Document DSA and SHA.
[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_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(BIGNUM *a, int checks, void (*callback)(int,int,void *),
158              BN_CTX *ctx_passed, void *cb_arg)
159         {
160         int i,j,c2=0,ret= -1;
161         BIGNUM *check;
162         BN_CTX *ctx=NULL,*ctx2=NULL;
163         BN_MONT_CTX *mont=NULL;
164
165         if (checks == BN_prime_checks)
166                 {
167                 int bits = BN_num_bits(a);
168                 checks = BN_prime_checks_size(bits);
169                 }
170
171         if (!BN_is_odd(a))
172                 return(0);
173         if (ctx_passed != NULL)
174                 ctx=ctx_passed;
175         else
176                 if ((ctx=BN_CTX_new()) == NULL) goto err;
177
178         if ((ctx2=BN_CTX_new()) == NULL) goto err;
179         if ((mont=BN_MONT_CTX_new()) == NULL) goto err;
180
181         check= &(ctx->bn[ctx->tos++]);
182
183         /* Setup the montgomery structure */
184         if (!BN_MONT_CTX_set(mont,a,ctx2)) goto err;
185
186         for (i=0; i<checks; i++)
187                 {
188                 if (!BN_pseudo_rand(check,BN_num_bits(a)-1,0,0)) goto err;
189                 j=witness(check,a,ctx,ctx2,mont);
190                 if (j == -1) goto err;
191                 if (j)
192                         {
193                         ret=0;
194                         goto err;
195                         }
196                 if (callback != NULL) callback(1,c2++,cb_arg);
197                 }
198         ret=1;
199 err:
200         ctx->tos--;
201         if ((ctx_passed == NULL) && (ctx != NULL))
202                 BN_CTX_free(ctx);
203         if (ctx2 != NULL)
204                 BN_CTX_free(ctx2);
205         if (mont != NULL) BN_MONT_CTX_free(mont);
206                 
207         return(ret);
208         }
209
210 static int witness(BIGNUM *a, BIGNUM *n, BN_CTX *ctx, BN_CTX *ctx2,
211              BN_MONT_CTX *mont)
212         {
213         int k,i,ret= -1,good;
214         BIGNUM *d,*dd,*tmp,*d1,*d2,*n1;
215         BIGNUM *mont_one,*mont_n1,*mont_a;
216
217         d1= &(ctx->bn[ctx->tos]);
218         d2= &(ctx->bn[ctx->tos+1]);
219         n1= &(ctx->bn[ctx->tos+2]);
220         ctx->tos+=3;
221
222         mont_one= &(ctx2->bn[ctx2->tos]);
223         mont_n1= &(ctx2->bn[ctx2->tos+1]);
224         mont_a= &(ctx2->bn[ctx2->tos+2]);
225         ctx2->tos+=3;
226
227         d=d1;
228         dd=d2;
229         if (!BN_one(d)) goto err;
230         if (!BN_sub(n1,n,d)) goto err; /* n1=n-1; */
231         k=BN_num_bits(n1);
232
233         if (!BN_to_montgomery(mont_one,BN_value_one(),mont,ctx2)) goto err;
234         if (!BN_to_montgomery(mont_n1,n1,mont,ctx2)) goto err;
235         if (!BN_to_montgomery(mont_a,a,mont,ctx2)) goto err;
236
237         BN_copy(d,mont_one);
238         for (i=k-1; i>=0; i--)
239                 {
240                 if (    (BN_cmp(d,mont_one) != 0) &&
241                         (BN_cmp(d,mont_n1) != 0))
242                         good=1;
243                 else
244                         good=0;
245
246                 BN_mod_mul_montgomery(dd,d,d,mont,ctx2);
247
248                 if (good && (BN_cmp(dd,mont_one) == 0))
249                         {
250                         ret=1;
251                         goto err;
252                         }
253                 if (BN_is_bit_set(n1,i))
254                         {
255                         BN_mod_mul_montgomery(d,dd,mont_a,mont,ctx2);
256                         }
257                 else
258                         {
259                         tmp=d;
260                         d=dd;
261                         dd=tmp;
262                         }
263                 }
264         if (BN_cmp(d,mont_one) == 0)
265                 i=0;
266         else    i=1;
267         ret=i;
268 err:
269         ctx->tos-=3;
270         ctx2->tos-=3;
271         return(ret);
272         }
273
274 static int probable_prime(BIGNUM *rnd, int bits)
275         {
276         int i;
277         MS_STATIC BN_ULONG mods[NUMPRIMES];
278         BN_ULONG delta,d;
279
280 again:
281         if (!BN_rand(rnd,bits,1,1)) return(0);
282         /* we now have a random number 'rand' to test. */
283         for (i=1; i<NUMPRIMES; i++)
284                 mods[i]=BN_mod_word(rnd,(BN_ULONG)primes[i]);
285         delta=0;
286         loop: for (i=1; i<NUMPRIMES; i++)
287                 {
288                 /* check that rnd is not a prime and also
289                  * that gcd(rnd-1,primes) == 1 (except for 2) */
290                 if (((mods[i]+delta)%primes[i]) <= 1)
291                         {
292                         d=delta;
293                         delta+=2;
294                         /* perhaps need to check for overflow of
295                          * delta (but delta can be upto 2^32)
296                          * 21-May-98 eay - added overflow check */
297                         if (delta < d) goto again;
298                         goto loop;
299                         }
300                 }
301         if (!BN_add_word(rnd,delta)) return(0);
302         return(1);
303         }
304
305 static int probable_prime_dh(BIGNUM *rnd, int bits, BIGNUM *add, BIGNUM *rem,
306              BN_CTX *ctx)
307         {
308         int i,ret=0;
309         BIGNUM *t1;
310
311         t1= &(ctx->bn[ctx->tos++]);
312
313         if (!BN_rand(rnd,bits,0,1)) goto err;
314
315         /* we need ((rnd-rem) % add) == 0 */
316
317         if (!BN_mod(t1,rnd,add,ctx)) goto err;
318         if (!BN_sub(rnd,rnd,t1)) goto err;
319         if (rem == NULL)
320                 { if (!BN_add_word(rnd,1)) goto err; }
321         else
322                 { if (!BN_add(rnd,rnd,rem)) goto err; }
323
324         /* we now have a random number 'rand' to test. */
325
326         loop: for (i=1; i<NUMPRIMES; i++)
327                 {
328                 /* check that rnd is a prime */
329                 if (BN_mod_word(rnd,(BN_ULONG)primes[i]) <= 1)
330                         {
331                         if (!BN_add(rnd,rnd,add)) goto err;
332                         goto loop;
333                         }
334                 }
335         ret=1;
336 err:
337         ctx->tos--;
338         return(ret);
339         }
340
341 static int probable_prime_dh_safe(BIGNUM *p, int bits, BIGNUM *padd,
342              BIGNUM *rem, BN_CTX *ctx)
343         {
344         int i,ret=0;
345         BIGNUM *t1,*qadd=NULL,*q=NULL;
346
347         bits--;
348         t1= &(ctx->bn[ctx->tos++]);
349         q= &(ctx->bn[ctx->tos++]);
350         qadd= &(ctx->bn[ctx->tos++]);
351
352         if (!BN_rshift1(qadd,padd)) goto err;
353                 
354         if (!BN_rand(q,bits,0,1)) goto err;
355
356         /* we need ((rnd-rem) % add) == 0 */
357         if (!BN_mod(t1,q,qadd,ctx)) goto err;
358         if (!BN_sub(q,q,t1)) goto err;
359         if (rem == NULL)
360                 { if (!BN_add_word(q,1)) goto err; }
361         else
362                 {
363                 if (!BN_rshift1(t1,rem)) goto err;
364                 if (!BN_add(q,q,t1)) goto err;
365                 }
366
367         /* we now have a random number 'rand' to test. */
368         if (!BN_lshift1(p,q)) goto err;
369         if (!BN_add_word(p,1)) goto err;
370
371         loop: for (i=1; i<NUMPRIMES; i++)
372                 {
373                 /* check that p and q are prime */
374                 /* check that for p and q
375                  * gcd(p-1,primes) == 1 (except for 2) */
376                 if (    (BN_mod_word(p,(BN_ULONG)primes[i]) == 0) ||
377                         (BN_mod_word(q,(BN_ULONG)primes[i]) == 0))
378                         {
379                         if (!BN_add(p,p,padd)) goto err;
380                         if (!BN_add(q,q,qadd)) goto err;
381                         goto loop;
382                         }
383                 }
384         ret=1;
385 err:
386         ctx->tos-=3;
387         return(ret);
388         }
389
390 #if 0
391
392 #define RECP_MUL_MOD
393
394 static int witness(BIGNUM *a, BIGNUM *n, BN_CTX *ctx,
395                    BN_CTX *unused, BN_MONT_CTX *unused2)
396         {
397         int k,i,ret= -1;
398         BIGNUM *d,*dd,*tmp;
399         BIGNUM *d1,*d2,*x,*n1;
400         BN_RECP_CTX recp;
401
402         d1= &(ctx->bn[ctx->tos]);
403         d2= &(ctx->bn[ctx->tos+1]);
404         x=  &(ctx->bn[ctx->tos+2]);
405         n1= &(ctx->bn[ctx->tos+3]);
406         ctx->tos+=4;
407
408         d=d1;
409         dd=d2;
410         if (!BN_one(d)) goto err;
411         if (!BN_sub(n1,n,d)) goto err; /* n1=n-1; */
412         k=BN_num_bits(n1);
413
414         /* i=BN_num_bits(n); */
415 #ifdef RECP_MUL_MOD
416         BN_RECP_CTX_init(&recp);
417         if (BN_RECP_CTX_set(&recp,n,ctx) <= 0) goto err;
418 #endif
419
420         for (i=k-1; i>=0; i--)
421                 {
422                 if (BN_copy(x,d) == NULL) goto err;
423 #ifndef RECP_MUL_MOD
424                 if (!BN_mod_mul(dd,d,d,n,ctx)) goto err;
425 #else
426                 if (!BN_mod_mul_reciprocal(dd,d,d,&recp,ctx)) goto err;
427 #endif
428                 if (    BN_is_one(dd) &&
429                         !BN_is_one(x) &&
430                         (BN_cmp(x,n1) != 0))
431                         {
432                         ret=1;
433                         goto err;
434                         }
435                 if (BN_is_bit_set(n1,i))
436                         {
437 #ifndef RECP_MUL_MOD
438                         if (!BN_mod_mul(d,dd,a,n,ctx)) goto err;
439 #else
440                         if (!BN_mod_mul_reciprocal(d,dd,a,&recp,ctx)) goto err; 
441 #endif
442                         }
443                 else
444                         {
445                         tmp=d;
446                         d=dd;
447                         dd=tmp;
448                         }
449                 }
450         if (BN_is_one(d))
451                 i=0;
452         else    i=1;
453         ret=i;
454 err:
455         ctx->tos-=4;
456 #ifdef RECP_MUL_MOD
457         BN_RECP_CTX_free(&recp);
458 #endif
459         return(ret);
460         }
461 #endif