Deprecate RAND_pseudo_bytes

[openssl.git] / doc / crypto / RAND_bytes.pod

diff --git a/doc/crypto/RAND_bytes.pod b/doc/crypto/RAND_bytes.pod
index ec874f1216056b24e2e191e383bc1def1baa07ba..f3a5ed22f860dab975f9c29f4b4e09a3e4b65c27 100644 (file)
--- a/doc/crypto/RAND_bytes.pod
+++ b/doc/crypto/RAND_bytes.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
 
 =head1 NAME
 

-RAND_bytes, RAND_pseudo_bytes - Generate random data
+RAND_bytes, RAND_pseudo_bytes - generate random data

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 


@@ -10,6 +10,8 @@ RAND_bytes, RAND_pseudo_bytes - Generate random data
 
  int RAND_bytes(unsigned char *buf, int num);
 
 
  int RAND_bytes(unsigned char *buf, int num);
 

+Deprecated:
+

  int RAND_pseudo_bytes(unsigned char *buf, int num);
 
 =head1 DESCRIPTION
  int RAND_pseudo_bytes(unsigned char *buf, int num);
 
 =head1 DESCRIPTION


@@ -18,6 +20,7 @@ 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.
 
 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
 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


@@ -25,6 +28,9 @@ unpredictable. They can be used for non-cryptographic purposes and for
 certain purposes in cryptographic protocols, but usually not for key
 generation etc.
 
 certain purposes in cryptographic protocols, but usually 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
 =head1 RETURN VALUES
 
 RAND_bytes() returns 1 on success, 0 otherwise. The error code can be


@@ -35,7 +41,8 @@ method.
 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 

-L<rand(3)|rand(3)>, L<err(3)|err(3)>, L<RAND_add(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
 
 
 =head1 HISTORY