2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
12 #include "internal/cryptlib.h"
13 #include <openssl/asn1t.h>
14 #include <openssl/x509.h>
15 #include "internal/x509_int.h"
16 #include "internal/asn1_int.h"
20 * Maximum length of X509_NAME: much larger than anything we should
21 * ever see in practice.
24 #define X509_NAME_MAX (1024 * 1024)
26 static int x509_name_ex_d2i(ASN1_VALUE **val,
27 const unsigned char **in, long len,
29 int tag, int aclass, char opt, ASN1_TLC *ctx);
31 static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out,
32 const ASN1_ITEM *it, int tag, int aclass);
33 static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it);
34 static void x509_name_ex_free(ASN1_VALUE **val, const ASN1_ITEM *it);
36 static int x509_name_encode(X509_NAME *a);
37 static int x509_name_canon(X509_NAME *a);
38 static int asn1_string_canon(ASN1_STRING *out, const ASN1_STRING *in);
39 static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) * intname,
42 static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
44 const char *fname, const ASN1_PCTX *pctx);
46 ASN1_SEQUENCE(X509_NAME_ENTRY) = {
47 ASN1_SIMPLE(X509_NAME_ENTRY, object, ASN1_OBJECT),
48 ASN1_SIMPLE(X509_NAME_ENTRY, value, ASN1_PRINTABLE)
49 } ASN1_SEQUENCE_END(X509_NAME_ENTRY)
51 IMPLEMENT_ASN1_FUNCTIONS(X509_NAME_ENTRY)
52 IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME_ENTRY)
55 * For the "Name" type we need a SEQUENCE OF { SET OF X509_NAME_ENTRY } so
56 * declare two template wrappers for this
59 ASN1_ITEM_TEMPLATE(X509_NAME_ENTRIES) =
60 ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SET_OF, 0, RDNS, X509_NAME_ENTRY)
61 static_ASN1_ITEM_TEMPLATE_END(X509_NAME_ENTRIES)
63 ASN1_ITEM_TEMPLATE(X509_NAME_INTERNAL) =
64 ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, Name, X509_NAME_ENTRIES)
65 static_ASN1_ITEM_TEMPLATE_END(X509_NAME_INTERNAL)
68 * Normally that's where it would end: we'd have two nested STACK structures
69 * representing the ASN1. Unfortunately X509_NAME uses a completely different
70 * form and caches encodings so we have to process the internal form and
71 * convert to the external form.
74 static const ASN1_EXTERN_FUNCS x509_name_ff = {
78 0, /* Default clear behaviour is OK */
84 IMPLEMENT_EXTERN_ASN1(X509_NAME, V_ASN1_SEQUENCE, x509_name_ff)
86 IMPLEMENT_ASN1_FUNCTIONS(X509_NAME)
88 IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME)
90 static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it)
92 X509_NAME *ret = OPENSSL_zalloc(sizeof(*ret));
96 if ((ret->entries = sk_X509_NAME_ENTRY_new_null()) == NULL)
98 if ((ret->bytes = BUF_MEM_new()) == NULL)
101 *val = (ASN1_VALUE *)ret;
105 ASN1err(ASN1_F_X509_NAME_EX_NEW, ERR_R_MALLOC_FAILURE);
107 sk_X509_NAME_ENTRY_free(ret->entries);
113 static void x509_name_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
119 a = (X509_NAME *)*pval;
121 BUF_MEM_free(a->bytes);
122 sk_X509_NAME_ENTRY_pop_free(a->entries, X509_NAME_ENTRY_free);
123 OPENSSL_free(a->canon_enc);
128 static void name_entry_stack_free(STACK_OF(X509_NAME_ENTRY) *ents)
130 sk_X509_NAME_ENTRY_pop_free(ents, X509_NAME_ENTRY_free);
133 static int x509_name_ex_d2i(ASN1_VALUE **val,
134 const unsigned char **in, long len,
135 const ASN1_ITEM *it, int tag, int aclass,
136 char opt, ASN1_TLC *ctx)
138 const unsigned char *p = *in, *q;
140 STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
152 STACK_OF(X509_NAME_ENTRY) *entries;
153 X509_NAME_ENTRY *entry;
154 if (len > X509_NAME_MAX)
158 /* Get internal representation of Name */
159 ret = ASN1_item_ex_d2i(&intname.a,
160 &p, len, ASN1_ITEM_rptr(X509_NAME_INTERNAL),
161 tag, aclass, opt, ctx);
167 x509_name_ex_free(val, NULL);
168 if (!x509_name_ex_new(&nm.a, NULL))
170 /* We've decoded it: now cache encoding */
171 if (!BUF_MEM_grow(nm.x->bytes, p - q))
173 memcpy(nm.x->bytes->data, q, p - q);
175 /* Convert internal representation to X509_NAME structure */
176 for (i = 0; i < sk_STACK_OF_X509_NAME_ENTRY_num(intname.s); i++) {
177 entries = sk_STACK_OF_X509_NAME_ENTRY_value(intname.s, i);
178 for (j = 0; j < sk_X509_NAME_ENTRY_num(entries); j++) {
179 entry = sk_X509_NAME_ENTRY_value(entries, j);
181 if (!sk_X509_NAME_ENTRY_push(nm.x->entries, entry))
186 * All entries have now been pushed to nm->x.entries
187 * free up the stacks in intname.s but not the entries
190 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s, sk_X509_NAME_ENTRY_free);
192 ret = x509_name_canon(nm.x);
201 /* If intname.s is not NULL only some entries exist in nm->x.entries:
202 * zero references in nm->x.entries list. Since all entries exist
203 * in intname.s we can free them all there
205 if (intname.s != NULL) {
206 sk_X509_NAME_ENTRY_zero(nm.x->entries);
207 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s, name_entry_stack_free);
209 X509_NAME_free(nm.x);
210 ASN1err(ASN1_F_X509_NAME_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
214 static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out,
215 const ASN1_ITEM *it, int tag, int aclass)
218 X509_NAME *a = (X509_NAME *)*val;
220 ret = x509_name_encode(a);
223 ret = x509_name_canon(a);
227 ret = a->bytes->length;
229 memcpy(*out, a->bytes->data, ret);
235 static void local_sk_X509_NAME_ENTRY_free(STACK_OF(X509_NAME_ENTRY) *ne)
237 sk_X509_NAME_ENTRY_free(ne);
240 static void local_sk_X509_NAME_ENTRY_pop_free(STACK_OF(X509_NAME_ENTRY) *ne)
242 sk_X509_NAME_ENTRY_pop_free(ne, X509_NAME_ENTRY_free);
245 static int x509_name_encode(X509_NAME *a)
248 STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
255 STACK_OF(X509_NAME_ENTRY) *entries = NULL;
256 X509_NAME_ENTRY *entry;
258 intname.s = sk_STACK_OF_X509_NAME_ENTRY_new_null();
261 for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
262 entry = sk_X509_NAME_ENTRY_value(a->entries, i);
263 if (entry->set != set) {
264 entries = sk_X509_NAME_ENTRY_new_null();
267 if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname.s, entries))
271 if (!sk_X509_NAME_ENTRY_push(entries, entry))
274 len = ASN1_item_ex_i2d(&intname.a, NULL,
275 ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
276 if (!BUF_MEM_grow(a->bytes, len))
278 p = (unsigned char *)a->bytes->data;
279 ASN1_item_ex_i2d(&intname.a,
280 &p, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
281 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
282 local_sk_X509_NAME_ENTRY_free);
286 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
287 local_sk_X509_NAME_ENTRY_free);
288 ASN1err(ASN1_F_X509_NAME_ENCODE, ERR_R_MALLOC_FAILURE);
292 static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
294 const char *fname, const ASN1_PCTX *pctx)
296 if (X509_NAME_print_ex(out, (const X509_NAME *)*pval,
297 indent, pctx->nm_flags) <= 0)
303 * This function generates the canonical encoding of the Name structure. In
304 * it all strings are converted to UTF8, leading, trailing and multiple
305 * spaces collapsed, converted to lower case and the leading SEQUENCE header
306 * removed. In future we could also normalize the UTF8 too. By doing this
307 * comparison of Name structures can be rapidly performed by just using
308 * memcmp() of the canonical encoding. By omitting the leading SEQUENCE name
309 * constraints of type dirName can also be checked with a simple memcmp().
312 static int x509_name_canon(X509_NAME *a)
315 STACK_OF(STACK_OF_X509_NAME_ENTRY) *intname = NULL;
316 STACK_OF(X509_NAME_ENTRY) *entries = NULL;
317 X509_NAME_ENTRY *entry, *tmpentry = NULL;
318 int i, set = -1, ret = 0, len;
320 OPENSSL_free(a->canon_enc);
322 /* Special case: empty X509_NAME => null encoding */
323 if (sk_X509_NAME_ENTRY_num(a->entries) == 0) {
327 intname = sk_STACK_OF_X509_NAME_ENTRY_new_null();
330 for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
331 entry = sk_X509_NAME_ENTRY_value(a->entries, i);
332 if (entry->set != set) {
333 entries = sk_X509_NAME_ENTRY_new_null();
336 if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname, entries))
340 tmpentry = X509_NAME_ENTRY_new();
341 if (tmpentry == NULL)
343 tmpentry->object = OBJ_dup(entry->object);
344 if (tmpentry->object == NULL)
346 if (!asn1_string_canon(tmpentry->value, entry->value))
348 if (!sk_X509_NAME_ENTRY_push(entries, tmpentry))
353 /* Finally generate encoding */
355 len = i2d_name_canon(intname, NULL);
358 a->canon_enclen = len;
360 p = OPENSSL_malloc(a->canon_enclen);
367 i2d_name_canon(intname, &p);
373 X509_NAME_ENTRY_free(tmpentry);
374 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname,
375 local_sk_X509_NAME_ENTRY_pop_free);
379 /* Bitmap of all the types of string that will be canonicalized. */
381 #define ASN1_MASK_CANON \
382 (B_ASN1_UTF8STRING | B_ASN1_BMPSTRING | B_ASN1_UNIVERSALSTRING \
383 | B_ASN1_PRINTABLESTRING | B_ASN1_T61STRING | B_ASN1_IA5STRING \
384 | B_ASN1_VISIBLESTRING)
386 static int asn1_string_canon(ASN1_STRING *out, const ASN1_STRING *in)
388 unsigned char *to, *from;
391 /* If type not in bitmask just copy string across */
392 if (!(ASN1_tag2bit(in->type) & ASN1_MASK_CANON)) {
393 if (!ASN1_STRING_copy(out, in))
398 out->type = V_ASN1_UTF8STRING;
399 out->length = ASN1_STRING_to_UTF8(&out->data, in);
400 if (out->length == -1)
409 * Convert string in place to canonical form. Ultimately we may need to
410 * handle a wider range of characters but for now ignore anything with
411 * MSB set and rely on the isspace() and tolower() functions.
414 /* Ignore leading spaces */
415 while ((len > 0) && !(*from & 0x80) && isspace(*from)) {
422 /* Ignore trailing spaces */
423 while ((len > 0) && !(to[-1] & 0x80) && isspace(to[-1])) {
432 /* If MSB set just copy across */
437 /* Collapse multiple spaces */
438 else if (isspace(*from)) {
439 /* Copy one space across */
442 * Ignore subsequent spaces. Note: don't need to check len here
443 * because we know the last character is a non-space so we can't
450 while (!(*from & 0x80) && isspace(*from));
452 *to++ = tolower(*from);
458 out->length = to - out->data;
464 static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) * _intname,
469 STACK_OF(ASN1_VALUE) *intname = (STACK_OF(ASN1_VALUE) *)_intname;
472 for (i = 0; i < sk_ASN1_VALUE_num(intname); i++) {
473 v = sk_ASN1_VALUE_value(intname, i);
474 ltmp = ASN1_item_ex_i2d(&v, in,
475 ASN1_ITEM_rptr(X509_NAME_ENTRIES), -1, -1);
483 int X509_NAME_set(X509_NAME **xn, X509_NAME *name)
491 in = X509_NAME_dup(name);
497 return (*xn != NULL);
500 int X509_NAME_print(BIO *bp, const X509_NAME *name, int obase)
507 b = X509_NAME_oneline(name, NULL, 0);
514 s = b + 1; /* skip the first slash */
518 #ifndef CHARSET_EBCDIC
520 ((s[1] >= 'A') && (s[1] <= 'Z') && ((s[2] == '=') ||
527 (isupper(s[1]) && ((s[2] == '=') ||
528 (isupper(s[2]) && (s[3] == '='))
533 if (BIO_write(bp, c, i) != i)
535 c = s + 1; /* skip following slash */
537 if (BIO_write(bp, ", ", 2) != 2)
551 X509err(X509_F_X509_NAME_PRINT, ERR_R_BUF_LIB);
556 int X509_NAME_get0_der(X509_NAME *nm, const unsigned char **pder,
559 /* Make sure encoding is valid */
560 if (i2d_X509_NAME(nm, NULL) <= 0)
563 *pder = (unsigned char *)nm->bytes->data;
565 *pderlen = nm->bytes->length;