RAND_load_file.pod 1.9 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.

23 24
On all systems, if the environment variable B<RANDFILE> is set, its
value will be used as the seed file name.
25

26
Otherwise, the file is called ".rnd", found in platform dependent locations:
27

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
=over 4

=item On Windows (in order of preference)

%HOME%, %USERPROFILE%, %SYSTEMROOT%, C:\

=item On VMS

SYS$LOGIN:

=item On all other systems

$HOME

=back

If C<$HOME> (on non-Windows and non-VMS system) is not set either, or
B<num> is too small for the path name, an error occurs.
U
Ulf Möller 已提交
46

47 48
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,
A
Alex Gaynor 已提交
49
up to B<max_bytes> are read;
50
if B<max_bytes> is -1, the complete file is read.
U
Ulf Möller 已提交
51 52

RAND_write_file() writes a number of random bytes (currently 1024) to
U
Ulf Möller 已提交
53
file B<filename> which can be used to initialize the PRNG by calling
U
Ulf Möller 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67
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 已提交
68
L<rand(3)>, L<RAND_add(3)>, L<RAND_cleanup(3)>
U
Ulf Möller 已提交
69

R
Rich Salz 已提交
70 71 72 73 74 75 76 77 78 79
=head1 COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

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