Simplify BN_rand_range
[openssl.git] / doc / crypto / BN_rand.pod
index f0f3b45..2a8bed5 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-BN_rand - Generate pseudo-random number
+BN_rand, BN_pseudo_rand - generate pseudo-random number
 
 =head1 SYNOPSIS
 
@@ -10,6 +10,10 @@ BN_rand - Generate pseudo-random number
 
  int BN_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(BIGNUM *rnd, BIGNUM *range);
+
 =head1 DESCRIPTION
 
 BN_rand() generates a cryptographically strong pseudo-random number of
@@ -18,19 +22,30 @@ 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*B<bits> length.
 If B<bottom> is true, the number will be odd.
 
-The PRNG must be seeded prior to calling BN_rand().
+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 <lt>= B<rnd> E<lt> B<range>.
+
+The PRNG must be seeded prior to calling BN_rand() or BN_rand_range().
 
 =head1 RETURN VALUES
 
-BN_rand() returns 1 on success, 0 on error.
-The error codes can be obtained by ERR_get_error(3).
+The functions return 1 on success, 0 on error.
+The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
 
 =head1 SEE ALSO
 
-bn(3), err(3), rand(3), RAND_add(), RAND_bytes()
+L<bn(3)|bn(3)>, L<err(3)|err(3)>, L<rand(3)|rand(3)>,
+L<RAND_add(3)|RAND_add(3)>, L<RAND_bytes(3)|RAND_bytes(3)>
 
 =head1 HISTORY
 
 BN_rand() is available in all versions of SSLeay and OpenSSL.
+BN_pseudo_rand() was added in OpenSSL 0.9.5, and BN_rand_range()
+in OpenSSL 0.9.6a.
 
 =cut