crypto/x509/x509_vpm.c

   1 /*
   2  * Copyright 2004-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (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/buffer.h>
  15 #include <openssl/x509.h>
  16 #include <openssl/x509v3.h>
  17 #include "crypto/x509.h"
  18
  19 #include "x509_local.h"
  20
  21 DEFINE_STACK_OF(X509_VERIFY_PARAM)
  22
  23 /* X509_VERIFY_PARAM functions */
  24
  25 #define SET_HOST 0
  26 #define ADD_HOST 1
  27
  28 static char *str_copy(const char *s)
  29 {
  30     return OPENSSL_strdup(s);
  31 }
  32
  33 static void str_free(char *s)
  34 {
  35     OPENSSL_free(s);
  36 }
  37
  38 static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
  39                                     const char *name, size_t namelen)
  40 {
  41     char *copy;
  42
  43     /*
  44      * Refuse names with embedded NUL bytes, except perhaps as final byte.
  45      * XXX: Do we need to push an error onto the error stack?
  46      */
  47     if (namelen == 0 || name == NULL)
  48         namelen = name ? strlen(name) : 0;
  49     else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
  50         return 0;
  51     if (namelen > 0 && name[namelen - 1] == '\0')
  52         --namelen;
  53
  54     if (mode == SET_HOST) {
  55         sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
  56         vpm->hosts = NULL;
  57     }
  58     if (name == NULL || namelen == 0)
  59         return 1;
  60
  61     copy = OPENSSL_strndup(name, namelen);
  62     if (copy == NULL)
  63         return 0;
  64
  65     if (vpm->hosts == NULL &&
  66         (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
  67         OPENSSL_free(copy);
  68         return 0;
  69     }
  70
  71     if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
  72         OPENSSL_free(copy);
  73         if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
  74             sk_OPENSSL_STRING_free(vpm->hosts);
  75             vpm->hosts = NULL;
  76         }
  77         return 0;
  78     }
  79
  80     return 1;
  81 }
  82
  83
  84 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
  85 {
  86     X509_VERIFY_PARAM *param;
  87
  88     param = OPENSSL_zalloc(sizeof(*param));
  89     if (param == NULL) {
  90         X509err(X509_F_X509_VERIFY_PARAM_NEW, ERR_R_MALLOC_FAILURE);
  91         return NULL;
  92     }
  93     param->trust = X509_TRUST_DEFAULT;
  94     /* param->inh_flags = X509_VP_FLAG_DEFAULT; */
  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     char *tmp;
 245     if (src) {
 246         if (srclen == 0)
 247             srclen = strlen(src);
 248
 249         tmp = OPENSSL_malloc(srclen + 1);
 250         if (tmp == NULL)
 251             return 0;
 252         memcpy(tmp, src, srclen);
 253         tmp[srclen] = '\0'; /* enforce NUL termination */
 254     } else {
 255         tmp = NULL;
 256         srclen = 0;
 257     }
 258     OPENSSL_free(*pdest);
 259     *pdest = tmp;
 260     if (pdestlen != NULL)
 261         *pdestlen = srclen;
 262     return 1;
 263 }
 264
 265 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
 266 {
 267     OPENSSL_free(param->name);
 268     param->name = OPENSSL_strdup(name);
 269     if (param->name)
 270         return 1;
 271     return 0;
 272 }
 273
 274 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
 275 {
 276     param->flags |= flags;
 277     if (flags & X509_V_FLAG_POLICY_MASK)
 278         param->flags |= X509_V_FLAG_POLICY_CHECK;
 279     return 1;
 280 }
 281
 282 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
 283                                   unsigned long flags)
 284 {
 285     param->flags &= ~flags;
 286     return 1;
 287 }
 288
 289 unsigned long X509_VERIFY_PARAM_get_flags(const X509_VERIFY_PARAM *param)
 290 {
 291     return param->flags;
 292 }
 293
 294 uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM *param)
 295 {
 296     return param->inh_flags;
 297 }
 298
 299 int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM *param, uint32_t flags)
 300 {
 301     param->inh_flags = flags;
 302     return 1;
 303 }
 304
 305 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
 306 {
 307     return X509_PURPOSE_set(&param->purpose, purpose);
 308 }
 309
 310 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
 311 {
 312     return X509_TRUST_set(&param->trust, trust);
 313 }
 314
 315 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
 316 {
 317     param->depth = depth;
 318 }
 319
 320 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level)
 321 {
 322     param->auth_level = auth_level;
 323 }
 324
 325 time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM *param)
 326 {
 327     return param->check_time;
 328 }
 329
 330 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
 331 {
 332     param->check_time = t;
 333     param->flags |= X509_V_FLAG_USE_CHECK_TIME;
 334 }
 335
 336 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
 337                                   ASN1_OBJECT *policy)
 338 {
 339     if (param->policies == NULL) {
 340         param->policies = sk_ASN1_OBJECT_new_null();
 341         if (param->policies == NULL)
 342             return 0;
 343     }
 344     if (!sk_ASN1_OBJECT_push(param->policies, policy))
 345         return 0;
 346     return 1;
 347 }
 348
 349 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
 350                                     STACK_OF(ASN1_OBJECT) *policies)
 351 {
 352     int i;
 353     ASN1_OBJECT *oid, *doid;
 354
 355     if (param == NULL)
 356         return 0;
 357     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
 358
 359     if (policies == NULL) {
 360         param->policies = NULL;
 361         return 1;
 362     }
 363
 364     param->policies = sk_ASN1_OBJECT_new_null();
 365     if (param->policies == NULL)
 366         return 0;
 367
 368     for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
 369         oid = sk_ASN1_OBJECT_value(policies, i);
 370         doid = OBJ_dup(oid);
 371         if (!doid)
 372             return 0;
 373         if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
 374             ASN1_OBJECT_free(doid);
 375             return 0;
 376         }
 377     }
 378     param->flags |= X509_V_FLAG_POLICY_CHECK;
 379     return 1;
 380 }
 381
 382 char *X509_VERIFY_PARAM_get0_host(X509_VERIFY_PARAM *param, int idx)
 383 {
 384     return sk_OPENSSL_STRING_value(param->hosts, idx);
 385 }
 386
 387 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
 388                                 const char *name, size_t namelen)
 389 {
 390     return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
 391 }
 392
 393 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
 394                                 const char *name, size_t namelen)
 395 {
 396     return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
 397 }
 398
 399 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
 400                                      unsigned int flags)
 401 {
 402     param->hostflags = flags;
 403 }
 404
 405 unsigned int X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM *param)
 406 {
 407     return param->hostflags;
 408 }
 409
 410 char *X509_VERIFY_PARAM_get0_peername(const X509_VERIFY_PARAM *param)
 411 {
 412     return param->peername;
 413 }
 414
 415 /*
 416  * Move peername from one param structure to another, freeing any name present
 417  * at the target.  If the source is a NULL parameter structure, free and zero
 418  * the target peername.
 419  */
 420 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
 421                                      X509_VERIFY_PARAM *from)
 422 {
 423     char *peername = (from != NULL) ? from->peername : NULL;
 424
 425     if (to->peername != peername) {
 426         OPENSSL_free(to->peername);
 427         to->peername = peername;
 428     }
 429     if (from)
 430         from->peername = NULL;
 431 }
 432
 433 char *X509_VERIFY_PARAM_get0_email(X509_VERIFY_PARAM *param)
 434 {
 435     return param->email;
 436 }
 437
 438 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
 439                                  const char *email, size_t emaillen)
 440 {
 441     return int_x509_param_set1(&param->email, &param->emaillen,
 442                                email, emaillen);
 443 }
 444
 445 static unsigned char
 446 *int_X509_VERIFY_PARAM_get0_ip(X509_VERIFY_PARAM *param, size_t *plen)
 447 {
 448     if (param == NULL || param->ip == NULL)
 449         return NULL;
 450     if (plen != NULL)
 451         *plen = param->iplen;
 452     return param->ip;
 453 }
 454
 455 char *X509_VERIFY_PARAM_get1_ip_asc(X509_VERIFY_PARAM *param)
 456 {
 457     size_t iplen;
 458     unsigned char *ip = int_X509_VERIFY_PARAM_get0_ip(param, &iplen);
 459
 460     return  ip == NULL ? NULL : ipaddr_to_asc(ip, iplen);
 461 }
 462
 463 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
 464                               const unsigned char *ip, size_t iplen)
 465 {
 466     if (iplen != 0 && iplen != 4 && iplen != 16)
 467         return 0;
 468     return int_x509_param_set1((char **)&param->ip, &param->iplen,
 469                                (char *)ip, iplen);
 470 }
 471
 472 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
 473 {
 474     unsigned char ipout[16];
 475     size_t iplen;
 476
 477     iplen = (size_t)a2i_ipadd(ipout, ipasc);
 478     if (iplen == 0)
 479         return 0;
 480     return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
 481 }
 482
 483 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
 484 {
 485     return param->depth;
 486 }
 487
 488 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param)
 489 {
 490     return param->auth_level;
 491 }
 492
 493 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
 494 {
 495     return param->name;
 496 }
 497
 498 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
 499
 500 /*
 501  * Default verify parameters: these are used for various applications and can
 502  * be overridden by the user specified table. NB: the 'name' field *must* be
 503  * in alphabetical order because it will be searched using OBJ_search.
 504  */
 505
 506 static const X509_VERIFY_PARAM default_table[] = {
 507     {
 508      "default",                 /* X509 default parameters */
 509      0,                         /* Check time */
 510      0,                         /* internal flags */
 511      X509_V_FLAG_TRUSTED_FIRST, /* flags */
 512      0,                         /* purpose */
 513      0,                         /* trust */
 514      100,                       /* depth */
 515      -1,                        /* auth_level */
 516      NULL,                      /* policies */
 517      vpm_empty_id},
 518     {
 519      "pkcs7",                   /* S/MIME sign parameters */
 520      0,                         /* Check time */
 521      0,                         /* internal flags */
 522      0,                         /* flags */
 523      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 524      X509_TRUST_EMAIL,          /* trust */
 525      -1,                        /* depth */
 526      -1,                        /* auth_level */
 527      NULL,                      /* policies */
 528      vpm_empty_id},
 529     {
 530      "smime_sign",              /* S/MIME sign parameters */
 531      0,                         /* Check time */
 532      0,                         /* internal flags */
 533      0,                         /* flags */
 534      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 535      X509_TRUST_EMAIL,          /* trust */
 536      -1,                        /* depth */
 537      -1,                        /* auth_level */
 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      -1,                        /* auth_level */
 549      NULL,                      /* policies */
 550      vpm_empty_id},
 551     {
 552      "ssl_server",              /* SSL/TLS server parameters */
 553      0,                         /* Check time */
 554      0,                         /* internal flags */
 555      0,                         /* flags */
 556      X509_PURPOSE_SSL_SERVER,   /* purpose */
 557      X509_TRUST_SSL_SERVER,     /* trust */
 558      -1,                        /* depth */
 559      -1,                        /* auth_level */
 560      NULL,                      /* policies */
 561      vpm_empty_id}
 562 };
 563
 564 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
 565
 566 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
 567 {
 568     return strcmp(a->name, b->name);
 569 }
 570
 571 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 572 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 573
 574 static int param_cmp(const X509_VERIFY_PARAM *const *a,
 575                      const X509_VERIFY_PARAM *const *b)
 576 {
 577     return strcmp((*a)->name, (*b)->name);
 578 }
 579
 580 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
 581 {
 582     int idx;
 583     X509_VERIFY_PARAM *ptmp;
 584     if (param_table == NULL) {
 585         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
 586         if (param_table == NULL)
 587             return 0;
 588     } else {
 589         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
 590         if (idx >= 0) {
 591             ptmp = sk_X509_VERIFY_PARAM_delete(param_table, idx);
 592             X509_VERIFY_PARAM_free(ptmp);
 593         }
 594     }
 595     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
 596         return 0;
 597     return 1;
 598 }
 599
 600 int X509_VERIFY_PARAM_get_count(void)
 601 {
 602     int num = OSSL_NELEM(default_table);
 603     if (param_table)
 604         num += sk_X509_VERIFY_PARAM_num(param_table);
 605     return num;
 606 }
 607
 608 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
 609 {
 610     int num = OSSL_NELEM(default_table);
 611     if (id < num)
 612         return default_table + id;
 613     return sk_X509_VERIFY_PARAM_value(param_table, id - num);
 614 }
 615
 616 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
 617 {
 618     int idx;
 619     X509_VERIFY_PARAM pm;
 620
 621     pm.name = (char *)name;
 622     if (param_table != NULL) {
 623         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
 624         if (idx >= 0)
 625             return sk_X509_VERIFY_PARAM_value(param_table, idx);
 626     }
 627     return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
 628 }
 629
 630 void X509_VERIFY_PARAM_table_cleanup(void)
 631 {
 632     sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
 633     param_table = NULL;
 634 }