1abcdd42db82130a5049cd010f92285bd3c76a3f
[openssl.git] / doc / crypto / BN_rand.pod
1 =pod
2
3 =head1 NAME
4
5 BN_rand, BN_pseudo_rand, BN_rand_range, BN_pseudo_rand_range - generate pseudo-random number
6
7 =head1 SYNOPSIS
8
9  #include <openssl/bn.h>
10
11  int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
12
13  int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
14
15  int BN_rand_range(BIGNUM *rnd, BIGNUM *range);
16
17  int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
18
19 =head1 DESCRIPTION
20
21 BN_rand() generates a cryptographically strong pseudo-random number of
22 B<bits> in length and stores it in B<rnd>. If B<top> is -1, the
23 most significant bit of the random number can be zero. If B<top> is 0,
24 it is set to 1, and if B<top> is 1, the two most significant bits of
25 the number will be set to 1, so that the product of two such random
26 numbers will always have 2*B<bits> length.  If B<bottom> is true, the
27 number will be odd. The value of B<bits> must be zero or greater. If B<bits> is
28 1 then B<top> cannot also be 1.
29
30 BN_pseudo_rand() does the same, but pseudo-random numbers generated by
31 this function are not necessarily unpredictable. They can be used for
32 non-cryptographic purposes and for certain purposes in cryptographic
33 protocols, but usually not for key generation etc.
34
35 BN_rand_range() generates a cryptographically strong pseudo-random
36 number B<rnd> in the range 0 E<lt>= B<rnd> E<lt> B<range>.
37 BN_pseudo_rand_range() does the same, but is based on BN_pseudo_rand(),
38 and hence numbers generated by it are not necessarily unpredictable.
39
40 The PRNG must be seeded prior to calling BN_rand() or BN_rand_range().
41
42 =head1 RETURN VALUES
43
44 The functions return 1 on success, 0 on error.
45 The error codes can be obtained by L<ERR_get_error(3)>.
46
47 =head1 SEE ALSO
48
49 L<bn(3)>, L<ERR_get_error(3)>, L<rand(3)>,
50 L<RAND_add(3)>, L<RAND_bytes(3)>
51
52 =head1 HISTORY
53
54 BN_rand() is available in all versions of SSLeay and OpenSSL.
55 BN_pseudo_rand() was added in OpenSSL 0.9.5. The B<top> == -1 case
56 and the function BN_rand_range() were added in OpenSSL 0.9.6a.
57 BN_pseudo_rand_range() was added in OpenSSL 0.9.6c.
58
59 =cut