mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
107 lines
3.2 KiB
PHP
107 lines
3.2 KiB
PHP
<?php
|
|
|
|
namespace SilverStripe\Security;
|
|
|
|
use ReflectionClass;
|
|
use SilverStripe\Core\Config\Config;
|
|
|
|
/**
|
|
* Allows pluggable password encryption.
|
|
* By default, this might be PHP's integrated sha1()
|
|
* function, but could also be more sophisticated to facilitate
|
|
* password migrations from other systems.
|
|
* Use {@link register()} to add new implementations.
|
|
*
|
|
* Used in {@link Security::encrypt_password()}.
|
|
*/
|
|
abstract class PasswordEncryptor
|
|
{
|
|
|
|
/**
|
|
* @var array
|
|
* @config
|
|
*/
|
|
private static $encryptors = [];
|
|
|
|
/**
|
|
* @return array Map of encryptor code to the used class.
|
|
*/
|
|
public static function get_encryptors()
|
|
{
|
|
return Config::inst()->get(self::class, 'encryptors');
|
|
}
|
|
|
|
/**
|
|
* @param string $algorithm
|
|
* @return PasswordEncryptor
|
|
* @throws PasswordEncryptor_NotFoundException
|
|
*/
|
|
public static function create_for_algorithm($algorithm)
|
|
{
|
|
$encryptors = self::get_encryptors();
|
|
if (!isset($encryptors[$algorithm])) {
|
|
throw new PasswordEncryptor_NotFoundException(
|
|
sprintf('No implementation found for "%s"', $algorithm)
|
|
);
|
|
}
|
|
|
|
$class=key($encryptors[$algorithm] ?? []);
|
|
if (!class_exists($class ?? '')) {
|
|
throw new PasswordEncryptor_NotFoundException(
|
|
sprintf('No class found for "%s"', $class)
|
|
);
|
|
}
|
|
$refClass = new ReflectionClass($class);
|
|
if (!$refClass->getConstructor()) {
|
|
return new $class;
|
|
}
|
|
|
|
// Don't treat array keys as argument names - keeps PHP 7 and PHP 8 operating similarly
|
|
$arguments = array_values($encryptors[$algorithm] ?? []);
|
|
return($refClass->newInstanceArgs($arguments));
|
|
}
|
|
|
|
/**
|
|
* Return a string value stored in the {@link Member->Password} property.
|
|
* The password should be hashed with {@link salt()} if applicable.
|
|
*
|
|
* @param string $password Cleartext password to be hashed
|
|
* @param string $salt (Optional)
|
|
* @param Member $member (Optional)
|
|
* @return String Maximum of 512 characters.
|
|
*/
|
|
abstract public function encrypt($password, $salt = null, $member = null);
|
|
|
|
/**
|
|
* Return a string value stored in the {@link Member->Salt} property.
|
|
*
|
|
* @uses RandomGenerator
|
|
*
|
|
* @param string $password Cleartext password
|
|
* @param Member $member (Optional)
|
|
* @return string Maximum of 50 characters
|
|
*/
|
|
public function salt($password, $member = null)
|
|
{
|
|
$generator = new RandomGenerator();
|
|
return substr($generator->randomToken('sha1') ?? '', 0, 50);
|
|
}
|
|
|
|
/**
|
|
* This usually just returns a strict string comparison,
|
|
* but is necessary for retain compatibility with password hashed
|
|
* with flawed algorithms - see {@link PasswordEncryptor_LegacyPHPHash} and
|
|
* {@link PasswordEncryptor_Blowfish}
|
|
*
|
|
* @param string $hash
|
|
* @param string $password
|
|
* @param string $salt
|
|
* @param Member $member
|
|
* @return bool
|
|
*/
|
|
public function check($hash, $password, $salt = null, $member = null)
|
|
{
|
|
return hash_equals($hash ?? '', $this->encrypt($password, $salt, $member) ?? '');
|
|
}
|
|
}
|