RAND_set_rand_method.pod 2.8 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4
=pod

=head1 NAME

U
Ulf Möller 已提交
5
RAND_set_rand_method, RAND_get_rand_method, RAND_SSLeay - select RAND method
U
Ulf Möller 已提交
6 7 8 9 10

=head1 SYNOPSIS

 #include <openssl/rand.h>

11
 void RAND_set_rand_method(const RAND_METHOD *meth);
U
Ulf Möller 已提交
12

13
 const RAND_METHOD *RAND_get_rand_method(void);
U
Ulf Möller 已提交
14 15 16 17 18

 RAND_METHOD *RAND_SSLeay(void);

=head1 DESCRIPTION

19 20 21 22 23
A B<RAND_METHOD> specifies the functions that OpenSSL uses for random number
generation. By modifying the method, alternative implementations such as
hardware RNGs may be used. IMPORTANT: See the NOTES section for important
information about how these RAND API functions are affected by the use of
B<ENGINE> API calls.
U
Ulf Möller 已提交
24

25 26 27 28 29 30 31 32
Initially, the default RAND_METHOD is the OpenSSL internal implementation, as
returned by RAND_SSLeay().

RAND_set_default_method() makes B<meth> the method for PRNG use. B<NB>: This is
true only whilst no ENGINE has been set as a default for RAND, so this function
is no longer recommended.

RAND_get_default_method() returns a pointer to the current RAND_METHOD.
33
However, the meaningfulness of this result is dependent on whether the ENGINE
34
API is being used, so this function is no longer recommended.
U
Ulf Möller 已提交
35

U
Ulf Möller 已提交
36
=head1 THE RAND_METHOD STRUCTURE
U
Ulf Möller 已提交
37 38 39 40 41 42 43 44

 typedef struct rand_meth_st
 {
        void (*seed)(const void *buf, int num);
        int (*bytes)(unsigned char *buf, int num);
        void (*cleanup)(void);
        void (*add)(const void *buf, int num, int entropy);
        int (*pseudorand)(unsigned char *buf, int num);
U
Ulf Möller 已提交
45
	int (*status)(void);
U
Ulf Möller 已提交
46 47 48
 } RAND_METHOD;

The components point to the implementation of RAND_seed(),
U
Ulf Möller 已提交
49 50
RAND_bytes(), RAND_cleanup(), RAND_add(), RAND_pseudo_rand()
and RAND_status().
U
Ulf Möller 已提交
51 52 53 54 55 56 57
Each component may be NULL if the function is not implemented.

=head1 RETURN VALUES

RAND_set_rand_method() returns no value. RAND_get_rand_method() and
RAND_SSLeay() return pointers to the respective methods.

58 59 60 61 62 63 64 65 66 67
=head1 NOTES

As of version 0.9.7, RAND_METHOD implementations are grouped together with other
algorithmic APIs (eg. RSA_METHOD, EVP_CIPHER, etc) in B<ENGINE> modules. If a
default ENGINE is specified for RAND functionality using an ENGINE API function,
that will override any RAND defaults set using the RAND API (ie.
RAND_set_rand_method()). For this reason, the ENGINE API is the recommended way
to control default implementations for use in RAND and other cryptographic
algorithms.

U
Ulf Möller 已提交
68 69
=head1 SEE ALSO

70
L<rand(3)|rand(3)>, L<engine(3)|engine(3)>
U
Ulf Möller 已提交
71 72 73 74 75 76

=head1 HISTORY

RAND_set_rand_method(), RAND_get_rand_method() and RAND_SSLeay() are
available in all versions of OpenSSL.

77 78 79 80 81 82
In the engine version of version 0.9.6, RAND_set_rand_method() was altered to
take an ENGINE pointer as its argument. As of version 0.9.7, that has been
reverted as the ENGINE API transparently overrides RAND defaults if used,
otherwise RAND API functions work as before. RAND_set_rand_engine() was also
introduced in version 0.9.7.

U
Ulf Möller 已提交
83
=cut