3 namespace CoreFramework\Filter\Verifier\Password;
5 // Import framework stuff
6 use CoreFramework\Filter\BaseFilter;
7 use CoreFramework\Filter\Filterable;
8 use CoreFramework\Factory\ObjectFactory;
9 use CoreFramework\Registry\Registry;
10 use CoreFramework\Request\Requestable;
11 use CoreFramework\Response\Responseable;
14 * A concrete filter for validating the password. This filter may intercept
15 * the filter chain if no password is given or the password is invalid
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class AccountPasswordVerifierFilter extends BaseFilter implements Filterable {
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Creates an instance of this filter class
50 * @return $filterInstance An instance of this filter class
52 public static final function createAccountPasswordVerifierFilter () {
54 $filterInstance = new AccountPasswordVerifierFilter();
56 // Return the instance
57 return $filterInstance;
61 * Executes the filter with given request and response objects
63 * @param $requestInstance An instance of a class with an Requestable interface
64 * @param $responseInstance An instance of a class with an Responseable interface
66 * @throws AccountPasswordMismatchException If the account password does not match
67 * @throws FilterChainException If this filter fails to operate
68 * @todo Rewrite handling of different password fields
70 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72 $password = $requestInstance->getRequestElement('pass_old');
74 // Is the password still not set?
75 if (is_null($password)) {
76 // Get password from alternative location
77 $password = $requestInstance->getRequestElement('password');
79 // Is the password still not set?
80 if (is_null($password)) {
81 // Not found in form so stop the filtering process
82 $requestInstance->requestIsValid(FALSE);
84 // Add a message to the response
85 $responseInstance->addFatalMessage('password_unset');
88 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
92 if (empty($password)) {
94 $requestInstance->requestIsValid(FALSE);
96 // Add a message to the response
97 $responseInstance->addFatalMessage('password_empty');
100 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
103 // Get a user instance
104 $userInstance = Registry::getRegistry()->getInstance('user');
107 $currentHash = $userInstance->getField('pass_hash');
109 // Get an encryption helper and encrypt the password
110 $passHash = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($password, $currentHash);
113 if ($currentHash != $passHash) {
114 // Throw an exception here to stop the proccessing
115 throw new AccountPasswordMismatchException($this, BaseUser::EXCEPTION_USER_PASS_MISMATCH);