Coverage Report

Created: 2025-12-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl30/crypto/asn1/tasn_prn.c
Line
Count
Source
1
/*
2
 * Copyright 2000-2021 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 <stddef.h>
11
#include "internal/cryptlib.h"
12
#include <openssl/asn1.h>
13
#include <openssl/asn1t.h>
14
#include <openssl/objects.h>
15
#include <openssl/buffer.h>
16
#include <openssl/err.h>
17
#include <openssl/x509v3.h>
18
#include "crypto/asn1.h"
19
#include "asn1_local.h"
20
21
/*
22
 * Print routines.
23
 */
24
25
/* ASN1_PCTX routines */
26
27
static ASN1_PCTX default_pctx = {
28
    ASN1_PCTX_FLAGS_SHOW_ABSENT, /* flags */
29
    0, /* nm_flags */
30
    0, /* cert_flags */
31
    0, /* oid_flags */
32
    0 /* str_flags */
33
};
34
35
ASN1_PCTX *ASN1_PCTX_new(void)
36
22
{
37
22
    ASN1_PCTX *ret;
38
39
22
    ret = OPENSSL_zalloc(sizeof(*ret));
40
22
    if (ret == NULL) {
41
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
42
0
        return NULL;
43
0
    }
44
22
    return ret;
45
22
}
46
47
void ASN1_PCTX_free(ASN1_PCTX *p)
48
0
{
49
0
    OPENSSL_free(p);
50
0
}
51
52
unsigned long ASN1_PCTX_get_flags(const ASN1_PCTX *p)
53
0
{
54
0
    return p->flags;
55
0
}
56
57
void ASN1_PCTX_set_flags(ASN1_PCTX *p, unsigned long flags)
58
22
{
59
22
    p->flags = flags;
60
22
}
61
62
unsigned long ASN1_PCTX_get_nm_flags(const ASN1_PCTX *p)
63
0
{
64
0
    return p->nm_flags;
65
0
}
66
67
void ASN1_PCTX_set_nm_flags(ASN1_PCTX *p, unsigned long flags)
68
0
{
69
0
    p->nm_flags = flags;
70
0
}
71
72
unsigned long ASN1_PCTX_get_cert_flags(const ASN1_PCTX *p)
73
0
{
74
0
    return p->cert_flags;
75
0
}
76
77
void ASN1_PCTX_set_cert_flags(ASN1_PCTX *p, unsigned long flags)
78
0
{
79
0
    p->cert_flags = flags;
80
0
}
81
82
unsigned long ASN1_PCTX_get_oid_flags(const ASN1_PCTX *p)
83
0
{
84
0
    return p->oid_flags;
85
0
}
86
87
void ASN1_PCTX_set_oid_flags(ASN1_PCTX *p, unsigned long flags)
88
0
{
89
0
    p->oid_flags = flags;
90
0
}
91
92
unsigned long ASN1_PCTX_get_str_flags(const ASN1_PCTX *p)
93
0
{
94
0
    return p->str_flags;
95
0
}
96
97
void ASN1_PCTX_set_str_flags(ASN1_PCTX *p, unsigned long flags)
98
22
{
99
22
    p->str_flags = flags;
100
22
}
101
102
/* Main print routines */
103
104
static int asn1_item_print_ctx(BIO *out, const ASN1_VALUE **fld, int indent,
105
    const ASN1_ITEM *it,
106
    const char *fname, const char *sname,
107
    int nohdr, const ASN1_PCTX *pctx);
108
109
static int asn1_template_print_ctx(BIO *out, const ASN1_VALUE **fld, int indent,
110
    const ASN1_TEMPLATE *tt, const ASN1_PCTX *pctx);
111
112
static int asn1_primitive_print(BIO *out, const ASN1_VALUE **fld,
113
    const ASN1_ITEM *it, int indent,
114
    const char *fname, const char *sname,
115
    const ASN1_PCTX *pctx);
116
117
static int asn1_print_fsname(BIO *out, int indent,
118
    const char *fname, const char *sname,
119
    const ASN1_PCTX *pctx);
120
121
int ASN1_item_print(BIO *out, const ASN1_VALUE *ifld, int indent,
122
    const ASN1_ITEM *it, const ASN1_PCTX *pctx)
123
378k
{
124
378k
    const char *sname;
125
378k
    if (pctx == NULL)
126
39.3k
        pctx = &default_pctx;
127
378k
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
128
0
        sname = NULL;
129
378k
    else
130
378k
        sname = it->sname;
131
378k
    return asn1_item_print_ctx(out, &ifld, indent, it, NULL, sname, 0, pctx);
132
378k
}
133
134
static int asn1_item_print_ctx(BIO *out, const ASN1_VALUE **fld, int indent,
135
    const ASN1_ITEM *it,
136
    const char *fname, const char *sname,
137
    int nohdr, const ASN1_PCTX *pctx)
138
7.35M
{
139
7.35M
    const ASN1_TEMPLATE *tt;
140
7.35M
    const ASN1_EXTERN_FUNCS *ef;
141
7.35M
    const ASN1_VALUE **tmpfld;
142
7.35M
    const ASN1_AUX *aux = it->funcs;
143
7.35M
    ASN1_aux_const_cb *asn1_cb = NULL;
144
7.35M
    ASN1_PRINT_ARG parg;
145
7.35M
    int i;
146
7.35M
    if (aux != NULL) {
147
739k
        parg.out = out;
148
739k
        parg.indent = indent;
149
739k
        parg.pctx = pctx;
150
739k
        asn1_cb = ((aux->flags & ASN1_AFLG_CONST_CB) != 0) ? aux->asn1_const_cb
151
739k
                                                           : (ASN1_aux_const_cb *)aux->asn1_cb; /* backward compatibility */
152
739k
    }
153
154
7.35M
    if (((it->itype != ASN1_ITYPE_PRIMITIVE)
155
5.35M
            || (it->utype != V_ASN1_BOOLEAN))
156
7.33M
        && *fld == NULL) {
157
1.83M
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_ABSENT) {
158
1.83M
            if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
159
0
                return 0;
160
1.83M
            if (BIO_puts(out, "<ABSENT>\n") <= 0)
161
0
                return 0;
162
1.83M
        }
163
1.83M
        return 1;
164
1.83M
    }
165
166
5.51M
    switch (it->itype) {
167
4.27M
    case ASN1_ITYPE_PRIMITIVE:
168
4.27M
        if (it->templates) {
169
98.6k
            if (!asn1_template_print_ctx(out, fld, indent,
170
98.6k
                    it->templates, pctx))
171
5.22k
                return 0;
172
93.4k
            break;
173
98.6k
        }
174
        /* fall through */
175
4.22M
    case ASN1_ITYPE_MSTRING:
176
4.22M
        if (!asn1_primitive_print(out, fld, it, indent, fname, sname, pctx))
177
37.3k
            return 0;
178
4.19M
        break;
179
180
4.19M
    case ASN1_ITYPE_EXTERN:
181
132k
        if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
182
0
            return 0;
183
        /* Use new style print routine if possible */
184
132k
        ef = it->funcs;
185
132k
        if (ef && ef->asn1_ex_print) {
186
132k
            i = ef->asn1_ex_print(out, fld, indent, "", pctx);
187
132k
            if (!i)
188
823
                return 0;
189
131k
            if ((i == 2) && (BIO_puts(out, "\n") <= 0))
190
0
                return 0;
191
131k
            return 1;
192
131k
        } else if (sname && BIO_printf(out, ":EXTERNAL TYPE %s\n", sname) <= 0)
193
0
            return 0;
194
0
        break;
195
196
207k
    case ASN1_ITYPE_CHOICE:
197
        /* CHOICE type, get selector */
198
207k
        i = ossl_asn1_get_choice_selector_const(fld, it);
199
        /* This should never happen... */
200
207k
        if ((i < 0) || (i >= it->tcount)) {
201
0
            if (BIO_printf(out, "ERROR: selector [%d] invalid\n", i) <= 0)
202
0
                return 0;
203
0
            return 1;
204
0
        }
205
207k
        tt = it->templates + i;
206
207k
        tmpfld = ossl_asn1_get_const_field_ptr(fld, tt);
207
207k
        if (!asn1_template_print_ctx(out, tmpfld, indent, tt, pctx))
208
12.3k
            return 0;
209
194k
        break;
210
211
834k
    case ASN1_ITYPE_SEQUENCE:
212
849k
    case ASN1_ITYPE_NDEF_SEQUENCE:
213
849k
        if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
214
0
            return 0;
215
849k
        if (fname || sname) {
216
503k
            if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
217
92.6k
                if (BIO_puts(out, " {\n") <= 0)
218
0
                    return 0;
219
410k
            } else {
220
410k
                if (BIO_puts(out, "\n") <= 0)
221
0
                    return 0;
222
410k
            }
223
503k
        }
224
225
849k
        if (asn1_cb) {
226
87.5k
            i = asn1_cb(ASN1_OP_PRINT_PRE, fld, it, &parg);
227
87.5k
            if (i == 0)
228
0
                return 0;
229
87.5k
            if (i == 2)
230
0
                return 1;
231
87.5k
        }
232
233
        /* Print each field entry */
234
4.38M
        for (i = 0, tt = it->templates; i < it->tcount; i++, tt++) {
235
3.59M
            const ASN1_TEMPLATE *seqtt;
236
3.59M
            seqtt = ossl_asn1_do_adb(*fld, tt, 1);
237
3.59M
            if (!seqtt)
238
0
                return 0;
239
3.59M
            tmpfld = ossl_asn1_get_const_field_ptr(fld, seqtt);
240
3.59M
            if (!asn1_template_print_ctx(out, tmpfld,
241
3.59M
                    indent + 2, seqtt, pctx))
242
51.3k
                return 0;
243
3.59M
        }
244
798k
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
245
174k
            if (BIO_printf(out, "%*s}\n", indent, "") < 0)
246
0
                return 0;
247
174k
        }
248
249
798k
        if (asn1_cb) {
250
62.0k
            i = asn1_cb(ASN1_OP_PRINT_POST, fld, it, &parg);
251
62.0k
            if (i == 0)
252
0
                return 0;
253
62.0k
        }
254
798k
        break;
255
256
798k
    default:
257
0
        BIO_printf(out, "Unprocessed type %d\n", it->itype);
258
0
        return 0;
259
5.51M
    }
260
261
5.27M
    return 1;
262
5.51M
}
263
264
static int asn1_template_print_ctx(BIO *out, const ASN1_VALUE **fld, int indent,
265
    const ASN1_TEMPLATE *tt, const ASN1_PCTX *pctx)
266
3.89M
{
267
3.89M
    int i, flags;
268
3.89M
    const char *sname, *fname;
269
3.89M
    const ASN1_VALUE *tfld;
270
3.89M
    flags = tt->flags;
271
3.89M
    if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME)
272
628k
        sname = ASN1_ITEM_ptr(tt->item)->sname;
273
3.26M
    else
274
3.26M
        sname = NULL;
275
3.89M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
276
0
        fname = NULL;
277
3.89M
    else
278
3.89M
        fname = tt->field_name;
279
280
    /*
281
     * If field is embedded then fld needs fixing so it is a pointer to
282
     * a pointer to a field.
283
     */
284
3.89M
    if (flags & ASN1_TFLG_EMBED) {
285
64.0k
        tfld = (const ASN1_VALUE *)fld;
286
64.0k
        fld = &tfld;
287
64.0k
    }
288
289
3.89M
    if (flags & ASN1_TFLG_SK_MASK) {
290
452k
        char *tname;
291
452k
        const ASN1_VALUE *skitem;
292
452k
        STACK_OF(const_ASN1_VALUE) *stack;
293
294
        /* SET OF, SEQUENCE OF */
295
452k
        if (fname) {
296
452k
            if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SSOF) {
297
127k
                if (flags & ASN1_TFLG_SET_OF)
298
24.1k
                    tname = "SET";
299
103k
                else
300
103k
                    tname = "SEQUENCE";
301
127k
                if (BIO_printf(out, "%*s%s OF %s {\n",
302
127k
                        indent, "", tname, tt->field_name)
303
127k
                    <= 0)
304
0
                    return 0;
305
324k
            } else if (BIO_printf(out, "%*s%s:\n", indent, "", fname) <= 0)
306
0
                return 0;
307
452k
        }
308
452k
        stack = (STACK_OF(const_ASN1_VALUE) *)*fld;
309
3.97M
        for (i = 0; i < sk_const_ASN1_VALUE_num(stack); i++) {
310
3.53M
            if ((i > 0) && (BIO_puts(out, "\n") <= 0))
311
0
                return 0;
312
313
3.53M
            skitem = sk_const_ASN1_VALUE_value(stack, i);
314
3.53M
            if (!asn1_item_print_ctx(out, &skitem, indent + 2,
315
3.53M
                    ASN1_ITEM_ptr(tt->item), NULL, NULL, 1,
316
3.53M
                    pctx))
317
8.84k
                return 0;
318
3.53M
        }
319
443k
        if (i == 0 && BIO_printf(out, "%*s<%s>\n", indent + 2, "", stack == NULL ? "ABSENT" : "EMPTY") <= 0)
320
0
            return 0;
321
443k
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
322
123k
            if (BIO_printf(out, "%*s}\n", indent, "") <= 0)
323
0
                return 0;
324
123k
        }
325
443k
        return 1;
326
443k
    }
327
3.44M
    return asn1_item_print_ctx(out, fld, indent, ASN1_ITEM_ptr(tt->item),
328
3.44M
        fname, sname, 0, pctx);
329
3.89M
}
330
331
static int asn1_print_fsname(BIO *out, int indent,
332
    const char *fname, const char *sname,
333
    const ASN1_PCTX *pctx)
334
6.70M
{
335
6.70M
    static const char spaces[] = "                    ";
336
6.70M
    static const int nspaces = sizeof(spaces) - 1;
337
338
6.74M
    while (indent > nspaces) {
339
45.7k
        if (BIO_write(out, spaces, nspaces) != nspaces)
340
0
            return 0;
341
45.7k
        indent -= nspaces;
342
45.7k
    }
343
6.70M
    if (BIO_write(out, spaces, indent) != indent)
344
0
        return 0;
345
6.70M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
346
0
        sname = NULL;
347
6.70M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
348
0
        fname = NULL;
349
6.70M
    if (!sname && !fname)
350
3.13M
        return 1;
351
3.57M
    if (fname) {
352
3.24M
        if (BIO_puts(out, fname) <= 0)
353
0
            return 0;
354
3.24M
    }
355
3.57M
    if (sname) {
356
816k
        if (fname) {
357
491k
            if (BIO_printf(out, " (%s)", sname) <= 0)
358
0
                return 0;
359
491k
        } else {
360
325k
            if (BIO_puts(out, sname) <= 0)
361
0
                return 0;
362
325k
        }
363
816k
    }
364
3.57M
    if (BIO_write(out, ": ", 2) != 2)
365
0
        return 0;
366
3.57M
    return 1;
367
3.57M
}
368
369
static int asn1_print_boolean(BIO *out, int boolval)
370
28.7k
{
371
28.7k
    const char *str;
372
28.7k
    switch (boolval) {
373
4.61k
    case -1:
374
4.61k
        str = "BOOL ABSENT";
375
4.61k
        break;
376
377
12.1k
    case 0:
378
12.1k
        str = "FALSE";
379
12.1k
        break;
380
381
12.0k
    default:
382
12.0k
        str = "TRUE";
383
12.0k
        break;
384
28.7k
    }
385
386
28.7k
    if (BIO_puts(out, str) <= 0)
387
0
        return 0;
388
28.7k
    return 1;
389
28.7k
}
390
391
static int asn1_print_integer(BIO *out, const ASN1_INTEGER *str)
392
2.98M
{
393
2.98M
    char *s;
394
2.98M
    int ret = 1;
395
2.98M
    s = i2s_ASN1_INTEGER(NULL, str);
396
2.98M
    if (s == NULL)
397
485
        return 0;
398
2.97M
    if (BIO_puts(out, s) <= 0)
399
0
        ret = 0;
400
2.97M
    OPENSSL_free(s);
401
2.97M
    return ret;
402
2.98M
}
403
404
static int asn1_print_oid(BIO *out, const ASN1_OBJECT *oid)
405
330k
{
406
330k
    char objbuf[80];
407
330k
    const char *ln;
408
330k
    ln = OBJ_nid2ln(OBJ_obj2nid(oid));
409
330k
    if (!ln)
410
0
        ln = "";
411
330k
    OBJ_obj2txt(objbuf, sizeof(objbuf), oid, 1);
412
330k
    if (BIO_printf(out, "%s (%s)", ln, objbuf) <= 0)
413
0
        return 0;
414
330k
    return 1;
415
330k
}
416
417
static int asn1_print_obstring(BIO *out, const ASN1_STRING *str, int indent)
418
212k
{
419
212k
    if (str->type == V_ASN1_BIT_STRING) {
420
97.9k
        if (BIO_printf(out, " (%ld unused bits)\n", str->flags & 0x7) <= 0)
421
0
            return 0;
422
114k
    } else if (BIO_puts(out, "\n") <= 0)
423
0
        return 0;
424
212k
    if ((str->length > 0)
425
130k
        && BIO_dump_indent(out, (const char *)str->data, str->length,
426
130k
               indent + 2)
427
130k
            <= 0)
428
0
        return 0;
429
212k
    return 1;
430
212k
}
431
432
static int asn1_primitive_print(BIO *out, const ASN1_VALUE **fld,
433
    const ASN1_ITEM *it, int indent,
434
    const char *fname, const char *sname,
435
    const ASN1_PCTX *pctx)
436
4.22M
{
437
4.22M
    long utype;
438
4.22M
    ASN1_STRING *str;
439
4.22M
    int ret = 1, needlf = 1;
440
4.22M
    const char *pname;
441
4.22M
    const ASN1_PRIMITIVE_FUNCS *pf;
442
4.22M
    pf = it->funcs;
443
4.22M
    if (!asn1_print_fsname(out, indent, fname, sname, pctx))
444
0
        return 0;
445
4.22M
    if (pf && pf->prim_print)
446
113k
        return pf->prim_print(out, fld, it, indent, pctx);
447
4.11M
    if (it->itype == ASN1_ITYPE_MSTRING) {
448
57.7k
        str = (ASN1_STRING *)*fld;
449
57.7k
        utype = str->type & ~V_ASN1_NEG;
450
4.05M
    } else {
451
4.05M
        utype = it->utype;
452
4.05M
        if (utype == V_ASN1_BOOLEAN)
453
23.1k
            str = NULL;
454
4.03M
        else
455
4.03M
            str = (ASN1_STRING *)*fld;
456
4.05M
    }
457
4.11M
    if (utype == V_ASN1_ANY) {
458
542k
        const ASN1_TYPE *atype = (const ASN1_TYPE *)*fld;
459
542k
        utype = atype->type;
460
542k
        fld = (const ASN1_VALUE **)&atype->value.asn1_value; /* actually is const */
461
542k
        str = (ASN1_STRING *)*fld;
462
542k
        if (pctx->flags & ASN1_PCTX_FLAGS_NO_ANY_TYPE)
463
0
            pname = NULL;
464
542k
        else
465
542k
            pname = ASN1_tag2str(utype);
466
3.57M
    } else {
467
3.57M
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_TYPE)
468
312k
            pname = ASN1_tag2str(utype);
469
3.26M
        else
470
3.26M
            pname = NULL;
471
3.57M
    }
472
473
4.11M
    if (utype == V_ASN1_NULL) {
474
26.7k
        if (BIO_puts(out, "NULL\n") <= 0)
475
0
            return 0;
476
26.7k
        return 1;
477
26.7k
    }
478
479
4.08M
    if (pname) {
480
829k
        if (BIO_puts(out, pname) <= 0)
481
0
            return 0;
482
829k
        if (BIO_puts(out, ":") <= 0)
483
0
            return 0;
484
829k
    }
485
486
4.08M
    switch (utype) {
487
28.7k
    case V_ASN1_BOOLEAN: {
488
28.7k
        int boolval = *(int *)fld;
489
28.7k
        if (boolval == -1)
490
4.61k
            boolval = it->size;
491
28.7k
        ret = asn1_print_boolean(out, boolval);
492
28.7k
    } break;
493
494
2.97M
    case V_ASN1_INTEGER:
495
2.98M
    case V_ASN1_ENUMERATED:
496
2.98M
        ret = asn1_print_integer(out, str);
497
2.98M
        break;
498
499
15.4k
    case V_ASN1_UTCTIME:
500
15.4k
        ret = ASN1_UTCTIME_print(out, str);
501
15.4k
        break;
502
503
16.6k
    case V_ASN1_GENERALIZEDTIME:
504
16.6k
        ret = ASN1_GENERALIZEDTIME_print(out, str);
505
16.6k
        break;
506
507
330k
    case V_ASN1_OBJECT:
508
330k
        ret = asn1_print_oid(out, (const ASN1_OBJECT *)*fld);
509
330k
        break;
510
511
114k
    case V_ASN1_OCTET_STRING:
512
212k
    case V_ASN1_BIT_STRING:
513
212k
        ret = asn1_print_obstring(out, str, indent);
514
212k
        needlf = 0;
515
212k
        break;
516
517
304k
    case V_ASN1_SEQUENCE:
518
358k
    case V_ASN1_SET:
519
428k
    case V_ASN1_OTHER:
520
428k
        if (BIO_puts(out, "\n") <= 0)
521
0
            return 0;
522
428k
        if (ASN1_parse_dump(out, str->data, str->length, indent, 0) <= 0)
523
17.4k
            ret = 0;
524
428k
        needlf = 0;
525
428k
        break;
526
527
77.4k
    default:
528
77.4k
        ret = ASN1_STRING_print_ex(out, str, pctx->str_flags);
529
4.08M
    }
530
4.08M
    if (!ret)
531
37.3k
        return 0;
532
4.05M
    if (needlf && BIO_puts(out, "\n") <= 0)
533
0
        return 0;
534
4.05M
    return 1;
535
4.05M
}