1 /* fips/rand/fips_drbg_lib.c */
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 #define OPENSSL_FIPSAPI
57 #include <openssl/crypto.h>
58 #include <openssl/evp.h>
59 #include <openssl/aes.h>
60 #include <openssl/err.h>
61 #include <openssl/fips_rand.h>
62 #include "fips_rand_lcl.h"
64 /* Support framework for SP800-90 DRBGs */
66 int FIPS_drbg_init(DRBG_CTX *dctx, int type, unsigned int flags)
69 memset(dctx, 0, sizeof(DRBG_CTX));
70 dctx->status = DRBG_STATUS_UNINITIALISED;
74 dctx->health_check_cnt = 0;
75 dctx->health_check_interval = DRBG_HEALTH_INTERVAL;
77 rv = fips_drbg_hash_init(dctx);
80 rv = fips_drbg_ctr_init(dctx);
85 FIPSerr(FIPS_F_FIPS_DRBG_INIT, FIPS_R_UNSUPPORTED_DRBG_TYPE);
87 FIPSerr(FIPS_F_FIPS_DRBG_INIT, FIPS_R_ERROR_INITIALISING_DRBG);
90 /* If not in test mode run selftests on DRBG of the same type */
92 if (!(dctx->flags & DRBG_FLAG_TEST))
95 if (!fips_drbg_kat(&tctx, type, flags | DRBG_FLAG_TEST))
97 FIPSerr(FIPS_F_FIPS_DRBG_INIT, FIPS_R_SELFTEST_FAILURE);
105 DRBG_CTX *FIPS_drbg_new(int type, unsigned int flags)
108 dctx = OPENSSL_malloc(sizeof(DRBG_CTX));
111 FIPSerr(FIPS_F_FIPS_DRBG_NEW, ERR_R_MALLOC_FAILURE);
117 if (FIPS_drbg_init(dctx, type, flags) <= 0)
126 void FIPS_drbg_free(DRBG_CTX *dctx)
128 if (dctx->uninstantiate)
129 dctx->uninstantiate(dctx);
130 OPENSSL_cleanse(&dctx->d, sizeof(dctx->d));
134 int FIPS_drbg_instantiate(DRBG_CTX *dctx,
135 const unsigned char *pers, size_t perslen)
137 size_t entlen = 0, noncelen = 0;
138 unsigned char *nonce = NULL, *entropy = NULL;
141 /* Put here so error script picks them up */
142 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE,
143 FIPS_R_PERSONALISATION_STRING_TOO_LONG);
144 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_IN_ERROR_STATE);
145 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ALREADY_INSTANTIATED);
146 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ERROR_RETRIEVING_ENTROPY);
147 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ERROR_RETRIEVING_NONCE);
148 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_INSTANTIATE_ERROR);
153 if (perslen > dctx->max_pers)
155 r = FIPS_R_PERSONALISATION_STRING_TOO_LONG;
159 if (dctx->status != DRBG_STATUS_UNINITIALISED)
161 if (dctx->status == DRBG_STATUS_ERROR)
162 r = FIPS_R_IN_ERROR_STATE;
164 r = FIPS_R_ALREADY_INSTANTIATED;
168 dctx->status = DRBG_STATUS_ERROR;
170 entlen = dctx->get_entropy(dctx, &entropy, dctx->strength,
171 dctx->min_entropy, dctx->max_entropy);
173 if (entlen < dctx->min_entropy || entlen > dctx->max_entropy)
175 r = FIPS_R_ERROR_RETRIEVING_ENTROPY;
179 if (dctx->max_nonce > 0)
181 noncelen = dctx->get_nonce(dctx, &nonce,
183 dctx->min_nonce, dctx->max_nonce);
185 if (noncelen < dctx->min_nonce || noncelen > dctx->max_nonce)
187 r = FIPS_R_ERROR_RETRIEVING_NONCE;
193 if (!dctx->instantiate(dctx,
198 r = FIPS_R_ERROR_INSTANTIATING_DRBG;
203 dctx->status = DRBG_STATUS_READY;
204 dctx->reseed_counter = 1;
208 if (entropy && dctx->cleanup_entropy)
209 dctx->cleanup_entropy(dctx, entropy, entlen);
211 if (nonce && dctx->cleanup_nonce)
212 dctx->cleanup_nonce(dctx, nonce, noncelen);
214 if (dctx->status == DRBG_STATUS_READY)
217 if (r && !(dctx->flags & DRBG_FLAG_NOERR))
218 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, r);
224 int FIPS_drbg_reseed(DRBG_CTX *dctx,
225 const unsigned char *adin, size_t adinlen)
227 unsigned char *entropy = NULL;
232 FIPSerr(FIPS_F_FIPS_DRBG_RESEED, FIPS_R_NOT_INSTANTIATED);
233 FIPSerr(FIPS_F_FIPS_DRBG_RESEED, FIPS_R_ADDITIONAL_INPUT_TOO_LONG);
235 if (dctx->status != DRBG_STATUS_READY
236 && dctx->status != DRBG_STATUS_RESEED)
238 if (dctx->status == DRBG_STATUS_ERROR)
239 r = FIPS_R_IN_ERROR_STATE;
240 else if(dctx->status == DRBG_STATUS_UNINITIALISED)
241 r = FIPS_R_NOT_INSTANTIATED;
247 else if (adinlen > dctx->max_adin)
249 r = FIPS_R_ADDITIONAL_INPUT_TOO_LONG;
253 dctx->status = DRBG_STATUS_ERROR;
255 entlen = dctx->get_entropy(dctx, &entropy, dctx->strength,
256 dctx->min_entropy, dctx->max_entropy);
258 if (entlen < dctx->min_entropy || entlen > dctx->max_entropy)
260 r = FIPS_R_ERROR_RETRIEVING_ENTROPY;
264 if (!dctx->reseed(dctx, entropy, entlen, adin, adinlen))
267 dctx->status = DRBG_STATUS_READY;
268 dctx->reseed_counter = 1;
271 if (entropy && dctx->cleanup_entropy)
272 dctx->cleanup_entropy(dctx, entropy, entlen);
274 if (dctx->status == DRBG_STATUS_READY)
277 if (r && !(dctx->flags & DRBG_FLAG_NOERR))
278 FIPSerr(FIPS_F_FIPS_DRBG_RESEED, r);
283 static int fips_drbg_check(DRBG_CTX *dctx)
285 if (dctx->flags & DRBG_FLAG_TEST)
287 dctx->health_check_cnt++;
288 if (dctx->health_check_cnt >= dctx->health_check_interval)
291 if (!fips_drbg_kat(&tctx, dctx->type,
292 dctx->flags | DRBG_FLAG_TEST))
294 FIPSerr(FIPS_F_FIPS_DRBG_CHECK, FIPS_R_SELFTEST_FAILURE);
297 dctx->health_check_cnt = 0;
302 int FIPS_drbg_generate(DRBG_CTX *dctx, unsigned char *out, size_t outlen,
303 int strength, int prediction_resistance,
304 const unsigned char *adin, size_t adinlen)
308 if (!fips_drbg_check(dctx))
311 if (dctx->status != DRBG_STATUS_READY
312 && dctx->status != DRBG_STATUS_RESEED)
314 if (dctx->status == DRBG_STATUS_ERROR)
315 r = FIPS_R_IN_ERROR_STATE;
316 else if(dctx->status == DRBG_STATUS_UNINITIALISED)
317 r = FIPS_R_NOT_INSTANTIATED;
321 if (outlen > dctx->max_request)
323 r = FIPS_R_REQUEST_TOO_LARGE_FOR_DRBG;
327 if (strength > dctx->strength)
329 r = FIPS_R_INSUFFICIENT_SECURITY_STRENGTH;
333 if (dctx->status == DRBG_STATUS_RESEED || prediction_resistance)
335 if (!FIPS_drbg_reseed(dctx, adin, adinlen))
337 r = FIPS_R_RESEED_ERROR;
344 if (!dctx->generate(dctx, out, outlen, adin, adinlen))
346 r = FIPS_R_GENERATE_ERROR;
347 dctx->status = DRBG_STATUS_ERROR;
350 if (dctx->reseed_counter >= dctx->reseed_interval)
351 dctx->status = DRBG_STATUS_RESEED;
353 dctx->reseed_counter++;
358 if (!(dctx->flags & DRBG_FLAG_NOERR))
359 FIPSerr(FIPS_F_FIPS_DRBG_GENERATE, r);
366 int FIPS_drbg_uninstantiate(DRBG_CTX *dctx)
369 if (!dctx->uninstantiate)
372 rv = dctx->uninstantiate(dctx);
373 /* Although we'd like to cleanse here we can't because we have to
374 * test the uninstantiate really zeroes the data.
376 memset(&dctx->d, 0, sizeof(dctx->d));
377 dctx->status = DRBG_STATUS_UNINITIALISED;
378 /* If method has problems uninstantiating, return error */
382 int FIPS_drbg_set_callbacks(DRBG_CTX *dctx,
383 size_t (*get_entropy)(DRBG_CTX *ctx, unsigned char **pout,
384 int entropy, size_t min_len, size_t max_len),
385 void (*cleanup_entropy)(DRBG_CTX *ctx, unsigned char *out, size_t olen),
386 size_t (*get_nonce)(DRBG_CTX *ctx, unsigned char **pout,
387 int entropy, size_t min_len, size_t max_len),
388 void (*cleanup_nonce)(DRBG_CTX *ctx, unsigned char *out, size_t olen))
390 if (dctx->status != DRBG_STATUS_UNINITIALISED)
392 dctx->get_entropy = get_entropy;
393 dctx->cleanup_entropy = cleanup_entropy;
394 dctx->get_nonce = get_nonce;
395 dctx->cleanup_nonce = cleanup_nonce;
399 int FIPS_drbg_set_rand_callbacks(DRBG_CTX *dctx,
400 size_t (*get_adin)(DRBG_CTX *ctx, unsigned char **pout),
401 void (*cleanup_adin)(DRBG_CTX *ctx, unsigned char *out, size_t olen),
402 int (*rand_seed_cb)(DRBG_CTX *ctx, const void *buf, int num),
403 int (*rand_add_cb)(DRBG_CTX *ctx,
404 const void *buf, int num, double entropy))
406 if (dctx->status != DRBG_STATUS_UNINITIALISED)
408 dctx->get_adin = get_adin;
409 dctx->cleanup_adin = cleanup_adin;
410 dctx->rand_seed_cb = rand_seed_cb;
411 dctx->rand_add_cb = rand_add_cb;
415 void *FIPS_drbg_get_app_data(DRBG_CTX *dctx)
417 return dctx->app_data;
420 void FIPS_drbg_set_app_data(DRBG_CTX *dctx, void *app_data)
422 dctx->app_data = app_data;
425 size_t FIPS_drbg_get_blocklength(DRBG_CTX *dctx)
427 return dctx->blocklength;
430 int FIPS_drbg_get_strength(DRBG_CTX *dctx)
432 return dctx->strength;
435 void FIPS_drbg_set_check_interval(DRBG_CTX *dctx, int interval)
437 dctx->health_check_interval = interval;
440 static int drbg_stick = 0;
442 void FIPS_drbg_stick(void)
447 /* Continuous DRBG utility function */
448 int fips_drbg_cprng_test(DRBG_CTX *dctx, const unsigned char *out)
450 /* No CPRNG in test mode */
451 if (dctx->flags & DRBG_FLAG_TEST)
453 /* Check block is valid: should never happen */
454 if (dctx->lb_valid == 0)
456 FIPSerr(FIPS_F_FIPS_DRBG_CPRNG_TEST, FIPS_R_INTERNAL_ERROR);
457 fips_set_selftest_fail();
461 memcpy(dctx->lb, out, dctx->blocklength);
462 /* Check against last block: fail if match */
463 if (!memcmp(dctx->lb, out, dctx->blocklength))
465 FIPSerr(FIPS_F_FIPS_DRBG_CPRNG_TEST, FIPS_R_DRBG_STUCK);
466 fips_set_selftest_fail();
469 /* Save last block for next comparison */
470 memcpy(dctx->lb, out, dctx->blocklength);