framework/main/classes/filter/verifier/class_AccountPasswordVerifierFilter.php

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