lib/libcrypto/man/BN_rand.3

   1 .\"     $OpenBSD: BN_rand.3,v 1.6 2016/12/10 21:13:25 schwarze Exp $
   2 .\"     OpenSSL 05ea606a May 20 20:52:46 2016 -0400
   3 .\"
   4 .\" This file was written by Ulf Moeller <ulf@openssl.org>.
   5 .\" Copyright (c) 2000, 2001, 2002, 2013, 2015 The OpenSSL Project.
   6 .\" All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\"
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\"
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in
  17 .\"    the documentation and/or other materials provided with the
  18 .\"    distribution.
  19 .\"
  20 .\" 3. All advertising materials mentioning features or use of this
  21 .\"    software must display the following acknowledgment:
  22 .\"    "This product includes software developed by the OpenSSL Project
  23 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  24 .\"
  25 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26 .\"    endorse or promote products derived from this software without
  27 .\"    prior written permission. For written permission, please contact
  28 .\"    openssl-core@openssl.org.
  29 .\"
  30 .\" 5. Products derived from this software may not be called "OpenSSL"
  31 .\"    nor may "OpenSSL" appear in their names without prior written
  32 .\"    permission of the OpenSSL Project.
  33 .\"
  34 .\" 6. Redistributions of any form whatsoever must retain the following
  35 .\"    acknowledgment:
  36 .\"    "This product includes software developed by the OpenSSL Project
  37 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38 .\"
  39 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  51 .\"
  52 .Dd $Mdocdate: December 10 2016 $
  53 .Dt BN_RAND 3
  54 .Os
  55 .Sh NAME
  56 .Nm BN_rand ,
  57 .Nm BN_pseudo_rand ,
  58 .Nm BN_rand_range ,
  59 .Nm BN_pseudo_rand_range
  60 .Nd generate pseudo-random number
  61 .Sh SYNOPSIS
  62 .In openssl/bn.h
  63 .Ft int
  64 .Fo BN_rand
  65 .Fa "BIGNUM *rnd"
  66 .Fa "int bits"
  67 .Fa "int top"
  68 .Fa "int bottom"
  69 .Fc
  70 .Ft int
  71 .Fo BN_pseudo_rand
  72 .Fa "BIGNUM *rnd"
  73 .Fa "int bits"
  74 .Fa "int top"
  75 .Fa "int bottom"
  76 .Fc
  77 .Ft int
  78 .Fo BN_rand_range
  79 .Fa "BIGNUM *rnd"
  80 .Fa "BIGNUM *range"
  81 .Fc
  82 .Ft int
  83 .Fo BN_pseudo_rand_range
  84 .Fa "BIGNUM *rnd"
  85 .Fa "BIGNUM *range"
  86 .Fc
  87 .Sh DESCRIPTION
  88 .Fn BN_rand
  89 generates a cryptographically strong pseudo-random number of
  90 .Fa bits
  91 in length and stores it in
  92 .Fa rnd .
  93 If
  94 .Fa top
  95 is -1, the most significant bit of the random number can be zero.
  96 If
  97 .Fa top
  98 is 0, it is set to 1, and if
  99 .Fa top
 100 is 1, the two most significant bits of the number will be set to 1, so
 101 that the product of two such random numbers will always have
 102 .Pf 2* Fa bits
 103 length.
 104 If
 105 .Fa bottom
 106 is true, the number will be odd.
 107 The value of
 108 .Fa bits
 109 must be zero or greater.
 110 If
 111 .Fa bits
 112 is +1 then
 113 .Fa top
 114 cannot also be 1.
 115 .Pp
 116 .Fn BN_pseudo_rand
 117 does the same, but pseudo-random numbers generated by this function are
 118 not necessarily unpredictable.
 119 They can be used for non-cryptographic purposes and for certain purposes
 120 in cryptographic protocols, but usually not for key generation etc.
 121 .Pp
 122 .Fn BN_rand_range
 123 generates a cryptographically strong pseudo-random number
 124 .Fa rnd
 125 in the range 0 <=
 126 .Fa rnd No < Fa range .
 127 .Fn BN_pseudo_rand_range
 128 does the same, but is based on
 129 .Fn BN_pseudo_rand ,
 130 and hence numbers generated by it are not necessarily unpredictable.
 131 .Sh RETURN VALUES
 132 The functions return 1 on success, 0 on error.
 133 The error codes can be obtained by
 134 .Xr ERR_get_error 3 .
 135 .Sh SEE ALSO
 136 .Xr BN_new 3 ,
 137 .Xr ERR_get_error 3 ,
 138 .Xr RAND_add 3 ,
 139 .Xr RAND_bytes 3
 140 .Sh HISTORY
 141 .Fn BN_rand
 142 is available in all versions of SSLeay and OpenSSL.
 143 .Fn BN_pseudo_rand
 144 was added in OpenSSL 0.9.5.
 145 The
 146 .Fa top
 147 == -1 case and the function
 148 .Fn BN_rand_range
 149 were added in OpenSSL 0.9.6a.
 150 .Fn BN_pseudo_rand_range
 151 was added in OpenSSL 0.9.6c.