crypto/x509/x509_vpm.c

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