xref: /freebsd/secure/lib/libcrypto/man/man3/BN_copy.3 (revision aa1a8ff2d6dbc51ef058f46f3db5a8bb77967145)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "BN_COPY 3ossl"
BN_COPY 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"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 \s-1BIGNUM\s0 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 \s-1BIGNUM\s0 with the \fB\s-1BN_FLG_CONSTTIME\s0 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 \s-1BIGNUM\s0 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 \*(L"read-only\*(R" operations, i.e. typically those functions where the relevant parameter is declared \*(L"const\*(R".
"\(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, \s-1NULL\s0 on error. BN_dup() returns the new \s-1BIGNUM\s0, and \s-1NULL\s0 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 \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.