Coverage Report

Created: 2023-09-25 06:41

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