memcmp(3)

compare memory areas

Section 3 manpages-dev bookworm source

Summary

memcmp() compares the first n bytes of two memory areas, treating each byte as an unsigned char. It returns an integer that is less than, equal to, or greater than zero depending on whether the first differing byte in s1 is less than, equal to, or greater than the corresponding byte in s2. Use it to test whether two buffers hold identical bytes or to order them.

Tip: Do not use memcmp() to compare secrets like passwords or cryptographic keys: its running time depends on how many leading bytes match, which leaks information; use a constant-time comparison instead.

Description

memcmp

NAME

memcmp - compare memory areas

LIBRARY

Standard C library (libc, -lc)

SYNOPSIS

#include <string.h>

int memcmp(const void s1[.n], const void s2[.n], size_t n);

DESCRIPTION

The memcmp() function compares the first n bytes (each interpreted as unsigned char) of the memory areas s1 and s2.

RETURN VALUE

The memcmp() function returns an integer less than, equal to, or greater than zero if the first n bytes of s1 is found, respectively, to be less than, to match, or be greater than the first n bytes of s2.

For a nonzero return value, the sign is determined by the sign of the difference between the first pair of bytes (interpreted as unsigned char) that differ in s1 and s2.

If n is zero, the return value is zero.

ATTRIBUTES

For an explanation of the terms used in this section, see attributes(7).

Image grohtml-41263-1.png

STANDARDS

POSIX.1-2001, POSIX.1-2008, C99, SVr4, 4.3BSD.

NOTES

Do not use memcmp() to compare security critical data, such as cryptographic secrets, because the required CPU time depends on the number of equal bytes. Instead, a function that performs comparisons in constant time is required. Some operating systems provide such a function (e.g., NetBSD’s consttime_memequal()), but no such function is specified in POSIX. On Linux, it may be necessary to implement such a function oneself.

SEE ALSO

bstring(3), strcasecmp(3), strcmp(3), strcoll(3), strncasecmp(3), strncmp(3), wmemcmp(3)

Examples

if (memcmp(buf1, buf2, len) == 0) { /* buffers are identical */ }

Check whether two buffers contain the same len bytes (zero means equal).

int r = memcmp(a, b, n);  /* r < 0, 0, or > 0 */

Order two memory areas; the sign reflects the first differing byte compared as unsigned char.

memcmp(p, q, 0);  /* always returns 0 */

Comparing zero bytes always reports equal.