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;
58 /* 888 bits from 10.1 table 2 */
59 #define HASH_PRNG_MAX_SEEDLEN 111
61 struct drbg_hash_ctx_st
65 unsigned char V[HASH_PRNG_MAX_SEEDLEN];
66 unsigned char C[HASH_PRNG_MAX_SEEDLEN];
67 /* Temporary value storage: should always exceed max digest length */
68 unsigned char vtmp[HASH_PRNG_MAX_SEEDLEN];
71 struct drbg_hmac_ctx_st
75 unsigned char K[EVP_MAX_MD_SIZE];
76 unsigned char V[EVP_MAX_MD_SIZE];
79 struct drbg_ctr_ctx_st
85 /* Temp variables used by derivation function */
88 /* Temporary block storage used by ctr_df */
89 unsigned char bltmp[16];
96 /* Functions shouldn't call err library */
97 #define DRBG_FLAG_NOERR 0x4
99 /* DRBG status values */
100 /* not initialised */
101 #define DRBG_STATUS_UNINITIALISED 0
102 /* ok and ready to generate random bits */
103 #define DRBG_STATUS_READY 1
104 /* reseed required */
105 #define DRBG_STATUS_RESEED 2
106 /* fatal error condition */
107 #define DRBG_STATUS_ERROR 3
109 /* A default maximum length: larger than any reasonable value used in pratice */
111 #define DRBG_MAX_LENGTH 0x7ffffff0
112 /* Maximum DRBG block length: all md sizes are bigger than cipher blocks sizes
113 * so use max digest length.
115 #define DRBG_MAX_BLOCK EVP_MAX_MD_SIZE
117 #define DRBG_HEALTH_INTERVAL (1 << 24)
119 /* DRBG context structure */
123 /* First types common to all implementations */
124 /* DRBG type: a NID for the underlying algorithm */
128 /* Used for periodic health checks */
129 int health_check_cnt, health_check_interval;
131 /* The following parameters are setup by mechanism drbg_init() call */
136 size_t min_entropy, max_entropy;
137 size_t min_nonce, max_nonce;
138 size_t max_pers, max_adin;
139 unsigned int reseed_counter;
140 unsigned int reseed_interval;
143 /* Application data: typically used by test get_entropy */
145 /* Implementation specific structures */
152 /* Initialiase PRNG and setup callbacks below */
153 int (*init)(DRBG_CTX *ctx, int nid, int security, unsigned int flags);
154 /* Intantiate PRNG */
155 int (*instantiate)(DRBG_CTX *ctx,
156 const unsigned char *ent, size_t entlen,
157 const unsigned char *nonce, size_t noncelen,
158 const unsigned char *pers, size_t perslen);
160 int (*reseed)(DRBG_CTX *ctx,
161 const unsigned char *ent, size_t entlen,
162 const unsigned char *adin, size_t adinlen);
164 int (*generate)(DRBG_CTX *ctx,
165 unsigned char *out, size_t outlen,
166 const unsigned char *adin, size_t adinlen);
168 int (*uninstantiate)(DRBG_CTX *ctx);
170 /* Entropy source block length */
171 size_t entropy_blocklen;
173 /* entropy gathering function */
174 size_t (*get_entropy)(DRBG_CTX *ctx, unsigned char **pout,
175 int entropy, size_t min_len, size_t max_len);
176 /* Indicates we have finished with entropy buffer */
177 void (*cleanup_entropy)(DRBG_CTX *ctx, unsigned char *out, size_t olen);
179 /* nonce gathering function */
180 size_t (*get_nonce)(DRBG_CTX *ctx, unsigned char **pout,
181 int entropy, size_t min_len, size_t max_len);
182 /* Indicates we have finished with nonce buffer */
183 void (*cleanup_nonce)(DRBG_CTX *ctx, unsigned char *out, size_t olen);
185 /* Continuous random number test temporary area */
187 unsigned char lb[EVP_MAX_MD_SIZE];
188 /* set if lb is valid */
191 /* Callbacks used when called through RAND interface */
192 /* Get any additional input for generate */
193 size_t (*get_adin)(DRBG_CTX *ctx, unsigned char **pout);
194 void (*cleanup_adin)(DRBG_CTX *ctx, unsigned char *out, size_t olen);
195 /* Callback for RAND_seed(), RAND_add() */
196 int (*rand_seed_cb)(DRBG_CTX *ctx, const void *buf, int num);
197 int (*rand_add_cb)(DRBG_CTX *ctx,
198 const void *buf, int num, double entropy);
202 int fips_drbg_ctr_init(DRBG_CTX *dctx);
203 int fips_drbg_hash_init(DRBG_CTX *dctx);
204 int fips_drbg_hmac_init(DRBG_CTX *dctx);
205 int fips_drbg_kat(DRBG_CTX *dctx, int nid, unsigned int flags);
206 int fips_drbg_cprng_test(DRBG_CTX *dctx, const unsigned char *out);