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