crypto/bn/bn_mont.c

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /*
  11  * Details about Montgomery multiplication algorithms can be found at
  12  * http://security.ece.orst.edu/publications.html, e.g.
  13  * http://security.ece.orst.edu/koc/papers/j37acmon.pdf and
  14  * sections 3.8 and 4.2 in http://security.ece.orst.edu/koc/papers/r01rsasw.pdf
  15  */
  16
  17 #include "internal/cryptlib.h"
  18 #include "bn_lcl.h"
  19
  20 #define MONT_WORD               /* use the faster word-based algorithm */
  21
  22 #ifdef MONT_WORD
  23 static int BN_from_montgomery_word(BIGNUM *ret, BIGNUM *r, BN_MONT_CTX *mont);
  24 #endif
  25
  26 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
  27                           BN_MONT_CTX *mont, BN_CTX *ctx)
  28 {
  29     BIGNUM *tmp;
  30     int ret = 0;
  31 #if defined(OPENSSL_BN_ASM_MONT) && defined(MONT_WORD)
  32     int num = mont->N.top;
  33
  34     if (num > 1 && a->top == num && b->top == num) {
  35         if (bn_wexpand(r, num) == NULL)
  36             return 0;
  37         if (bn_mul_mont(r->d, a->d, b->d, mont->N.d, mont->n0, num)) {
  38             r->neg = a->neg ^ b->neg;
  39             r->top = num;
  40             bn_correct_top(r);
  41             return 1;
  42         }
  43     }
  44 #endif
  45
  46     BN_CTX_start(ctx);
  47     tmp = BN_CTX_get(ctx);
  48     if (tmp == NULL)
  49         goto err;
  50
  51     bn_check_top(tmp);
  52     if (a == b) {
  53         if (!BN_sqr(tmp, a, ctx))
  54             goto err;
  55     } else {
  56         if (!BN_mul(tmp, a, b, ctx))
  57             goto err;
  58     }
  59     /* reduce from aRR to aR */
  60 #ifdef MONT_WORD
  61     if (!BN_from_montgomery_word(r, tmp, mont))
  62         goto err;
  63 #else
  64     if (!BN_from_montgomery(r, tmp, mont, ctx))
  65         goto err;
  66 #endif
  67     bn_check_top(r);
  68     ret = 1;
  69  err:
  70     BN_CTX_end(ctx);
  71     return ret;
  72 }
  73
  74 #ifdef MONT_WORD
  75 static int BN_from_montgomery_word(BIGNUM *ret, BIGNUM *r, BN_MONT_CTX *mont)
  76 {
  77     BIGNUM *n;
  78     BN_ULONG *ap, *np, *rp, n0, v, carry;
  79     int nl, max, i;
  80
  81     n = &(mont->N);
  82     nl = n->top;
  83     if (nl == 0) {
  84         ret->top = 0;
  85         return 1;
  86     }
  87
  88     max = (2 * nl);             /* carry is stored separately */
  89     if (bn_wexpand(r, max) == NULL)
  90         return 0;
  91
  92     r->neg ^= n->neg;
  93     np = n->d;
  94     rp = r->d;
  95
  96     /* clear the top words of T */
  97     i = max - r->top;
  98     if (i)
  99         memset(&rp[r->top], 0, sizeof(*rp) * i);
 100
 101     r->top = max;
 102     n0 = mont->n0[0];
 103
 104     /*
 105      * Add multiples of |n| to |r| until R = 2^(nl * BN_BITS2) divides it. On
 106      * input, we had |r| < |n| * R, so now |r| < 2 * |n| * R. Note that |r|
 107      * includes |carry| which is stored separately.
 108      */
 109     for (carry = 0, i = 0; i < nl; i++, rp++) {
 110         v = bn_mul_add_words(rp, np, nl, (rp[0] * n0) & BN_MASK2);
 111         v = (v + carry + rp[nl]) & BN_MASK2;
 112         carry |= (v != rp[nl]);
 113         carry &= (v <= rp[nl]);
 114         rp[nl] = v;
 115     }
 116
 117     if (bn_wexpand(ret, nl) == NULL)
 118         return 0;
 119     ret->top = nl;
 120     ret->neg = r->neg;
 121
 122     rp = ret->d;
 123
 124     /*
 125      * Shift |nl| words to divide by R. We have |ap| < 2 * |n|. Note that |ap|
 126      * includes |carry| which is stored separately.
 127      */
 128     ap = &(r->d[nl]);
 129
 130     /*
 131      * |v| is one if |ap| - |np| underflowed or zero if it did not. Note |v|
 132      * cannot be -1. That would imply the subtraction did not fit in |nl| words,
 133      * and we know at most one subtraction is needed.
 134      */
 135     v = bn_sub_words(rp, ap, np, nl) - carry;
 136     v = 0 - v;
 137     for (i = 0; i < nl; i++) {
 138         rp[i] = (v & ap[i]) | (~v & rp[i]);
 139         ap[i] = 0;
 140     }
 141     bn_correct_top(r);
 142     bn_correct_top(ret);
 143     bn_check_top(ret);
 144
 145     return 1;
 146 }
 147 #endif                          /* MONT_WORD */
 148
 149 int BN_from_montgomery(BIGNUM *ret, const BIGNUM *a, BN_MONT_CTX *mont,
 150                        BN_CTX *ctx)
 151 {
 152     int retn = 0;
 153 #ifdef MONT_WORD
 154     BIGNUM *t;
 155
 156     BN_CTX_start(ctx);
 157     if ((t = BN_CTX_get(ctx)) && BN_copy(t, a))
 158         retn = BN_from_montgomery_word(ret, t, mont);
 159     BN_CTX_end(ctx);
 160 #else                           /* !MONT_WORD */
 161     BIGNUM *t1, *t2;
 162
 163     BN_CTX_start(ctx);
 164     t1 = BN_CTX_get(ctx);
 165     t2 = BN_CTX_get(ctx);
 166     if (t2 == NULL)
 167         goto err;
 168
 169     if (!BN_copy(t1, a))
 170         goto err;
 171     BN_mask_bits(t1, mont->ri);
 172
 173     if (!BN_mul(t2, t1, &mont->Ni, ctx))
 174         goto err;
 175     BN_mask_bits(t2, mont->ri);
 176
 177     if (!BN_mul(t1, t2, &mont->N, ctx))
 178         goto err;
 179     if (!BN_add(t2, a, t1))
 180         goto err;
 181     if (!BN_rshift(ret, t2, mont->ri))
 182         goto err;
 183
 184     if (BN_ucmp(ret, &(mont->N)) >= 0) {
 185         if (!BN_usub(ret, ret, &(mont->N)))
 186             goto err;
 187     }
 188     retn = 1;
 189     bn_check_top(ret);
 190  err:
 191     BN_CTX_end(ctx);
 192 #endif                          /* MONT_WORD */
 193     return retn;
 194 }
 195
 196 BN_MONT_CTX *BN_MONT_CTX_new(void)
 197 {
 198     BN_MONT_CTX *ret;
 199
 200     if ((ret = OPENSSL_malloc(sizeof(*ret))) == NULL)
 201         return NULL;
 202
 203     BN_MONT_CTX_init(ret);
 204     ret->flags = BN_FLG_MALLOCED;
 205     return ret;
 206 }
 207
 208 void BN_MONT_CTX_init(BN_MONT_CTX *ctx)
 209 {
 210     ctx->ri = 0;
 211     bn_init(&(ctx->RR));
 212     bn_init(&(ctx->N));
 213     bn_init(&(ctx->Ni));
 214     ctx->n0[0] = ctx->n0[1] = 0;
 215     ctx->flags = 0;
 216 }
 217
 218 void BN_MONT_CTX_free(BN_MONT_CTX *mont)
 219 {
 220     if (mont == NULL)
 221         return;
 222
 223     BN_clear_free(&(mont->RR));
 224     BN_clear_free(&(mont->N));
 225     BN_clear_free(&(mont->Ni));
 226     if (mont->flags & BN_FLG_MALLOCED)
 227         OPENSSL_free(mont);
 228 }
 229
 230 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx)
 231 {
 232     int ret = 0;
 233     BIGNUM *Ri, *R;
 234
 235     if (BN_is_zero(mod))
 236         return 0;
 237
 238     BN_CTX_start(ctx);
 239     if ((Ri = BN_CTX_get(ctx)) == NULL)
 240         goto err;
 241     R = &(mont->RR);            /* grab RR as a temp */
 242     if (!BN_copy(&(mont->N), mod))
 243         goto err;               /* Set N */
 244     if (BN_get_flags(mod, BN_FLG_CONSTTIME) != 0)
 245         BN_set_flags(&(mont->N), BN_FLG_CONSTTIME);
 246     mont->N.neg = 0;
 247
 248 #ifdef MONT_WORD
 249     {
 250         BIGNUM tmod;
 251         BN_ULONG buf[2];
 252
 253         bn_init(&tmod);
 254         tmod.d = buf;
 255         tmod.dmax = 2;
 256         tmod.neg = 0;
 257
 258         if (BN_get_flags(mod, BN_FLG_CONSTTIME) != 0)
 259             BN_set_flags(&tmod, BN_FLG_CONSTTIME);
 260
 261         mont->ri = (BN_num_bits(mod) + (BN_BITS2 - 1)) / BN_BITS2 * BN_BITS2;
 262
 263 # if defined(OPENSSL_BN_ASM_MONT) && (BN_BITS2<=32)
 264         /*
 265          * Only certain BN_BITS2<=32 platforms actually make use of n0[1],
 266          * and we could use the #else case (with a shorter R value) for the
 267          * others.  However, currently only the assembler files do know which
 268          * is which.
 269          */
 270
 271         BN_zero(R);
 272         if (!(BN_set_bit(R, 2 * BN_BITS2)))
 273             goto err;
 274
 275         tmod.top = 0;
 276         if ((buf[0] = mod->d[0]))
 277             tmod.top = 1;
 278         if ((buf[1] = mod->top > 1 ? mod->d[1] : 0))
 279             tmod.top = 2;
 280
 281         if ((BN_mod_inverse(Ri, R, &tmod, ctx)) == NULL)
 282             goto err;
 283         if (!BN_lshift(Ri, Ri, 2 * BN_BITS2))
 284             goto err;           /* R*Ri */
 285         if (!BN_is_zero(Ri)) {
 286             if (!BN_sub_word(Ri, 1))
 287                 goto err;
 288         } else {                /* if N mod word size == 1 */
 289
 290             if (bn_expand(Ri, (int)sizeof(BN_ULONG) * 2) == NULL)
 291                 goto err;
 292             /* Ri-- (mod double word size) */
 293             Ri->neg = 0;
 294             Ri->d[0] = BN_MASK2;
 295             Ri->d[1] = BN_MASK2;
 296             Ri->top = 2;
 297         }
 298         if (!BN_div(Ri, NULL, Ri, &tmod, ctx))
 299             goto err;
 300         /*
 301          * Ni = (R*Ri-1)/N, keep only couple of least significant words:
 302          */
 303         mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
 304         mont->n0[1] = (Ri->top > 1) ? Ri->d[1] : 0;
 305 # else
 306         BN_zero(R);
 307         if (!(BN_set_bit(R, BN_BITS2)))
 308             goto err;           /* R */
 309
 310         buf[0] = mod->d[0];     /* tmod = N mod word size */
 311         buf[1] = 0;
 312         tmod.top = buf[0] != 0 ? 1 : 0;
 313         /* Ri = R^-1 mod N */
 314         if ((BN_mod_inverse(Ri, R, &tmod, ctx)) == NULL)
 315             goto err;
 316         if (!BN_lshift(Ri, Ri, BN_BITS2))
 317             goto err;           /* R*Ri */
 318         if (!BN_is_zero(Ri)) {
 319             if (!BN_sub_word(Ri, 1))
 320                 goto err;
 321         } else {                /* if N mod word size == 1 */
 322
 323             if (!BN_set_word(Ri, BN_MASK2))
 324                 goto err;       /* Ri-- (mod word size) */
 325         }
 326         if (!BN_div(Ri, NULL, Ri, &tmod, ctx))
 327             goto err;
 328         /*
 329          * Ni = (R*Ri-1)/N, keep only least significant word:
 330          */
 331         mont->n0[0] = (Ri->top > 0) ? Ri->d[0] : 0;
 332         mont->n0[1] = 0;
 333 # endif
 334     }
 335 #else                           /* !MONT_WORD */
 336     {                           /* bignum version */
 337         mont->ri = BN_num_bits(&mont->N);
 338         BN_zero(R);
 339         if (!BN_set_bit(R, mont->ri))
 340             goto err;           /* R = 2^ri */
 341         /* Ri = R^-1 mod N */
 342         if ((BN_mod_inverse(Ri, R, &mont->N, ctx)) == NULL)
 343             goto err;
 344         if (!BN_lshift(Ri, Ri, mont->ri))
 345             goto err;           /* R*Ri */
 346         if (!BN_sub_word(Ri, 1))
 347             goto err;
 348         /*
 349          * Ni = (R*Ri-1) / N
 350          */
 351         if (!BN_div(&(mont->Ni), NULL, Ri, &mont->N, ctx))
 352             goto err;
 353     }
 354 #endif
 355
 356     /* setup RR for conversions */
 357     BN_zero(&(mont->RR));
 358     if (!BN_set_bit(&(mont->RR), mont->ri * 2))
 359         goto err;
 360     if (!BN_mod(&(mont->RR), &(mont->RR), &(mont->N), ctx))
 361         goto err;
 362
 363     ret = 1;
 364  err:
 365     BN_CTX_end(ctx);
 366     return ret;
 367 }
 368
 369 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from)
 370 {
 371     if (to == from)
 372         return to;
 373
 374     if (!BN_copy(&(to->RR), &(from->RR)))
 375         return NULL;
 376     if (!BN_copy(&(to->N), &(from->N)))
 377         return NULL;
 378     if (!BN_copy(&(to->Ni), &(from->Ni)))
 379         return NULL;
 380     to->ri = from->ri;
 381     to->n0[0] = from->n0[0];
 382     to->n0[1] = from->n0[1];
 383     return to;
 384 }
 385
 386 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, CRYPTO_RWLOCK *lock,
 387                                     const BIGNUM *mod, BN_CTX *ctx)
 388 {
 389     BN_MONT_CTX *ret;
 390
 391     CRYPTO_THREAD_read_lock(lock);
 392     ret = *pmont;
 393     CRYPTO_THREAD_unlock(lock);
 394     if (ret)
 395         return ret;
 396
 397     /*
 398      * We don't want to serialise globally while doing our lazy-init math in
 399      * BN_MONT_CTX_set. That punishes threads that are doing independent
 400      * things. Instead, punish the case where more than one thread tries to
 401      * lazy-init the same 'pmont', by having each do the lazy-init math work
 402      * independently and only use the one from the thread that wins the race
 403      * (the losers throw away the work they've done).
 404      */
 405     ret = BN_MONT_CTX_new();
 406     if (ret == NULL)
 407         return NULL;
 408     if (!BN_MONT_CTX_set(ret, mod, ctx)) {
 409         BN_MONT_CTX_free(ret);
 410         return NULL;
 411     }
 412
 413     /* The locked compare-and-set, after the local work is done. */
 414     CRYPTO_THREAD_write_lock(lock);
 415     if (*pmont) {
 416         BN_MONT_CTX_free(ret);
 417         ret = *pmont;
 418     } else
 419         *pmont = ret;
 420     CRYPTO_THREAD_unlock(lock);
 421     return ret;
 422 }