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

=head1 NAME

U
Ulf Möller 已提交
5
BN_rand, BN_pseudo_rand - generate pseudo-random number
U
Ulf Möller 已提交
6 7 8 9 10 11 12

=head1 SYNOPSIS

 #include <openssl/bn.h>

 int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);

U
Ulf Möller 已提交
13
 int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
U
Ulf Möller 已提交
14

B
Bodo Möller 已提交
15
 int BN_rand_range(BIGNUM *rnd, BIGNUM *range);
U
Ulf Möller 已提交
16

R
Richard Levitte 已提交
17
 int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
18

U
Ulf Möller 已提交
19 20 21
=head1 DESCRIPTION

BN_rand() generates a cryptographically strong pseudo-random number of
22 23 24 25 26 27
B<bits> bits in length and stores it in B<rnd>. If B<top> is -1, the
most significant bit of the random number can be zero. If B<top> is 0,
it is set to 1, and if B<top> is 1, the two most significant bits of
the number will be set to 1, so that the product of two such random
numbers will always have 2*B<bits> length.  If B<bottom> is true, the
number will be odd.
U
Ulf Möller 已提交
28

U
Ulf Möller 已提交
29 30 31 32 33
BN_pseudo_rand() does the same, but pseudo-random numbers generated by
this function are not necessarily unpredictable. They can be used for
non-cryptographic purposes and for certain purposes in cryptographic
protocols, but usually not for key generation etc.

U
Ulf Möller 已提交
34
BN_rand_range() generates a cryptographically strong pseudo-random
B
Bodo Möller 已提交
35
number B<rnd> in the range 0 <lt>= B<rnd> E<lt> B<range>.
36 37
BN_pseudo_rand_range() does the same, but is based on BN_pseudo_rand(),
and hence numbers generated by it are not necessarily unpredictable.
U
Ulf Möller 已提交
38 39

The PRNG must be seeded prior to calling BN_rand() or BN_rand_range().
U
Ulf Möller 已提交
40 41 42

=head1 RETURN VALUES

U
Ulf Möller 已提交
43
The functions return 1 on success, 0 on error.
44
The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
U
Ulf Möller 已提交
45 46 47

=head1 SEE ALSO

48
L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<rand(3)|rand(3)>,
49
L<RAND_add(3)|RAND_add(3)>, L<RAND_bytes(3)|RAND_bytes(3)>
U
Ulf Möller 已提交
50 51 52 53

=head1 HISTORY

BN_rand() is available in all versions of SSLeay and OpenSSL.
54 55
BN_pseudo_rand() was added in OpenSSL 0.9.5. The B<top> == -1 case
and the function BN_rand_range() were added in OpenSSL 0.9.6a.
56
BN_pseudo_rand_range() was added in OpenSSL 0.9.6c.
U
Ulf Möller 已提交
57 58

=cut