crypto/openssl/crypto/x509/x509_vpm.c

   1 /* x509_vpm.c */
   2 /*
   3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
   4  * 2004.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 2004 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59
  60 #include <stdio.h>
  61
  62 #include "cryptlib.h"
  63 #include <openssl/crypto.h>
  64 #include <openssl/lhash.h>
  65 #include <openssl/buffer.h>
  66 #include <openssl/x509.h>
  67 #include <openssl/x509v3.h>
  68
  69 /* X509_VERIFY_PARAM functions */
  70
  71 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
  72 {
  73     if (!param)
  74         return;
  75     param->name = NULL;
  76     param->purpose = 0;
  77     param->trust = 0;
  78     /*
  79      * param->inh_flags = X509_VP_FLAG_DEFAULT;
  80      */
  81     param->inh_flags = 0;
  82     param->flags = 0;
  83     param->depth = -1;
  84     if (param->policies) {
  85         sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
  86         param->policies = NULL;
  87     }
  88 }
  89
  90 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
  91 {
  92     X509_VERIFY_PARAM *param;
  93     param = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
  94     if (!param)
  95         return NULL;
  96     memset(param, 0, sizeof(X509_VERIFY_PARAM));
  97     x509_verify_param_zero(param);
  98     return param;
  99 }
 100
 101 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
 102 {
 103     x509_verify_param_zero(param);
 104     OPENSSL_free(param);
 105 }
 106
 107 /*-
 108  * This function determines how parameters are "inherited" from one structure
 109  * to another. There are several different ways this can happen.
 110  *
 111  * 1. If a child structure needs to have its values initialized from a parent
 112  *    they are simply copied across. For example SSL_CTX copied to SSL.
 113  * 2. If the structure should take on values only if they are currently unset.
 114  *    For example the values in an SSL structure will take appropriate value
 115  *    for SSL servers or clients but only if the application has not set new
 116  *    ones.
 117  *
 118  * The "inh_flags" field determines how this function behaves.
 119  *
 120  * Normally any values which are set in the default are not copied from the
 121  * destination and verify flags are ORed together.
 122  *
 123  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
 124  * to the destination. Effectively the values in "to" become default values
 125  * which will be used only if nothing new is set in "from".
 126  *
 127  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
 128  * they are set or not. Flags is still Ored though.
 129  *
 130  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
 131  * of ORed.
 132  *
 133  * If X509_VP_FLAG_LOCKED is set then no values are copied.
 134  *
 135  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
 136  * after the next call.
 137  */
 138
 139 /* Macro to test if a field should be copied from src to dest */
 140
 141 #define test_x509_verify_param_copy(field, def) \
 142         (to_overwrite || \
 143                 ((src->field != def) && (to_default || (dest->field == def))))
 144
 145 /* Macro to test and copy a field if necessary */
 146
 147 #define x509_verify_param_copy(field, def) \
 148         if (test_x509_verify_param_copy(field, def)) \
 149                 dest->field = src->field
 150
 151 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
 152                               const X509_VERIFY_PARAM *src)
 153 {
 154     unsigned long inh_flags;
 155     int to_default, to_overwrite;
 156     if (!src)
 157         return 1;
 158     inh_flags = dest->inh_flags | src->inh_flags;
 159
 160     if (inh_flags & X509_VP_FLAG_ONCE)
 161         dest->inh_flags = 0;
 162
 163     if (inh_flags & X509_VP_FLAG_LOCKED)
 164         return 1;
 165
 166     if (inh_flags & X509_VP_FLAG_DEFAULT)
 167         to_default = 1;
 168     else
 169         to_default = 0;
 170
 171     if (inh_flags & X509_VP_FLAG_OVERWRITE)
 172         to_overwrite = 1;
 173     else
 174         to_overwrite = 0;
 175
 176     x509_verify_param_copy(purpose, 0);
 177     x509_verify_param_copy(trust, 0);
 178     x509_verify_param_copy(depth, -1);
 179
 180     /* If overwrite or check time not set, copy across */
 181
 182     if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
 183         dest->check_time = src->check_time;
 184         dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
 185         /* Don't need to copy flag: that is done below */
 186     }
 187
 188     if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
 189         dest->flags = 0;
 190
 191     dest->flags |= src->flags;
 192
 193     if (test_x509_verify_param_copy(policies, NULL)) {
 194         if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
 195             return 0;
 196     }
 197
 198     return 1;
 199 }
 200
 201 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
 202                            const X509_VERIFY_PARAM *from)
 203 {
 204     unsigned long save_flags = to->inh_flags;
 205     int ret;
 206     to->inh_flags |= X509_VP_FLAG_DEFAULT;
 207     ret = X509_VERIFY_PARAM_inherit(to, from);
 208     to->inh_flags = save_flags;
 209     return ret;
 210 }
 211
 212 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
 213 {
 214     if (param->name)
 215         OPENSSL_free(param->name);
 216     param->name = BUF_strdup(name);
 217     if (param->name)
 218         return 1;
 219     return 0;
 220 }
 221
 222 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
 223 {
 224     param->flags |= flags;
 225     if (flags & X509_V_FLAG_POLICY_MASK)
 226         param->flags |= X509_V_FLAG_POLICY_CHECK;
 227     return 1;
 228 }
 229
 230 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
 231                                   unsigned long flags)
 232 {
 233     param->flags &= ~flags;
 234     return 1;
 235 }
 236
 237 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
 238 {
 239     return param->flags;
 240 }
 241
 242 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
 243 {
 244     return X509_PURPOSE_set(&param->purpose, purpose);
 245 }
 246
 247 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
 248 {
 249     return X509_TRUST_set(&param->trust, trust);
 250 }
 251
 252 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
 253 {
 254     param->depth = depth;
 255 }
 256
 257 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
 258 {
 259     param->check_time = t;
 260     param->flags |= X509_V_FLAG_USE_CHECK_TIME;
 261 }
 262
 263 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
 264                                   ASN1_OBJECT *policy)
 265 {
 266     if (!param->policies) {
 267         param->policies = sk_ASN1_OBJECT_new_null();
 268         if (!param->policies)
 269             return 0;
 270     }
 271     if (!sk_ASN1_OBJECT_push(param->policies, policy))
 272         return 0;
 273     return 1;
 274 }
 275
 276 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
 277                                     STACK_OF(ASN1_OBJECT) *policies)
 278 {
 279     int i;
 280     ASN1_OBJECT *oid, *doid;
 281     if (!param)
 282         return 0;
 283     if (param->policies)
 284         sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
 285
 286     if (!policies) {
 287         param->policies = NULL;
 288         return 1;
 289     }
 290
 291     param->policies = sk_ASN1_OBJECT_new_null();
 292     if (!param->policies)
 293         return 0;
 294
 295     for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
 296         oid = sk_ASN1_OBJECT_value(policies, i);
 297         doid = OBJ_dup(oid);
 298         if (!doid)
 299             return 0;
 300         if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
 301             ASN1_OBJECT_free(doid);
 302             return 0;
 303         }
 304     }
 305     param->flags |= X509_V_FLAG_POLICY_CHECK;
 306     return 1;
 307 }
 308
 309 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
 310 {
 311     return param->depth;
 312 }
 313
 314 /*
 315  * Default verify parameters: these are used for various applications and can
 316  * be overridden by the user specified table. NB: the 'name' field *must* be
 317  * in alphabetical order because it will be searched using OBJ_search.
 318  */
 319
 320 static const X509_VERIFY_PARAM default_table[] = {
 321     {
 322      "default",                 /* X509 default parameters */
 323      0,                         /* Check time */
 324      0,                         /* internal flags */
 325      0,                         /* flags */
 326      0,                         /* purpose */
 327      0,                         /* trust */
 328      100,                       /* depth */
 329      NULL                       /* policies */
 330      },
 331     {
 332      "pkcs7",                   /* S/MIME sign parameters */
 333      0,                         /* Check time */
 334      0,                         /* internal flags */
 335      0,                         /* flags */
 336      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 337      X509_TRUST_EMAIL,          /* trust */
 338      -1,                        /* depth */
 339      NULL                       /* policies */
 340      },
 341     {
 342      "smime_sign",              /* S/MIME sign parameters */
 343      0,                         /* Check time */
 344      0,                         /* internal flags */
 345      0,                         /* flags */
 346      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 347      X509_TRUST_EMAIL,          /* trust */
 348      -1,                        /* depth */
 349      NULL                       /* policies */
 350      },
 351     {
 352      "ssl_client",              /* SSL/TLS client parameters */
 353      0,                         /* Check time */
 354      0,                         /* internal flags */
 355      0,                         /* flags */
 356      X509_PURPOSE_SSL_CLIENT,   /* purpose */
 357      X509_TRUST_SSL_CLIENT,     /* trust */
 358      -1,                        /* depth */
 359      NULL                       /* policies */
 360      },
 361     {
 362      "ssl_server",              /* SSL/TLS server parameters */
 363      0,                         /* Check time */
 364      0,                         /* internal flags */
 365      0,                         /* flags */
 366      X509_PURPOSE_SSL_SERVER,   /* purpose */
 367      X509_TRUST_SSL_SERVER,     /* trust */
 368      -1,                        /* depth */
 369      NULL                       /* policies */
 370      }
 371 };
 372
 373 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
 374
 375 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
 376 {
 377     return strcmp(a->name, b->name);
 378 }
 379
 380 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 381 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 382
 383 static int param_cmp(const X509_VERIFY_PARAM *const *a,
 384                      const X509_VERIFY_PARAM *const *b)
 385 {
 386     return strcmp((*a)->name, (*b)->name);
 387 }
 388
 389 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
 390 {
 391     int idx;
 392     X509_VERIFY_PARAM *ptmp;
 393     if (!param_table) {
 394         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
 395         if (!param_table)
 396             return 0;
 397     } else {
 398         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
 399         if (idx != -1) {
 400             ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
 401             X509_VERIFY_PARAM_free(ptmp);
 402             (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
 403         }
 404     }
 405     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
 406         return 0;
 407     return 1;
 408 }
 409
 410 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
 411 {
 412     int idx;
 413     X509_VERIFY_PARAM pm;
 414
 415     pm.name = (char *)name;
 416     if (param_table) {
 417         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
 418         if (idx != -1)
 419             return sk_X509_VERIFY_PARAM_value(param_table, idx);
 420     }
 421     return OBJ_bsearch_table(&pm, default_table,
 422                              sizeof(default_table) /
 423                              sizeof(X509_VERIFY_PARAM));
 424 }
 425
 426 void X509_VERIFY_PARAM_table_cleanup(void)
 427 {
 428     if (param_table)
 429         sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
 430     param_table = NULL;
 431 }