hash_equals()WP 3.9.2

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.

No Hooks.

Return

true|false. Whether strings are equal.

Usage

hash_equals( $known_string, $user_string );
$known_string(string) (required)
Expected string.
$user_string(string) (required)
Actual, user supplied, string.

Changelog

Since 3.9.2 Introduced.

hash_equals() code WP 6.4.3

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;
}