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