This repository has been archived on 2024-06-26. You can view files and clone it, but cannot push or open issues or pull requests.
sakura/libraries/Hashing.php

225 lines
6.5 KiB
PHP
Raw Normal View History

<?php
/*
2016-02-02 21:04:15 +00:00
* Password Hashing With PBKDF2 (https://defuse.ca/php-pbkdf2.htm).
* Copyright (c) 2013, Taylor Hornby
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
namespace Sakura;
/**
2016-02-02 21:04:15 +00:00
* PBKDF2 password hashing implementation.
*
* @package Sakura
2016-02-02 21:04:15 +00:00
* @author Taylor Hornby <havoc@defuse.ca>
* @author Julian van de Groep <me@flash.moe>
*/
class Hashing
{
2016-02-02 21:04:15 +00:00
/**
* Hashing algorithm that should be used.
*
* @var string
*/
2015-09-14 21:41:43 +00:00
private static $hashAlgorithm = 'sha256';
2016-02-02 21:04:15 +00:00
/**
* Iterations.
*
* @var int
*/
2015-09-14 21:41:43 +00:00
private static $iterations = 1000;
2016-02-02 21:04:15 +00:00
/**
* The amount of bytes the salt should be.
*
* @var int
*/
2015-09-14 21:41:43 +00:00
private static $saltBytes = 24;
2016-02-02 21:04:15 +00:00
/**
* The amount of bytes the hash should be.
*
* @var int
*/
2015-09-14 21:41:43 +00:00
private static $hashBytes = 24;
2016-02-02 21:04:15 +00:00
/**
* Creates a hash.
*
* @param string $pass The password that should be hashed.
*
* @return array An array containing the algorithm, iterations, salt and hash.
*/
2015-09-14 21:41:43 +00:00
public static function createHash($pass)
{
$salt = base64_encode(
\mcrypt_create_iv(
2015-09-14 21:41:43 +00:00
self::$saltBytes,
MCRYPT_DEV_URANDOM
)
);
$hash = base64_encode(
self::pbkdf2(
2015-09-14 21:41:43 +00:00
self::$hashAlgorithm,
$pass,
$salt,
2015-09-14 21:41:43 +00:00
self::$iterations,
self::$hashBytes,
true
)
);
$passwordData = [
2015-09-14 21:41:43 +00:00
self::$hashAlgorithm,
self::$iterations,
$salt,
$hash,
];
return $passwordData;
}
2016-02-02 21:04:15 +00:00
/**
* Validate a password.
*
* @param string $password The password that is being validated.
* @param array $params The parametres in the order of algorithm, iterations, salt and hash.
*
* @return bool Correct?
*/
2015-09-14 21:41:43 +00:00
public static function validatePassword($password, $params)
{
2015-09-14 21:41:43 +00:00
if (count($params) < 4) {
return false;
}
2015-09-14 21:41:43 +00:00
$pbkdf2 = base64_decode($params[3]);
2015-09-14 21:41:43 +00:00
$validate = self::slowEquals(
$pbkdf2,
self::pbkdf2(
2015-09-14 21:41:43 +00:00
$params[0],
$password,
2015-09-14 21:41:43 +00:00
$params[2],
(int) $params[1],
strlen($pbkdf2),
true
)
);
return $validate;
}
2016-02-02 21:04:15 +00:00
/**
* Compares two strings $a and $b in length-constant time.
*
* @param string $a String A.
* @param string $b String B.
*
* @return bool Boolean indicating difference.
*/
2015-09-14 21:41:43 +00:00
public static function slowEquals($a, $b)
{
$diff = strlen($a) ^ strlen($b);
for ($i = 0; $i < strlen($a) && $i < strlen($b); $i++) {
$diff |= ord($a[$i]) ^ ord($b[$i]);
}
return $diff === 0;
}
2016-02-02 21:04:15 +00:00
/**
* PBKDF2 key derivation function as defined by RSA's PKCS #5: https://www.ietf.org/rfc/rfc2898.txt
2016-02-02 21:04:15 +00:00
*
* This implementation of PBKDF2 was originally created by https://defuse.ca
* With improvements by http://www.variations-of-shadow.com
2016-02-02 21:04:15 +00:00
*
* @param mixed $algorithm The hash algorithm to use. Recommended: SHA256.
* @param mixed $password The password.
* @param mixed $salt A salt that is unique to the password.
* @param mixed $count Iteration count. Higher is better, but slower. Recommended: At least 1000.
* @param mixed $key_length The length of the derived key in bytes.
* @param mixed $raw_output A $key_length-byte key derived from the password and salt.
*
* @return string The PBKDF2 derivation.
*/
private static function pbkdf2($algorithm, $password, $salt, $count, $key_length, $raw_output = false)
{
$algorithm = strtolower($algorithm);
if (!in_array($algorithm, hash_algos(), true)) {
2015-09-14 21:41:43 +00:00
trigger_error(
'PBKDF2 ERROR: Invalid hash algorithm.',
E_USER_ERROR
);
}
if ($count <= 0 || $key_length <= 0) {
2015-09-14 21:41:43 +00:00
trigger_error(
'PBKDF2 ERROR: Invalid parameters.',
E_USER_ERROR
);
}
if (function_exists('hash_pbkdf2')) {
// The output length is in NIBBLES (4-bits) if $raw_output is false!
if (!$raw_output) {
$key_length = $key_length * 2;
}
return hash_pbkdf2($algorithm, $password, $salt, $count, $key_length, $raw_output);
}
$hash_length = strlen(hash($algorithm, '', true));
$block_count = ceil($key_length / $hash_length);
$output = '';
for ($i = 1; $i <= $block_count; $i++) {
// $i encoded as 4 bytes, big endian.
$last = $salt . pack('N', $i);
// First iteration
$last = $xorsum = hash_hmac($algorithm, $last, $password, true);
// Perform the other $count - 1 interations
for ($j = 1; $j < $count; $j++) {
$xorsum ^= ($last = hash_hmac($algorithm, $last, $password, true));
}
$output .= $xorsum;
if ($raw_output) {
return substr($output, 0, $key_length);
}
return bin2hex(substr($output, 0, $key_length));
}
}
}