crypto/x509/x509_vpm.c

   1 /*
   2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
   3  * 2004.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 2004 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    licensing@OpenSSL.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #include <stdio.h>
  60
  61 #include "internal/cryptlib.h"
  62 #include <openssl/crypto.h>
  63 #include <openssl/lhash.h>
  64 #include <openssl/buffer.h>
  65 #include <openssl/x509.h>
  66 #include <openssl/x509v3.h>
  67
  68 #include "x509_lcl.h"
  69
  70 /* X509_VERIFY_PARAM functions */
  71
  72 #define SET_HOST 0
  73 #define ADD_HOST 1
  74
  75 static char *str_copy(const char *s)
  76 {
  77     return OPENSSL_strdup(s);
  78 }
  79
  80 static void str_free(char *s)
  81 {
  82     OPENSSL_free(s);
  83 }
  84
  85 static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
  86                                     const char *name, size_t namelen)
  87 {
  88     char *copy;
  89
  90     /*
  91      * Refuse names with embedded NUL bytes, except perhaps as final byte.
  92      * XXX: Do we need to push an error onto the error stack?
  93      */
  94     if (namelen == 0 || name == NULL)
  95         namelen = name ? strlen(name) : 0;
  96     else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
  97         return 0;
  98     if (namelen > 0 && name[namelen - 1] == '\0')
  99         --namelen;
 100
 101     if (mode == SET_HOST) {
 102         sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
 103         vpm->hosts = NULL;
 104     }
 105     if (name == NULL || namelen == 0)
 106         return 1;
 107
 108     copy = OPENSSL_strndup(name, namelen);
 109     if (copy == NULL)
 110         return 0;
 111
 112     if (vpm->hosts == NULL &&
 113         (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
 114         OPENSSL_free(copy);
 115         return 0;
 116     }
 117
 118     if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
 119         OPENSSL_free(copy);
 120         if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
 121             sk_OPENSSL_STRING_free(vpm->hosts);
 122             vpm->hosts = NULL;
 123         }
 124         return 0;
 125     }
 126
 127     return 1;
 128 }
 129
 130 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
 131 {
 132     if (!param)
 133         return;
 134     param->name = NULL;
 135     param->purpose = 0;
 136     param->trust = X509_TRUST_DEFAULT;
 137     /*
 138      * param->inh_flags = X509_VP_FLAG_DEFAULT;
 139      */
 140     param->inh_flags = 0;
 141     param->flags = 0;
 142     param->depth = -1;
 143     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
 144     param->policies = NULL;
 145     sk_OPENSSL_STRING_pop_free(param->hosts, str_free);
 146     param->hosts = NULL;
 147     OPENSSL_free(param->peername);
 148     param->peername = NULL;
 149     OPENSSL_free(param->email);
 150     param->email = NULL;
 151     param->emaillen = 0;
 152     OPENSSL_free(param->ip);
 153     param->ip = NULL;
 154     param->iplen = 0;
 155 }
 156
 157 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
 158 {
 159     X509_VERIFY_PARAM *param;
 160
 161     param = OPENSSL_zalloc(sizeof(*param));
 162     if (param == NULL)
 163         return NULL;
 164     x509_verify_param_zero(param);
 165     return param;
 166 }
 167
 168 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
 169 {
 170     if (!param)
 171         return;
 172     x509_verify_param_zero(param);
 173     OPENSSL_free(param);
 174 }
 175
 176 /*-
 177  * This function determines how parameters are "inherited" from one structure
 178  * to another. There are several different ways this can happen.
 179  *
 180  * 1. If a child structure needs to have its values initialized from a parent
 181  *    they are simply copied across. For example SSL_CTX copied to SSL.
 182  * 2. If the structure should take on values only if they are currently unset.
 183  *    For example the values in an SSL structure will take appropriate value
 184  *    for SSL servers or clients but only if the application has not set new
 185  *    ones.
 186  *
 187  * The "inh_flags" field determines how this function behaves.
 188  *
 189  * Normally any values which are set in the default are not copied from the
 190  * destination and verify flags are ORed together.
 191  *
 192  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
 193  * to the destination. Effectively the values in "to" become default values
 194  * which will be used only if nothing new is set in "from".
 195  *
 196  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
 197  * they are set or not. Flags is still Ored though.
 198  *
 199  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
 200  * of ORed.
 201  *
 202  * If X509_VP_FLAG_LOCKED is set then no values are copied.
 203  *
 204  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
 205  * after the next call.
 206  */
 207
 208 /* Macro to test if a field should be copied from src to dest */
 209
 210 #define test_x509_verify_param_copy(field, def) \
 211         (to_overwrite || \
 212                 ((src->field != def) && (to_default || (dest->field == def))))
 213
 214 /* Macro to test and copy a field if necessary */
 215
 216 #define x509_verify_param_copy(field, def) \
 217         if (test_x509_verify_param_copy(field, def)) \
 218                 dest->field = src->field
 219
 220 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
 221                               const X509_VERIFY_PARAM *src)
 222 {
 223     unsigned long inh_flags;
 224     int to_default, to_overwrite;
 225     if (!src)
 226         return 1;
 227     inh_flags = dest->inh_flags | src->inh_flags;
 228
 229     if (inh_flags & X509_VP_FLAG_ONCE)
 230         dest->inh_flags = 0;
 231
 232     if (inh_flags & X509_VP_FLAG_LOCKED)
 233         return 1;
 234
 235     if (inh_flags & X509_VP_FLAG_DEFAULT)
 236         to_default = 1;
 237     else
 238         to_default = 0;
 239
 240     if (inh_flags & X509_VP_FLAG_OVERWRITE)
 241         to_overwrite = 1;
 242     else
 243         to_overwrite = 0;
 244
 245     x509_verify_param_copy(purpose, 0);
 246     x509_verify_param_copy(trust, X509_TRUST_DEFAULT);
 247     x509_verify_param_copy(depth, -1);
 248
 249     /* If overwrite or check time not set, copy across */
 250
 251     if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
 252         dest->check_time = src->check_time;
 253         dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
 254         /* Don't need to copy flag: that is done below */
 255     }
 256
 257     if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
 258         dest->flags = 0;
 259
 260     dest->flags |= src->flags;
 261
 262     if (test_x509_verify_param_copy(policies, NULL)) {
 263         if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
 264             return 0;
 265     }
 266
 267     /* Copy the host flags if and only if we're copying the host list */
 268     if (test_x509_verify_param_copy(hosts, NULL)) {
 269         sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
 270         dest->hosts = NULL;
 271         if (src->hosts) {
 272             dest->hosts =
 273                 sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
 274             if (dest->hosts == NULL)
 275                 return 0;
 276             dest->hostflags = src->hostflags;
 277         }
 278     }
 279
 280     if (test_x509_verify_param_copy(email, NULL)) {
 281         if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
 282             return 0;
 283     }
 284
 285     if (test_x509_verify_param_copy(ip, NULL)) {
 286         if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
 287             return 0;
 288     }
 289
 290     return 1;
 291 }
 292
 293 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
 294                            const X509_VERIFY_PARAM *from)
 295 {
 296     unsigned long save_flags = to->inh_flags;
 297     int ret;
 298     to->inh_flags |= X509_VP_FLAG_DEFAULT;
 299     ret = X509_VERIFY_PARAM_inherit(to, from);
 300     to->inh_flags = save_flags;
 301     return ret;
 302 }
 303
 304 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
 305                                const char *src, size_t srclen)
 306 {
 307     void *tmp;
 308     if (src) {
 309         if (srclen == 0) {
 310             tmp = OPENSSL_strdup(src);
 311             srclen = strlen(src);
 312         } else
 313             tmp = OPENSSL_memdup(src, srclen);
 314         if (!tmp)
 315             return 0;
 316     } else {
 317         tmp = NULL;
 318         srclen = 0;
 319     }
 320     OPENSSL_free(*pdest);
 321     *pdest = tmp;
 322     if (pdestlen)
 323         *pdestlen = srclen;
 324     return 1;
 325 }
 326
 327 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
 328 {
 329     OPENSSL_free(param->name);
 330     param->name = OPENSSL_strdup(name);
 331     if (param->name)
 332         return 1;
 333     return 0;
 334 }
 335
 336 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
 337 {
 338     param->flags |= flags;
 339     if (flags & X509_V_FLAG_POLICY_MASK)
 340         param->flags |= X509_V_FLAG_POLICY_CHECK;
 341     return 1;
 342 }
 343
 344 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
 345                                   unsigned long flags)
 346 {
 347     param->flags &= ~flags;
 348     return 1;
 349 }
 350
 351 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
 352 {
 353     return param->flags;
 354 }
 355
 356 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
 357 {
 358     return X509_PURPOSE_set(&param->purpose, purpose);
 359 }
 360
 361 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
 362 {
 363     return X509_TRUST_set(&param->trust, trust);
 364 }
 365
 366 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
 367 {
 368     param->depth = depth;
 369 }
 370
 371 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
 372 {
 373     param->check_time = t;
 374     param->flags |= X509_V_FLAG_USE_CHECK_TIME;
 375 }
 376
 377 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
 378                                   ASN1_OBJECT *policy)
 379 {
 380     if (!param->policies) {
 381         param->policies = sk_ASN1_OBJECT_new_null();
 382         if (!param->policies)
 383             return 0;
 384     }
 385     if (!sk_ASN1_OBJECT_push(param->policies, policy))
 386         return 0;
 387     return 1;
 388 }
 389
 390 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
 391                                     STACK_OF(ASN1_OBJECT) *policies)
 392 {
 393     int i;
 394     ASN1_OBJECT *oid, *doid;
 395
 396     if (!param)
 397         return 0;
 398     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
 399
 400     if (!policies) {
 401         param->policies = NULL;
 402         return 1;
 403     }
 404
 405     param->policies = sk_ASN1_OBJECT_new_null();
 406     if (!param->policies)
 407         return 0;
 408
 409     for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
 410         oid = sk_ASN1_OBJECT_value(policies, i);
 411         doid = OBJ_dup(oid);
 412         if (!doid)
 413             return 0;
 414         if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
 415             ASN1_OBJECT_free(doid);
 416             return 0;
 417         }
 418     }
 419     param->flags |= X509_V_FLAG_POLICY_CHECK;
 420     return 1;
 421 }
 422
 423 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
 424                                 const char *name, size_t namelen)
 425 {
 426     return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
 427 }
 428
 429 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
 430                                 const char *name, size_t namelen)
 431 {
 432     return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
 433 }
 434
 435 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
 436                                      unsigned int flags)
 437 {
 438     param->hostflags = flags;
 439 }
 440
 441 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
 442 {
 443     return param->peername;
 444 }
 445
 446 /*
 447  * Move peername from one param structure to another, freeing any name present
 448  * at the target.  If the source is a NULL parameter structure, free and zero
 449  * the target peername.
 450  */
 451 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
 452                                      X509_VERIFY_PARAM *from)
 453 {
 454     char *peername = (from != NULL) ? from->peername : NULL;
 455
 456     if (to->peername != peername) {
 457         OPENSSL_free(to->peername);
 458         to->peername = peername;
 459     }
 460     if (from)
 461         from->peername = NULL;
 462 }
 463
 464 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
 465                                  const char *email, size_t emaillen)
 466 {
 467     return int_x509_param_set1(&param->email, &param->emaillen,
 468                                email, emaillen);
 469 }
 470
 471 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
 472                               const unsigned char *ip, size_t iplen)
 473 {
 474     if (iplen != 0 && iplen != 4 && iplen != 16)
 475         return 0;
 476     return int_x509_param_set1((char **)&param->ip, &param->iplen,
 477                                (char *)ip, iplen);
 478 }
 479
 480 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
 481 {
 482     unsigned char ipout[16];
 483     size_t iplen;
 484
 485     iplen = (size_t)a2i_ipadd(ipout, ipasc);
 486     if (iplen == 0)
 487         return 0;
 488     return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
 489 }
 490
 491 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
 492 {
 493     return param->depth;
 494 }
 495
 496 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
 497 {
 498     return param->name;
 499 }
 500
 501 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
 502
 503 /*
 504  * Default verify parameters: these are used for various applications and can
 505  * be overridden by the user specified table. NB: the 'name' field *must* be
 506  * in alphabetical order because it will be searched using OBJ_search.
 507  */
 508
 509 static const X509_VERIFY_PARAM default_table[] = {
 510     {
 511      "default",                 /* X509 default parameters */
 512      0,                         /* Check time */
 513      0,                         /* internal flags */
 514      X509_V_FLAG_TRUSTED_FIRST, /* flags */
 515      0,                         /* purpose */
 516      0,                         /* trust */
 517      100,                       /* depth */
 518      NULL,                      /* policies */
 519      vpm_empty_id},
 520     {
 521      "pkcs7",                   /* S/MIME sign parameters */
 522      0,                         /* Check time */
 523      0,                         /* internal flags */
 524      0,                         /* flags */
 525      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 526      X509_TRUST_EMAIL,          /* trust */
 527      -1,                        /* depth */
 528      NULL,                      /* policies */
 529      vpm_empty_id},
 530     {
 531      "smime_sign",              /* S/MIME sign parameters */
 532      0,                         /* Check time */
 533      0,                         /* internal flags */
 534      0,                         /* flags */
 535      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 536      X509_TRUST_EMAIL,          /* trust */
 537      -1,                        /* depth */
 538      NULL,                      /* policies */
 539      vpm_empty_id},
 540     {
 541      "ssl_client",              /* SSL/TLS client parameters */
 542      0,                         /* Check time */
 543      0,                         /* internal flags */
 544      0,                         /* flags */
 545      X509_PURPOSE_SSL_CLIENT,   /* purpose */
 546      X509_TRUST_SSL_CLIENT,     /* trust */
 547      -1,                        /* depth */
 548      NULL,                      /* policies */
 549      vpm_empty_id},
 550     {
 551      "ssl_server",              /* SSL/TLS server parameters */
 552      0,                         /* Check time */
 553      0,                         /* internal flags */
 554      0,                         /* flags */
 555      X509_PURPOSE_SSL_SERVER,   /* purpose */
 556      X509_TRUST_SSL_SERVER,     /* trust */
 557      -1,                        /* depth */
 558      NULL,                      /* policies */
 559      vpm_empty_id}
 560 };
 561
 562 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
 563
 564 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
 565 {
 566     return strcmp(a->name, b->name);
 567 }
 568
 569 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 570 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 571
 572 static int param_cmp(const X509_VERIFY_PARAM *const *a,
 573                      const X509_VERIFY_PARAM *const *b)
 574 {
 575     return strcmp((*a)->name, (*b)->name);
 576 }
 577
 578 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
 579 {
 580     int idx;
 581     X509_VERIFY_PARAM *ptmp;
 582     if (param_table == NULL) {
 583         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
 584         if (param_table == NULL)
 585             return 0;
 586     } else {
 587         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
 588         if (idx != -1) {
 589             ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
 590             X509_VERIFY_PARAM_free(ptmp);
 591             (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
 592         }
 593     }
 594     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
 595         return 0;
 596     return 1;
 597 }
 598
 599 int X509_VERIFY_PARAM_get_count(void)
 600 {
 601     int num = OSSL_NELEM(default_table);
 602     if (param_table)
 603         num += sk_X509_VERIFY_PARAM_num(param_table);
 604     return num;
 605 }
 606
 607 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
 608 {
 609     int num = OSSL_NELEM(default_table);
 610     if (id < num)
 611         return default_table + id;
 612     return sk_X509_VERIFY_PARAM_value(param_table, id - num);
 613 }
 614
 615 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
 616 {
 617     int idx;
 618     X509_VERIFY_PARAM pm;
 619
 620     pm.name = (char *)name;
 621     if (param_table) {
 622         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
 623         if (idx != -1)
 624             return sk_X509_VERIFY_PARAM_value(param_table, idx);
 625     }
 626     return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
 627 }
 628
 629 void X509_VERIFY_PARAM_table_cleanup(void)
 630 {
 631     sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
 632     param_table = NULL;
 633 }