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     if (param == NULL)
 104         return;
 105     x509_verify_param_zero(param);
 106     OPENSSL_free(param);
 107 }
 108
 109 /*-
 110  * This function determines how parameters are "inherited" from one structure
 111  * to another. There are several different ways this can happen.
 112  *
 113  * 1. If a child structure needs to have its values initialized from a parent
 114  *    they are simply copied across. For example SSL_CTX copied to SSL.
 115  * 2. If the structure should take on values only if they are currently unset.
 116  *    For example the values in an SSL structure will take appropriate value
 117  *    for SSL servers or clients but only if the application has not set new
 118  *    ones.
 119  *
 120  * The "inh_flags" field determines how this function behaves.
 121  *
 122  * Normally any values which are set in the default are not copied from the
 123  * destination and verify flags are ORed together.
 124  *
 125  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
 126  * to the destination. Effectively the values in "to" become default values
 127  * which will be used only if nothing new is set in "from".
 128  *
 129  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
 130  * they are set or not. Flags is still Ored though.
 131  *
 132  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
 133  * of ORed.
 134  *
 135  * If X509_VP_FLAG_LOCKED is set then no values are copied.
 136  *
 137  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
 138  * after the next call.
 139  */
 140
 141 /* Macro to test if a field should be copied from src to dest */
 142
 143 #define test_x509_verify_param_copy(field, def) \
 144         (to_overwrite || \
 145                 ((src->field != def) && (to_default || (dest->field == def))))
 146
 147 /* Macro to test and copy a field if necessary */
 148
 149 #define x509_verify_param_copy(field, def) \
 150         if (test_x509_verify_param_copy(field, def)) \
 151                 dest->field = src->field
 152
 153 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
 154                               const X509_VERIFY_PARAM *src)
 155 {
 156     unsigned long inh_flags;
 157     int to_default, to_overwrite;
 158     if (!src)
 159         return 1;
 160     inh_flags = dest->inh_flags | src->inh_flags;
 161
 162     if (inh_flags & X509_VP_FLAG_ONCE)
 163         dest->inh_flags = 0;
 164
 165     if (inh_flags & X509_VP_FLAG_LOCKED)
 166         return 1;
 167
 168     if (inh_flags & X509_VP_FLAG_DEFAULT)
 169         to_default = 1;
 170     else
 171         to_default = 0;
 172
 173     if (inh_flags & X509_VP_FLAG_OVERWRITE)
 174         to_overwrite = 1;
 175     else
 176         to_overwrite = 0;
 177
 178     x509_verify_param_copy(purpose, 0);
 179     x509_verify_param_copy(trust, 0);
 180     x509_verify_param_copy(depth, -1);
 181
 182     /* If overwrite or check time not set, copy across */
 183
 184     if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
 185         dest->check_time = src->check_time;
 186         dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
 187         /* Don't need to copy flag: that is done below */
 188     }
 189
 190     if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
 191         dest->flags = 0;
 192
 193     dest->flags |= src->flags;
 194
 195     if (test_x509_verify_param_copy(policies, NULL)) {
 196         if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
 197             return 0;
 198     }
 199
 200     return 1;
 201 }
 202
 203 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
 204                            const X509_VERIFY_PARAM *from)
 205 {
 206     unsigned long save_flags = to->inh_flags;
 207     int ret;
 208     to->inh_flags |= X509_VP_FLAG_DEFAULT;
 209     ret = X509_VERIFY_PARAM_inherit(to, from);
 210     to->inh_flags = save_flags;
 211     return ret;
 212 }
 213
 214 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
 215 {
 216     if (param->name)
 217         OPENSSL_free(param->name);
 218     param->name = BUF_strdup(name);
 219     if (param->name)
 220         return 1;
 221     return 0;
 222 }
 223
 224 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
 225 {
 226     param->flags |= flags;
 227     if (flags & X509_V_FLAG_POLICY_MASK)
 228         param->flags |= X509_V_FLAG_POLICY_CHECK;
 229     return 1;
 230 }
 231
 232 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
 233                                   unsigned long flags)
 234 {
 235     param->flags &= ~flags;
 236     return 1;
 237 }
 238
 239 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
 240 {
 241     return param->flags;
 242 }
 243
 244 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
 245 {
 246     return X509_PURPOSE_set(&param->purpose, purpose);
 247 }
 248
 249 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
 250 {
 251     return X509_TRUST_set(&param->trust, trust);
 252 }
 253
 254 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
 255 {
 256     param->depth = depth;
 257 }
 258
 259 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
 260 {
 261     param->check_time = t;
 262     param->flags |= X509_V_FLAG_USE_CHECK_TIME;
 263 }
 264
 265 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
 266                                   ASN1_OBJECT *policy)
 267 {
 268     if (!param->policies) {
 269         param->policies = sk_ASN1_OBJECT_new_null();
 270         if (!param->policies)
 271             return 0;
 272     }
 273     if (!sk_ASN1_OBJECT_push(param->policies, policy))
 274         return 0;
 275     return 1;
 276 }
 277
 278 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
 279                                     STACK_OF(ASN1_OBJECT) *policies)
 280 {
 281     int i;
 282     ASN1_OBJECT *oid, *doid;
 283     if (!param)
 284         return 0;
 285     if (param->policies)
 286         sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
 287
 288     if (!policies) {
 289         param->policies = NULL;
 290         return 1;
 291     }
 292
 293     param->policies = sk_ASN1_OBJECT_new_null();
 294     if (!param->policies)
 295         return 0;
 296
 297     for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
 298         oid = sk_ASN1_OBJECT_value(policies, i);
 299         doid = OBJ_dup(oid);
 300         if (!doid)
 301             return 0;
 302         if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
 303             ASN1_OBJECT_free(doid);
 304             return 0;
 305         }
 306     }
 307     param->flags |= X509_V_FLAG_POLICY_CHECK;
 308     return 1;
 309 }
 310
 311 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
 312 {
 313     return param->depth;
 314 }
 315
 316 /*
 317  * Default verify parameters: these are used for various applications and can
 318  * be overridden by the user specified table. NB: the 'name' field *must* be
 319  * in alphabetical order because it will be searched using OBJ_search.
 320  */
 321
 322 static const X509_VERIFY_PARAM default_table[] = {
 323     {
 324      "default",                 /* X509 default parameters */
 325      0,                         /* Check time */
 326      0,                         /* internal flags */
 327      0,                         /* flags */
 328      0,                         /* purpose */
 329      0,                         /* trust */
 330      100,                       /* depth */
 331      NULL                       /* policies */
 332      },
 333     {
 334      "pkcs7",                   /* S/MIME sign parameters */
 335      0,                         /* Check time */
 336      0,                         /* internal flags */
 337      0,                         /* flags */
 338      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 339      X509_TRUST_EMAIL,          /* trust */
 340      -1,                        /* depth */
 341      NULL                       /* policies */
 342      },
 343     {
 344      "smime_sign",              /* S/MIME sign parameters */
 345      0,                         /* Check time */
 346      0,                         /* internal flags */
 347      0,                         /* flags */
 348      X509_PURPOSE_SMIME_SIGN,   /* purpose */
 349      X509_TRUST_EMAIL,          /* trust */
 350      -1,                        /* depth */
 351      NULL                       /* policies */
 352      },
 353     {
 354      "ssl_client",              /* SSL/TLS client parameters */
 355      0,                         /* Check time */
 356      0,                         /* internal flags */
 357      0,                         /* flags */
 358      X509_PURPOSE_SSL_CLIENT,   /* purpose */
 359      X509_TRUST_SSL_CLIENT,     /* trust */
 360      -1,                        /* depth */
 361      NULL                       /* policies */
 362      },
 363     {
 364      "ssl_server",              /* SSL/TLS server parameters */
 365      0,                         /* Check time */
 366      0,                         /* internal flags */
 367      0,                         /* flags */
 368      X509_PURPOSE_SSL_SERVER,   /* purpose */
 369      X509_TRUST_SSL_SERVER,     /* trust */
 370      -1,                        /* depth */
 371      NULL                       /* policies */
 372      }
 373 };
 374
 375 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
 376
 377 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
 378 {
 379     return strcmp(a->name, b->name);
 380 }
 381
 382 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 383 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
 384
 385 static int param_cmp(const X509_VERIFY_PARAM *const *a,
 386                      const X509_VERIFY_PARAM *const *b)
 387 {
 388     return strcmp((*a)->name, (*b)->name);
 389 }
 390
 391 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
 392 {
 393     int idx;
 394     X509_VERIFY_PARAM *ptmp;
 395     if (!param_table) {
 396         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
 397         if (!param_table)
 398             return 0;
 399     } else {
 400         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
 401         if (idx != -1) {
 402             ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
 403             X509_VERIFY_PARAM_free(ptmp);
 404             (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
 405         }
 406     }
 407     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
 408         return 0;
 409     return 1;
 410 }
 411
 412 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
 413 {
 414     int idx;
 415     X509_VERIFY_PARAM pm;
 416
 417     pm.name = (char *)name;
 418     if (param_table) {
 419         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
 420         if (idx != -1)
 421             return sk_X509_VERIFY_PARAM_value(param_table, idx);
 422     }
 423     return OBJ_bsearch_table(&pm, default_table,
 424                              sizeof(default_table) /
 425                              sizeof(X509_VERIFY_PARAM));
 426 }
 427
 428 void X509_VERIFY_PARAM_table_cleanup(void)
 429 {
 430     if (param_table)
 431         sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
 432     param_table = NULL;
 433 }