crypto/asn1/a_int.c

   1 /*
   2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (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 <stdio.h>
  11 #include "internal/cryptlib.h"
  12 #include "internal/numbers.h"
  13 #include <limits.h>
  14 #include <openssl/asn1.h>
  15 #include <openssl/bn.h>
  16 #include "asn1_local.h"
  17
  18 ASN1_INTEGER *ASN1_INTEGER_dup(const ASN1_INTEGER *x)
  19 {
  20     return ASN1_STRING_dup(x);
  21 }
  22
  23 int ASN1_INTEGER_cmp(const ASN1_INTEGER *x, const ASN1_INTEGER *y)
  24 {
  25     int neg, ret;
  26     /* Compare signs */
  27     neg = x->type & V_ASN1_NEG;
  28     if (neg != (y->type & V_ASN1_NEG)) {
  29         if (neg)
  30             return -1;
  31         else
  32             return 1;
  33     }
  34
  35     ret = ASN1_STRING_cmp(x, y);
  36
  37     if (neg)
  38         return -ret;
  39     else
  40         return ret;
  41 }
  42
  43 /*-
  44  * This converts a big endian buffer and sign into its content encoding.
  45  * This is used for INTEGER and ENUMERATED types.
  46  * The internal representation is an ASN1_STRING whose data is a big endian
  47  * representation of the value, ignoring the sign. The sign is determined by
  48  * the type: if type & V_ASN1_NEG is true it is negative, otherwise positive.
  49  *
  50  * Positive integers are no problem: they are almost the same as the DER
  51  * encoding, except if the first byte is >= 0x80 we need to add a zero pad.
  52  *
  53  * Negative integers are a bit trickier...
  54  * The DER representation of negative integers is in 2s complement form.
  55  * The internal form is converted by complementing each octet and finally
  56  * adding one to the result. This can be done less messily with a little trick.
  57  * If the internal form has trailing zeroes then they will become FF by the
  58  * complement and 0 by the add one (due to carry) so just copy as many trailing
  59  * zeros to the destination as there are in the source. The carry will add one
  60  * to the last none zero octet: so complement this octet and add one and finally
  61  * complement any left over until you get to the start of the string.
  62  *
  63  * Padding is a little trickier too. If the first bytes is > 0x80 then we pad
  64  * with 0xff. However if the first byte is 0x80 and one of the following bytes
  65  * is non-zero we pad with 0xff. The reason for this distinction is that 0x80
  66  * followed by optional zeros isn't padded.
  67  */
  68
  69 /*
  70  * If |pad| is zero, the operation is effectively reduced to memcpy,
  71  * and if |pad| is 0xff, then it performs two's complement, ~dst + 1.
  72  * Note that in latter case sequence of zeros yields itself, and so
  73  * does 0x80 followed by any number of zeros. These properties are
  74  * used elsewhere below...
  75  */
  76 static void twos_complement(unsigned char *dst, const unsigned char *src,
  77                             size_t len, unsigned char pad)
  78 {
  79     unsigned int carry = pad & 1;
  80
  81     /* Begin at the end of the encoding */
  82     if (len != 0) {
  83         /*
  84          * if len == 0 then src/dst could be NULL, and this would be undefined
  85          * behaviour.
  86          */
  87         dst += len;
  88         src += len;
  89     }
  90     /* two's complement value: ~value + 1 */
  91     while (len-- != 0) {
  92         *(--dst) = (unsigned char)(carry += *(--src) ^ pad);
  93         carry >>= 8;
  94     }
  95 }
  96
  97 static size_t i2c_ibuf(const unsigned char *b, size_t blen, int neg,
  98                        unsigned char **pp)
  99 {
 100     unsigned int pad = 0;
 101     size_t ret, i;
 102     unsigned char *p, pb = 0;
 103
 104     if (b != NULL && blen) {
 105         ret = blen;
 106         i = b[0];
 107         if (!neg && (i > 127)) {
 108             pad = 1;
 109             pb = 0;
 110         } else if (neg) {
 111             pb = 0xFF;
 112             if (i > 128) {
 113                 pad = 1;
 114             } else if (i == 128) {
 115                 /*
 116                  * Special case [of minimal negative for given length]:
 117                  * if any other bytes non zero we pad, otherwise we don't.
 118                  */
 119                 for (pad = 0, i = 1; i < blen; i++)
 120                     pad |= b[i];
 121                 pb = pad != 0 ? 0xffU : 0;
 122                 pad = pb & 1;
 123             }
 124         }
 125         ret += pad;
 126     } else {
 127         ret = 1;
 128         blen = 0;   /* reduce '(b == NULL || blen == 0)' to '(blen == 0)' */
 129     }
 130
 131     if (pp == NULL || (p = *pp) == NULL)
 132         return ret;
 133
 134     /*
 135      * This magically handles all corner cases, such as '(b == NULL ||
 136      * blen == 0)', non-negative value, "negative" zero, 0x80 followed
 137      * by any number of zeros...
 138      */
 139     *p = pb;
 140     p += pad;       /* yes, p[0] can be written twice, but it's little
 141                      * price to pay for eliminated branches */
 142     twos_complement(p, b, blen, pb);
 143
 144     *pp += ret;
 145     return ret;
 146 }
 147
 148 /*
 149  * convert content octets into a big endian buffer. Returns the length
 150  * of buffer or 0 on error: for malformed INTEGER. If output buffer is
 151  * NULL just return length.
 152  */
 153
 154 static size_t c2i_ibuf(unsigned char *b, int *pneg,
 155                        const unsigned char *p, size_t plen)
 156 {
 157     int neg, pad;
 158     /* Zero content length is illegal */
 159     if (plen == 0) {
 160         ERR_raise(ERR_LIB_ASN1, ASN1_R_ILLEGAL_ZERO_CONTENT);
 161         return 0;
 162     }
 163     neg = p[0] & 0x80;
 164     if (pneg)
 165         *pneg = neg;
 166     /* Handle common case where length is 1 octet separately */
 167     if (plen == 1) {
 168         if (b != NULL) {
 169             if (neg)
 170                 b[0] = (p[0] ^ 0xFF) + 1;
 171             else
 172                 b[0] = p[0];
 173         }
 174         return 1;
 175     }
 176
 177     pad = 0;
 178     if (p[0] == 0) {
 179         pad = 1;
 180     } else if (p[0] == 0xFF) {
 181         size_t i;
 182
 183         /*
 184          * Special case [of "one less minimal negative" for given length]:
 185          * if any other bytes non zero it was padded, otherwise not.
 186          */
 187         for (pad = 0, i = 1; i < plen; i++)
 188             pad |= p[i];
 189         pad = pad != 0 ? 1 : 0;
 190     }
 191     /* reject illegal padding: first two octets MSB can't match */
 192     if (pad && (neg == (p[1] & 0x80))) {
 193         ERR_raise(ERR_LIB_ASN1, ASN1_R_ILLEGAL_PADDING);
 194         return 0;
 195     }
 196
 197     /* skip over pad */
 198     p += pad;
 199     plen -= pad;
 200
 201     if (b != NULL)
 202         twos_complement(b, p, plen, neg ? 0xffU : 0);
 203
 204     return plen;
 205 }
 206
 207 int i2c_ASN1_INTEGER(ASN1_INTEGER *a, unsigned char **pp)
 208 {
 209     return i2c_ibuf(a->data, a->length, a->type & V_ASN1_NEG, pp);
 210 }
 211
 212 /* Convert big endian buffer into uint64_t, return 0 on error */
 213 static int asn1_get_uint64(uint64_t *pr, const unsigned char *b, size_t blen)
 214 {
 215     size_t i;
 216     uint64_t r;
 217
 218     if (blen > sizeof(*pr)) {
 219         ERR_raise(ERR_LIB_ASN1, ASN1_R_TOO_LARGE);
 220         return 0;
 221     }
 222     if (b == NULL)
 223         return 0;
 224     for (r = 0, i = 0; i < blen; i++) {
 225         r <<= 8;
 226         r |= b[i];
 227     }
 228     *pr = r;
 229     return 1;
 230 }
 231
 232 /*
 233  * Write uint64_t to big endian buffer and return offset to first
 234  * written octet. In other words it returns offset in range from 0
 235  * to 7, with 0 denoting 8 written octets and 7 - one.
 236  */
 237 static size_t asn1_put_uint64(unsigned char b[sizeof(uint64_t)], uint64_t r)
 238 {
 239     size_t off = sizeof(uint64_t);
 240
 241     do {
 242         b[--off] = (unsigned char)r;
 243     } while (r >>= 8);
 244
 245     return off;
 246 }
 247
 248 /*
 249  * Absolute value of INT64_MIN: we can't just use -INT64_MIN as gcc produces
 250  * overflow warnings.
 251  */
 252 #define ABS_INT64_MIN ((uint64_t)INT64_MAX + (-(INT64_MIN + INT64_MAX)))
 253
 254 /* signed version of asn1_get_uint64 */
 255 static int asn1_get_int64(int64_t *pr, const unsigned char *b, size_t blen,
 256                           int neg)
 257 {
 258     uint64_t r;
 259     if (asn1_get_uint64(&r, b, blen) == 0)
 260         return 0;
 261     if (neg) {
 262         if (r <= INT64_MAX) {
 263             /* Most significant bit is guaranteed to be clear, negation
 264              * is guaranteed to be meaningful in platform-neutral sense. */
 265             *pr = -(int64_t)r;
 266         } else if (r == ABS_INT64_MIN) {
 267             /* This never happens if INT64_MAX == ABS_INT64_MIN, e.g.
 268              * on ones'-complement system. */
 269             *pr = (int64_t)(0 - r);
 270         } else {
 271             ERR_raise(ERR_LIB_ASN1, ASN1_R_TOO_SMALL);
 272             return 0;
 273         }
 274     } else {
 275         if (r <= INT64_MAX) {
 276             *pr = (int64_t)r;
 277         } else {
 278             ERR_raise(ERR_LIB_ASN1, ASN1_R_TOO_LARGE);
 279             return 0;
 280         }
 281     }
 282     return 1;
 283 }
 284
 285 /* Convert ASN1 INTEGER content octets to ASN1_INTEGER structure */
 286 ASN1_INTEGER *c2i_ASN1_INTEGER(ASN1_INTEGER **a, const unsigned char **pp,
 287                                long len)
 288 {
 289     ASN1_INTEGER *ret = NULL;
 290     size_t r;
 291     int neg;
 292
 293     r = c2i_ibuf(NULL, NULL, *pp, len);
 294
 295     if (r == 0)
 296         return NULL;
 297
 298     if ((a == NULL) || ((*a) == NULL)) {
 299         ret = ASN1_INTEGER_new();
 300         if (ret == NULL)
 301             return NULL;
 302         ret->type = V_ASN1_INTEGER;
 303     } else
 304         ret = *a;
 305
 306     if (ASN1_STRING_set(ret, NULL, r) == 0)
 307         goto err;
 308
 309     c2i_ibuf(ret->data, &neg, *pp, len);
 310
 311     if (neg)
 312         ret->type |= V_ASN1_NEG;
 313
 314     *pp += len;
 315     if (a != NULL)
 316         (*a) = ret;
 317     return ret;
 318  err:
 319     ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
 320     if ((a == NULL) || (*a != ret))
 321         ASN1_INTEGER_free(ret);
 322     return NULL;
 323 }
 324
 325 static int asn1_string_get_int64(int64_t *pr, const ASN1_STRING *a, int itype)
 326 {
 327     if (a == NULL) {
 328         ERR_raise(ERR_LIB_ASN1, ERR_R_PASSED_NULL_PARAMETER);
 329         return 0;
 330     }
 331     if ((a->type & ~V_ASN1_NEG) != itype) {
 332         ERR_raise(ERR_LIB_ASN1, ASN1_R_WRONG_INTEGER_TYPE);
 333         return 0;
 334     }
 335     return asn1_get_int64(pr, a->data, a->length, a->type & V_ASN1_NEG);
 336 }
 337
 338 static int asn1_string_set_int64(ASN1_STRING *a, int64_t r, int itype)
 339 {
 340     unsigned char tbuf[sizeof(r)];
 341     size_t off;
 342
 343     a->type = itype;
 344     if (r < 0) {
 345         /* Most obvious '-r' triggers undefined behaviour for most
 346          * common INT64_MIN. Even though below '0 - (uint64_t)r' can
 347          * appear two's-complement centric, it does produce correct/
 348          * expected result even on one's-complement. This is because
 349          * cast to unsigned has to change bit pattern... */
 350         off = asn1_put_uint64(tbuf, 0 - (uint64_t)r);
 351         a->type |= V_ASN1_NEG;
 352     } else {
 353         off = asn1_put_uint64(tbuf, r);
 354         a->type &= ~V_ASN1_NEG;
 355     }
 356     return ASN1_STRING_set(a, tbuf + off, sizeof(tbuf) - off);
 357 }
 358
 359 static int asn1_string_get_uint64(uint64_t *pr, const ASN1_STRING *a,
 360                                   int itype)
 361 {
 362     if (a == NULL) {
 363         ERR_raise(ERR_LIB_ASN1, ERR_R_PASSED_NULL_PARAMETER);
 364         return 0;
 365     }
 366     if ((a->type & ~V_ASN1_NEG) != itype) {
 367         ERR_raise(ERR_LIB_ASN1, ASN1_R_WRONG_INTEGER_TYPE);
 368         return 0;
 369     }
 370     if (a->type & V_ASN1_NEG) {
 371         ERR_raise(ERR_LIB_ASN1, ASN1_R_ILLEGAL_NEGATIVE_VALUE);
 372         return 0;
 373     }
 374     return asn1_get_uint64(pr, a->data, a->length);
 375 }
 376
 377 static int asn1_string_set_uint64(ASN1_STRING *a, uint64_t r, int itype)
 378 {
 379     unsigned char tbuf[sizeof(r)];
 380     size_t off;
 381
 382     a->type = itype;
 383     off = asn1_put_uint64(tbuf, r);
 384     return ASN1_STRING_set(a, tbuf + off, sizeof(tbuf) - off);
 385 }
 386
 387 /*
 388  * This is a version of d2i_ASN1_INTEGER that ignores the sign bit of ASN1
 389  * integers: some broken software can encode a positive INTEGER with its MSB
 390  * set as negative (it doesn't add a padding zero).
 391  */
 392
 393 ASN1_INTEGER *d2i_ASN1_UINTEGER(ASN1_INTEGER **a, const unsigned char **pp,
 394                                 long length)
 395 {
 396     ASN1_INTEGER *ret = NULL;
 397     const unsigned char *p;
 398     unsigned char *s;
 399     long len;
 400     int inf, tag, xclass;
 401     int i;
 402
 403     if ((a == NULL) || ((*a) == NULL)) {
 404         if ((ret = ASN1_INTEGER_new()) == NULL)
 405             return NULL;
 406         ret->type = V_ASN1_INTEGER;
 407     } else
 408         ret = (*a);
 409
 410     p = *pp;
 411     inf = ASN1_get_object(&p, &len, &tag, &xclass, length);
 412     if (inf & 0x80) {
 413         i = ASN1_R_BAD_OBJECT_HEADER;
 414         goto err;
 415     }
 416
 417     if (tag != V_ASN1_INTEGER) {
 418         i = ASN1_R_EXPECTING_AN_INTEGER;
 419         goto err;
 420     }
 421
 422     /*
 423      * We must OPENSSL_malloc stuff, even for 0 bytes otherwise it signifies
 424      * a missing NULL parameter.
 425      */
 426     s = OPENSSL_malloc((int)len + 1);
 427     if (s == NULL) {
 428         i = ERR_R_MALLOC_FAILURE;
 429         goto err;
 430     }
 431     ret->type = V_ASN1_INTEGER;
 432     if (len) {
 433         if ((*p == 0) && (len != 1)) {
 434             p++;
 435             len--;
 436         }
 437         memcpy(s, p, (int)len);
 438         p += len;
 439     }
 440
 441     OPENSSL_free(ret->data);
 442     ret->data = s;
 443     ret->length = (int)len;
 444     if (a != NULL)
 445         (*a) = ret;
 446     *pp = p;
 447     return ret;
 448  err:
 449     ERR_raise(ERR_LIB_ASN1, i);
 450     if ((a == NULL) || (*a != ret))
 451         ASN1_INTEGER_free(ret);
 452     return NULL;
 453 }
 454
 455 static ASN1_STRING *bn_to_asn1_string(const BIGNUM *bn, ASN1_STRING *ai,
 456                                       int atype)
 457 {
 458     ASN1_INTEGER *ret;
 459     int len;
 460
 461     if (ai == NULL) {
 462         ret = ASN1_STRING_type_new(atype);
 463     } else {
 464         ret = ai;
 465         ret->type = atype;
 466     }
 467
 468     if (ret == NULL) {
 469         ERR_raise(ERR_LIB_ASN1, ERR_R_NESTED_ASN1_ERROR);
 470         goto err;
 471     }
 472
 473     if (BN_is_negative(bn) && !BN_is_zero(bn))
 474         ret->type |= V_ASN1_NEG_INTEGER;
 475
 476     len = BN_num_bytes(bn);
 477
 478     if (len == 0)
 479         len = 1;
 480
 481     if (ASN1_STRING_set(ret, NULL, len) == 0) {
 482         ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
 483         goto err;
 484     }
 485
 486     /* Correct zero case */
 487     if (BN_is_zero(bn))
 488         ret->data[0] = 0;
 489     else
 490         len = BN_bn2bin(bn, ret->data);
 491     ret->length = len;
 492     return ret;
 493  err:
 494     if (ret != ai)
 495         ASN1_INTEGER_free(ret);
 496     return NULL;
 497 }
 498
 499 static BIGNUM *asn1_string_to_bn(const ASN1_INTEGER *ai, BIGNUM *bn,
 500                                  int itype)
 501 {
 502     BIGNUM *ret;
 503
 504     if ((ai->type & ~V_ASN1_NEG) != itype) {
 505         ERR_raise(ERR_LIB_ASN1, ASN1_R_WRONG_INTEGER_TYPE);
 506         return NULL;
 507     }
 508
 509     ret = BN_bin2bn(ai->data, ai->length, bn);
 510     if (ret == NULL) {
 511         ERR_raise(ERR_LIB_ASN1, ASN1_R_BN_LIB);
 512         return NULL;
 513     }
 514     if (ai->type & V_ASN1_NEG)
 515         BN_set_negative(ret, 1);
 516     return ret;
 517 }
 518
 519 int ASN1_INTEGER_get_int64(int64_t *pr, const ASN1_INTEGER *a)
 520 {
 521     return asn1_string_get_int64(pr, a, V_ASN1_INTEGER);
 522 }
 523
 524 int ASN1_INTEGER_set_int64(ASN1_INTEGER *a, int64_t r)
 525 {
 526     return asn1_string_set_int64(a, r, V_ASN1_INTEGER);
 527 }
 528
 529 int ASN1_INTEGER_get_uint64(uint64_t *pr, const ASN1_INTEGER *a)
 530 {
 531     return asn1_string_get_uint64(pr, a, V_ASN1_INTEGER);
 532 }
 533
 534 int ASN1_INTEGER_set_uint64(ASN1_INTEGER *a, uint64_t r)
 535 {
 536     return asn1_string_set_uint64(a, r, V_ASN1_INTEGER);
 537 }
 538
 539 int ASN1_INTEGER_set(ASN1_INTEGER *a, long v)
 540 {
 541     return ASN1_INTEGER_set_int64(a, v);
 542 }
 543
 544 long ASN1_INTEGER_get(const ASN1_INTEGER *a)
 545 {
 546     int i;
 547     int64_t r;
 548     if (a == NULL)
 549         return 0;
 550     i = ASN1_INTEGER_get_int64(&r, a);
 551     if (i == 0)
 552         return -1;
 553     if (r > LONG_MAX || r < LONG_MIN)
 554         return -1;
 555     return (long)r;
 556 }
 557
 558 ASN1_INTEGER *BN_to_ASN1_INTEGER(const BIGNUM *bn, ASN1_INTEGER *ai)
 559 {
 560     return bn_to_asn1_string(bn, ai, V_ASN1_INTEGER);
 561 }
 562
 563 BIGNUM *ASN1_INTEGER_to_BN(const ASN1_INTEGER *ai, BIGNUM *bn)
 564 {
 565     return asn1_string_to_bn(ai, bn, V_ASN1_INTEGER);
 566 }
 567
 568 int ASN1_ENUMERATED_get_int64(int64_t *pr, const ASN1_ENUMERATED *a)
 569 {
 570     return asn1_string_get_int64(pr, a, V_ASN1_ENUMERATED);
 571 }
 572
 573 int ASN1_ENUMERATED_set_int64(ASN1_ENUMERATED *a, int64_t r)
 574 {
 575     return asn1_string_set_int64(a, r, V_ASN1_ENUMERATED);
 576 }
 577
 578 int ASN1_ENUMERATED_set(ASN1_ENUMERATED *a, long v)
 579 {
 580     return ASN1_ENUMERATED_set_int64(a, v);
 581 }
 582
 583 long ASN1_ENUMERATED_get(const ASN1_ENUMERATED *a)
 584 {
 585     int i;
 586     int64_t r;
 587     if (a == NULL)
 588         return 0;
 589     if ((a->type & ~V_ASN1_NEG) != V_ASN1_ENUMERATED)
 590         return -1;
 591     if (a->length > (int)sizeof(long))
 592         return 0xffffffffL;
 593     i = ASN1_ENUMERATED_get_int64(&r, a);
 594     if (i == 0)
 595         return -1;
 596     if (r > LONG_MAX || r < LONG_MIN)
 597         return -1;
 598     return (long)r;
 599 }
 600
 601 ASN1_ENUMERATED *BN_to_ASN1_ENUMERATED(const BIGNUM *bn, ASN1_ENUMERATED *ai)
 602 {
 603     return bn_to_asn1_string(bn, ai, V_ASN1_ENUMERATED);
 604 }
 605
 606 BIGNUM *ASN1_ENUMERATED_to_BN(const ASN1_ENUMERATED *ai, BIGNUM *bn)
 607 {
 608     return asn1_string_to_bn(ai, bn, V_ASN1_ENUMERATED);
 609 }
 610
 611 /* Internal functions used by x_int64.c */
 612 int c2i_uint64_int(uint64_t *ret, int *neg, const unsigned char **pp, long len)
 613 {
 614     unsigned char buf[sizeof(uint64_t)];
 615     size_t buflen;
 616
 617     buflen = c2i_ibuf(NULL, NULL, *pp, len);
 618     if (buflen == 0)
 619         return 0;
 620     if (buflen > sizeof(uint64_t)) {
 621         ERR_raise(ERR_LIB_ASN1, ASN1_R_TOO_LARGE);
 622         return 0;
 623     }
 624     (void)c2i_ibuf(buf, neg, *pp, len);
 625     return asn1_get_uint64(ret, buf, buflen);
 626 }
 627
 628 int i2c_uint64_int(unsigned char *p, uint64_t r, int neg)
 629 {
 630     unsigned char buf[sizeof(uint64_t)];
 631     size_t off;
 632
 633     off = asn1_put_uint64(buf, r);
 634     return i2c_ibuf(buf + off, sizeof(buf) - off, neg, &p);
 635 }
 636