crypto/bn/bn_mont.c

   1 /* crypto/bn/bn_mont.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-2006 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 /*
 113  * Details about Montgomery multiplication algorithms can be found at
 114  * http://security.ece.orst.edu/publications.html, e.g.
 115  * http://security.ece.orst.edu/koc/papers/j37acmon.pdf and
 116  * sections 3.8 and 4.2 in http://security.ece.orst.edu/koc/papers/r01rsasw.pdf
 117  */
 118
 119 #include "cryptlib.h"
 120 #include "bn_lcl.h"
 121
 122 #define MONT_WORD               /* use the faster word-based algorithm */
 123
 124 #ifdef MONT_WORD
 125 static int BN_from_montgomery_word(BIGNUM *ret, BIGNUM *r, BN_MONT_CTX *mont);
 126 #endif
 127
 128 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
 129                           BN_MONT_CTX *mont, BN_CTX *ctx)
 130 {
 131     BIGNUM *tmp;
 132     int ret = 0;
 133 #if defined(OPENSSL_BN_ASM_MONT) && defined(MONT_WORD)
 134     int num = mont->N.top;
 135
 136     if (num > 1 && a->top == num && b->top == num) {
 137         if (bn_wexpand(r, num) == NULL)
 138             return (0);
 139         if (bn_mul_mont(r->d, a->d, b->d, mont->N.d, mont->n0, num)) {
 140             r->neg = a->neg ^ b->neg;
 141             r->top = num;
 142             bn_correct_top(r);
 143             return (1);
 144         }
 145     }
 146 #endif
 147
 148     BN_CTX_start(ctx);
 149     tmp = BN_CTX_get(ctx);
 150     if (tmp == NULL)
 151         goto err;
 152
 153     bn_check_top(tmp);
 154     if (a == b) {
 155         if (!BN_sqr(tmp, a, ctx))
 156             goto err;
 157     } else {
 158         if (!BN_mul(tmp, a, b, ctx))
 159             goto err;
 160     }
 161     /* reduce from aRR to aR */
 162 #ifdef MONT_WORD
 163     if (!BN_from_montgomery_word(r, tmp, mont))
 164         goto err;
 165 #else
 166     if (!BN_from_montgomery(r, tmp, mont, ctx))
 167         goto err;
 168 #endif
 169     bn_check_top(r);
 170     ret = 1;
 171  err:
 172     BN_CTX_end(ctx);
 173     return (ret);
 174 }
 175
 176 #ifdef MONT_WORD
 177 static int BN_from_montgomery_word(BIGNUM *ret, BIGNUM *r, BN_MONT_CTX *mont)
 178 {
 179     BIGNUM *n;
 180     BN_ULONG *ap, *np, *rp, n0, v, carry;
 181     int nl, max, i;
 182
 183     n = &(mont->N);
 184     nl = n->top;
 185     if (nl == 0) {
 186         ret->top = 0;
 187         return (1);
 188     }
 189
 190     max = (2 * nl);             /* carry is stored separately */
 191     if (bn_wexpand(r, max) == NULL)
 192         return (0);
 193
 194     r->neg ^= n->neg;
 195     np = n->d;
 196     rp = r->d;
 197
 198     /* clear the top words of T */
 199     memset(&(rp[r->top]), 0, (max - r->top) * sizeof(BN_ULONG));
 200
 201     r->top = max;
 202     n0 = mont->n0[0];
 203
 204     for (carry = 0, i = 0; i < nl; i++, rp++) {
 205         v = bn_mul_add_words(rp, np, nl, (rp[0] * n0) & BN_MASK2);
 206         v = (v + carry + rp[nl]) & BN_MASK2;
 207         carry |= (v != rp[nl]);
 208         carry &= (v <= rp[nl]);
 209         rp[nl] = v;
 210     }
 211
 212     if (bn_wexpand(ret, nl) == NULL)
 213         return (0);
 214     ret->top = nl;
 215     ret->neg = r->neg;
 216
 217     rp = ret->d;
 218     ap = &(r->d[nl]);
 219
 220 # define BRANCH_FREE 1
 221 # if BRANCH_FREE
 222     {
 223         BN_ULONG *nrp;
 224         size_t m;
 225
 226         v = bn_sub_words(rp, ap, np, nl) - carry;
 227         /*
 228          * if subtraction result is real, then trick unconditional memcpy
 229          * below to perform in-place "refresh" instead of actual copy.
 230          */
 231         m = (0 - (size_t)v);
 232         nrp =
 233             (BN_ULONG *)(((PTR_SIZE_INT) rp & ~m) | ((PTR_SIZE_INT) ap & m));
 234
 235         for (i = 0, nl -= 4; i < nl; i += 4) {
 236             BN_ULONG t1, t2, t3, t4;
 237
 238             t1 = nrp[i + 0];
 239             t2 = nrp[i + 1];
 240             t3 = nrp[i + 2];
 241             ap[i + 0] = 0;
 242             t4 = nrp[i + 3];
 243             ap[i + 1] = 0;
 244             rp[i + 0] = t1;
 245             ap[i + 2] = 0;
 246             rp[i + 1] = t2;
 247             ap[i + 3] = 0;
 248             rp[i + 2] = t3;
 249             rp[i + 3] = t4;
 250         }
 251         for (nl += 4; i < nl; i++)
 252             rp[i] = nrp[i], ap[i] = 0;
 253     }
 254 # else
 255     if (bn_sub_words(rp, ap, np, nl) - carry)
 256         memcpy(rp, ap, nl * sizeof(BN_ULONG));
 257 # endif
 258     bn_correct_top(r);
 259     bn_correct_top(ret);
 260     bn_check_top(ret);
 261
 262     return (1);
 263 }
 264 #endif                          /* MONT_WORD */
 265
 266 int BN_from_montgomery(BIGNUM *ret, const BIGNUM *a, BN_MONT_CTX *mont,
 267                        BN_CTX *ctx)
 268 {
 269     int retn = 0;
 270 #ifdef MONT_WORD
 271     BIGNUM *t;
 272
 273     BN_CTX_start(ctx);
 274     if ((t = BN_CTX_get(ctx)) && BN_copy(t, a))
 275         retn = BN_from_montgomery_word(ret, t, mont);
 276     BN_CTX_end(ctx);
 277 #else                           /* !MONT_WORD */
 278     BIGNUM *t1, *t2;
 279
 280     BN_CTX_start(ctx);
 281     t1 = BN_CTX_get(ctx);
 282     t2 = BN_CTX_get(ctx);
 283     if (t1 == NULL || t2 == NULL)
 284         goto err;
 285
 286     if (!BN_copy(t1, a))
 287         goto err;
 288     BN_mask_bits(t1, mont->ri);
 289
 290     if (!BN_mul(t2, t1, &mont->Ni, ctx))
 291         goto err;
 292     BN_mask_bits(t2, mont->ri);
 293
 294     if (!BN_mul(t1, t2, &mont->N, ctx))
 295         goto err;
 296     if (!BN_add(t2, a, t1))
 297         goto err;
 298     if (!BN_rshift(ret, t2, mont->ri))
 299         goto err;
 300
 301     if (BN_ucmp(ret, &(mont->N)) >= 0) {
 302         if (!BN_usub(ret, ret, &(mont->N)))
 303             goto err;
 304     }
 305     retn = 1;
 306     bn_check_top(ret);
 307  err:
 308     BN_CTX_end(ctx);
 309 #endif                          /* MONT_WORD */
 310     return (retn);
 311 }
 312
 313 BN_MONT_CTX *BN_MONT_CTX_new(void)
 314 {
 315     BN_MONT_CTX *ret;
 316
 317     if ((ret = OPENSSL_malloc(sizeof(*ret))) == NULL)
 318         return (NULL);
 319
 320     BN_MONT_CTX_init(ret);
 321     ret->flags = BN_FLG_MALLOCED;
 322     return (ret);
 323 }
 324
 325 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
 326 {
 327     ctx->ri = 0;
 328     BN_init(&(ctx->RR));
 329     BN_init(&(ctx->N));
 330     BN_init(&(ctx->Ni));
 331     ctx->n0[0] = ctx->n0[1] = 0;
 332     ctx->flags = 0;
 333 }
 334
 335 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
 336 {
 337     if (mont == NULL)
 338         return;
 339
 340     BN_free(&(mont->RR));
 341     BN_free(&(mont->N));
 342     BN_free(&(mont->Ni));
 343     if (mont->flags & BN_FLG_MALLOCED)
 344         OPENSSL_free(mont);
 345 }
 346
 347 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
 348 {
 349     int ret = 0;
 350     BIGNUM *Ri, *R;
 351
 352     BN_CTX_start(ctx);
 353     if ((Ri = BN_CTX_get(ctx)) == NULL)
 354         goto err;
 355     R = &(mont->RR);            /* grab RR as a temp */
 356     if (!BN_copy(&(mont->N), mod))
 357         goto err;               /* Set N */
 358     mont->N.neg = 0;
 359
 360 #ifdef MONT_WORD
 361     {
 362         BIGNUM tmod;
 363         BN_ULONG buf[2];
 364
 365         BN_init(&tmod);
 366         tmod.d = buf;
 367         tmod.dmax = 2;
 368         tmod.neg = 0;
 369
 370         mont->ri = (BN_num_bits(mod) + (BN_BITS2 - 1)) / BN_BITS2 * BN_BITS2;
 371
 372 # if defined(OPENSSL_BN_ASM_MONT) && (BN_BITS2<=32)
 373         /*
 374          * Only certain BN_BITS2<=32 platforms actually make use of n0[1],
 375          * and we could use the #else case (with a shorter R value) for the
 376          * others.  However, currently only the assembler files do know which
 377          * is which.
 378          */
 379
 380         BN_zero(R);
 381         if (!(BN_set_bit(R, 2 * BN_BITS2)))
 382             goto err;
 383
 384         tmod.top = 0;
 385         if ((buf[0] = mod->d[0]))
 386             tmod.top = 1;
 387         if ((buf[1] = mod->top > 1 ? mod->d[1] : 0))
 388             tmod.top = 2;
 389
 390         if ((BN_mod_inverse(Ri, R, &tmod, ctx)) == NULL)
 391             goto err;
 392         if (!BN_lshift(Ri, Ri, 2 * BN_BITS2))
 393             goto err;           /* R*Ri */
 394         if (!BN_is_zero(Ri)) {
 395             if (!BN_sub_word(Ri, 1))
 396                 goto err;
 397         } else {                /* if N mod word size == 1 */
 398
 399             if (bn_expand(Ri, (int)sizeof(BN_ULONG) * 2) == NULL)
 400                 goto err;
 401             /* Ri-- (mod double word size) */
 402             Ri->neg = 0;
 403             Ri->d[0] = BN_MASK2;
 404             Ri->d[1] = BN_MASK2;
 405             Ri->top = 2;
 406         }
 407         if (!BN_div(Ri, NULL, Ri, &tmod, ctx))
 408             goto err;
 409         /*
 410          * Ni = (R*Ri-1)/N, keep only couple of least significant words:
 411          */
 412         mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
 413         mont->n0[1] = (Ri->top > 1) ? Ri->d[1] : 0;
 414 # else
 415         BN_zero(R);
 416         if (!(BN_set_bit(R, BN_BITS2)))
 417             goto err;           /* R */
 418
 419         buf[0] = mod->d[0];     /* tmod = N mod word size */
 420         buf[1] = 0;
 421         tmod.top = buf[0] != 0 ? 1 : 0;
 422         /* Ri = R^-1 mod N */
 423         if ((BN_mod_inverse(Ri, R, &tmod, ctx)) == NULL)
 424             goto err;
 425         if (!BN_lshift(Ri, Ri, BN_BITS2))
 426             goto err;           /* R*Ri */
 427         if (!BN_is_zero(Ri)) {
 428             if (!BN_sub_word(Ri, 1))
 429                 goto err;
 430         } else {                /* if N mod word size == 1 */
 431
 432             if (!BN_set_word(Ri, BN_MASK2))
 433                 goto err;       /* Ri-- (mod word size) */
 434         }
 435         if (!BN_div(Ri, NULL, Ri, &tmod, ctx))
 436             goto err;
 437         /*
 438          * Ni = (R*Ri-1)/N, keep only least significant word:
 439          */
 440         mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
 441         mont->n0[1] = 0;
 442 # endif
 443     }
 444 #else                           /* !MONT_WORD */
 445     {                           /* bignum version */
 446         mont->ri = BN_num_bits(&mont->N);
 447         BN_zero(R);
 448         if (!BN_set_bit(R, mont->ri))
 449             goto err;           /* R = 2^ri */
 450         /* Ri = R^-1 mod N */
 451         if ((BN_mod_inverse(Ri, R, &mont->N, ctx)) == NULL)
 452             goto err;
 453         if (!BN_lshift(Ri, Ri, mont->ri))
 454             goto err;           /* R*Ri */
 455         if (!BN_sub_word(Ri, 1))
 456             goto err;
 457         /*
 458          * Ni = (R*Ri-1) / N
 459          */
 460         if (!BN_div(&(mont->Ni), NULL, Ri, &mont->N, ctx))
 461             goto err;
 462     }
 463 #endif
 464
 465     /* setup RR for conversions */
 466     BN_zero(&(mont->RR));
 467     if (!BN_set_bit(&(mont->RR), mont->ri * 2))
 468         goto err;
 469     if (!BN_mod(&(mont->RR), &(mont->RR), &(mont->N), ctx))
 470         goto err;
 471
 472     ret = 1;
 473  err:
 474     BN_CTX_end(ctx);
 475     return ret;
 476 }
 477
 478 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
 479 {
 480     if (to == from)
 481         return (to);
 482
 483     if (!BN_copy(&(to->RR), &(from->RR)))
 484         return NULL;
 485     if (!BN_copy(&(to->N), &(from->N)))
 486         return NULL;
 487     if (!BN_copy(&(to->Ni), &(from->Ni)))
 488         return NULL;
 489     to->ri = from->ri;
 490     to->n0[0] = from->n0[0];
 491     to->n0[1] = from->n0[1];
 492     return (to);
 493 }
 494
 495 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
 496                                     const BIGNUM *mod, BN_CTX *ctx)
 497 {
 498     BN_MONT_CTX *ret;
 499
 500     CRYPTO_r_lock(lock);
 501     ret = *pmont;
 502     CRYPTO_r_unlock(lock);
 503     if (ret)
 504         return ret;
 505
 506     /*
 507      * We don't want to serialise globally while doing our lazy-init math in
 508      * BN_MONT_CTX_set. That punishes threads that are doing independent
 509      * things. Instead, punish the case where more than one thread tries to
 510      * lazy-init the same 'pmont', by having each do the lazy-init math work
 511      * independently and only use the one from the thread that wins the race
 512      * (the losers throw away the work they've done).
 513      */
 514     ret = BN_MONT_CTX_new();
 515     if (!ret)
 516         return NULL;
 517     if (!BN_MONT_CTX_set(ret, mod, ctx)) {
 518         BN_MONT_CTX_free(ret);
 519         return NULL;
 520     }
 521
 522     /* The locked compare-and-set, after the local work is done. */
 523     CRYPTO_w_lock(lock);
 524     if (*pmont) {
 525         BN_MONT_CTX_free(ret);
 526         ret = *pmont;
 527     } else
 528         *pmont = ret;
 529     CRYPTO_w_unlock(lock);
 530     return ret;
 531 }