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