doc/man3/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>.
  23 If B<bits> is less than zero, or too small to
  24 accommodate the requirements specified by the B<top> and B<bottom>
  25 parameters, an error is returned.
  26 The B<top> parameters specifies
  27 requirements on the most significant bit of the generated number.
  28 If it is B<BN_RAND_TOP_ANY>, there is no constraint.
  29 If it is B<BN_RAND_TOP_ONE>, the top bit must be one.
  30 If it is B<BN_RAND_TOP_TWO>, the two most significant bits of
  31 the number will be set to 1, so that the product of two such random
  32 numbers will always have 2*B<bits> length.
  33 If B<bottom> is B<BN_RAND_BOTTOM_ODD>, the number will be odd; if it
  34 is B<BN_RAND_BOTTOM_ANY> it can be odd or even.
  35 If B<bits> is 1 then B<top> cannot also be B<BN_RAND_FLG_TOPTWO>.
  36
  37 BN_rand_range() generates a cryptographically strong pseudo-random
  38 number B<rnd> in the range 0 E<lt>= B<rnd> E<lt> B<range>.
  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 HISTORY
  48
  49 Starting with OpenSSL release 1.1.0,
  50 BN_pseudo_rand() has been identical to BN_rand()
  51 and
  52 BN_pseudo_rand_range() has been identical to BN_rand_range().
  53 The "pseudo" functions should not be used and may be deprecated in
  54 a future release.
  55
  56 =head1 SEE ALSO
  57
  58 L<ERR_get_error(3)>, L<RAND_add(3)>, L<RAND_bytes(3)>
  59
  60 =head1 COPYRIGHT
  61
  62 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
  63
  64 Licensed under the OpenSSL license (the "License").  You may not use
  65 this file except in compliance with the License.  You can obtain a copy
  66 in the file LICENSE in the source distribution or at
  67 L<https://www.openssl.org/source/license.html>.
  68
  69 =cut