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(ASN1_OBJECT)
  22 DEFINE_STACK_OF(X509_VERIFY_PARAM)
  23 DEFINE_STACK_OF_STRING()
  24
  25 /* X509_VERIFY_PARAM functions */
  26
  27 #define SET_HOST 0
  28 #define ADD_HOST 1
  29
  30 static char *str_copy(const char *s)
  31 {
  32     return OPENSSL_strdup(s);
  33 }
  34
  35 static void str_free(char *s)
  36 {
  37     OPENSSL_free(s);
  38 }
  39
  40 static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
  41                                     const char *name, size_t namelen)
  42 {
  43     char *copy;
  44
  45     /*
  46      * Refuse names with embedded NUL bytes, except perhaps as final byte.
  47      * XXX: Do we need to push an error onto the error stack?
  48      */
  49     if (namelen == 0 || name == NULL)
  50         namelen = name ? strlen(name) : 0;
  51     else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
  52         return 0;
  53     if (namelen > 0 && name[namelen - 1] == '\0')
  54         --namelen;
  55
  56     if (mode == SET_HOST) {
  57         sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
  58         vpm->hosts = NULL;
  59     }
  60     if (name == NULL || namelen == 0)
  61         return 1;
  62
  63     copy = OPENSSL_strndup(name, namelen);
  64     if (copy == NULL)
  65         return 0;
  66
  67     if (vpm->hosts == NULL &&
  68         (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
  69         OPENSSL_free(copy);
  70         return 0;
  71     }
  72
  73     if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
  74         OPENSSL_free(copy);
  75         if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
  76             sk_OPENSSL_STRING_free(vpm->hosts);
  77             vpm->hosts = NULL;
  78         }
  79         return 0;
  80     }
  81
  82     return 1;
  83 }
  84
  85
  86 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
  87 {
  88     X509_VERIFY_PARAM *param;
  89
  90     param = OPENSSL_zalloc(sizeof(*param));
  91     if (param == NULL) {
  92         X509err(X509_F_X509_VERIFY_PARAM_NEW, ERR_R_MALLOC_FAILURE);
  93         return NULL;
  94     }
  95     param->trust = X509_TRUST_DEFAULT;
  96     /* param->inh_flags = X509_VP_FLAG_DEFAULT; */
  97     param->depth = -1;
  98     param->auth_level = -1; /* -1 means unset, 0 is explicit */
  99     return param;
 100 }
 101
 102 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
 103 {
 104     if (param == NULL)
 105         return;
 106     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
 107     sk_OPENSSL_STRING_pop_free(param->hosts, str_free);
 108     OPENSSL_free(param->peername);
 109     OPENSSL_free(param->email);
 110     OPENSSL_free(param->ip);
 111     OPENSSL_free(param);
 112 }
 113
 114 /*-
 115  * This function determines how parameters are "inherited" from one structure
 116  * to another. There are several different ways this can happen.
 117  *
 118  * 1. If a child structure needs to have its values initialized from a parent
 119  *    they are simply copied across. For example SSL_CTX copied to SSL.
 120  * 2. If the structure should take on values only if they are currently unset.
 121  *    For example the values in an SSL structure will take appropriate value
 122  *    for SSL servers or clients but only if the application has not set new
 123  *    ones.
 124  *
 125  * The "inh_flags" field determines how this function behaves.
 126  *
 127  * Normally any values which are set in the default are not copied from the
 128  * destination and verify flags are ORed together.
 129  *
 130  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
 131  * to the destination. Effectively the values in "to" become default values
 132  * which will be used only if nothing new is set in "from".
 133  *
 134  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
 135  * they are set or not. Flags is still Ored though.
 136  *
 137  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
 138  * of ORed.
 139  *
 140  * If X509_VP_FLAG_LOCKED is set then no values are copied.
 141  *
 142  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
 143  * after the next call.
 144  */
 145
 146 /* Macro to test if a field should be copied from src to dest */
 147
 148 #define test_x509_verify_param_copy(field, def) \
 149         (to_overwrite || \
 150                 ((src->field != def) && (to_default || (dest->field == def))))
 151
 152 /* Macro to test and copy a field if necessary */
 153
 154 #define x509_verify_param_copy(field, def) \
 155         if (test_x509_verify_param_copy(field, def)) \
 156                 dest->field = src->field
 157
 158 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
 159                               const X509_VERIFY_PARAM *src)
 160 {
 161     unsigned long inh_flags;
 162     int to_default, to_overwrite;
 163     if (!src)
 164         return 1;
 165     inh_flags = dest->inh_flags | src->inh_flags;
 166
 167     if (inh_flags & X509_VP_FLAG_ONCE)
 168         dest->inh_flags = 0;
 169
 170     if (inh_flags & X509_VP_FLAG_LOCKED)
 171         return 1;
 172
 173     if (inh_flags & X509_VP_FLAG_DEFAULT)
 174         to_default = 1;
 175     else
 176         to_default = 0;
 177
 178     if (inh_flags & X509_VP_FLAG_OVERWRITE)
 179         to_overwrite = 1;
 180     else
 181         to_overwrite = 0;
 182
 183     x509_verify_param_copy(purpose, 0);
 184     x509_verify_param_copy(trust, X509_TRUST_DEFAULT);
 185     x509_verify_param_copy(depth, -1);
 186     x509_verify_param_copy(auth_level, -1);
 187
 188     /* If overwrite or check time not set, copy across */
 189
 190     if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
 191         dest->check_time = src->check_time;
 192         dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
 193         /* Don't need to copy flag: that is done below */
 194     }
 195
 196     if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
 197         dest->flags = 0;
 198
 199     dest->flags |= src->flags;
 200
 201     if (test_x509_verify_param_copy(policies, NULL)) {
 202         if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
 203             return 0;
 204     }
 205
 206     /* Copy the host flags if and only if we're copying the host list */
 207     if (test_x509_verify_param_copy(hosts, NULL)) {
 208         sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
 209         dest->hosts = NULL;
 210         if (src->hosts) {
 211             dest->hosts =
 212                 sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
 213             if (dest->hosts == NULL)
 214                 return 0;
 215             dest->hostflags = src->hostflags;
 216         }
 217     }
 218
 219     if (test_x509_verify_param_copy(email, NULL)) {
 220         if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
 221             return 0;
 222     }
 223
 224     if (test_x509_verify_param_copy(ip, NULL)) {
 225         if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
 226             return 0;
 227     }
 228
 229     return 1;
 230 }
 231
 232 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
 233                            const X509_VERIFY_PARAM *from)
 234 {
 235     unsigned long save_flags = to->inh_flags;
 236     int ret;
 237     to->inh_flags |= X509_VP_FLAG_DEFAULT;
 238     ret = X509_VERIFY_PARAM_inherit(to, from);
 239     to->inh_flags = save_flags;
 240     return ret;
 241 }
 242
 243 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
 244                                const char *src, size_t srclen)
 245 {
 246     void *tmp;
 247     if (src) {
 248         if (srclen == 0)
 249             srclen = strlen(src);
 250
 251         tmp = OPENSSL_memdup(src, srclen);
 252         if (tmp == NULL)
 253             return 0;
 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 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
 383                                 const char *name, size_t namelen)
 384 {
 385     return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
 386 }
 387
 388 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
 389                                 const char *name, size_t namelen)
 390 {
 391     return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
 392 }
 393
 394 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
 395                                      unsigned int flags)
 396 {
 397     param->hostflags = flags;
 398 }
 399
 400 unsigned int X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM *param)
 401 {
 402     return param->hostflags;
 403 }
 404
 405 char *X509_VERIFY_PARAM_get0_peername(const X509_VERIFY_PARAM *param)
 406 {
 407     return param->peername;
 408 }
 409
 410 /*
 411  * Move peername from one param structure to another, freeing any name present
 412  * at the target.  If the source is a NULL parameter structure, free and zero
 413  * the target peername.
 414  */
 415 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
 416                                      X509_VERIFY_PARAM *from)
 417 {
 418     char *peername = (from != NULL) ? from->peername : NULL;
 419
 420     if (to->peername != peername) {
 421         OPENSSL_free(to->peername);
 422         to->peername = peername;
 423     }
 424     if (from)
 425         from->peername = NULL;
 426 }
 427
 428 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
 429                                  const char *email, size_t emaillen)
 430 {
 431     return int_x509_param_set1(&param->email, &param->emaillen,
 432                                email, emaillen);
 433 }
 434
 435 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
 436                               const unsigned char *ip, size_t iplen)
 437 {
 438     if (iplen != 0 && iplen != 4 && iplen != 16)
 439         return 0;
 440     return int_x509_param_set1((char **)&param->ip, &param->iplen,
 441                                (char *)ip, iplen);
 442 }
 443
 444 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
 445 {
 446     unsigned char ipout[16];
 447     size_t iplen;
 448
 449     iplen = (size_t)a2i_ipadd(ipout, ipasc);
 450     if (iplen == 0)
 451         return 0;
 452     return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
 453 }
 454
 455 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
 456 {
 457     return param->depth;
 458 }
 459
 460 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param)
 461 {
 462     return param->auth_level;
 463 }
 464
 465 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
 466 {
 467     return param->name;
 468 }
 469
 470 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
 471
 472 /*
 473  * Default verify parameters: these are used for various applications and can
 474  * be overridden by the user specified table. NB: the 'name' field *must* be
 475  * in alphabetical order because it will be searched using OBJ_search.
 476  */
 477
 478 static const X509_VERIFY_PARAM default_table[] = {
 479     {
 480      "default",                 /* X509 default parameters */
 481      0,                         /* Check time */
 482      0,                         /* internal flags */
 483      X509_V_FLAG_TRUSTED_FIRST, /* flags */
 484      0,                         /* purpose */
 485      0,                         /* trust */
 486      100,                       /* depth */
 487      -1,                        /* auth_level */
 488      NULL,                      /* policies */
 489      vpm_empty_id},
 490     {
 491      "pkcs7",                   /* S/MIME sign parameters */
 492      0,                         /* Check time */
 493      0,                         /* internal flags */
 494      0,                         /* flags */
 495      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 496      X509_TRUST_EMAIL,          /* trust */
 497      -1,                        /* depth */
 498      -1,                        /* auth_level */
 499      NULL,                      /* policies */
 500      vpm_empty_id},
 501     {
 502      "smime_sign",              /* S/MIME sign parameters */
 503      0,                         /* Check time */
 504      0,                         /* internal flags */
 505      0,                         /* flags */
 506      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 507      X509_TRUST_EMAIL,          /* trust */
 508      -1,                        /* depth */
 509      -1,                        /* auth_level */
 510      NULL,                      /* policies */
 511      vpm_empty_id},
 512     {
 513      "ssl_client",              /* SSL/TLS client parameters */
 514      0,                         /* Check time */
 515      0,                         /* internal flags */
 516      0,                         /* flags */
 517      X509_PURPOSE_SSL_CLIENT,   /* purpose */
 518      X509_TRUST_SSL_CLIENT,     /* trust */
 519      -1,                        /* depth */
 520      -1,                        /* auth_level */
 521      NULL,                      /* policies */
 522      vpm_empty_id},
 523     {
 524      "ssl_server",              /* SSL/TLS server parameters */
 525      0,                         /* Check time */
 526      0,                         /* internal flags */
 527      0,                         /* flags */
 528      X509_PURPOSE_SSL_SERVER,   /* purpose */
 529      X509_TRUST_SSL_SERVER,     /* trust */
 530      -1,                        /* depth */
 531      -1,                        /* auth_level */
 532      NULL,                      /* policies */
 533      vpm_empty_id}
 534 };
 535
 536 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
 537
 538 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
 539 {
 540     return strcmp(a->name, b->name);
 541 }
 542
 543 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 544 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 545
 546 static int param_cmp(const X509_VERIFY_PARAM *const *a,
 547                      const X509_VERIFY_PARAM *const *b)
 548 {
 549     return strcmp((*a)->name, (*b)->name);
 550 }
 551
 552 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
 553 {
 554     int idx;
 555     X509_VERIFY_PARAM *ptmp;
 556     if (param_table == NULL) {
 557         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
 558         if (param_table == NULL)
 559             return 0;
 560     } else {
 561         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
 562         if (idx >= 0) {
 563             ptmp = sk_X509_VERIFY_PARAM_delete(param_table, idx);
 564             X509_VERIFY_PARAM_free(ptmp);
 565         }
 566     }
 567     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
 568         return 0;
 569     return 1;
 570 }
 571
 572 int X509_VERIFY_PARAM_get_count(void)
 573 {
 574     int num = OSSL_NELEM(default_table);
 575     if (param_table)
 576         num += sk_X509_VERIFY_PARAM_num(param_table);
 577     return num;
 578 }
 579
 580 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
 581 {
 582     int num = OSSL_NELEM(default_table);
 583     if (id < num)
 584         return default_table + id;
 585     return sk_X509_VERIFY_PARAM_value(param_table, id - num);
 586 }
 587
 588 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
 589 {
 590     int idx;
 591     X509_VERIFY_PARAM pm;
 592
 593     pm.name = (char *)name;
 594     if (param_table != NULL) {
 595         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
 596         if (idx >= 0)
 597             return sk_X509_VERIFY_PARAM_value(param_table, idx);
 598     }
 599     return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
 600 }
 601
 602 void X509_VERIFY_PARAM_table_cleanup(void)
 603 {
 604     sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
 605     param_table = NULL;
 606 }