31ce1d49a6b5847c5832ffd4b0acaa02a43ef921
[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 #define OPENSSL_FIPSAPI
77
78 #include <stdio.h>
79 #include "cryptlib.h"
80 #include <openssl/evp.h>
81 #include <openssl/bn.h>
82 #include <openssl/rand.h>
83 #include <openssl/sha.h>
84 #ifdef OPENSSL_FIPS
85 #include <openssl/fips.h>
86 #endif
87
88 #include "dsa_locl.h"
89
90 int DSA_generate_parameters_ex(DSA *ret, int bits,
91                 const unsigned char *seed_in, int seed_len,
92                 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb)
93         {
94         if(ret->meth->dsa_paramgen)
95                 return ret->meth->dsa_paramgen(ret, bits, seed_in, seed_len,
96                                 counter_ret, h_ret, cb);
97         else
98                 {
99                 const EVP_MD *evpmd;
100                 size_t qbits = bits >= 2048 ? 256 : 160;
101
102                 if (bits >= 2048)
103                         {
104                         qbits = 256;
105                         evpmd = EVP_sha256();
106                         }
107                 else
108                         {
109                         qbits = 160;
110                         evpmd = EVP_sha1();
111                         }
112
113                 return dsa_builtin_paramgen(ret, bits, qbits, evpmd,
114                         seed_in, seed_len, NULL, counter_ret, h_ret, cb);
115                 }
116         }
117
118 int dsa_builtin_paramgen(DSA *ret, size_t bits, size_t qbits,
119         const EVP_MD *evpmd, const unsigned char *seed_in, size_t seed_len,
120         unsigned char *seed_out,
121         int *counter_ret, unsigned long *h_ret, BN_GENCB *cb)
122         {
123         int ok=0;
124         unsigned char seed[SHA256_DIGEST_LENGTH];
125         unsigned char md[SHA256_DIGEST_LENGTH];
126         unsigned char buf[SHA256_DIGEST_LENGTH],buf2[SHA256_DIGEST_LENGTH];
127         BIGNUM *r0,*W,*X,*c,*test;
128         BIGNUM *g=NULL,*q=NULL,*p=NULL;
129         BN_MONT_CTX *mont=NULL;
130         int i, k, n=0, m=0, qsize = qbits >> 3;
131         int counter=0;
132         int r=0;
133         BN_CTX *ctx=NULL;
134         unsigned int h=2;
135
136 #ifdef OPENSSL_FIPS
137         if(FIPS_selftest_failed())
138             {
139             FIPSerr(FIPS_F_DSA_BUILTIN_PARAMGEN, FIPS_R_FIPS_SELFTEST_FAILED);
140             goto err;
141             }
142
143         if (FIPS_mode() && (bits < OPENSSL_DSA_FIPS_MIN_MODULUS_BITS))
144                 {
145                 DSAerr(DSA_F_DSA_BUILTIN_PARAMGEN, DSA_R_KEY_SIZE_TOO_SMALL);
146                 goto err;
147                 }
148 #endif
149
150         if (qsize != SHA_DIGEST_LENGTH && qsize != SHA224_DIGEST_LENGTH &&
151             qsize != SHA256_DIGEST_LENGTH)
152                 /* invalid q size */
153                 return 0;
154
155         if (evpmd == NULL)
156                 /* use SHA1 as default */
157                 evpmd = EVP_sha1();
158
159         if (bits < 512)
160                 bits = 512;
161
162         bits = (bits+63)/64*64;
163
164         /* NB: seed_len == 0 is special case: copy generated seed to
165          * seed_in if it is not NULL.
166          */
167         if (seed_len && (seed_len < (size_t)qsize))
168                 seed_in = NULL;         /* seed buffer too small -- ignore */
169         if (seed_len > (size_t)qsize) 
170                 seed_len = qsize;       /* App. 2.2 of FIPS PUB 186 allows larger SEED,
171                                          * but our internal buffers are restricted to 160 bits*/
172         if (seed_in != NULL)
173                 memcpy(seed, seed_in, seed_len);
174
175         if ((ctx=BN_CTX_new()) == NULL)
176                 goto err;
177
178         if ((mont=BN_MONT_CTX_new()) == NULL)
179                 goto err;
180
181         BN_CTX_start(ctx);
182         r0 = BN_CTX_get(ctx);
183         g = BN_CTX_get(ctx);
184         W = BN_CTX_get(ctx);
185         q = BN_CTX_get(ctx);
186         X = BN_CTX_get(ctx);
187         c = BN_CTX_get(ctx);
188         p = BN_CTX_get(ctx);
189         test = BN_CTX_get(ctx);
190
191         if (!BN_lshift(test,BN_value_one(),bits-1))
192                 goto err;
193
194         for (;;)
195                 {
196                 for (;;) /* find q */
197                         {
198                         int seed_is_random;
199
200                         /* step 1 */
201                         if(!BN_GENCB_call(cb, 0, m++))
202                                 goto err;
203
204                         if (!seed_len)
205                                 {
206                                 RAND_pseudo_bytes(seed, qsize);
207                                 seed_is_random = 1;
208                                 }
209                         else
210                                 {
211                                 seed_is_random = 0;
212                                 seed_len=0; /* use random seed if 'seed_in' turns out to be bad*/
213                                 }
214                         memcpy(buf , seed, qsize);
215                         memcpy(buf2, seed, qsize);
216                         /* precompute "SEED + 1" for step 7: */
217                         for (i = qsize-1; i >= 0; i--)
218                                 {
219                                 buf[i]++;
220                                 if (buf[i] != 0)
221                                         break;
222                                 }
223
224                         /* step 2 */
225                         if (!EVP_Digest(seed, qsize, md,   NULL, evpmd, NULL))
226                                 goto err;
227                         if (!EVP_Digest(buf,  qsize, buf2, NULL, evpmd, NULL))
228                                 goto err;
229                         for (i = 0; i < qsize; i++)
230                                 md[i]^=buf2[i];
231
232                         /* step 3 */
233                         md[0] |= 0x80;
234                         md[qsize-1] |= 0x01;
235                         if (!BN_bin2bn(md, qsize, q))
236                                 goto err;
237
238                         /* step 4 */
239                         r = BN_is_prime_fasttest_ex(q, DSS_prime_checks, ctx,
240                                         seed_is_random, cb);
241                         if (r > 0)
242                                 break;
243                         if (r != 0)
244                                 goto err;
245
246                         /* do a callback call */
247                         /* step 5 */
248                         }
249
250                 if(!BN_GENCB_call(cb, 2, 0)) goto err;
251                 if(!BN_GENCB_call(cb, 3, 0)) goto err;
252
253                 /* step 6 */
254                 counter=0;
255                 /* "offset = 2" */
256
257                 n=(bits-1)/160;
258
259                 for (;;)
260                         {
261                         if ((counter != 0) && !BN_GENCB_call(cb, 0, counter))
262                                 goto err;
263
264                         /* step 7 */
265                         BN_zero(W);
266                         /* now 'buf' contains "SEED + offset - 1" */
267                         for (k=0; k<=n; k++)
268                                 {
269                                 /* obtain "SEED + offset + k" by incrementing: */
270                                 for (i = qsize-1; i >= 0; i--)
271                                         {
272                                         buf[i]++;
273                                         if (buf[i] != 0)
274                                                 break;
275                                         }
276
277                                 if (!EVP_Digest(buf, qsize, md ,NULL, evpmd,
278                                                                         NULL))
279                                         goto err;
280
281                                 /* step 8 */
282                                 if (!BN_bin2bn(md, qsize, r0))
283                                         goto err;
284                                 if (!BN_lshift(r0,r0,(qsize << 3)*k)) goto err;
285                                 if (!BN_add(W,W,r0)) goto err;
286                                 }
287
288                         /* more of step 8 */
289                         if (!BN_mask_bits(W,bits-1)) goto err;
290                         if (!BN_copy(X,W)) goto err;
291                         if (!BN_add(X,X,test)) goto err;
292
293                         /* step 9 */
294                         if (!BN_lshift1(r0,q)) goto err;
295                         if (!BN_mod(c,X,r0,ctx)) goto err;
296                         if (!BN_sub(r0,c,BN_value_one())) goto err;
297                         if (!BN_sub(p,X,r0)) goto err;
298
299                         /* step 10 */
300                         if (BN_cmp(p,test) >= 0)
301                                 {
302                                 /* step 11 */
303                                 r = BN_is_prime_fasttest_ex(p, DSS_prime_checks,
304                                                 ctx, 1, cb);
305                                 if (r > 0)
306                                                 goto end; /* found it */
307                                 if (r != 0)
308                                         goto err;
309                                 }
310
311                         /* step 13 */
312                         counter++;
313                         /* "offset = offset + n + 1" */
314
315                         /* step 14 */
316                         if (counter >= 4096) break;
317                         }
318                 }
319 end:
320         if(!BN_GENCB_call(cb, 2, 1))
321                 goto err;
322
323         /* We now need to generate g */
324         /* Set r0=(p-1)/q */
325         if (!BN_sub(test,p,BN_value_one())) goto err;
326         if (!BN_div(r0,NULL,test,q,ctx)) goto err;
327
328         if (!BN_set_word(test,h)) goto err;
329         if (!BN_MONT_CTX_set(mont,p,ctx)) goto err;
330
331         for (;;)
332                 {
333                 /* g=test^r0%p */
334                 if (!BN_mod_exp_mont(g,test,r0,p,ctx,mont)) goto err;
335                 if (!BN_is_one(g)) break;
336                 if (!BN_add(test,test,BN_value_one())) goto err;
337                 h++;
338                 }
339
340         if(!BN_GENCB_call(cb, 3, 1))
341                 goto err;
342
343         ok=1;
344 err:
345         if (ok)
346                 {
347                 if(ret->p) BN_free(ret->p);
348                 if(ret->q) BN_free(ret->q);
349                 if(ret->g) BN_free(ret->g);
350                 ret->p=BN_dup(p);
351                 ret->q=BN_dup(q);
352                 ret->g=BN_dup(g);
353                 if (ret->p == NULL || ret->q == NULL || ret->g == NULL)
354                         {
355                         ok=0;
356                         goto err;
357                         }
358                 if (counter_ret != NULL) *counter_ret=counter;
359                 if (h_ret != NULL) *h_ret=h;
360                 if (seed_out)
361                         memcpy(seed_out, seed, qsize);
362                 }
363         if(ctx)
364                 {
365                 BN_CTX_end(ctx);
366                 BN_CTX_free(ctx);
367                 }
368         if (mont != NULL) BN_MONT_CTX_free(mont);
369         return ok;
370         }
371
372 /* Security strength of parameter values for (L,N): see FIPS186-3 4.2
373  * and SP800-131A
374  */
375
376
377 static int dsa2_security_strength(size_t L, size_t N)
378         {
379         if (L == 1024 && N == 160)
380                 return 80;
381         if (L == 2048 && N == 224)
382                 return 112;
383         if (L == 2048 && N == 256)
384                 return 112;
385         if (L == 3072 && N == 256)
386                 return 112;
387         return 0;
388         }
389
390 /* This is a parameter generation algorithm for the DSA2 algorithm as
391  * described in FIPS 186-3.
392  */
393
394 int dsa_builtin_paramgen2(DSA *ret, size_t L, size_t N,
395         const EVP_MD *evpmd, const unsigned char *seed_in, size_t seed_len,
396         unsigned char *seed_out,
397         int *counter_ret, unsigned long *h_ret, BN_GENCB *cb)
398         {
399         int ok=-1;
400         unsigned char *seed = NULL;
401         unsigned char md[EVP_MAX_MD_SIZE];
402         int mdsize;
403         BIGNUM *r0,*W,*X,*c,*test;
404         BIGNUM *g=NULL,*q=NULL,*p=NULL;
405         BN_MONT_CTX *mont=NULL;
406         int i, k, n=0, m=0, qsize = N >> 3;
407         int counter=0;
408         int r=0;
409         BN_CTX *ctx=NULL;
410         unsigned int h=2;
411
412 #ifdef OPENSSL_FIPS
413         if(FIPS_selftest_failed())
414             {
415             FIPSerr(FIPS_F_DSA_BUILTIN_PARAMGEN2,
416                     FIPS_R_FIPS_SELFTEST_FAILED);
417             goto err;
418             }
419 #endif
420         if (!dsa2_security_strength(L, N))
421                 {
422                 DSAerr(DSA_F_DSA_BUILTIN_PARAMGEN2, DSA_R_INVALID_PARAMETERS);
423                 ok = 0;
424                 goto err;
425                 }
426
427         if (evpmd == NULL)
428                 {
429                 if (N == 160)
430                         evpmd = EVP_sha1();
431                 else if (N == 224)
432                         evpmd = EVP_sha224();
433                 else
434                         evpmd = EVP_sha256();
435                 }
436
437         mdsize = M_EVP_MD_size(evpmd);
438
439         if (seed_len == 0)
440                 seed_len = mdsize;
441
442         seed = OPENSSL_malloc(seed_len);
443
444         if (!seed)
445                 goto err;
446
447         if (seed_in)
448                 memcpy(seed, seed_in, seed_len);
449
450         if ((ctx=BN_CTX_new()) == NULL)
451                 goto err;
452
453         if ((mont=BN_MONT_CTX_new()) == NULL)
454                 goto err;
455
456         BN_CTX_start(ctx);
457         r0 = BN_CTX_get(ctx);
458         g = BN_CTX_get(ctx);
459         W = BN_CTX_get(ctx);
460         q = BN_CTX_get(ctx);
461         X = BN_CTX_get(ctx);
462         c = BN_CTX_get(ctx);
463         p = BN_CTX_get(ctx);
464         test = BN_CTX_get(ctx);
465
466         if (!BN_lshift(test,BN_value_one(),L-1))
467                 goto err;
468         for (;;)
469                 {
470                 for (;;) /* find q */
471                         {
472                         unsigned char *pmd;
473                         /* step 1 */
474                         if(!BN_GENCB_call(cb, 0, m++))
475                                 goto err;
476
477                         if (!seed_in)
478                                 RAND_pseudo_bytes(seed, seed_len);
479                         /* step 2 */
480                         if (!EVP_Digest(seed, seed_len, md, NULL, evpmd, NULL))
481                                 goto err;
482                         /* Take least significant bits of md */
483                         if (mdsize > qsize)
484                                 pmd = md + mdsize - qsize;
485                         else
486                                 pmd = md;
487
488                         if (mdsize < qsize)
489                                 memset(md + mdsize, 0, qsize - mdsize);
490
491                         /* step 3 */
492                         pmd[0] |= 0x80;
493                         pmd[qsize-1] |= 0x01;
494                         if (!BN_bin2bn(pmd, qsize, q))
495                                 goto err;
496
497                         /* step 4 */
498                         r = BN_is_prime_fasttest_ex(q, DSS_prime_checks, ctx,
499                                         seed_in ? 1 : 0, cb);
500                         if (r > 0)
501                                 break;
502                         if (r != 0)
503                                 goto err;
504                         /* Provided seed didn't produce a prime: error */
505                         if (seed_in)
506                                 {
507                                 ok = 0;
508                                 DSAerr(DSA_F_DSA_BUILTIN_PARAMGEN2, DSA_R_Q_NOT_PRIME);
509                                 goto err;
510                                 }
511
512                         /* do a callback call */
513                         /* step 5 */
514                         }
515                 /* Copy seed to seed_out before we mess with it */
516                 if (seed_out)
517                         memcpy(seed_out, seed, seed_len);
518
519                 if(!BN_GENCB_call(cb, 2, 0)) goto err;
520                 if(!BN_GENCB_call(cb, 3, 0)) goto err;
521
522                 /* step 6 */
523                 counter=0;
524                 /* "offset = 1" */
525
526                 n=(L-1)/(mdsize << 3);
527
528                 for (;;)
529                         {
530                         if ((counter != 0) && !BN_GENCB_call(cb, 0, counter))
531                                 goto err;
532
533                         /* step 7 */
534                         BN_zero(W);
535                         /* now 'buf' contains "SEED + offset - 1" */
536                         for (k=0; k<=n; k++)
537                                 {
538                                 /* obtain "SEED + offset + k" by incrementing: */
539                                 for (i = seed_len-1; i >= 0; i--)
540                                         {
541                                         seed[i]++;
542                                         if (seed[i] != 0)
543                                                 break;
544                                         }
545
546                                 if (!EVP_Digest(seed, seed_len, md ,NULL, evpmd,
547                                                                         NULL))
548                                         goto err;
549
550                                 /* step 8 */
551                                 if (!BN_bin2bn(md, mdsize, r0))
552                                         goto err;
553                                 if (!BN_lshift(r0,r0,(mdsize << 3)*k)) goto err;
554                                 if (!BN_add(W,W,r0)) goto err;
555                                 }
556
557                         /* more of step 8 */
558                         if (!BN_mask_bits(W,L-1)) goto err;
559                         if (!BN_copy(X,W)) goto err;
560                         if (!BN_add(X,X,test)) goto err;
561
562                         /* step 9 */
563                         if (!BN_lshift1(r0,q)) goto err;
564                         if (!BN_mod(c,X,r0,ctx)) goto err;
565                         if (!BN_sub(r0,c,BN_value_one())) goto err;
566                         if (!BN_sub(p,X,r0)) goto err;
567
568                         /* step 10 */
569                         if (BN_cmp(p,test) >= 0)
570                                 {
571                                 /* step 11 */
572                                 r = BN_is_prime_fasttest_ex(p, DSS_prime_checks,
573                                                 ctx, 1, cb);
574                                 if (r > 0)
575                                                 goto end; /* found it */
576                                 if (r != 0)
577                                         goto err;
578                                 }
579
580                         /* step 13 */
581                         counter++;
582                         /* "offset = offset + n + 1" */
583
584                         /* step 14 */
585                         if (counter >= 4096) break;
586                         }
587                 }
588 end:
589         if(!BN_GENCB_call(cb, 2, 1))
590                 goto err;
591
592         /* We now need to generate g */
593         /* Set r0=(p-1)/q */
594         if (!BN_sub(test,p,BN_value_one())) goto err;
595         if (!BN_div(r0,NULL,test,q,ctx)) goto err;
596
597         if (!BN_set_word(test,h)) goto err;
598         if (!BN_MONT_CTX_set(mont,p,ctx)) goto err;
599
600         for (;;)
601                 {
602                 /* g=test^r0%p */
603                 if (!BN_mod_exp_mont(g,test,r0,p,ctx,mont)) goto err;
604                 if (!BN_is_one(g)) break;
605                 if (!BN_add(test,test,BN_value_one())) goto err;
606                 h++;
607                 }
608
609         if(!BN_GENCB_call(cb, 3, 1))
610                 goto err;
611
612         ok=1;
613 err:
614         if (ok == 1)
615                 {
616                 if(ret->p) BN_free(ret->p);
617                 if(ret->q) BN_free(ret->q);
618                 if(ret->g) BN_free(ret->g);
619                 ret->p=BN_dup(p);
620                 ret->q=BN_dup(q);
621                 ret->g=BN_dup(g);
622                 if (ret->p == NULL || ret->q == NULL || ret->g == NULL)
623                         {
624                         ok=-1;
625                         goto err;
626                         }
627                 if (counter_ret != NULL) *counter_ret=counter;
628                 if (h_ret != NULL) *h_ret=h;
629                 }
630         if (seed)
631                 OPENSSL_free(seed);
632         if(ctx)
633                 {
634                 BN_CTX_end(ctx);
635                 BN_CTX_free(ctx);
636                 }
637         if (mont != NULL) BN_MONT_CTX_free(mont);
638         return ok;
639         }
640 #endif