crypto/rand/rand_lib.c

   1 /* crypto/rand/rand_lib.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 #include <stdio.h>
  60 #include <time.h>
  61 #include "cryptlib.h"
  62 #include <openssl/rand.h>
  63
  64 #ifdef OPENSSL_FIPSCANISTER
  65 #define OPENSSL_NO_ENGINE
  66 #include <openssl/fips.h>
  67 #endif
  68
  69 #ifndef OPENSSL_NO_ENGINE
  70 #include <openssl/engine.h>
  71 #endif
  72
  73 #ifdef OPENSSL_FIPS
  74 #include <openssl/fips.h>
  75 #include <openssl/fips_rand.h>
  76 #endif
  77
  78 #ifndef OPENSSL_NO_ENGINE
  79 /* non-NULL if default_RAND_meth is ENGINE-provided */
  80 static ENGINE *funct_ref =NULL;
  81 #endif
  82 static const RAND_METHOD *default_RAND_meth = NULL;
  83
  84 int RAND_set_rand_method(const RAND_METHOD *meth)
  85         {
  86 #ifdef OPENSSL_FIPS
  87         if (!FIPS_rand_set_method(meth))
  88                 return 0;
  89 #endif
  90 #ifndef OPENSSL_NO_ENGINE
  91         if(funct_ref)
  92                 {
  93                 ENGINE_finish(funct_ref);
  94                 funct_ref = NULL;
  95                 }
  96 #endif
  97         default_RAND_meth = meth;
  98         return 1;
  99         }
 100
 101 const RAND_METHOD *RAND_get_rand_method(void)
 102         {
 103         if (!default_RAND_meth)
 104                 {
 105 #ifndef OPENSSL_NO_ENGINE
 106                 ENGINE *e = ENGINE_get_default_RAND();
 107                 if(e)
 108                         {
 109                         default_RAND_meth = ENGINE_get_RAND(e);
 110                         if(!default_RAND_meth)
 111                                 {
 112                                 ENGINE_finish(e);
 113                                 e = NULL;
 114                                 }
 115                         }
 116                 if(e)
 117                         funct_ref = e;
 118                 else
 119 #endif
 120                         default_RAND_meth = RAND_SSLeay();
 121                 }
 122         return default_RAND_meth;
 123         }
 124
 125 #ifndef OPENSSL_NO_ENGINE
 126 int RAND_set_rand_engine(ENGINE *engine)
 127         {
 128         const RAND_METHOD *tmp_meth = NULL;
 129         if(engine)
 130                 {
 131                 if(!ENGINE_init(engine))
 132                         return 0;
 133                 tmp_meth = ENGINE_get_RAND(engine);
 134                 if(!tmp_meth)
 135                         {
 136                         ENGINE_finish(engine);
 137                         return 0;
 138                         }
 139                 }
 140         /* This function releases any prior ENGINE so call it first */
 141         RAND_set_rand_method(tmp_meth);
 142         funct_ref = engine;
 143         return 1;
 144         }
 145 #endif
 146
 147 void RAND_cleanup(void)
 148         {
 149         const RAND_METHOD *meth = RAND_get_rand_method();
 150         if (meth && meth->cleanup)
 151                 meth->cleanup();
 152         RAND_set_rand_method(NULL);
 153         }
 154
 155 void RAND_seed(const void *buf, int num)
 156         {
 157         const RAND_METHOD *meth = RAND_get_rand_method();
 158         if (meth && meth->seed)
 159                 meth->seed(buf,num);
 160         }
 161
 162 void RAND_add(const void *buf, int num, double entropy)
 163         {
 164         const RAND_METHOD *meth = RAND_get_rand_method();
 165         if (meth && meth->add)
 166                 meth->add(buf,num,entropy);
 167         }
 168
 169 int RAND_bytes(unsigned char *buf, int num)
 170         {
 171         const RAND_METHOD *meth = RAND_get_rand_method();
 172         if (meth && meth->bytes)
 173                 return meth->bytes(buf,num);
 174         return(-1);
 175         }
 176
 177 int RAND_pseudo_bytes(unsigned char *buf, int num)
 178         {
 179         const RAND_METHOD *meth = RAND_get_rand_method();
 180         if (meth && meth->pseudorand)
 181                 return meth->pseudorand(buf,num);
 182         return(-1);
 183         }
 184
 185 int RAND_status(void)
 186         {
 187         const RAND_METHOD *meth = RAND_get_rand_method();
 188         if (meth && meth->status)
 189                 return meth->status();
 190         return 0;
 191         }
 192
 193 #ifdef OPENSSL_FIPS
 194
 195 /* FIPS DRBG initialisation code. This sets up the DRBG for use by the
 196  * rest of OpenSSL.
 197  */
 198
 199 /* Entropy gatherer: use standard OpenSSL PRNG to seed (this will gather
 200  * entropy internally through RAND_poll().
 201  */
 202
 203 static size_t drbg_get_entropy(DRBG_CTX *ctx, unsigned char **pout,
 204                                 int entropy, size_t min_len, size_t max_len)
 205         {
 206         /* Round up request to multiple of block size */
 207         min_len = ((min_len + 19) / 20) * 20;
 208         *pout = OPENSSL_malloc(min_len);
 209         if (!*pout)
 210                 return 0;
 211         if (RAND_SSLeay()->bytes(*pout, min_len) <= 0)
 212                 {
 213                 OPENSSL_free(*pout);
 214                 *pout = NULL;
 215                 return 0;
 216                 }
 217         return min_len;
 218         }
 219
 220 static void drbg_free_entropy(DRBG_CTX *ctx, unsigned char *out, size_t olen)
 221         {
 222         OPENSSL_cleanse(out, olen);
 223         OPENSSL_free(out);
 224         }
 225
 226 /* Set "additional input" when generating random data. This uses the
 227  * current PID, a time value and a counter.
 228  */
 229
 230 static size_t drbg_get_adin(DRBG_CTX *ctx, unsigned char **pout)
 231         {
 232         /* Use of static variables is OK as this happens under a lock */
 233         static unsigned char buf[16];
 234         static unsigned long counter;
 235         FIPS_get_timevec(buf, &counter);
 236         *pout = buf;
 237         return sizeof(buf);
 238         }
 239
 240 /* RAND_add() and RAND_seed() pass through to OpenSSL PRNG so it is
 241  * correctly seeded by RAND_poll().
 242  */
 243
 244 static int drbg_rand_add(DRBG_CTX *ctx, const void *in, int inlen,
 245                                 double entropy)
 246         {
 247         RAND_SSLeay()->add(in, inlen, entropy);
 248         return 1;
 249         }
 250
 251 static int drbg_rand_seed(DRBG_CTX *ctx, const void *in, int inlen)
 252         {
 253         RAND_SSLeay()->seed(in, inlen);
 254         return 1;
 255         }
 256
 257 int RAND_init_fips(void)
 258         {
 259         DRBG_CTX *dctx;
 260         size_t plen;
 261         unsigned char pers[32], *p;
 262         dctx = FIPS_get_default_drbg();
 263         FIPS_drbg_init(dctx, NID_aes_256_ctr, DRBG_FLAG_CTR_USE_DF);
 264         FIPS_drbg_set_callbacks(dctx,
 265                                 drbg_get_entropy, drbg_free_entropy, 20,
 266                                 drbg_get_entropy, drbg_free_entropy);
 267         FIPS_drbg_set_rand_callbacks(dctx, drbg_get_adin, 0,
 268                                         drbg_rand_seed, drbg_rand_add);
 269         /* Personalisation string: a string followed by date time vector */
 270         strcpy((char *)pers, "OpenSSL DRBG2.0");
 271         plen = drbg_get_adin(dctx, &p);
 272         memcpy(pers + 16, p, plen);
 273
 274         FIPS_drbg_instantiate(dctx, pers, sizeof(pers));
 275         FIPS_rand_set_method(FIPS_drbg_method());
 276         return 1;
 277         }
 278
 279 #endif