RAND_load_file.pod 1.5 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4 5 6 7 8 9 10
=pod

=head1 NAME

RAND_load_file, RAND_write_file, RAND_file_name - PRNG seed file

=head1 SYNOPSIS

 #include <openssl/rand.h>

B
Bodo Möller 已提交
11
 const char *RAND_file_name(char *buf, size_t num);
U
Ulf Möller 已提交
12 13 14 15 16 17 18 19 20

 int RAND_load_file(const char *filename, long max_bytes);

 int RAND_write_file(const char *filename);

=head1 DESCRIPTION

RAND_file_name() generates a default path for the random seed
file. B<buf> points to a buffer of size B<num> in which to store the
21 22
filename. The seed file is $RANDFILE if that environment variable is
set, $HOME/.rnd otherwise. If $HOME is not set either, or B<num> is
U
Ulf Möller 已提交
23 24
too small for the path name, an error occurs.

25 26
RAND_load_file() reads a number of bytes from file B<filename> and
adds them to the PRNG. If B<max_bytes> is non-negative,
27 28
up to to B<max_bytes> are read; starting with OpenSSL 0.9.5,
if B<max_bytes> is -1, the complete file is read.
U
Ulf Möller 已提交
29 30

RAND_write_file() writes a number of random bytes (currently 1024) to
U
Ulf Möller 已提交
31
file B<filename> which can be used to initialize the PRNG by calling
U
Ulf Möller 已提交
32 33 34 35 36 37 38 39 40 41 42 43 44 45
RAND_load_file() in a later session.

=head1 RETURN VALUES

RAND_load_file() returns the number of bytes read.

RAND_write_file() returns the number of bytes written, and -1 if the
bytes written were generated without appropriate seed.

RAND_file_name() returns a pointer to B<buf> on success, and NULL on
error.

=head1 SEE ALSO

R
Rich Salz 已提交
46
L<rand(3)>, L<RAND_add(3)>, L<RAND_cleanup(3)>
U
Ulf Möller 已提交
47 48 49 50 51 52 53

=head1 HISTORY

RAND_load_file(), RAND_write_file() and RAND_file_name() are available in
all versions of SSLeay and OpenSSL.

=cut