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