]>
Commit | Line | Data |
---|---|---|
60b52453 UM |
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 | ||
fba90464 | 11 | const char *RAND_file_name(char *buf, size_t num); |
60b52453 UM |
12 | |
13 | int RAND_load_file(const char *filename, long max_bytes); | |
14 | ||
15 | int RAND_write_file(const char *filename); | |
16 | ||
17 | =head1 DESCRIPTION | |
18 | ||
19 | RAND_file_name() generates a default path for the random seed | |
20 | file. B<buf> points to a buffer of size B<num> in which to store the | |
05ccd698 BM |
21 | filename. The seed file is $RANDFILE if that environment variable is |
22 | set, $HOME/.rnd otherwise. If $HOME is not set either, or B<num> is | |
60b52453 UM |
23 | too small for the path name, an error occurs. |
24 | ||
05ccd698 BM |
25 | RAND_load_file() reads a number of bytes from file B<filename> and |
26 | adds them to the PRNG. If B<max_bytes> is non-negative, | |
b9b6a7e5 | 27 | up to B<max_bytes> are read; |
a7b991bd | 28 | if B<max_bytes> is -1, the complete file is read. |
60b52453 UM |
29 | |
30 | RAND_write_file() writes a number of random bytes (currently 1024) to | |
e93f9a32 | 31 | file B<filename> which can be used to initialize the PRNG by calling |
60b52453 UM |
32 | RAND_load_file() in a later session. |
33 | ||
34 | =head1 RETURN VALUES | |
35 | ||
36 | RAND_load_file() returns the number of bytes read. | |
37 | ||
38 | RAND_write_file() returns the number of bytes written, and -1 if the | |
39 | bytes written were generated without appropriate seed. | |
40 | ||
41 | RAND_file_name() returns a pointer to B<buf> on success, and NULL on | |
42 | error. | |
43 | ||
44 | =head1 SEE ALSO | |
45 | ||
9b86974e | 46 | L<rand(3)>, L<RAND_add(3)>, L<RAND_cleanup(3)> |
60b52453 | 47 | |
60b52453 | 48 | =cut |
e2f92610 RS |
49 | |
50 | =head1 COPYRIGHT | |
51 | ||
52 | Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. | |
53 | ||
54 | Licensed under the OpenSSL license (the "License"). You may not use | |
55 | this file except in compliance with the License. You can obtain a copy | |
56 | in the file LICENSE in the source distribution or at | |
57 | L<https://www.openssl.org/source/license.html>. | |
58 | ||
59 | =cut |