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