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