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         if (bits < 2)
 169                 {
 170                 /* There are no prime numbers this small. */
 171                 BNerr(BN_F_BN_GENERATE_PRIME_EX, BN_R_BITS_TOO_SMALL);
 172                 return 0;
 173                 }
 174         else if (bits == 2 && safe)
 175                 {
 176                 /* The smallest safe prime (7) is three bits. */
 177                 BNerr(BN_F_BN_GENERATE_PRIME_EX, BN_R_BITS_TOO_SMALL);
 178                 return 0;
 179                 }
 180
 181         ctx=BN_CTX_new();
 182         if (ctx == NULL) goto err;
 183         BN_CTX_start(ctx);
 184         t = BN_CTX_get(ctx);
 185         if(!t) goto err;
 186 loop:
 187         /* make a random number and set the top and bottom bits */
 188         if (add == NULL)
 189                 {
 190                 if (!probable_prime(ret,bits)) goto err;
 191                 }
 192         else
 193                 {
 194                 if (safe)
 195                         {
 196                         if (!probable_prime_dh_safe(ret,bits,add,rem,ctx))
 197                                  goto err;
 198                         }
 199                 else
 200                         {
 201                         if (!probable_prime_dh(ret,bits,add,rem,ctx))
 202                                 goto err;
 203                         }
 204                 }
 205         /* if (BN_mod_word(ret,(BN_ULONG)3) == 1) goto loop; */
 206         if(!BN_GENCB_call(cb, 0, c1++))
 207                 /* aborted */
 208                 goto err;
 209
 210         if (!safe)
 211                 {
 212                 i=BN_is_prime_fasttest_ex(ret,checks,ctx,0,cb);
 213                 if (i == -1) goto err;
 214                 if (i == 0) goto loop;
 215                 }
 216         else
 217                 {
 218                 /* for "safe prime" generation,
 219                  * check that (p-1)/2 is prime.
 220                  * Since a prime is odd, We just
 221                  * need to divide by 2 */
 222                 if (!BN_rshift1(t,ret)) goto err;
 223
 224                 for (i=0; i<checks; i++)
 225                         {
 226                         j=BN_is_prime_fasttest_ex(ret,1,ctx,0,cb);
 227                         if (j == -1) goto err;
 228                         if (j == 0) goto loop;
 229
 230                         j=BN_is_prime_fasttest_ex(t,1,ctx,0,cb);
 231                         if (j == -1) goto err;
 232                         if (j == 0) goto loop;
 233
 234                         if(!BN_GENCB_call(cb, 2, c1-1))
 235                                 goto err;
 236                         /* We have a safe prime test pass */
 237                         }
 238                 }
 239         /* we have a prime :-) */
 240         found = 1;
 241 err:
 242         if (ctx != NULL)
 243                 {
 244                 BN_CTX_end(ctx);
 245                 BN_CTX_free(ctx);
 246                 }
 247         bn_check_top(ret);
 248         return found;
 249         }
 250
 251 int BN_is_prime_ex(const BIGNUM *a, int checks, BN_CTX *ctx_passed, BN_GENCB *cb)
 252         {
 253         return BN_is_prime_fasttest_ex(a, checks, ctx_passed, 0, cb);
 254         }
 255
 256 int BN_is_prime_fasttest_ex(const BIGNUM *a, int checks, BN_CTX *ctx_passed,
 257                 int do_trial_division, BN_GENCB *cb)
 258         {
 259         int i, j, ret = -1;
 260         int k;
 261         BN_CTX *ctx = NULL;
 262         BIGNUM *A1, *A1_odd, *check; /* taken from ctx */
 263         BN_MONT_CTX *mont = NULL;
 264         const BIGNUM *A = NULL;
 265
 266         if (BN_cmp(a, BN_value_one()) <= 0)
 267                 return 0;
 268
 269         if (checks == BN_prime_checks)
 270                 checks = BN_prime_checks_for_size(BN_num_bits(a));
 271
 272         /* first look for small factors */
 273         if (!BN_is_odd(a))
 274                 /* a is even => a is prime if and only if a == 2 */
 275                 return BN_is_word(a, 2);
 276         if (do_trial_division)
 277                 {
 278                 for (i = 1; i < NUMPRIMES; i++)
 279                         if (BN_mod_word(a, primes[i]) == 0)
 280                                 return 0;
 281                 if(!BN_GENCB_call(cb, 1, -1))
 282                         goto err;
 283                 }
 284
 285         if (ctx_passed != NULL)
 286                 ctx = ctx_passed;
 287         else
 288                 if ((ctx=BN_CTX_new()) == NULL)
 289                         goto err;
 290         BN_CTX_start(ctx);
 291
 292         /* A := abs(a) */
 293         if (a->neg)
 294                 {
 295                 BIGNUM *t;
 296                 if ((t = BN_CTX_get(ctx)) == NULL) goto err;
 297                 BN_copy(t, a);
 298                 t->neg = 0;
 299                 A = t;
 300                 }
 301         else
 302                 A = a;
 303         A1 = BN_CTX_get(ctx);
 304         A1_odd = BN_CTX_get(ctx);
 305         check = BN_CTX_get(ctx);
 306         if (check == NULL) goto err;
 307
 308         /* compute A1 := A - 1 */
 309         if (!BN_copy(A1, A))
 310                 goto err;
 311         if (!BN_sub_word(A1, 1))
 312                 goto err;
 313         if (BN_is_zero(A1))
 314                 {
 315                 ret = 0;
 316                 goto err;
 317                 }
 318
 319         /* write  A1  as  A1_odd * 2^k */
 320         k = 1;
 321         while (!BN_is_bit_set(A1, k))
 322                 k++;
 323         if (!BN_rshift(A1_odd, A1, k))
 324                 goto err;
 325
 326         /* Montgomery setup for computations mod A */
 327         mont = BN_MONT_CTX_new();
 328         if (mont == NULL)
 329                 goto err;
 330         if (!BN_MONT_CTX_set(mont, A, ctx))
 331                 goto err;
 332
 333         for (i = 0; i < checks; i++)
 334                 {
 335                 if (!BN_pseudo_rand_range(check, A1))
 336                         goto err;
 337                 if (!BN_add_word(check, 1))
 338                         goto err;
 339                 /* now 1 <= check < A */
 340
 341                 j = witness(check, A, A1, A1_odd, k, ctx, mont);
 342                 if (j == -1) goto err;
 343                 if (j)
 344                         {
 345                         ret=0;
 346                         goto err;
 347                         }
 348                 if(!BN_GENCB_call(cb, 1, i))
 349                         goto err;
 350                 }
 351         ret=1;
 352 err:
 353         if (ctx != NULL)
 354                 {
 355                 BN_CTX_end(ctx);
 356                 if (ctx_passed == NULL)
 357                         BN_CTX_free(ctx);
 358                 }
 359         if (mont != NULL)
 360                 BN_MONT_CTX_free(mont);
 361
 362         return(ret);
 363         }
 364
 365 static int witness(BIGNUM *w, const BIGNUM *a, const BIGNUM *a1,
 366         const BIGNUM *a1_odd, int k, BN_CTX *ctx, BN_MONT_CTX *mont)
 367         {
 368         if (!BN_mod_exp_mont(w, w, a1_odd, a, ctx, mont)) /* w := w^a1_odd mod a */
 369                 return -1;
 370         if (BN_is_one(w))
 371                 return 0; /* probably prime */
 372         if (BN_cmp(w, a1) == 0)
 373                 return 0; /* w == -1 (mod a),  'a' is probably prime */
 374         while (--k)
 375                 {
 376                 if (!BN_mod_mul(w, w, w, a, ctx)) /* w := w^2 mod a */
 377                         return -1;
 378                 if (BN_is_one(w))
 379                         return 1; /* 'a' is composite, otherwise a previous 'w' would
 380                                    * have been == -1 (mod 'a') */
 381                 if (BN_cmp(w, a1) == 0)
 382                         return 0; /* w == -1 (mod a), 'a' is probably prime */
 383                 }
 384         /* If we get here, 'w' is the (a-1)/2-th power of the original 'w',
 385          * and it is neither -1 nor +1 -- so 'a' cannot be prime */
 386         bn_check_top(w);
 387         return 1;
 388         }
 389
 390 static int probable_prime(BIGNUM *rnd, int bits)
 391         {
 392         int i;
 393         prime_t mods[NUMPRIMES];
 394         BN_ULONG delta;
 395         BN_ULONG maxdelta = BN_MASK2 - primes[NUMPRIMES-1];
 396         char is_single_word = bits <= BN_BITS2;
 397
 398 again:
 399         if (!BN_rand(rnd,bits,1,1)) return(0);
 400         /* we now have a random number 'rnd' to test. */
 401         for (i=1; i<NUMPRIMES; i++)
 402                 mods[i]=(prime_t)BN_mod_word(rnd,(BN_ULONG)primes[i]);
 403         /* If bits is so small that it fits into a single word then we
 404          * additionally don't want to exceed that many bits. */
 405         if (is_single_word)
 406                 {
 407                 BN_ULONG size_limit = (((BN_ULONG) 1) << bits) - BN_get_word(rnd) - 1;
 408                 if (size_limit < maxdelta)
 409                         maxdelta = size_limit;
 410                 }
 411         delta=0;
 412 loop:
 413         if (is_single_word)
 414                 {
 415                 BN_ULONG rnd_word = BN_get_word(rnd);
 416
 417                 /* In the case that the candidate prime is a single word then
 418                  * we check that:
 419                  *   1) It's greater than primes[i] because we shouldn't reject
 420                  *      3 as being a prime number because it's a multiple of
 421                  *      three.
 422                  *   2) That it's not a multiple of a known prime. We don't
 423                  *      check that rnd-1 is also coprime to all the known
 424                  *      primes because there aren't many small primes where
 425                  *      that's true. */
 426                 for (i=1; i<NUMPRIMES && primes[i]<rnd_word; i++)
 427                         {
 428                         if ((mods[i]+delta)%primes[i] == 0)
 429                                 {
 430                                 delta+=2;
 431                                 if (delta > maxdelta) goto again;
 432                                 goto loop;
 433                                 }
 434                         }
 435                 }
 436         else
 437                 {
 438                 for (i=1; i<NUMPRIMES; i++)
 439                         {
 440                         /* check that rnd is not a prime and also
 441                          * that gcd(rnd-1,primes) == 1 (except for 2) */
 442                         if (((mods[i]+delta)%primes[i]) <= 1)
 443                                 {
 444                                 delta+=2;
 445                                 if (delta > maxdelta) goto again;
 446                                 goto loop;
 447                                 }
 448                         }
 449                 }
 450         if (!BN_add_word(rnd,delta)) return(0);
 451         if (BN_num_bits(rnd) != bits)
 452                 goto again;
 453         bn_check_top(rnd);
 454         return(1);
 455         }
 456
 457 static int probable_prime_dh(BIGNUM *rnd, int bits,
 458         const BIGNUM *add, const BIGNUM *rem, BN_CTX *ctx)
 459         {
 460         int i,ret=0;
 461         BIGNUM *t1;
 462
 463         BN_CTX_start(ctx);
 464         if ((t1 = BN_CTX_get(ctx)) == NULL) goto err;
 465
 466         if (!BN_rand(rnd,bits,0,1)) goto err;
 467
 468         /* we need ((rnd-rem) % add) == 0 */
 469
 470         if (!BN_mod(t1,rnd,add,ctx)) goto err;
 471         if (!BN_sub(rnd,rnd,t1)) goto err;
 472         if (rem == NULL)
 473                 { if (!BN_add_word(rnd,1)) goto err; }
 474         else
 475                 { if (!BN_add(rnd,rnd,rem)) goto err; }
 476
 477         /* we now have a random number 'rand' to test. */
 478
 479 loop:
 480         for (i=1; i<NUMPRIMES; i++)
 481                 {
 482                 /* check that rnd is a prime */
 483                 if (BN_mod_word(rnd,(BN_ULONG)primes[i]) <= 1)
 484                         {
 485                         if (!BN_add(rnd,rnd,add)) goto err;
 486                         goto loop;
 487                         }
 488                 }
 489         ret=1;
 490 err:
 491         BN_CTX_end(ctx);
 492         bn_check_top(rnd);
 493         return(ret);
 494         }
 495
 496 static int probable_prime_dh_safe(BIGNUM *p, int bits, const BIGNUM *padd,
 497         const BIGNUM *rem, BN_CTX *ctx)
 498         {
 499         int i,ret=0;
 500         BIGNUM *t1,*qadd,*q;
 501
 502         bits--;
 503         BN_CTX_start(ctx);
 504         t1 = BN_CTX_get(ctx);
 505         q = BN_CTX_get(ctx);
 506         qadd = BN_CTX_get(ctx);
 507         if (qadd == NULL) goto err;
 508
 509         if (!BN_rshift1(qadd,padd)) goto err;
 510
 511         if (!BN_rand(q,bits,0,1)) goto err;
 512
 513         /* we need ((rnd-rem) % add) == 0 */
 514         if (!BN_mod(t1,q,qadd,ctx)) goto err;
 515         if (!BN_sub(q,q,t1)) goto err;
 516         if (rem == NULL)
 517                 { if (!BN_add_word(q,1)) goto err; }
 518         else
 519                 {
 520                 if (!BN_rshift1(t1,rem)) goto err;
 521                 if (!BN_add(q,q,t1)) goto err;
 522                 }
 523
 524         /* we now have a random number 'rand' to test. */
 525         if (!BN_lshift1(p,q)) goto err;
 526         if (!BN_add_word(p,1)) goto err;
 527
 528 loop:
 529         for (i=1; i<NUMPRIMES; i++)
 530                 {
 531                 /* check that p and q are prime */
 532                 /* check that for p and q
 533                  * gcd(p-1,primes) == 1 (except for 2) */
 534                 if (    (BN_mod_word(p,(BN_ULONG)primes[i]) == 0) ||
 535                         (BN_mod_word(q,(BN_ULONG)primes[i]) == 0))
 536                         {
 537                         if (!BN_add(p,p,padd)) goto err;
 538                         if (!BN_add(q,q,qadd)) goto err;
 539                         goto loop;
 540                         }
 541                 }
 542         ret=1;
 543 err:
 544         BN_CTX_end(ctx);
 545         bn_check_top(p);
 546         return(ret);
 547         }