Debian Codegraph @

upstream/debian-unstable/man3/BN_new.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_NEW 3SSL"
58 .TH BN_NEW 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_new, BN_secure_new, BN_clear, BN_free, BN_clear_free \- allocate and free BIGNUMs
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bn.h>
69 \&
70 \& BIGNUM *BN_new(void);
71 \&
72 \& BIGNUM *BN_secure_new(void);
73 \&
74 \& void BN_clear(BIGNUM *a);
75 \&
76 \& void BN_free(BIGNUM *a);
77 \&
78 \& void BN_clear_free(BIGNUM *a);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 \&\fBBN_new()\fR allocates and initializes a \fBBIGNUM\fR structure.
83 \&\fBBN_secure_new()\fR does the same except that the secure heap
84 \&\fBOPENSSL_secure_malloc\fR\|(3) is used to store the value.
85 .PP
86 \&\fBBN_clear()\fR is used to destroy sensitive data such as keys when they
87 are no longer needed. It erases the memory used by \fBa\fR and sets it
88 to the value 0.
89 If \fBa\fR is NULL, nothing is done.
90 .PP
91 \&\fBBN_free()\fR frees the components of the \fBBIGNUM\fR, and if it was created
92 by \fBBN_new()\fR, also the structure itself. \fBBN_clear_free()\fR additionally
93 overwrites the data before the memory is returned to the system.
94 If \fBa\fR is NULL, nothing is done.
95 .SH "RETURN VALUES"
96 .IX Header "RETURN VALUES"
97 \&\fBBN_new()\fR and \fBBN_secure_new()\fR
98 return a pointer to the \fBBIGNUM\fR initialised to the value 0.
99 If the allocation fails,
100 they return \fBNULL\fR and set an error code that can be obtained
101 by \fBERR_get_error\fR\|(3).
102 .PP
103 \&\fBBN_clear()\fR, \fBBN_free()\fR and \fBBN_clear_free()\fR have no return values.
104 .SH "SEE ALSO"
105 .IX Header "SEE ALSO"
106 \&\fBERR_get_error\fR\|(3), \fBOPENSSL_secure_malloc\fR\|(3)
107 .SH HISTORY
108 .IX Header "HISTORY"
109 \&\fBBN_init()\fR was removed in OpenSSL 1.1.0; use \fBBN_new()\fR instead.
110 .SH COPYRIGHT
111 .IX Header "COPYRIGHT"
112 Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
113 .PP
114 Licensed under the Apache License 2.0 (the "License"). You may not use
115 this file except in compliance with the License. You can obtain a copy
116 in the file LICENSE in the source distribution or at
117 <https://www.openssl.org/source/license.html>.