crypto/x509/x509_vpm.c

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