1 /* crypto/asn1/x_name.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
62 #include <openssl/asn1t.h>
63 #include <openssl/x509.h>
64 #include "asn1_locl.h"
66 typedef STACK_OF(X509_NAME_ENTRY
) STACK_OF_X509_NAME_ENTRY
;
67 DECLARE_STACK_OF(STACK_OF_X509_NAME_ENTRY
)
69 static int x509_name_ex_d2i(ASN1_VALUE
**val
,
70 const unsigned char **in
, long len
,
72 int tag
, int aclass
, char opt
, ASN1_TLC
*ctx
);
74 static int x509_name_ex_i2d(ASN1_VALUE
**val
, unsigned char **out
,
75 const ASN1_ITEM
*it
, int tag
, int aclass
);
76 static int x509_name_ex_new(ASN1_VALUE
**val
, const ASN1_ITEM
*it
);
77 static void x509_name_ex_free(ASN1_VALUE
**val
, const ASN1_ITEM
*it
);
79 static int x509_name_encode(X509_NAME
*a
);
80 static int x509_name_canon(X509_NAME
*a
);
81 static int asn1_string_canon(ASN1_STRING
*out
, ASN1_STRING
*in
);
82 static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY
) * intname
,
85 static int x509_name_ex_print(BIO
*out
, ASN1_VALUE
**pval
,
87 const char *fname
, const ASN1_PCTX
*pctx
);
89 ASN1_SEQUENCE(X509_NAME_ENTRY
) = {
90 ASN1_SIMPLE(X509_NAME_ENTRY
, object
, ASN1_OBJECT
),
91 ASN1_SIMPLE(X509_NAME_ENTRY
, value
, ASN1_PRINTABLE
)
92 } ASN1_SEQUENCE_END(X509_NAME_ENTRY
)
94 IMPLEMENT_ASN1_FUNCTIONS(X509_NAME_ENTRY
)
95 IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME_ENTRY
)
98 * For the "Name" type we need a SEQUENCE OF { SET OF X509_NAME_ENTRY } so
99 * declare two template wrappers for this
102 ASN1_ITEM_TEMPLATE(X509_NAME_ENTRIES
) =
103 ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SET_OF
, 0, RDNS
, X509_NAME_ENTRY
)
104 ASN1_ITEM_TEMPLATE_END(X509_NAME_ENTRIES
)
106 ASN1_ITEM_TEMPLATE(X509_NAME_INTERNAL
) =
107 ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF
, 0, Name
, X509_NAME_ENTRIES
)
108 ASN1_ITEM_TEMPLATE_END(X509_NAME_INTERNAL
)
111 * Normally that's where it would end: we'd have two nested STACK structures
112 * representing the ASN1. Unfortunately X509_NAME uses a completely different
113 * form and caches encodings so we have to process the internal form and
114 * convert to the external form.
117 const ASN1_EXTERN_FUNCS x509_name_ff
= {
121 0, /* Default clear behaviour is OK */
127 IMPLEMENT_EXTERN_ASN1(X509_NAME
, V_ASN1_SEQUENCE
, x509_name_ff
)
129 IMPLEMENT_ASN1_FUNCTIONS(X509_NAME
)
131 IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME
)
133 static int x509_name_ex_new(ASN1_VALUE
**val
, const ASN1_ITEM
*it
)
135 X509_NAME
*ret
= NULL
;
136 ret
= OPENSSL_malloc(sizeof(X509_NAME
));
139 if ((ret
->entries
= sk_X509_NAME_ENTRY_new_null()) == NULL
)
141 if ((ret
->bytes
= BUF_MEM_new()) == NULL
)
143 ret
->canon_enc
= NULL
;
144 ret
->canon_enclen
= 0;
146 *val
= (ASN1_VALUE
*)ret
;
150 ASN1err(ASN1_F_X509_NAME_EX_NEW
, ERR_R_MALLOC_FAILURE
);
153 sk_X509_NAME_ENTRY_free(ret
->entries
);
159 static void x509_name_ex_free(ASN1_VALUE
**pval
, const ASN1_ITEM
*it
)
164 a
= (X509_NAME
*)*pval
;
166 BUF_MEM_free(a
->bytes
);
167 sk_X509_NAME_ENTRY_pop_free(a
->entries
, X509_NAME_ENTRY_free
);
169 OPENSSL_free(a
->canon_enc
);
174 static int x509_name_ex_d2i(ASN1_VALUE
**val
,
175 const unsigned char **in
, long len
,
176 const ASN1_ITEM
*it
, int tag
, int aclass
,
177 char opt
, ASN1_TLC
*ctx
)
179 const unsigned char *p
= *in
, *q
;
181 STACK_OF(STACK_OF_X509_NAME_ENTRY
) *s
;
193 STACK_OF(X509_NAME_ENTRY
) *entries
;
194 X509_NAME_ENTRY
*entry
;
197 /* Get internal representation of Name */
198 ret
= ASN1_item_ex_d2i(&intname
.a
,
199 &p
, len
, ASN1_ITEM_rptr(X509_NAME_INTERNAL
),
200 tag
, aclass
, opt
, ctx
);
206 x509_name_ex_free(val
, NULL
);
207 if (!x509_name_ex_new(&nm
.a
, NULL
))
209 /* We've decoded it: now cache encoding */
210 if (!BUF_MEM_grow(nm
.x
->bytes
, p
- q
))
212 memcpy(nm
.x
->bytes
->data
, q
, p
- q
);
214 /* Convert internal representation to X509_NAME structure */
215 for (i
= 0; i
< sk_STACK_OF_X509_NAME_ENTRY_num(intname
.s
); i
++) {
216 entries
= sk_STACK_OF_X509_NAME_ENTRY_value(intname
.s
, i
);
217 for (j
= 0; j
< sk_X509_NAME_ENTRY_num(entries
); j
++) {
218 entry
= sk_X509_NAME_ENTRY_value(entries
, j
);
220 if (!sk_X509_NAME_ENTRY_push(nm
.x
->entries
, entry
))
223 sk_X509_NAME_ENTRY_free(entries
);
225 sk_STACK_OF_X509_NAME_ENTRY_free(intname
.s
);
226 ret
= x509_name_canon(nm
.x
);
235 X509_NAME_free(nm
.x
);
236 ASN1err(ASN1_F_X509_NAME_EX_D2I
, ERR_R_NESTED_ASN1_ERROR
);
240 static int x509_name_ex_i2d(ASN1_VALUE
**val
, unsigned char **out
,
241 const ASN1_ITEM
*it
, int tag
, int aclass
)
244 X509_NAME
*a
= (X509_NAME
*)*val
;
246 ret
= x509_name_encode(a
);
249 ret
= x509_name_canon(a
);
253 ret
= a
->bytes
->length
;
255 memcpy(*out
, a
->bytes
->data
, ret
);
261 static void local_sk_X509_NAME_ENTRY_free(STACK_OF(X509_NAME_ENTRY
) *ne
)
263 sk_X509_NAME_ENTRY_free(ne
);
266 static void local_sk_X509_NAME_ENTRY_pop_free(STACK_OF(X509_NAME_ENTRY
) *ne
)
268 sk_X509_NAME_ENTRY_pop_free(ne
, X509_NAME_ENTRY_free
);
271 static int x509_name_encode(X509_NAME
*a
)
274 STACK_OF(STACK_OF_X509_NAME_ENTRY
) *s
;
281 STACK_OF(X509_NAME_ENTRY
) *entries
= NULL
;
282 X509_NAME_ENTRY
*entry
;
284 intname
.s
= sk_STACK_OF_X509_NAME_ENTRY_new_null();
287 for (i
= 0; i
< sk_X509_NAME_ENTRY_num(a
->entries
); i
++) {
288 entry
= sk_X509_NAME_ENTRY_value(a
->entries
, i
);
289 if (entry
->set
!= set
) {
290 entries
= sk_X509_NAME_ENTRY_new_null();
293 if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname
.s
, entries
))
297 if (!sk_X509_NAME_ENTRY_push(entries
, entry
))
300 len
= ASN1_item_ex_i2d(&intname
.a
, NULL
,
301 ASN1_ITEM_rptr(X509_NAME_INTERNAL
), -1, -1);
302 if (!BUF_MEM_grow(a
->bytes
, len
))
304 p
= (unsigned char *)a
->bytes
->data
;
305 ASN1_item_ex_i2d(&intname
.a
,
306 &p
, ASN1_ITEM_rptr(X509_NAME_INTERNAL
), -1, -1);
307 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname
.s
,
308 local_sk_X509_NAME_ENTRY_free
);
312 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname
.s
,
313 local_sk_X509_NAME_ENTRY_free
);
314 ASN1err(ASN1_F_X509_NAME_ENCODE
, ERR_R_MALLOC_FAILURE
);
318 static int x509_name_ex_print(BIO
*out
, ASN1_VALUE
**pval
,
320 const char *fname
, const ASN1_PCTX
*pctx
)
322 if (X509_NAME_print_ex(out
, (X509_NAME
*)*pval
,
323 indent
, pctx
->nm_flags
) <= 0)
329 * This function generates the canonical encoding of the Name structure. In
330 * it all strings are converted to UTF8, leading, trailing and multiple
331 * spaces collapsed, converted to lower case and the leading SEQUENCE header
332 * removed. In future we could also normalize the UTF8 too. By doing this
333 * comparison of Name structures can be rapidly perfomed by just using
334 * memcmp() of the canonical encoding. By omitting the leading SEQUENCE name
335 * constraints of type dirName can also be checked with a simple memcmp().
338 static int x509_name_canon(X509_NAME
*a
)
341 STACK_OF(STACK_OF_X509_NAME_ENTRY
) *intname
= NULL
;
342 STACK_OF(X509_NAME_ENTRY
) *entries
= NULL
;
343 X509_NAME_ENTRY
*entry
, *tmpentry
= NULL
;
344 int i
, set
= -1, ret
= 0;
347 OPENSSL_free(a
->canon_enc
);
350 /* Special case: empty X509_NAME => null encoding */
351 if (sk_X509_NAME_ENTRY_num(a
->entries
) == 0) {
355 intname
= sk_STACK_OF_X509_NAME_ENTRY_new_null();
358 for (i
= 0; i
< sk_X509_NAME_ENTRY_num(a
->entries
); i
++) {
359 entry
= sk_X509_NAME_ENTRY_value(a
->entries
, i
);
360 if (entry
->set
!= set
) {
361 entries
= sk_X509_NAME_ENTRY_new_null();
364 if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname
, entries
))
368 tmpentry
= X509_NAME_ENTRY_new();
371 tmpentry
->object
= OBJ_dup(entry
->object
);
372 if (!asn1_string_canon(tmpentry
->value
, entry
->value
))
374 if (!sk_X509_NAME_ENTRY_push(entries
, tmpentry
))
379 /* Finally generate encoding */
381 a
->canon_enclen
= i2d_name_canon(intname
, NULL
);
383 p
= OPENSSL_malloc(a
->canon_enclen
);
390 i2d_name_canon(intname
, &p
);
397 X509_NAME_ENTRY_free(tmpentry
);
399 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname
,
400 local_sk_X509_NAME_ENTRY_pop_free
);
404 /* Bitmap of all the types of string that will be canonicalized. */
406 #define ASN1_MASK_CANON \
407 (B_ASN1_UTF8STRING | B_ASN1_BMPSTRING | B_ASN1_UNIVERSALSTRING \
408 | B_ASN1_PRINTABLESTRING | B_ASN1_T61STRING | B_ASN1_IA5STRING \
409 | B_ASN1_VISIBLESTRING)
411 static int asn1_string_canon(ASN1_STRING
*out
, ASN1_STRING
*in
)
413 unsigned char *to
, *from
;
416 /* If type not in bitmask just copy string across */
417 if (!(ASN1_tag2bit(in
->type
) & ASN1_MASK_CANON
)) {
418 if (!ASN1_STRING_copy(out
, in
))
423 out
->type
= V_ASN1_UTF8STRING
;
424 out
->length
= ASN1_STRING_to_UTF8(&out
->data
, in
);
425 if (out
->length
== -1)
434 * Convert string in place to canonical form. Ultimately we may need to
435 * handle a wider range of characters but for now ignore anything with
436 * MSB set and rely on the isspace() and tolower() functions.
439 /* Ignore leading spaces */
440 while ((len
> 0) && !(*from
& 0x80) && isspace(*from
)) {
447 /* Ignore trailing spaces */
448 while ((len
> 0) && !(*to
& 0x80) && isspace(*to
)) {
457 /* If MSB set just copy across */
462 /* Collapse multiple spaces */
463 else if (isspace(*from
)) {
464 /* Copy one space across */
467 * Ignore subsequent spaces. Note: don't need to check len here
468 * because we know the last character is a non-space so we can't
475 while (!(*from
& 0x80) && isspace(*from
));
477 *to
++ = tolower(*from
);
483 out
->length
= to
- out
->data
;
489 static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY
) * _intname
,
494 STACK_OF(ASN1_VALUE
) *intname
= (STACK_OF(ASN1_VALUE
) *)_intname
;
497 for (i
= 0; i
< sk_ASN1_VALUE_num(intname
); i
++) {
498 v
= sk_ASN1_VALUE_value(intname
, i
);
499 ltmp
= ASN1_item_ex_i2d(&v
, in
,
500 ASN1_ITEM_rptr(X509_NAME_ENTRIES
), -1, -1);
508 int X509_NAME_set(X509_NAME
**xn
, X509_NAME
*name
)
516 in
= X509_NAME_dup(name
);
522 return (*xn
!= NULL
);
525 IMPLEMENT_STACK_OF(X509_NAME_ENTRY
)
527 IMPLEMENT_ASN1_SET_OF(X509_NAME_ENTRY
)