aboutsummaryrefslogtreecommitdiff
path: root/doc/man3/BN_rand.pod
diff options
context:
space:
mode:
authorRich Salz <rsalz@openssl.org>2017-06-21 13:55:02 +0100
committerRich Salz <rsalz@openssl.org>2017-07-03 19:26:56 -0400
commit5ecff87d666f47d0003b106c61ada1e25655b81d (patch)
tree108956af50bdc6bf5d396014fe700b2c18565244 /doc/man3/BN_rand.pod
parent299c9cbb631869026537c96b7431d7682dd3c008 (diff)
downloadopenssl-5ecff87d666f47d0003b106c61ada1e25655b81d.zip
openssl-5ecff87d666f47d0003b106c61ada1e25655b81d.tar.gz
openssl-5ecff87d666f47d0003b106c61ada1e25655b81d.tar.bz2
BN_pseudo_rand is really BN_rand
And BN_pseudo_rand_range is really BN_rand_range. Document that we might deprecate those functions. Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3743)
Diffstat (limited to 'doc/man3/BN_rand.pod')
-rw-r--r--doc/man3/BN_rand.pod16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/man3/BN_rand.pod b/doc/man3/BN_rand.pod
index 08d14de..099dda4 100644
--- a/doc/man3/BN_rand.pod
+++ b/doc/man3/BN_rand.pod
@@ -34,15 +34,8 @@ 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_pseudo_rand() does the same, but pseudo-random numbers generated by
-this function are not necessarily unpredictable. They can be used for
-non-cryptographic purposes and for certain purposes in cryptographic
-protocols, but usually not for key generation etc.
-
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_pseudo_rand_range() does the same, but is based on BN_pseudo_rand(),
-and hence numbers generated by it are not necessarily unpredictable.
The PRNG must be seeded prior to calling BN_rand() or BN_rand_range().
@@ -51,6 +44,15 @@ The PRNG must be seeded prior to calling BN_rand() or BN_rand_range().
The functions return 1 on success, 0 on error.
The error codes can be obtained by L<ERR_get_error(3)>.
+=head1 HISTORY
+
+Starting with OpenSSL release 1.1.0,
+BN_pseudo_rand() has been identical to BN_rand()
+and
+BN_pseudo_rand_range() has been identical to BN_rand_range().
+The "pseudo" functions should not be used and may be deprecated in
+a future release.
+
=head1 SEE ALSO
L<ERR_get_error(3)>, L<RAND_add(3)>, L<RAND_bytes(3)>