commit e573532b959e7476cefa826a7b6ee2c929375d32 Author: Tom Adams Date: Tue Sep 27 11:29:48 2016 -0400 Use bcrypt when available and fail gracefully - Move password hashing/verifying into new class - Use bcrypt if PHP version >= 5.3.7 - Add compatibility library - Upgrade password hashes automatically - Show a message in the situation where a password is using bcrypt but PHP is not capable of verifying it Resolves: https://core.trac.wordpress.org/ticket/21022 diff --git a/wp-includes/class-wp-hasher.php b/wp-includes/class-wp-hasher.php new file mode 100644 index 0000000..9f6a9c5 --- /dev/null +++ b/wp-includes/class-wp-hasher.php @@ -0,0 +1,44 @@ +hasher = new PasswordHash( 8, true ); + } + + // Test whether this PHP installation can use bcrypt + public function UseBcrypt() { + // Versions before 5.3.7 have bugs with their bcrypt implementations + return version_compare( PHP_VERSION, '5.3.7', '>=' ); + } + + // Test for a portable hash + public function HashIsPortable( $hash ) { + return substr( $hash, 0, 3 ) === '$P$'; + } + + public function HashPassword( $password ) { + if ( $this->UseBcrypt() ) { + return password_hash( $password, PASSWORD_BCRYPT ); + } else { + $this->InitializePasswordHash(); + return $this->hasher->HashPassword( $password ); + } + } + + public function CheckPassword( $password, $hash ) { + if ( $this->UseBcrypt() && ! $this->HashIsPortable( $hash ) ) { + return password_verify( $password, $hash ); + } else { + $this->InitializePasswordHash(); + return $this->hasher->CheckPassword( $password, $hash ); + } + } +} diff --git a/wp-includes/compat-password.php b/wp-includes/compat-password.php new file mode 100644 index 0000000..cc6896c --- /dev/null +++ b/wp-includes/compat-password.php @@ -0,0 +1,314 @@ + + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @copyright 2012 The Authors + */ + +namespace { + + if (!defined('PASSWORD_BCRYPT')) { + /** + * PHPUnit Process isolation caches constants, but not function declarations. + * So we need to check if the constants are defined separately from + * the functions to enable supporting process isolation in userland + * code. + */ + define('PASSWORD_BCRYPT', 1); + define('PASSWORD_DEFAULT', PASSWORD_BCRYPT); + define('PASSWORD_BCRYPT_DEFAULT_COST', 10); + } + + if (!function_exists('password_hash')) { + + /** + * Hash the password using the specified algorithm + * + * @param string $password The password to hash + * @param int $algo The algorithm to use (Defined by PASSWORD_* constants) + * @param array $options The options for the algorithm to use + * + * @return string|false The hashed password, or false on error. + */ + function password_hash($password, $algo, array $options = array()) { + if (!function_exists('crypt')) { + trigger_error("Crypt must be loaded for password_hash to function", E_USER_WARNING); + return null; + } + if (is_null($password) || is_int($password)) { + $password = (string) $password; + } + if (!is_string($password)) { + trigger_error("password_hash(): Password must be a string", E_USER_WARNING); + return null; + } + if (!is_int($algo)) { + trigger_error("password_hash() expects parameter 2 to be long, " . gettype($algo) . " given", E_USER_WARNING); + return null; + } + $resultLength = 0; + switch ($algo) { + case PASSWORD_BCRYPT: + $cost = PASSWORD_BCRYPT_DEFAULT_COST; + if (isset($options['cost'])) { + $cost = $options['cost']; + if ($cost < 4 || $cost > 31) { + trigger_error(sprintf("password_hash(): Invalid bcrypt cost parameter specified: %d", $cost), E_USER_WARNING); + return null; + } + } + // The length of salt to generate + $raw_salt_len = 16; + // The length required in the final serialization + $required_salt_len = 22; + $hash_format = sprintf("$2y$%02d$", $cost); + // The expected length of the final crypt() output + $resultLength = 60; + break; + default: + trigger_error(sprintf("password_hash(): Unknown password hashing algorithm: %s", $algo), E_USER_WARNING); + return null; + } + $salt_requires_encoding = false; + if (isset($options['salt'])) { + switch (gettype($options['salt'])) { + case 'NULL': + case 'boolean': + case 'integer': + case 'double': + case 'string': + $salt = (string) $options['salt']; + break; + case 'object': + if (method_exists($options['salt'], '__tostring')) { + $salt = (string) $options['salt']; + break; + } + case 'array': + case 'resource': + default: + trigger_error('password_hash(): Non-string salt parameter supplied', E_USER_WARNING); + return null; + } + if (PasswordCompat\binary\_strlen($salt) < $required_salt_len) { + trigger_error(sprintf("password_hash(): Provided salt is too short: %d expecting %d", PasswordCompat\binary\_strlen($salt), $required_salt_len), E_USER_WARNING); + return null; + } elseif (0 == preg_match('#^[a-zA-Z0-9./]+$#D', $salt)) { + $salt_requires_encoding = true; + } + } else { + $buffer = ''; + $buffer_valid = false; + if (function_exists('mcrypt_create_iv') && !defined('PHALANGER')) { + $buffer = mcrypt_create_iv($raw_salt_len, MCRYPT_DEV_URANDOM); + if ($buffer) { + $buffer_valid = true; + } + } + if (!$buffer_valid && function_exists('openssl_random_pseudo_bytes')) { + $buffer = openssl_random_pseudo_bytes($raw_salt_len); + if ($buffer) { + $buffer_valid = true; + } + } + if (!$buffer_valid && @is_readable('/dev/urandom')) { + $f = fopen('/dev/urandom', 'r'); + $read = PasswordCompat\binary\_strlen($buffer); + while ($read < $raw_salt_len) { + $buffer .= fread($f, $raw_salt_len - $read); + $read = PasswordCompat\binary\_strlen($buffer); + } + fclose($f); + if ($read >= $raw_salt_len) { + $buffer_valid = true; + } + } + if (!$buffer_valid || PasswordCompat\binary\_strlen($buffer) < $raw_salt_len) { + $bl = PasswordCompat\binary\_strlen($buffer); + for ($i = 0; $i < $raw_salt_len; $i++) { + if ($i < $bl) { + $buffer[$i] = $buffer[$i] ^ chr(mt_rand(0, 255)); + } else { + $buffer .= chr(mt_rand(0, 255)); + } + } + } + $salt = $buffer; + $salt_requires_encoding = true; + } + if ($salt_requires_encoding) { + // encode string with the Base64 variant used by crypt + $base64_digits = + 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'; + $bcrypt64_digits = + './ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; + + $base64_string = base64_encode($salt); + $salt = strtr(rtrim($base64_string, '='), $base64_digits, $bcrypt64_digits); + } + $salt = PasswordCompat\binary\_substr($salt, 0, $required_salt_len); + + $hash = $hash_format . $salt; + + $ret = crypt($password, $hash); + + if (!is_string($ret) || PasswordCompat\binary\_strlen($ret) != $resultLength) { + return false; + } + + return $ret; + } + + /** + * Get information about the password hash. Returns an array of the information + * that was used to generate the password hash. + * + * array( + * 'algo' => 1, + * 'algoName' => 'bcrypt', + * 'options' => array( + * 'cost' => PASSWORD_BCRYPT_DEFAULT_COST, + * ), + * ) + * + * @param string $hash The password hash to extract info from + * + * @return array The array of information about the hash. + */ + function password_get_info($hash) { + $return = array( + 'algo' => 0, + 'algoName' => 'unknown', + 'options' => array(), + ); + if (PasswordCompat\binary\_substr($hash, 0, 4) == '$2y$' && PasswordCompat\binary\_strlen($hash) == 60) { + $return['algo'] = PASSWORD_BCRYPT; + $return['algoName'] = 'bcrypt'; + list($cost) = sscanf($hash, "$2y$%d$"); + $return['options']['cost'] = $cost; + } + return $return; + } + + /** + * Determine if the password hash needs to be rehashed according to the options provided + * + * If the answer is true, after validating the password using password_verify, rehash it. + * + * @param string $hash The hash to test + * @param int $algo The algorithm used for new password hashes + * @param array $options The options array passed to password_hash + * + * @return boolean True if the password needs to be rehashed. + */ + function password_needs_rehash($hash, $algo, array $options = array()) { + $info = password_get_info($hash); + if ($info['algo'] != $algo) { + return true; + } + switch ($algo) { + case PASSWORD_BCRYPT: + $cost = isset($options['cost']) ? $options['cost'] : PASSWORD_BCRYPT_DEFAULT_COST; + if ($cost != $info['options']['cost']) { + return true; + } + break; + } + return false; + } + + /** + * Verify a password against a hash using a timing attack resistant approach + * + * @param string $password The password to verify + * @param string $hash The hash to verify against + * + * @return boolean If the password matches the hash + */ + function password_verify($password, $hash) { + if (!function_exists('crypt')) { + trigger_error("Crypt must be loaded for password_verify to function", E_USER_WARNING); + return false; + } + $ret = crypt($password, $hash); + if (!is_string($ret) || PasswordCompat\binary\_strlen($ret) != PasswordCompat\binary\_strlen($hash) || PasswordCompat\binary\_strlen($ret) <= 13) { + return false; + } + + $status = 0; + for ($i = 0; $i < PasswordCompat\binary\_strlen($ret); $i++) { + $status |= (ord($ret[$i]) ^ ord($hash[$i])); + } + + return $status === 0; + } + } + +} + +namespace PasswordCompat\binary { + + if (!function_exists('PasswordCompat\\binary\\_strlen')) { + + /** + * Count the number of bytes in a string + * + * We cannot simply use strlen() for this, because it might be overwritten by the mbstring extension. + * In this case, strlen() will count the number of *characters* based on the internal encoding. A + * sequence of bytes might be regarded as a single multibyte character. + * + * @param string $binary_string The input string + * + * @internal + * @return int The number of bytes + */ + function _strlen($binary_string) { + if (function_exists('mb_strlen')) { + return mb_strlen($binary_string, '8bit'); + } + return strlen($binary_string); + } + + /** + * Get a substring based on byte limits + * + * @see _strlen() + * + * @param string $binary_string The input string + * @param int $start + * @param int $length + * + * @internal + * @return string The substring + */ + function _substr($binary_string, $start, $length) { + if (function_exists('mb_substr')) { + return mb_substr($binary_string, $start, $length, '8bit'); + } + return substr($binary_string, $start, $length); + } + + /** + * Check if current PHP version is compatible with the library + * + * @return boolean the check result + */ + function check() { + static $pass = NULL; + + if (is_null($pass)) { + if (function_exists('crypt')) { + $hash = '$2y$04$usesomesillystringfore7hnbRJHxXVLeakoG8K30oukPsA.ztMG'; + $test = crypt("password", $hash); + $pass = $test == $hash; + } else { + $pass = false; + } + } + return $pass; + } + + } +} \ No newline at end of file diff --git a/wp-includes/default-filters.php b/wp-includes/default-filters.php index 3402e48..bc7843f 100644 --- a/wp-includes/default-filters.php +++ b/wp-includes/default-filters.php @@ -262,6 +262,8 @@ add_action( 'login_head', 'print_admin_styles', 9 ); add_action( 'login_head', 'wp_site_icon', 99 ); add_action( 'login_footer', 'wp_print_footer_scripts', 20 ); add_action( 'login_init', 'send_frame_options_header', 10, 0 ); +add_filter( 'check_password', 'wp_upgrade_password', 10, 4 ); +add_filter( 'wp_authenticate_user','wp_user_can_authenticate', 10, 1 ); // Feed Generator Tags foreach ( array( 'rss2_head', 'commentsrss2_head', 'rss_head', 'rdf_header', 'atom_head', 'comments_atom_head', 'opml_head', 'app_head' ) as $action ) { diff --git a/wp-includes/pluggable.php b/wp-includes/pluggable.php index 5c77477..2397560 100644 --- a/wp-includes/pluggable.php +++ b/wp-includes/pluggable.php @@ -1739,8 +1739,8 @@ function wp_new_user_notification( $user_id, $deprecated = null, $notify = '' ) // Now insert the key, hashed, into the DB. if ( empty( $wp_hasher ) ) { - require_once ABSPATH . WPINC . '/class-phpass.php'; - $wp_hasher = new PasswordHash( 8, true ); + require_once ABSPATH . WPINC . '/class-wp-hasher.php'; + $wp_hasher = new WP_Hasher(); } $hashed = time() . ':' . $wp_hasher->HashPassword( $key ); $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) ); @@ -2014,9 +2014,9 @@ function wp_hash_password($password) { global $wp_hasher; if ( empty($wp_hasher) ) { - require_once( ABSPATH . WPINC . '/class-phpass.php'); + require_once( ABSPATH . WPINC . '/class-wp-hasher.php'); // By default, use the portable hash from phpass - $wp_hasher = new PasswordHash(8, true); + $wp_hasher = new WP_Hasher(); } return $wp_hasher->HashPassword( trim( $password ) ); @@ -2074,9 +2074,9 @@ function wp_check_password($password, $hash, $user_id = '') { // If the stored hash is longer than an MD5, presume the // new style phpass portable hash. if ( empty($wp_hasher) ) { - require_once( ABSPATH . WPINC . '/class-phpass.php'); + require_once( ABSPATH . WPINC . '/class-wp-hasher.php'); // By default, use the portable hash from phpass - $wp_hasher = new PasswordHash(8, true); + $wp_hasher = new WP_Hasher(); } $check = $wp_hasher->CheckPassword($password, $hash); diff --git a/wp-includes/user.php b/wp-includes/user.php index 6d473ef..36cb303 100644 --- a/wp-includes/user.php +++ b/wp-includes/user.php @@ -2095,8 +2095,8 @@ function get_password_reset_key( $user ) { // Now insert the key, hashed, into the DB. if ( empty( $wp_hasher ) ) { - require_once ABSPATH . WPINC . '/class-phpass.php'; - $wp_hasher = new PasswordHash( 8, true ); + require_once ABSPATH . WPINC . '/class-wp-hasher.php'; + $wp_hasher = new WP_Hasher(); } $hashed = time() . ':' . $wp_hasher->HashPassword( $key ); $key_saved = $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) ); @@ -2140,8 +2140,8 @@ function check_password_reset_key($key, $login) { return new WP_Error('invalid_key', __('Invalid key')); if ( empty( $wp_hasher ) ) { - require_once ABSPATH . WPINC . '/class-phpass.php'; - $wp_hasher = new PasswordHash( 8, true ); + require_once ABSPATH . WPINC . '/class-wp-hasher.php'; + $wp_hasher = new WP_Hasher(); } /** @@ -2507,3 +2507,41 @@ function _wp_get_current_user() { return $current_user; } + +/** + * Upgrades user's password from "portable" hashes to bcrypt. + */ + function wp_upgrade_password( $check, $password, $hash, $user_id ) { + if ( $check && substr( $hash, 0, 3 ) === '$P$' ) { + wp_set_password( $password, $user_id ); + } + + return $check; + } + + /** + * Tests to make sure the user's password hash can be used. + */ + function wp_user_can_authenticate( $user ) { + global $wp_hasher; + + if ( empty( $wp_hasher ) ) { + require_once ABSPATH . WPINC . '/class-wp-hasher.php'; + $wp_hasher = new WP_Hasher(); + } + + if (!$wp_hasher->UseBcrypt() && !$wp_hasher->HashIsPortable( $user->user_pass )) { + return new WP_Error( + 'unusable_password', + __( 'ERROR: Sorry, something has gone wrong and you must reset your password.' ) . + '
' . + __( 'More information' ) . + '' . + '
' . + __( 'Reset your password' ) . + '' + ); + } + + return $user; + } diff --git a/wp-login.php b/wp-login.php index 01c754f..c622123 100644 --- a/wp-login.php +++ b/wp-login.php @@ -444,8 +444,8 @@ case 'postpass' : exit(); } - require_once ABSPATH . WPINC . '/class-phpass.php'; - $hasher = new PasswordHash( 8, true ); + require_once ABSPATH . WPINC . '/class-wp-hasher.php'; + $hasher = new WP_Hasher(); /** * Filters the life span of the post password cookie.