php8.5
Home/ Manual/ sodium / functions/ sodium_memcmp

sodium_memcmp

PHP function Edit on GitHub ✎

(PHP 7 >= 7.2.0, PHP 8)

Test for equality in constant-time

Description

sodium_memcmp(string $string1, string $string2): int

Compare two strings in constant-time.

In practice, you almost always want to use hash_equals() instead, since it provides the same logic but returns a bool instead of an int. However, if you're using the return value of a comparison in a calculation that's timing-sensitive, and worried about timing leaks with bool-to-int conversions, sodium_memcmp() is an ideal replacement.

Parameters

string1

String to compare

string2

Other string to compare

Return Values

Returns 0 if both strings are equal; -1 otherwise.

Source: reference/sodium/functions/sodium-memcmp.xml · from the official PHP manual (php/doc-en)