Debian Codegraph @

upstream/debian-unstable/man3/BN_CTX_start.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_CTX_START 3SSL"
58 .TH BN_CTX_START 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_CTX_start, BN_CTX_get, BN_CTX_end \- use temporary BIGNUM variables
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bn.h>
69 \&
70 \& void BN_CTX_start(BN_CTX *ctx);
71 \&
72 \& BIGNUM *BN_CTX_get(BN_CTX *ctx);
73 \&
74 \& void BN_CTX_end(BN_CTX *ctx);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 These functions are used to obtain temporary \fBBIGNUM\fR variables from
79 a \fBBN_CTX\fR (which can been created by using \fBBN_CTX_new\fR\|(3))
80 in order to save the overhead of repeatedly creating and
81 freeing \fBBIGNUM\fRs in functions that are called from inside a loop.
82 .PP
83 A function must call \fBBN_CTX_start()\fR first. Then, \fBBN_CTX_get()\fR may be
84 called repeatedly to obtain temporary \fBBIGNUM\fRs. All \fBBN_CTX_get()\fR
85 calls must be made before calling any other functions that use the
86 \&\fBctx\fR as an argument.
87 .PP
88 Finally, \fBBN_CTX_end()\fR must be called before returning from the function.
89 If \fBctx\fR is NULL, nothing is done.
90 When \fBBN_CTX_end()\fR is called, the \fBBIGNUM\fR pointers obtained from
91 \&\fBBN_CTX_get()\fR become invalid.
92 .SH "RETURN VALUES"
93 .IX Header "RETURN VALUES"
94 \&\fBBN_CTX_start()\fR and \fBBN_CTX_end()\fR return no values.
95 .PP
96 \&\fBBN_CTX_get()\fR returns a pointer to the \fBBIGNUM\fR, or \fBNULL\fR on error.
97 Once \fBBN_CTX_get()\fR has failed, the subsequent calls will return \fBNULL\fR
98 as well, so it is sufficient to check the return value of the last
99 \&\fBBN_CTX_get()\fR call. In case of an error, an error code is set, which
100 can be obtained by \fBERR_get_error\fR\|(3).
101 .SH "SEE ALSO"
102 .IX Header "SEE ALSO"
103 \&\fBBN_CTX_new\fR\|(3)
104 .SH COPYRIGHT
105 .IX Header "COPYRIGHT"
106 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
107 .PP
108 Licensed under the Apache License 2.0 (the "License"). You may not use
109 this file except in compliance with the License. You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 <https://www.openssl.org/source/license.html>.