openssl/doc/crypto/RAND_load_file.pod

49 lines
1.3 KiB
Plaintext
Raw Normal View History

2000-01-22 01:50:27 +08:00
=pod
=head1 NAME
RAND_load_file, RAND_write_file, RAND_file_name - PRNG seed file
=head1 SYNOPSIS
#include <openssl/rand.h>
2001-03-21 23:25:56 +08:00
const char *RAND_file_name(char *buf, size_t num);
2000-01-22 01:50:27 +08:00
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
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
2000-01-22 01:50:27 +08:00
too small for the path name, an error occurs.
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,
up to to B<max_bytes> are read;
if B<max_bytes> is -1, the complete file is read.
2000-01-22 01:50:27 +08:00
RAND_write_file() writes a number of random bytes (currently 1024) to
2000-01-27 09:50:42 +08:00
file B<filename> which can be used to initialize the PRNG by calling
2000-01-22 01:50:27 +08:00
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
L<rand(3)>, L<RAND_add(3)>, L<RAND_cleanup(3)>
2000-01-22 01:50:27 +08:00
=cut