crypto/x509/x509_vpm.c

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