Coverage Report

Created: 2026-02-14 07:20

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl30/crypto/packet.c
Line
Count
Source
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
206k
#define DEFAULT_BUF_SIZE 256
15
16
int WPACKET_allocate_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
17
120M
{
18
120M
    if (!WPACKET_reserve_bytes(pkt, len, allocbytes))
19
98.0k
        return 0;
20
21
119M
    pkt->written += len;
22
119M
    pkt->curr += len;
23
119M
    return 1;
24
120M
}
25
26
int WPACKET_sub_allocate_bytes__(WPACKET *pkt, size_t len,
27
    unsigned char **allocbytes, size_t lenbytes)
28
35.2k
{
29
35.2k
    if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
30
35.2k
        || !WPACKET_allocate_bytes(pkt, len, allocbytes)
31
35.2k
        || !WPACKET_close(pkt))
32
0
        return 0;
33
34
35.2k
    return 1;
35
35.2k
}
36
37
125M
#define GETBUF(p) (((p)->staticbuf != NULL)         \
38
125M
        ? (p)->staticbuf                            \
39
125M
        : ((p)->buf != NULL                         \
40
23.3M
                  ? (unsigned char *)(p)->buf->data \
41
23.3M
                  : NULL))
42
43
int WPACKET_reserve_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
44
122M
{
45
    /* Internal API, so should not fail */
46
122M
    if (!ossl_assert(pkt->subs != NULL && len != 0))
47
0
        return 0;
48
49
122M
    if (pkt->maxsize - pkt->written < len)
50
98.0k
        return 0;
51
52
122M
    if (pkt->buf != NULL && (pkt->buf->length - pkt->written < len)) {
53
118k
        size_t newlen;
54
118k
        size_t reflen;
55
56
118k
        reflen = (len > pkt->buf->length) ? len : pkt->buf->length;
57
58
118k
        if (reflen > SIZE_MAX / 2) {
59
0
            newlen = SIZE_MAX;
60
118k
        } else {
61
118k
            newlen = reflen * 2;
62
118k
            if (newlen < DEFAULT_BUF_SIZE)
63
88.0k
                newlen = DEFAULT_BUF_SIZE;
64
118k
        }
65
118k
        if (BUF_MEM_grow(pkt->buf, newlen) == 0)
66
0
            return 0;
67
118k
    }
68
122M
    if (allocbytes != NULL) {
69
119M
        *allocbytes = WPACKET_get_curr(pkt);
70
119M
        if (pkt->endfirst && *allocbytes != NULL)
71
78.1k
            *allocbytes -= len;
72
119M
    }
73
74
122M
    return 1;
75
122M
}
76
77
int WPACKET_sub_reserve_bytes__(WPACKET *pkt, size_t len,
78
    unsigned char **allocbytes, size_t lenbytes)
79
9.70k
{
80
9.70k
    if (pkt->endfirst && lenbytes > 0)
81
0
        return 0;
82
83
9.70k
    if (!WPACKET_reserve_bytes(pkt, lenbytes + len, allocbytes))
84
0
        return 0;
85
86
9.70k
    if (*allocbytes != NULL)
87
9.70k
        *allocbytes += lenbytes;
88
89
9.70k
    return 1;
90
9.70k
}
91
92
static size_t maxmaxsize(size_t lenbytes)
93
22.4M
{
94
22.4M
    if (lenbytes >= sizeof(size_t) || lenbytes == 0)
95
22.4M
        return SIZE_MAX;
96
97
0
    return ((size_t)1 << (lenbytes * 8)) - 1 + lenbytes;
98
22.4M
}
99
100
static int wpacket_intern_init_len(WPACKET *pkt, size_t lenbytes)
101
14.2M
{
102
14.2M
    unsigned char *lenchars;
103
104
14.2M
    pkt->curr = 0;
105
14.2M
    pkt->written = 0;
106
107
14.2M
    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
14.2M
    if (lenbytes == 0)
113
14.2M
        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
13.3M
{
131
13.3M
    size_t max = maxmaxsize(lenbytes);
132
133
    /* Internal API, so should not fail */
134
13.3M
    if (!ossl_assert(buf != NULL && len > 0))
135
0
        return 0;
136
137
13.3M
    pkt->staticbuf = buf;
138
13.3M
    pkt->buf = NULL;
139
13.3M
    pkt->maxsize = (max < len) ? max : len;
140
13.3M
    pkt->endfirst = 0;
141
142
13.3M
    return wpacket_intern_init_len(pkt, lenbytes);
143
13.3M
}
144
145
int WPACKET_init_der(WPACKET *pkt, unsigned char *buf, size_t len)
146
25.9k
{
147
    /* Internal API, so should not fail */
148
25.9k
    if (!ossl_assert(buf != NULL && len > 0))
149
0
        return 0;
150
151
25.9k
    pkt->staticbuf = buf;
152
25.9k
    pkt->buf = NULL;
153
25.9k
    pkt->maxsize = len;
154
25.9k
    pkt->endfirst = 1;
155
156
25.9k
    return wpacket_intern_init_len(pkt, 0);
157
25.9k
}
158
159
int WPACKET_init_len(WPACKET *pkt, BUF_MEM *buf, size_t lenbytes)
160
346k
{
161
    /* Internal API, so should not fail */
162
346k
    if (!ossl_assert(buf != NULL))
163
0
        return 0;
164
165
346k
    pkt->staticbuf = NULL;
166
346k
    pkt->buf = buf;
167
346k
    pkt->maxsize = maxmaxsize(lenbytes);
168
346k
    pkt->endfirst = 0;
169
170
346k
    return wpacket_intern_init_len(pkt, lenbytes);
171
346k
}
172
173
int WPACKET_init(WPACKET *pkt, BUF_MEM *buf)
174
341k
{
175
341k
    return WPACKET_init_len(pkt, buf, 0);
176
341k
}
177
178
int WPACKET_init_null(WPACKET *pkt, size_t lenbytes)
179
566k
{
180
566k
    pkt->staticbuf = NULL;
181
566k
    pkt->buf = NULL;
182
566k
    pkt->maxsize = maxmaxsize(lenbytes);
183
566k
    pkt->endfirst = 0;
184
185
566k
    return wpacket_intern_init_len(pkt, 0);
186
566k
}
187
188
int WPACKET_init_null_der(WPACKET *pkt)
189
46
{
190
46
    pkt->staticbuf = NULL;
191
46
    pkt->buf = NULL;
192
46
    pkt->maxsize = SIZE_MAX;
193
46
    pkt->endfirst = 1;
194
195
46
    return wpacket_intern_init_len(pkt, 0);
196
46
}
197
198
int WPACKET_set_flags(WPACKET *pkt, unsigned int flags)
199
264k
{
200
    /* Internal API, so should not fail */
201
264k
    if (!ossl_assert(pkt->subs != NULL))
202
0
        return 0;
203
204
264k
    pkt->subs->flags = flags;
205
206
264k
    return 1;
207
264k
}
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
34.6M
{
212
34.6M
    if (data == NULL)
213
3.39M
        return 1;
214
215
88.1M
    for (data += len - 1; len > 0; len--) {
216
56.9M
        *data = (unsigned char)(value & 0xff);
217
56.9M
        data--;
218
56.9M
        value >>= 8;
219
56.9M
    }
220
221
    /* Check whether we could fit the value in the assigned number of bytes */
222
31.2M
    if (value > 0)
223
568
        return 0;
224
225
31.2M
    return 1;
226
31.2M
}
227
228
/*
229
 * Internal helper function used by WPACKET_close(), WPACKET_finish() and
230
 * WPACKET_fill_lengths() to close a sub-packet and write out its length if
231
 * necessary. If |doclose| is 0 then it goes through the motions of closing
232
 * (i.e. it fills in all the lengths), but doesn't actually close anything.
233
 */
234
static int wpacket_intern_close(WPACKET *pkt, WPACKET_SUB *sub, int doclose)
235
609k
{
236
609k
    size_t packlen = pkt->written - sub->pwritten;
237
238
609k
    if (packlen == 0
239
16.0k
        && (sub->flags & WPACKET_FLAGS_NON_ZERO_LENGTH) != 0)
240
0
        return 0;
241
242
609k
    if (packlen == 0
243
16.0k
        && sub->flags & WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH) {
244
        /* We can't handle this case. Return an error */
245
1.43k
        if (!doclose)
246
0
            return 0;
247
248
        /* Deallocate any bytes allocated for the length of the WPACKET */
249
1.43k
        if ((pkt->curr - sub->lenbytes) == sub->packet_len) {
250
1.43k
            pkt->written -= sub->lenbytes;
251
1.43k
            pkt->curr -= sub->lenbytes;
252
1.43k
        }
253
254
        /* Don't write out the packet length */
255
1.43k
        sub->packet_len = 0;
256
1.43k
        sub->lenbytes = 0;
257
1.43k
    }
258
259
    /* Write out the WPACKET length if needed */
260
609k
    if (sub->lenbytes > 0) {
261
216k
        unsigned char *buf = GETBUF(pkt);
262
263
216k
        if (buf != NULL
264
216k
            && !put_value(&buf[sub->packet_len], packlen,
265
216k
                sub->lenbytes))
266
118
            return 0;
267
392k
    } else if (pkt->endfirst && sub->parent != NULL
268
3.60k
        && (packlen != 0
269
2
            || (sub->flags
270
2
                   & WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH)
271
3.60k
                == 0)) {
272
3.60k
        size_t tmplen = packlen;
273
3.60k
        size_t numlenbytes = 1;
274
275
3.60k
        while ((tmplen = tmplen >> 8) > 0)
276
0
            numlenbytes++;
277
3.60k
        if (!WPACKET_put_bytes__(pkt, packlen, numlenbytes))
278
0
            return 0;
279
3.60k
        if (packlen > 0x7f) {
280
0
            numlenbytes |= 0x80;
281
0
            if (!WPACKET_put_bytes_u8(pkt, numlenbytes))
282
0
                return 0;
283
0
        }
284
3.60k
    }
285
286
608k
    if (doclose) {
287
608k
        pkt->subs = sub->parent;
288
608k
        OPENSSL_free(sub);
289
608k
    }
290
291
608k
    return 1;
292
609k
}
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
7.66M
{
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
7.66M
    if (pkt->subs == NULL || pkt->subs->parent == NULL)
316
0
        return 0;
317
318
7.66M
    return wpacket_intern_close(pkt, pkt->subs, 1);
319
7.66M
}
320
321
int WPACKET_finish(WPACKET *pkt)
322
13.9M
{
323
13.9M
    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
13.9M
    if (pkt->subs == NULL || pkt->subs->parent != NULL)
330
0
        return 0;
331
332
13.9M
    ret = wpacket_intern_close(pkt, pkt->subs, 1);
333
13.9M
    if (ret) {
334
13.9M
        OPENSSL_free(pkt->subs);
335
13.9M
        pkt->subs = NULL;
336
13.9M
    }
337
338
13.9M
    return ret;
339
13.9M
}
340
341
int WPACKET_start_sub_packet_len__(WPACKET *pkt, size_t lenbytes)
342
7.67M
{
343
7.67M
    WPACKET_SUB *sub;
344
7.67M
    unsigned char *lenchars;
345
346
    /* Internal API, so should not fail */
347
7.67M
    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
7.67M
    if (lenbytes > 0 && pkt->endfirst)
352
0
        return 0;
353
354
7.67M
    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
7.67M
    sub->parent = pkt->subs;
360
7.67M
    pkt->subs = sub;
361
7.67M
    sub->pwritten = pkt->written + lenbytes;
362
7.67M
    sub->lenbytes = lenbytes;
363
364
7.67M
    if (lenbytes == 0) {
365
1.82M
        sub->packet_len = 0;
366
1.82M
        return 1;
367
1.82M
    }
368
369
5.84M
    sub->packet_len = pkt->written;
370
371
5.84M
    if (!WPACKET_allocate_bytes(pkt, lenbytes, &lenchars))
372
0
        return 0;
373
374
5.84M
    return 1;
375
5.84M
}
376
377
int WPACKET_start_sub_packet(WPACKET *pkt)
378
1.82M
{
379
1.82M
    return WPACKET_start_sub_packet_len__(pkt, 0);
380
1.82M
}
381
382
int WPACKET_put_bytes__(WPACKET *pkt, uint64_t val, size_t size)
383
28.8M
{
384
28.8M
    unsigned char *data;
385
386
    /* Internal API, so should not fail */
387
28.8M
    if (!ossl_assert(size <= sizeof(uint64_t))
388
28.8M
        || !WPACKET_allocate_bytes(pkt, size, &data)
389
28.7M
        || !put_value(data, val, size))
390
33.9k
        return 0;
391
392
28.7M
    return 1;
393
28.8M
}
394
395
int WPACKET_set_max_size(WPACKET *pkt, size_t maxsize)
396
8.15M
{
397
8.15M
    WPACKET_SUB *sub;
398
8.15M
    size_t lenbytes;
399
400
    /* Internal API, so should not fail */
401
8.15M
    if (!ossl_assert(pkt->subs != NULL))
402
0
        return 0;
403
404
    /* Find the WPACKET_SUB for the top level */
405
8.15M
    for (sub = pkt->subs; sub->parent != NULL; sub = sub->parent)
406
0
        continue;
407
408
8.15M
    lenbytes = sub->lenbytes;
409
8.15M
    if (lenbytes == 0)
410
8.15M
        lenbytes = sizeof(pkt->maxsize);
411
412
8.15M
    if (maxmaxsize(lenbytes) < maxsize || maxsize < pkt->written)
413
0
        return 0;
414
415
8.15M
    pkt->maxsize = maxsize;
416
417
8.15M
    return 1;
418
8.15M
}
419
420
int WPACKET_memset(WPACKET *pkt, int ch, size_t len)
421
1.38M
{
422
1.38M
    unsigned char *dest;
423
424
1.38M
    if (len == 0)
425
0
        return 1;
426
427
1.38M
    if (!WPACKET_allocate_bytes(pkt, len, &dest))
428
4
        return 0;
429
430
1.38M
    if (dest != NULL)
431
1.38M
        memset(dest, ch, len);
432
433
1.38M
    return 1;
434
1.38M
}
435
436
int WPACKET_memcpy(WPACKET *pkt, const void *src, size_t len)
437
14.5M
{
438
14.5M
    unsigned char *dest;
439
440
14.5M
    if (len == 0)
441
6.24M
        return 1;
442
443
8.32M
    if (!WPACKET_allocate_bytes(pkt, len, &dest))
444
62.9k
        return 0;
445
446
8.26M
    if (dest != NULL)
447
8.26M
        memcpy(dest, src, len);
448
449
8.26M
    return 1;
450
8.32M
}
451
452
int WPACKET_sub_memcpy__(WPACKET *pkt, const void *src, size_t len,
453
    size_t lenbytes)
454
1.89M
{
455
1.89M
    if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
456
1.89M
        || !WPACKET_memcpy(pkt, src, len)
457
1.89M
        || !WPACKET_close(pkt))
458
568
        return 0;
459
460
1.89M
    return 1;
461
1.89M
}
462
463
int WPACKET_get_total_written(WPACKET *pkt, size_t *written)
464
17.6M
{
465
    /* Internal API, so should not fail */
466
17.6M
    if (!ossl_assert(written != NULL))
467
0
        return 0;
468
469
17.6M
    *written = pkt->written;
470
471
17.6M
    return 1;
472
17.6M
}
473
474
int WPACKET_get_length(WPACKET *pkt, size_t *len)
475
1.87M
{
476
    /* Internal API, so should not fail */
477
1.87M
    if (!ossl_assert(pkt->subs != NULL && len != NULL))
478
0
        return 0;
479
480
1.87M
    *len = pkt->written - pkt->subs->pwritten;
481
482
1.87M
    return 1;
483
1.87M
}
484
485
unsigned char *WPACKET_get_curr(WPACKET *pkt)
486
124M
{
487
124M
    unsigned char *buf = GETBUF(pkt);
488
489
124M
    if (buf == NULL)
490
4.52M
        return NULL;
491
492
120M
    if (pkt->endfirst)
493
104k
        return buf + pkt->maxsize - pkt->curr;
494
495
120M
    return buf + pkt->curr;
496
120M
}
497
498
int WPACKET_is_null_buf(WPACKET *pkt)
499
565k
{
500
565k
    return pkt->buf == NULL && pkt->staticbuf == NULL;
501
565k
}
502
503
void WPACKET_cleanup(WPACKET *pkt)
504
702k
{
505
702k
    WPACKET_SUB *sub, *parent;
506
507
1.02M
    for (sub = pkt->subs; sub != NULL; sub = parent) {
508
322k
        parent = sub->parent;
509
322k
        OPENSSL_free(sub);
510
322k
    }
511
    pkt->subs = NULL;
512
702k
}