Redirect DSA operations to FIPS module in FIPS mode.
[openssl.git] / crypto / dsa / dsa_gen.c
1 /* crypto/dsa/dsa_gen.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 #undef GENUINE_DSA
60
61 #ifdef GENUINE_DSA
62 /* Parameter generation follows the original release of FIPS PUB 186,
63  * Appendix 2.2 (i.e. use SHA as defined in FIPS PUB 180) */
64 #define HASH    EVP_sha()
65 #else
66 /* Parameter generation follows the updated Appendix 2.2 for FIPS PUB 186,
67  * also Appendix 2.2 of FIPS PUB 186-1 (i.e. use SHA as defined in
68  * FIPS PUB 180-1) */
69 #define HASH    EVP_sha1()
70 #endif 
71
72 #include <openssl/opensslconf.h> /* To see if OPENSSL_NO_SHA is defined */
73
74 #ifndef OPENSSL_NO_SHA
75
76 #include <stdio.h>
77 #include "cryptlib.h"
78 #include <openssl/evp.h>
79 #include <openssl/bn.h>
80 #include <openssl/rand.h>
81 #include <openssl/sha.h>
82 #include "dsa_locl.h"
83
84 #ifdef OPENSSL_FIPS
85 #include <openssl/fips.h>
86 #endif
87
88 int DSA_generate_parameters_ex(DSA *ret, int bits,
89                 const unsigned char *seed_in, int seed_len,
90                 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb)
91         {
92         if (FIPS_mode() && !(ret->meth->flags & DSA_FLAG_FIPS_METHOD)
93                         && !(ret->flags & DSA_FLAG_NON_FIPS_ALLOW))
94                 {
95                 DSAerr(DSA_F_DSA_GENERATE_PARAMETERS_EX, DSA_R_NON_FIPS_DSA_METHOD);
96                 return 0;
97                 }
98
99         if(ret->meth->dsa_paramgen)
100                 return ret->meth->dsa_paramgen(ret, bits, seed_in, seed_len,
101                                 counter_ret, h_ret, cb);
102 #ifdef OPENSSL_FIPS
103         else if (FIPS_mode())
104                 {
105                 return FIPS_dsa_generate_parameters_ex(ret, bits, 
106                                                         seed_in, seed_len,
107                                                         counter_ret, h_ret, cb);
108                 }
109 #endif
110         else
111                 {
112                 const EVP_MD *evpmd;
113                 size_t qbits = bits >= 2048 ? 256 : 160;
114
115                 if (bits >= 2048)
116                         {
117                         qbits = 256;
118                         evpmd = EVP_sha256();
119                         }
120                 else
121                         {
122                         qbits = 160;
123                         evpmd = EVP_sha1();
124                         }
125
126                 return dsa_builtin_paramgen(ret, bits, qbits, evpmd,
127                         seed_in, seed_len, NULL, counter_ret, h_ret, cb);
128                 }
129         }
130
131 int dsa_builtin_paramgen(DSA *ret, size_t bits, size_t qbits,
132         const EVP_MD *evpmd, const unsigned char *seed_in, size_t seed_len,
133         unsigned char *seed_out,
134         int *counter_ret, unsigned long *h_ret, BN_GENCB *cb)
135         {
136         int ok=0;
137         unsigned char seed[SHA256_DIGEST_LENGTH];
138         unsigned char md[SHA256_DIGEST_LENGTH];
139         unsigned char buf[SHA256_DIGEST_LENGTH],buf2[SHA256_DIGEST_LENGTH];
140         BIGNUM *r0,*W,*X,*c,*test;
141         BIGNUM *g=NULL,*q=NULL,*p=NULL;
142         BN_MONT_CTX *mont=NULL;
143         int i, k, n=0, m=0, qsize = qbits >> 3;
144         int counter=0;
145         int r=0;
146         BN_CTX *ctx=NULL;
147         unsigned int h=2;
148
149         if (qsize != SHA_DIGEST_LENGTH && qsize != SHA224_DIGEST_LENGTH &&
150             qsize != SHA256_DIGEST_LENGTH)
151                 /* invalid q size */
152                 return 0;
153
154         if (evpmd == NULL)
155                 /* use SHA1 as default */
156                 evpmd = EVP_sha1();
157
158         if (bits < 512)
159                 bits = 512;
160
161         bits = (bits+63)/64*64;
162
163         /* NB: seed_len == 0 is special case: copy generated seed to
164          * seed_in if it is not NULL.
165          */
166         if (seed_len && (seed_len < (size_t)qsize))
167                 seed_in = NULL;         /* seed buffer too small -- ignore */
168         if (seed_len > (size_t)qsize) 
169                 seed_len = qsize;       /* App. 2.2 of FIPS PUB 186 allows larger SEED,
170                                          * but our internal buffers are restricted to 160 bits*/
171         if (seed_in != NULL)
172                 memcpy(seed, seed_in, seed_len);
173
174         if ((ctx=BN_CTX_new()) == NULL)
175                 goto err;
176
177         if ((mont=BN_MONT_CTX_new()) == NULL)
178                 goto err;
179
180         BN_CTX_start(ctx);
181         r0 = BN_CTX_get(ctx);
182         g = BN_CTX_get(ctx);
183         W = BN_CTX_get(ctx);
184         q = BN_CTX_get(ctx);
185         X = BN_CTX_get(ctx);
186         c = BN_CTX_get(ctx);
187         p = BN_CTX_get(ctx);
188         test = BN_CTX_get(ctx);
189
190         if (!BN_lshift(test,BN_value_one(),bits-1))
191                 goto err;
192
193         for (;;)
194                 {
195                 for (;;) /* find q */
196                         {
197                         int seed_is_random;
198
199                         /* step 1 */
200                         if(!BN_GENCB_call(cb, 0, m++))
201                                 goto err;
202
203                         if (!seed_len)
204                                 {
205                                 RAND_pseudo_bytes(seed, qsize);
206                                 seed_is_random = 1;
207                                 }
208                         else
209                                 {
210                                 seed_is_random = 0;
211                                 seed_len=0; /* use random seed if 'seed_in' turns out to be bad*/
212                                 }
213                         memcpy(buf , seed, qsize);
214                         memcpy(buf2, seed, qsize);
215                         /* precompute "SEED + 1" for step 7: */
216                         for (i = qsize-1; i >= 0; i--)
217                                 {
218                                 buf[i]++;
219                                 if (buf[i] != 0)
220                                         break;
221                                 }
222
223                         /* step 2 */
224                         if (!EVP_Digest(seed, qsize, md,   NULL, evpmd, NULL))
225                                 goto err;
226                         if (!EVP_Digest(buf,  qsize, buf2, NULL, evpmd, NULL))
227                                 goto err;
228                         for (i = 0; i < qsize; i++)
229                                 md[i]^=buf2[i];
230
231                         /* step 3 */
232                         md[0] |= 0x80;
233                         md[qsize-1] |= 0x01;
234                         if (!BN_bin2bn(md, qsize, q))
235                                 goto err;
236
237                         /* step 4 */
238                         r = BN_is_prime_fasttest_ex(q, DSS_prime_checks, ctx,
239                                         seed_is_random, cb);
240                         if (r > 0)
241                                 break;
242                         if (r != 0)
243                                 goto err;
244
245                         /* do a callback call */
246                         /* step 5 */
247                         }
248
249                 if(!BN_GENCB_call(cb, 2, 0)) goto err;
250                 if(!BN_GENCB_call(cb, 3, 0)) goto err;
251
252                 /* step 6 */
253                 counter=0;
254                 /* "offset = 2" */
255
256                 n=(bits-1)/160;
257
258                 for (;;)
259                         {
260                         if ((counter != 0) && !BN_GENCB_call(cb, 0, counter))
261                                 goto err;
262
263                         /* step 7 */
264                         BN_zero(W);
265                         /* now 'buf' contains "SEED + offset - 1" */
266                         for (k=0; k<=n; k++)
267                                 {
268                                 /* obtain "SEED + offset + k" by incrementing: */
269                                 for (i = qsize-1; i >= 0; i--)
270                                         {
271                                         buf[i]++;
272                                         if (buf[i] != 0)
273                                                 break;
274                                         }
275
276                                 if (!EVP_Digest(buf, qsize, md ,NULL, evpmd,
277                                                                         NULL))
278                                         goto err;
279
280                                 /* step 8 */
281                                 if (!BN_bin2bn(md, qsize, r0))
282                                         goto err;
283                                 if (!BN_lshift(r0,r0,(qsize << 3)*k)) goto err;
284                                 if (!BN_add(W,W,r0)) goto err;
285                                 }
286
287                         /* more of step 8 */
288                         if (!BN_mask_bits(W,bits-1)) goto err;
289                         if (!BN_copy(X,W)) goto err;
290                         if (!BN_add(X,X,test)) goto err;
291
292                         /* step 9 */
293                         if (!BN_lshift1(r0,q)) goto err;
294                         if (!BN_mod(c,X,r0,ctx)) goto err;
295                         if (!BN_sub(r0,c,BN_value_one())) goto err;
296                         if (!BN_sub(p,X,r0)) goto err;
297
298                         /* step 10 */
299                         if (BN_cmp(p,test) >= 0)
300                                 {
301                                 /* step 11 */
302                                 r = BN_is_prime_fasttest_ex(p, DSS_prime_checks,
303                                                 ctx, 1, cb);
304                                 if (r > 0)
305                                                 goto end; /* found it */
306                                 if (r != 0)
307                                         goto err;
308                                 }
309
310                         /* step 13 */
311                         counter++;
312                         /* "offset = offset + n + 1" */
313
314                         /* step 14 */
315                         if (counter >= 4096) break;
316                         }
317                 }
318 end:
319         if(!BN_GENCB_call(cb, 2, 1))
320                 goto err;
321
322         /* We now need to generate g */
323         /* Set r0=(p-1)/q */
324         if (!BN_sub(test,p,BN_value_one())) goto err;
325         if (!BN_div(r0,NULL,test,q,ctx)) goto err;
326
327         if (!BN_set_word(test,h)) goto err;
328         if (!BN_MONT_CTX_set(mont,p,ctx)) goto err;
329
330         for (;;)
331                 {
332                 /* g=test^r0%p */
333                 if (!BN_mod_exp_mont(g,test,r0,p,ctx,mont)) goto err;
334                 if (!BN_is_one(g)) break;
335                 if (!BN_add(test,test,BN_value_one())) goto err;
336                 h++;
337                 }
338
339         if(!BN_GENCB_call(cb, 3, 1))
340                 goto err;
341
342         ok=1;
343 err:
344         if (ok)
345                 {
346                 if(ret->p) BN_free(ret->p);
347                 if(ret->q) BN_free(ret->q);
348                 if(ret->g) BN_free(ret->g);
349                 ret->p=BN_dup(p);
350                 ret->q=BN_dup(q);
351                 ret->g=BN_dup(g);
352                 if (ret->p == NULL || ret->q == NULL || ret->g == NULL)
353                         {
354                         ok=0;
355                         goto err;
356                         }
357                 if (counter_ret != NULL) *counter_ret=counter;
358                 if (h_ret != NULL) *h_ret=h;
359                 if (seed_out)
360                         memcpy(seed_out, seed, qsize);
361                 }
362         if(ctx)
363                 {
364                 BN_CTX_end(ctx);
365                 BN_CTX_free(ctx);
366                 }
367         if (mont != NULL) BN_MONT_CTX_free(mont);
368         return ok;
369         }
370 #endif