x_name.c revision 325335
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 void local_sk_X509_NAME_ENTRY_free(STACK_OF(X509_NAME_ENTRY) *ne) 182{ 183 sk_X509_NAME_ENTRY_free(ne); 184} 185 186static void local_sk_X509_NAME_ENTRY_pop_free(STACK_OF(X509_NAME_ENTRY) *ne) 187{ 188 sk_X509_NAME_ENTRY_pop_free(ne, X509_NAME_ENTRY_free); 189} 190 191static int x509_name_ex_d2i(ASN1_VALUE **val, 192 const unsigned char **in, long len, 193 const ASN1_ITEM *it, int tag, int aclass, 194 char opt, ASN1_TLC *ctx) 195{ 196 const unsigned char *p = *in, *q; 197 union { 198 STACK_OF(STACK_OF_X509_NAME_ENTRY) *s; 199 ASN1_VALUE *a; 200 } intname = { 201 NULL 202 }; 203 union { 204 X509_NAME *x; 205 ASN1_VALUE *a; 206 } nm = { 207 NULL 208 }; 209 int i, j, ret; 210 STACK_OF(X509_NAME_ENTRY) *entries; 211 X509_NAME_ENTRY *entry; 212 if (len > X509_NAME_MAX) 213 len = X509_NAME_MAX; 214 q = p; 215 216 /* Get internal representation of Name */ 217 ret = ASN1_item_ex_d2i(&intname.a, 218 &p, len, ASN1_ITEM_rptr(X509_NAME_INTERNAL), 219 tag, aclass, opt, ctx); 220 221 if (ret <= 0) 222 return ret; 223 224 if (*val) 225 x509_name_ex_free(val, NULL); 226 if (!x509_name_ex_new(&nm.a, NULL)) 227 goto err; 228 /* We've decoded it: now cache encoding */ 229 if (!BUF_MEM_grow(nm.x->bytes, p - q)) 230 goto err; 231 memcpy(nm.x->bytes->data, q, p - q); 232 233 /* Convert internal representation to X509_NAME structure */ 234 for (i = 0; i < sk_STACK_OF_X509_NAME_ENTRY_num(intname.s); i++) { 235 entries = sk_STACK_OF_X509_NAME_ENTRY_value(intname.s, i); 236 for (j = 0; j < sk_X509_NAME_ENTRY_num(entries); j++) { 237 entry = sk_X509_NAME_ENTRY_value(entries, j); 238 entry->set = i; 239 if (!sk_X509_NAME_ENTRY_push(nm.x->entries, entry)) 240 goto err; 241 sk_X509_NAME_ENTRY_set(entries, j, NULL); 242 } 243 } 244 ret = x509_name_canon(nm.x); 245 if (!ret) 246 goto err; 247 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s, 248 local_sk_X509_NAME_ENTRY_free); 249 nm.x->modified = 0; 250 *val = nm.a; 251 *in = p; 252 return ret; 253 err: 254 if (nm.x != NULL) 255 X509_NAME_free(nm.x); 256 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s, 257 local_sk_X509_NAME_ENTRY_pop_free); 258 ASN1err(ASN1_F_X509_NAME_EX_D2I, ERR_R_NESTED_ASN1_ERROR); 259 return 0; 260} 261 262static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out, 263 const ASN1_ITEM *it, int tag, int aclass) 264{ 265 int ret; 266 X509_NAME *a = (X509_NAME *)*val; 267 if (a->modified) { 268 ret = x509_name_encode(a); 269 if (ret < 0) 270 return ret; 271 ret = x509_name_canon(a); 272 if (ret < 0) 273 return ret; 274 } 275 ret = a->bytes->length; 276 if (out != NULL) { 277 memcpy(*out, a->bytes->data, ret); 278 *out += ret; 279 } 280 return ret; 281} 282 283static int x509_name_encode(X509_NAME *a) 284{ 285 union { 286 STACK_OF(STACK_OF_X509_NAME_ENTRY) *s; 287 ASN1_VALUE *a; 288 } intname = { 289 NULL 290 }; 291 int len; 292 unsigned char *p; 293 STACK_OF(X509_NAME_ENTRY) *entries = NULL; 294 X509_NAME_ENTRY *entry; 295 int i, set = -1; 296 intname.s = sk_STACK_OF_X509_NAME_ENTRY_new_null(); 297 if (!intname.s) 298 goto memerr; 299 for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) { 300 entry = sk_X509_NAME_ENTRY_value(a->entries, i); 301 if (entry->set != set) { 302 entries = sk_X509_NAME_ENTRY_new_null(); 303 if (!entries) 304 goto memerr; 305 if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname.s, entries)) { 306 sk_X509_NAME_ENTRY_free(entries); 307 goto memerr; 308 } 309 set = entry->set; 310 } 311 if (!sk_X509_NAME_ENTRY_push(entries, entry)) 312 goto memerr; 313 } 314 len = ASN1_item_ex_i2d(&intname.a, NULL, 315 ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1); 316 if (!BUF_MEM_grow(a->bytes, len)) 317 goto memerr; 318 p = (unsigned char *)a->bytes->data; 319 ASN1_item_ex_i2d(&intname.a, 320 &p, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1); 321 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s, 322 local_sk_X509_NAME_ENTRY_free); 323 a->modified = 0; 324 return len; 325 memerr: 326 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s, 327 local_sk_X509_NAME_ENTRY_free); 328 ASN1err(ASN1_F_X509_NAME_ENCODE, ERR_R_MALLOC_FAILURE); 329 return -1; 330} 331 332static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval, 333 int indent, 334 const char *fname, const ASN1_PCTX *pctx) 335{ 336 if (X509_NAME_print_ex(out, (X509_NAME *)*pval, 337 indent, pctx->nm_flags) <= 0) 338 return 0; 339 return 2; 340} 341 342/* 343 * This function generates the canonical encoding of the Name structure. In 344 * it all strings are converted to UTF8, leading, trailing and multiple 345 * spaces collapsed, converted to lower case and the leading SEQUENCE header 346 * removed. In future we could also normalize the UTF8 too. By doing this 347 * comparison of Name structures can be rapidly perfomed by just using 348 * memcmp() of the canonical encoding. By omitting the leading SEQUENCE name 349 * constraints of type dirName can also be checked with a simple memcmp(). 350 */ 351 352static int x509_name_canon(X509_NAME *a) 353{ 354 unsigned char *p; 355 STACK_OF(STACK_OF_X509_NAME_ENTRY) *intname = NULL; 356 STACK_OF(X509_NAME_ENTRY) *entries = NULL; 357 X509_NAME_ENTRY *entry, *tmpentry = NULL; 358 int i, set = -1, ret = 0; 359 360 if (a->canon_enc) { 361 OPENSSL_free(a->canon_enc); 362 a->canon_enc = NULL; 363 } 364 /* Special case: empty X509_NAME => null encoding */ 365 if (sk_X509_NAME_ENTRY_num(a->entries) == 0) { 366 a->canon_enclen = 0; 367 return 1; 368 } 369 intname = sk_STACK_OF_X509_NAME_ENTRY_new_null(); 370 if (!intname) 371 goto err; 372 for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) { 373 entry = sk_X509_NAME_ENTRY_value(a->entries, i); 374 if (entry->set != set) { 375 entries = sk_X509_NAME_ENTRY_new_null(); 376 if (!entries) 377 goto err; 378 if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname, entries)) { 379 sk_X509_NAME_ENTRY_free(entries); 380 goto err; 381 } 382 set = entry->set; 383 } 384 tmpentry = X509_NAME_ENTRY_new(); 385 if (!tmpentry) 386 goto err; 387 tmpentry->object = OBJ_dup(entry->object); 388 if (!asn1_string_canon(tmpentry->value, entry->value)) 389 goto err; 390 if (!sk_X509_NAME_ENTRY_push(entries, tmpentry)) 391 goto err; 392 tmpentry = NULL; 393 } 394 395 /* Finally generate encoding */ 396 397 a->canon_enclen = i2d_name_canon(intname, NULL); 398 399 p = OPENSSL_malloc(a->canon_enclen); 400 401 if (!p) 402 goto err; 403 404 a->canon_enc = p; 405 406 i2d_name_canon(intname, &p); 407 408 ret = 1; 409 410 err: 411 412 if (tmpentry) 413 X509_NAME_ENTRY_free(tmpentry); 414 if (intname) 415 sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname, 416 local_sk_X509_NAME_ENTRY_pop_free); 417 return ret; 418} 419 420/* Bitmap of all the types of string that will be canonicalized. */ 421 422#define ASN1_MASK_CANON \ 423 (B_ASN1_UTF8STRING | B_ASN1_BMPSTRING | B_ASN1_UNIVERSALSTRING \ 424 | B_ASN1_PRINTABLESTRING | B_ASN1_T61STRING | B_ASN1_IA5STRING \ 425 | B_ASN1_VISIBLESTRING) 426 427static int asn1_string_canon(ASN1_STRING *out, ASN1_STRING *in) 428{ 429 unsigned char *to, *from; 430 int len, i; 431 432 /* If type not in bitmask just copy string across */ 433 if (!(ASN1_tag2bit(in->type) & ASN1_MASK_CANON)) { 434 if (!ASN1_STRING_copy(out, in)) 435 return 0; 436 return 1; 437 } 438 439 out->type = V_ASN1_UTF8STRING; 440 out->length = ASN1_STRING_to_UTF8(&out->data, in); 441 if (out->length == -1) 442 return 0; 443 444 to = out->data; 445 from = to; 446 447 len = out->length; 448 449 /* 450 * Convert string in place to canonical form. Ultimately we may need to 451 * handle a wider range of characters but for now ignore anything with 452 * MSB set and rely on the isspace() and tolower() functions. 453 */ 454 455 /* Ignore leading spaces */ 456 while ((len > 0) && !(*from & 0x80) && isspace(*from)) { 457 from++; 458 len--; 459 } 460 461 to = from + len - 1; 462 463 /* Ignore trailing spaces */ 464 while ((len > 0) && !(*to & 0x80) && isspace(*to)) { 465 to--; 466 len--; 467 } 468 469 to = out->data; 470 471 i = 0; 472 while (i < len) { 473 /* If MSB set just copy across */ 474 if (*from & 0x80) { 475 *to++ = *from++; 476 i++; 477 } 478 /* Collapse multiple spaces */ 479 else if (isspace(*from)) { 480 /* Copy one space across */ 481 *to++ = ' '; 482 /* 483 * Ignore subsequent spaces. Note: don't need to check len here 484 * because we know the last character is a non-space so we can't 485 * overflow. 486 */ 487 do { 488 from++; 489 i++; 490 } 491 while (!(*from & 0x80) && isspace(*from)); 492 } else { 493 *to++ = tolower(*from); 494 from++; 495 i++; 496 } 497 } 498 499 out->length = to - out->data; 500 501 return 1; 502 503} 504 505static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) * _intname, 506 unsigned char **in) 507{ 508 int i, len, ltmp; 509 ASN1_VALUE *v; 510 STACK_OF(ASN1_VALUE) *intname = (STACK_OF(ASN1_VALUE) *)_intname; 511 512 len = 0; 513 for (i = 0; i < sk_ASN1_VALUE_num(intname); i++) { 514 v = sk_ASN1_VALUE_value(intname, i); 515 ltmp = ASN1_item_ex_i2d(&v, in, 516 ASN1_ITEM_rptr(X509_NAME_ENTRIES), -1, -1); 517 if (ltmp < 0) 518 return ltmp; 519 len += ltmp; 520 } 521 return len; 522} 523 524int X509_NAME_set(X509_NAME **xn, X509_NAME *name) 525{ 526 X509_NAME *in; 527 528 if (!xn || !name) 529 return (0); 530 531 if (*xn != name) { 532 in = X509_NAME_dup(name); 533 if (in != NULL) { 534 X509_NAME_free(*xn); 535 *xn = in; 536 } 537 } 538 return (*xn != NULL); 539} 540 541IMPLEMENT_STACK_OF(X509_NAME_ENTRY) 542 543IMPLEMENT_ASN1_SET_OF(X509_NAME_ENTRY) 544