Debian Codegraph @

upstream/debian-unstable/man3/BN_cmp.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 "BN_CMP 3SSL"
58 .TH BN_CMP 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 BN_cmp, BN_ucmp, BN_is_zero, BN_is_one, BN_is_word, BN_abs_is_word, BN_is_odd, BN_are_coprime
65 \&\- BIGNUM comparison and test functions
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/bn.h>
70 \&
71 \& int BN_cmp(const BIGNUM *a, const BIGNUM *b);
72 \& int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
73 \&
74 \& int BN_is_zero(const BIGNUM *a);
75 \& int BN_is_one(const BIGNUM *a);
76 \& int BN_is_word(const BIGNUM *a, const BN_ULONG w);
77 \& int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
78 \& int BN_is_odd(const BIGNUM *a);
79 \&
80 \& int BN_are_coprime(BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
81 .Ve
82 .SH DESCRIPTION
83 .IX Header "DESCRIPTION"
84 \&\fBBN_cmp()\fR compares the numbers \fIa\fR and \fIb\fR. \fBBN_ucmp()\fR compares their
85 absolute values.
86 .PP
87 \&\fBBN_is_zero()\fR, \fBBN_is_one()\fR, \fBBN_is_word()\fR and \fBBN_abs_is_word()\fR test if
88 \&\fIa\fR equals 0, 1, \fIw\fR, or |\fIw\fR| respectively.
89 \&\fBBN_is_odd()\fR tests if \fIa\fR is odd.
90 .PP
91 \&\fBBN_are_coprime()\fR determines if \fBa\fR and \fBb\fR are coprime.
92 \&\fBctx\fR is used internally for storing temporary variables.
93 The values of \fBa\fR and \fBb\fR and \fBctx\fR must not be NULL.
94 .SH "RETURN VALUES"
95 .IX Header "RETURN VALUES"
96 \&\fBBN_cmp()\fR returns \-1 if \fIa\fR < \fIb\fR, 0 if \fIa\fR == \fIb\fR and 1 if
97 \&\fIa\fR > \fIb\fR. \fBBN_ucmp()\fR is the same using the absolute values
98 of \fIa\fR and \fIb\fR.
99 .PP
100 \&\fBBN_is_zero()\fR, \fBBN_is_one()\fR \fBBN_is_word()\fR, \fBBN_abs_is_word()\fR and
101 \&\fBBN_is_odd()\fR return 1 if the condition is true, 0 otherwise.
102 .PP
103 \&\fBBN_are_coprime()\fR returns 1 if the \fBBIGNUM\fR's are coprime, otherwise it
104 returns 0.
105 .SH HISTORY
106 .IX Header "HISTORY"
107 Prior to OpenSSL 1.1.0, \fBBN_is_zero()\fR, \fBBN_is_one()\fR, \fBBN_is_word()\fR,
108 \&\fBBN_abs_is_word()\fR and \fBBN_is_odd()\fR were macros.
109 .PP
110 The function \fBBN_are_coprime()\fR was added in OpenSSL 3.1.
111 .SH COPYRIGHT
112 .IX Header "COPYRIGHT"
113 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
114 .PP
115 Licensed under the Apache License 2.0 (the "License"). You may not use
116 this file except in compliance with the License. You can obtain a copy
117 in the file LICENSE in the source distribution or at
118 <https://www.openssl.org/source/license.html>.