doc/crypto/RAND_bytes.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RAND_bytes, RAND_pseudo_bytes - generate random data
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rand.h>
  10
  11  int RAND_bytes(unsigned char *buf, int num);
  12
  13 Deprecated:
  14
  15  int RAND_pseudo_bytes(unsigned char *buf, int num);
  16
  17 =head1 DESCRIPTION
  18
  19 RAND_bytes() puts B<num> cryptographically strong pseudo-random bytes
  20 into B<buf>. An error occurs if the PRNG has not been seeded with
  21 enough randomness to ensure an unpredictable byte sequence.
  22
  23 RAND_pseudo_bytes() has been deprecated. Users should use RAND_bytes() instead.
  24 RAND_pseudo_bytes() puts B<num> pseudo-random bytes into B<buf>.
  25 Pseudo-random byte sequences generated by RAND_pseudo_bytes() will be
  26 unique if they are of sufficient length, but are not necessarily
  27 unpredictable. They can be used for non-cryptographic purposes and for
  28 certain purposes in cryptographic protocols, but usually not for key
  29 generation etc.
  30
  31 The contents of B<buf> is mixed into the entropy pool before retrieving
  32 the new pseudo-random bytes unless disabled at compile time (see FAQ).
  33
  34 =head1 RETURN VALUES
  35
  36 RAND_bytes() returns 1 on success, 0 otherwise. The error code can be
  37 obtained by L<ERR_get_error(3)>. RAND_pseudo_bytes() returns 1 if the
  38 bytes generated are cryptographically strong, 0 otherwise. Both
  39 functions return -1 if they are not supported by the current RAND
  40 method.
  41
  42 =head1 SEE ALSO
  43
  44 L<rand(3)>, L<ERR_get_error(3)>,
  45 L<RAND_add(3)>
  46
  47 =head1 HISTORY
  48
  49 RAND_bytes() is available in all versions of SSLeay and OpenSSL.  It
  50 has a return value since OpenSSL 0.9.5. RAND_pseudo_bytes() was added
  51 in OpenSSL 0.9.5.
  52
  53 =cut