doc/man3/RAND_bytes.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RAND_bytes, RAND_priv_bytes, RAND_bytes_ex, RAND_priv_bytes_ex,
   6 RAND_pseudo_bytes - generate random data
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/rand.h>
  11
  12  int RAND_bytes(unsigned char *buf, int num);
  13  int RAND_priv_bytes(unsigned char *buf, int num);
  14
  15  int RAND_bytes_ex(OPENSSL_CTX *ctx, unsigned char *buf, int num);
  16  int RAND_priv_bytes_ex(OPENSSL_CTX *ctx, unsigned char *buf, int num);
  17
  18 Deprecated since OpenSSL 1.1.0, can be hidden entirely by defining
  19 B<OPENSSL_API_COMPAT> with a suitable version value, see
  20 L<openssl_user_macros(7)>:
  21
  22  int RAND_pseudo_bytes(unsigned char *buf, int num);
  23
  24 =head1 DESCRIPTION
  25
  26 RAND_bytes() generates B<num> random bytes using a cryptographically
  27 secure pseudo random generator (CSPRNG) and stores them in B<buf>.
  28
  29 RAND_priv_bytes() has the same semantics as RAND_bytes().  It is intended to
  30 be used for generating values that should remain private. If using the
  31 default RAND_METHOD, this function uses a separate "private" PRNG
  32 instance so that a compromise of the "public" PRNG instance will not
  33 affect the secrecy of these private values, as described in L<RAND(7)>
  34 and L<RAND_DRBG(7)>.
  35
  36 RAND_bytes_ex() and RAND_priv_bytes_ex() are the same as RAND_bytes() and
  37 RAND_priv_bytes() except that they both take an additional I<ctx> parameter.
  38 The DRBG used for the operation is the public or private DRBG associated with
  39 the specified I<ctx>. The parameter can be NULL, in which case
  40 the default library context is used (see L<OPENSSL_CTX(3)>.
  41 If the default RAND_METHOD has been changed then for compatibility reasons the
  42 RAND_METHOD will be used in preference and the DRBG of the library context
  43 ignored.
  44
  45 =head1 NOTES
  46
  47 By default, the OpenSSL CSPRNG supports a security level of 256 bits, provided it
  48 was able to seed itself from a trusted entropy source.
  49 On all major platforms supported by OpenSSL (including the Unix-like platforms
  50 and Windows), OpenSSL is configured to automatically seed the CSPRNG on first use
  51 using the operating systems's random generator.
  52
  53 If the entropy source fails or is not available, the CSPRNG will enter an
  54 error state and refuse to generate random bytes. For that reason, it is important
  55 to always check the error return value of RAND_bytes() and RAND_priv_bytes() and
  56 not take randomness for granted.
  57
  58 On other platforms, there might not be a trusted entropy source available
  59 or OpenSSL might have been explicitly configured to use different entropy sources.
  60 If you are in doubt about the quality of the entropy source, don't hesitate to ask
  61 your operating system vendor or post a question on GitHub or the openssl-users
  62 mailing list.
  63
  64 =head1 RETURN VALUES
  65
  66 RAND_bytes() and RAND_priv_bytes()
  67 return 1 on success, -1 if not supported by the current
  68 RAND method, or 0 on other failure. The error code can be
  69 obtained by L<ERR_get_error(3)>.
  70
  71 =head1 SEE ALSO
  72
  73 L<RAND_add(3)>,
  74 L<RAND_bytes(3)>,
  75 L<RAND_priv_bytes(3)>,
  76 L<ERR_get_error(3)>,
  77 L<RAND(7)>,
  78 L<RAND_DRBG(7)>
  79
  80 =head1 HISTORY
  81
  82 =over 2
  83
  84 =item *
  85
  86 RAND_pseudo_bytes() was deprecated in OpenSSL 1.1.0; use RAND_bytes() instead.
  87
  88 =item *
  89
  90 The RAND_priv_bytes() function was added in OpenSSL 1.1.1.
  91
  92 =item *
  93
  94 The RAND_bytes_ex() and RAND_priv_bytes_ex() functions were added in OpenSSL 3.0
  95
  96 =back
  97
  98 =head1 COPYRIGHT
  99
 100 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 101
 102 Licensed under the Apache License 2.0 (the "License").  You may not use
 103 this file except in compliance with the License.  You can obtain a copy
 104 in the file LICENSE in the source distribution or at
 105 L<https://www.openssl.org/source/license.html>.
 106
 107 =cut