Extensive reorganisation of PRNG handling in FIPS module: all calls
[openssl.git] / crypto / rand / rand_lib.c
1 /* crypto/rand/rand_lib.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include <time.h>
61 #include "cryptlib.h"
62 #include <openssl/rand.h>
63
64 #ifndef OPENSSL_NO_ENGINE
65 #include <openssl/engine.h>
66 #endif
67
68 #ifndef OPENSSL_NO_ENGINE
69 /* non-NULL if default_RAND_meth is ENGINE-provided */
70 static ENGINE *funct_ref =NULL;
71 #endif
72 static const RAND_METHOD *default_RAND_meth = NULL;
73
74 int RAND_set_rand_method(const RAND_METHOD *meth)
75         {
76 #ifndef OPENSSL_NO_ENGINE
77         if(funct_ref)
78                 {
79                 ENGINE_finish(funct_ref);
80                 funct_ref = NULL;
81                 }
82 #endif
83         default_RAND_meth = meth;
84         return 1;
85         }
86
87 const RAND_METHOD *RAND_get_rand_method(void)
88         {
89         if (!default_RAND_meth)
90                 {
91 #ifndef OPENSSL_NO_ENGINE
92                 ENGINE *e = ENGINE_get_default_RAND();
93                 if(e)
94                         {
95                         default_RAND_meth = ENGINE_get_RAND(e);
96                         if(!default_RAND_meth)
97                                 {
98                                 ENGINE_finish(e);
99                                 e = NULL;
100                                 }
101                         }
102                 if(e)
103                         funct_ref = e;
104                 else
105 #endif
106                         default_RAND_meth = RAND_SSLeay();
107                 }
108         return default_RAND_meth;
109         }
110
111 #ifndef OPENSSL_NO_ENGINE
112 int RAND_set_rand_engine(ENGINE *engine)
113         {
114         const RAND_METHOD *tmp_meth = NULL;
115         if(engine)
116                 {
117                 if(!ENGINE_init(engine))
118                         return 0;
119                 tmp_meth = ENGINE_get_RAND(engine);
120                 if(!tmp_meth)
121                         {
122                         ENGINE_finish(engine);
123                         return 0;
124                         }
125                 }
126         /* This function releases any prior ENGINE so call it first */
127         RAND_set_rand_method(tmp_meth);
128         funct_ref = engine;
129         return 1;
130         }
131 #endif
132
133 void RAND_cleanup(void)
134         {
135         const RAND_METHOD *meth = RAND_get_rand_method();
136         if (meth && meth->cleanup)
137                 meth->cleanup();
138         RAND_set_rand_method(NULL);
139         }
140
141 void RAND_seed(const void *buf, int num)
142         {
143         const RAND_METHOD *meth = RAND_get_rand_method();
144         if (meth && meth->seed)
145                 meth->seed(buf,num);
146         }
147
148 void RAND_add(const void *buf, int num, double entropy)
149         {
150         const RAND_METHOD *meth = RAND_get_rand_method();
151         if (meth && meth->add)
152                 meth->add(buf,num,entropy);
153         }
154
155 int RAND_bytes(unsigned char *buf, int num)
156         {
157         const RAND_METHOD *meth = RAND_get_rand_method();
158         if (meth && meth->bytes)
159                 return meth->bytes(buf,num);
160         return(-1);
161         }
162
163 int RAND_pseudo_bytes(unsigned char *buf, int num)
164         {
165         const RAND_METHOD *meth = RAND_get_rand_method();
166         if (meth && meth->pseudorand)
167                 return meth->pseudorand(buf,num);
168         return(-1);
169         }
170
171 int RAND_status(void)
172         {
173         const RAND_METHOD *meth = RAND_get_rand_method();
174         if (meth && meth->status)
175                 return meth->status();
176         return 0;
177         }
178
179 #ifdef OPENSSL_FIPS
180
181 #include <openssl/fips.h>
182 #include <openssl/fips_rand.h>
183
184 /* FIPS DRBG initialisation code. This sets up the DRBG for use by the
185  * rest of OpenSSL. 
186  */
187
188 /* Entropy gatherer: use standard OpenSSL PRNG to seed (this will gather
189  * entropy internally through RAND_poll().
190  */
191
192 static size_t drbg_get_entropy(DRBG_CTX *ctx, unsigned char **pout,
193                                 int entropy, size_t min_len, size_t max_len)
194         {
195         *pout = OPENSSL_malloc(min_len);
196         if (!*pout)
197                 return 0;
198         if (RAND_SSLeay()->bytes(*pout, min_len) <= 0)
199                 {
200                 OPENSSL_free(*pout);
201                 *pout = NULL;
202                 return 0;
203                 }
204         return min_len;
205         }
206
207 static void drbg_free_entropy(DRBG_CTX *ctx, unsigned char *out, size_t olen)
208         {
209         OPENSSL_cleanse(out, olen);
210         OPENSSL_free(out);
211         }
212
213 /* RAND_add() and RAND_seed() pass through to OpenSSL PRNG so it is 
214  * correctly seeded by RAND_poll().
215  */
216
217 static int drbg_rand_add(DRBG_CTX *ctx, const void *in, int inlen,
218                                 double entropy)
219         {
220         return RAND_SSLeay()->add(in, inlen, entropy);
221         }
222
223 static int drbg_rand_seed(DRBG_CTX *ctx, const void *in, int inlen)
224         {
225         return RAND_SSLeay()->seed(in, inlen);
226         }
227
228 int RAND_init_fips(void)
229         {
230         DRBG_CTX *dctx;
231         unsigned char pers[16] = {0,0,0};
232         dctx = FIPS_get_default_drbg();
233         FIPS_drbg_init(dctx, NID_aes_256_ctr, DRBG_FLAG_CTR_USE_DF);
234         FIPS_drbg_set_callbacks(dctx,
235                                 drbg_get_entropy, drbg_free_entropy,
236                                 drbg_get_entropy, drbg_free_entropy);
237         FIPS_drbg_set_rand_callbacks(dctx, 0, 0,
238                                         drbg_rand_seed, drbg_rand_add);
239         FIPS_drbg_instantiate(dctx, pers, sizeof(pers));
240         FIPS_rand_set_method(FIPS_drbg_method());
241         return 1;
242         }
243
244 #endif