crypto/x509/x509_vpm.c

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