1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
<?php
/* --------------------------------------------------------------
AuthStrategyInterface.inc.php 2016-08-11
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface AuthStrategyInterface
*
* @category System
* @package Authentication
* @subpackage Interfaces
*/
interface AuthStrategyInterface
{
/**
* Verifies a given password by its stored hash from the current hashing algorithm.
*
* @param StringType $password
* @param NonEmptyStringType $hash
* @param AuthStrategyCollection $authStrategyCollection
*
* @return bool Is the password valid?
*/
public function verify(StringType $password,
NonEmptyStringType $hash,
AuthStrategyCollection $authStrategyCollection = null);
/**
* Generates a hash by given password string.
*
* @param StringType $password String that should be hashed.
*
* @throws RuntimeException if password_hash() could not create a hash.
*
* @return string Resulting hash.
*/
public function getHash(StringType $password);
/**
* Returns a rehashed password hash if it does not match the currently used hashing algorithm.
*
* @param StringType $password Password that should be rehashed by a new
* algorithm.
* @param NonEmptyStringType $hash Current password hash.
* @param AuthStrategyCollection|null $authStrategyCollection Collection of hashing algorithms.
*
* @return string The new password hash.
*/
public function getRehashedPassword(StringType $password,
NonEmptyStringType $hash,
AuthStrategyCollection $authStrategyCollection = null);
}