Coverage Report

Created: 2025-06-13 06:58

/src/openssl/crypto/asn1/tasn_prn.c
Line
Count
Source (jump to first uncovered line)
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
12
{
37
12
    ASN1_PCTX *ret;
38
39
12
    ret = OPENSSL_zalloc(sizeof(*ret));
40
12
    if (ret == NULL)
41
0
        return NULL;
42
12
    return ret;
43
12
}
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
12
{
57
12
    p->flags = flags;
58
12
}
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
12
{
97
12
    p->str_flags = flags;
98
12
}
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
278k
{
122
278k
    const char *sname;
123
278k
    if (pctx == NULL)
124
28.3k
        pctx = &default_pctx;
125
278k
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
126
0
        sname = NULL;
127
278k
    else
128
278k
        sname = it->sname;
129
278k
    return asn1_item_print_ctx(out, &ifld, indent, it, NULL, sname, 0, pctx);
130
278k
}
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
3.63M
{
137
3.63M
    const ASN1_TEMPLATE *tt;
138
3.63M
    const ASN1_EXTERN_FUNCS *ef;
139
3.63M
    const ASN1_VALUE **tmpfld;
140
3.63M
    const ASN1_AUX *aux = it->funcs;
141
3.63M
    ASN1_aux_const_cb *asn1_cb = NULL;
142
3.63M
    ASN1_PRINT_ARG parg;
143
3.63M
    int i;
144
3.63M
    if (aux != NULL) {
145
487k
        parg.out = out;
146
487k
        parg.indent = indent;
147
487k
        parg.pctx = pctx;
148
487k
        asn1_cb = ((aux->flags & ASN1_AFLG_CONST_CB) != 0) ? aux->asn1_const_cb
149
487k
            : (ASN1_aux_const_cb *)aux->asn1_cb; /* backward compatibility */
150
487k
    }
151
152
3.63M
   if (((it->itype != ASN1_ITYPE_PRIMITIVE)
153
3.63M
       || (it->utype != V_ASN1_BOOLEAN)) && *fld == NULL) {
154
1.11M
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_ABSENT) {
155
1.11M
            if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
156
0
                return 0;
157
1.11M
            if (BIO_puts(out, "<ABSENT>\n") <= 0)
158
0
                return 0;
159
1.11M
        }
160
1.11M
        return 1;
161
1.11M
    }
162
163
2.51M
    switch (it->itype) {
164
1.60M
    case ASN1_ITYPE_PRIMITIVE:
165
1.60M
        if (it->templates) {
166
66.0k
            if (!asn1_template_print_ctx(out, fld, indent,
167
66.0k
                                         it->templates, pctx))
168
4.61k
                return 0;
169
61.4k
            break;
170
66.0k
        }
171
        /* fall through */
172
1.57M
    case ASN1_ITYPE_MSTRING:
173
1.57M
        if (!asn1_primitive_print(out, fld, it, indent, fname, sname, pctx))
174
25.9k
            return 0;
175
1.55M
        break;
176
177
1.55M
    case ASN1_ITYPE_EXTERN:
178
100k
        if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
179
0
            return 0;
180
        /* Use new style print routine if possible */
181
100k
        ef = it->funcs;
182
100k
        if (ef && ef->asn1_ex_print) {
183
100k
            i = ef->asn1_ex_print(out, fld, indent, "", pctx);
184
100k
            if (!i)
185
841
                return 0;
186
99.5k
            if ((i == 2) && (BIO_puts(out, "\n") <= 0))
187
0
                return 0;
188
99.5k
            return 1;
189
99.5k
        } else if (sname &&
190
0
                   BIO_printf(out, ":EXTERNAL TYPE %s\n", sname) <= 0)
191
0
            return 0;
192
0
        break;
193
194
184k
    case ASN1_ITYPE_CHOICE:
195
        /* CHOICE type, get selector */
196
184k
        i = ossl_asn1_get_choice_selector_const(fld, it);
197
        /* This should never happen... */
198
184k
        if ((i < 0) || (i >= it->tcount)) {
199
0
            if (BIO_printf(out, "ERROR: selector [%d] invalid\n", i) <= 0)
200
0
                return 0;
201
0
            return 1;
202
0
        }
203
184k
        tt = it->templates + i;
204
184k
        tmpfld = ossl_asn1_get_const_field_ptr(fld, tt);
205
184k
        if (!asn1_template_print_ctx(out, tmpfld, indent, tt, pctx))
206
11.4k
            return 0;
207
172k
        break;
208
209
568k
    case ASN1_ITYPE_SEQUENCE:
210
584k
    case ASN1_ITYPE_NDEF_SEQUENCE:
211
584k
        if (!nohdr && !asn1_print_fsname(out, indent, fname, sname, pctx))
212
0
            return 0;
213
584k
        if (fname || sname) {
214
363k
            if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
215
71.4k
                if (BIO_puts(out, " {\n") <= 0)
216
0
                    return 0;
217
291k
            } else {
218
291k
                if (BIO_puts(out, "\n") <= 0)
219
0
                    return 0;
220
291k
            }
221
363k
        }
222
223
584k
        if (asn1_cb) {
224
74.2k
            i = asn1_cb(ASN1_OP_PRINT_PRE, fld, it, &parg);
225
74.2k
            if (i == 0)
226
0
                return 0;
227
74.2k
            if (i == 2)
228
0
                return 1;
229
74.2k
        }
230
231
        /* Print each field entry */
232
2.92M
        for (i = 0, tt = it->templates; i < it->tcount; i++, tt++) {
233
2.37M
            const ASN1_TEMPLATE *seqtt;
234
2.37M
            seqtt = ossl_asn1_do_adb(*fld, tt, 1);
235
2.37M
            if (!seqtt)
236
0
                return 0;
237
2.37M
            tmpfld = ossl_asn1_get_const_field_ptr(fld, seqtt);
238
2.37M
            if (!asn1_template_print_ctx(out, tmpfld,
239
2.37M
                                         indent + 2, seqtt, pctx))
240
36.9k
                return 0;
241
2.37M
        }
242
547k
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
243
153k
            if (BIO_printf(out, "%*s}\n", indent, "") < 0)
244
0
                return 0;
245
153k
        }
246
247
547k
        if (asn1_cb) {
248
55.2k
            i = asn1_cb(ASN1_OP_PRINT_POST, fld, it, &parg);
249
55.2k
            if (i == 0)
250
0
                return 0;
251
55.2k
        }
252
547k
        break;
253
254
547k
    default:
255
0
        BIO_printf(out, "Unprocessed type %d\n", it->itype);
256
0
        return 0;
257
2.51M
    }
258
259
2.33M
    return 1;
260
2.51M
}
261
262
static int asn1_template_print_ctx(BIO *out, const ASN1_VALUE **fld, int indent,
263
                            const ASN1_TEMPLATE *tt, const ASN1_PCTX *pctx)
264
2.63M
{
265
2.63M
    int i, flags;
266
2.63M
    const char *sname, *fname;
267
2.63M
    const ASN1_VALUE *tfld;
268
2.63M
    flags = tt->flags;
269
2.63M
    if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME)
270
532k
        sname = ASN1_ITEM_ptr(tt->item)->sname;
271
2.09M
    else
272
2.09M
        sname = NULL;
273
2.63M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
274
0
        fname = NULL;
275
2.63M
    else
276
2.63M
        fname = tt->field_name;
277
278
    /*
279
     * If field is embedded then fld needs fixing so it is a pointer to
280
     * a pointer to a field.
281
     */
282
2.63M
    if (flags & ASN1_TFLG_EMBED) {
283
43.7k
        tfld = (const ASN1_VALUE *)fld;
284
43.7k
        fld = &tfld;
285
43.7k
    }
286
287
2.63M
    if (flags & ASN1_TFLG_SK_MASK) {
288
318k
        char *tname;
289
318k
        const ASN1_VALUE *skitem;
290
318k
        STACK_OF(const_ASN1_VALUE) *stack;
291
292
        /* SET OF, SEQUENCE OF */
293
318k
        if (fname) {
294
318k
            if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SSOF) {
295
96.8k
                if (flags & ASN1_TFLG_SET_OF)
296
18.1k
                    tname = "SET";
297
78.6k
                else
298
78.6k
                    tname = "SEQUENCE";
299
96.8k
                if (BIO_printf(out, "%*s%s OF %s {\n",
300
96.8k
                               indent, "", tname, tt->field_name) <= 0)
301
0
                    return 0;
302
222k
            } else if (BIO_printf(out, "%*s%s:\n", indent, "", fname) <= 0)
303
0
                return 0;
304
318k
        }
305
318k
        stack = (STACK_OF(const_ASN1_VALUE) *)*fld;
306
1.35M
        for (i = 0; i < sk_const_ASN1_VALUE_num(stack); i++) {
307
1.04M
            if ((i > 0) && (BIO_puts(out, "\n") <= 0))
308
0
                return 0;
309
310
1.04M
            skitem = sk_const_ASN1_VALUE_value(stack, i);
311
1.04M
            if (!asn1_item_print_ctx(out, &skitem, indent + 2,
312
1.04M
                                     ASN1_ITEM_ptr(tt->item), NULL, NULL, 1,
313
1.04M
                                     pctx))
314
6.86k
                return 0;
315
1.04M
        }
316
312k
        if (i == 0 && BIO_printf(out, "%*s<%s>\n", indent + 2, "",
317
262k
                                 stack == NULL ? "ABSENT" : "EMPTY") <= 0)
318
0
            return 0;
319
312k
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_SEQUENCE) {
320
93.7k
            if (BIO_printf(out, "%*s}\n", indent, "") <= 0)
321
0
                return 0;
322
93.7k
        }
323
312k
        return 1;
324
312k
    }
325
2.31M
    return asn1_item_print_ctx(out, fld, indent, ASN1_ITEM_ptr(tt->item),
326
2.31M
                               fname, sname, 0, pctx);
327
2.63M
}
328
329
static int asn1_print_fsname(BIO *out, int indent,
330
                             const char *fname, const char *sname,
331
                             const ASN1_PCTX *pctx)
332
3.16M
{
333
3.16M
    static const char spaces[] = "                    ";
334
3.16M
    static const int nspaces = sizeof(spaces) - 1;
335
336
3.20M
    while (indent > nspaces) {
337
39.8k
        if (BIO_write(out, spaces, nspaces) != nspaces)
338
0
            return 0;
339
39.8k
        indent -= nspaces;
340
39.8k
    }
341
3.16M
    if (BIO_write(out, spaces, indent) != indent)
342
0
        return 0;
343
3.16M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_STRUCT_NAME)
344
0
        sname = NULL;
345
3.16M
    if (pctx->flags & ASN1_PCTX_FLAGS_NO_FIELD_NAME)
346
0
        fname = NULL;
347
3.16M
    if (!sname && !fname)
348
769k
        return 1;
349
2.39M
    if (fname) {
350
2.15M
        if (BIO_puts(out, fname) <= 0)
351
0
            return 0;
352
2.15M
    }
353
2.39M
    if (sname) {
354
667k
        if (fname) {
355
427k
            if (BIO_printf(out, " (%s)", sname) <= 0)
356
0
                return 0;
357
427k
        } else {
358
240k
            if (BIO_puts(out, sname) <= 0)
359
0
                return 0;
360
240k
        }
361
667k
    }
362
2.39M
    if (BIO_write(out, ": ", 2) != 2)
363
0
        return 0;
364
2.39M
    return 1;
365
2.39M
}
366
367
static int asn1_print_boolean(BIO *out, int boolval)
368
20.5k
{
369
20.5k
    const char *str;
370
20.5k
    switch (boolval) {
371
5.99k
    case -1:
372
5.99k
        str = "BOOL ABSENT";
373
5.99k
        break;
374
375
6.21k
    case 0:
376
6.21k
        str = "FALSE";
377
6.21k
        break;
378
379
8.37k
    default:
380
8.37k
        str = "TRUE";
381
8.37k
        break;
382
383
20.5k
    }
384
385
20.5k
    if (BIO_puts(out, str) <= 0)
386
0
        return 0;
387
20.5k
    return 1;
388
389
20.5k
}
390
391
static int asn1_print_integer(BIO *out, const ASN1_INTEGER *str)
392
629k
{
393
629k
    char *s;
394
629k
    int ret = 1;
395
629k
    s = i2s_ASN1_INTEGER(NULL, str);
396
629k
    if (s == NULL)
397
301
        return 0;
398
629k
    if (BIO_puts(out, s) <= 0)
399
0
        ret = 0;
400
629k
    OPENSSL_free(s);
401
629k
    return ret;
402
629k
}
403
404
static int asn1_print_oid(BIO *out, const ASN1_OBJECT *oid)
405
236k
{
406
236k
    char objbuf[80];
407
236k
    const char *ln;
408
236k
    ln = OBJ_nid2ln(OBJ_obj2nid(oid));
409
236k
    if (!ln)
410
0
        ln = "";
411
236k
    OBJ_obj2txt(objbuf, sizeof(objbuf), oid, 1);
412
236k
    if (BIO_printf(out, "%s (%s)", ln, objbuf) <= 0)
413
0
        return 0;
414
236k
    return 1;
415
236k
}
416
417
static int asn1_print_obstring(BIO *out, const ASN1_STRING *str, int indent)
418
171k
{
419
171k
    if (str->type == V_ASN1_BIT_STRING) {
420
83.0k
        if (BIO_printf(out, " (%ld unused bits)\n", str->flags & 0x7) <= 0)
421
0
            return 0;
422
88.2k
    } else if (BIO_puts(out, "\n") <= 0)
423
0
        return 0;
424
171k
    if ((str->length > 0)
425
171k
        && BIO_dump_indent(out, (const char *)str->data, str->length,
426
85.1k
                           indent + 2) <= 0)
427
0
        return 0;
428
171k
    return 1;
429
171k
}
430
431
static int asn1_primitive_print(BIO *out, const ASN1_VALUE **fld,
432
                                const ASN1_ITEM *it, int indent,
433
                                const char *fname, const char *sname,
434
                                const ASN1_PCTX *pctx)
435
1.57M
{
436
1.57M
    long utype;
437
1.57M
    ASN1_STRING *str;
438
1.57M
    int ret = 1, needlf = 1;
439
1.57M
    const char *pname;
440
1.57M
    const ASN1_PRIMITIVE_FUNCS *pf;
441
1.57M
    pf = it->funcs;
442
1.57M
    if (!asn1_print_fsname(out, indent, fname, sname, pctx))
443
0
        return 0;
444
1.57M
    if (pf && pf->prim_print)
445
103k
        return pf->prim_print(out, fld, it, indent, pctx);
446
1.47M
    if (it->itype == ASN1_ITYPE_MSTRING) {
447
39.1k
        str = (ASN1_STRING *)*fld;
448
39.1k
        utype = str->type & ~V_ASN1_NEG;
449
1.43M
    } else {
450
1.43M
        utype = it->utype;
451
1.43M
        if (utype == V_ASN1_BOOLEAN)
452
14.7k
            str = NULL;
453
1.42M
        else
454
1.42M
            str = (ASN1_STRING *)*fld;
455
1.43M
    }
456
1.47M
    if (utype == V_ASN1_ANY) {
457
377k
        const ASN1_TYPE *atype = (const ASN1_TYPE *)*fld;
458
377k
        utype = atype->type;
459
377k
        fld = (const ASN1_VALUE **)&atype->value.asn1_value; /* actually is const */
460
377k
        str = (ASN1_STRING *)*fld;
461
377k
        if (pctx->flags & ASN1_PCTX_FLAGS_NO_ANY_TYPE)
462
0
            pname = NULL;
463
377k
        else
464
377k
            pname = ASN1_tag2str(utype);
465
1.09M
    } else {
466
1.09M
        if (pctx->flags & ASN1_PCTX_FLAGS_SHOW_TYPE)
467
252k
            pname = ASN1_tag2str(utype);
468
844k
        else
469
844k
            pname = NULL;
470
1.09M
    }
471
472
1.47M
    if (utype == V_ASN1_NULL) {
473
20.8k
        if (BIO_puts(out, "NULL\n") <= 0)
474
0
            return 0;
475
20.8k
        return 1;
476
20.8k
    }
477
478
1.45M
    if (pname) {
479
609k
        if (BIO_puts(out, pname) <= 0)
480
0
            return 0;
481
609k
        if (BIO_puts(out, ":") <= 0)
482
0
            return 0;
483
609k
    }
484
485
1.45M
    switch (utype) {
486
20.5k
    case V_ASN1_BOOLEAN:
487
20.5k
        {
488
20.5k
            int boolval = *(int *)fld;
489
20.5k
            if (boolval == -1)
490
5.99k
                boolval = it->size;
491
20.5k
            ret = asn1_print_boolean(out, boolval);
492
20.5k
        }
493
20.5k
        break;
494
495
629k
    case V_ASN1_INTEGER:
496
629k
    case V_ASN1_ENUMERATED:
497
629k
        ret = asn1_print_integer(out, str);
498
629k
        break;
499
500
13.4k
    case V_ASN1_UTCTIME:
501
13.4k
        ret = ASN1_UTCTIME_print(out, str);
502
13.4k
        break;
503
504
10.7k
    case V_ASN1_GENERALIZEDTIME:
505
10.7k
        ret = ASN1_GENERALIZEDTIME_print(out, str);
506
10.7k
        break;
507
508
236k
    case V_ASN1_OBJECT:
509
236k
        ret = asn1_print_oid(out, (const ASN1_OBJECT *)*fld);
510
236k
        break;
511
512
88.2k
    case V_ASN1_OCTET_STRING:
513
171k
    case V_ASN1_BIT_STRING:
514
171k
        ret = asn1_print_obstring(out, str, indent);
515
171k
        needlf = 0;
516
171k
        break;
517
518
216k
    case V_ASN1_SEQUENCE:
519
243k
    case V_ASN1_SET:
520
303k
    case V_ASN1_OTHER:
521
303k
        if (BIO_puts(out, "\n") <= 0)
522
0
            return 0;
523
303k
        if (ASN1_parse_dump(out, str->data, str->length, indent, 0) <= 0)
524
11.4k
            ret = 0;
525
303k
        needlf = 0;
526
303k
        break;
527
528
68.4k
    default:
529
68.4k
        ret = ASN1_STRING_print_ex(out, str, pctx->str_flags);
530
531
1.45M
    }
532
1.45M
    if (!ret)
533
25.9k
        return 0;
534
1.42M
    if (needlf && BIO_puts(out, "\n") <= 0)
535
0
        return 0;
536
1.42M
    return 1;
537
1.42M
}