<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 2.4.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Auth;
use Cake\Core\InstanceConfigTrait;
/**
* Abstract password hashing class
*/
abstract class AbstractPasswordHasher
{
use InstanceConfigTrait;
/**
* Default config
*
* These are merged with user-provided config when the object is used.
*
* @var array
*/
protected $_defaultConfig = [];
/**
* Constructor
*
* @param array $config Array of config.
*/
public function __construct(array $config = [])
{
$this->setConfig($config);
}
/**
* Generates password hash.
*
* @param string $password Plain text password to hash.
* @return string|false Either the password hash string or false
*/
abstract public function hash($password);
/**
* Check hash. Generate hash from user provided password string or data array
* and check against existing hash.
*
* @param string $password Plain text password to hash.
* @param string $hashedPassword Existing hashed password.
* @return bool True if hashes match else false.
*/
abstract public function check($password, $hashedPassword);
/**
* Returns true if the password need to be rehashed, due to the password being
* created with anything else than the passwords generated by this class.
*
* Returns true by default since the only implementation users should rely
* on is the one provided by default in php 5.5+ or any compatible library
*
* @param string $password The password to verify
* @return bool
*/
public function needsRehash($password)
{
return password_needs_rehash($password, PASSWORD_DEFAULT);
}
}