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 "internal/x509_int.h"
65 #include "internal/asn1_int.h"
67 typedef STACK_OF(X509_NAME_ENTRY
) STACK_OF_X509_NAME_ENTRY
;
68 DECLARE_STACK_OF(STACK_OF_X509_NAME_ENTRY
)
70 static int x509_name_ex_d2i(ASN1_VALUE
**val
,
71 const unsigned char **in
, long len
,
73 int tag
, int aclass
, char opt
, ASN1_TLC
*ctx
);
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
);
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
,
86 static int x509_name_ex_print(BIO
*out
, ASN1_VALUE
**pval
,
88 const char *fname
, const ASN1_PCTX
*pctx
);
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
)
95 IMPLEMENT_ASN1_FUNCTIONS(X509_NAME_ENTRY
)
96 IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME_ENTRY
)
99 * For the "Name" type we need a SEQUENCE OF { SET OF X509_NAME_ENTRY } so
100 * declare two template wrappers for this
103 ASN1_ITEM_TEMPLATE(X509_NAME_ENTRIES
) =
104 ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SET_OF
, 0, RDNS
, X509_NAME_ENTRY
)
105 ASN1_ITEM_TEMPLATE_END(X509_NAME_ENTRIES
)
107 ASN1_ITEM_TEMPLATE(X509_NAME_INTERNAL
) =
108 ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF
, 0, Name
, X509_NAME_ENTRIES
)
109 ASN1_ITEM_TEMPLATE_END(X509_NAME_INTERNAL
)
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.
118 const ASN1_EXTERN_FUNCS x509_name_ff
= {
122 0, /* Default clear behaviour is OK */
128 IMPLEMENT_EXTERN_ASN1(X509_NAME
, V_ASN1_SEQUENCE
, x509_name_ff
)
130 IMPLEMENT_ASN1_FUNCTIONS(X509_NAME
)
132 IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME
)
134 static int x509_name_ex_new(ASN1_VALUE
**val
, const ASN1_ITEM
*it
)
136 X509_NAME
*ret
= NULL
;
137 ret
= OPENSSL_malloc(sizeof(X509_NAME
));
140 if ((ret
->entries
= sk_X509_NAME_ENTRY_new_null()) == NULL
)
142 if ((ret
->bytes
= BUF_MEM_new()) == NULL
)
144 ret
->canon_enc
= NULL
;
145 ret
->canon_enclen
= 0;
147 *val
= (ASN1_VALUE
*)ret
;
151 ASN1err(ASN1_F_X509_NAME_EX_NEW
, ERR_R_MALLOC_FAILURE
);
154 sk_X509_NAME_ENTRY_free(ret
->entries
);
160 static void x509_name_ex_free(ASN1_VALUE
**pval
, const ASN1_ITEM
*it
)
165 a
= (X509_NAME
*)*pval
;
167 BUF_MEM_free(a
->bytes
);
168 sk_X509_NAME_ENTRY_pop_free(a
->entries
, X509_NAME_ENTRY_free
);
170 OPENSSL_free(a
->canon_enc
);
175 static int x509_name_ex_d2i(ASN1_VALUE
**val
,
176 const unsigned char **in
, long len
,
177 const ASN1_ITEM
*it
, int tag
, int aclass
,
178 char opt
, ASN1_TLC
*ctx
)
180 const unsigned char *p
= *in
, *q
;
182 STACK_OF(STACK_OF_X509_NAME_ENTRY
) *s
;
194 STACK_OF(X509_NAME_ENTRY
) *entries
;
195 X509_NAME_ENTRY
*entry
;
198 /* Get internal representation of Name */
199 ret
= ASN1_item_ex_d2i(&intname
.a
,
200 &p
, len
, ASN1_ITEM_rptr(X509_NAME_INTERNAL
),
201 tag
, aclass
, opt
, ctx
);
207 x509_name_ex_free(val
, NULL
);
208 if (!x509_name_ex_new(&nm
.a
, NULL
))
210 /* We've decoded it: now cache encoding */
211 if (!BUF_MEM_grow(nm
.x
->bytes
, p
- q
))
213 memcpy(nm
.x
->bytes
->data
, q
, p
- q
);
215 /* Convert internal representation to X509_NAME structure */
216 for (i
= 0; i
< sk_STACK_OF_X509_NAME_ENTRY_num(intname
.s
); i
++) {
217 entries
= sk_STACK_OF_X509_NAME_ENTRY_value(intname
.s
, i
);
218 for (j
= 0; j
< sk_X509_NAME_ENTRY_num(entries
); j
++) {
219 entry
= sk_X509_NAME_ENTRY_value(entries
, j
);
221 if (!sk_X509_NAME_ENTRY_push(nm
.x
->entries
, entry
))
224 sk_X509_NAME_ENTRY_free(entries
);
226 sk_STACK_OF_X509_NAME_ENTRY_free(intname
.s
);
227 ret
= x509_name_canon(nm
.x
);
236 X509_NAME_free(nm
.x
);
237 ASN1err(ASN1_F_X509_NAME_EX_D2I
, ERR_R_NESTED_ASN1_ERROR
);
241 static int x509_name_ex_i2d(ASN1_VALUE
**val
, unsigned char **out
,
242 const ASN1_ITEM
*it
, int tag
, int aclass
)
245 X509_NAME
*a
= (X509_NAME
*)*val
;
247 ret
= x509_name_encode(a
);
250 ret
= x509_name_canon(a
);
254 ret
= a
->bytes
->length
;
256 memcpy(*out
, a
->bytes
->data
, ret
);
262 static void local_sk_X509_NAME_ENTRY_free(STACK_OF(X509_NAME_ENTRY
) *ne
)
264 sk_X509_NAME_ENTRY_free(ne
);
267 static void local_sk_X509_NAME_ENTRY_pop_free(STACK_OF(X509_NAME_ENTRY
) *ne
)
269 sk_X509_NAME_ENTRY_pop_free(ne
, X509_NAME_ENTRY_free
);
272 static int x509_name_encode(X509_NAME
*a
)
275 STACK_OF(STACK_OF_X509_NAME_ENTRY
) *s
;
282 STACK_OF(X509_NAME_ENTRY
) *entries
= NULL
;
283 X509_NAME_ENTRY
*entry
;
285 intname
.s
= sk_STACK_OF_X509_NAME_ENTRY_new_null();
288 for (i
= 0; i
< sk_X509_NAME_ENTRY_num(a
->entries
); i
++) {
289 entry
= sk_X509_NAME_ENTRY_value(a
->entries
, i
);
290 if (entry
->set
!= set
) {
291 entries
= sk_X509_NAME_ENTRY_new_null();
294 if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname
.s
, entries
))
298 if (!sk_X509_NAME_ENTRY_push(entries
, entry
))
301 len
= ASN1_item_ex_i2d(&intname
.a
, NULL
,
302 ASN1_ITEM_rptr(X509_NAME_INTERNAL
), -1, -1);
303 if (!BUF_MEM_grow(a
->bytes
, len
))
305 p
= (unsigned char *)a
->bytes
->data
;
306 ASN1_item_ex_i2d(&intname
.a
,
307 &p
, ASN1_ITEM_rptr(X509_NAME_INTERNAL
), -1, -1);
308 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname
.s
,
309 local_sk_X509_NAME_ENTRY_free
);
313 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname
.s
,
314 local_sk_X509_NAME_ENTRY_free
);
315 ASN1err(ASN1_F_X509_NAME_ENCODE
, ERR_R_MALLOC_FAILURE
);
319 static int x509_name_ex_print(BIO
*out
, ASN1_VALUE
**pval
,
321 const char *fname
, const ASN1_PCTX
*pctx
)
323 if (X509_NAME_print_ex(out
, (X509_NAME
*)*pval
,
324 indent
, pctx
->nm_flags
) <= 0)
330 * This function generates the canonical encoding of the Name structure. In
331 * it all strings are converted to UTF8, leading, trailing and multiple
332 * spaces collapsed, converted to lower case and the leading SEQUENCE header
333 * removed. In future we could also normalize the UTF8 too. By doing this
334 * comparison of Name structures can be rapidly perfomed by just using
335 * memcmp() of the canonical encoding. By omitting the leading SEQUENCE name
336 * constraints of type dirName can also be checked with a simple memcmp().
339 static int x509_name_canon(X509_NAME
*a
)
342 STACK_OF(STACK_OF_X509_NAME_ENTRY
) *intname
= NULL
;
343 STACK_OF(X509_NAME_ENTRY
) *entries
= NULL
;
344 X509_NAME_ENTRY
*entry
, *tmpentry
= NULL
;
345 int i
, set
= -1, ret
= 0;
348 OPENSSL_free(a
->canon_enc
);
351 /* Special case: empty X509_NAME => null encoding */
352 if (sk_X509_NAME_ENTRY_num(a
->entries
) == 0) {
356 intname
= sk_STACK_OF_X509_NAME_ENTRY_new_null();
359 for (i
= 0; i
< sk_X509_NAME_ENTRY_num(a
->entries
); i
++) {
360 entry
= sk_X509_NAME_ENTRY_value(a
->entries
, i
);
361 if (entry
->set
!= set
) {
362 entries
= sk_X509_NAME_ENTRY_new_null();
365 if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname
, entries
))
369 tmpentry
= X509_NAME_ENTRY_new();
372 tmpentry
->object
= OBJ_dup(entry
->object
);
373 if (!asn1_string_canon(tmpentry
->value
, entry
->value
))
375 if (!sk_X509_NAME_ENTRY_push(entries
, tmpentry
))
380 /* Finally generate encoding */
382 a
->canon_enclen
= i2d_name_canon(intname
, NULL
);
384 p
= OPENSSL_malloc(a
->canon_enclen
);
391 i2d_name_canon(intname
, &p
);
398 X509_NAME_ENTRY_free(tmpentry
);
400 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname
,
401 local_sk_X509_NAME_ENTRY_pop_free
);
405 /* Bitmap of all the types of string that will be canonicalized. */
407 #define ASN1_MASK_CANON \
408 (B_ASN1_UTF8STRING | B_ASN1_BMPSTRING | B_ASN1_UNIVERSALSTRING \
409 | B_ASN1_PRINTABLESTRING | B_ASN1_T61STRING | B_ASN1_IA5STRING \
410 | B_ASN1_VISIBLESTRING)
412 static int asn1_string_canon(ASN1_STRING
*out
, ASN1_STRING
*in
)
414 unsigned char *to
, *from
;
417 /* If type not in bitmask just copy string across */
418 if (!(ASN1_tag2bit(in
->type
) & ASN1_MASK_CANON
)) {
419 if (!ASN1_STRING_copy(out
, in
))
424 out
->type
= V_ASN1_UTF8STRING
;
425 out
->length
= ASN1_STRING_to_UTF8(&out
->data
, in
);
426 if (out
->length
== -1)
435 * Convert string in place to canonical form. Ultimately we may need to
436 * handle a wider range of characters but for now ignore anything with
437 * MSB set and rely on the isspace() and tolower() functions.
440 /* Ignore leading spaces */
441 while ((len
> 0) && !(*from
& 0x80) && isspace(*from
)) {
448 /* Ignore trailing spaces */
449 while ((len
> 0) && !(*to
& 0x80) && isspace(*to
)) {
458 /* If MSB set just copy across */
463 /* Collapse multiple spaces */
464 else if (isspace(*from
)) {
465 /* Copy one space across */
468 * Ignore subsequent spaces. Note: don't need to check len here
469 * because we know the last character is a non-space so we can't
476 while (!(*from
& 0x80) && isspace(*from
));
478 *to
++ = tolower(*from
);
484 out
->length
= to
- out
->data
;
490 static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY
) * _intname
,
495 STACK_OF(ASN1_VALUE
) *intname
= (STACK_OF(ASN1_VALUE
) *)_intname
;
498 for (i
= 0; i
< sk_ASN1_VALUE_num(intname
); i
++) {
499 v
= sk_ASN1_VALUE_value(intname
, i
);
500 ltmp
= ASN1_item_ex_i2d(&v
, in
,
501 ASN1_ITEM_rptr(X509_NAME_ENTRIES
), -1, -1);
509 int X509_NAME_set(X509_NAME
**xn
, X509_NAME
*name
)
517 in
= X509_NAME_dup(name
);
523 return (*xn
!= NULL
);