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_ctr_ctx_st DRBG_CTR_CTX;
57 /* 888 bits from 10.1 table 2 */
58 #define HASH_PRNG_MAX_SEEDLEN 111
60 struct drbg_hash_ctx_st
64 unsigned char V[HASH_PRNG_MAX_SEEDLEN];
65 unsigned char C[HASH_PRNG_MAX_SEEDLEN];
66 /* Temporary value storage: should always exceed max digest length */
67 unsigned char vtmp[HASH_PRNG_MAX_SEEDLEN];
70 struct drbg_ctr_ctx_st
76 /* Temp variables used by derivation function */
79 /* Temporary block storage used by ctr_df */
80 unsigned char bltmp[16];
87 /* Functions shouldn't call err library */
88 #define DRBG_FLAG_NOERR 0x4
90 /* DRBG status values */
92 #define DRBG_STATUS_UNINITIALISED 0
93 /* ok and ready to generate random bits */
94 #define DRBG_STATUS_READY 1
96 #define DRBG_STATUS_RESEED 2
97 /* fatal error condition */
98 #define DRBG_STATUS_ERROR 3
100 /* A default maximum length: larger than any reasonable value used in pratice */
102 #define DRBG_MAX_LENGTH 0x7ffffff0
104 /* DRBG context structure */
108 /* First types common to all implementations */
109 /* DRBG type: a NID for the underlying algorithm */
114 /* The following parameters are setup by mechanism drbg_init() call */
119 size_t min_entropy, max_entropy;
120 size_t min_nonce, max_nonce;
121 size_t max_pers, max_adin;
122 unsigned int reseed_counter;
123 unsigned int reseed_interval;
126 /* Application data: typically used by test get_entropy */
128 /* Implementation specific structures */
134 /* Initialiase PRNG and setup callbacks below */
135 int (*init)(DRBG_CTX *ctx, int nid, int security, unsigned int flags);
136 /* Intantiate PRNG */
137 int (*instantiate)(DRBG_CTX *ctx,
138 const unsigned char *ent, size_t entlen,
139 const unsigned char *nonce, size_t noncelen,
140 const unsigned char *pers, size_t perslen);
142 int (*reseed)(DRBG_CTX *ctx,
143 const unsigned char *ent, size_t entlen,
144 const unsigned char *adin, size_t adinlen);
146 int (*generate)(DRBG_CTX *ctx,
147 unsigned char *out, size_t outlen,
148 const unsigned char *adin, size_t adinlen);
150 int (*uninstantiate)(DRBG_CTX *ctx);
152 /* entropy gathering function */
153 size_t (*get_entropy)(DRBG_CTX *ctx, unsigned char **pout,
154 int entropy, size_t min_len, size_t max_len);
155 /* Indicates we have finished with entropy buffer */
156 void (*cleanup_entropy)(DRBG_CTX *ctx, unsigned char *out, size_t olen);
158 /* nonce gathering function */
159 size_t (*get_nonce)(DRBG_CTX *ctx, unsigned char **pout,
160 int entropy, size_t min_len, size_t max_len);
161 /* Indicates we have finished with nonce buffer */
162 void (*cleanup_nonce)(DRBG_CTX *ctx, unsigned char *out, size_t olen);
164 /* Continuous random number test temporary area */
166 unsigned char lb[16];
167 /* set if lb is valid */
170 /* Callbacks used when called through RAND interface */
171 /* Get any additional input for generate */
172 size_t (*get_adin)(DRBG_CTX *ctx, unsigned char **pout);
173 void (*cleanup_adin)(DRBG_CTX *ctx, unsigned char *out, size_t olen);
174 /* Callback for RAND_seed(), RAND_add() */
175 int (*rand_seed_cb)(DRBG_CTX *ctx, const void *buf, int num);
176 int (*rand_add_cb)(DRBG_CTX *ctx,
177 const void *buf, int num, double entropy);
181 int fips_drbg_ctr_init(DRBG_CTX *dctx);
182 int fips_drbg_hash_init(DRBG_CTX *dctx);
183 int fips_drbg_kat(DRBG_CTX *dctx, int nid, unsigned int flags);