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