86d37b3f847737c6312632981c1fa523cd0fe699
[openssl.git] / doc / man3 / RAND_bytes.pod
1 =pod
2
3 =head1 NAME
4
5 RAND_bytes, RAND_priv_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  int RAND_priv_bytes(unsigned char *buf, int num);
13
14 Deprecated since OpenSSL 1.1.0, can be hidden entirely by defining
15 B<OPENSSL_API_COMPAT> with a suitable version value, see
16 L<openssl_user_macros(7)>:
17
18  int RAND_pseudo_bytes(unsigned char *buf, int num);
19
20 =head1 DESCRIPTION
21
22 RAND_bytes() puts B<num> cryptographically strong pseudo-random bytes
23 into B<buf>.
24
25 RAND_priv_bytes() has the same semantics as RAND_bytes().  It is intended to
26 be used for generating values that should remain private. If using the
27 default RAND_METHOD, this function uses a separate "private" PRNG
28 instance so that a compromise of the "public" PRNG instance will not
29 affect the secrecy of these private values, as described in L<RAND(7)>
30 and L<RAND_DRBG(7)>.
31
32 =head1 NOTES
33
34 Always check the error return value of RAND_bytes() and
35 RAND_priv_bytes() and do not take randomness for granted: an error occurs
36 if the CSPRNG has not been seeded with enough randomness to ensure an
37 unpredictable byte sequence.
38
39 =head1 RETURN VALUES
40
41 RAND_bytes() and RAND_priv_bytes()
42 return 1 on success, -1 if not supported by the current
43 RAND method, or 0 on other failure. The error code can be
44 obtained by L<ERR_get_error(3)>.
45
46 =head1 HISTORY
47
48 =over 2
49
50 =item *
51
52 RAND_pseudo_bytes() was deprecated in OpenSSL 1.1.0; use RAND_bytes() instead.
53
54 =item *
55
56 The RAND_priv_bytes() function was added in OpenSSL 1.1.1.
57
58 =back
59
60 =head1 SEE ALSO
61
62 L<RAND_add(3)>,
63 L<RAND_bytes(3)>,
64 L<RAND_priv_bytes(3)>,
65 L<ERR_get_error(3)>,
66 L<RAND(7)>,
67 L<RAND_DRBG(7)>
68
69 =head1 COPYRIGHT
70
71 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
72
73 Licensed under the Apache License 2.0 (the "License").  You may not use
74 this file except in compliance with the License.  You can obtain a copy
75 in the file LICENSE in the source distribution or at
76 L<https://www.openssl.org/source/license.html>.
77
78 =cut