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 rv = fips_drbg_hash_init(dctx);
77 rv = fips_drbg_ctr_init(dctx);
82 FIPSerr(FIPS_F_FIPS_DRBG_INIT, FIPS_R_UNSUPPORTED_DRBG_TYPE);
84 FIPSerr(FIPS_F_FIPS_DRBG_INIT, FIPS_R_ERROR_INITIALISING_DRBG);
90 DRBG_CTX *FIPS_drbg_new(int type, unsigned int flags)
94 dctx = OPENSSL_malloc(sizeof(DRBG_CTX));
97 FIPSerr(FIPS_F_FIPS_DRBG_NEW, ERR_R_MALLOC_FAILURE);
102 rv = FIPS_drbg_init(dctx, type, flags);
104 if (FIPS_drbg_init(dctx, type, flags) <= 0)
113 void FIPS_drbg_free(DRBG_CTX *dctx)
115 if (dctx->uninstantiate)
116 dctx->uninstantiate(dctx);
117 OPENSSL_cleanse(dctx, sizeof(DRBG_CTX));
121 int FIPS_drbg_instantiate(DRBG_CTX *dctx,
122 const unsigned char *pers, size_t perslen)
124 size_t entlen, noncelen;
127 /* Put here so error script picks them up */
128 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE,
129 FIPS_R_PERSONALISATION_STRING_TOO_LONG);
130 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_IN_ERROR_STATE);
131 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ALREADY_INSTANTIATED);
132 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ERROR_RETRIEVING_ENTROPY);
133 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ERROR_RETRIEVING_NONCE);
134 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_INSTANTIATE_ERROR);
139 if (perslen > dctx->max_pers)
141 r = FIPS_R_PERSONALISATION_STRING_TOO_LONG;
145 if (dctx->status != DRBG_STATUS_UNINITIALISED)
147 if (dctx->status == DRBG_STATUS_ERROR)
148 r = FIPS_R_IN_ERROR_STATE;
150 r = FIPS_R_ALREADY_INSTANTIATED;
154 dctx->status = DRBG_STATUS_ERROR;
156 entlen = dctx->get_entropy(dctx, dctx->entropy, dctx->strength,
157 dctx->min_entropy, dctx->max_entropy);
159 if (entlen < dctx->min_entropy || entlen > dctx->max_entropy)
161 r = FIPS_R_ERROR_RETRIEVING_ENTROPY;
165 if (dctx->max_nonce > 0)
168 noncelen = dctx->get_nonce(dctx, dctx->nonce,
170 dctx->min_nonce, dctx->max_nonce);
172 if (noncelen < dctx->min_nonce || noncelen > dctx->max_nonce)
174 r = FIPS_R_ERROR_RETRIEVING_NONCE;
182 if (!dctx->instantiate(dctx,
183 dctx->entropy, entlen,
184 dctx->nonce, noncelen,
187 r = FIPS_R_ERROR_INSTANTIATING_DRBG;
192 dctx->status = DRBG_STATUS_READY;
193 dctx->reseed_counter = 1;
197 OPENSSL_cleanse(dctx->entropy, sizeof(dctx->entropy));
198 OPENSSL_cleanse(dctx->nonce, sizeof(dctx->nonce));
200 if (dctx->status == DRBG_STATUS_READY)
203 if (r && !(dctx->flags & DRBG_FLAG_NOERR))
204 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, r);
210 int FIPS_drbg_reseed(DRBG_CTX *dctx,
211 const unsigned char *adin, size_t adinlen)
217 FIPSerr(FIPS_F_FIPS_DRBG_RESEED, FIPS_R_NOT_INSTANTIATED);
218 FIPSerr(FIPS_F_FIPS_DRBG_RESEED, FIPS_R_ADDITIONAL_INPUT_TOO_LONG);
220 if (dctx->status != DRBG_STATUS_READY
221 && dctx->status != DRBG_STATUS_RESEED)
223 if (dctx->status == DRBG_STATUS_ERROR)
224 r = FIPS_R_IN_ERROR_STATE;
225 else if(dctx->status == DRBG_STATUS_UNINITIALISED)
226 r = FIPS_R_NOT_INSTANTIATED;
232 else if (adinlen > dctx->max_adin)
234 r = FIPS_R_ADDITIONAL_INPUT_TOO_LONG;
238 dctx->status = DRBG_STATUS_ERROR;
240 entlen = dctx->get_entropy(dctx, dctx->entropy, dctx->strength,
241 dctx->min_entropy, dctx->max_entropy);
243 if (entlen < dctx->min_entropy || entlen > dctx->max_entropy)
245 r = FIPS_R_ERROR_RETRIEVING_ENTROPY;
249 if (!dctx->reseed(dctx, dctx->entropy, entlen, adin, adinlen))
252 dctx->status = DRBG_STATUS_READY;
253 dctx->reseed_counter = 1;
255 OPENSSL_cleanse(dctx->entropy, sizeof(dctx->entropy));
257 if (dctx->status == DRBG_STATUS_READY)
260 if (r && !(dctx->flags & DRBG_FLAG_NOERR))
261 FIPSerr(FIPS_F_FIPS_DRBG_RESEED, r);
267 static int fips_drbg_generate_internal(DRBG_CTX *dctx,
268 unsigned char *out, size_t outlen,
269 int strength, int prediction_resistance,
270 const unsigned char *adin, size_t adinlen)
273 if (outlen > dctx->max_request)
275 r = FIPS_R_REQUEST_TOO_LARGE_FOR_DRBG;
279 if (strength > dctx->strength)
281 r = FIPS_R_INSUFFICIENT_SECURITY_STRENGTH;
285 if (dctx->status == DRBG_STATUS_RESEED || prediction_resistance)
287 if (!FIPS_drbg_reseed(dctx, adin, adinlen))
289 r = FIPS_R_RESEED_ERROR;
295 if (dctx->status != DRBG_STATUS_READY)
297 if (dctx->status == DRBG_STATUS_ERROR)
298 r = FIPS_R_IN_ERROR_STATE;
299 else if(dctx->status == DRBG_STATUS_UNINITIALISED)
300 r = FIPS_R_NOT_INSTANTIATED;
303 if (!dctx->generate(dctx, out, outlen, adin, adinlen))
305 r = FIPS_R_GENERATE_ERROR;
306 dctx->status = DRBG_STATUS_ERROR;
309 if (dctx->reseed_counter >= dctx->reseed_interval)
310 dctx->status = DRBG_STATUS_RESEED;
312 dctx->reseed_counter++;
317 if (!(dctx->flags & DRBG_FLAG_NOERR))
318 FIPSerr(FIPS_F_FIPS_DRBG_GENERATE_INTERNAL, r);
325 /* external generate function: incorporates continuous RNG test if not
329 int FIPS_drbg_generate(DRBG_CTX *dctx,
330 unsigned char *out, size_t outlen,
331 int strength, int prediction_resistance,
332 const unsigned char *adin, size_t adinlen)
334 unsigned char tmp[16], *pout;
336 /* If test mode don't run continuous RNG test */
337 if (dctx->flags & DRBG_FLAG_TEST)
339 return fips_drbg_generate_internal(dctx, out, outlen,
341 prediction_resistance,
344 /* If this is the first call generate block and save buffer */
347 if (!fips_drbg_generate_internal(dctx, dctx->lb, 16,
348 strength, prediction_resistance,
354 /* If request less that 16 bytes request 16 in temp buffer */
368 if (!fips_drbg_generate_internal(dctx, pout, poutlen,
369 strength, prediction_resistance,
372 /* Compare to last block for continuous PRNG test */
373 if (!memcmp(pout, dctx->lb, 16))
375 FIPSerr(FIPS_F_FIPS_DRBG_GENERATE, FIPS_R_DRBG_STUCK);
378 /* Update last block */
379 memcpy(dctx->lb, pout, 16);
380 /* Copy to output buffer if needed */
382 memcpy(out, pout, outlen);
388 int FIPS_drbg_uninstantiate(DRBG_CTX *dctx)
391 if (!dctx->uninstantiate)
394 rv = dctx->uninstantiate(dctx);
395 /* Although we'd like to cleanse here we can't because we have to
396 * test the uninstantiate really zeroes the data.
398 memset(dctx, 0, sizeof(DRBG_CTX));
399 /* If method has problems uninstantiating, return error */
403 int FIPS_drbg_set_callbacks(DRBG_CTX *dctx,
404 size_t (*get_entropy)(DRBG_CTX *ctx, unsigned char *out,
405 int entropy, size_t min_len, size_t max_len),
406 size_t (*get_nonce)(DRBG_CTX *ctx, unsigned char *out,
407 int entropy, size_t min_len, size_t max_len))
409 if (dctx->status != DRBG_STATUS_UNINITIALISED)
411 dctx->get_entropy = get_entropy;
412 dctx->get_nonce = get_nonce;
416 void *FIPS_drbg_get_app_data(DRBG_CTX *dctx)
418 return dctx->app_data;
421 void FIPS_drbg_set_app_data(DRBG_CTX *dctx, void *app_data)
423 dctx->app_data = app_data;
426 size_t FIPS_drbg_get_blocklength(DRBG_CTX *dctx)
428 return dctx->blocklength;
431 int FIPS_drbg_get_strength(DRBG_CTX *dctx)
433 return dctx->strength;