wpseek.com
A WordPress-centric search engine for devs and theme authors



hash_equals › WordPress Function

Since3.9.2
Deprecatedn/a
hash_equals ( $known_string, $user_string )
Parameters: (2)
  • (string) $known_string Expected string.
    Required: Yes
  • (string) $user_string Actual, user supplied, string.
    Required: Yes
Returns:
  • (bool) Whether strings are equal.
Defined at:
Codex:

Timing attack safe string comparison.

Compares two strings using the same time whether they're equal or not. Note: It can leak the length of a string when arguments of differing length are supplied. This function was added in PHP 5.6. However, the Hash extension may be explicitly disabled on select servers. As of PHP 7.4.0, the Hash extension is a core PHP extension and can no longer be disabled. I.e. when PHP 7.4.0 becomes the minimum requirement, this polyfill can be safely removed.


Source

function hash_equals( $known_string, $user_string ) {
		$known_string_length = strlen( $known_string );

		if ( strlen( $user_string ) !== $known_string_length ) {
			return false;
		}

		$result = 0;

		// Do not attempt to "optimize" this.
		for ( $i = 0; $i < $known_string_length; $i++ ) {
			$result |= ord( $known_string[ $i ] ) ^ ord( $user_string[ $i ] );
		}

		return 0 === $result;
	}
endif;

// sodium_crypto_box() was introduced in PHP 7.2.
if ( ! function_exists( 'sodium_crypto_box' ) ) {
	require ABSPATH . WPINC . '/sodium_compat/autoload.php';
}