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