From ef9db7444ac2e8e7416cc40f076e0d0748b042c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20=C5=81ojewski?= Date: Sat, 30 Jun 2018 14:32:13 +0200 Subject: [PATCH] Feature/issue#44 (#47) phpass implementation --- CHANGELOG.md | 7 +- README.md | 3 +- lib/Crypto/PasswordHash.php | 230 ++++++++++++++++++++++++++++++++++++ lib/Crypto/Phpass.php | 75 ++++++++++++ tests/Crypto/PhpassTest.php | 55 +++++++++ 5 files changed, 367 insertions(+), 3 deletions(-) create mode 100644 lib/Crypto/PasswordHash.php create mode 100644 lib/Crypto/Phpass.php create mode 100644 tests/Crypto/PhpassTest.php diff --git a/CHANGELOG.md b/CHANGELOG.md index cc1c2ee..95d78e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,14 +5,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Added +- SHA512 Whirlpool hashing algorithm +- phpass hashing implementation +- Support for salt column + ### Fixed - Table and column autocomplete in settings panel ## [v4.0.0-rc2] ### Added - User active column -- SHA512 Whirlpool hashing algorithm -- Support for salt column ### Changed - Fixed "Use of undefined constant" error for Argon2 Crypt with PHP below 7.2. diff --git a/README.md b/README.md index 01b9e67..82bfc17 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ User table: wp_users Username column: user_login Password column: user_pass -Hashing algorithm: Unix (Crypt) +Hashing algorithm: Unix (Crypt) or Portable PHP password ``` #### JHipster @@ -191,6 +191,7 @@ SHA512 (Crypt) | Generates hash with 5000 rounds. | $6$rounds=5000$yH.Q0OL4qbCOU Standard DES (Crypt) | | yTBnb7ab/N072 Joomla MD5 Encryption | Generates 32 chars salt. | 14d21b49b0f13e2acba962b6b0039edd:haJK0yTvBXTNMh76xwEw5RYEVpJsN8us MD5 | No salt supported. | 5f4dcc3b5aa765d61d8327deb882cf99 +Portable PHP password | See [phpass](http://www.openwall.com/phpass/). | $P$BxrwraqNTi4as0EI.IpiA/K.muk9ke/ SHA1 | No salt supported. | 5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8 SHA512 Whirlpool | No salt supported. | a96b16ebb691dbe968b0d66d0d924cff5cf5de5e0885181d00761d87f295b2bf3d3c66187c050fc01c196ff3acaa48d3561ffd170413346e934a32280d632f2e SSHA256 | Generates 32 chars salt. | {SSHA256}+WxTB3JxprNteeovsuSYtgI+UkVPA9lfwGoYkz3Ff7hjd1FSdmlTMkNsSExyR21KM3NvNTZ5V0p4WXJMUjFzUg== diff --git a/lib/Crypto/PasswordHash.php b/lib/Crypto/PasswordHash.php new file mode 100644 index 0000000..6228ba7 --- /dev/null +++ b/lib/Crypto/PasswordHash.php @@ -0,0 +1,230 @@ + in 2004-2006 and placed in +# the public domain. Revised in subsequent years, still public domain. +# +# There's absolutely no warranty. +# +# The homepage URL for this framework is: +# +# http://www.openwall.com/phpass/ +# +# Please be sure to update the Version line if you edit this file in any way. +# It is suggested that you leave the main version number intact, but indicate +# your project name (after the slash) and add your own revision information. +# +# Please do not change the "private" password hashing method implemented in +# here, thereby making your hashes incompatible. However, if you must, please +# change the hash type identifier (the "$P$") to something different. +# +# Obviously, since this code is in the public domain, the above are not +# requirements (there can be none), but merely suggestions. +# + +namespace OCA\UserSQL\Crypto; + +class PasswordHash { + var $itoa64; + var $iteration_count_log2; + var $portable_hashes; + var $random_state; + + function __construct($iteration_count_log2, $portable_hashes) + { + $this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'; + + if ($iteration_count_log2 < 4 || $iteration_count_log2 > 31) + $iteration_count_log2 = 8; + $this->iteration_count_log2 = $iteration_count_log2; + + $this->portable_hashes = $portable_hashes; + + $this->random_state = microtime(); + if (function_exists('getmypid')) + $this->random_state .= getmypid(); + } + + function PasswordHash($iteration_count_log2, $portable_hashes) + { + self::__construct($iteration_count_log2, $portable_hashes); + } + + function get_random_bytes($count) + { + $output = ''; + if (@is_readable('/dev/urandom') && + ($fh = @fopen('/dev/urandom', 'rb'))) { + $output = fread($fh, $count); + fclose($fh); + } + + if (strlen($output) < $count) { + $output = ''; + for ($i = 0; $i < $count; $i += 16) { + $this->random_state = + md5(microtime() . $this->random_state); + $output .= md5($this->random_state, TRUE); + } + $output = substr($output, 0, $count); + } + + return $output; + } + + function encode64($input, $count) + { + $output = ''; + $i = 0; + do { + $value = ord($input[$i++]); + $output .= $this->itoa64[$value & 0x3f]; + if ($i < $count) + $value |= ord($input[$i]) << 8; + $output .= $this->itoa64[($value >> 6) & 0x3f]; + if ($i++ >= $count) + break; + if ($i < $count) + $value |= ord($input[$i]) << 16; + $output .= $this->itoa64[($value >> 12) & 0x3f]; + if ($i++ >= $count) + break; + $output .= $this->itoa64[($value >> 18) & 0x3f]; + } while ($i < $count); + + return $output; + } + + function gensalt_private($input) + { + $output = '$P$'; + $output .= $this->itoa64[min($this->iteration_count_log2 + + ((PHP_VERSION >= '5') ? 5 : 3), 30)]; + $output .= $this->encode64($input, 6); + + return $output; + } + + function crypt_private($password, $setting) + { + $output = '*0'; + if (substr($setting, 0, 2) === $output) + $output = '*1'; + + $id = substr($setting, 0, 3); + # We use "$P$", phpBB3 uses "$H$" for the same thing + if ($id !== '$P$' && $id !== '$H$') + return $output; + + $count_log2 = strpos($this->itoa64, $setting[3]); + if ($count_log2 < 7 || $count_log2 > 30) + return $output; + + $count = 1 << $count_log2; + + $salt = substr($setting, 4, 8); + if (strlen($salt) !== 8) + return $output; + + # We were kind of forced to use MD5 here since it's the only + # cryptographic primitive that was available in all versions + # of PHP in use. To implement our own low-level crypto in PHP + # would have resulted in much worse performance and + # consequently in lower iteration counts and hashes that are + # quicker to crack (by non-PHP code). + $hash = md5($salt . $password, TRUE); + do { + $hash = md5($hash . $password, TRUE); + } while (--$count); + + $output = substr($setting, 0, 12); + $output .= $this->encode64($hash, 16); + + return $output; + } + + function gensalt_blowfish($input) + { + # This one needs to use a different order of characters and a + # different encoding scheme from the one in encode64() above. + # We care because the last character in our encoded string will + # only represent 2 bits. While two known implementations of + # bcrypt will happily accept and correct a salt string which + # has the 4 unused bits set to non-zero, we do not want to take + # chances and we also do not want to waste an additional byte + # of entropy. + $itoa64 = './ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; + + $output = '$2a$'; + $output .= chr(ord('0') + $this->iteration_count_log2 / 10); + $output .= chr(ord('0') + $this->iteration_count_log2 % 10); + $output .= '$'; + + $i = 0; + do { + $c1 = ord($input[$i++]); + $output .= $itoa64[$c1 >> 2]; + $c1 = ($c1 & 0x03) << 4; + if ($i >= 16) { + $output .= $itoa64[$c1]; + break; + } + + $c2 = ord($input[$i++]); + $c1 |= $c2 >> 4; + $output .= $itoa64[$c1]; + $c1 = ($c2 & 0x0f) << 2; + + $c2 = ord($input[$i++]); + $c1 |= $c2 >> 6; + $output .= $itoa64[$c1]; + $output .= $itoa64[$c2 & 0x3f]; + } while (1); + + return $output; + } + + function HashPassword($password) + { + $random = ''; + + if (CRYPT_BLOWFISH === 1 && !$this->portable_hashes) { + $random = $this->get_random_bytes(16); + $hash = + crypt($password, $this->gensalt_blowfish($random)); + if (strlen($hash) === 60) + return $hash; + } + + if (strlen($random) < 6) + $random = $this->get_random_bytes(6); + $hash = + $this->crypt_private($password, + $this->gensalt_private($random)); + if (strlen($hash) === 34) + return $hash; + + # Returning '*' on error is safe here, but would _not_ be safe + # in a crypt(3)-like function used _both_ for generating new + # hashes and for validating passwords against existing hashes. + return '*'; + } + + function CheckPassword($password, $stored_hash) + { + $hash = $this->crypt_private($password, $stored_hash); + if ($hash[0] === '*') + $hash = crypt($password, $stored_hash); + + # This is not constant-time. In order to keep the code simple, + # for timing safety we currently rely on the salts being + # unpredictable, which they are at least in the non-fallback + # cases (that is, when we use /dev/urandom and bcrypt). + return $hash === $stored_hash; + } +} + +?> diff --git a/lib/Crypto/Phpass.php b/lib/Crypto/Phpass.php new file mode 100644 index 0000000..1feba29 --- /dev/null +++ b/lib/Crypto/Phpass.php @@ -0,0 +1,75 @@ + + * @author Marcin Łojewski + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +namespace OCA\UserSQL\Crypto; + +use OCP\IL10N; + +/** + * phpass hashing implementation. + * + * @author Marcin Łojewski + */ +class Phpass extends AbstractAlgorithm +{ + /** + * @var PasswordHash + */ + private $hasher; + + /** + * The class constructor. + * + * @param IL10N $localization The localization service. + * @param int $hashCostLog2 Log2 Hash cost. + * @param bool $hashPortable Use portable hash implementation. + */ + public function __construct( + IL10N $localization, $hashCostLog2 = 8, $hashPortable = true + ) { + parent::__construct($localization); + $this->hasher = new PasswordHash($hashCostLog2, $hashPortable); + } + + /** + * @inheritdoc + */ + public function checkPassword($password, $dbHash) + { + return $this->hasher->CheckPassword($password, $dbHash); + } + + /** + * @inheritdoc + */ + public function getPasswordHash($password) + { + return $this->hasher->HashPassword($password); + } + + /** + * @inheritdoc + */ + protected function getAlgorithmName() + { + return "Portable PHP password"; + } +} diff --git a/tests/Crypto/PhpassTest.php b/tests/Crypto/PhpassTest.php new file mode 100644 index 0000000..22b1ecc --- /dev/null +++ b/tests/Crypto/PhpassTest.php @@ -0,0 +1,55 @@ + + * @author Marcin Łojewski + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +namespace Tests\UserSQL\Crypto; + +use OCA\UserSQL\Crypto\Phpass; +use OCA\UserSQL\Crypto\IPasswordAlgorithm; +use OCP\IL10N; +use Test\TestCase; + +/** + * Unit tests for class PhpassTest. + * + * @author Marcin Łojewski + */ +class PhpassTest extends TestCase +{ + /** + * @var IPasswordAlgorithm + */ + private $crypto; + + public function testCheckPassword() + { + $this->assertTrue( + $this->crypto->checkPassword( + "password", "\$P\$BxrwraqNTi4as0EI.IpiA/K.muk9ke/" + ) + ); + } + + protected function setUp() + { + parent::setUp(); + $this->crypto = new Phpass($this->createMock(IL10N::class)); + } +}