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 static 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 DRBG_CTX *FIPS_drbg_new(int type, unsigned int flags)
86 dctx = OPENSSL_malloc(sizeof(DRBG_CTX));
89 FIPSerr(FIPS_F_FIPS_DRBG_NEW, ERR_R_MALLOC_FAILURE);
92 rv = fips_drbg_init(dctx, type, flags);
97 FIPSerr(FIPS_F_FIPS_DRBG_NEW, FIPS_R_UNSUPPORTED_DRBG_TYPE);
99 FIPSerr(FIPS_F_FIPS_DRBG_NEW, FIPS_R_ERROR_INITIALISING_DRBG);
107 void FIPS_drbg_free(DRBG_CTX *dctx)
109 dctx->uninstantiate(dctx);
110 OPENSSL_cleanse(dctx, sizeof(DRBG_CTX));
114 int FIPS_drbg_instantiate(DRBG_CTX *dctx,
116 const unsigned char *pers, size_t perslen)
118 size_t entlen, noncelen;
121 /* Put here so error script picks them up */
122 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE,
123 FIPS_R_PERSONALISATION_STRING_TOO_LONG);
124 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_IN_ERROR_STATE);
125 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ALREADY_INSTANTIATED);
126 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ERROR_RETRIEVING_ENTROPY);
127 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_ERROR_RETRIEVING_NONCE);
128 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, FIPS_R_INSTANTIATE_ERROR);
133 if (perslen > dctx->max_pers)
135 r = FIPS_R_PERSONALISATION_STRING_TOO_LONG;
139 if (dctx->status != DRBG_STATUS_UNINITIALISED)
141 if (dctx->status == DRBG_STATUS_ERROR)
142 r = FIPS_R_IN_ERROR_STATE;
144 r = FIPS_R_ALREADY_INSTANTIATED;
148 if (strength > dctx->strength)
150 r = FIPS_R_INSUFFICIENT_SECURITY_STRENGTH;
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;
194 /* Initial test value for reseed interval */
195 dctx->reseed_interval = 1<<24;
199 OPENSSL_cleanse(dctx->entropy, sizeof(dctx->entropy));
200 OPENSSL_cleanse(dctx->nonce, sizeof(dctx->nonce));
202 if (dctx->status == DRBG_STATUS_READY)
205 if (r && !(dctx->flags & DRBG_FLAG_TEST))
206 FIPSerr(FIPS_F_FIPS_DRBG_INSTANTIATE, r);
212 int FIPS_drbg_reseed(DRBG_CTX *dctx,
213 const unsigned char *adin, size_t adinlen)
219 FIPSerr(FIPS_F_FIPS_DRBG_RESEED, FIPS_R_NOT_INSTANTIATED);
220 FIPSerr(FIPS_F_FIPS_DRBG_RESEED, FIPS_R_ADDITIONAL_INPUT_TOO_LONG);
222 if (dctx->status != DRBG_STATUS_READY
223 && dctx->status != DRBG_STATUS_RESEED)
225 if (dctx->status == DRBG_STATUS_ERROR)
226 r = FIPS_R_IN_ERROR_STATE;
227 else if(dctx->status == DRBG_STATUS_UNINITIALISED)
228 r = FIPS_R_NOT_INSTANTIATED;
234 else if (adinlen > dctx->max_adin)
236 r = FIPS_R_ADDITIONAL_INPUT_TOO_LONG;
240 dctx->status = DRBG_STATUS_ERROR;
242 entlen = dctx->get_entropy(dctx, dctx->entropy, dctx->strength,
243 dctx->min_entropy, dctx->max_entropy);
245 if (entlen < dctx->min_entropy || entlen > dctx->max_entropy)
247 r = FIPS_R_ERROR_RETRIEVING_ENTROPY;
251 if (!dctx->reseed(dctx, dctx->entropy, entlen, adin, adinlen))
254 dctx->status = DRBG_STATUS_READY;
255 dctx->reseed_counter = 1;
257 OPENSSL_cleanse(dctx->entropy, sizeof(dctx->entropy));
259 if (dctx->status == DRBG_STATUS_READY)
262 if (r && !(dctx->flags & DRBG_FLAG_TEST))
263 FIPSerr(FIPS_F_FIPS_DRBG_RESEED, r);
269 int FIPS_drbg_generate(DRBG_CTX *dctx, unsigned char *out, size_t outlen,
270 int strength, int prediction_resistance,
271 const unsigned char *adin, size_t adinlen)
274 if (outlen > dctx->max_request)
276 r = FIPS_R_REQUEST_TOO_LARGE_FOR_DRBG;
280 if (strength > dctx->strength)
282 r = FIPS_R_INSUFFICIENT_SECURITY_STRENGTH;
286 if (dctx->status == DRBG_STATUS_RESEED || prediction_resistance)
288 if (!FIPS_drbg_reseed(dctx, adin, adinlen))
290 r = FIPS_R_RESEED_ERROR;
296 if (dctx->status != DRBG_STATUS_READY)
298 if (dctx->status == DRBG_STATUS_ERROR)
299 r = FIPS_R_IN_ERROR_STATE;
300 else if(dctx->status == DRBG_STATUS_UNINITIALISED)
301 r = FIPS_R_NOT_INSTANTIATED;
304 if (!dctx->generate(dctx, out, outlen, adin, adinlen))
306 r = FIPS_R_GENERATE_ERROR;
307 dctx->status = DRBG_STATUS_ERROR;
310 if (dctx->reseed_counter > dctx->reseed_interval)
311 dctx->status = DRBG_STATUS_RESEED;
313 dctx->reseed_counter++;
318 if (!(dctx->flags & DRBG_FLAG_TEST))
319 FIPSerr(FIPS_F_FIPS_DRBG_GENERATE, r);
326 int FIPS_drbg_uninstantiate(DRBG_CTX *dctx)
328 int save_type, save_flags, rv;
329 save_type = dctx->type;
330 save_flags = dctx->flags;
331 rv = dctx->uninstantiate(dctx);
332 OPENSSL_cleanse(dctx, sizeof(DRBG_CTX));
333 /* If method has problems uninstantiating, return error */
336 return fips_drbg_init(dctx, save_type, save_flags);
339 int FIPS_drbg_set_test_mode(DRBG_CTX *dctx,
340 size_t (*get_entropy)(DRBG_CTX *ctx, unsigned char *out,
341 int entropy, size_t min_len, size_t max_len),
342 size_t (*get_nonce)(DRBG_CTX *ctx, unsigned char *out,
343 int entropy, size_t min_len, size_t max_len))
345 if (dctx->status != DRBG_STATUS_UNINITIALISED)
347 dctx->flags |= DRBG_FLAG_TEST;
348 dctx->get_entropy = get_entropy;
349 dctx->get_nonce = get_nonce;
353 void *FIPS_drbg_get_app_data(DRBG_CTX *dctx)
355 return dctx->app_data;
358 void FIPS_drbg_set_app_data(DRBG_CTX *dctx, void *app_data)
360 dctx->app_data = app_data;
363 size_t FIPS_drbg_get_blocklength(DRBG_CTX *dctx)
365 return dctx->blocklength;
368 int FIPS_drbg_get_strength(DRBG_CTX *dctx)
370 return dctx->strength;