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  #if OPENSSL_API_COMPAT < 0x10100000L
  16  int RAND_pseudo_bytes(unsigned char *buf, int num);
  17  #endif
  18
  19 =head1 DESCRIPTION
  20
  21 RAND_bytes() puts B<num> cryptographically strong pseudo-random bytes
  22 into B<buf>. An error occurs if the PRNG has not been seeded with
  23 enough randomness to ensure an unpredictable byte sequence.
  24
  25 RAND_pseudo_bytes() has been deprecated. Users should use RAND_bytes() instead.
  26 RAND_pseudo_bytes() puts B<num> pseudo-random bytes into B<buf>.
  27 Pseudo-random byte sequences generated by RAND_pseudo_bytes() will be
  28 unique if they are of sufficient length, but are not necessarily
  29 unpredictable. They can be used for non-cryptographic purposes and for
  30 certain purposes in cryptographic protocols, but usually not for key
  31 generation etc.
  32
  33 The contents of B<buf> is mixed into the entropy pool before retrieving
  34 the new pseudo-random bytes unless disabled at compile time (see FAQ).
  35
  36 =head1 RETURN VALUES
  37
  38 RAND_bytes() returns 1 on success, 0 otherwise. The error code can be
  39 obtained by L<ERR_get_error(3)>. RAND_pseudo_bytes() returns 1 if the
  40 bytes generated are cryptographically strong, 0 otherwise. Both
  41 functions return -1 if they are not supported by the current RAND
  42 method.
  43
  44 =head1 SEE ALSO
  45
  46 L<rand(3)>, L<ERR_get_error(3)>,
  47 L<RAND_add(3)>
  48
  49 =head1 COPYRIGHT
  50
  51 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  52
  53 Licensed under the OpenSSL license (the "License").  You may not use
  54 this file except in compliance with the License.  You can obtain a copy
  55 in the file LICENSE in the source distribution or at
  56 L<https://www.openssl.org/source/license.html>.
  57
  58 =cut