crypto/x509/x_name.c

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