Replace the BN_CTX implementation with my current work. I'm leaving the
[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  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111
112 #include <stdio.h>
113 #include <time.h>
114 #include "cryptlib.h"
115 #include "bn_lcl.h"
116 #include <openssl/rand.h>
117
118 /* NB: these functions have been "upgraded", the deprecated versions (which are
119  * compatibility wrappers using these functions) are in bn_depr.c.
120  * - Geoff
121  */
122
123 /* The quick sieve algorithm approach to weeding out primes is
124  * Philip Zimmermann's, as implemented in PGP.  I have had a read of
125  * his comments and implemented my own version.
126  */
127 #include "bn_prime.h"
128
129 static int witness(BIGNUM *w, const BIGNUM *a, const BIGNUM *a1,
130         const BIGNUM *a1_odd, int k, BN_CTX *ctx, BN_MONT_CTX *mont);
131 static int probable_prime(BIGNUM *rnd, int bits);
132 static int probable_prime_dh(BIGNUM *rnd, int bits,
133         const BIGNUM *add, const BIGNUM *rem, BN_CTX *ctx);
134 static int probable_prime_dh_safe(BIGNUM *rnd, int bits,
135         const BIGNUM *add, const BIGNUM *rem, BN_CTX *ctx);
136
137 int BN_GENCB_call(BN_GENCB *cb, int a, int b)
138         {
139         /* No callback means continue */
140         if(!cb) return 1;
141         switch(cb->ver)
142                 {
143         case 1:
144                 /* Deprecated-style callbacks */
145                 if(!cb->cb.cb_1)
146                         return 1;
147                 cb->cb.cb_1(a, b, cb->arg);
148                 return 1;
149         case 2:
150                 /* New-style callbacks */
151                 return cb->cb.cb_2(a, b, cb);
152         default:
153                 break;
154                 }
155         /* Unrecognised callback type */
156         return 0;
157         }
158
159 int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe,
160         const BIGNUM *add, const BIGNUM *rem, BN_GENCB *cb)
161         {
162         BIGNUM t;
163         int found=0;
164         int i,j,c1=0;
165         BN_CTX *ctx;
166         int checks = BN_prime_checks_for_size(bits);
167
168         BN_init(&t);
169         ctx=BN_CTX_new();
170         if (ctx == NULL) goto err;
171 loop: 
172         /* make a random number and set the top and bottom bits */
173         if (add == NULL)
174                 {
175                 if (!probable_prime(ret,bits)) goto err;
176                 }
177         else
178                 {
179                 if (safe)
180                         {
181                         if (!probable_prime_dh_safe(ret,bits,add,rem,ctx))
182                                  goto err;
183                         }
184                 else
185                         {
186                         if (!probable_prime_dh(ret,bits,add,rem,ctx))
187                                 goto err;
188                         }
189                 }
190         /* if (BN_mod_word(ret,(BN_ULONG)3) == 1) goto loop; */
191         if(!BN_GENCB_call(cb, 0, c1++))
192                 /* aborted */
193                 goto err;
194
195         if (!safe)
196                 {
197                 i=BN_is_prime_fasttest_ex(ret,checks,ctx,0,cb);
198                 if (i == -1) goto err;
199                 if (i == 0) goto loop;
200                 }
201         else
202                 {
203                 /* for "safe prime" generation,
204                  * check that (p-1)/2 is prime.
205                  * Since a prime is odd, We just
206                  * need to divide by 2 */
207                 if (!BN_rshift1(&t,ret)) goto err;
208
209                 for (i=0; i<checks; i++)
210                         {
211                         j=BN_is_prime_fasttest_ex(ret,1,ctx,0,cb);
212                         if (j == -1) goto err;
213                         if (j == 0) goto loop;
214
215                         j=BN_is_prime_fasttest_ex(&t,1,ctx,0,cb);
216                         if (j == -1) goto err;
217                         if (j == 0) goto loop;
218
219                         if(!BN_GENCB_call(cb, 2, c1-1))
220                                 goto err;
221                         /* We have a safe prime test pass */
222                         }
223                 }
224         /* we have a prime :-) */
225         found = 1;
226 err:
227         BN_free(&t);
228         if (ctx != NULL) BN_CTX_free(ctx);
229         bn_check_top(ret);
230         return found;
231         }
232
233 int BN_is_prime_ex(const BIGNUM *a, int checks, BN_CTX *ctx_passed, BN_GENCB *cb)
234         {
235         return BN_is_prime_fasttest_ex(a, checks, ctx_passed, 0, cb);
236         }
237
238 int BN_is_prime_fasttest_ex(const BIGNUM *a, int checks, BN_CTX *ctx_passed,
239                 int do_trial_division, BN_GENCB *cb)
240         {
241         int i, j, ret = -1;
242         int k;
243         BN_CTX *ctx = NULL;
244         BIGNUM *A1, *A1_odd, *check; /* taken from ctx */
245         BN_MONT_CTX *mont = NULL;
246         const BIGNUM *A = NULL;
247
248         if (BN_cmp(a, BN_value_one()) <= 0)
249                 return 0;
250         
251         if (checks == BN_prime_checks)
252                 checks = BN_prime_checks_for_size(BN_num_bits(a));
253
254         /* first look for small factors */
255         if (!BN_is_odd(a))
256                 return 0;
257         if (do_trial_division)
258                 {
259                 for (i = 1; i < NUMPRIMES; i++)
260                         if (BN_mod_word(a, primes[i]) == 0) 
261                                 return 0;
262                 if(!BN_GENCB_call(cb, 1, -1))
263                         goto err;
264                 }
265
266         if (ctx_passed != NULL)
267                 ctx = ctx_passed;
268         else
269                 if ((ctx=BN_CTX_new()) == NULL)
270                         goto err;
271         BN_CTX_start(ctx);
272
273         /* A := abs(a) */
274         if (a->neg)
275                 {
276                 BIGNUM *t;
277                 if ((t = BN_CTX_get(ctx)) == NULL) goto err;
278                 BN_copy(t, a);
279                 t->neg = 0;
280                 A = t;
281                 }
282         else
283                 A = a;
284         A1 = BN_CTX_get(ctx);
285         A1_odd = BN_CTX_get(ctx);
286         check = BN_CTX_get(ctx);
287         if (check == NULL) goto err;
288
289         /* compute A1 := A - 1 */
290         if (!BN_copy(A1, A))
291                 goto err;
292         if (!BN_sub_word(A1, 1))
293                 goto err;
294         if (BN_is_zero(A1))
295                 {
296                 ret = 0;
297                 goto err;
298                 }
299
300         /* write  A1  as  A1_odd * 2^k */
301         k = 1;
302         while (!BN_is_bit_set(A1, k))
303                 k++;
304         if (!BN_rshift(A1_odd, A1, k))
305                 goto err;
306
307         /* Montgomery setup for computations mod A */
308         mont = BN_MONT_CTX_new();
309         if (mont == NULL)
310                 goto err;
311         if (!BN_MONT_CTX_set(mont, A, ctx))
312                 goto err;
313         
314         for (i = 0; i < checks; i++)
315                 {
316                 if (!BN_pseudo_rand_range(check, A1))
317                         goto err;
318                 if (!BN_add_word(check, 1))
319                         goto err;
320                 /* now 1 <= check < A */
321
322                 j = witness(check, A, A1, A1_odd, k, ctx, mont);
323                 if (j == -1) goto err;
324                 if (j)
325                         {
326                         ret=0;
327                         goto err;
328                         }
329                 if(!BN_GENCB_call(cb, 1, i))
330                         goto err;
331                 }
332         ret=1;
333 err:
334         if (ctx != NULL)
335                 {
336                 BN_CTX_end(ctx);
337                 if (ctx_passed == NULL)
338                         BN_CTX_free(ctx);
339                 }
340         if (mont != NULL)
341                 BN_MONT_CTX_free(mont);
342
343         return(ret);
344         }
345
346 static int witness(BIGNUM *w, const BIGNUM *a, const BIGNUM *a1,
347         const BIGNUM *a1_odd, int k, BN_CTX *ctx, BN_MONT_CTX *mont)
348         {
349         if (!BN_mod_exp_mont(w, w, a1_odd, a, ctx, mont)) /* w := w^a1_odd mod a */
350                 return -1;
351         if (BN_is_one(w))
352                 return 0; /* probably prime */
353         if (BN_cmp(w, a1) == 0)
354                 return 0; /* w == -1 (mod a),  'a' is probably prime */
355         while (--k)
356                 {
357                 if (!BN_mod_mul(w, w, w, a, ctx)) /* w := w^2 mod a */
358                         return -1;
359                 if (BN_is_one(w))
360                         return 1; /* 'a' is composite, otherwise a previous 'w' would
361                                    * have been == -1 (mod 'a') */
362                 if (BN_cmp(w, a1) == 0)
363                         return 0; /* w == -1 (mod a), 'a' is probably prime */
364                 }
365         /* If we get here, 'w' is the (a-1)/2-th power of the original 'w',
366          * and it is neither -1 nor +1 -- so 'a' cannot be prime */
367         bn_check_top(w);
368         return 1;
369         }
370
371 static int probable_prime(BIGNUM *rnd, int bits)
372         {
373         int i;
374         BN_ULONG mods[NUMPRIMES];
375         BN_ULONG delta,d;
376
377 again:
378         if (!BN_rand(rnd,bits,1,1)) return(0);
379         /* we now have a random number 'rand' to test. */
380         for (i=1; i<NUMPRIMES; i++)
381                 mods[i]=BN_mod_word(rnd,(BN_ULONG)primes[i]);
382         delta=0;
383         loop: for (i=1; i<NUMPRIMES; i++)
384                 {
385                 /* check that rnd is not a prime and also
386                  * that gcd(rnd-1,primes) == 1 (except for 2) */
387                 if (((mods[i]+delta)%primes[i]) <= 1)
388                         {
389                         d=delta;
390                         delta+=2;
391                         /* perhaps need to check for overflow of
392                          * delta (but delta can be up to 2^32)
393                          * 21-May-98 eay - added overflow check */
394                         if (delta < d) goto again;
395                         goto loop;
396                         }
397                 }
398         if (!BN_add_word(rnd,delta)) return(0);
399         bn_check_top(rnd);
400         return(1);
401         }
402
403 static int probable_prime_dh(BIGNUM *rnd, int bits,
404         const BIGNUM *add, const BIGNUM *rem, BN_CTX *ctx)
405         {
406         int i,ret=0;
407         BIGNUM *t1;
408
409         BN_CTX_start(ctx);
410         if ((t1 = BN_CTX_get(ctx)) == NULL) goto err;
411
412         if (!BN_rand(rnd,bits,0,1)) goto err;
413
414         /* we need ((rnd-rem) % add) == 0 */
415
416         if (!BN_mod(t1,rnd,add,ctx)) goto err;
417         if (!BN_sub(rnd,rnd,t1)) goto err;
418         if (rem == NULL)
419                 { if (!BN_add_word(rnd,1)) goto err; }
420         else
421                 { if (!BN_add(rnd,rnd,rem)) goto err; }
422
423         /* we now have a random number 'rand' to test. */
424
425         loop: for (i=1; i<NUMPRIMES; i++)
426                 {
427                 /* check that rnd is a prime */
428                 if (BN_mod_word(rnd,(BN_ULONG)primes[i]) <= 1)
429                         {
430                         if (!BN_add(rnd,rnd,add)) goto err;
431                         goto loop;
432                         }
433                 }
434         ret=1;
435 err:
436         BN_CTX_end(ctx);
437         bn_check_top(rnd);
438         return(ret);
439         }
440
441 static int probable_prime_dh_safe(BIGNUM *p, int bits, const BIGNUM *padd,
442         const BIGNUM *rem, BN_CTX *ctx)
443         {
444         int i,ret=0;
445         BIGNUM *t1,*qadd,*q;
446
447         bits--;
448         BN_CTX_start(ctx);
449         t1 = BN_CTX_get(ctx);
450         q = BN_CTX_get(ctx);
451         qadd = BN_CTX_get(ctx);
452         if (qadd == NULL) goto err;
453
454         if (!BN_rshift1(qadd,padd)) goto err;
455                 
456         if (!BN_rand(q,bits,0,1)) goto err;
457
458         /* we need ((rnd-rem) % add) == 0 */
459         if (!BN_mod(t1,q,qadd,ctx)) goto err;
460         if (!BN_sub(q,q,t1)) goto err;
461         if (rem == NULL)
462                 { if (!BN_add_word(q,1)) goto err; }
463         else
464                 {
465                 if (!BN_rshift1(t1,rem)) goto err;
466                 if (!BN_add(q,q,t1)) goto err;
467                 }
468
469         /* we now have a random number 'rand' to test. */
470         if (!BN_lshift1(p,q)) goto err;
471         if (!BN_add_word(p,1)) goto err;
472
473         loop: for (i=1; i<NUMPRIMES; i++)
474                 {
475                 /* check that p and q are prime */
476                 /* check that for p and q
477                  * gcd(p-1,primes) == 1 (except for 2) */
478                 if (    (BN_mod_word(p,(BN_ULONG)primes[i]) == 0) ||
479                         (BN_mod_word(q,(BN_ULONG)primes[i]) == 0))
480                         {
481                         if (!BN_add(p,p,padd)) goto err;
482                         if (!BN_add(q,q,qadd)) goto err;
483                         goto loop;
484                         }
485                 }
486         ret=1;
487 err:
488         BN_CTX_end(ctx);
489         bn_check_top(p);
490         return(ret);
491         }