$NetBSD: BN_copy.3,v 1.5 2026/04/08 17:06:41 christos Exp $ -*- mode: troff; coding: utf-8 -*- Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) 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
Required to disable full justification in groff 1.23.0. ======================================================================== Title "BN_copy 3" BN_copy 3 2026-04-07 3.5.6 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents..nh
NAME
BN_copy, BN_dup, BN_with_flags - copy BIGNUMs
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <
openssl/
bn.h>
\&
BIGNUM *BN_copy(BIGNUM *to, const BIGNUM *from);
\&
BIGNUM *BN_dup(const BIGNUM *from);
\&
void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBBN_copy() copies
from to
to.
BN_dup() creates a new
BIGNUM
containing the value
from.
BN_with_flags creates a temporary shallow copy of b in dest. It places
significant restrictions on the copied data. Applications that do no adhere to
these restrictions may encounter unexpected side effects or crashes. For that
reason use of this function is discouraged. Any flags provided in flags will
be set in dest in addition to any flags already set in b. For example this
might commonly be used to create a temporary copy of a BIGNUM with the
\fBBN_FLG_CONSTTIME flag set for constant time operations. The temporary copy in
\fBdest will share some internal state with b. For this reason the following
restrictions apply to the use of dest:
\(bu 2
\fBdest should be a newly allocated BIGNUM obtained via a call to
BN_new(). It
should not have been used for other purposes or initialised in any way.
\(bu 2
\fBdest must only be used in "read-only" operations, i.e. typically those
functions where the relevant parameter is declared "const".
\(bu 2
\fBdest must be used and freed before any further subsequent use of
b
"RETURN VALUES"
Header "RETURN VALUES" \fBBN_copy() returns
to on success, NULL on error.
BN_dup() returns
the new
BIGNUM, and NULL on error. The error codes can be obtained
by
ERR_get_error\|(3).
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3)
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>.