x_name.c revision 298999
1/* crypto/asn1/x_name.c */
2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3 * All rights reserved.
4 *
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
8 *
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to.  The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 *
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
22 *
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
26 * 1. Redistributions of source code must retain the copyright
27 *    notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 *    notice, this list of conditions and the following disclaimer in the
30 *    documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 *    must display the following acknowledgement:
33 *    "This product includes cryptographic software written by
34 *     Eric Young (eay@cryptsoft.com)"
35 *    The word 'cryptographic' can be left out if the rouines from the library
36 *    being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 *    the apps directory (application code) you must include an acknowledgement:
39 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 *
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
52 *
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed.  i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
57 */
58
59#include <stdio.h>
60#include <ctype.h>
61#include "cryptlib.h"
62#include <openssl/asn1t.h>
63#include <openssl/x509.h>
64#include "asn1_locl.h"
65
66typedef STACK_OF(X509_NAME_ENTRY) STACK_OF_X509_NAME_ENTRY;
67DECLARE_STACK_OF(STACK_OF_X509_NAME_ENTRY)
68
69/*
70 * Maximum length of X509_NAME: much larger than anything we should
71 * ever see in practice.
72 */
73
74#define X509_NAME_MAX (1024 * 1024)
75
76static int x509_name_ex_d2i(ASN1_VALUE **val,
77                            const unsigned char **in, long len,
78                            const ASN1_ITEM *it,
79                            int tag, int aclass, char opt, ASN1_TLC *ctx);
80
81static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out,
82                            const ASN1_ITEM *it, int tag, int aclass);
83static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it);
84static void x509_name_ex_free(ASN1_VALUE **val, const ASN1_ITEM *it);
85
86static int x509_name_encode(X509_NAME *a);
87static int x509_name_canon(X509_NAME *a);
88static int asn1_string_canon(ASN1_STRING *out, ASN1_STRING *in);
89static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) * intname,
90                          unsigned char **in);
91
92static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
93                              int indent,
94                              const char *fname, const ASN1_PCTX *pctx);
95
96ASN1_SEQUENCE(X509_NAME_ENTRY) = {
97        ASN1_SIMPLE(X509_NAME_ENTRY, object, ASN1_OBJECT),
98        ASN1_SIMPLE(X509_NAME_ENTRY, value, ASN1_PRINTABLE)
99} ASN1_SEQUENCE_END(X509_NAME_ENTRY)
100
101IMPLEMENT_ASN1_FUNCTIONS(X509_NAME_ENTRY)
102IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME_ENTRY)
103
104/*
105 * For the "Name" type we need a SEQUENCE OF { SET OF X509_NAME_ENTRY } so
106 * declare two template wrappers for this
107 */
108
109ASN1_ITEM_TEMPLATE(X509_NAME_ENTRIES) =
110        ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SET_OF, 0, RDNS, X509_NAME_ENTRY)
111ASN1_ITEM_TEMPLATE_END(X509_NAME_ENTRIES)
112
113ASN1_ITEM_TEMPLATE(X509_NAME_INTERNAL) =
114        ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, Name, X509_NAME_ENTRIES)
115ASN1_ITEM_TEMPLATE_END(X509_NAME_INTERNAL)
116
117/*
118 * Normally that's where it would end: we'd have two nested STACK structures
119 * representing the ASN1. Unfortunately X509_NAME uses a completely different
120 * form and caches encodings so we have to process the internal form and
121 * convert to the external form.
122 */
123
124const ASN1_EXTERN_FUNCS x509_name_ff = {
125    NULL,
126    x509_name_ex_new,
127    x509_name_ex_free,
128    0,                          /* Default clear behaviour is OK */
129    x509_name_ex_d2i,
130    x509_name_ex_i2d,
131    x509_name_ex_print
132};
133
134IMPLEMENT_EXTERN_ASN1(X509_NAME, V_ASN1_SEQUENCE, x509_name_ff)
135
136IMPLEMENT_ASN1_FUNCTIONS(X509_NAME)
137
138IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME)
139
140static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it)
141{
142    X509_NAME *ret = NULL;
143    ret = OPENSSL_malloc(sizeof(X509_NAME));
144    if (!ret)
145        goto memerr;
146    if ((ret->entries = sk_X509_NAME_ENTRY_new_null()) == NULL)
147        goto memerr;
148    if ((ret->bytes = BUF_MEM_new()) == NULL)
149        goto memerr;
150    ret->canon_enc = NULL;
151    ret->canon_enclen = 0;
152    ret->modified = 1;
153    *val = (ASN1_VALUE *)ret;
154    return 1;
155
156 memerr:
157    ASN1err(ASN1_F_X509_NAME_EX_NEW, ERR_R_MALLOC_FAILURE);
158    if (ret) {
159        if (ret->entries)
160            sk_X509_NAME_ENTRY_free(ret->entries);
161        OPENSSL_free(ret);
162    }
163    return 0;
164}
165
166static void x509_name_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
167{
168    X509_NAME *a;
169    if (!pval || !*pval)
170        return;
171    a = (X509_NAME *)*pval;
172
173    BUF_MEM_free(a->bytes);
174    sk_X509_NAME_ENTRY_pop_free(a->entries, X509_NAME_ENTRY_free);
175    if (a->canon_enc)
176        OPENSSL_free(a->canon_enc);
177    OPENSSL_free(a);
178    *pval = NULL;
179}
180
181static int x509_name_ex_d2i(ASN1_VALUE **val,
182                            const unsigned char **in, long len,
183                            const ASN1_ITEM *it, int tag, int aclass,
184                            char opt, ASN1_TLC *ctx)
185{
186    const unsigned char *p = *in, *q;
187    union {
188        STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
189        ASN1_VALUE *a;
190    } intname = {
191        NULL
192    };
193    union {
194        X509_NAME *x;
195        ASN1_VALUE *a;
196    } nm = {
197        NULL
198    };
199    int i, j, ret;
200    STACK_OF(X509_NAME_ENTRY) *entries;
201    X509_NAME_ENTRY *entry;
202    if (len > X509_NAME_MAX) {
203        ASN1err(ASN1_F_X509_NAME_EX_D2I, ASN1_R_TOO_LONG);
204        return 0;
205    }
206    q = p;
207
208    /* Get internal representation of Name */
209    ret = ASN1_item_ex_d2i(&intname.a,
210                           &p, len, ASN1_ITEM_rptr(X509_NAME_INTERNAL),
211                           tag, aclass, opt, ctx);
212
213    if (ret <= 0)
214        return ret;
215
216    if (*val)
217        x509_name_ex_free(val, NULL);
218    if (!x509_name_ex_new(&nm.a, NULL))
219        goto err;
220    /* We've decoded it: now cache encoding */
221    if (!BUF_MEM_grow(nm.x->bytes, p - q))
222        goto err;
223    memcpy(nm.x->bytes->data, q, p - q);
224
225    /* Convert internal representation to X509_NAME structure */
226    for (i = 0; i < sk_STACK_OF_X509_NAME_ENTRY_num(intname.s); i++) {
227        entries = sk_STACK_OF_X509_NAME_ENTRY_value(intname.s, i);
228        for (j = 0; j < sk_X509_NAME_ENTRY_num(entries); j++) {
229            entry = sk_X509_NAME_ENTRY_value(entries, j);
230            entry->set = i;
231            if (!sk_X509_NAME_ENTRY_push(nm.x->entries, entry))
232                goto err;
233        }
234        sk_X509_NAME_ENTRY_free(entries);
235    }
236    sk_STACK_OF_X509_NAME_ENTRY_free(intname.s);
237    ret = x509_name_canon(nm.x);
238    if (!ret)
239        goto err;
240    nm.x->modified = 0;
241    *val = nm.a;
242    *in = p;
243    return ret;
244 err:
245    if (nm.x != NULL)
246        X509_NAME_free(nm.x);
247    ASN1err(ASN1_F_X509_NAME_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
248    return 0;
249}
250
251static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out,
252                            const ASN1_ITEM *it, int tag, int aclass)
253{
254    int ret;
255    X509_NAME *a = (X509_NAME *)*val;
256    if (a->modified) {
257        ret = x509_name_encode(a);
258        if (ret < 0)
259            return ret;
260        ret = x509_name_canon(a);
261        if (ret < 0)
262            return ret;
263    }
264    ret = a->bytes->length;
265    if (out != NULL) {
266        memcpy(*out, a->bytes->data, ret);
267        *out += ret;
268    }
269    return ret;
270}
271
272static void local_sk_X509_NAME_ENTRY_free(STACK_OF(X509_NAME_ENTRY) *ne)
273{
274    sk_X509_NAME_ENTRY_free(ne);
275}
276
277static void local_sk_X509_NAME_ENTRY_pop_free(STACK_OF(X509_NAME_ENTRY) *ne)
278{
279    sk_X509_NAME_ENTRY_pop_free(ne, X509_NAME_ENTRY_free);
280}
281
282static int x509_name_encode(X509_NAME *a)
283{
284    union {
285        STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
286        ASN1_VALUE *a;
287    } intname = {
288        NULL
289    };
290    int len;
291    unsigned char *p;
292    STACK_OF(X509_NAME_ENTRY) *entries = NULL;
293    X509_NAME_ENTRY *entry;
294    int i, set = -1;
295    intname.s = sk_STACK_OF_X509_NAME_ENTRY_new_null();
296    if (!intname.s)
297        goto memerr;
298    for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
299        entry = sk_X509_NAME_ENTRY_value(a->entries, i);
300        if (entry->set != set) {
301            entries = sk_X509_NAME_ENTRY_new_null();
302            if (!entries)
303                goto memerr;
304            if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname.s, entries))
305                goto memerr;
306            set = entry->set;
307        }
308        if (!sk_X509_NAME_ENTRY_push(entries, entry))
309            goto memerr;
310    }
311    len = ASN1_item_ex_i2d(&intname.a, NULL,
312                           ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
313    if (!BUF_MEM_grow(a->bytes, len))
314        goto memerr;
315    p = (unsigned char *)a->bytes->data;
316    ASN1_item_ex_i2d(&intname.a,
317                     &p, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
318    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
319                                         local_sk_X509_NAME_ENTRY_free);
320    a->modified = 0;
321    return len;
322 memerr:
323    sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
324                                         local_sk_X509_NAME_ENTRY_free);
325    ASN1err(ASN1_F_X509_NAME_ENCODE, ERR_R_MALLOC_FAILURE);
326    return -1;
327}
328
329static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
330                              int indent,
331                              const char *fname, const ASN1_PCTX *pctx)
332{
333    if (X509_NAME_print_ex(out, (X509_NAME *)*pval,
334                           indent, pctx->nm_flags) <= 0)
335        return 0;
336    return 2;
337}
338
339/*
340 * This function generates the canonical encoding of the Name structure. In
341 * it all strings are converted to UTF8, leading, trailing and multiple
342 * spaces collapsed, converted to lower case and the leading SEQUENCE header
343 * removed. In future we could also normalize the UTF8 too. By doing this
344 * comparison of Name structures can be rapidly perfomed by just using
345 * memcmp() of the canonical encoding. By omitting the leading SEQUENCE name
346 * constraints of type dirName can also be checked with a simple memcmp().
347 */
348
349static int x509_name_canon(X509_NAME *a)
350{
351    unsigned char *p;
352    STACK_OF(STACK_OF_X509_NAME_ENTRY) *intname = NULL;
353    STACK_OF(X509_NAME_ENTRY) *entries = NULL;
354    X509_NAME_ENTRY *entry, *tmpentry = NULL;
355    int i, set = -1, ret = 0;
356
357    if (a->canon_enc) {
358        OPENSSL_free(a->canon_enc);
359        a->canon_enc = NULL;
360    }
361    /* Special case: empty X509_NAME => null encoding */
362    if (sk_X509_NAME_ENTRY_num(a->entries) == 0) {
363        a->canon_enclen = 0;
364        return 1;
365    }
366    intname = sk_STACK_OF_X509_NAME_ENTRY_new_null();
367    if (!intname)
368        goto err;
369    for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
370        entry = sk_X509_NAME_ENTRY_value(a->entries, i);
371        if (entry->set != set) {
372            entries = sk_X509_NAME_ENTRY_new_null();
373            if (!entries)
374                goto err;
375            if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname, entries))
376                goto err;
377            set = entry->set;
378        }
379        tmpentry = X509_NAME_ENTRY_new();
380        if (!tmpentry)
381            goto err;
382        tmpentry->object = OBJ_dup(entry->object);
383        if (!asn1_string_canon(tmpentry->value, entry->value))
384            goto err;
385        if (!sk_X509_NAME_ENTRY_push(entries, tmpentry))
386            goto err;
387        tmpentry = NULL;
388    }
389
390    /* Finally generate encoding */
391
392    a->canon_enclen = i2d_name_canon(intname, NULL);
393
394    p = OPENSSL_malloc(a->canon_enclen);
395
396    if (!p)
397        goto err;
398
399    a->canon_enc = p;
400
401    i2d_name_canon(intname, &p);
402
403    ret = 1;
404
405 err:
406
407    if (tmpentry)
408        X509_NAME_ENTRY_free(tmpentry);
409    if (intname)
410        sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname,
411                                             local_sk_X509_NAME_ENTRY_pop_free);
412    return ret;
413}
414
415/* Bitmap of all the types of string that will be canonicalized. */
416
417#define ASN1_MASK_CANON \
418        (B_ASN1_UTF8STRING | B_ASN1_BMPSTRING | B_ASN1_UNIVERSALSTRING \
419        | B_ASN1_PRINTABLESTRING | B_ASN1_T61STRING | B_ASN1_IA5STRING \
420        | B_ASN1_VISIBLESTRING)
421
422static int asn1_string_canon(ASN1_STRING *out, ASN1_STRING *in)
423{
424    unsigned char *to, *from;
425    int len, i;
426
427    /* If type not in bitmask just copy string across */
428    if (!(ASN1_tag2bit(in->type) & ASN1_MASK_CANON)) {
429        if (!ASN1_STRING_copy(out, in))
430            return 0;
431        return 1;
432    }
433
434    out->type = V_ASN1_UTF8STRING;
435    out->length = ASN1_STRING_to_UTF8(&out->data, in);
436    if (out->length == -1)
437        return 0;
438
439    to = out->data;
440    from = to;
441
442    len = out->length;
443
444    /*
445     * Convert string in place to canonical form. Ultimately we may need to
446     * handle a wider range of characters but for now ignore anything with
447     * MSB set and rely on the isspace() and tolower() functions.
448     */
449
450    /* Ignore leading spaces */
451    while ((len > 0) && !(*from & 0x80) && isspace(*from)) {
452        from++;
453        len--;
454    }
455
456    to = from + len - 1;
457
458    /* Ignore trailing spaces */
459    while ((len > 0) && !(*to & 0x80) && isspace(*to)) {
460        to--;
461        len--;
462    }
463
464    to = out->data;
465
466    i = 0;
467    while (i < len) {
468        /* If MSB set just copy across */
469        if (*from & 0x80) {
470            *to++ = *from++;
471            i++;
472        }
473        /* Collapse multiple spaces */
474        else if (isspace(*from)) {
475            /* Copy one space across */
476            *to++ = ' ';
477            /*
478             * Ignore subsequent spaces. Note: don't need to check len here
479             * because we know the last character is a non-space so we can't
480             * overflow.
481             */
482            do {
483                from++;
484                i++;
485            }
486            while (!(*from & 0x80) && isspace(*from));
487        } else {
488            *to++ = tolower(*from);
489            from++;
490            i++;
491        }
492    }
493
494    out->length = to - out->data;
495
496    return 1;
497
498}
499
500static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) * _intname,
501                          unsigned char **in)
502{
503    int i, len, ltmp;
504    ASN1_VALUE *v;
505    STACK_OF(ASN1_VALUE) *intname = (STACK_OF(ASN1_VALUE) *)_intname;
506
507    len = 0;
508    for (i = 0; i < sk_ASN1_VALUE_num(intname); i++) {
509        v = sk_ASN1_VALUE_value(intname, i);
510        ltmp = ASN1_item_ex_i2d(&v, in,
511                                ASN1_ITEM_rptr(X509_NAME_ENTRIES), -1, -1);
512        if (ltmp < 0)
513            return ltmp;
514        len += ltmp;
515    }
516    return len;
517}
518
519int X509_NAME_set(X509_NAME **xn, X509_NAME *name)
520{
521    X509_NAME *in;
522
523    if (!xn || !name)
524        return (0);
525
526    if (*xn != name) {
527        in = X509_NAME_dup(name);
528        if (in != NULL) {
529            X509_NAME_free(*xn);
530            *xn = in;
531        }
532    }
533    return (*xn != NULL);
534}
535
536IMPLEMENT_STACK_OF(X509_NAME_ENTRY)
537
538IMPLEMENT_ASN1_SET_OF(X509_NAME_ENTRY)
539