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