Coverage Report

Created: 2023-06-08 06:41

/src/openssl111/crypto/x509/x_name.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the OpenSSL license (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
21.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(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(STACK_OF(STACK_OF_X509_NAME_ENTRY) * intname,
40
                          unsigned char **in);
41
42
static int x509_name_ex_print(BIO *out, 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
41.3k
{
92
41.3k
    X509_NAME *ret = OPENSSL_zalloc(sizeof(*ret));
93
94
41.3k
    if (ret == NULL)
95
0
        goto memerr;
96
41.3k
    if ((ret->entries = sk_X509_NAME_ENTRY_new_null()) == NULL)
97
0
        goto memerr;
98
41.3k
    if ((ret->bytes = BUF_MEM_new()) == NULL)
99
0
        goto memerr;
100
41.3k
    ret->modified = 1;
101
41.3k
    *val = (ASN1_VALUE *)ret;
102
41.3k
    return 1;
103
104
0
 memerr:
105
0
    ASN1err(ASN1_F_X509_NAME_EX_NEW, 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
41.3k
}
112
113
static void x509_name_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
114
41.3k
{
115
41.3k
    X509_NAME *a;
116
117
41.3k
    if (!pval || !*pval)
118
0
        return;
119
41.3k
    a = (X509_NAME *)*pval;
120
121
41.3k
    BUF_MEM_free(a->bytes);
122
41.3k
    sk_X509_NAME_ENTRY_pop_free(a->entries, X509_NAME_ENTRY_free);
123
41.3k
    OPENSSL_free(a->canon_enc);
124
41.3k
    OPENSSL_free(a);
125
41.3k
    *pval = NULL;
126
41.3k
}
127
128
static void local_sk_X509_NAME_ENTRY_free(STACK_OF(X509_NAME_ENTRY) *ne)
129
1.88M
{
130
1.88M
    sk_X509_NAME_ENTRY_free(ne);
131
1.88M
}
132
133
static void local_sk_X509_NAME_ENTRY_pop_free(STACK_OF(X509_NAME_ENTRY) *ne)
134
249k
{
135
249k
    sk_X509_NAME_ENTRY_pop_free(ne, X509_NAME_ENTRY_free);
136
249k
}
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
21.5k
{
143
21.5k
    const unsigned char *p = *in, *q;
144
21.5k
    union {
145
21.5k
        STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
146
21.5k
        ASN1_VALUE *a;
147
21.5k
    } intname = {
148
21.5k
        NULL
149
21.5k
    };
150
21.5k
    union {
151
21.5k
        X509_NAME *x;
152
21.5k
        ASN1_VALUE *a;
153
21.5k
    } nm = {
154
21.5k
        NULL
155
21.5k
    };
156
21.5k
    int i, j, ret;
157
21.5k
    STACK_OF(X509_NAME_ENTRY) *entries;
158
21.5k
    X509_NAME_ENTRY *entry;
159
21.5k
    if (len > X509_NAME_MAX)
160
0
        len = X509_NAME_MAX;
161
21.5k
    q = p;
162
163
    /* Get internal representation of Name */
164
21.5k
    ret = ASN1_item_ex_d2i(&intname.a,
165
21.5k
                           &p, len, ASN1_ITEM_rptr(X509_NAME_INTERNAL),
166
21.5k
                           tag, aclass, opt, ctx);
167
168
21.5k
    if (ret <= 0)
169
1.43k
        return ret;
170
171
20.0k
    if (*val)
172
17.1k
        x509_name_ex_free(val, NULL);
173
20.0k
    if (!x509_name_ex_new(&nm.a, NULL))
174
0
        goto err;
175
    /* We've decoded it: now cache encoding */
176
20.0k
    if (!BUF_MEM_grow(nm.x->bytes, p - q))
177
0
        goto err;
178
20.0k
    memcpy(nm.x->bytes->data, q, p - q);
179
180
    /* Convert internal representation to X509_NAME structure */
181
1.90M
    for (i = 0; i < sk_STACK_OF_X509_NAME_ENTRY_num(intname.s); i++) {
182
1.88M
        entries = sk_STACK_OF_X509_NAME_ENTRY_value(intname.s, i);
183
2.25M
        for (j = 0; j < sk_X509_NAME_ENTRY_num(entries); j++) {
184
363k
            entry = sk_X509_NAME_ENTRY_value(entries, j);
185
363k
            entry->set = i;
186
363k
            if (!sk_X509_NAME_ENTRY_push(nm.x->entries, entry))
187
0
                goto err;
188
363k
            sk_X509_NAME_ENTRY_set(entries, j, NULL);
189
363k
        }
190
1.88M
    }
191
20.0k
    ret = x509_name_canon(nm.x);
192
20.0k
    if (!ret)
193
310
        goto err;
194
19.7k
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
195
19.7k
                                         local_sk_X509_NAME_ENTRY_free);
196
19.7k
    nm.x->modified = 0;
197
19.7k
    *val = nm.a;
198
19.7k
    *in = p;
199
19.7k
    return ret;
200
201
310
 err:
202
310
    if (nm.x != NULL)
203
310
        X509_NAME_free(nm.x);
204
310
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
205
310
                                         local_sk_X509_NAME_ENTRY_pop_free);
206
310
    ASN1err(ASN1_F_X509_NAME_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
207
310
    return 0;
208
20.0k
}
209
210
static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out,
211
                            const ASN1_ITEM *it, int tag, int aclass)
212
0
{
213
0
    int ret;
214
0
    X509_NAME *a = (X509_NAME *)*val;
215
0
    if (a->modified) {
216
0
        ret = x509_name_encode(a);
217
0
        if (ret < 0)
218
0
            return ret;
219
0
        ret = x509_name_canon(a);
220
0
        if (!ret)
221
0
            return -1;
222
0
    }
223
0
    ret = a->bytes->length;
224
0
    if (out != NULL) {
225
0
        memcpy(*out, a->bytes->data, ret);
226
0
        *out += ret;
227
0
    }
228
0
    return ret;
229
0
}
230
231
static int x509_name_encode(X509_NAME *a)
232
0
{
233
0
    union {
234
0
        STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
235
0
        ASN1_VALUE *a;
236
0
    } intname = {
237
0
        NULL
238
0
    };
239
0
    int len;
240
0
    unsigned char *p;
241
0
    STACK_OF(X509_NAME_ENTRY) *entries = NULL;
242
0
    X509_NAME_ENTRY *entry;
243
0
    int i, set = -1;
244
0
    intname.s = sk_STACK_OF_X509_NAME_ENTRY_new_null();
245
0
    if (!intname.s)
246
0
        goto memerr;
247
0
    for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
248
0
        entry = sk_X509_NAME_ENTRY_value(a->entries, i);
249
0
        if (entry->set != set) {
250
0
            entries = sk_X509_NAME_ENTRY_new_null();
251
0
            if (!entries)
252
0
                goto memerr;
253
0
            if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname.s, entries)) {
254
0
                sk_X509_NAME_ENTRY_free(entries);
255
0
                goto memerr;
256
0
            }
257
0
            set = entry->set;
258
0
        }
259
0
        if (!sk_X509_NAME_ENTRY_push(entries, entry))
260
0
            goto memerr;
261
0
    }
262
0
    len = ASN1_item_ex_i2d(&intname.a, NULL,
263
0
                           ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
264
0
    if (!BUF_MEM_grow(a->bytes, len))
265
0
        goto memerr;
266
0
    p = (unsigned char *)a->bytes->data;
267
0
    ASN1_item_ex_i2d(&intname.a,
268
0
                     &p, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
269
0
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
270
0
                                         local_sk_X509_NAME_ENTRY_free);
271
0
    a->modified = 0;
272
0
    return len;
273
0
 memerr:
274
0
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
275
0
                                         local_sk_X509_NAME_ENTRY_free);
276
0
    ASN1err(ASN1_F_X509_NAME_ENCODE, ERR_R_MALLOC_FAILURE);
277
0
    return -1;
278
0
}
279
280
static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
281
                              int indent,
282
                              const char *fname, const ASN1_PCTX *pctx)
283
0
{
284
0
    if (X509_NAME_print_ex(out, (const X509_NAME *)*pval,
285
0
                           indent, pctx->nm_flags) <= 0)
286
0
        return 0;
287
0
    return 2;
288
0
}
289
290
/*
291
 * This function generates the canonical encoding of the Name structure. In
292
 * it all strings are converted to UTF8, leading, trailing and multiple
293
 * spaces collapsed, converted to lower case and the leading SEQUENCE header
294
 * removed. In future we could also normalize the UTF8 too. By doing this
295
 * comparison of Name structures can be rapidly performed by just using
296
 * memcmp() of the canonical encoding. By omitting the leading SEQUENCE name
297
 * constraints of type dirName can also be checked with a simple memcmp().
298
 */
299
300
static int x509_name_canon(X509_NAME *a)
301
20.0k
{
302
20.0k
    unsigned char *p;
303
20.0k
    STACK_OF(STACK_OF_X509_NAME_ENTRY) *intname;
304
20.0k
    STACK_OF(X509_NAME_ENTRY) *entries = NULL;
305
20.0k
    X509_NAME_ENTRY *entry, *tmpentry = NULL;
306
20.0k
    int i, set = -1, ret = 0, len;
307
308
20.0k
    OPENSSL_free(a->canon_enc);
309
20.0k
    a->canon_enc = NULL;
310
    /* Special case: empty X509_NAME => null encoding */
311
20.0k
    if (sk_X509_NAME_ENTRY_num(a->entries) == 0) {
312
17.9k
        a->canon_enclen = 0;
313
17.9k
        return 1;
314
17.9k
    }
315
2.16k
    intname = sk_STACK_OF_X509_NAME_ENTRY_new_null();
316
2.16k
    if (intname == NULL) {
317
0
        X509err(X509_F_X509_NAME_CANON, ERR_R_MALLOC_FAILURE);
318
0
        goto err;
319
0
    }
320
365k
    for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
321
363k
        entry = sk_X509_NAME_ENTRY_value(a->entries, i);
322
363k
        if (entry->set != set) {
323
246k
            entries = sk_X509_NAME_ENTRY_new_null();
324
246k
            if (entries == NULL)
325
0
                goto err;
326
246k
            if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname, entries)) {
327
0
                sk_X509_NAME_ENTRY_free(entries);
328
0
                X509err(X509_F_X509_NAME_CANON, ERR_R_MALLOC_FAILURE);
329
0
                goto err;
330
0
            }
331
246k
            set = entry->set;
332
246k
        }
333
363k
        tmpentry = X509_NAME_ENTRY_new();
334
363k
        if (tmpentry == NULL) {
335
0
            X509err(X509_F_X509_NAME_CANON, ERR_R_MALLOC_FAILURE);
336
0
            goto err;
337
0
        }
338
363k
        tmpentry->object = OBJ_dup(entry->object);
339
363k
        if (tmpentry->object == NULL) {
340
0
            X509err(X509_F_X509_NAME_CANON, ERR_R_MALLOC_FAILURE);
341
0
            goto err;
342
0
        }
343
363k
        if (!asn1_string_canon(tmpentry->value, entry->value))
344
310
            goto err;
345
362k
        if (!sk_X509_NAME_ENTRY_push(entries, tmpentry)) {
346
0
            X509err(X509_F_X509_NAME_CANON, ERR_R_MALLOC_FAILURE);
347
0
            goto err;
348
0
        }
349
362k
        tmpentry = NULL;
350
362k
    }
351
352
    /* Finally generate encoding */
353
1.85k
    len = i2d_name_canon(intname, NULL);
354
1.85k
    if (len < 0)
355
0
        goto err;
356
1.85k
    a->canon_enclen = len;
357
358
1.85k
    p = OPENSSL_malloc(a->canon_enclen);
359
1.85k
    if (p == NULL) {
360
0
        X509err(X509_F_X509_NAME_CANON, ERR_R_MALLOC_FAILURE);
361
0
        goto err;
362
0
    }
363
364
1.85k
    a->canon_enc = p;
365
366
1.85k
    i2d_name_canon(intname, &p);
367
368
1.85k
    ret = 1;
369
370
2.16k
 err:
371
2.16k
    X509_NAME_ENTRY_free(tmpentry);
372
2.16k
    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname,
373
2.16k
                                         local_sk_X509_NAME_ENTRY_pop_free);
374
2.16k
    return ret;
375
1.85k
}
376
377
/* Bitmap of all the types of string that will be canonicalized. */
378
379
#define ASN1_MASK_CANON \
380
363k
        (B_ASN1_UTF8STRING | B_ASN1_BMPSTRING | B_ASN1_UNIVERSALSTRING \
381
363k
        | B_ASN1_PRINTABLESTRING | B_ASN1_T61STRING | B_ASN1_IA5STRING \
382
363k
        | B_ASN1_VISIBLESTRING)
383
384
static int asn1_string_canon(ASN1_STRING *out, const ASN1_STRING *in)
385
363k
{
386
363k
    unsigned char *to, *from;
387
363k
    int len, i;
388
389
    /* If type not in bitmask just copy string across */
390
363k
    if (!(ASN1_tag2bit(in->type) & ASN1_MASK_CANON)) {
391
216k
        if (!ASN1_STRING_copy(out, in))
392
0
            return 0;
393
216k
        return 1;
394
216k
    }
395
396
146k
    out->type = V_ASN1_UTF8STRING;
397
146k
    out->length = ASN1_STRING_to_UTF8(&out->data, in);
398
146k
    if (out->length == -1)
399
310
        return 0;
400
401
146k
    to = out->data;
402
146k
    from = to;
403
404
146k
    len = out->length;
405
406
    /*
407
     * Convert string in place to canonical form. Ultimately we may need to
408
     * handle a wider range of characters but for now ignore anything with
409
     * MSB set and rely on the ossl_isspace() to fail on bad characters without
410
     * needing isascii or range checks as well.
411
     */
412
413
    /* Ignore leading spaces */
414
146k
    while (len > 0 && ossl_isspace(*from)) {
415
578
        from++;
416
578
        len--;
417
578
    }
418
419
146k
    to = from + len;
420
421
    /* Ignore trailing spaces */
422
146k
    while (len > 0 && ossl_isspace(to[-1])) {
423
270
        to--;
424
270
        len--;
425
270
    }
426
427
146k
    to = out->data;
428
429
146k
    i = 0;
430
22.1M
    while (i < len) {
431
        /* If not ASCII set just copy across */
432
22.0M
        if (!ossl_isascii(*from)) {
433
21.7M
            *to++ = *from++;
434
21.7M
            i++;
435
21.7M
        }
436
        /* Collapse multiple spaces */
437
263k
        else if (ossl_isspace(*from)) {
438
            /* Copy one space across */
439
14.6k
            *to++ = ' ';
440
            /*
441
             * Ignore subsequent spaces. Note: don't need to check len here
442
             * because we know the last character is a non-space so we can't
443
             * overflow.
444
             */
445
17.3k
            do {
446
17.3k
                from++;
447
17.3k
                i++;
448
17.3k
            }
449
17.3k
            while (ossl_isspace(*from));
450
248k
        } else {
451
248k
            *to++ = ossl_tolower(*from);
452
248k
            from++;
453
248k
            i++;
454
248k
        }
455
22.0M
    }
456
457
146k
    out->length = to - out->data;
458
459
146k
    return 1;
460
461
146k
}
462
463
static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) * _intname,
464
                          unsigned char **in)
465
3.71k
{
466
3.71k
    int i, len, ltmp;
467
3.71k
    ASN1_VALUE *v;
468
3.71k
    STACK_OF(ASN1_VALUE) *intname = (STACK_OF(ASN1_VALUE) *)_intname;
469
470
3.71k
    len = 0;
471
496k
    for (i = 0; i < sk_ASN1_VALUE_num(intname); i++) {
472
492k
        v = sk_ASN1_VALUE_value(intname, i);
473
492k
        ltmp = ASN1_item_ex_i2d(&v, in,
474
492k
                                ASN1_ITEM_rptr(X509_NAME_ENTRIES), -1, -1);
475
492k
        if (ltmp < 0)
476
0
            return ltmp;
477
492k
        len += ltmp;
478
492k
    }
479
3.71k
    return len;
480
3.71k
}
481
482
int X509_NAME_set(X509_NAME **xn, X509_NAME *name)
483
0
{
484
0
    if (*xn == name)
485
0
        return *xn != NULL;
486
0
    if ((name = X509_NAME_dup(name)) == NULL)
487
0
        return 0;
488
0
    X509_NAME_free(*xn);
489
0
    *xn = name;
490
0
    return 1;
491
0
}
492
493
int X509_NAME_print(BIO *bp, const X509_NAME *name, int obase)
494
8.73k
{
495
8.73k
    char *s, *c, *b;
496
8.73k
    int i;
497
498
8.73k
    b = X509_NAME_oneline(name, NULL, 0);
499
8.73k
    if (!b)
500
35
        return 0;
501
8.70k
    if (!*b) {
502
7.91k
        OPENSSL_free(b);
503
7.91k
        return 1;
504
7.91k
    }
505
788
    s = b + 1;                  /* skip the first slash */
506
507
788
    c = s;
508
35.8M
    for (;;) {
509
35.8M
        if (((*s == '/') &&
510
35.8M
             (ossl_isupper(s[1]) && ((s[2] == '=') ||
511
2.05k
                                (ossl_isupper(s[2]) && (s[3] == '='))
512
35.8M
              ))) || (*s == '\0'))
513
2.14k
        {
514
2.14k
            i = s - c;
515
2.14k
            if (BIO_write(bp, c, i) != i)
516
0
                goto err;
517
2.14k
            c = s + 1;          /* skip following slash */
518
2.14k
            if (*s != '\0') {
519
1.35k
                if (BIO_write(bp, ", ", 2) != 2)
520
0
                    goto err;
521
1.35k
            }
522
2.14k
        }
523
35.8M
        if (*s == '\0')
524
788
            break;
525
35.8M
        s++;
526
35.8M
    }
527
528
788
    OPENSSL_free(b);
529
788
    return 1;
530
0
 err:
531
0
    X509err(X509_F_X509_NAME_PRINT, ERR_R_BUF_LIB);
532
0
    OPENSSL_free(b);
533
0
    return 0;
534
788
}
535
536
int X509_NAME_get0_der(X509_NAME *nm, const unsigned char **pder,
537
                       size_t *pderlen)
538
0
{
539
    /* Make sure encoding is valid */
540
0
    if (i2d_X509_NAME(nm, NULL) <= 0)
541
0
        return 0;
542
0
    if (pder != NULL)
543
0
        *pder = (unsigned char *)nm->bytes->data;
544
0
    if (pderlen != NULL)
545
0
        *pderlen = nm->bytes->length;
546
0
    return 1;
547
0
}