Implement new password hashing (PBKDF2-SHA1) #83
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| <?php | ||
|
|
||
| namespace LanSuite; | ||
|
|
||
| class PasswordHash | ||
| { | ||
| public static function hash($password) | ||
| { | ||
| $algo_cfg = self::getAlgoCfg(); | ||
|
|
||
| switch ($algo_cfg['algo']) { | ||
| case 'md5': | ||
| return md5($password); | ||
|
|
||
| case 'pbkdf2-sha1': | ||
| /* | ||
| * Hash format: $pbkdf2-sha1$(iterations)$(salt)$(hash) | ||
| * Example: $pbkdf2-sha1$500000$o2ermOW/WQy1XFFDVfx/Zw==$otf1NOkfKFTrIh9Au1oTPdwdnTc= | ||
| * Parameters: | ||
| * - iterations: integer | ||
| * - salt: base64-encoded salt | ||
| * - hash: base64-encoded hash | ||
| */ | ||
|
|
||
| $iterations = $algo_cfg['iterations']; | ||
| if (!is_numeric($iterations) || $iterations < 1) { | ||
| throw new Exception('Unexpected iterations value'); | ||
| } | ||
| $iterations = intval($iterations); | ||
|
|
||
| $rawsalt = random_bytes(16); | ||
| $rawhash = hash_pbkdf2('sha1', $password, $rawsalt, $iterations, 0, true); | ||
|
|
||
| $b64salt = base64_encode($rawsalt); | ||
| $b64hash = base64_encode($rawhash); | ||
| if ($b64salt === false || $b64hash === false) { | ||
| throw new Exception('Unexpected base64_encode error'); | ||
| } | ||
|
|
||
| return '$pbkdf2-sha1$'.$iterations.'$'.$b64salt.'$'.$b64hash; | ||
| } | ||
|
|
||
| throw new Exception('Unsupported password hashing algorithm'); | ||
| } | ||
|
|
||
| public static function verify($password, $hash) | ||
| { | ||
| $info = self::getInfo($hash); | ||
|
|
||
| switch ($info['algo']) { | ||
| case 'md5': | ||
| $newhash = md5($password); | ||
| return hash_equals($info['hash'], $newhash); | ||
| case 'pbkdf2-sha1': | ||
| $newhash = hash_pbkdf2('sha1', $password, $info['salt'], intval($info['iterations']), 0, true); | ||
| return hash_equals($info['hash'], $newhash); | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| public static function needsRehash($hash) | ||
| { | ||
| global $config; | ||
|
|
||
| $algo_cfg = self::getAlgoCfg(); | ||
|
|
||
| $info = self::getInfo($hash); | ||
|
|
||
| foreach ($info as $key => $value) { | ||
| if ($key === 'hash' || $key === 'salt') { | ||
| continue; | ||
| } | ||
|
|
||
| if ($algo_cfg[$key] !== $value) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| private static function getInfo($hash) | ||
| { | ||
| if ($hash[0] === '$') { | ||
| $parts = explode('$', $hash); | ||
| if (count($parts) !== 5) { | ||
| throw new Exception('Unexpected hash format'); | ||
| } | ||
| list($dummy, $algo, $iterations, $b64salt, $b64hash) = $parts; | ||
|
|
||
| if (!is_numeric($iterations) || $iterations < 1) { | ||
| throw new Exception('Unexpected iterations value'); | ||
| } | ||
| $rawsalt = base64_decode($b64salt, true); | ||
| $rawhash = base64_decode($b64hash, true); | ||
| if ($rawsalt === false || $rawhash === false) { | ||
| throw new Exception('Unexpected base64_decode error'); | ||
| } | ||
|
|
||
| return array('algo' => $algo, 'iterations' => $iterations, 'hash' => $rawhash, 'salt' => $rawsalt); | ||
| } else { | ||
| return array('algo' => 'md5', 'hash' => $hash); | ||
| } | ||
| } | ||
|
|
||
| private static function getAlgo() | ||
| { | ||
| global $cfg; | ||
|
|
||
| if (array_key_exists('pwhash_algo', $cfg)) { | ||
| $pwhash_algo = $cfg['pwhash_algo']; | ||
| } else { | ||
| $pwhash_algo = 'md5'; | ||
| } | ||
|
|
||
| if ($pwhash_algo === 'default') { | ||
| $pwhash_algo = 'pbkdf2-sha1'; | ||
| } | ||
|
|
||
| return $pwhash_algo; | ||
| } | ||
|
|
||
| private static function getDefaultAlgoCfg($algo) | ||
| { | ||
| switch ($algo) { | ||
| case 'pbkdf2-sha1': | ||
| return array('iterations' => '500000'); | ||
| } | ||
|
|
||
| return array(); | ||
| } | ||
|
|
||
| private static function parseAlgoCfg($algo_cfg_str) | ||
| { | ||
| $algo_cfg = array(); | ||
|
|
||
| $pairs = explode(',', $algo_cfg_str); | ||
|
|
||
| foreach ($pairs as $pair) { | ||
| $parts = explode('=', $pair, 2); | ||
|
|
||
| $key = $parts[0]; | ||
|
|
||
| if (count($parts) > 1) { | ||
| $value = $parts[1]; | ||
| } else { | ||
| $value = null; | ||
| } | ||
|
|
||
| $algo_cfg[$key] = $value; | ||
| } | ||
|
|
||
| return $algo_cfg; | ||
| } | ||
|
|
||
| private static function getAlgoCfg() | ||
| { | ||
| global $cfg; | ||
|
|
||
| $algo = self::getAlgo(); | ||
| $algo_cfg = self::getDefaultAlgoCfg($algo); | ||
|
|
||
| if (array_key_exists('pwhash_algo_cfg', $cfg)) { | ||
| $custom_algo_cfg = self::parseAlgoCfg($cfg['pwhash_algo_cfg']); | ||
| $algo_cfg = array_merge($algo_cfg, $custom_algo_cfg); | ||
| } | ||
|
|
||
| return array_merge($algo_cfg, array('algo' => $algo)); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not favor making this class with a collection of static functions. I think we could benefit more from streamlining the scope of this class a bit more by e.g., removing the dependency on the configuration and injecting the configuration into the constructor.
This would make unit testing easier as well.
I can take this on and modify the class / this PR.