1 /* fips/rand/fips_rand_lcl.h */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2011 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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 * licensing@OpenSSL.org.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
54 typedef struct drbg_hash_ctx_st DRBG_HASH_CTX;
55 typedef struct drbg_hmac_ctx_st DRBG_HMAC_CTX;
56 typedef struct drbg_ctr_ctx_st DRBG_CTR_CTX;
57 typedef struct drbg_ec_ctx_st DRBG_EC_CTX;
59 /* 888 bits from 10.1 table 2 */
60 #define HASH_PRNG_MAX_SEEDLEN 111
62 struct drbg_hash_ctx_st
66 unsigned char V[HASH_PRNG_MAX_SEEDLEN];
67 unsigned char C[HASH_PRNG_MAX_SEEDLEN];
68 /* Temporary value storage: should always exceed max digest length */
69 unsigned char vtmp[HASH_PRNG_MAX_SEEDLEN];
72 struct drbg_hmac_ctx_st
76 unsigned char K[EVP_MAX_MD_SIZE];
77 unsigned char V[EVP_MAX_MD_SIZE];
80 struct drbg_ctr_ctx_st
86 /* Temp variables used by derivation function */
89 /* Temporary block storage used by ctr_df */
90 unsigned char bltmp[16];
95 /* Maximum seed length */
96 #define EC_PRNG_MAX_SEEDLEN 66
100 /* Message digest to use */
102 /* Curve to use: generator is point P */
106 /* Temporary point */
111 /* Buffer to store byte version of s value */
112 unsigned char sbuf[EC_PRNG_MAX_SEEDLEN];
113 /* Buffer to store byte version of t value */
114 unsigned char tbuf[EC_PRNG_MAX_SEEDLEN];
117 /* Temporary value storage: should always exceed max digest length */
118 unsigned char vtmp[EC_PRNG_MAX_SEEDLEN];
119 /* Flag to indicate s = s * P has been deferred */
121 /* Temp BN context */
125 /* DRBG internal flags */
127 /* Functions shouldn't call err library */
128 #define DRBG_FLAG_NOERR 0x1
129 /* Custom reseed checking */
130 #define DRBG_CUSTOM_RESEED 0x2
132 /* DRBG status values */
133 /* not initialised */
134 #define DRBG_STATUS_UNINITIALISED 0
135 /* ok and ready to generate random bits */
136 #define DRBG_STATUS_READY 1
137 /* reseed required */
138 #define DRBG_STATUS_RESEED 2
139 /* fatal error condition */
140 #define DRBG_STATUS_ERROR 3
142 /* A default maximum length: larger than any reasonable value used in pratice */
144 #define DRBG_MAX_LENGTH 0x7ffffff0
145 /* Maximum DRBG block length: all md sizes are bigger than cipher blocks sizes
146 * so use max digest length.
148 #define DRBG_MAX_BLOCK EVP_MAX_MD_SIZE
150 #define DRBG_HEALTH_INTERVAL (1 << 24)
152 /* DRBG context structure */
156 /* First types common to all implementations */
157 /* DRBG type: a NID for the underlying algorithm */
159 /* Various external flags */
161 /* Various internal use only flags */
163 /* Used for periodic health checks */
164 int health_check_cnt, health_check_interval;
166 /* The following parameters are setup by mechanism drbg_init() call */
171 size_t min_entropy, max_entropy;
172 size_t min_nonce, max_nonce;
173 size_t max_pers, max_adin;
174 unsigned int reseed_counter;
175 unsigned int reseed_interval;
178 /* Application data: typically used by test get_entropy */
180 /* Implementation specific structures */
188 /* Initialiase PRNG and setup callbacks below */
189 int (*init)(DRBG_CTX *ctx, int nid, int security, unsigned int flags);
190 /* Intantiate PRNG */
191 int (*instantiate)(DRBG_CTX *ctx,
192 const unsigned char *ent, size_t entlen,
193 const unsigned char *nonce, size_t noncelen,
194 const unsigned char *pers, size_t perslen);
196 int (*reseed)(DRBG_CTX *ctx,
197 const unsigned char *ent, size_t entlen,
198 const unsigned char *adin, size_t adinlen);
200 int (*generate)(DRBG_CTX *ctx,
201 unsigned char *out, size_t outlen,
202 const unsigned char *adin, size_t adinlen);
204 int (*uninstantiate)(DRBG_CTX *ctx);
206 /* Entropy source block length */
207 size_t entropy_blocklen;
209 /* entropy gathering function */
210 size_t (*get_entropy)(DRBG_CTX *ctx, unsigned char **pout,
211 int entropy, size_t min_len, size_t max_len);
212 /* Indicates we have finished with entropy buffer */
213 void (*cleanup_entropy)(DRBG_CTX *ctx, unsigned char *out, size_t olen);
215 /* nonce gathering function */
216 size_t (*get_nonce)(DRBG_CTX *ctx, unsigned char **pout,
217 int entropy, size_t min_len, size_t max_len);
218 /* Indicates we have finished with nonce buffer */
219 void (*cleanup_nonce)(DRBG_CTX *ctx, unsigned char *out, size_t olen);
221 /* Continuous random number test temporary area */
223 unsigned char lb[EVP_MAX_MD_SIZE];
224 /* set if lb is valid */
227 /* Callbacks used when called through RAND interface */
228 /* Get any additional input for generate */
229 size_t (*get_adin)(DRBG_CTX *ctx, unsigned char **pout);
230 void (*cleanup_adin)(DRBG_CTX *ctx, unsigned char *out, size_t olen);
231 /* Callback for RAND_seed(), RAND_add() */
232 int (*rand_seed_cb)(DRBG_CTX *ctx, const void *buf, int num);
233 int (*rand_add_cb)(DRBG_CTX *ctx,
234 const void *buf, int num, double entropy);
238 int fips_drbg_ctr_init(DRBG_CTX *dctx);
239 int fips_drbg_hash_init(DRBG_CTX *dctx);
240 int fips_drbg_hmac_init(DRBG_CTX *dctx);
241 int fips_drbg_ec_init(DRBG_CTX *dctx);
242 int fips_drbg_kat(DRBG_CTX *dctx, int nid, unsigned int flags);
243 int fips_drbg_cprng_test(DRBG_CTX *dctx, const unsigned char *out);