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\GenericRegistry;
  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  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
  21  * @license             GNU GPL 3.0 or any newer version
  22  * @link                http://www.shipsimu.org
  23  *
  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.
  28  *
  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.
  33  *
  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/>.
  36  */
  37 class AccountPasswordVerifierFilter extends BaseFilter implements Filterable {
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46         }
  47
  48         /**
  49          * Creates an instance of this filter class
  50          *
  51          * @return      $filterInstance         An instance of this filter class
  52          */
  53         public static final function createAccountPasswordVerifierFilter () {
  54                 // Get a new instance
  55                 $filterInstance = new AccountPasswordVerifierFilter();
  56
  57                 // Return the instance
  58                 return $filterInstance;
  59         }
  60
  61         /**
  62          * Executes the filter with given request and response objects
  63          *
  64          * @param       $requestInstance        An instance of a class with an Requestable interface
  65          * @param       $responseInstance       An instance of a class with an Responseable interface
  66          * @return      void
  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
  70          */
  71         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  72                 // Get password
  73                 $password = $requestInstance->getRequestElement('pass_old');
  74
  75                 // Is the password still not set?
  76                 if (is_null($password)) {
  77                         // Get password from alternative location
  78                         $password = $requestInstance->getRequestElement('password');
  79
  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);
  84
  85                                 // Add a message to the response
  86                                 $responseInstance->addFatalMessage('password_unset');
  87
  88                                 // Abort here
  89                                 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  90                         } // END - if
  91                 } // END - if
  92
  93                 if (empty($password)) {
  94                         // Password is empty
  95                         $requestInstance->requestIsValid(false);
  96
  97                         // Add a message to the response
  98                         $responseInstance->addFatalMessage('password_empty');
  99
 100                         // Abort here
 101                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
 102                 } // END - if
 103
 104                 // Get a user instance
 105                 $userInstance = GenericRegistry::getRegistry()->getInstance('user');
 106
 107                 // Get current hash
 108                 $currentHash = $userInstance->getField('pass_hash');
 109
 110                 // Get an encryption helper and encrypt the password
 111                 $passHash = ObjectFactory::createObjectByConfiguredName('crypto_class')->hashString($password, $currentHash);
 112
 113                 // Does it match?
 114                 if ($currentHash != $passHash) {
 115                         // Throw an exception here to stop the proccessing
 116                         throw new AccountPasswordMismatchException($this, BaseUser::EXCEPTION_USER_PASS_MISMATCH);
 117                 } // END - if
 118         }
 119
 120 }