8fc985ee3e9e185ad1aa363b549f223cf82725ea
[openssl.git] / doc / crypto / 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  char *RAND_file_name(char *buf, int num);
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
21 filename. The seed file is $RANDFILE, if that environment variable is
22 set, $HOME/.rand otherwise. If $HOME is not set either, or B<num> is
23 too small for the path name, an error occurs.
24
25 RAND_load_file() reads up to B<max_bytes> from file B<filename> and
26 adds them to the PRNG.
27
28 RAND_write_file() writes a number of random bytes (currently 1024) to
29 file B<filename> which can be used to initialze the PRNG by calling
30 RAND_load_file() in a later session.
31
32 =head1 RETURN VALUES
33
34 RAND_load_file() returns the number of bytes read.
35
36 RAND_write_file() returns the number of bytes written, and -1 if the
37 bytes written were generated without appropriate seed.
38
39 RAND_file_name() returns a pointer to B<buf> on success, and NULL on
40 error.
41
42 =head1 SEE ALSO
43
44 rand(3), RAND_add(3), RAND_cleanup(3)
45
46 =head1 HISTORY
47
48 RAND_load_file(), RAND_write_file() and RAND_file_name() are available in
49 all versions of SSLeay and OpenSSL.
50
51 =cut