2fe932fd3f42839b11a9c92cf27b6ab8c34529ea
[openssl.git] / doc / man3 / RAND_load_file.pod
1 =pod
2
3 =head1 NAME
4
5 RAND_load_file, RAND_write_file, RAND_file_name - PRNG seed file
6
7 =head1 SYNOPSIS
8
9  #include <openssl/rand.h>
10
11  int RAND_load_file(const char *filename, long max_bytes);
12
13  int RAND_write_file(const char *filename);
14
15  const char *RAND_file_name(char *buf, size_t num);
16
17 =head1 DESCRIPTION
18
19 RAND_load_file() reads a number of bytes from file B<filename> and
20 adds them to the PRNG. If B<max_bytes> is non-negative,
21 up to B<max_bytes> are read;
22 if B<max_bytes> is -1, the complete file is read.
23 Do not load the same file multiple times unless its contents have
24 been updated by RAND_write_file() between reads.
25 Also, note that B<filename> should be adequately protected so that an
26 attacker cannot replace or examine the contents.
27
28 RAND_write_file() writes a number of random bytes (currently 128) to
29 file B<filename> which can be used to initialize the PRNG by calling
30 RAND_load_file() in a later session.
31
32 RAND_file_name() generates a default path for the random seed
33 file. B<buf> points to a buffer of size B<num> in which to store the
34 filename.
35
36 On all systems, if the environment variable B<RANDFILE> is set, its
37 value will be used as the seed file name.
38 Otherwise, the file is called C<.rnd>, found in platform dependent locations:
39
40 =over 4
41
42 =item On Windows (in order of preference)
43
44  %HOME%, %USERPROFILE%, %SYSTEMROOT%, C:\
45
46 =item On VMS
47
48  SYS$LOGIN:
49
50 =item On all other systems
51
52  $HOME
53
54 =back
55
56 If C<$HOME> (on non-Windows and non-VMS system) is not set either, or
57 B<num> is too small for the path name, an error occurs.
58
59 =head1 RETURN VALUES
60
61 RAND_load_file() returns the number of bytes read or -1 on error.
62
63 RAND_write_file() returns the number of bytes written, or -1 if the
64 bytes written were generated without appropriate seeding.
65
66 RAND_file_name() returns a pointer to B<buf> on success, and NULL on
67 error.
68
69 =head1 SEE ALSO
70
71 L<RAND_bytes(3)>, L<RAND_add(3)>
72
73 =head1 HISTORY
74
75 A comment in the source since at least OpenSSL 1.0.2 said that
76 RAND_load_file() and RAND_write_file() were only intended for regular files,
77 and not really device special files such as C</dev/random>.  This was
78 poorly enforced before OpenSSL 1.1.1.
79
80 =head1 COPYRIGHT
81
82 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
83
84 Licensed under the OpenSSL license (the "License").  You may not use
85 this file except in compliance with the License.  You can obtain a copy
86 in the file LICENSE in the source distribution or at
87 L<https://www.openssl.org/source/license.html>.
88
89 =cut