$NetBSD: BN_new.3,v 1.25 2024/09/08 13:08:16 christos Exp $
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
Standard preamble:
========================================================================
..
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "BN_new 3"
way too many mistakes in technical documents.
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
Standard preamble:
========================================================================
..
.... \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "BN_new 3"
BN_new 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makesway too many mistakes in technical documents.
NAME
BN_new, BN_secure_new, BN_clear, BN_free, BN_clear_free - allocate and free BIGNUMs
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <openssl/bn.h>
\&
BIGNUM *BN_new(void);
\&
BIGNUM *BN_secure_new(void);
\&
void BN_clear(BIGNUM *a);
\&
void BN_free(BIGNUM *a);
\&
void BN_clear_free(BIGNUM *a);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBBN_new() allocates and initializes a BIGNUM structure.
\fBBN_secure_new() does the same except that the secure heap
\fBOPENSSL_secure_malloc\|(3) is used to store the value.
\fBBN_clear() is used to destroy sensitive data such as keys when they are no longer needed. It erases the memory used by a and sets it to the value 0. If a is NULL, nothing is done.
\fBBN_free() frees the components of the BIGNUM, and if it was created by BN_new(), also the structure itself. BN_clear_free() additionally overwrites the data before the memory is returned to the system. If a is NULL, nothing is done.
"RETURN VALUES"
Header "RETURN VALUES" \fBBN_new() and BN_secure_new()
return a pointer to the BIGNUM initialised to the value 0.
If the allocation fails,
they return NULL and set an error code that can be obtained
by ERR_get_error\|(3).
\fBBN_clear(), BN_free() and BN_clear_free() have no return values.
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3), OPENSSL_secure_malloc\|(3)
HISTORY
Header "HISTORY" \fBBN_init() was removed in OpenSSL 1.1.0; use BN_new() instead.
COPYRIGHT
Header "COPYRIGHT" Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.