3 namespace Com\Github\DomBlack\Scrypt;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Feature\FrameworkFeature;
8 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
11 * This file contains a 'core-d' version of the example helper classes for the
12 * php-scrypt extension. It has been renamed from scrypt.php to this name so the
13 * framework can easily find it. Also it now extends BaseFrameworkSystem, no
14 * other modifications has been done (except this comment ;-) ).
16 * For license file, original README and CREDITS file, see
17 * framework/main/third_party/scrypt/.
19 * As with all cryptographic code; it is recommended that you use a tried and
20 * tested library which uses this library; rather than rolling your own.
26 * @author Dominic Black <thephenix@gmail.com>
27 * @license http://www.opensource.org/licenses/BSD-2-Clause BSD 2-Clause License
28 * @link http://github.com/DomBlack/php-scrypt
32 * This class abstracts away from scrypt module, allowing for easy use.
34 * You can create a new hash for a password by calling Scrypt:hashScrypt($password)
36 * You can check a password by calling Scrypt:checkScrypt($password, $hash)
40 * @author Dominic Black <thephenix@gmail.com>
41 * @author Roland Haeder <roland@mxchange.org>
42 * @license http://www.opensource.org/licenses/BSD-2-Clause BSD 2-Clause License
43 * @link http://github.com/DomBlack/php-scrypt
45 abstract class Scrypt extends BaseFrameworkSystem
50 * @var int The key length
52 private static $_keyLength = 32;
55 * Get the byte-length of the given string
57 * @param string $str Input string
61 protected static function strlen ($str) {
62 static $isShadowed = null;
64 if ($isShadowed === null) {
65 $isShadowed = extension_loaded('mbstring') &&
66 ini_get('mbstring.func_overload') & 2;
70 return mb_strlen($str, '8bit');
77 * Generates a random salt
79 * @param int $length The length of the salt
81 * @return string The salt
83 public static function generateScryptSalt ($length = 8)
86 $buffer_valid = false;
87 if (function_exists('mcrypt_create_iv') && !defined('PHALANGER')) {
88 $buffer = mcrypt_create_iv($length, MCRYPT_DEV_URANDOM);
93 if (!$buffer_valid && function_exists('openssl_random_pseudo_bytes')) {
94 $cryptoStrong = false;
95 $buffer = openssl_random_pseudo_bytes($length, $cryptoStrong);
96 if ($buffer && $cryptoStrong) {
100 if (!$buffer_valid && FrameworkBootstrap::isReadableFile('/dev/urandom')) {
101 $f = fopen('/dev/urandom', 'r');
102 $read = static::strlen($buffer);
103 while ($read < $length) {
104 $buffer .= fread($f, $length - $read);
105 $read = static::strlen($buffer);
108 if ($read >= $length) {
109 $buffer_valid = true;
112 if (!$buffer_valid || static::strlen($buffer) < $length) {
113 $bl = static::strlen($buffer);
114 for ($i = 0; $i < $length; $i++) {
116 $buffer[$i] = $buffer[$i] ^ chr(mt_rand(0, 255));
118 $buffer .= chr(mt_rand(0, 255));
122 $salt = str_replace(array('+', '$'), array('.', ''), base64_encode($buffer));
128 * Create a password hash
130 * @param string $password The clear text password
131 * @param string $salt The salt to use, or null to generate a random one
132 * @param int $N The CPU difficultly (must be a power of 2, > 1)
133 * @param int $r The memory difficultly
134 * @param int $p The parallel difficultly
136 * @return string The hashed password
138 public static function hashScrypt ($password, $salt = false, $N = 16384, $r = 8, $p = 1)
140 if (!FrameworkFeature::isFeatureAvailable('hubcoin_reward')) {
141 // Feature has been disabled
142 throw new \InvalidArgumentException('Feature "scrypt" disabled.');
145 if ($N == 0 || ($N & ($N - 1)) != 0) {
146 throw new \InvalidArgumentException('N must be > 0 and a power of 2');
149 if ($N > PHP_INT_MAX / 128 / $r) {
150 throw new \InvalidArgumentException('Parameter N is too large');
153 if ($r > PHP_INT_MAX / 128 / $p) {
154 throw new \InvalidArgumentException('Parameter r is too large');
157 if ($salt === false) {
158 $salt = self::generateScryptSalt();
160 // Remove dollar signs from the salt, as we use that as a separator.
161 $salt = str_replace(array('+', '$'), array('.', ''), base64_encode($salt));
164 $hash = scrypt($password, $salt, $N, $r, $p, self::$_keyLength);
166 return $N . '$' . $r . '$' . $p . '$' . $salt . '$' . $hash;
170 * Check a clear text password against a hash
172 * @param string $password The clear text password
173 * @param string $hash The hashed password
175 * @return boolean If the clear text matches
177 public static function checkScrypt ($password, $hash)
179 // Is there actually a hash?
184 if (!FrameworkFeature::isFeatureAvailable('hubcoin_reward')) {
185 // Feature has been disabled
186 throw new \InvalidArgumentException('Feature "scrypt" disabled.');
189 list ($N, $r, $p, $salt, $hash) = explode('$', $hash);
192 if (empty($N) or empty($r) or empty($p) or empty($salt) or empty($hash)) {
196 // Are numeric values numeric?
197 if (!is_numeric($N) or !is_numeric($r) or !is_numeric($p)) {
201 $calculated = scrypt($password, $salt, $N, $r, $p, self::$_keyLength);
203 // Use compareScryptHashes to avoid timeing attacks
204 return self::compareScryptHashes($hash, $calculated);
208 * Zend Framework (http://framework.zend.com/)
210 * @link http://github.com/zendframework/zf2 for the canonical source repository
211 * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
212 * @license http://framework.zend.com/license/new-bsd New BSD License
214 * Compare two strings to avoid timing attacks
216 * C function memcmp() internally used by PHP, exits as soon as a difference
217 * is found in the two buffers. That makes possible of leaking
218 * timing information useful to an attacker attempting to iteratively guess
219 * the unknown string (e.g. password).
221 * @param string $expected
222 * @param string $actual
224 * @return boolean If the two strings match.
226 public static function compareScryptHashes ($expected, $actual)
228 $expected = (string) $expected;
229 $actual = (string) $actual;
230 $lenExpected = static::strlen($expected);
231 $lenActual = static::strlen($actual);
232 $len = min($lenExpected, $lenActual);
235 for ($i = 0; $i < $len; $i ++) {
236 $result |= ord($expected[$i]) ^ ord($actual[$i]);
238 $result |= $lenExpected ^ $lenActual;
240 return ($result === 0);