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;
12 use CoreFramework\User\BaseUser;
15 * A concrete filter for validating the password. This filter may intercept
16 * the filter chain if no password is given or the password is invalid
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class AccountPasswordVerifierFilter extends BaseFilter implements Filterable {
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of this filter class
51 * @return $filterInstance An instance of this filter class
53 public static final function createAccountPasswordVerifierFilter () {
55 $filterInstance = new AccountPasswordVerifierFilter();
57 // Return the instance
58 return $filterInstance;
62 * Executes the filter with given request and response objects
64 * @param $requestInstance An instance of a class with an Requestable interface
65 * @param $responseInstance An instance of a class with an Responseable interface
67 * @throws AccountPasswordMismatchException If the account password does not match
68 * @throws FilterChainException If this filter fails to operate
69 * @todo Rewrite handling of different password fields
71 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
73 $password = $requestInstance->getRequestElement('pass_old');
75 // Is the password still not set?
76 if (is_null($password)) {
77 // Get password from alternative location
78 $password = $requestInstance->getRequestElement('password');
80 // Is the password still not set?
81 if (is_null($password)) {
82 // Not found in form so stop the filtering process
83 $requestInstance->requestIsValid(FALSE);
85 // Add a message to the response
86 $responseInstance->addFatalMessage('password_unset');
89 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
93 if (empty($password)) {
95 $requestInstance->requestIsValid(FALSE);
97 // Add a message to the response
98 $responseInstance->addFatalMessage('password_empty');
101 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
104 // Get a user instance
105 $userInstance = Registry::getRegistry()->getInstance('user');
108 $currentHash = $userInstance->getField('pass_hash');
110 // Get an encryption helper and encrypt the password
111 $passHash = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($password, $currentHash);
114 if ($currentHash != $passHash) {
115 // Throw an exception here to stop the proccessing
116 throw new AccountPasswordMismatchException($this, BaseUser::EXCEPTION_USER_PASS_MISMATCH);