crypto/packet.c

   1 /*
   2  * Copyright 2015-2021 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 "internal/cryptlib.h"
  11 #include "internal/packet.h"
  12 #include <openssl/err.h>
  13
  14 #define DEFAULT_BUF_SIZE    256
  15
  16 int WPACKET_allocate_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
  17 {
  18     if (!WPACKET_reserve_bytes(pkt, len, allocbytes))
  19         return 0;
  20
  21     pkt->written += len;
  22     pkt->curr += len;
  23     return 1;
  24 }
  25
  26 int WPACKET_sub_allocate_bytes__(WPACKET *pkt, size_t len,
  27                                  unsigned char **allocbytes, size_t lenbytes)
  28 {
  29     if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
  30             || !WPACKET_allocate_bytes(pkt, len, allocbytes)
  31             || !WPACKET_close(pkt))
  32         return 0;
  33
  34     return 1;
  35 }
  36
  37 #define GETBUF(p)   (((p)->staticbuf != NULL) \
  38                      ? (p)->staticbuf \
  39                      : ((p)->buf != NULL \
  40                         ? (unsigned char *)(p)->buf->data \
  41                         : NULL))
  42
  43 int WPACKET_reserve_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
  44 {
  45     /* Internal API, so should not fail */
  46     if (!ossl_assert(pkt->subs != NULL && len != 0))
  47         return 0;
  48
  49     if (pkt->maxsize - pkt->written < len)
  50         return 0;
  51
  52     if (pkt->buf != NULL && (pkt->buf->length - pkt->written < len)) {
  53         size_t newlen;
  54         size_t reflen;
  55
  56         reflen = (len > pkt->buf->length) ? len : pkt->buf->length;
  57
  58         if (reflen > SIZE_MAX / 2) {
  59             newlen = SIZE_MAX;
  60         } else {
  61             newlen = reflen * 2;
  62             if (newlen < DEFAULT_BUF_SIZE)
  63                 newlen = DEFAULT_BUF_SIZE;
  64         }
  65         if (BUF_MEM_grow(pkt->buf, newlen) == 0)
  66             return 0;
  67     }
  68     if (allocbytes != NULL) {
  69         *allocbytes = WPACKET_get_curr(pkt);
  70         if (pkt->endfirst && *allocbytes != NULL)
  71             *allocbytes -= len;
  72     }
  73
  74     return 1;
  75 }
  76
  77 int WPACKET_sub_reserve_bytes__(WPACKET *pkt, size_t len,
  78                                 unsigned char **allocbytes, size_t lenbytes)
  79 {
  80     if (pkt->endfirst && lenbytes > 0)
  81         return 0;
  82
  83     if (!WPACKET_reserve_bytes(pkt, lenbytes + len, allocbytes))
  84         return 0;
  85
  86     if (*allocbytes != NULL)
  87         *allocbytes += lenbytes;
  88
  89     return 1;
  90 }
  91
  92 static size_t maxmaxsize(size_t lenbytes)
  93 {
  94     if (lenbytes >= sizeof(size_t) || lenbytes == 0)
  95         return SIZE_MAX;
  96
  97     return ((size_t)1 << (lenbytes * 8)) - 1 + lenbytes;
  98 }
  99
 100 static int wpacket_intern_init_len(WPACKET *pkt, size_t lenbytes)
 101 {
 102     unsigned char *lenchars;
 103
 104     pkt->curr = 0;
 105     pkt->written = 0;
 106
 107     if ((pkt->subs = OPENSSL_zalloc(sizeof(*pkt->subs))) == NULL)
 108         return 0;
 109
 110     if (lenbytes == 0)
 111         return 1;
 112
 113     pkt->subs->pwritten = lenbytes;
 114     pkt->subs->lenbytes = lenbytes;
 115
 116     if (!WPACKET_allocate_bytes(pkt, lenbytes, &lenchars)) {
 117         OPENSSL_free(pkt->subs);
 118         pkt->subs = NULL;
 119         return 0;
 120     }
 121     pkt->subs->packet_len = 0;
 122
 123     return 1;
 124 }
 125
 126 int WPACKET_init_static_len(WPACKET *pkt, unsigned char *buf, size_t len,
 127                             size_t lenbytes)
 128 {
 129     size_t max = maxmaxsize(lenbytes);
 130
 131     /* Internal API, so should not fail */
 132     if (!ossl_assert(buf != NULL && len > 0))
 133         return 0;
 134
 135     pkt->staticbuf = buf;
 136     pkt->buf = NULL;
 137     pkt->maxsize = (max < len) ? max : len;
 138     pkt->endfirst = 0;
 139
 140     return wpacket_intern_init_len(pkt, lenbytes);
 141 }
 142
 143 int WPACKET_init_der(WPACKET *pkt, unsigned char *buf, size_t len)
 144 {
 145     /* Internal API, so should not fail */
 146     if (!ossl_assert(buf != NULL && len > 0))
 147         return 0;
 148
 149     pkt->staticbuf = buf;
 150     pkt->buf = NULL;
 151     pkt->maxsize = len;
 152     pkt->endfirst = 1;
 153
 154     return wpacket_intern_init_len(pkt, 0);
 155 }
 156
 157 int WPACKET_init_len(WPACKET *pkt, BUF_MEM *buf, size_t lenbytes)
 158 {
 159     /* Internal API, so should not fail */
 160     if (!ossl_assert(buf != NULL))
 161         return 0;
 162
 163     pkt->staticbuf = NULL;
 164     pkt->buf = buf;
 165     pkt->maxsize = maxmaxsize(lenbytes);
 166     pkt->endfirst = 0;
 167
 168     return wpacket_intern_init_len(pkt, lenbytes);
 169 }
 170
 171 int WPACKET_init(WPACKET *pkt, BUF_MEM *buf)
 172 {
 173     return WPACKET_init_len(pkt, buf, 0);
 174 }
 175
 176 int WPACKET_init_null(WPACKET *pkt, size_t lenbytes)
 177 {
 178     pkt->staticbuf = NULL;
 179     pkt->buf = NULL;
 180     pkt->maxsize = maxmaxsize(lenbytes);
 181     pkt->endfirst = 0;
 182
 183     return wpacket_intern_init_len(pkt, 0);
 184 }
 185
 186 int WPACKET_init_null_der(WPACKET *pkt)
 187 {
 188     pkt->staticbuf = NULL;
 189     pkt->buf = NULL;
 190     pkt->maxsize = SIZE_MAX;
 191     pkt->endfirst = 1;
 192
 193     return wpacket_intern_init_len(pkt, 0);
 194 }
 195
 196 int WPACKET_set_flags(WPACKET *pkt, unsigned int flags)
 197 {
 198     /* Internal API, so should not fail */
 199     if (!ossl_assert(pkt->subs != NULL))
 200         return 0;
 201
 202     pkt->subs->flags = flags;
 203
 204     return 1;
 205 }
 206
 207 /* Store the |value| of length |len| at location |data| */
 208 static int put_value(unsigned char *data, uint64_t value, size_t len)
 209 {
 210     if (data == NULL)
 211         return 1;
 212
 213     for (data += len - 1; len > 0; len--) {
 214         *data = (unsigned char)(value & 0xff);
 215         data--;
 216         value >>= 8;
 217     }
 218
 219     /* Check whether we could fit the value in the assigned number of bytes */
 220     if (value > 0)
 221         return 0;
 222
 223     return 1;
 224 }
 225
 226 static int put_quic_value(unsigned char *data, size_t value, size_t len)
 227 {
 228     if (data == NULL)
 229         return 1;
 230
 231     /* Value too large for field. */
 232     if (ossl_quic_vlint_encode_len(value) > len)
 233         return 0;
 234
 235     ossl_quic_vlint_encode_n(data, value, len);
 236     return 1;
 237 }
 238
 239 /*
 240  * Internal helper function used by WPACKET_close(), WPACKET_finish() and
 241  * WPACKET_fill_lengths() to close a sub-packet and write out its length if
 242  * necessary. If |doclose| is 0 then it goes through the motions of closing
 243  * (i.e. it fills in all the lengths), but doesn't actually close anything.
 244  */
 245 static int wpacket_intern_close(WPACKET *pkt, WPACKET_SUB *sub, int doclose)
 246 {
 247     size_t packlen = pkt->written - sub->pwritten;
 248
 249     if (packlen == 0
 250             && (sub->flags & WPACKET_FLAGS_NON_ZERO_LENGTH) != 0)
 251         return 0;
 252
 253     if (packlen == 0
 254             && sub->flags & WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH) {
 255         /* We can't handle this case. Return an error */
 256         if (!doclose)
 257             return 0;
 258
 259         /* Deallocate any bytes allocated for the length of the WPACKET */
 260         if ((pkt->curr - sub->lenbytes) == sub->packet_len) {
 261             pkt->written -= sub->lenbytes;
 262             pkt->curr -= sub->lenbytes;
 263         }
 264
 265         /* Don't write out the packet length */
 266         sub->packet_len = 0;
 267         sub->lenbytes = 0;
 268     }
 269
 270     /* Write out the WPACKET length if needed */
 271     if (sub->lenbytes > 0) {
 272         unsigned char *buf = GETBUF(pkt);
 273
 274         if (buf != NULL) {
 275             if ((sub->flags & WPACKET_FLAGS_QUIC_VLINT) == 0) {
 276                 if (!put_value(&buf[sub->packet_len], packlen, sub->lenbytes))
 277                     return 0;
 278             } else {
 279                 if (!put_quic_value(&buf[sub->packet_len], packlen, sub->lenbytes))
 280                     return 0;
 281             }
 282         }
 283     } else if (pkt->endfirst && sub->parent != NULL
 284                && (packlen != 0
 285                    || (sub->flags
 286                        & WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH) == 0)) {
 287         size_t tmplen = packlen;
 288         size_t numlenbytes = 1;
 289
 290         while ((tmplen = tmplen >> 8) > 0)
 291             numlenbytes++;
 292         if (!WPACKET_put_bytes__(pkt, packlen, numlenbytes))
 293             return 0;
 294         if (packlen > 0x7f) {
 295             numlenbytes |= 0x80;
 296             if (!WPACKET_put_bytes_u8(pkt, numlenbytes))
 297                 return 0;
 298         }
 299     }
 300
 301     if (doclose) {
 302         pkt->subs = sub->parent;
 303         OPENSSL_free(sub);
 304     }
 305
 306     return 1;
 307 }
 308
 309 int WPACKET_fill_lengths(WPACKET *pkt)
 310 {
 311     WPACKET_SUB *sub;
 312
 313     if (!ossl_assert(pkt->subs != NULL))
 314         return 0;
 315
 316     for (sub = pkt->subs; sub != NULL; sub = sub->parent) {
 317         if (!wpacket_intern_close(pkt, sub, 0))
 318             return 0;
 319     }
 320
 321     return 1;
 322 }
 323
 324 int WPACKET_close(WPACKET *pkt)
 325 {
 326     /*
 327      * Internal API, so should not fail - but we do negative testing of this
 328      * so no assert (otherwise the tests fail)
 329      */
 330     if (pkt->subs == NULL || pkt->subs->parent == NULL)
 331         return 0;
 332
 333     return wpacket_intern_close(pkt, pkt->subs, 1);
 334 }
 335
 336 int WPACKET_finish(WPACKET *pkt)
 337 {
 338     int ret;
 339
 340     /*
 341      * Internal API, so should not fail - but we do negative testing of this
 342      * so no assert (otherwise the tests fail)
 343      */
 344     if (pkt->subs == NULL || pkt->subs->parent != NULL)
 345         return 0;
 346
 347     ret = wpacket_intern_close(pkt, pkt->subs, 1);
 348     if (ret) {
 349         OPENSSL_free(pkt->subs);
 350         pkt->subs = NULL;
 351     }
 352
 353     return ret;
 354 }
 355
 356 int WPACKET_start_sub_packet_len__(WPACKET *pkt, size_t lenbytes)
 357 {
 358     WPACKET_SUB *sub;
 359     unsigned char *lenchars;
 360
 361     /* Internal API, so should not fail */
 362     if (!ossl_assert(pkt->subs != NULL))
 363         return 0;
 364
 365     /* We don't support lenbytes greater than 0 when doing endfirst writing */
 366     if (lenbytes > 0 && pkt->endfirst)
 367         return 0;
 368
 369     if ((sub = OPENSSL_zalloc(sizeof(*sub))) == NULL)
 370         return 0;
 371
 372     sub->parent = pkt->subs;
 373     pkt->subs = sub;
 374     sub->pwritten = pkt->written + lenbytes;
 375     sub->lenbytes = lenbytes;
 376
 377     if (lenbytes == 0) {
 378         sub->packet_len = 0;
 379         return 1;
 380     }
 381
 382     sub->packet_len = pkt->written;
 383
 384     if (!WPACKET_allocate_bytes(pkt, lenbytes, &lenchars))
 385         return 0;
 386
 387     return 1;
 388 }
 389
 390 int WPACKET_start_sub_packet(WPACKET *pkt)
 391 {
 392     return WPACKET_start_sub_packet_len__(pkt, 0);
 393 }
 394
 395 int WPACKET_put_bytes__(WPACKET *pkt, uint64_t val, size_t size)
 396 {
 397     unsigned char *data;
 398
 399     /* Internal API, so should not fail */
 400     if (!ossl_assert(size <= sizeof(uint64_t))
 401             || !WPACKET_allocate_bytes(pkt, size, &data)
 402             || !put_value(data, val, size))
 403         return 0;
 404
 405     return 1;
 406 }
 407
 408 int WPACKET_set_max_size(WPACKET *pkt, size_t maxsize)
 409 {
 410     WPACKET_SUB *sub;
 411     size_t lenbytes;
 412
 413     /* Internal API, so should not fail */
 414     if (!ossl_assert(pkt->subs != NULL))
 415         return 0;
 416
 417     /* Find the WPACKET_SUB for the top level */
 418     for (sub = pkt->subs; sub->parent != NULL; sub = sub->parent)
 419         continue;
 420
 421     lenbytes = sub->lenbytes;
 422     if (lenbytes == 0)
 423         lenbytes = sizeof(pkt->maxsize);
 424
 425     if (maxmaxsize(lenbytes) < maxsize || maxsize < pkt->written)
 426         return 0;
 427
 428     pkt->maxsize = maxsize;
 429
 430     return 1;
 431 }
 432
 433 int WPACKET_memset(WPACKET *pkt, int ch, size_t len)
 434 {
 435     unsigned char *dest;
 436
 437     if (len == 0)
 438         return 1;
 439
 440     if (!WPACKET_allocate_bytes(pkt, len, &dest))
 441         return 0;
 442
 443     if (dest != NULL)
 444         memset(dest, ch, len);
 445
 446     return 1;
 447 }
 448
 449 int WPACKET_memcpy(WPACKET *pkt, const void *src, size_t len)
 450 {
 451     unsigned char *dest;
 452
 453     if (len == 0)
 454         return 1;
 455
 456     if (!WPACKET_allocate_bytes(pkt, len, &dest))
 457         return 0;
 458
 459     if (dest != NULL)
 460         memcpy(dest, src, len);
 461
 462     return 1;
 463 }
 464
 465 int WPACKET_sub_memcpy__(WPACKET *pkt, const void *src, size_t len,
 466                          size_t lenbytes)
 467 {
 468     if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
 469             || !WPACKET_memcpy(pkt, src, len)
 470             || !WPACKET_close(pkt))
 471         return 0;
 472
 473     return 1;
 474 }
 475
 476 int WPACKET_get_total_written(WPACKET *pkt, size_t *written)
 477 {
 478     /* Internal API, so should not fail */
 479     if (!ossl_assert(written != NULL))
 480         return 0;
 481
 482     *written = pkt->written;
 483
 484     return 1;
 485 }
 486
 487 int WPACKET_get_length(WPACKET *pkt, size_t *len)
 488 {
 489     /* Internal API, so should not fail */
 490     if (!ossl_assert(pkt->subs != NULL && len != NULL))
 491         return 0;
 492
 493     *len = pkt->written - pkt->subs->pwritten;
 494
 495     return 1;
 496 }
 497
 498 unsigned char *WPACKET_get_curr(WPACKET *pkt)
 499 {
 500     unsigned char *buf = GETBUF(pkt);
 501
 502     if (buf == NULL)
 503         return NULL;
 504
 505     if (pkt->endfirst)
 506         return buf + pkt->maxsize - pkt->curr;
 507
 508     return buf + pkt->curr;
 509 }
 510
 511 int WPACKET_is_null_buf(WPACKET *pkt)
 512 {
 513     return pkt->buf == NULL && pkt->staticbuf == NULL;
 514 }
 515
 516 void WPACKET_cleanup(WPACKET *pkt)
 517 {
 518     WPACKET_SUB *sub, *parent;
 519
 520     for (sub = pkt->subs; sub != NULL; sub = parent) {
 521         parent = sub->parent;
 522         OPENSSL_free(sub);
 523     }
 524     pkt->subs = NULL;
 525 }
 526
 527 int WPACKET_start_quic_sub_packet_bound(WPACKET *pkt, size_t max_len)
 528 {
 529     size_t enclen = ossl_quic_vlint_encode_len(max_len);
 530
 531     if (enclen == 0)
 532         return 0;
 533
 534     if (WPACKET_start_sub_packet_len__(pkt, enclen) == 0)
 535         return 0;
 536
 537     pkt->subs->flags |= WPACKET_FLAGS_QUIC_VLINT;
 538     return 1;
 539 }
 540
 541 int WPACKET_start_quic_sub_packet(WPACKET *pkt)
 542 {
 543     /*
 544      * Assume no (sub)packet will exceed 4GiB, thus the 8-byte encoding need not
 545      * be used.
 546      */
 547     return WPACKET_start_quic_sub_packet_bound(pkt, OSSL_QUIC_VLINT_4B_MIN);
 548 }
 549
 550 int WPACKET_quic_sub_allocate_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
 551 {
 552     if (!WPACKET_start_quic_sub_packet_bound(pkt, len)
 553             || !WPACKET_allocate_bytes(pkt, len, allocbytes)
 554             || !WPACKET_close(pkt))
 555         return 0;
 556
 557     return 1;
 558 }
 559
 560 /*
 561  * Write a QUIC variable-length integer to the packet.
 562  */
 563 int WPACKET_quic_write_vlint(WPACKET *pkt, uint64_t v)
 564 {
 565     unsigned char *b = NULL;
 566     size_t enclen = ossl_quic_vlint_encode_len(v);
 567
 568     if (enclen == 0)
 569         return 0;
 570
 571     if (WPACKET_allocate_bytes(pkt, enclen, &b) == 0)
 572         return 0;
 573
 574     ossl_quic_vlint_encode(b, v);
 575     return 1;
 576 }