Coverage Report

Created: 2025-06-13 06:56

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