Coverage Report

Created: 2026-07-12 07:21

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
21
{
37
21
    ASN1_PCTX *ret;
38
39
21
    ret = OPENSSL_zalloc(sizeof(*ret));
40
21
    if (ret == NULL) {
41
0
        ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
42
0
        return NULL;
43
0
    }
44
21
    return ret;
45
21
}
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
21
{
59
21
    p->flags = flags;
60
21
}
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
21
{
99
21
    p->str_flags = flags;
100
21
}
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
339k
{
124
339k
    const char *sname;
125
339k
    if (pctx == NULL)
126
39.4k
        pctx = &default_pctx;
127
339k
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
128
0
        sname = NULL;
129
339k
    else
130
339k
        sname = it->sname;
131
339k
    return asn1_item_print_ctx(out, &ifld, indent, it, NULL, sname, 0, pctx);
132
339k
}
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.06M
{
139
7.06M
    const ASN1_TEMPLATE *tt;
140
7.06M
    const ASN1_EXTERN_FUNCS *ef;
141
7.06M
    const ASN1_VALUE **tmpfld;
142
7.06M
    const ASN1_AUX *aux = it->funcs;
143
7.06M
    ASN1_aux_const_cb *asn1_cb = NULL;
144
7.06M
    ASN1_PRINT_ARG parg;
145
7.06M
    int i;
146
7.06M
    if (aux != NULL) {
147
960k
        parg.out = out;
148
960k
        parg.indent = indent;
149
960k
        parg.pctx = pctx;
150
960k
        asn1_cb = ((aux->flags & ASN1_AFLG_CONST_CB) != 0) ? aux->asn1_const_cb
151
960k
                                                           : (ASN1_aux_const_cb *)aux->asn1_cb; /* backward compatibility */
152
960k
    }
153
154
7.06M
    if (((it->itype != ASN1_ITYPE_PRIMITIVE)
155
4.61M
            || (it->utype != V_ASN1_BOOLEAN))
156
7.05M
        && *fld == NULL) {
157
2.59M
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_ABSENT) {
158
2.59M
            if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
159
0
                return 0;
160
2.59M
            if (BIO_puts(out, "<ABSENT>\n") <= 0)
161
0
                return 0;
162
2.59M
        }
163
2.59M
        return 1;
164
2.59M
    }
165
166
4.47M
    switch (it->itype) {
167
3.16M
    case ASN1_ITYPE_PRIMITIVE:
168
3.16M
        if (it->templates) {
169
91.8k
            if (!asn1_template_print_ctx(out, fld, indent,
170
91.8k
                    it->templates, pctx))
171
4.38k
                return 0;
172
87.4k
            break;
173
91.8k
        }
174
        /* fall through */
175
3.12M
    case ASN1_ITYPE_MSTRING:
176
3.12M
        if (!asn1_primitive_print(out, fld, it, indent, fname, sname, pctx))
177
29.6k
            return 0;
178
3.09M
        break;
179
180
3.09M
    case ASN1_ITYPE_EXTERN:
181
116k
        if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
182
0
            return 0;
183
        /* Use new style print routine if possible */
184
116k
        ef = it->funcs;
185
116k
        if (ef && ef->asn1_ex_print) {
186
116k
            i = ef->asn1_ex_print(out, fld, indent, "", pctx);
187
116k
            if (!i)
188
751
                return 0;
189
115k
            if ((i == 2) && (BIO_puts(out, "\n") <= 0))
190
0
                return 0;
191
115k
            return 1;
192
115k
        } else if (sname && BIO_printf(out, ":EXTERNAL TYPE %s\n", sname) <= 0)
193
0
            return 0;
194
0
        break;
195
196
178k
    case ASN1_ITYPE_CHOICE:
197
        /* CHOICE type, get selector */
198
178k
        i = ossl_asn1_get_choice_selector_const(fld, it);
199
        /* This should never happen... */
200
178k
        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
178k
        tt = it->templates + i;
206
178k
        tmpfld = ossl_asn1_get_const_field_ptr(fld, tt);
207
178k
        if (!asn1_template_print_ctx(out, tmpfld, indent, tt, pctx))
208
11.8k
            return 0;
209
166k
        break;
210
211
948k
    case ASN1_ITYPE_SEQUENCE:
212
963k
    case ASN1_ITYPE_NDEF_SEQUENCE:
213
963k
        if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
214
0
            return 0;
215
963k
        if (fname || sname) {
216
552k
            if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
217
85.9k
                if (BIO_puts(out, " {\n") <= 0)
218
0
                    return 0;
219
467k
            } else {
220
467k
                if (BIO_puts(out, "\n") <= 0)
221
0
                    return 0;
222
467k
            }
223
552k
        }
224
225
963k
        if (asn1_cb) {
226
79.6k
            i = asn1_cb(ASN1_OP_PRINT_PRE, fld, it, &parg);
227
79.6k
            if (i == 0)
228
0
                return 0;
229
79.6k
            if (i == 2)
230
0
                return 1;
231
79.6k
        }
232
233
        /* Print each field entry */
234
5.29M
        for (i = 0, tt = it->templates; i < it->tcount; i++, tt++) {
235
4.37M
            const ASN1_TEMPLATE *seqtt;
236
4.37M
            seqtt = ossl_asn1_do_adb(*fld, tt, 1);
237
4.37M
            if (!seqtt)
238
0
                return 0;
239
4.37M
            tmpfld = ossl_asn1_get_const_field_ptr(fld, seqtt);
240
4.37M
            if (!asn1_template_print_ctx(out, tmpfld,
241
4.37M
                    indent + 2, seqtt, pctx))
242
43.4k
                return 0;
243
4.37M
        }
244
920k
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
245
170k
            if (BIO_printf(out, "%*s}\n", indent, "") < 0)
246
0
                return 0;
247
170k
        }
248
249
920k
        if (asn1_cb) {
250
57.9k
            i = asn1_cb(ASN1_OP_PRINT_POST, fld, it, &parg);
251
57.9k
            if (i == 0)
252
0
                return 0;
253
57.9k
        }
254
920k
        break;
255
256
920k
    default:
257
0
        BIO_printf(out, "Unprocessed type %d\n", it->itype);
258
0
        return 0;
259
4.47M
    }
260
261
4.26M
    return 1;
262
4.47M
}
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
5.15M
{
267
5.15M
    int i, flags;
268
5.15M
    const char *sname, *fname;
269
5.15M
    const ASN1_VALUE *tfld;
270
5.15M
    flags = tt->flags;
271
5.15M
    if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME)
272
593k
        sname = ASN1_ITEM_ptr(tt->item)->sname;
273
4.56M
    else
274
4.56M
        sname = NULL;
275
5.15M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
276
0
        fname = NULL;
277
5.15M
    else
278
5.15M
        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
5.15M
    if (flags & ASN1_TFLG_EMBED) {
285
62.4k
        tfld = (const ASN1_VALUE *)fld;
286
62.4k
        fld = &tfld;
287
62.4k
    }
288
289
5.15M
    if (flags & ASN1_TFLG_SK_MASK) {
290
567k
        char *tname;
291
567k
        const ASN1_VALUE *skitem;
292
567k
        STACK_OF(const_ASN1_VALUE) *stack;
293
294
        /* SET OF, SEQUENCE OF */
295
567k
        if (fname) {
296
567k
            if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SSOF) {
297
115k
                if (flags & ASN1_TFLG_SET_OF)
298
20.7k
                    tname = "SET";
299
94.8k
                else
300
94.8k
                    tname = "SEQUENCE";
301
115k
                if (BIO_printf(out, "%*s%s OF %s {\n",
302
115k
                        indent, "", tname, tt->field_name)
303
115k
                    <= 0)
304
0
                    return 0;
305
451k
            } else if (BIO_printf(out, "%*s%s:\n", indent, "", fname) <= 0)
306
0
                return 0;
307
567k
        }
308
567k
        stack = (STACK_OF(const_ASN1_VALUE) *)*fld;
309
3.26M
        for (i = 0; i < sk_const_ASN1_VALUE_num(stack); i++) {
310
2.70M
            if ((i > 0) && (BIO_puts(out, "\n") <= 0))
311
0
                return 0;
312
313
2.70M
            skitem = sk_const_ASN1_VALUE_value(stack, i);
314
2.70M
            if (!asn1_item_print_ctx(out, &skitem, indent + 2,
315
2.70M
                    ASN1_ITEM_ptr(tt->item), NULL, NULL, 1,
316
2.70M
                    pctx))
317
8.31k
                return 0;
318
2.70M
        }
319
558k
        if (i == 0 && BIO_printf(out, "%*s<%s>\n", indent + 2, "", stack == NULL ? "ABSENT" : "EMPTY") <= 0)
320
0
            return 0;
321
558k
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
322
112k
            if (BIO_printf(out, "%*s}\n", indent, "") <= 0)
323
0
                return 0;
324
112k
        }
325
558k
        return 1;
326
558k
    }
327
4.59M
    return asn1_item_print_ctx(out, fld, indent, ASN1_ITEM_ptr(tt->item),
328
4.59M
        fname, sname, 0, pctx);
329
5.15M
}
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.88M
{
335
6.88M
    static const char spaces[] = "                    ";
336
6.88M
    static const int nspaces = sizeof(spaces) - 1;
337
338
6.92M
    while (indent > nspaces) {
339
46.7k
        if (BIO_write(out, spaces, nspaces) != nspaces)
340
0
            return 0;
341
46.7k
        indent -= nspaces;
342
46.7k
    }
343
6.88M
    if (BIO_write(out, spaces, indent) != indent)
344
0
        return 0;
345
6.88M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
346
0
        sname = NULL;
347
6.88M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
348
0
        fname = NULL;
349
6.88M
    if (!sname && !fname)
350
2.21M
        return 1;
351
4.66M
    if (fname) {
352
4.36M
        if (BIO_puts(out, fname) <= 0)
353
0
            return 0;
354
4.36M
    }
355
4.66M
    if (sname) {
356
764k
        if (fname) {
357
468k
            if (BIO_printf(out, " (%s)", sname) <= 0)
358
0
                return 0;
359
468k
        } else {
360
295k
            if (BIO_puts(out, sname) <= 0)
361
0
                return 0;
362
295k
        }
363
764k
    }
364
4.66M
    if (BIO_write(out, ": ", 2) != 2)
365
0
        return 0;
366
4.66M
    return 1;
367
4.66M
}
368
369
static int asn1_print_boolean(BIO *out, int boolval)
370
26.1k
{
371
26.1k
    const char *str;
372
26.1k
    switch (boolval) {
373
4.13k
    case -1:
374
4.13k
        str = "BOOL ABSENT";
375
4.13k
        break;
376
377
11.0k
    case 0:
378
11.0k
        str = "FALSE";
379
11.0k
        break;
380
381
10.9k
    default:
382
10.9k
        str = "TRUE";
383
10.9k
        break;
384
26.1k
    }
385
386
26.1k
    if (BIO_puts(out, str) <= 0)
387
0
        return 0;
388
26.1k
    return 1;
389
26.1k
}
390
391
static int asn1_print_integer(BIO *out, const ASN1_INTEGER *str)
392
2.03M
{
393
2.03M
    char *s;
394
2.03M
    int ret = 1;
395
2.03M
    s = i2s_ASN1_INTEGER(NULL, str);
396
2.03M
    if (s == NULL)
397
391
        return 0;
398
2.03M
    if (BIO_puts(out, s) <= 0)
399
0
        ret = 0;
400
2.03M
    OPENSSL_free(s);
401
2.03M
    return ret;
402
2.03M
}
403
404
static int asn1_print_oid(BIO *out, const ASN1_OBJECT *oid)
405
327k
{
406
327k
    char objbuf[80];
407
327k
    const char *ln;
408
327k
    ln = OBJ_nid2ln(OBJ_obj2nid(oid));
409
327k
    if (!ln)
410
0
        ln = "";
411
327k
    OBJ_obj2txt(objbuf, sizeof(objbuf), oid, 1);
412
327k
    if (BIO_printf(out, "%s (%s)", ln, objbuf) <= 0)
413
0
        return 0;
414
327k
    return 1;
415
327k
}
416
417
static int asn1_print_obstring(BIO *out, const ASN1_STRING *str, int indent)
418
219k
{
419
219k
    if (str->type == V_ASN1_BIT_STRING) {
420
105k
        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
219k
    if ((str->length > 0)
425
118k
        && BIO_dump_indent(out, (const char *)str->data, str->length,
426
118k
               indent + 2)
427
118k
            <= 0)
428
0
        return 0;
429
219k
    return 1;
430
219k
}
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
3.28M
{
437
3.28M
    long utype;
438
3.28M
    ASN1_STRING *str;
439
3.28M
    int ret = 1, needlf = 1;
440
3.28M
    const char *pname;
441
3.28M
    const ASN1_PRIMITIVE_FUNCS *pf;
442
3.28M
    pf = it->funcs;
443
3.28M
    if (!asn1_print_fsname(out, indent, fname, sname, pctx))
444
0
        return 0;
445
3.28M
    if (pf && pf->prim_print)
446
115k
        return pf->prim_print(out, fld, it, indent, pctx);
447
3.16M
    if (it->itype == ASN1_ITYPE_MSTRING) {
448
49.2k
        str = (ASN1_STRING *)*fld;
449
49.2k
        utype = str->type & ~V_ASN1_NEG;
450
3.11M
    } else {
451
3.11M
        utype = it->utype;
452
3.11M
        if (utype == V_ASN1_BOOLEAN)
453
20.5k
            str = NULL;
454
3.09M
        else
455
3.09M
            str = (ASN1_STRING *)*fld;
456
3.11M
    }
457
3.16M
    if (utype == V_ASN1_ANY) {
458
482k
        const ASN1_TYPE *atype = (const ASN1_TYPE *)*fld;
459
482k
        utype = atype->type;
460
482k
        fld = (const ASN1_VALUE **)&atype->value.asn1_value; /* actually is const */
461
482k
        str = (ASN1_STRING *)*fld;
462
482k
        if (pctx->flags & ASN1_PCTX_FLAGS_NO_ANY_TYPE)
463
0
            pname = NULL;
464
482k
        else
465
482k
            pname = ASN1_tag2str(utype);
466
2.68M
    } else {
467
2.68M
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_TYPE)
468
270k
            pname = ASN1_tag2str(utype);
469
2.41M
        else
470
2.41M
            pname = NULL;
471
2.68M
    }
472
473
3.16M
    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
3.14M
    if (pname) {
480
728k
        if (BIO_puts(out, pname) <= 0)
481
0
            return 0;
482
728k
        if (BIO_puts(out, ":") <= 0)
483
0
            return 0;
484
728k
    }
485
486
3.14M
    switch (utype) {
487
26.1k
    case V_ASN1_BOOLEAN: {
488
26.1k
        int boolval = *(int *)fld;
489
26.1k
        if (boolval == -1)
490
4.13k
            boolval = it->size;
491
26.1k
        ret = asn1_print_boolean(out, boolval);
492
26.1k
    } break;
493
494
2.03M
    case V_ASN1_INTEGER:
495
2.03M
    case V_ASN1_ENUMERATED:
496
2.03M
        ret = asn1_print_integer(out, str);
497
2.03M
        break;
498
499
18.9k
    case V_ASN1_UTCTIME:
500
18.9k
        ret = ASN1_UTCTIME_print(out, str);
501
18.9k
        break;
502
503
14.1k
    case V_ASN1_GENERALIZEDTIME:
504
14.1k
        ret = ASN1_GENERALIZEDTIME_print(out, str);
505
14.1k
        break;
506
507
327k
    case V_ASN1_OBJECT:
508
327k
        ret = asn1_print_oid(out, (const ASN1_OBJECT *)*fld);
509
327k
        break;
510
511
114k
    case V_ASN1_OCTET_STRING:
512
219k
    case V_ASN1_BIT_STRING:
513
219k
        ret = asn1_print_obstring(out, str, indent);
514
219k
        needlf = 0;
515
219k
        break;
516
517
258k
    case V_ASN1_SEQUENCE:
518
292k
    case V_ASN1_SET:
519
367k
    case V_ASN1_OTHER:
520
367k
        if (BIO_puts(out, "\n") <= 0)
521
0
            return 0;
522
367k
        if (ASN1_parse_dump(out, str->data, str->length, indent, 0) <= 0)
523
13.4k
            ret = 0;
524
367k
        needlf = 0;
525
367k
        break;
526
527
130k
    default:
528
130k
        ret = ASN1_STRING_print_ex(out, str, pctx->str_flags);
529
3.14M
    }
530
3.14M
    if (!ret)
531
32.5k
        return 0;
532
3.10M
    if (needlf && BIO_puts(out, "\n") <= 0)
533
0
        return 0;
534
3.10M
    return 1;
535
3.10M
}