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