diff options
author | Matt Caswell <matt@openssl.org> | 2019-06-28 11:24:51 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2019-07-02 16:49:18 +0100 |
commit | ee1d4f3db4e8963c6472420d0256c2bfd6525137 (patch) | |
tree | 476e1b636b9a7140ae49d11a59175ee4e8fa311c /doc | |
parent | 6694e51dbaecc7b331a6f0fa484d77008367c59c (diff) |
Make BIGNUM rand functions available within the FIPS module
The BIGNUM rand functions were previously disabled for the FIPS module.
We can now re-enable them.
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/9193)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/BN_rand.pod | 37 |
1 files changed, 29 insertions, 8 deletions
diff --git a/doc/man3/BN_rand.pod b/doc/man3/BN_rand.pod index 93e8c3f9d4..fc41322f8e 100644 --- a/doc/man3/BN_rand.pod +++ b/doc/man3/BN_rand.pod @@ -2,30 +2,37 @@ =head1 NAME -BN_rand, BN_priv_rand, BN_pseudo_rand, -BN_rand_range, BN_priv_rand_range, BN_pseudo_rand_range +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 =head1 SYNOPSIS #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); =head1 DESCRIPTION -BN_rand() generates a cryptographically strong pseudo-random number of -B<bits> in length and stores it in B<rnd>. +BN_rand_ex() generate a cryptographically strong pseudo-random +number of B<bits> in length and stores it in B<rnd> using the random number +generator for the library context associated with B<ctx>. The parameter B<ctx> +may be NULL in which case the default library context is used. If B<bits> is less than zero, or too small to accommodate the requirements specified by the B<top> and B<bottom> parameters, an error is returned. @@ -40,11 +47,20 @@ If B<bottom> is B<BN_RAND_BOTTOM_ODD>, the number will be odd; if it is B<BN_RAND_BOTTOM_ANY> it can be odd or even. If B<bits> is 1 then B<top> cannot also be B<BN_RAND_FLG_TOPTWO>. -BN_rand_range() generates a cryptographically strong pseudo-random -number B<rnd> in the range 0 E<lt>= B<rnd> E<lt> B<range>. +BN_rand() is the same as BN_rand_ex() except that the default library context +is always used. -BN_priv_rand() and BN_priv_rand_range() have the same semantics as -BN_rand() and BN_rand_range() respectively. They are intended to be +BN_rand_range_ex() generates a cryptographically strong pseudo-random +number B<rnd> in the range 0 E<lt>= B<rnd> E<lt> B<range> using the random number +generator for the library context associated with B<ctx>. The parameter B<ctx> +may be NULL in which case the default library context is used. + +BN_rand_range() is the same as BN_rand_range_ex() except that the default +library context is always used. + +BN_priv_rand_ex(), BN_priv_rand(), BN_priv_rand_rand_ex() and +BN_priv_rand_range() have the same semantics as BN_rand_ex(), BN_rand(), +BN_rand_range_ex() and BN_rand_range() respectively. They are intended to be used for generating values that should remain private, and mirror the same difference between L<RAND_bytes(3)> and L<RAND_priv_bytes(3)>. @@ -85,6 +101,11 @@ a future release. The BN_priv_rand() and BN_priv_rand_range() functions were added in OpenSSL 1.1.1. +=item * + +The BN_rand_ex(), BN_priv_rand_ex(), BN_rand_range_ex() and +BN_priv_rand_range_ex() functions were added in OpenSSL 3.0. + =back =head1 COPYRIGHT |