Make output of "openssl dsaparam 1024" more interesting :-)
[openssl.git] / crypto / bn / bn_prime.c
1 /* crypto/bn/bn_prime.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 "bn_lcl.h"
63 #include <openssl/rand.h>
64
65 /* The quick sieve algorithm approach to weeding out primes is
66  * Philip Zimmermann's, as implemented in PGP.  I have had a read of
67  * his comments and implemented my own version.
68  */
69 #include "bn_prime.h"
70
71 static int witness(BIGNUM *a, BIGNUM *n, BN_CTX *ctx,BN_CTX *ctx2,
72         BN_MONT_CTX *mont);
73 static int probable_prime(BIGNUM *rnd, int bits);
74 static int probable_prime_dh(BIGNUM *rnd, int bits,
75         BIGNUM *add, BIGNUM *rem, BN_CTX *ctx);
76 static int probable_prime_dh_safe(BIGNUM *rnd, int bits,
77         BIGNUM *add, BIGNUM *rem, BN_CTX *ctx);
78
79 BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe, BIGNUM *add,
80              BIGNUM *rem, void (*callback)(int,int,void *), void *cb_arg)
81         {
82         BIGNUM *rnd=NULL;
83         BIGNUM t;
84         int found=0;
85         int i,j,c1=0;
86         BN_CTX *ctx;
87         int checks = BN_prime_checks_for_size(bits);
88
89         ctx=BN_CTX_new();
90         if (ctx == NULL) goto err;
91         if (ret == NULL)
92                 {
93                 if ((rnd=BN_new()) == NULL) goto err;
94                 }
95         else
96                 rnd=ret;
97         BN_init(&t);
98 loop: 
99         /* make a random number and set the top and bottom bits */
100         if (add == NULL)
101                 {
102                 if (!probable_prime(rnd,bits)) goto err;
103                 }
104         else
105                 {
106                 if (safe)
107                         {
108                         if (!probable_prime_dh_safe(rnd,bits,add,rem,ctx))
109                                  goto err;
110                         }
111                 else
112                         {
113                         if (!probable_prime_dh(rnd,bits,add,rem,ctx))
114                                 goto err;
115                         }
116                 }
117         /* if (BN_mod_word(rnd,(BN_ULONG)3) == 1) goto loop; */
118         if (callback != NULL) callback(0,c1++,cb_arg);
119
120         if (!safe)
121                 {
122                 i=BN_is_prime(rnd,checks,callback,ctx,cb_arg);
123                 if (i == -1) goto err;
124                 if (i == 0) goto loop;
125                 }
126         else
127                 {
128                 /* for "safe prime" generation,
129                  * check that (p-1)/2 is prime.
130                  * Since a prime is odd, We just
131                  * need to divide by 2 */
132                 if (!BN_rshift1(&t,rnd)) goto err;
133
134                 for (i=0; i<checks; i++)
135                         {
136                         j=BN_is_prime(rnd,1,callback,ctx,cb_arg);
137                         if (j == -1) goto err;
138                         if (j == 0) goto loop;
139
140                         j=BN_is_prime(&t,1,callback,ctx,cb_arg);
141                         if (j == -1) goto err;
142                         if (j == 0) goto loop;
143
144                         if (callback != NULL) callback(2,c1-1,cb_arg);
145                         /* We have a safe prime test pass */
146                         }
147                 }
148         /* we have a prime :-) */
149         found = 1;
150 err:
151         if (!found && (ret == NULL) && (rnd != NULL)) BN_free(rnd);
152         BN_free(&t);
153         if (ctx != NULL) BN_CTX_free(ctx);
154         return(found ? rnd : NULL);
155         }
156
157 int BN_is_prime_fasttest(BIGNUM *a, int checks,
158                 void (*callback)(int,int,void *),
159                 BN_CTX *ctx_passed, BN_CTX *ctx2_passed, void *cb_arg,
160                 int do_trial_division)
161         {
162         int i,j,ret= -1;
163         BIGNUM *check;
164         BN_CTX *ctx=NULL,*ctx2=NULL;
165         BN_MONT_CTX *mont=NULL;
166
167         if (checks == BN_prime_checks)
168                 {
169                 int bits = BN_num_bits(a);
170                 checks = BN_prime_checks_for_size(bits);
171                 }
172
173         if (!BN_is_odd(a))
174                 return(0);
175         if (do_trial_division)
176                 {
177                 for (i = 1; i < NUMPRIMES; i++)
178                         if (BN_mod_word(a, primes[i]) == 0) 
179                                 return 0;
180                 if (callback != NULL) callback(1,-1,cb_arg);
181                 }
182
183         if (ctx_passed != NULL)
184                 ctx=ctx_passed;
185         else
186                 if ((ctx=BN_CTX_new()) == NULL) goto err;
187         if (ctx2_passed != NULL)
188                 ctx2=ctx2_passed;
189         else
190                 if ((ctx2=BN_CTX_new()) == NULL) goto err;
191
192         if ((mont=BN_MONT_CTX_new()) == NULL) goto err;
193
194         check= &(ctx->bn[ctx->tos++]);
195
196         /* Setup the montgomery structure */
197         if (!BN_MONT_CTX_set(mont,a,ctx2)) goto err;
198
199         for (i=0; i<checks; i++)
200                 {
201                 if (!BN_pseudo_rand(check,BN_num_bits(a),0,0)) goto err;
202                 if (BN_cmp(check, a) >= 0)
203                         BN_sub(check, check, a);
204                 j=witness(check,a,ctx,ctx2,mont);
205                 if (j == -1) goto err;
206                 if (j)
207                         {
208                         ret=0;
209                         goto err;
210                         }
211                 if (callback != NULL) callback(1,i,cb_arg);
212                 }
213         ret=1;
214 err:
215         ctx->tos--;
216         if ((ctx_passed == NULL) && (ctx != NULL))
217                 BN_CTX_free(ctx);
218         if ((ctx2_passed == NULL) && (ctx2 != NULL))
219                 BN_CTX_free(ctx2);
220         if (mont != NULL) BN_MONT_CTX_free(mont);
221                 
222         return(ret);
223         }
224
225 int BN_is_prime(BIGNUM *a, int checks, void (*callback)(int,int,void *),
226         BN_CTX *ctx_passed, void *cb_arg)
227         {
228         return BN_is_prime_fasttest(a, checks, callback, ctx_passed, NULL, cb_arg, 0);
229         }
230
231 static int witness(BIGNUM *a, BIGNUM *n, BN_CTX *ctx, BN_CTX *ctx2,
232              BN_MONT_CTX *mont)
233         {
234         int k,i,ret= -1,good;
235         BIGNUM *d,*dd,*tmp,*d1,*d2,*n1;
236         BIGNUM *mont_one,*mont_n1,*mont_a;
237
238         d1= &(ctx->bn[ctx->tos]);
239         d2= &(ctx->bn[ctx->tos+1]);
240         n1= &(ctx->bn[ctx->tos+2]);
241         ctx->tos+=3;
242
243         mont_one= &(ctx2->bn[ctx2->tos]);
244         mont_n1= &(ctx2->bn[ctx2->tos+1]);
245         mont_a= &(ctx2->bn[ctx2->tos+2]);
246         ctx2->tos+=3;
247
248         d=d1;
249         dd=d2;
250         if (!BN_one(d)) goto err;
251         if (!BN_sub(n1,n,d)) goto err; /* n1=n-1; */
252         k=BN_num_bits(n1);
253
254         if (!BN_to_montgomery(mont_one,BN_value_one(),mont,ctx2)) goto err;
255         if (!BN_to_montgomery(mont_n1,n1,mont,ctx2)) goto err;
256         if (!BN_to_montgomery(mont_a,a,mont,ctx2)) goto err;
257
258         BN_copy(d,mont_one);
259         for (i=k-1; i>=0; i--)
260                 {
261                 if (    (BN_cmp(d,mont_one) != 0) &&
262                         (BN_cmp(d,mont_n1) != 0))
263                         good=1;
264                 else
265                         good=0;
266
267                 BN_mod_mul_montgomery(dd,d,d,mont,ctx2);
268
269                 if (good && (BN_cmp(dd,mont_one) == 0))
270                         {
271                         ret=1;
272                         goto err;
273                         }
274                 if (BN_is_bit_set(n1,i))
275                         {
276                         BN_mod_mul_montgomery(d,dd,mont_a,mont,ctx2);
277                         }
278                 else
279                         {
280                         tmp=d;
281                         d=dd;
282                         dd=tmp;
283                         }
284                 }
285         if (BN_cmp(d,mont_one) == 0)
286                 i=0;
287         else    i=1;
288         ret=i;
289 err:
290         ctx->tos-=3;
291         ctx2->tos-=3;
292         return(ret);
293         }
294
295 static int probable_prime(BIGNUM *rnd, int bits)
296         {
297         int i;
298         BN_ULONG mods[NUMPRIMES];
299         BN_ULONG delta,d;
300
301 again:
302         if (!BN_rand(rnd,bits,1,1)) return(0);
303         /* we now have a random number 'rand' to test. */
304         for (i=1; i<NUMPRIMES; i++)
305                 mods[i]=BN_mod_word(rnd,(BN_ULONG)primes[i]);
306         delta=0;
307         loop: for (i=1; i<NUMPRIMES; i++)
308                 {
309                 /* check that rnd is not a prime and also
310                  * that gcd(rnd-1,primes) == 1 (except for 2) */
311                 if (((mods[i]+delta)%primes[i]) <= 1)
312                         {
313                         d=delta;
314                         delta+=2;
315                         /* perhaps need to check for overflow of
316                          * delta (but delta can be upto 2^32)
317                          * 21-May-98 eay - added overflow check */
318                         if (delta < d) goto again;
319                         goto loop;
320                         }
321                 }
322         if (!BN_add_word(rnd,delta)) return(0);
323         return(1);
324         }
325
326 static int probable_prime_dh(BIGNUM *rnd, int bits, BIGNUM *add, BIGNUM *rem,
327              BN_CTX *ctx)
328         {
329         int i,ret=0;
330         BIGNUM *t1;
331
332         t1= &(ctx->bn[ctx->tos++]);
333
334         if (!BN_rand(rnd,bits,0,1)) goto err;
335
336         /* we need ((rnd-rem) % add) == 0 */
337
338         if (!BN_mod(t1,rnd,add,ctx)) goto err;
339         if (!BN_sub(rnd,rnd,t1)) goto err;
340         if (rem == NULL)
341                 { if (!BN_add_word(rnd,1)) goto err; }
342         else
343                 { if (!BN_add(rnd,rnd,rem)) goto err; }
344
345         /* we now have a random number 'rand' to test. */
346
347         loop: for (i=1; i<NUMPRIMES; i++)
348                 {
349                 /* check that rnd is a prime */
350                 if (BN_mod_word(rnd,(BN_ULONG)primes[i]) <= 1)
351                         {
352                         if (!BN_add(rnd,rnd,add)) goto err;
353                         goto loop;
354                         }
355                 }
356         ret=1;
357 err:
358         ctx->tos--;
359         return(ret);
360         }
361
362 static int probable_prime_dh_safe(BIGNUM *p, int bits, BIGNUM *padd,
363              BIGNUM *rem, BN_CTX *ctx)
364         {
365         int i,ret=0;
366         BIGNUM *t1,*qadd=NULL,*q=NULL;
367
368         bits--;
369         t1= &(ctx->bn[ctx->tos++]);
370         q= &(ctx->bn[ctx->tos++]);
371         qadd= &(ctx->bn[ctx->tos++]);
372
373         if (!BN_rshift1(qadd,padd)) goto err;
374                 
375         if (!BN_rand(q,bits,0,1)) goto err;
376
377         /* we need ((rnd-rem) % add) == 0 */
378         if (!BN_mod(t1,q,qadd,ctx)) goto err;
379         if (!BN_sub(q,q,t1)) goto err;
380         if (rem == NULL)
381                 { if (!BN_add_word(q,1)) goto err; }
382         else
383                 {
384                 if (!BN_rshift1(t1,rem)) goto err;
385                 if (!BN_add(q,q,t1)) goto err;
386                 }
387
388         /* we now have a random number 'rand' to test. */
389         if (!BN_lshift1(p,q)) goto err;
390         if (!BN_add_word(p,1)) goto err;
391
392         loop: for (i=1; i<NUMPRIMES; i++)
393                 {
394                 /* check that p and q are prime */
395                 /* check that for p and q
396                  * gcd(p-1,primes) == 1 (except for 2) */
397                 if (    (BN_mod_word(p,(BN_ULONG)primes[i]) == 0) ||
398                         (BN_mod_word(q,(BN_ULONG)primes[i]) == 0))
399                         {
400                         if (!BN_add(p,p,padd)) goto err;
401                         if (!BN_add(q,q,qadd)) goto err;
402                         goto loop;
403                         }
404                 }
405         ret=1;
406 err:
407         ctx->tos-=3;
408         return(ret);
409         }
410
411 #if 0
412
413 #define RECP_MUL_MOD
414
415 static int witness(BIGNUM *a, BIGNUM *n, BN_CTX *ctx,
416                    BN_CTX *unused, BN_MONT_CTX *unused2)
417         {
418         int k,i,ret= -1;
419         BIGNUM *d,*dd,*tmp;
420         BIGNUM *d1,*d2,*x,*n1;
421         BN_RECP_CTX recp;
422
423         d1= &(ctx->bn[ctx->tos]);
424         d2= &(ctx->bn[ctx->tos+1]);
425         x=  &(ctx->bn[ctx->tos+2]);
426         n1= &(ctx->bn[ctx->tos+3]);
427         ctx->tos+=4;
428
429         d=d1;
430         dd=d2;
431         if (!BN_one(d)) goto err;
432         if (!BN_sub(n1,n,d)) goto err; /* n1=n-1; */
433         k=BN_num_bits(n1);
434
435         /* i=BN_num_bits(n); */
436 #ifdef RECP_MUL_MOD
437         BN_RECP_CTX_init(&recp);
438         if (BN_RECP_CTX_set(&recp,n,ctx) <= 0) goto err;
439 #endif
440
441         for (i=k-1; i>=0; i--)
442                 {
443                 if (BN_copy(x,d) == NULL) goto err;
444 #ifndef RECP_MUL_MOD
445                 if (!BN_mod_mul(dd,d,d,n,ctx)) goto err;
446 #else
447                 if (!BN_mod_mul_reciprocal(dd,d,d,&recp,ctx)) goto err;
448 #endif
449                 if (    BN_is_one(dd) &&
450                         !BN_is_one(x) &&
451                         (BN_cmp(x,n1) != 0))
452                         {
453                         ret=1;
454                         goto err;
455                         }
456                 if (BN_is_bit_set(n1,i))
457                         {
458 #ifndef RECP_MUL_MOD
459                         if (!BN_mod_mul(d,dd,a,n,ctx)) goto err;
460 #else
461                         if (!BN_mod_mul_reciprocal(d,dd,a,&recp,ctx)) goto err; 
462 #endif
463                         }
464                 else
465                         {
466                         tmp=d;
467                         d=dd;
468                         dd=tmp;
469                         }
470                 }
471         if (BN_is_one(d))
472                 i=0;
473         else    i=1;
474         ret=i;
475 err:
476         ctx->tos-=4;
477 #ifdef RECP_MUL_MOD
478         BN_RECP_CTX_free(&recp);
479 #endif
480         return(ret);
481         }
482 #endif