Coverage Report

Created: 2024-08-17 11:00

/src/mbedtls/library/asn1parse.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 *  Generic ASN.1 parsing
3
 *
4
 *  Copyright The Mbed TLS Contributors
5
 *  SPDX-License-Identifier: Apache-2.0
6
 *
7
 *  Licensed under the Apache License, Version 2.0 (the "License"); you may
8
 *  not use this file except in compliance with the License.
9
 *  You may obtain a copy of the License at
10
 *
11
 *  http://www.apache.org/licenses/LICENSE-2.0
12
 *
13
 *  Unless required by applicable law or agreed to in writing, software
14
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15
 *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 *  See the License for the specific language governing permissions and
17
 *  limitations under the License.
18
 */
19
20
#include "common.h"
21
22
#if defined(MBEDTLS_ASN1_PARSE_C)
23
24
#include "mbedtls/asn1.h"
25
#include "mbedtls/platform_util.h"
26
#include "mbedtls/error.h"
27
28
#include <string.h>
29
30
#if defined(MBEDTLS_BIGNUM_C)
31
#include "mbedtls/bignum.h"
32
#endif
33
34
#include "mbedtls/platform.h"
35
36
/*
37
 * ASN.1 DER decoding routines
38
 */
39
int mbedtls_asn1_get_len(unsigned char **p,
40
                         const unsigned char *end,
41
                         size_t *len)
42
118k
{
43
118k
    if ((end - *p) < 1) {
44
16
        return MBEDTLS_ERR_ASN1_OUT_OF_DATA;
45
16
    }
46
47
118k
    if ((**p & 0x80) == 0) {
48
103k
        *len = *(*p)++;
49
103k
    } else {
50
14.5k
        switch (**p & 0x7F) {
51
1.94k
            case 1:
52
1.94k
                if ((end - *p) < 2) {
53
3
                    return MBEDTLS_ERR_ASN1_OUT_OF_DATA;
54
3
                }
55
56
1.94k
                *len = (*p)[1];
57
1.94k
                (*p) += 2;
58
1.94k
                break;
59
60
12.5k
            case 2:
61
12.5k
                if ((end - *p) < 3) {
62
7
                    return MBEDTLS_ERR_ASN1_OUT_OF_DATA;
63
7
                }
64
65
12.5k
                *len = ((size_t) (*p)[1] << 8) | (*p)[2];
66
12.5k
                (*p) += 3;
67
12.5k
                break;
68
69
12
            case 3:
70
12
                if ((end - *p) < 4) {
71
6
                    return MBEDTLS_ERR_ASN1_OUT_OF_DATA;
72
6
                }
73
74
6
                *len = ((size_t) (*p)[1] << 16) |
75
6
                       ((size_t) (*p)[2] << 8) | (*p)[3];
76
6
                (*p) += 4;
77
6
                break;
78
79
13
            case 4:
80
13
                if ((end - *p) < 5) {
81
6
                    return MBEDTLS_ERR_ASN1_OUT_OF_DATA;
82
6
                }
83
84
7
                *len = ((size_t) (*p)[1] << 24) | ((size_t) (*p)[2] << 16) |
85
7
                       ((size_t) (*p)[3] << 8) |           (*p)[4];
86
7
                (*p) += 5;
87
7
                break;
88
89
41
            default:
90
41
                return MBEDTLS_ERR_ASN1_INVALID_LENGTH;
91
14.5k
        }
92
14.5k
    }
93
94
118k
    if (*len > (size_t) (end - *p)) {
95
49
        return MBEDTLS_ERR_ASN1_OUT_OF_DATA;
96
49
    }
97
98
118k
    return 0;
99
118k
}
100
101
int mbedtls_asn1_get_tag(unsigned char **p,
102
                         const unsigned char *end,
103
                         size_t *len, int tag)
104
102k
{
105
102k
    if ((end - *p) < 1) {
106
12
        return MBEDTLS_ERR_ASN1_OUT_OF_DATA;
107
12
    }
108
109
102k
    if (**p != tag) {
110
8.31k
        return MBEDTLS_ERR_ASN1_UNEXPECTED_TAG;
111
8.31k
    }
112
113
94.6k
    (*p)++;
114
115
94.6k
    return mbedtls_asn1_get_len(p, end, len);
116
102k
}
117
118
int mbedtls_asn1_get_bool(unsigned char **p,
119
                          const unsigned char *end,
120
                          int *val)
121
5.77k
{
122
5.77k
    int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
123
5.77k
    size_t len;
124
125
5.77k
    if ((ret = mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_BOOLEAN)) != 0) {
126
4.84k
        return ret;
127
4.84k
    }
128
129
925
    if (len != 1) {
130
5
        return MBEDTLS_ERR_ASN1_INVALID_LENGTH;
131
5
    }
132
133
920
    *val = (**p != 0) ? 1 : 0;
134
920
    (*p)++;
135
136
920
    return 0;
137
925
}
138
139
static int asn1_get_tagged_int(unsigned char **p,
140
                               const unsigned char *end,
141
                               int tag, int *val)
142
2.71k
{
143
2.71k
    int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
144
2.71k
    size_t len;
145
146
2.71k
    if ((ret = mbedtls_asn1_get_tag(p, end, &len, tag)) != 0) {
147
30
        return ret;
148
30
    }
149
150
    /*
151
     * len==0 is malformed (0 must be represented as 020100 for INTEGER,
152
     * or 0A0100 for ENUMERATED tags
153
     */
154
2.68k
    if (len == 0) {
155
2
        return MBEDTLS_ERR_ASN1_INVALID_LENGTH;
156
2
    }
157
    /* This is a cryptography library. Reject negative integers. */
158
2.68k
    if ((**p & 0x80) != 0) {
159
2
        return MBEDTLS_ERR_ASN1_INVALID_LENGTH;
160
2
    }
161
162
    /* Skip leading zeros. */
163
2.69k
    while (len > 0 && **p == 0) {
164
12
        ++(*p);
165
12
        --len;
166
12
    }
167
168
    /* Reject integers that don't fit in an int. This code assumes that
169
     * the int type has no padding bit. */
170
2.68k
    if (len > sizeof(int)) {
171
5
        return MBEDTLS_ERR_ASN1_INVALID_LENGTH;
172
5
    }
173
2.67k
    if (len == sizeof(int) && (**p & 0x80) != 0) {
174
0
        return MBEDTLS_ERR_ASN1_INVALID_LENGTH;
175
0
    }
176
177
2.67k
    *val = 0;
178
5.34k
    while (len-- > 0) {
179
2.67k
        *val = (*val << 8) | **p;
180
2.67k
        (*p)++;
181
2.67k
    }
182
183
2.67k
    return 0;
184
2.67k
}
185
186
int mbedtls_asn1_get_int(unsigned char **p,
187
                         const unsigned char *end,
188
                         int *val)
189
2.71k
{
190
2.71k
    return asn1_get_tagged_int(p, end, MBEDTLS_ASN1_INTEGER, val);
191
2.71k
}
192
193
int mbedtls_asn1_get_enum(unsigned char **p,
194
                          const unsigned char *end,
195
                          int *val)
196
0
{
197
0
    return asn1_get_tagged_int(p, end, MBEDTLS_ASN1_ENUMERATED, val);
198
0
}
199
200
#if defined(MBEDTLS_BIGNUM_C)
201
int mbedtls_asn1_get_mpi(unsigned char **p,
202
                         const unsigned char *end,
203
                         mbedtls_mpi *X)
204
0
{
205
0
    int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
206
0
    size_t len;
207
208
0
    if ((ret = mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_INTEGER)) != 0) {
209
0
        return ret;
210
0
    }
211
212
0
    ret = mbedtls_mpi_read_binary(X, *p, len);
213
214
0
    *p += len;
215
216
0
    return ret;
217
0
}
218
#endif /* MBEDTLS_BIGNUM_C */
219
220
int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end,
221
                               mbedtls_asn1_bitstring *bs)
222
5
{
223
5
    int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
224
225
    /* Certificate type is a single byte bitstring */
226
5
    if ((ret = mbedtls_asn1_get_tag(p, end, &bs->len, MBEDTLS_ASN1_BIT_STRING)) != 0) {
227
3
        return ret;
228
3
    }
229
230
    /* Check length, subtract one for actual bit string length */
231
2
    if (bs->len < 1) {
232
1
        return MBEDTLS_ERR_ASN1_OUT_OF_DATA;
233
1
    }
234
1
    bs->len -= 1;
235
236
    /* Get number of unused bits, ensure unused bits <= 7 */
237
1
    bs->unused_bits = **p;
238
1
    if (bs->unused_bits > 7) {
239
1
        return MBEDTLS_ERR_ASN1_INVALID_LENGTH;
240
1
    }
241
0
    (*p)++;
242
243
    /* Get actual bitstring */
244
0
    bs->p = *p;
245
0
    *p += bs->len;
246
247
0
    if (*p != end) {
248
0
        return MBEDTLS_ERR_ASN1_LENGTH_MISMATCH;
249
0
    }
250
251
0
    return 0;
252
0
}
253
254
/*
255
 * Traverse an ASN.1 "SEQUENCE OF <tag>"
256
 * and call a callback for each entry found.
257
 */
258
int mbedtls_asn1_traverse_sequence_of(
259
    unsigned char **p,
260
    const unsigned char *end,
261
    unsigned char tag_must_mask, unsigned char tag_must_val,
262
    unsigned char tag_may_mask, unsigned char tag_may_val,
263
    int (*cb)(void *ctx, int tag,
264
              unsigned char *start, size_t len),
265
    void *ctx)
266
13
{
267
13
    int ret;
268
13
    size_t len;
269
270
    /* Get main sequence tag */
271
13
    if ((ret = mbedtls_asn1_get_tag(p, end, &len,
272
13
                                    MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
273
7
        return ret;
274
7
    }
275
276
6
    if (*p + len != end) {
277
2
        return MBEDTLS_ERR_ASN1_LENGTH_MISMATCH;
278
2
    }
279
280
4
    while (*p < end) {
281
2
        unsigned char const tag = *(*p)++;
282
283
2
        if ((tag & tag_must_mask) != tag_must_val) {
284
2
            return MBEDTLS_ERR_ASN1_UNEXPECTED_TAG;
285
2
        }
286
287
0
        if ((ret = mbedtls_asn1_get_len(p, end, &len)) != 0) {
288
0
            return ret;
289
0
        }
290
291
0
        if ((tag & tag_may_mask) == tag_may_val) {
292
0
            if (cb != NULL) {
293
0
                ret = cb(ctx, tag, *p, len);
294
0
                if (ret != 0) {
295
0
                    return ret;
296
0
                }
297
0
            }
298
0
        }
299
300
0
        *p += len;
301
0
    }
302
303
2
    return 0;
304
4
}
305
306
/*
307
 * Get a bit string without unused bits
308
 */
309
int mbedtls_asn1_get_bitstring_null(unsigned char **p, const unsigned char *end,
310
                                    size_t *len)
311
3.40k
{
312
3.40k
    int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
313
314
3.40k
    if ((ret = mbedtls_asn1_get_tag(p, end, len, MBEDTLS_ASN1_BIT_STRING)) != 0) {
315
9
        return ret;
316
9
    }
317
318
3.39k
    if (*len == 0) {
319
2
        return MBEDTLS_ERR_ASN1_INVALID_DATA;
320
2
    }
321
3.39k
    --(*len);
322
323
3.39k
    if (**p != 0) {
324
2
        return MBEDTLS_ERR_ASN1_INVALID_DATA;
325
2
    }
326
3.39k
    ++(*p);
327
328
3.39k
    return 0;
329
3.39k
}
330
331
void mbedtls_asn1_sequence_free(mbedtls_asn1_sequence *seq)
332
9.05k
{
333
9.06k
    while (seq != NULL) {
334
13
        mbedtls_asn1_sequence *next = seq->next;
335
13
        mbedtls_free(seq);
336
13
        seq = next;
337
13
    }
338
9.05k
}
339
340
typedef struct {
341
    int tag;
342
    mbedtls_asn1_sequence *cur;
343
} asn1_get_sequence_of_cb_ctx_t;
344
345
static int asn1_get_sequence_of_cb(void *ctx,
346
                                   int tag,
347
                                   unsigned char *start,
348
                                   size_t len)
349
0
{
350
0
    asn1_get_sequence_of_cb_ctx_t *cb_ctx =
351
0
        (asn1_get_sequence_of_cb_ctx_t *) ctx;
352
0
    mbedtls_asn1_sequence *cur =
353
0
        cb_ctx->cur;
354
355
0
    if (cur->buf.p != NULL) {
356
0
        cur->next =
357
0
            mbedtls_calloc(1, sizeof(mbedtls_asn1_sequence));
358
359
0
        if (cur->next == NULL) {
360
0
            return MBEDTLS_ERR_ASN1_ALLOC_FAILED;
361
0
        }
362
363
0
        cur = cur->next;
364
0
    }
365
366
0
    cur->buf.p = start;
367
0
    cur->buf.len = len;
368
0
    cur->buf.tag = tag;
369
370
0
    cb_ctx->cur = cur;
371
0
    return 0;
372
0
}
373
374
/*
375
 *  Parses and splits an ASN.1 "SEQUENCE OF <tag>"
376
 */
377
int mbedtls_asn1_get_sequence_of(unsigned char **p,
378
                                 const unsigned char *end,
379
                                 mbedtls_asn1_sequence *cur,
380
                                 int tag)
381
13
{
382
13
    asn1_get_sequence_of_cb_ctx_t cb_ctx = { tag, cur };
383
13
    memset(cur, 0, sizeof(mbedtls_asn1_sequence));
384
13
    return mbedtls_asn1_traverse_sequence_of(
385
13
        p, end, 0xFF, tag, 0, 0,
386
13
        asn1_get_sequence_of_cb, &cb_ctx);
387
13
}
388
389
int mbedtls_asn1_get_alg(unsigned char **p,
390
                         const unsigned char *end,
391
                         mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params)
392
6.11k
{
393
6.11k
    int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
394
6.11k
    size_t len;
395
396
6.11k
    if ((ret = mbedtls_asn1_get_tag(p, end, &len,
397
6.11k
                                    MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
398
23
        return ret;
399
23
    }
400
401
6.09k
    if ((end - *p) < 1) {
402
0
        return MBEDTLS_ERR_ASN1_OUT_OF_DATA;
403
0
    }
404
405
6.09k
    alg->tag = **p;
406
6.09k
    end = *p + len;
407
408
6.09k
    if ((ret = mbedtls_asn1_get_tag(p, end, &alg->len, MBEDTLS_ASN1_OID)) != 0) {
409
13
        return ret;
410
13
    }
411
412
6.08k
    alg->p = *p;
413
6.08k
    *p += alg->len;
414
415
6.08k
    if (*p == end) {
416
744
        mbedtls_platform_zeroize(params, sizeof(mbedtls_asn1_buf));
417
744
        return 0;
418
744
    }
419
420
5.33k
    params->tag = **p;
421
5.33k
    (*p)++;
422
423
5.33k
    if ((ret = mbedtls_asn1_get_len(p, end, &params->len)) != 0) {
424
10
        return ret;
425
10
    }
426
427
5.32k
    params->p = *p;
428
5.32k
    *p += params->len;
429
430
5.32k
    if (*p != end) {
431
2
        return MBEDTLS_ERR_ASN1_LENGTH_MISMATCH;
432
2
    }
433
434
5.32k
    return 0;
435
5.32k
}
436
437
int mbedtls_asn1_get_alg_null(unsigned char **p,
438
                              const unsigned char *end,
439
                              mbedtls_asn1_buf *alg)
440
0
{
441
0
    int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
442
0
    mbedtls_asn1_buf params;
443
444
0
    memset(&params, 0, sizeof(mbedtls_asn1_buf));
445
446
0
    if ((ret = mbedtls_asn1_get_alg(p, end, alg, &params)) != 0) {
447
0
        return ret;
448
0
    }
449
450
0
    if ((params.tag != MBEDTLS_ASN1_NULL && params.tag != 0) || params.len != 0) {
451
0
        return MBEDTLS_ERR_ASN1_INVALID_DATA;
452
0
    }
453
454
0
    return 0;
455
0
}
456
457
#if !defined(MBEDTLS_DEPRECATED_REMOVED)
458
void mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *cur)
459
0
{
460
0
    if (cur == NULL) {
461
0
        return;
462
0
    }
463
464
0
    mbedtls_free(cur->oid.p);
465
0
    mbedtls_free(cur->val.p);
466
467
0
    mbedtls_platform_zeroize(cur, sizeof(mbedtls_asn1_named_data));
468
0
}
469
#endif /* MBEDTLS_DEPRECATED_REMOVED */
470
471
void mbedtls_asn1_free_named_data_list(mbedtls_asn1_named_data **head)
472
0
{
473
0
    mbedtls_asn1_named_data *cur;
474
475
0
    while ((cur = *head) != NULL) {
476
0
        *head = cur->next;
477
0
        mbedtls_free(cur->oid.p);
478
0
        mbedtls_free(cur->val.p);
479
0
        mbedtls_free(cur);
480
0
    }
481
0
}
482
483
void mbedtls_asn1_free_named_data_list_shallow(mbedtls_asn1_named_data *name)
484
6.08k
{
485
13.9k
    for (mbedtls_asn1_named_data *next; name != NULL; name = next) {
486
7.81k
        next = name->next;
487
7.81k
        mbedtls_free(name);
488
7.81k
    }
489
6.08k
}
490
491
const mbedtls_asn1_named_data *mbedtls_asn1_find_named_data(const mbedtls_asn1_named_data *list,
492
                                                            const char *oid, size_t len)
493
0
{
494
0
    while (list != NULL) {
495
0
        if (list->oid.len == len &&
496
0
            memcmp(list->oid.p, oid, len) == 0) {
497
0
            break;
498
0
        }
499
500
0
        list = list->next;
501
0
    }
502
503
0
    return list;
504
0
}
505
506
#endif /* MBEDTLS_ASN1_PARSE_C */