Coverage Report

Created: 2025-06-13 06:58

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