crypto/bn/bn_lib.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 #include <assert.h>
  11 #include <limits.h>
  12 #include "internal/cryptlib.h"
  13 #include "bn_lcl.h"
  14 #include <openssl/opensslconf.h>
  15 #include "internal/constant_time_locl.h"
  16
  17 /* This stuff appears to be completely unused, so is deprecated */
  18 #if OPENSSL_API_COMPAT < 0x00908000L
  19 /*-
  20  * For a 32 bit machine
  21  * 2 -   4 ==  128
  22  * 3 -   8 ==  256
  23  * 4 -  16 ==  512
  24  * 5 -  32 == 1024
  25  * 6 -  64 == 2048
  26  * 7 - 128 == 4096
  27  * 8 - 256 == 8192
  28  */
  29 static int bn_limit_bits = 0;
  30 static int bn_limit_num = 8;    /* (1<<bn_limit_bits) */
  31 static int bn_limit_bits_low = 0;
  32 static int bn_limit_num_low = 8; /* (1<<bn_limit_bits_low) */
  33 static int bn_limit_bits_high = 0;
  34 static int bn_limit_num_high = 8; /* (1<<bn_limit_bits_high) */
  35 static int bn_limit_bits_mont = 0;
  36 static int bn_limit_num_mont = 8; /* (1<<bn_limit_bits_mont) */
  37
  38 void BN_set_params(int mult, int high, int low, int mont)
  39 {
  40     if (mult >= 0) {
  41         if (mult > (int)(sizeof(int) * 8) - 1)
  42             mult = sizeof(int) * 8 - 1;
  43         bn_limit_bits = mult;
  44         bn_limit_num = 1 << mult;
  45     }
  46     if (high >= 0) {
  47         if (high > (int)(sizeof(int) * 8) - 1)
  48             high = sizeof(int) * 8 - 1;
  49         bn_limit_bits_high = high;
  50         bn_limit_num_high = 1 << high;
  51     }
  52     if (low >= 0) {
  53         if (low > (int)(sizeof(int) * 8) - 1)
  54             low = sizeof(int) * 8 - 1;
  55         bn_limit_bits_low = low;
  56         bn_limit_num_low = 1 << low;
  57     }
  58     if (mont >= 0) {
  59         if (mont > (int)(sizeof(int) * 8) - 1)
  60             mont = sizeof(int) * 8 - 1;
  61         bn_limit_bits_mont = mont;
  62         bn_limit_num_mont = 1 << mont;
  63     }
  64 }
  65
  66 int BN_get_params(int which)
  67 {
  68     if (which == 0)
  69         return (bn_limit_bits);
  70     else if (which == 1)
  71         return (bn_limit_bits_high);
  72     else if (which == 2)
  73         return (bn_limit_bits_low);
  74     else if (which == 3)
  75         return (bn_limit_bits_mont);
  76     else
  77         return (0);
  78 }
  79 #endif
  80
  81 const BIGNUM *BN_value_one(void)
  82 {
  83     static const BN_ULONG data_one = 1L;
  84     static const BIGNUM const_one =
  85         { (BN_ULONG *)&data_one, 1, 1, 0, BN_FLG_STATIC_DATA };
  86
  87     return (&const_one);
  88 }
  89
  90 int BN_num_bits_word(BN_ULONG l)
  91 {
  92     BN_ULONG x, mask;
  93     int bits = (l != 0);
  94
  95 #if BN_BITS2 > 32
  96     x = l >> 32;
  97     mask = (0 - x) & BN_MASK2;
  98     mask = (0 - (mask >> (BN_BITS2 - 1)));
  99     bits += 32 & mask;
 100     l ^= (x ^ l) & mask;
 101 #endif
 102
 103     x = l >> 16;
 104     mask = (0 - x) & BN_MASK2;
 105     mask = (0 - (mask >> (BN_BITS2 - 1)));
 106     bits += 16 & mask;
 107     l ^= (x ^ l) & mask;
 108
 109     x = l >> 8;
 110     mask = (0 - x) & BN_MASK2;
 111     mask = (0 - (mask >> (BN_BITS2 - 1)));
 112     bits += 8 & mask;
 113     l ^= (x ^ l) & mask;
 114
 115     x = l >> 4;
 116     mask = (0 - x) & BN_MASK2;
 117     mask = (0 - (mask >> (BN_BITS2 - 1)));
 118     bits += 4 & mask;
 119     l ^= (x ^ l) & mask;
 120
 121     x = l >> 2;
 122     mask = (0 - x) & BN_MASK2;
 123     mask = (0 - (mask >> (BN_BITS2 - 1)));
 124     bits += 2 & mask;
 125     l ^= (x ^ l) & mask;
 126
 127     x = l >> 1;
 128     mask = (0 - x) & BN_MASK2;
 129     mask = (0 - (mask >> (BN_BITS2 - 1)));
 130     bits += 1 & mask;
 131
 132     return bits;
 133 }
 134
 135 int BN_num_bits(const BIGNUM *a)
 136 {
 137     int i = a->top - 1;
 138     bn_check_top(a);
 139
 140     if (BN_is_zero(a))
 141         return 0;
 142     return ((i * BN_BITS2) + BN_num_bits_word(a->d[i]));
 143 }
 144
 145 static void bn_free_d(BIGNUM *a)
 146 {
 147     if (BN_get_flags(a, BN_FLG_SECURE))
 148         OPENSSL_secure_free(a->d);
 149     else
 150         OPENSSL_free(a->d);
 151 }
 152
 153
 154 void BN_clear_free(BIGNUM *a)
 155 {
 156     int i;
 157
 158     if (a == NULL)
 159         return;
 160     bn_check_top(a);
 161     if (a->d != NULL) {
 162         OPENSSL_cleanse(a->d, a->dmax * sizeof(a->d[0]));
 163         if (!BN_get_flags(a, BN_FLG_STATIC_DATA))
 164             bn_free_d(a);
 165     }
 166     i = BN_get_flags(a, BN_FLG_MALLOCED);
 167     OPENSSL_cleanse(a, sizeof(*a));
 168     if (i)
 169         OPENSSL_free(a);
 170 }
 171
 172 void BN_free(BIGNUM *a)
 173 {
 174     if (a == NULL)
 175         return;
 176     bn_check_top(a);
 177     if (!BN_get_flags(a, BN_FLG_STATIC_DATA))
 178         bn_free_d(a);
 179     if (a->flags & BN_FLG_MALLOCED)
 180         OPENSSL_free(a);
 181     else {
 182 #if OPENSSL_API_COMPAT < 0x00908000L
 183         a->flags |= BN_FLG_FREE;
 184 #endif
 185         a->d = NULL;
 186     }
 187 }
 188
 189 void bn_init(BIGNUM *a)
 190 {
 191     static BIGNUM nilbn;
 192
 193     *a = nilbn;
 194     bn_check_top(a);
 195 }
 196
 197 BIGNUM *BN_new(void)
 198 {
 199     BIGNUM *ret;
 200
 201     if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
 202         BNerr(BN_F_BN_NEW, ERR_R_MALLOC_FAILURE);
 203         return (NULL);
 204     }
 205     ret->flags = BN_FLG_MALLOCED;
 206     bn_check_top(ret);
 207     return (ret);
 208 }
 209
 210  BIGNUM *BN_secure_new(void)
 211  {
 212      BIGNUM *ret = BN_new();
 213      if (ret != NULL)
 214          ret->flags |= BN_FLG_SECURE;
 215      return (ret);
 216  }
 217
 218 /* This is used by bn_expand2() */
 219 /* The caller MUST check that words > b->dmax before calling this */
 220 static BN_ULONG *bn_expand_internal(const BIGNUM *b, int words)
 221 {
 222     BN_ULONG *A, *a = NULL;
 223     const BN_ULONG *B;
 224     int i;
 225
 226     if (words > (INT_MAX / (4 * BN_BITS2))) {
 227         BNerr(BN_F_BN_EXPAND_INTERNAL, BN_R_BIGNUM_TOO_LONG);
 228         return NULL;
 229     }
 230     if (BN_get_flags(b, BN_FLG_STATIC_DATA)) {
 231         BNerr(BN_F_BN_EXPAND_INTERNAL, BN_R_EXPAND_ON_STATIC_BIGNUM_DATA);
 232         return (NULL);
 233     }
 234     if (BN_get_flags(b, BN_FLG_SECURE))
 235         a = A = OPENSSL_secure_zalloc(words * sizeof(*a));
 236     else
 237         a = A = OPENSSL_zalloc(words * sizeof(*a));
 238     if (A == NULL) {
 239         BNerr(BN_F_BN_EXPAND_INTERNAL, ERR_R_MALLOC_FAILURE);
 240         return (NULL);
 241     }
 242
 243 #if 1
 244     B = b->d;
 245     /* Check if the previous number needs to be copied */
 246     if (B != NULL) {
 247         for (i = b->top >> 2; i > 0; i--, A += 4, B += 4) {
 248             /*
 249              * The fact that the loop is unrolled
 250              * 4-wise is a tribute to Intel. It's
 251              * the one that doesn't have enough
 252              * registers to accommodate more data.
 253              * I'd unroll it 8-wise otherwise:-)
 254              *
 255              *              <appro@fy.chalmers.se>
 256              */
 257             BN_ULONG a0, a1, a2, a3;
 258             a0 = B[0];
 259             a1 = B[1];
 260             a2 = B[2];
 261             a3 = B[3];
 262             A[0] = a0;
 263             A[1] = a1;
 264             A[2] = a2;
 265             A[3] = a3;
 266         }
 267         switch (b->top & 3) {
 268         case 3:
 269             A[2] = B[2];
 270             /* fall thru */
 271         case 2:
 272             A[1] = B[1];
 273             /* fall thru */
 274         case 1:
 275             A[0] = B[0];
 276             /* fall thru */
 277         case 0:
 278             /* Without the "case 0" some old optimizers got this wrong. */
 279             ;
 280         }
 281     }
 282 #else
 283     memset(A, 0, sizeof(*A) * words);
 284     memcpy(A, b->d, sizeof(b->d[0]) * b->top);
 285 #endif
 286
 287     return (a);
 288 }
 289
 290 /*
 291  * This is an internal function that should not be used in applications. It
 292  * ensures that 'b' has enough room for a 'words' word number and initialises
 293  * any unused part of b->d with leading zeros. It is mostly used by the
 294  * various BIGNUM routines. If there is an error, NULL is returned. If not,
 295  * 'b' is returned.
 296  */
 297
 298 BIGNUM *bn_expand2(BIGNUM *b, int words)
 299 {
 300     if (words > b->dmax) {
 301         BN_ULONG *a = bn_expand_internal(b, words);
 302         if (!a)
 303             return NULL;
 304         if (b->d) {
 305             OPENSSL_cleanse(b->d, b->dmax * sizeof(b->d[0]));
 306             bn_free_d(b);
 307         }
 308         b->d = a;
 309         b->dmax = words;
 310     }
 311
 312     return b;
 313 }
 314
 315 BIGNUM *BN_dup(const BIGNUM *a)
 316 {
 317     BIGNUM *t;
 318
 319     if (a == NULL)
 320         return NULL;
 321     bn_check_top(a);
 322
 323     t = BN_get_flags(a, BN_FLG_SECURE) ? BN_secure_new() : BN_new();
 324     if (t == NULL)
 325         return NULL;
 326     if (!BN_copy(t, a)) {
 327         BN_free(t);
 328         return NULL;
 329     }
 330     bn_check_top(t);
 331     return t;
 332 }
 333
 334 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b)
 335 {
 336     int i;
 337     BN_ULONG *A;
 338     const BN_ULONG *B;
 339
 340     bn_check_top(b);
 341
 342     if (a == b)
 343         return (a);
 344     if (bn_wexpand(a, b->top) == NULL)
 345         return (NULL);
 346
 347 #if 1
 348     A = a->d;
 349     B = b->d;
 350     for (i = b->top >> 2; i > 0; i--, A += 4, B += 4) {
 351         BN_ULONG a0, a1, a2, a3;
 352         a0 = B[0];
 353         a1 = B[1];
 354         a2 = B[2];
 355         a3 = B[3];
 356         A[0] = a0;
 357         A[1] = a1;
 358         A[2] = a2;
 359         A[3] = a3;
 360     }
 361     /* ultrix cc workaround, see comments in bn_expand_internal */
 362     switch (b->top & 3) {
 363     case 3:
 364         A[2] = B[2];
 365         /* fall thru */
 366     case 2:
 367         A[1] = B[1];
 368         /* fall thru */
 369     case 1:
 370         A[0] = B[0];
 371         /* fall thru */
 372     case 0:;
 373     }
 374 #else
 375     memcpy(a->d, b->d, sizeof(b->d[0]) * b->top);
 376 #endif
 377
 378     a->neg = b->neg;
 379     a->top = b->top;
 380     a->flags |= b->flags & BN_FLG_FIXED_TOP;
 381     bn_check_top(a);
 382     return (a);
 383 }
 384
 385 #define FLAGS_DATA(flags) ((flags) & (BN_FLG_STATIC_DATA \
 386                                     | BN_FLG_CONSTTIME   \
 387                                     | BN_FLG_SECURE      \
 388                                     | BN_FLG_FIXED_TOP))
 389 #define FLAGS_STRUCT(flags) ((flags) & (BN_FLG_MALLOCED))
 390
 391 void BN_swap(BIGNUM *a, BIGNUM *b)
 392 {
 393     int flags_old_a, flags_old_b;
 394     BN_ULONG *tmp_d;
 395     int tmp_top, tmp_dmax, tmp_neg;
 396
 397     bn_check_top(a);
 398     bn_check_top(b);
 399
 400     flags_old_a = a->flags;
 401     flags_old_b = b->flags;
 402
 403     tmp_d = a->d;
 404     tmp_top = a->top;
 405     tmp_dmax = a->dmax;
 406     tmp_neg = a->neg;
 407
 408     a->d = b->d;
 409     a->top = b->top;
 410     a->dmax = b->dmax;
 411     a->neg = b->neg;
 412
 413     b->d = tmp_d;
 414     b->top = tmp_top;
 415     b->dmax = tmp_dmax;
 416     b->neg = tmp_neg;
 417
 418     a->flags = FLAGS_STRUCT(flags_old_a) | FLAGS_DATA(flags_old_b);
 419     b->flags = FLAGS_STRUCT(flags_old_b) | FLAGS_DATA(flags_old_a);
 420     bn_check_top(a);
 421     bn_check_top(b);
 422 }
 423
 424 void BN_clear(BIGNUM *a)
 425 {
 426     bn_check_top(a);
 427     if (a->d != NULL)
 428         OPENSSL_cleanse(a->d, sizeof(*a->d) * a->dmax);
 429     a->neg = 0;
 430     a->top = 0;
 431     a->flags &= ~BN_FLG_FIXED_TOP;
 432 }
 433
 434 BN_ULONG BN_get_word(const BIGNUM *a)
 435 {
 436     if (a->top > 1)
 437         return BN_MASK2;
 438     else if (a->top == 1)
 439         return a->d[0];
 440     /* a->top == 0 */
 441     return 0;
 442 }
 443
 444 int BN_set_word(BIGNUM *a, BN_ULONG w)
 445 {
 446     bn_check_top(a);
 447     if (bn_expand(a, (int)sizeof(BN_ULONG) * 8) == NULL)
 448         return (0);
 449     a->neg = 0;
 450     a->d[0] = w;
 451     a->top = (w ? 1 : 0);
 452     a->flags &= ~BN_FLG_FIXED_TOP;
 453     bn_check_top(a);
 454     return (1);
 455 }
 456
 457 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret)
 458 {
 459     unsigned int i, m;
 460     unsigned int n;
 461     BN_ULONG l;
 462     BIGNUM *bn = NULL;
 463
 464     if (ret == NULL)
 465         ret = bn = BN_new();
 466     if (ret == NULL)
 467         return (NULL);
 468     bn_check_top(ret);
 469     /* Skip leading zero's. */
 470     for ( ; len > 0 && *s == 0; s++, len--)
 471         continue;
 472     n = len;
 473     if (n == 0) {
 474         ret->top = 0;
 475         return (ret);
 476     }
 477     i = ((n - 1) / BN_BYTES) + 1;
 478     m = ((n - 1) % (BN_BYTES));
 479     if (bn_wexpand(ret, (int)i) == NULL) {
 480         BN_free(bn);
 481         return NULL;
 482     }
 483     ret->top = i;
 484     ret->neg = 0;
 485     l = 0;
 486     while (n--) {
 487         l = (l << 8L) | *(s++);
 488         if (m-- == 0) {
 489             ret->d[--i] = l;
 490             l = 0;
 491             m = BN_BYTES - 1;
 492         }
 493     }
 494     /*
 495      * need to call this due to clear byte at top if avoiding having the top
 496      * bit set (-ve number)
 497      */
 498     bn_correct_top(ret);
 499     return (ret);
 500 }
 501
 502 /* ignore negative */
 503 static int bn2binpad(const BIGNUM *a, unsigned char *to, int tolen)
 504 {
 505     int n;
 506     size_t i, lasti, j, atop, mask;
 507     BN_ULONG l;
 508
 509     /*
 510      * In case |a| is fixed-top, BN_num_bytes can return bogus length,
 511      * but it's assumed that fixed-top inputs ought to be "nominated"
 512      * even for padded output, so it works out...
 513      */
 514     n = BN_num_bytes(a);
 515     if (tolen == -1) {
 516         tolen = n;
 517     } else if (tolen < n) {     /* uncommon/unlike case */
 518         BIGNUM temp = *a;
 519
 520         bn_correct_top(&temp);
 521         n = BN_num_bytes(&temp);
 522         if (tolen < n)
 523             return -1;
 524     }
 525
 526     /* Swipe through whole available data and don't give away padded zero. */
 527     atop = a->dmax * BN_BYTES;
 528     if (atop == 0) {
 529         OPENSSL_cleanse(to, tolen);
 530         return tolen;
 531     }
 532
 533     lasti = atop - 1;
 534     atop = a->top * BN_BYTES;
 535     for (i = 0, j = 0, to += tolen; j < (size_t)tolen; j++) {
 536         l = a->d[i / BN_BYTES];
 537         mask = 0 - ((j - atop) >> (8 * sizeof(i) - 1));
 538         *--to = (unsigned char)(l >> (8 * (i % BN_BYTES)) & mask);
 539         i += (i - lasti) >> (8 * sizeof(i) - 1); /* stay on last limb */
 540     }
 541
 542     return tolen;
 543 }
 544
 545 int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen)
 546 {
 547     if (tolen < 0)
 548         return -1;
 549     return bn2binpad(a, to, tolen);
 550 }
 551
 552 int BN_bn2bin(const BIGNUM *a, unsigned char *to)
 553 {
 554     return bn2binpad(a, to, -1);
 555 }
 556
 557 BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret)
 558 {
 559     unsigned int i, m;
 560     unsigned int n;
 561     BN_ULONG l;
 562     BIGNUM *bn = NULL;
 563
 564     if (ret == NULL)
 565         ret = bn = BN_new();
 566     if (ret == NULL)
 567         return (NULL);
 568     bn_check_top(ret);
 569     s += len;
 570     /* Skip trailing zeroes. */
 571     for ( ; len > 0 && s[-1] == 0; s--, len--)
 572         continue;
 573     n = len;
 574     if (n == 0) {
 575         ret->top = 0;
 576         return ret;
 577     }
 578     i = ((n - 1) / BN_BYTES) + 1;
 579     m = ((n - 1) % (BN_BYTES));
 580     if (bn_wexpand(ret, (int)i) == NULL) {
 581         BN_free(bn);
 582         return NULL;
 583     }
 584     ret->top = i;
 585     ret->neg = 0;
 586     l = 0;
 587     while (n--) {
 588         s--;
 589         l = (l << 8L) | *s;
 590         if (m-- == 0) {
 591             ret->d[--i] = l;
 592             l = 0;
 593             m = BN_BYTES - 1;
 594         }
 595     }
 596     /*
 597      * need to call this due to clear byte at top if avoiding having the top
 598      * bit set (-ve number)
 599      */
 600     bn_correct_top(ret);
 601     return ret;
 602 }
 603
 604 int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen)
 605 {
 606     int i;
 607     BN_ULONG l;
 608     bn_check_top(a);
 609     i = BN_num_bytes(a);
 610     if (tolen < i)
 611         return -1;
 612     /* Add trailing zeroes if necessary */
 613     if (tolen > i)
 614         memset(to + i, 0, tolen - i);
 615     to += i;
 616     while (i--) {
 617         l = a->d[i / BN_BYTES];
 618         to--;
 619         *to = (unsigned char)(l >> (8 * (i % BN_BYTES))) & 0xff;
 620     }
 621     return tolen;
 622 }
 623
 624 int BN_ucmp(const BIGNUM *a, const BIGNUM *b)
 625 {
 626     int i;
 627     BN_ULONG t1, t2, *ap, *bp;
 628
 629     bn_check_top(a);
 630     bn_check_top(b);
 631
 632     i = a->top - b->top;
 633     if (i != 0)
 634         return (i);
 635     ap = a->d;
 636     bp = b->d;
 637     for (i = a->top - 1; i >= 0; i--) {
 638         t1 = ap[i];
 639         t2 = bp[i];
 640         if (t1 != t2)
 641             return ((t1 > t2) ? 1 : -1);
 642     }
 643     return (0);
 644 }
 645
 646 int BN_cmp(const BIGNUM *a, const BIGNUM *b)
 647 {
 648     int i;
 649     int gt, lt;
 650     BN_ULONG t1, t2;
 651
 652     if ((a == NULL) || (b == NULL)) {
 653         if (a != NULL)
 654             return (-1);
 655         else if (b != NULL)
 656             return (1);
 657         else
 658             return (0);
 659     }
 660
 661     bn_check_top(a);
 662     bn_check_top(b);
 663
 664     if (a->neg != b->neg) {
 665         if (a->neg)
 666             return (-1);
 667         else
 668             return (1);
 669     }
 670     if (a->neg == 0) {
 671         gt = 1;
 672         lt = -1;
 673     } else {
 674         gt = -1;
 675         lt = 1;
 676     }
 677
 678     if (a->top > b->top)
 679         return (gt);
 680     if (a->top < b->top)
 681         return (lt);
 682     for (i = a->top - 1; i >= 0; i--) {
 683         t1 = a->d[i];
 684         t2 = b->d[i];
 685         if (t1 > t2)
 686             return (gt);
 687         if (t1 < t2)
 688             return (lt);
 689     }
 690     return (0);
 691 }
 692
 693 int BN_set_bit(BIGNUM *a, int n)
 694 {
 695     int i, j, k;
 696
 697     if (n < 0)
 698         return 0;
 699
 700     i = n / BN_BITS2;
 701     j = n % BN_BITS2;
 702     if (a->top <= i) {
 703         if (bn_wexpand(a, i + 1) == NULL)
 704             return (0);
 705         for (k = a->top; k < i + 1; k++)
 706             a->d[k] = 0;
 707         a->top = i + 1;
 708         a->flags &= ~BN_FLG_FIXED_TOP;
 709     }
 710
 711     a->d[i] |= (((BN_ULONG)1) << j);
 712     bn_check_top(a);
 713     return (1);
 714 }
 715
 716 int BN_clear_bit(BIGNUM *a, int n)
 717 {
 718     int i, j;
 719
 720     bn_check_top(a);
 721     if (n < 0)
 722         return 0;
 723
 724     i = n / BN_BITS2;
 725     j = n % BN_BITS2;
 726     if (a->top <= i)
 727         return (0);
 728
 729     a->d[i] &= (~(((BN_ULONG)1) << j));
 730     bn_correct_top(a);
 731     return (1);
 732 }
 733
 734 int BN_is_bit_set(const BIGNUM *a, int n)
 735 {
 736     int i, j;
 737
 738     bn_check_top(a);
 739     if (n < 0)
 740         return 0;
 741     i = n / BN_BITS2;
 742     j = n % BN_BITS2;
 743     if (a->top <= i)
 744         return 0;
 745     return (int)(((a->d[i]) >> j) & ((BN_ULONG)1));
 746 }
 747
 748 int BN_mask_bits(BIGNUM *a, int n)
 749 {
 750     int b, w;
 751
 752     bn_check_top(a);
 753     if (n < 0)
 754         return 0;
 755
 756     w = n / BN_BITS2;
 757     b = n % BN_BITS2;
 758     if (w >= a->top)
 759         return 0;
 760     if (b == 0)
 761         a->top = w;
 762     else {
 763         a->top = w + 1;
 764         a->d[w] &= ~(BN_MASK2 << b);
 765     }
 766     bn_correct_top(a);
 767     return (1);
 768 }
 769
 770 void BN_set_negative(BIGNUM *a, int b)
 771 {
 772     if (b && !BN_is_zero(a))
 773         a->neg = 1;
 774     else
 775         a->neg = 0;
 776 }
 777
 778 int bn_cmp_words(const BN_ULONG *a, const BN_ULONG *b, int n)
 779 {
 780     int i;
 781     BN_ULONG aa, bb;
 782
 783     aa = a[n - 1];
 784     bb = b[n - 1];
 785     if (aa != bb)
 786         return ((aa > bb) ? 1 : -1);
 787     for (i = n - 2; i >= 0; i--) {
 788         aa = a[i];
 789         bb = b[i];
 790         if (aa != bb)
 791             return ((aa > bb) ? 1 : -1);
 792     }
 793     return (0);
 794 }
 795
 796 /*
 797  * Here follows a specialised variants of bn_cmp_words().  It has the
 798  * capability of performing the operation on arrays of different sizes. The
 799  * sizes of those arrays is expressed through cl, which is the common length
 800  * ( basically, min(len(a),len(b)) ), and dl, which is the delta between the
 801  * two lengths, calculated as len(a)-len(b). All lengths are the number of
 802  * BN_ULONGs...
 803  */
 804
 805 int bn_cmp_part_words(const BN_ULONG *a, const BN_ULONG *b, int cl, int dl)
 806 {
 807     int n, i;
 808     n = cl - 1;
 809
 810     if (dl < 0) {
 811         for (i = dl; i < 0; i++) {
 812             if (b[n - i] != 0)
 813                 return -1;      /* a < b */
 814         }
 815     }
 816     if (dl > 0) {
 817         for (i = dl; i > 0; i--) {
 818             if (a[n + i] != 0)
 819                 return 1;       /* a > b */
 820         }
 821     }
 822     return bn_cmp_words(a, b, cl);
 823 }
 824
 825 /*
 826  * Constant-time conditional swap of a and b.
 827  * a and b are swapped if condition is not 0.  The code assumes that at most one bit of condition is set.
 828  * nwords is the number of words to swap.  The code assumes that at least nwords are allocated in both a and b,
 829  * and that no more than nwords are used by either a or b.
 830  * a and b cannot be the same number
 831  */
 832 void BN_consttime_swap(BN_ULONG condition, BIGNUM *a, BIGNUM *b, int nwords)
 833 {
 834     BN_ULONG t;
 835     int i;
 836
 837     bn_wcheck_size(a, nwords);
 838     bn_wcheck_size(b, nwords);
 839
 840     assert(a != b);
 841     assert((condition & (condition - 1)) == 0);
 842     assert(sizeof(BN_ULONG) >= sizeof(int));
 843
 844     condition = ((condition - 1) >> (BN_BITS2 - 1)) - 1;
 845
 846     t = (a->top ^ b->top) & condition;
 847     a->top ^= t;
 848     b->top ^= t;
 849
 850     t = (a->neg ^ b->neg) & condition;
 851     a->neg ^= t;
 852     b->neg ^= t;
 853
 854     /*-
 855      * BN_FLG_STATIC_DATA: indicates that data may not be written to. Intention
 856      * is actually to treat it as it's read-only data, and some (if not most)
 857      * of it does reside in read-only segment. In other words observation of
 858      * BN_FLG_STATIC_DATA in BN_consttime_swap should be treated as fatal
 859      * condition. It would either cause SEGV or effectively cause data
 860      * corruption.
 861      *
 862      * BN_FLG_MALLOCED: refers to BN structure itself, and hence must be
 863      * preserved.
 864      *
 865      * BN_FLG_SECURE: must be preserved, because it determines how x->d was
 866      * allocated and hence how to free it.
 867      *
 868      * BN_FLG_CONSTTIME: sufficient to mask and swap
 869      *
 870      * BN_FLG_FIXED_TOP: indicates that we haven't called bn_correct_top() on
 871      * the data, so the d array may be padded with additional 0 values (i.e.
 872      * top could be greater than the minimal value that it could be). We should
 873      * be swapping it
 874      */
 875
 876 #define BN_CONSTTIME_SWAP_FLAGS (BN_FLG_CONSTTIME | BN_FLG_FIXED_TOP)
 877
 878     t = ((a->flags ^ b->flags) & BN_CONSTTIME_SWAP_FLAGS) & condition;
 879     a->flags ^= t;
 880     b->flags ^= t;
 881
 882 #define BN_CONSTTIME_SWAP(ind) \
 883         do { \
 884                 t = (a->d[ind] ^ b->d[ind]) & condition; \
 885                 a->d[ind] ^= t; \
 886                 b->d[ind] ^= t; \
 887         } while (0)
 888
 889     switch (nwords) {
 890     default:
 891         for (i = 10; i < nwords; i++)
 892             BN_CONSTTIME_SWAP(i);
 893         /* Fallthrough */
 894     case 10:
 895         BN_CONSTTIME_SWAP(9);   /* Fallthrough */
 896     case 9:
 897         BN_CONSTTIME_SWAP(8);   /* Fallthrough */
 898     case 8:
 899         BN_CONSTTIME_SWAP(7);   /* Fallthrough */
 900     case 7:
 901         BN_CONSTTIME_SWAP(6);   /* Fallthrough */
 902     case 6:
 903         BN_CONSTTIME_SWAP(5);   /* Fallthrough */
 904     case 5:
 905         BN_CONSTTIME_SWAP(4);   /* Fallthrough */
 906     case 4:
 907         BN_CONSTTIME_SWAP(3);   /* Fallthrough */
 908     case 3:
 909         BN_CONSTTIME_SWAP(2);   /* Fallthrough */
 910     case 2:
 911         BN_CONSTTIME_SWAP(1);   /* Fallthrough */
 912     case 1:
 913         BN_CONSTTIME_SWAP(0);
 914     }
 915 #undef BN_CONSTTIME_SWAP
 916 }
 917
 918 /* Bits of security, see SP800-57 */
 919
 920 int BN_security_bits(int L, int N)
 921 {
 922     int secbits, bits;
 923     if (L >= 15360)
 924         secbits = 256;
 925     else if (L >= 7680)
 926         secbits = 192;
 927     else if (L >= 3072)
 928         secbits = 128;
 929     else if (L >= 2048)
 930         secbits = 112;
 931     else if (L >= 1024)
 932         secbits = 80;
 933     else
 934         return 0;
 935     if (N == -1)
 936         return secbits;
 937     bits = N / 2;
 938     if (bits < 80)
 939         return 0;
 940     return bits >= secbits ? secbits : bits;
 941 }
 942
 943 void BN_zero_ex(BIGNUM *a)
 944 {
 945     a->neg = 0;
 946     a->top = 0;
 947     a->flags &= ~BN_FLG_FIXED_TOP;
 948 }
 949
 950 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w)
 951 {
 952     return ((a->top == 1) && (a->d[0] == w)) || ((w == 0) && (a->top == 0));
 953 }
 954
 955 int BN_is_zero(const BIGNUM *a)
 956 {
 957     return a->top == 0;
 958 }
 959
 960 int BN_is_one(const BIGNUM *a)
 961 {
 962     return BN_abs_is_word(a, 1) && !a->neg;
 963 }
 964
 965 int BN_is_word(const BIGNUM *a, const BN_ULONG w)
 966 {
 967     return BN_abs_is_word(a, w) && (!w || !a->neg);
 968 }
 969
 970 int BN_is_odd(const BIGNUM *a)
 971 {
 972     return (a->top > 0) && (a->d[0] & 1);
 973 }
 974
 975 int BN_is_negative(const BIGNUM *a)
 976 {
 977     return (a->neg != 0);
 978 }
 979
 980 int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
 981                      BN_CTX *ctx)
 982 {
 983     return BN_mod_mul_montgomery(r, a, &(mont->RR), mont, ctx);
 984 }
 985
 986 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags)
 987 {
 988     dest->d = b->d;
 989     dest->top = b->top;
 990     dest->dmax = b->dmax;
 991     dest->neg = b->neg;
 992     dest->flags = ((dest->flags & BN_FLG_MALLOCED)
 993                    | (b->flags & ~BN_FLG_MALLOCED)
 994                    | BN_FLG_STATIC_DATA | flags);
 995 }
 996
 997 BN_GENCB *BN_GENCB_new(void)
 998 {
 999     BN_GENCB *ret;
1000
1001     if ((ret = OPENSSL_malloc(sizeof(*ret))) == NULL) {
1002         BNerr(BN_F_BN_GENCB_NEW, ERR_R_MALLOC_FAILURE);
1003         return (NULL);
1004     }
1005
1006     return ret;
1007 }
1008
1009 void BN_GENCB_free(BN_GENCB *cb)
1010 {
1011     if (cb == NULL)
1012         return;
1013     OPENSSL_free(cb);
1014 }
1015
1016 void BN_set_flags(BIGNUM *b, int n)
1017 {
1018     b->flags |= n;
1019 }
1020
1021 int BN_get_flags(const BIGNUM *b, int n)
1022 {
1023     return b->flags & n;
1024 }
1025
1026 /* Populate a BN_GENCB structure with an "old"-style callback */
1027 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
1028                       void *cb_arg)
1029 {
1030     BN_GENCB *tmp_gencb = gencb;
1031     tmp_gencb->ver = 1;
1032     tmp_gencb->arg = cb_arg;
1033     tmp_gencb->cb.cb_1 = callback;
1034 }
1035
1036 /* Populate a BN_GENCB structure with a "new"-style callback */
1037 void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
1038                   void *cb_arg)
1039 {
1040     BN_GENCB *tmp_gencb = gencb;
1041     tmp_gencb->ver = 2;
1042     tmp_gencb->arg = cb_arg;
1043     tmp_gencb->cb.cb_2 = callback;
1044 }
1045
1046 void *BN_GENCB_get_arg(BN_GENCB *cb)
1047 {
1048     return cb->arg;
1049 }
1050
1051 BIGNUM *bn_wexpand(BIGNUM *a, int words)
1052 {
1053     return (words <= a->dmax) ? a : bn_expand2(a, words);
1054 }
1055
1056 void bn_correct_top(BIGNUM *a)
1057 {
1058     BN_ULONG *ftl;
1059     int tmp_top = a->top;
1060
1061     if (tmp_top > 0) {
1062         for (ftl = &(a->d[tmp_top]); tmp_top > 0; tmp_top--) {
1063             ftl--;
1064             if (*ftl != 0)
1065                 break;
1066         }
1067         a->top = tmp_top;
1068     }
1069     if (a->top == 0)
1070         a->neg = 0;
1071     a->flags &= ~BN_FLG_FIXED_TOP;
1072     bn_pollute(a);
1073 }