Coverage Report

Created: 2023-06-08 06:41

/src/openssl30/crypto/x509/x_name.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 1995-2022 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 <stdio.h>
11
#include "crypto/ctype.h"
12
#include "internal/cryptlib.h"
13
#include <openssl/asn1t.h>
14
#include <openssl/x509.h>
15
#include "crypto/x509.h"
16
#include "crypto/asn1.h"
17
#include "x509_local.h"
18
19
/*
20
 * Maximum length of X509_NAME: much larger than anything we should
21
 * ever see in practice.
22
 */
23
24
30.5k
#define X509_NAME_MAX (1024 * 1024)
25
26
static int x509_name_ex_d2i(ASN1_VALUE **val,
27
                            const unsigned char **in, long len,
28
                            const ASN1_ITEM *it,
29
                            int tag, int aclass, char opt, ASN1_TLC *ctx);
30
31
static int x509_name_ex_i2d(const ASN1_VALUE **val, unsigned char **out,
32
                            const ASN1_ITEM *it, int tag, int aclass);
33
static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it);
34
static void x509_name_ex_free(ASN1_VALUE **val, const ASN1_ITEM *it);
35
36
static int x509_name_encode(X509_NAME *a);
37
static int x509_name_canon(X509_NAME *a);
38
static int asn1_string_canon(ASN1_STRING *out, const ASN1_STRING *in);
39
static int i2d_name_canon(const STACK_OF(STACK_OF_X509_NAME_ENTRY) * intname,
40
                          unsigned char **in);
41
42
static int x509_name_ex_print(BIO *out, const ASN1_VALUE **pval,
43
                              int indent,
44
                              const char *fname, const ASN1_PCTX *pctx);
45
46
ASN1_SEQUENCE(X509_NAME_ENTRY) = {
47
        ASN1_SIMPLE(X509_NAME_ENTRY, object, ASN1_OBJECT),
48
        ASN1_SIMPLE(X509_NAME_ENTRY, value, ASN1_PRINTABLE)
49
} ASN1_SEQUENCE_END(X509_NAME_ENTRY)
50
51
IMPLEMENT_ASN1_FUNCTIONS(X509_NAME_ENTRY)
52
IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME_ENTRY)
53
54
/*
55
 * For the "Name" type we need a SEQUENCE OF { SET OF X509_NAME_ENTRY } so
56
 * declare two template wrappers for this
57
 */
58
59
ASN1_ITEM_TEMPLATE(X509_NAME_ENTRIES) =
60
        ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SET_OF, 0, RDNS, X509_NAME_ENTRY)
61
static_ASN1_ITEM_TEMPLATE_END(X509_NAME_ENTRIES)
62
63
ASN1_ITEM_TEMPLATE(X509_NAME_INTERNAL) =
64
        ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, Name, X509_NAME_ENTRIES)
65
static_ASN1_ITEM_TEMPLATE_END(X509_NAME_INTERNAL)
66
67
/*
68
 * Normally that's where it would end: we'd have two nested STACK structures
69
 * representing the ASN1. Unfortunately X509_NAME uses a completely different
70
 * form and caches encodings so we have to process the internal form and
71
 * convert to the external form.
72
 */
73
74
static const ASN1_EXTERN_FUNCS x509_name_ff = {
75
    NULL,
76
    x509_name_ex_new,
77
    x509_name_ex_free,
78
    0,                          /* Default clear behaviour is OK */
79
    x509_name_ex_d2i,
80
    x509_name_ex_i2d,
81
    x509_name_ex_print
82
};
83
84
IMPLEMENT_EXTERN_ASN1(X509_NAME, V_ASN1_SEQUENCE, x509_name_ff)
85
86
IMPLEMENT_ASN1_FUNCTIONS(X509_NAME)
87
88
IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME)
89
90
static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it)
91
60.4k
{
92
60.4k
    X509_NAME *ret = OPENSSL_zalloc(sizeof(*ret));
93
94
60.4k
    if (ret == NULL)
95
0
        goto memerr;
96
60.4k
    if ((ret->entries = sk_X509_NAME_ENTRY_new_null()) == NULL)
97
0
        goto memerr;
98
60.4k
    if ((ret->bytes = BUF_MEM_new()) == NULL)
99
0
        goto memerr;
100
60.4k
    ret->modified = 1;
101
60.4k
    *val = (ASN1_VALUE *)ret;
102
60.4k
    return 1;
103
104
0
 memerr:
105
0
    ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
106
0
    if (ret) {
107
0
        sk_X509_NAME_ENTRY_free(ret->entries);
108
0
        OPENSSL_free(ret);
109
0
    }
110
0
    return 0;
111
60.4k
}
112
113
static void x509_name_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
114
60.4k
{
115
60.4k
    X509_NAME *a;
116
117
60.4k
    if (pval == NULL || *pval == NULL)
118
0
        return;
119
60.4k
    a = (X509_NAME *)*pval;
120
121
60.4k
    BUF_MEM_free(a->bytes);
122
60.4k
    sk_X509_NAME_ENTRY_pop_free(a->entries, X509_NAME_ENTRY_free);
123
60.4k
    OPENSSL_free(a->canon_enc);
124
60.4k
    OPENSSL_free(a);
125
60.4k
    *pval = NULL;
126
60.4k
}
127
128
static void local_sk_X509_NAME_ENTRY_free(STACK_OF(X509_NAME_ENTRY) *ne)
129
30.2k
{
130
30.2k
    sk_X509_NAME_ENTRY_free(ne);
131
30.2k
}
132
133
static void local_sk_X509_NAME_ENTRY_pop_free(STACK_OF(X509_NAME_ENTRY) *ne)
134
30.3k
{
135
30.3k
    sk_X509_NAME_ENTRY_pop_free(ne, X509_NAME_ENTRY_free);
136
30.3k
}
137
138
static int x509_name_ex_d2i(ASN1_VALUE **val,
139
                            const unsigned char **in, long len,
140
                            const ASN1_ITEM *it, int tag, int aclass,
141
                            char opt, ASN1_TLC *ctx)
142
30.5k
{
143
30.5k
    const unsigned char *p = *in, *q;
144
30.5k
    union {
145
30.5k
        STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
146
30.5k
        ASN1_VALUE *a;
147
30.5k
    } intname = {
148
30.5k
        NULL
149
30.5k
    };
150
30.5k
    union {
151
30.5k
        X509_NAME *x;
152
30.5k
        ASN1_VALUE *a;
153
30.5k
    } nm = {
154
30.5k
        NULL
155
30.5k
    };
156
30.5k
    int i, j, ret;
157
30.5k
    STACK_OF(X509_NAME_ENTRY) *entries;
158
30.5k
    X509_NAME_ENTRY *entry;
159
160
30.5k
    if (len > X509_NAME_MAX)
161
0
        len = X509_NAME_MAX;
162
30.5k
    q = p;
163
164
    /* Get internal representation of Name */
165
30.5k
    ret = ASN1_item_ex_d2i(&intname.a,
166
30.5k
                           &p, len, ASN1_ITEM_rptr(X509_NAME_INTERNAL),
167
30.5k
                           tag, aclass, opt, ctx);
168
169
30.5k
    if (ret <= 0)
170
209
        return ret;
171
172
30.3k
    if (*val)
173
30.1k
        x509_name_ex_free(val, NULL);
174
30.3k
    if (!x509_name_ex_new(&nm.a, NULL))
175
0
        goto err;
176
    /* We've decoded it: now cache encoding */
177
30.3k
    if (!BUF_MEM_grow(nm.x->bytes, p - q))
178
0
        goto err;
179
30.3k
    memcpy(nm.x->bytes->data, q, p - q);
180
181
    /* Convert internal representation to X509_NAME structure */
182
60.7k
    for (i = 0; i < sk_STACK_OF_X509_NAME_ENTRY_num(intname.s); i++) {
183
30.3k
        entries = sk_STACK_OF_X509_NAME_ENTRY_value(intname.s, i);
184
60.6k
        for (j = 0; j < sk_X509_NAME_ENTRY_num(entries); j++) {
185
30.3k
            entry = sk_X509_NAME_ENTRY_value(entries, j);
186
30.3k
            entry->set = i;
187
30.3k
            if (!sk_X509_NAME_ENTRY_push(nm.x->entries, entry))
188
0
                goto err;
189
30.3k
            (void)sk_X509_NAME_ENTRY_set(entries, j, NULL);
190
30.3k
        }
191
30.3k
    }
192
30.3k
    ret = x509_name_canon(nm.x);
193
30.3k
    if (!ret)
194
82
        goto err;
195
30.2k
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
196
30.2k
                                         local_sk_X509_NAME_ENTRY_free);
197
30.2k
    nm.x->modified = 0;
198
30.2k
    *val = nm.a;
199
30.2k
    *in = p;
200
30.2k
    return ret;
201
202
82
 err:
203
82
    if (nm.x != NULL)
204
82
        X509_NAME_free(nm.x);
205
82
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
206
82
                                         local_sk_X509_NAME_ENTRY_pop_free);
207
82
    ERR_raise(ERR_LIB_ASN1, ERR_R_NESTED_ASN1_ERROR);
208
82
    return 0;
209
30.3k
}
210
211
static int x509_name_ex_i2d(const ASN1_VALUE **val, unsigned char **out,
212
                            const ASN1_ITEM *it, int tag, int aclass)
213
0
{
214
0
    int ret;
215
0
    X509_NAME *a = (X509_NAME *)*val;
216
217
0
    if (a->modified) {
218
0
        ret = x509_name_encode(a);
219
0
        if (ret < 0)
220
0
            return ret;
221
0
        ret = x509_name_canon(a);
222
0
        if (!ret)
223
0
            return -1;
224
0
    }
225
0
    ret = a->bytes->length;
226
0
    if (out != NULL) {
227
0
        memcpy(*out, a->bytes->data, ret);
228
0
        *out += ret;
229
0
    }
230
0
    return ret;
231
0
}
232
233
static int x509_name_encode(X509_NAME *a)
234
0
{
235
0
    union {
236
0
        STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
237
0
        const ASN1_VALUE *a;
238
0
    } intname = {
239
0
        NULL
240
0
    };
241
0
    int len;
242
0
    unsigned char *p;
243
0
    STACK_OF(X509_NAME_ENTRY) *entries = NULL;
244
0
    X509_NAME_ENTRY *entry;
245
0
    int i, set = -1;
246
247
0
    intname.s = sk_STACK_OF_X509_NAME_ENTRY_new_null();
248
0
    if (!intname.s)
249
0
        goto memerr;
250
0
    for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
251
0
        entry = sk_X509_NAME_ENTRY_value(a->entries, i);
252
0
        if (entry->set != set) {
253
0
            entries = sk_X509_NAME_ENTRY_new_null();
254
0
            if (!entries)
255
0
                goto memerr;
256
0
            if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname.s, entries)) {
257
0
                sk_X509_NAME_ENTRY_free(entries);
258
0
                goto memerr;
259
0
            }
260
0
            set = entry->set;
261
0
        }
262
0
        if (!sk_X509_NAME_ENTRY_push(entries, entry))
263
0
            goto memerr;
264
0
    }
265
0
    len = ASN1_item_ex_i2d(&intname.a, NULL,
266
0
                           ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
267
0
    if (!BUF_MEM_grow(a->bytes, len))
268
0
        goto memerr;
269
0
    p = (unsigned char *)a->bytes->data;
270
0
    ASN1_item_ex_i2d(&intname.a,
271
0
                     &p, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
272
0
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
273
0
                                         local_sk_X509_NAME_ENTRY_free);
274
0
    a->modified = 0;
275
0
    return len;
276
0
 memerr:
277
0
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
278
0
                                         local_sk_X509_NAME_ENTRY_free);
279
0
    ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
280
0
    return -1;
281
0
}
282
283
static int x509_name_ex_print(BIO *out, const ASN1_VALUE **pval,
284
                              int indent,
285
                              const char *fname, const ASN1_PCTX *pctx)
286
0
{
287
0
    if (X509_NAME_print_ex(out, (const X509_NAME *)*pval,
288
0
                           indent, pctx->nm_flags) <= 0)
289
0
        return 0;
290
0
    return 2;
291
0
}
292
293
/*
294
 * This function generates the canonical encoding of the Name structure. In
295
 * it all strings are converted to UTF8, leading, trailing and multiple
296
 * spaces collapsed, converted to lower case and the leading SEQUENCE header
297
 * removed. In future we could also normalize the UTF8 too. By doing this
298
 * comparison of Name structures can be rapidly performed by just using
299
 * memcmp() of the canonical encoding. By omitting the leading SEQUENCE name
300
 * constraints of type dirName can also be checked with a simple memcmp().
301
 * NOTE: For empty X509_NAME (NULL-DN), canon_enclen == 0 && canon_enc == NULL
302
 */
303
304
static int x509_name_canon(X509_NAME *a)
305
30.3k
{
306
30.3k
    unsigned char *p;
307
30.3k
    STACK_OF(STACK_OF_X509_NAME_ENTRY) *intname;
308
30.3k
    STACK_OF(X509_NAME_ENTRY) *entries = NULL;
309
30.3k
    X509_NAME_ENTRY *entry, *tmpentry = NULL;
310
30.3k
    int i, set = -1, ret = 0, len;
311
312
30.3k
    OPENSSL_free(a->canon_enc);
313
30.3k
    a->canon_enc = NULL;
314
    /* Special case: empty X509_NAME => null encoding */
315
30.3k
    if (sk_X509_NAME_ENTRY_num(a->entries) == 0) {
316
51
        a->canon_enclen = 0;
317
51
        return 1;
318
51
    }
319
30.3k
    intname = sk_STACK_OF_X509_NAME_ENTRY_new_null();
320
30.3k
    if (intname == NULL) {
321
0
        ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
322
0
        goto err;
323
0
    }
324
60.5k
    for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
325
30.3k
        entry = sk_X509_NAME_ENTRY_value(a->entries, i);
326
30.3k
        if (entry->set != set) {
327
30.3k
            entries = sk_X509_NAME_ENTRY_new_null();
328
30.3k
            if (entries == NULL)
329
0
                goto err;
330
30.3k
            if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname, entries)) {
331
0
                sk_X509_NAME_ENTRY_free(entries);
332
0
                ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
333
0
                goto err;
334
0
            }
335
30.3k
            set = entry->set;
336
30.3k
        }
337
30.3k
        tmpentry = X509_NAME_ENTRY_new();
338
30.3k
        if (tmpentry == NULL) {
339
0
            ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
340
0
            goto err;
341
0
        }
342
30.3k
        tmpentry->object = OBJ_dup(entry->object);
343
30.3k
        if (tmpentry->object == NULL) {
344
0
            ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
345
0
            goto err;
346
0
        }
347
30.3k
        if (!asn1_string_canon(tmpentry->value, entry->value))
348
82
            goto err;
349
30.2k
        if (!sk_X509_NAME_ENTRY_push(entries, tmpentry)) {
350
0
            ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
351
0
            goto err;
352
0
        }
353
30.2k
        tmpentry = NULL;
354
30.2k
    }
355
356
    /* Finally generate encoding */
357
30.2k
    len = i2d_name_canon(intname, NULL);
358
30.2k
    if (len < 0)
359
0
        goto err;
360
30.2k
    a->canon_enclen = len;
361
362
30.2k
    p = OPENSSL_malloc(a->canon_enclen);
363
30.2k
    if (p == NULL) {
364
0
        ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
365
0
        goto err;
366
0
    }
367
368
30.2k
    a->canon_enc = p;
369
370
30.2k
    i2d_name_canon(intname, &p);
371
372
30.2k
    ret = 1;
373
374
30.3k
 err:
375
30.3k
    X509_NAME_ENTRY_free(tmpentry);
376
30.3k
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname,
377
30.3k
                                         local_sk_X509_NAME_ENTRY_pop_free);
378
30.3k
    return ret;
379
30.2k
}
380
381
/* Bitmap of all the types of string that will be canonicalized. */
382
383
#define ASN1_MASK_CANON \
384
30.3k
        (B_ASN1_UTF8STRING | B_ASN1_BMPSTRING | B_ASN1_UNIVERSALSTRING \
385
30.3k
        | B_ASN1_PRINTABLESTRING | B_ASN1_T61STRING | B_ASN1_IA5STRING \
386
30.3k
        | B_ASN1_VISIBLESTRING)
387
388
static int asn1_string_canon(ASN1_STRING *out, const ASN1_STRING *in)
389
30.3k
{
390
30.3k
    unsigned char *to, *from;
391
30.3k
    int len, i;
392
393
    /* If type not in bitmask just copy string across */
394
30.3k
    if (!(ASN1_tag2bit(in->type) & ASN1_MASK_CANON)) {
395
28
        if (!ASN1_STRING_copy(out, in))
396
0
            return 0;
397
28
        return 1;
398
28
    }
399
400
30.3k
    out->type = V_ASN1_UTF8STRING;
401
30.3k
    out->length = ASN1_STRING_to_UTF8(&out->data, in);
402
30.3k
    if (out->length == -1)
403
82
        return 0;
404
405
30.2k
    to = out->data;
406
30.2k
    from = to;
407
408
30.2k
    len = out->length;
409
410
    /*
411
     * Convert string in place to canonical form. Ultimately we may need to
412
     * handle a wider range of characters but for now ignore anything with
413
     * MSB set and rely on the ossl_isspace() to fail on bad characters without
414
     * needing isascii or range checks as well.
415
     */
416
417
    /* Ignore leading spaces */
418
30.2k
    while (len > 0 && ossl_isspace(*from)) {
419
55
        from++;
420
55
        len--;
421
55
    }
422
423
30.2k
    to = from + len;
424
425
    /* Ignore trailing spaces */
426
30.2k
    while (len > 0 && ossl_isspace(to[-1])) {
427
44
        to--;
428
44
        len--;
429
44
    }
430
431
30.2k
    to = out->data;
432
433
30.2k
    i = 0;
434
242k
    while (i < len) {
435
        /* If not ASCII set just copy across */
436
212k
        if (!ossl_isascii(*from)) {
437
987
            *to++ = *from++;
438
987
            i++;
439
987
        }
440
        /* Collapse multiple spaces */
441
211k
        else if (ossl_isspace(*from)) {
442
            /* Copy one space across */
443
30.1k
            *to++ = ' ';
444
            /*
445
             * Ignore subsequent spaces. Note: don't need to check len here
446
             * because we know the last character is a non-space so we can't
447
             * overflow.
448
             */
449
30.1k
            do {
450
30.1k
                from++;
451
30.1k
                i++;
452
30.1k
            }
453
30.1k
            while (ossl_isspace(*from));
454
180k
        } else {
455
180k
            *to++ = ossl_tolower(*from);
456
180k
            from++;
457
180k
            i++;
458
180k
        }
459
212k
    }
460
461
30.2k
    out->length = to - out->data;
462
463
30.2k
    return 1;
464
465
30.3k
}
466
467
static int i2d_name_canon(const STACK_OF(STACK_OF_X509_NAME_ENTRY) * _intname,
468
                          unsigned char **in)
469
60.4k
{
470
60.4k
    int i, len, ltmp;
471
60.4k
    const ASN1_VALUE *v;
472
60.4k
    STACK_OF(ASN1_VALUE) *intname = (STACK_OF(ASN1_VALUE) *)_intname;
473
474
60.4k
    len = 0;
475
120k
    for (i = 0; i < sk_ASN1_VALUE_num(intname); i++) {
476
60.4k
        v = sk_ASN1_VALUE_value(intname, i);
477
60.4k
        ltmp = ASN1_item_ex_i2d(&v, in,
478
60.4k
                                ASN1_ITEM_rptr(X509_NAME_ENTRIES), -1, -1);
479
60.4k
        if (ltmp < 0)
480
0
            return ltmp;
481
60.4k
        len += ltmp;
482
60.4k
    }
483
60.4k
    return len;
484
60.4k
}
485
486
int X509_NAME_set(X509_NAME **xn, const X509_NAME *name)
487
0
{
488
0
    X509_NAME *name_copy;
489
490
0
    if (*xn == name)
491
0
        return *xn != NULL;
492
0
    if ((name_copy = X509_NAME_dup(name)) == NULL)
493
0
        return 0;
494
0
    X509_NAME_free(*xn);
495
0
    *xn = name_copy;
496
0
    return 1;
497
0
}
498
499
int X509_NAME_print(BIO *bp, const X509_NAME *name, int obase)
500
0
{
501
0
    char *s, *c, *b;
502
0
    int i;
503
504
0
    b = X509_NAME_oneline(name, NULL, 0);
505
0
    if (b == NULL)
506
0
        return 0;
507
0
    if (*b == '\0') {
508
0
        OPENSSL_free(b);
509
0
        return 1;
510
0
    }
511
0
    s = b + 1;                  /* skip the first slash */
512
513
0
    c = s;
514
0
    for (;;) {
515
0
        if (((*s == '/') &&
516
0
             (ossl_isupper(s[1]) && ((s[2] == '=') ||
517
0
                                (ossl_isupper(s[2]) && (s[3] == '='))
518
0
              ))) || (*s == '\0'))
519
0
        {
520
0
            i = s - c;
521
0
            if (BIO_write(bp, c, i) != i)
522
0
                goto err;
523
0
            c = s + 1;          /* skip following slash */
524
0
            if (*s != '\0') {
525
0
                if (BIO_write(bp, ", ", 2) != 2)
526
0
                    goto err;
527
0
            }
528
0
        }
529
0
        if (*s == '\0')
530
0
            break;
531
0
        s++;
532
0
    }
533
534
0
    OPENSSL_free(b);
535
0
    return 1;
536
0
 err:
537
0
    ERR_raise(ERR_LIB_X509, ERR_R_BUF_LIB);
538
0
    OPENSSL_free(b);
539
0
    return 0;
540
0
}
541
542
int X509_NAME_get0_der(const X509_NAME *nm, const unsigned char **pder,
543
                       size_t *pderlen)
544
0
{
545
    /* Make sure encoding is valid */
546
0
    if (i2d_X509_NAME(nm, NULL) <= 0)
547
0
        return 0;
548
0
    if (pder != NULL)
549
0
        *pder = (unsigned char *)nm->bytes->data;
550
0
    if (pderlen != NULL)
551
0
        *pderlen = nm->bytes->length;
552
0
    return 1;
553
0
}