Debian Codegraph @

upstream/debian-unstable/man3/CRYPTO_memcmp.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "CRYPTO_MEMCMP 3SSL"
58 .TH CRYPTO_MEMCMP 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 CRYPTO_memcmp \- Constant time memory comparison
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/crypto.h>
69 \&
70 \& int CRYPTO_memcmp(const void *a, const void *b, size_t len);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 The CRYPTO_memcmp function compares the \fBlen\fR bytes pointed to by \fBa\fR and \fBb\fR
75 for equality.
76 It takes an amount of time dependent on \fBlen\fR, but independent of the
77 contents of the memory regions pointed to by \fBa\fR and \fBb\fR.
78 .SH "RETURN VALUES"
79 .IX Header "RETURN VALUES"
80 \&\fBCRYPTO_memcmp()\fR returns 0 if the memory regions are equal and nonzero
81 otherwise.
82 .SH NOTES
83 .IX Header "NOTES"
84 Unlike \fBmemcmp\fR\|(2), this function cannot be used to order the two memory regions
85 as the return value when they differ is undefined, other than being nonzero.
86 .SH COPYRIGHT
87 .IX Header "COPYRIGHT"
88 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
89 .PP
90 Licensed under the Apache License 2.0 (the "License"). You may not use
91 this file except in compliance with the License. You can obtain a copy
92 in the file LICENSE in the source distribution or at
93 <https://www.openssl.org/source/license.html>.