RAND_bytes.pod 1.9 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4
=pod

=head1 NAME

5
RAND_bytes, RAND_priv_bytes, RAND_pseudo_bytes - generate random data
U
Ulf Möller 已提交
6 7 8 9 10 11

=head1 SYNOPSIS

 #include <openssl/rand.h>

 int RAND_bytes(unsigned char *buf, int num);
12
 int RAND_priv_bytes(unsigned char *buf, int num);
U
Ulf Möller 已提交
13

M
Matt Caswell 已提交
14 15
Deprecated:

16
 #if OPENSSL_API_COMPAT < 0x10100000L
U
Ulf Möller 已提交
17
 int RAND_pseudo_bytes(unsigned char *buf, int num);
18
 #endif
U
Ulf Möller 已提交
19 20 21

=head1 DESCRIPTION

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 27 28 29 30 31 32 33 34 35 36 37
be used for generating values that should remain private. If using the
default RAND_METHOD, this function uses a separate "private" PRNG
instance so that a compromise of the "public" PRNG instance will not
affect the secrecy of these private values, as described in L<RAND(7)>
and L<RAND_DRBG(7)>.

=head1 NOTES

Always check the error return value of RAND_bytes() and
RAND_priv_bytes() and do not take randomness for granted: an error occurs
if the CSPRNG has not been seeded with enough randomness to ensure an
unpredictable byte sequence.
38

U
Ulf Möller 已提交
39 40
=head1 RETURN VALUES

41
RAND_bytes() and RAND_priv_bytes()
42
return 1 on success, -1 if not supported by the current
R
Rich Salz 已提交
43 44 45
RAND method, or 0 on other failure. The error code can be
obtained by L<ERR_get_error(3)>.

R
Rich Salz 已提交
46
=head1 HISTORY
R
Rich Salz 已提交
47

48 49 50 51
=over 2

=item *

R
Rich Salz 已提交
52
RAND_pseudo_bytes() was deprecated in OpenSSL 1.1.0; use RAND_bytes() instead.
U
Ulf Möller 已提交
53

54 55 56 57 58 59
=item *

RAND_priv_bytes() was added in OpenSSL 1.1.1.

=back

U
Ulf Möller 已提交
60 61
=head1 SEE ALSO

62 63
L<RAND_add(3)>,
L<RAND_bytes(3)>,
64
L<RAND_priv_bytes(3)>,
65
L<ERR_get_error(3)>,
66 67
L<RAND(7)>,
L<RAND_DRBG(7)>
U
Ulf Möller 已提交
68

R
Rich Salz 已提交
69 70
=head1 COPYRIGHT

71
Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
R
Rich Salz 已提交
72 73 74 75 76 77 78

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut