233 lines
8.2 KiB
Groff
Executable File
233 lines
8.2 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. 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\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, 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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. 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
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. 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
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "BN_RAND 3"
|
|
.TH BN_RAND 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
BN_rand_ex, BN_rand, BN_priv_rand_ex, BN_priv_rand, BN_pseudo_rand,
|
|
BN_rand_range_ex, BN_rand_range, BN_priv_rand_range_ex, BN_priv_rand_range,
|
|
BN_pseudo_rand_range
|
|
\&\- generate pseudo\-random number
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/bn.h>
|
|
\&
|
|
\& int BN_rand_ex(BIGNUM *rnd, int bits, int top, int bottom, BN_CTX *ctx);
|
|
\& int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
|
|
\&
|
|
\& int BN_priv_rand_ex(BIGNUM *rnd, int bits, int top, int bottom, BN_CTX *ctx);
|
|
\& int BN_priv_rand(BIGNUM *rnd, int bits, int top, int bottom);
|
|
\&
|
|
\& int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
|
|
\&
|
|
\& int BN_rand_range_ex(BIGNUM *rnd, BIGNUM *range, BN_CTX *ctx);
|
|
\& int BN_rand_range(BIGNUM *rnd, BIGNUM *range);
|
|
\&
|
|
\& int BN_priv_rand_range_ex(BIGNUM *rnd, BIGNUM *range, BN_CTX *ctx);
|
|
\& int BN_priv_rand_range(BIGNUM *rnd, BIGNUM *range);
|
|
\&
|
|
\& int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fIBN_rand_ex()\fR generate a cryptographically strong pseudo-random
|
|
number of \fBbits\fR in length and stores it in \fBrnd\fR using the random number
|
|
generator for the library context associated with \fBctx\fR. The parameter \fBctx\fR
|
|
may be \s-1NULL\s0 in which case the default library context is used.
|
|
If \fBbits\fR is less than zero, or too small to
|
|
accommodate the requirements specified by the \fBtop\fR and \fBbottom\fR
|
|
parameters, an error is returned.
|
|
The \fBtop\fR parameters specifies
|
|
requirements on the most significant bit of the generated number.
|
|
If it is \fB\s-1BN_RAND_TOP_ANY\s0\fR, there is no constraint.
|
|
If it is \fB\s-1BN_RAND_TOP_ONE\s0\fR, the top bit must be one.
|
|
If it is \fB\s-1BN_RAND_TOP_TWO\s0\fR, the two most significant bits of
|
|
the number will be set to 1, so that the product of two such random
|
|
numbers will always have 2*\fBbits\fR length.
|
|
If \fBbottom\fR is \fB\s-1BN_RAND_BOTTOM_ODD\s0\fR, the number will be odd; if it
|
|
is \fB\s-1BN_RAND_BOTTOM_ANY\s0\fR it can be odd or even.
|
|
If \fBbits\fR is 1 then \fBtop\fR cannot also be \fB\s-1BN_RAND_FLG_TOPTWO\s0\fR.
|
|
.PP
|
|
\&\fIBN_rand()\fR is the same as \fIBN_rand_ex()\fR except that the default library context
|
|
is always used.
|
|
.PP
|
|
\&\fIBN_rand_range_ex()\fR generates a cryptographically strong pseudo-random
|
|
number \fBrnd\fR in the range 0 <= \fBrnd\fR < \fBrange\fR using the random number
|
|
generator for the library context associated with \fBctx\fR. The parameter \fBctx\fR
|
|
may be \s-1NULL\s0 in which case the default library context is used.
|
|
.PP
|
|
\&\fIBN_rand_range()\fR is the same as \fIBN_rand_range_ex()\fR except that the default
|
|
library context is always used.
|
|
.PP
|
|
\&\fIBN_priv_rand_ex()\fR, \fIBN_priv_rand()\fR, \fIBN_priv_rand_rand_ex()\fR and
|
|
\&\fIBN_priv_rand_range()\fR have the same semantics as \fIBN_rand_ex()\fR, \fIBN_rand()\fR,
|
|
\&\fIBN_rand_range_ex()\fR and \fIBN_rand_range()\fR respectively. They are intended to be
|
|
used for generating values that should remain private, and mirror the
|
|
same difference between \fIRAND_bytes\fR\|(3) and \fIRAND_priv_bytes\fR\|(3).
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
Always check the error return value of these functions and do not take
|
|
randomness for granted: an error occurs if the \s-1CSPRNG\s0 has not been
|
|
seeded with enough randomness to ensure an unpredictable byte sequence.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
The functions return 1 on success, 0 on error.
|
|
The error codes can be obtained by \fIERR_get_error\fR\|(3).
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIERR_get_error\fR\|(3),
|
|
\&\fIRAND_add\fR\|(3),
|
|
\&\fIRAND_bytes\fR\|(3),
|
|
\&\fIRAND_priv_bytes\fR\|(3),
|
|
\&\s-1\fIRAND\s0\fR\|(7),
|
|
\&\s-1\fIRAND_DRBG\s0\fR\|(7)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
.IP "\(bu" 2
|
|
Starting with OpenSSL release 1.1.0, \fIBN_pseudo_rand()\fR has been identical
|
|
to \fIBN_rand()\fR and \fIBN_pseudo_rand_range()\fR has been identical to
|
|
\&\fIBN_rand_range()\fR.
|
|
The \*(L"pseudo\*(R" functions should not be used and may be deprecated in
|
|
a future release.
|
|
.IP "\(bu" 2
|
|
The
|
|
\&\fIBN_priv_rand()\fR and \fIBN_priv_rand_range()\fR functions were added in OpenSSL 1.1.1.
|
|
.IP "\(bu" 2
|
|
The \fIBN_rand_ex()\fR, \fIBN_priv_rand_ex()\fR, \fIBN_rand_range_ex()\fR and
|
|
\&\fIBN_priv_rand_range_ex()\fR functions were added in OpenSSL 3.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
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>.
|