From 27c3c9e543412112b877fdf1f01c5fe54d220138 Mon Sep 17 00:00:00 2001 From: mpi <> Date: Wed, 16 Apr 2014 09:50:10 +0000 Subject: Sync the list of man pages for libcrypto, explicity rename conflicting pages instead of doing it in the Makefiles and move a libssl page where it belongs. ok miod@ --- src/lib/libcrypto/doc/RAND.pod | 74 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 src/lib/libcrypto/doc/RAND.pod (limited to 'src/lib/libcrypto/doc/RAND.pod') diff --git a/src/lib/libcrypto/doc/RAND.pod b/src/lib/libcrypto/doc/RAND.pod new file mode 100644 index 0000000000..e987414477 --- /dev/null +++ b/src/lib/libcrypto/doc/RAND.pod @@ -0,0 +1,74 @@ +=pod + +=head1 NAME + +rand - pseudo-random number generator + +=head1 SYNOPSIS + + #include + + int RAND_set_rand_engine(ENGINE *engine); + + int RAND_bytes(unsigned char *buf, int num); + int RAND_pseudo_bytes(unsigned char *buf, int num); + + void RAND_seed(const void *buf, int num); + void RAND_add(const void *buf, int num, int entropy); + int RAND_status(void); + + int RAND_load_file(const char *file, long max_bytes); + int RAND_write_file(const char *file); + const char *RAND_file_name(char *file, size_t num); + + int RAND_egd(const char *path); + + void RAND_set_rand_method(const RAND_METHOD *meth); + const RAND_METHOD *RAND_get_rand_method(void); + RAND_METHOD *RAND_SSLeay(void); + + void RAND_cleanup(void); + +=head1 DESCRIPTION + +Since the introduction of the ENGINE API, the recommended way of controlling +default implementations is by using the ENGINE API functions. The default +B, as set by RAND_set_rand_method() and returned by +RAND_get_rand_method(), is only used if no ENGINE has been set as the default +"rand" implementation. Hence, these two functions are no longer the recommened +way to control defaults. + +If an alternative B implementation is being used (either set +directly or as provided by an ENGINE module), then it is entirely responsible +for the generation and management of a cryptographically secure PRNG stream. The +mechanisms described below relate solely to the software PRNG implementation +built in to OpenSSL and used by default. + +These functions implement a cryptographically secure pseudo-random +number generator (PRNG). It is used by other library functions for +example to generate random keys, and applications can use it when they +need randomness. + +A cryptographic PRNG must be seeded with unpredictable data such as +mouse movements or keys pressed at random by the user. This is +described in L. Its state can be saved in a seed file +(see L) to avoid having to go through the +seeding process whenever the application is started. + +L describes how to obtain random data from the +PRNG. + +=head1 INTERNALS + +The RAND_SSLeay() method implements a PRNG based on the systems' +L random number generator. + +=head1 SEE ALSO + +L, L, +L, L, +L, +L, +L + +=cut -- cgit v1.2.3-55-g6feb