Add SSL_get_pending_cipher()
[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:
15
16  #if OPENSSL_API_COMPAT < 0x10100000L
17  int RAND_pseudo_bytes(unsigned char *buf, int num);
18  #endif
19
20 =head1 DESCRIPTION
21
22 RAND_bytes() puts B<num> cryptographically strong pseudo-random bytes
23 into B<buf>. An error occurs if the PRNG has not been seeded with
24 enough randomness to ensure an unpredictable byte sequence.
25
26 RAND_priv_bytes() has the same semantics as RAND_bytes().  It is intended to
27 be used for generating long-term private keys. If using the default
28 RAND_METHOD, this function uses a separate instance of the PRNG so that
29 a compromise of the global generator will not affect such key generation.
30
31 =head1 RETURN VALUES
32
33 RAND_bytes() nad RAND_priv_bytes()
34 return 1 on success, -1 if not supported by the current
35 RAND method, or 0 on other failure. The error code can be
36 obtained by L<ERR_get_error(3)>.
37
38 =head1 HISTORY
39
40 RAND_pseudo_bytes() was deprecated in OpenSSL 1.1.0; use RAND_bytes() instead.
41
42 =head1 SEE ALSO
43
44 L<RAND_bytes(3)>, L<ERR_get_error(3)>,
45 L<RAND_add(3)>
46
47 =head1 COPYRIGHT
48
49 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
50
51 Licensed under the OpenSSL license (the "License").  You may not use
52 this file except in compliance with the License.  You can obtain a copy
53 in the file LICENSE in the source distribution or at
54 L<https://www.openssl.org/source/license.html>.
55
56 =cut