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