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