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