crypto/rand/rand_lcl.h

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef HEADER_RAND_LCL_H
  11 # define HEADER_RAND_LCL_H
  12
  13 # include <openssl/aes.h>
  14 # include <openssl/evp.h>
  15 # include <openssl/sha.h>
  16 # include <openssl/hmac.h>
  17 # include <openssl/ec.h>
  18 # include <openssl/rand_drbg.h>
  19
  20 /* How many times to read the TSC as a randomness source. */
  21 # define TSC_READ_COUNT                 4
  22
  23 /* Maximum reseed intervals */
  24 # define MAX_RESEED_INTERVAL                     (1 << 24)
  25 # define MAX_RESEED_TIME_INTERVAL                (1 << 20) /* approx. 12 days */
  26
  27 /* Default reseed intervals */
  28 # define MASTER_RESEED_INTERVAL                  (1 << 8)
  29 # define SLAVE_RESEED_INTERVAL                   (1 << 16)
  30 # define MASTER_RESEED_TIME_INTERVAL             (60*60)   /* 1 hour */
  31 # define SLAVE_RESEED_TIME_INTERVAL              (7*60)    /* 7 minutes */
  32
  33
  34
  35 /*
  36  * Maximum input size for the DRBG (entropy, nonce, personalization string)
  37  *
  38  * NIST SP800 90Ar1 allows a maximum of (1 << 35) bits i.e., (1 << 32) bytes.
  39  *
  40  * We lower it to 'only' INT32_MAX bytes, which is equivalent to 2 gigabytes.
  41  */
  42 # define DRBG_MAX_LENGTH                         INT32_MAX
  43
  44
  45
  46 /*
  47  * Maximum allocation size for RANDOM_POOL buffers
  48  *
  49  * The max_len value for the buffer provided to the rand_drbg_get_entropy()
  50  * callback is currently 2^31 bytes (2 gigabytes), if a derivation function
  51  * is used. Since this is much too large to be allocated, the rand_pool_new()
  52  * function chooses more modest values as default pool length, bounded
  53  * by RAND_POOL_MIN_LENGTH and RAND_POOL_MAX_LENGTH
  54  *
  55  * The choice of the RAND_POOL_FACTOR is large enough such that the
  56  * RAND_POOL can store a random input which has a lousy entropy rate of
  57  * 8/256 (= 0.03125) bits per byte. This input will be sent through the
  58  * derivation function which 'compresses' the low quality input into a
  59  * high quality output.
  60  *
  61  * The factor 1.5 below is the pessimistic estimate for the extra amount
  62  * of entropy required when no get_nonce() callback is defined.
  63  */
  64 # define RAND_POOL_FACTOR        256
  65 # define RAND_POOL_MAX_LENGTH    (RAND_POOL_FACTOR * \
  66                                   3 * (RAND_DRBG_STRENGTH / 16))
  67 /*
  68  *                             = (RAND_POOL_FACTOR * \
  69  *                                1.5 * (RAND_DRBG_STRENGTH / 8))
  70  */
  71
  72
  73 /* DRBG status values */
  74 typedef enum drbg_status_e {
  75     DRBG_UNINITIALISED,
  76     DRBG_READY,
  77     DRBG_ERROR
  78 } DRBG_STATUS;
  79
  80
  81 /* instantiate */
  82 typedef int (*RAND_DRBG_instantiate_fn)(RAND_DRBG *ctx,
  83                                         const unsigned char *ent,
  84                                         size_t entlen,
  85                                         const unsigned char *nonce,
  86                                         size_t noncelen,
  87                                         const unsigned char *pers,
  88                                         size_t perslen);
  89 /* reseed */
  90 typedef int (*RAND_DRBG_reseed_fn)(RAND_DRBG *ctx,
  91                                    const unsigned char *ent,
  92                                    size_t entlen,
  93                                    const unsigned char *adin,
  94                                    size_t adinlen);
  95 /* generate output */
  96 typedef int (*RAND_DRBG_generate_fn)(RAND_DRBG *ctx,
  97                                      unsigned char *out,
  98                                      size_t outlen,
  99                                      const unsigned char *adin,
 100                                      size_t adinlen);
 101 /* uninstantiate */
 102 typedef int (*RAND_DRBG_uninstantiate_fn)(RAND_DRBG *ctx);
 103
 104
 105 /*
 106  * The DRBG methods
 107  */
 108
 109 typedef struct rand_drbg_method_st {
 110     RAND_DRBG_instantiate_fn instantiate;
 111     RAND_DRBG_reseed_fn reseed;
 112     RAND_DRBG_generate_fn generate;
 113     RAND_DRBG_uninstantiate_fn uninstantiate;
 114 } RAND_DRBG_METHOD;
 115
 116 /* 888 bits from SP800-90Ar1 10.1 table 2 */
 117 #define HASH_PRNG_MAX_SEEDLEN    (888/8)
 118
 119 typedef struct rand_drbg_hash_st {
 120     const EVP_MD *md;
 121     EVP_MD_CTX *ctx;
 122     size_t blocklen;
 123     unsigned char V[HASH_PRNG_MAX_SEEDLEN];
 124     unsigned char C[HASH_PRNG_MAX_SEEDLEN];
 125     /* Temporary value storage: should always exceed max digest length */
 126     unsigned char vtmp[HASH_PRNG_MAX_SEEDLEN];
 127 } RAND_DRBG_HASH;
 128
 129 typedef struct rand_drbg_hmac_st {
 130     const EVP_MD *md;
 131     HMAC_CTX *ctx;
 132     size_t blocklen;
 133     unsigned char K[EVP_MAX_MD_SIZE];
 134     unsigned char V[EVP_MAX_MD_SIZE];
 135 } RAND_DRBG_HMAC;
 136
 137 /*
 138  * The state of a DRBG AES-CTR.
 139  */
 140 typedef struct rand_drbg_ctr_st {
 141     EVP_CIPHER_CTX *ctx;
 142     EVP_CIPHER_CTX *ctx_df;
 143     const EVP_CIPHER *cipher;
 144     size_t keylen;
 145     unsigned char K[32];
 146     unsigned char V[16];
 147     /* Temporary block storage used by ctr_df */
 148     unsigned char bltmp[16];
 149     size_t bltmp_pos;
 150     unsigned char KX[48];
 151 } RAND_DRBG_CTR;
 152
 153
 154 /*
 155  * The 'random pool' acts as a dumb container for collecting random
 156  * input from various entropy sources. The pool has no knowledge about
 157  * whether its randomness is fed into a legacy RAND_METHOD via RAND_add()
 158  * or into a new style RAND_DRBG. It is the callers duty to 1) initialize the
 159  * random pool, 2) pass it to the polling callbacks, 3) seed the RNG, and
 160  * 4) cleanup the random pool again.
 161  *
 162  * The random pool contains no locking mechanism because its scope and
 163  * lifetime is intended to be restricted to a single stack frame.
 164  */
 165 struct rand_pool_st {
 166     unsigned char *buffer;  /* points to the beginning of the random pool */
 167     size_t len; /* current number of random bytes contained in the pool */
 168
 169     int attached;  /* true pool was attached to existing buffer */
 170
 171     size_t min_len; /* minimum number of random bytes requested */
 172     size_t max_len; /* maximum number of random bytes (allocated buffer size) */
 173     size_t entropy; /* current entropy count in bits */
 174     size_t entropy_requested; /* requested entropy count in bits */
 175 };
 176
 177 /*
 178  * The state of all types of DRBGs, even though we only have CTR mode
 179  * right now.
 180  */
 181 struct rand_drbg_st {
 182     CRYPTO_RWLOCK *lock;
 183     RAND_DRBG *parent;
 184     int secure; /* 1: allocated on the secure heap, 0: otherwise */
 185     int type; /* the nid of the underlying algorithm */
 186     /*
 187      * Stores the value of the rand_fork_count global as of when we last
 188      * reseeded.  The DRBG reseeds automatically whenever drbg->fork_count !=
 189      * rand_fork_count.  Used to provide fork-safety and reseed this DRBG in
 190      * the child process.
 191      */
 192     int fork_count;
 193     unsigned short flags; /* various external flags */
 194
 195     /*
 196      * The random_data is used by RAND_add()/drbg_add() to attach random
 197      * data to the global drbg, such that the rand_drbg_get_entropy() callback
 198      * can pull it during instantiation and reseeding. This is necessary to
 199      * reconcile the different philosophies of the RAND and the RAND_DRBG
 200      * with respect to how randomness is added to the RNG during reseeding
 201      * (see PR #4328).
 202      */
 203     struct rand_pool_st *pool;
 204
 205     /*
 206      * The following parameters are setup by the per-type "init" function.
 207      *
 208      * The supported types and their init functions are:
 209      *    (1) CTR_DRBG:  drbg_ctr_init().
 210      *    (2) HMAC_DRBG: drbg_hmac_init().
 211      *    (3) HASH_DRBG: drbg_hash_init().
 212      *
 213      * The parameters are closely related to the ones described in
 214      * section '10.2.1 CTR_DRBG' of [NIST SP 800-90Ar1], with one
 215      * crucial difference: In the NIST standard, all counts are given
 216      * in bits, whereas in OpenSSL entropy counts are given in bits
 217      * and buffer lengths are given in bytes.
 218      *
 219      * Since this difference has lead to some confusion in the past,
 220      * (see [GitHub Issue #2443], formerly [rt.openssl.org #4055])
 221      * the 'len' suffix has been added to all buffer sizes for
 222      * clarification.
 223      */
 224
 225     int strength;
 226     size_t max_request;
 227     size_t min_entropylen, max_entropylen;
 228     size_t min_noncelen, max_noncelen;
 229     size_t max_perslen, max_adinlen;
 230
 231     /*
 232      * Counts the number of generate requests since the last reseed
 233      * (Starts at 1). This value is the reseed_counter as defined in
 234      * NIST SP 800-90Ar1
 235      */
 236     unsigned int reseed_gen_counter;
 237     /*
 238      * Maximum number of generate requests until a reseed is required.
 239      * This value is ignored if it is zero.
 240      */
 241     unsigned int reseed_interval;
 242     /* Stores the time when the last reseeding occurred */
 243     time_t reseed_time;
 244     /*
 245      * Specifies the maximum time interval (in seconds) between reseeds.
 246      * This value is ignored if it is zero.
 247      */
 248     time_t reseed_time_interval;
 249     /*
 250      * Counts the number of reseeds since instantiation.
 251      * This value is ignored if it is zero.
 252      *
 253      * This counter is used only for seed propagation from the <master> DRBG
 254      * to its two children, the <public> and <private> DRBG. This feature is
 255      * very special and its sole purpose is to ensure that any randomness which
 256      * is added by RAND_add() or RAND_seed() will have an immediate effect on
 257      * the output of RAND_bytes() resp. RAND_priv_bytes().
 258      */
 259     unsigned int reseed_prop_counter;
 260
 261     size_t seedlen;
 262     DRBG_STATUS state;
 263
 264     /* Application data, mainly used in the KATs. */
 265     CRYPTO_EX_DATA ex_data;
 266
 267     /* Implementation specific data */
 268     union {
 269         RAND_DRBG_CTR ctr;
 270         RAND_DRBG_HASH hash;
 271         RAND_DRBG_HMAC hmac;
 272     } data;
 273
 274     /* Implementation specific methods */
 275     RAND_DRBG_METHOD *meth;
 276
 277     /* Callback functions.  See comments in rand_lib.c */
 278     RAND_DRBG_get_entropy_fn get_entropy;
 279     RAND_DRBG_cleanup_entropy_fn cleanup_entropy;
 280     RAND_DRBG_get_nonce_fn get_nonce;
 281     RAND_DRBG_cleanup_nonce_fn cleanup_nonce;
 282 };
 283
 284 /* The global RAND method, and the global buffer and DRBG instance. */
 285 extern RAND_METHOD rand_meth;
 286
 287 /*
 288  * A "generation count" of forks.  Incremented in the child process after a
 289  * fork.  Since rand_fork_count is increment-only, and only ever written to in
 290  * the child process of the fork, which is guaranteed to be single-threaded, no
 291  * locking is needed for normal (read) accesses; the rest of pthread fork
 292  * processing is assumed to introduce the necessary memory barriers.  Sibling
 293  * children of a given parent will produce duplicate values, but this is not
 294  * problematic because the reseeding process pulls input from the system CSPRNG
 295  * and/or other global sources, so the siblings will end up generating
 296  * different output streams.
 297  */
 298 extern int rand_fork_count;
 299
 300 /* DRBG helpers */
 301 int rand_drbg_restart(RAND_DRBG *drbg,
 302                       const unsigned char *buffer, size_t len, size_t entropy);
 303
 304 /* locking api */
 305 int rand_drbg_lock(RAND_DRBG *drbg);
 306 int rand_drbg_unlock(RAND_DRBG *drbg);
 307 int rand_drbg_enable_locking(RAND_DRBG *drbg);
 308
 309
 310 /* initializes the DRBG implementation */
 311 int drbg_ctr_init(RAND_DRBG *drbg);
 312 int drbg_hash_init(RAND_DRBG *drbg);
 313 int drbg_hmac_init(RAND_DRBG *drbg);
 314
 315 #endif