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