Deprecate RAND_pseudo_bytes
[openssl.git] / doc / crypto / RAND_bytes.pod
index 4abe93a..f3a5ed2 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RAND_bytes, RAND_pseudo_bytes - Generate random data
+RAND_bytes, RAND_pseudo_bytes - generate random data
 
 =head1 SYNOPSIS
 
@@ -10,29 +10,39 @@ RAND_bytes, RAND_pseudo_bytes - Generate random data
 
  int RAND_bytes(unsigned char *buf, int num);
 
+Deprecated:
+
  int RAND_pseudo_bytes(unsigned char *buf, int num);
 
 =head1 DESCRIPTION
 
-RAND_bytes() puts B<num> random bytes into B<buf>. An error occurs if
-the PRNG has not been seeded with enough randomness.
+RAND_bytes() puts B<num> cryptographically strong pseudo-random bytes
+into B<buf>. An error occurs if the PRNG has not been seeded with
+enough randomness to ensure an unpredictable byte sequence.
+
+RAND_pseudo_bytes() has been deprecated. Users should use RAND_bytes() instead.
+RAND_pseudo_bytes() puts B<num> pseudo-random bytes into B<buf>.
+Pseudo-random byte sequences generated by RAND_pseudo_bytes() will be
+unique if they are of sufficient length, but 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.
 
-RAND_pseudo_bytes() puts B<num> pseudo-random bytes into B<buf>. These
-bytes are guaranteed to be unique, but not unpredictable. They can be
-used for non-cryptographic purposes and for certain purposes in
-cryptographic protocols, but not for key generation etc.
+The contents of B<buf> is mixed into the entropy pool before retrieving
+the new pseudo-random bytes unless disabled at compile time (see FAQ).
 
 =head1 RETURN VALUES
 
 RAND_bytes() returns 1 on success, 0 otherwise. The error code can be
-obtained by ERR_get_error(3). RAND_pseudo_bytes() returns 1 if the
+obtained by L<ERR_get_error(3)|ERR_get_error(3)>. RAND_pseudo_bytes() returns 1 if the
 bytes generated are cryptographically strong, 0 otherwise. Both
 functions return -1 if they are not supported by the current RAND
 method.
 
 =head1 SEE ALSO
 
-rand(3), err(3), RAND_add(3)
+L<rand(3)|rand(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
+L<RAND_add(3)|RAND_add(3)>
 
 =head1 HISTORY