Coverage Report

Created: 2026-09-12 06:55

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