[thirdparty/openssl.git] / doc / man3 / CRYPTO_memcmp.pod

=pod

=head1 NAME

CRYPTO_memcmp - Constant time memory comparison

=head1 SYNOPSIS

 #include <openssl/crypto.h>

 int CRYPTO_memcmp(const void *a, const void *b, size_t len);

=head1 DESCRIPTION

The CRYPTO_memcmp function compares the B<len> bytes pointed to by B<a> and B<b>
for equality.
It takes an amount of time dependent on B<len>, but independent of the
contents of the memory regions pointed to by B<a> and B<b>.

=head1 RETURN VALUES

CRYPTO_memcmp() returns 0 if the memory regions are equal and nonzero
otherwise.

=head1 NOTES

Unlike memcmp(2), this function cannot be used to order the two memory regions
as the return value when they differ is undefined, other than being nonzero.

=head1 COPYRIGHT

Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
0ccff7a7 P	1	=pod
	2
	3	=head1 NAME
	4
	5	CRYPTO_memcmp - Constant time memory comparison
	6
	7	=head1 SYNOPSIS
	8
	9	#include <openssl/crypto.h>
	10
	11	int CRYPTO_memcmp(const void a, const void b, size_t len);
	12
	13	=head1 DESCRIPTION
	14
	15	The CRYPTO_memcmp function compares the B<len> bytes pointed to by B<a> and B<b>
	16	for equality.
	17	It takes an amount of time dependent on B<len>, but independent of the
	18	contents of the memory regions pointed to by B<a> and B<b>.
	19
	20	=head1 RETURN VALUES
	21
9c0586d5	22	CRYPTO_memcmp() returns 0 if the memory regions are equal and nonzero
0ccff7a7 P	23	otherwise.
	24
	25	=head1 NOTES
	26
	27	Unlike memcmp(2), this function cannot be used to order the two memory regions
9c0586d5	28	as the return value when they differ is undefined, other than being nonzero.
0ccff7a7 P	29
	30	=head1 COPYRIGHT
	31
	32	Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
	33
	34	Licensed under the Apache License 2.0 (the "License"). You may not use
	35	this file except in compliance with the License. You can obtain a copy
	36	in the file LICENSE in the source distribution or at
	37	L<https://www.openssl.org/source/license.html>.
	38
	39	=cut