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