Debian Codegraph @

upstream/debian-unstable/man3/BN_zero.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_ZERO 3SSL"
58 .TH BN_ZERO 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_zero, BN_one, BN_value_one, BN_set_word, BN_get_word \- BIGNUM assignment
65 operations
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/bn.h>
70 \&
71 \& void BN_zero(BIGNUM *a);
72 \& int BN_one(BIGNUM *a);
73 \&
74 \& const BIGNUM *BN_value_one(void);
75 \&
76 \& int BN_set_word(BIGNUM *a, BN_ULONG w);
77 \& unsigned BN_ULONG BN_get_word(BIGNUM *a);
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 \&\fBBN_ULONG\fR is a macro that will be an unsigned integral type optimized
82 for the most efficient implementation on the local platform.
83 .PP
84 \&\fBBN_zero()\fR, \fBBN_one()\fR and \fBBN_set_word()\fR set \fBa\fR to the values 0, 1 and
85 \&\fBw\fR respectively. \fBBN_zero()\fR and \fBBN_one()\fR are macros.
86 .PP
87 \&\fBBN_value_one()\fR returns a \fBBIGNUM\fR constant of value 1. This constant
88 is useful for use in comparisons and assignment.
89 .PP
90 \&\fBBN_get_word()\fR returns \fBa\fR, if it can be represented as a \fBBN_ULONG\fR.
91 .SH "RETURN VALUES"
92 .IX Header "RETURN VALUES"
93 \&\fBBN_get_word()\fR returns the value \fBa\fR, or all-bits-set if \fBa\fR cannot
94 be represented as a single integer.
95 .PP
96 \&\fBBN_one()\fR and \fBBN_set_word()\fR return 1 on success, 0 otherwise.
97 \&\fBBN_value_one()\fR returns the constant.
98 \&\fBBN_zero()\fR never fails and returns no value.
99 .SH BUGS
100 .IX Header "BUGS"
101 If a \fBBIGNUM\fR is equal to the value of all-bits-set, it will collide
102 with the error condition returned by \fBBN_get_word()\fR which uses that
103 as an error value.
104 .PP
105 \&\fBBN_ULONG\fR should probably be a typedef.
106 .SH "SEE ALSO"
107 .IX Header "SEE ALSO"
108 \&\fBBN_bn2bin\fR\|(3)
109 .SH HISTORY
110 .IX Header "HISTORY"
111 In OpenSSL 0.9.8, \fBBN_zero()\fR was changed to not return a value; previous
112 versions returned an int.
113 .SH COPYRIGHT
114 .IX Header "COPYRIGHT"
115 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
116 .PP
117 Licensed under the Apache License 2.0 (the "License"). You may not use
118 this file except in compliance with the License. You can obtain a copy
119 in the file LICENSE in the source distribution or at
120 <https://www.openssl.org/source/license.html>.