Coverage Report

Created: 2025-11-16 06:40

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
379k
{
124
379k
    const char *sname;
125
379k
    if (pctx == NULL)
126
38.5k
        pctx = &default_pctx;
127
379k
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
128
0
        sname = NULL;
129
379k
    else
130
379k
        sname = it->sname;
131
379k
    return asn1_item_print_ctx(out, &ifld, indent, it, NULL, sname, 0, pctx);
132
379k
}
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.37M
{
139
7.37M
    const ASN1_TEMPLATE *tt;
140
7.37M
    const ASN1_EXTERN_FUNCS *ef;
141
7.37M
    const ASN1_VALUE **tmpfld;
142
7.37M
    const ASN1_AUX *aux = it->funcs;
143
7.37M
    ASN1_aux_const_cb *asn1_cb = NULL;
144
7.37M
    ASN1_PRINT_ARG parg;
145
7.37M
    int i;
146
7.37M
    if (aux != NULL) {
147
718k
        parg.out = out;
148
718k
        parg.indent = indent;
149
718k
        parg.pctx = pctx;
150
718k
        asn1_cb = ((aux->flags & ASN1_AFLG_CONST_CB) != 0) ? aux->asn1_const_cb
151
718k
            : (ASN1_aux_const_cb *)aux->asn1_cb; /* backward compatibility */
152
718k
    }
153
154
7.37M
   if (((it->itype != ASN1_ITYPE_PRIMITIVE)
155
7.34M
       || (it->utype != V_ASN1_BOOLEAN)) && *fld == NULL) {
156
1.69M
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_ABSENT) {
157
1.69M
            if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
158
0
                return 0;
159
1.69M
            if (BIO_puts(out, "<ABSENT>\n") <= 0)
160
0
                return 0;
161
1.69M
        }
162
1.69M
        return 1;
163
1.69M
    }
164
165
5.67M
    switch (it->itype) {
166
4.40M
    case ASN1_ITYPE_PRIMITIVE:
167
4.40M
        if (it->templates) {
168
102k
            if (!asn1_template_print_ctx(out, fld, indent,
169
102k
                                         it->templates, pctx))
170
5.58k
                return 0;
171
96.7k
            break;
172
102k
        }
173
        /* fall through */
174
4.36M
    case ASN1_ITYPE_MSTRING:
175
4.36M
        if (!asn1_primitive_print(out, fld, it, indent, fname, sname, pctx))
176
36.1k
            return 0;
177
4.32M
        break;
178
179
4.32M
    case ASN1_ITYPE_EXTERN:
180
139k
        if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
181
0
            return 0;
182
        /* Use new style print routine if possible */
183
139k
        ef = it->funcs;
184
139k
        if (ef && ef->asn1_ex_print) {
185
139k
            i = ef->asn1_ex_print(out, fld, indent, "", pctx);
186
139k
            if (!i)
187
1.24k
                return 0;
188
137k
            if ((i == 2) && (BIO_puts(out, "\n") <= 0))
189
0
                return 0;
190
137k
            return 1;
191
137k
        } else if (sname &&
192
0
                   BIO_printf(out, ":EXTERNAL TYPE %s\n", sname) <= 0)
193
0
            return 0;
194
0
        break;
195
196
225k
    case ASN1_ITYPE_CHOICE:
197
        /* CHOICE type, get selector */
198
225k
        i = ossl_asn1_get_choice_selector_const(fld, it);
199
        /* This should never happen... */
200
225k
        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
225k
        tt = it->templates + i;
206
225k
        tmpfld = ossl_asn1_get_const_field_ptr(fld, tt);
207
225k
        if (!asn1_template_print_ctx(out, tmpfld, indent, tt, pctx))
208
13.1k
            return 0;
209
212k
        break;
210
211
828k
    case ASN1_ITYPE_SEQUENCE:
212
845k
    case ASN1_ITYPE_NDEF_SEQUENCE:
213
845k
        if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
214
0
            return 0;
215
845k
        if (fname || sname) {
216
499k
            if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
217
90.8k
                if (BIO_puts(out, " {\n") <= 0)
218
0
                    return 0;
219
409k
            } else {
220
409k
                if (BIO_puts(out, "\n") <= 0)
221
0
                    return 0;
222
409k
            }
223
499k
        }
224
225
845k
        if (asn1_cb) {
226
93.0k
            i = asn1_cb(ASN1_OP_PRINT_PRE, fld, it, &parg);
227
93.0k
            if (i == 0)
228
0
                return 0;
229
93.0k
            if (i == 2)
230
0
                return 1;
231
93.0k
        }
232
233
        /* Print each field entry */
234
4.29M
        for (i = 0, tt = it->templates; i < it->tcount; i++, tt++) {
235
3.49M
            const ASN1_TEMPLATE *seqtt;
236
3.49M
            seqtt = ossl_asn1_do_adb(*fld, tt, 1);
237
3.49M
            if (!seqtt)
238
0
                return 0;
239
3.49M
            tmpfld = ossl_asn1_get_const_field_ptr(fld, seqtt);
240
3.49M
            if (!asn1_template_print_ctx(out, tmpfld,
241
3.49M
                                         indent + 2, seqtt, pctx))
242
51.7k
                return 0;
243
3.49M
        }
244
793k
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
245
192k
            if (BIO_printf(out, "%*s}\n", indent, "") < 0)
246
0
                return 0;
247
192k
        }
248
249
793k
        if (asn1_cb) {
250
67.0k
            i = asn1_cb(ASN1_OP_PRINT_POST, fld, it, &parg);
251
67.0k
            if (i == 0)
252
0
                return 0;
253
67.0k
        }
254
793k
        break;
255
256
793k
    default:
257
0
        BIO_printf(out, "Unprocessed type %d\n", it->itype);
258
0
        return 0;
259
5.67M
    }
260
261
5.43M
    return 1;
262
5.67M
}
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.82M
{
267
3.82M
    int i, flags;
268
3.82M
    const char *sname, *fname;
269
3.82M
    const ASN1_VALUE *tfld;
270
3.82M
    flags = tt->flags;
271
3.82M
    if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME)
272
678k
        sname = ASN1_ITEM_ptr(tt->item)->sname;
273
3.14M
    else
274
3.14M
        sname = NULL;
275
3.82M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
276
0
        fname = NULL;
277
3.82M
    else
278
3.82M
        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.82M
    if (flags & ASN1_TFLG_EMBED) {
285
65.7k
        tfld = (const ASN1_VALUE *)fld;
286
65.7k
        fld = &tfld;
287
65.7k
    }
288
289
3.82M
    if (flags & ASN1_TFLG_SK_MASK) {
290
457k
        char *tname;
291
457k
        const ASN1_VALUE *skitem;
292
457k
        STACK_OF(const_ASN1_VALUE) *stack;
293
294
        /* SET OF, SEQUENCE OF */
295
457k
        if (fname) {
296
457k
            if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SSOF) {
297
134k
                if (flags & ASN1_TFLG_SET_OF)
298
23.7k
                    tname = "SET";
299
110k
                else
300
110k
                    tname = "SEQUENCE";
301
134k
                if (BIO_printf(out, "%*s%s OF %s {\n",
302
134k
                               indent, "", tname, tt->field_name) <= 0)
303
0
                    return 0;
304
323k
            } else if (BIO_printf(out, "%*s%s:\n", indent, "", fname) <= 0)
305
0
                return 0;
306
457k
        }
307
457k
        stack = (STACK_OF(const_ASN1_VALUE) *)*fld;
308
4.07M
        for (i = 0; i < sk_const_ASN1_VALUE_num(stack); i++) {
309
3.62M
            if ((i > 0) && (BIO_puts(out, "\n") <= 0))
310
0
                return 0;
311
312
3.62M
            skitem = sk_const_ASN1_VALUE_value(stack, i);
313
3.62M
            if (!asn1_item_print_ctx(out, &skitem, indent + 2,
314
3.62M
                                     ASN1_ITEM_ptr(tt->item), NULL, NULL, 1,
315
3.62M
                                     pctx))
316
9.16k
                return 0;
317
3.62M
        }
318
448k
        if (i == 0 && BIO_printf(out, "%*s<%s>\n", indent + 2, "",
319
375k
                                 stack == NULL ? "ABSENT" : "EMPTY") <= 0)
320
0
            return 0;
321
448k
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
322
129k
            if (BIO_printf(out, "%*s}\n", indent, "") <= 0)
323
0
                return 0;
324
129k
        }
325
448k
        return 1;
326
448k
    }
327
3.36M
    return asn1_item_print_ctx(out, fld, indent, ASN1_ITEM_ptr(tt->item),
328
3.36M
                               fname, sname, 0, pctx);
329
3.82M
}
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.69M
{
335
6.69M
    static const char spaces[] = "                    ";
336
6.69M
    static const int nspaces = sizeof(spaces) - 1;
337
338
6.75M
    while (indent > nspaces) {
339
58.0k
        if (BIO_write(out, spaces, nspaces) != nspaces)
340
0
            return 0;
341
58.0k
        indent -= nspaces;
342
58.0k
    }
343
6.69M
    if (BIO_write(out, spaces, indent) != indent)
344
0
        return 0;
345
6.69M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
346
0
        sname = NULL;
347
6.69M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
348
0
        fname = NULL;
349
6.69M
    if (!sname && !fname)
350
3.21M
        return 1;
351
3.48M
    if (fname) {
352
3.15M
        if (BIO_puts(out, fname) <= 0)
353
0
            return 0;
354
3.15M
    }
355
3.48M
    if (sname) {
356
861k
        if (fname) {
357
534k
            if (BIO_printf(out, " (%s)", sname) <= 0)
358
0
                return 0;
359
534k
        } else {
360
326k
            if (BIO_puts(out, sname) <= 0)
361
0
                return 0;
362
326k
        }
363
861k
    }
364
3.48M
    if (BIO_write(out, ": ", 2) != 2)
365
0
        return 0;
366
3.48M
    return 1;
367
3.48M
}
368
369
static int asn1_print_boolean(BIO *out, int boolval)
370
29.9k
{
371
29.9k
    const char *str;
372
29.9k
    switch (boolval) {
373
7.34k
    case -1:
374
7.34k
        str = "BOOL ABSENT";
375
7.34k
        break;
376
377
11.1k
    case 0:
378
11.1k
        str = "FALSE";
379
11.1k
        break;
380
381
11.4k
    default:
382
11.4k
        str = "TRUE";
383
11.4k
        break;
384
385
29.9k
    }
386
387
29.9k
    if (BIO_puts(out, str) <= 0)
388
0
        return 0;
389
29.9k
    return 1;
390
391
29.9k
}
392
393
static int asn1_print_integer(BIO *out, const ASN1_INTEGER *str)
394
3.05M
{
395
3.05M
    char *s;
396
3.05M
    int ret = 1;
397
3.05M
    s = i2s_ASN1_INTEGER(NULL, str);
398
3.05M
    if (s == NULL)
399
452
        return 0;
400
3.05M
    if (BIO_puts(out, s) <= 0)
401
0
        ret = 0;
402
3.05M
    OPENSSL_free(s);
403
3.05M
    return ret;
404
3.05M
}
405
406
static int asn1_print_oid(BIO *out, const ASN1_OBJECT *oid)
407
337k
{
408
337k
    char objbuf[80];
409
337k
    const char *ln;
410
337k
    ln = OBJ_nid2ln(OBJ_obj2nid(oid));
411
337k
    if (!ln)
412
0
        ln = "";
413
337k
    OBJ_obj2txt(objbuf, sizeof(objbuf), oid, 1);
414
337k
    if (BIO_printf(out, "%s (%s)", ln, objbuf) <= 0)
415
0
        return 0;
416
337k
    return 1;
417
337k
}
418
419
static int asn1_print_obstring(BIO *out, const ASN1_STRING *str, int indent)
420
216k
{
421
216k
    if (str->type == V_ASN1_BIT_STRING) {
422
104k
        if (BIO_printf(out, " (%ld unused bits)\n", str->flags & 0x7) <= 0)
423
0
            return 0;
424
111k
    } else if (BIO_puts(out, "\n") <= 0)
425
0
        return 0;
426
216k
    if ((str->length > 0)
427
127k
        && BIO_dump_indent(out, (const char *)str->data, str->length,
428
127k
                           indent + 2) <= 0)
429
0
        return 0;
430
216k
    return 1;
431
216k
}
432
433
static int asn1_primitive_print(BIO *out, const ASN1_VALUE **fld,
434
                                const ASN1_ITEM *it, int indent,
435
                                const char *fname, const char *sname,
436
                                const ASN1_PCTX *pctx)
437
4.36M
{
438
4.36M
    long utype;
439
4.36M
    ASN1_STRING *str;
440
4.36M
    int ret = 1, needlf = 1;
441
4.36M
    const char *pname;
442
4.36M
    const ASN1_PRIMITIVE_FUNCS *pf;
443
4.36M
    pf = it->funcs;
444
4.36M
    if (!asn1_print_fsname(out, indent, fname, sname, pctx))
445
0
        return 0;
446
4.36M
    if (pf && pf->prim_print)
447
139k
        return pf->prim_print(out, fld, it, indent, pctx);
448
4.22M
    if (it->itype == ASN1_ITYPE_MSTRING) {
449
57.0k
        str = (ASN1_STRING *)*fld;
450
57.0k
        utype = str->type & ~V_ASN1_NEG;
451
4.16M
    } else {
452
4.16M
        utype = it->utype;
453
4.16M
        if (utype == V_ASN1_BOOLEAN)
454
24.6k
            str = NULL;
455
4.14M
        else
456
4.14M
            str = (ASN1_STRING *)*fld;
457
4.16M
    }
458
4.22M
    if (utype == V_ASN1_ANY) {
459
553k
        const ASN1_TYPE *atype = (const ASN1_TYPE *)*fld;
460
553k
        utype = atype->type;
461
553k
        fld = (const ASN1_VALUE **)&atype->value.asn1_value; /* actually is const */
462
553k
        str = (ASN1_STRING *)*fld;
463
553k
        if (pctx->flags & ASN1_PCTX_FLAGS_NO_ANY_TYPE)
464
0
            pname = NULL;
465
553k
        else
466
553k
            pname = ASN1_tag2str(utype);
467
3.67M
    } else {
468
3.67M
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_TYPE)
469
320k
            pname = ASN1_tag2str(utype);
470
3.35M
        else
471
3.35M
            pname = NULL;
472
3.67M
    }
473
474
4.22M
    if (utype == V_ASN1_NULL) {
475
25.1k
        if (BIO_puts(out, "NULL\n") <= 0)
476
0
            return 0;
477
25.1k
        return 1;
478
25.1k
    }
479
480
4.19M
    if (pname) {
481
849k
        if (BIO_puts(out, pname) <= 0)
482
0
            return 0;
483
849k
        if (BIO_puts(out, ":") <= 0)
484
0
            return 0;
485
849k
    }
486
487
4.19M
    switch (utype) {
488
29.9k
    case V_ASN1_BOOLEAN:
489
29.9k
        {
490
29.9k
            int boolval = *(int *)fld;
491
29.9k
            if (boolval == -1)
492
7.34k
                boolval = it->size;
493
29.9k
            ret = asn1_print_boolean(out, boolval);
494
29.9k
        }
495
29.9k
        break;
496
497
3.05M
    case V_ASN1_INTEGER:
498
3.05M
    case V_ASN1_ENUMERATED:
499
3.05M
        ret = asn1_print_integer(out, str);
500
3.05M
        break;
501
502
19.8k
    case V_ASN1_UTCTIME:
503
19.8k
        ret = ASN1_UTCTIME_print(out, str);
504
19.8k
        break;
505
506
15.5k
    case V_ASN1_GENERALIZEDTIME:
507
15.5k
        ret = ASN1_GENERALIZEDTIME_print(out, str);
508
15.5k
        break;
509
510
337k
    case V_ASN1_OBJECT:
511
337k
        ret = asn1_print_oid(out, (const ASN1_OBJECT *)*fld);
512
337k
        break;
513
514
111k
    case V_ASN1_OCTET_STRING:
515
216k
    case V_ASN1_BIT_STRING:
516
216k
        ret = asn1_print_obstring(out, str, indent);
517
216k
        needlf = 0;
518
216k
        break;
519
520
318k
    case V_ASN1_SEQUENCE:
521
359k
    case V_ASN1_SET:
522
447k
    case V_ASN1_OTHER:
523
447k
        if (BIO_puts(out, "\n") <= 0)
524
0
            return 0;
525
447k
        if (ASN1_parse_dump(out, str->data, str->length, indent, 0) <= 0)
526
16.5k
            ret = 0;
527
447k
        needlf = 0;
528
447k
        break;
529
530
78.3k
    default:
531
78.3k
        ret = ASN1_STRING_print_ex(out, str, pctx->str_flags);
532
533
4.19M
    }
534
4.19M
    if (!ret)
535
36.1k
        return 0;
536
4.16M
    if (needlf && BIO_puts(out, "\n") <= 0)
537
0
        return 0;
538
4.16M
    return 1;
539
4.16M
}