<?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 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Auth;
/**
* Default password hashing class.
*/
class DefaultPasswordHasher extends AbstractPasswordHasher
{
/**
* Default config for this object.
*
* ### Options
*
* - `hashType` - Hashing algo to use. Valid values are those supported by `$algo`
* argument of `password_hash()`. Defaults to `PASSWORD_DEFAULT`
* - `hashOptions` - Associative array of options. Check the PHP manual for
* supported options for each hash type. Defaults to empty array.
*
* @var array
*/
protected $_defaultConfig = [
'hashType' => PASSWORD_DEFAULT,
'hashOptions' => [],
];
/**
* Generates password hash.
*
* @param string $password Plain text password to hash.
* @return string|false Password hash or false on failure
* @link https://book.cakephp.org/3/en/controllers/components/authentication.html#hashing-passwords
*/
public function hash($password)
{
return password_hash(
$password,
$this->_config['hashType'],
$this->_config['hashOptions']
);
}
/**
* Check hash. Generate hash for user provided password 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.
*/
public function check($password, $hashedPassword)
{
return password_verify($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.
*
* @param string $password The password to verify
* @return bool
*/
public function needsRehash($password)
{
return password_needs_rehash($password, $this->_config['hashType'], $this->_config['hashOptions']);
}
}