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         if (!param)
  93                 return NULL;
  94         memset(param, 0, sizeof(X509_VERIFY_PARAM));
  95         x509_verify_param_zero(param);
  96         return param;
  97         }
  98
  99 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
 100         {
 101         x509_verify_param_zero(param);
 102         OPENSSL_free(param);
 103         }
 104
 105 /* This function determines how parameters are "inherited" from one structure
 106  * to another. There are several different ways this can happen.
 107  *
 108  * 1. If a child structure needs to have its values initialized from a parent
 109  *    they are simply copied across. For example SSL_CTX copied to SSL.
 110  * 2. If the structure should take on values only if they are currently unset.
 111  *    For example the values in an SSL structure will take appropriate value
 112  *    for SSL servers or clients but only if the application has not set new
 113  *    ones.
 114  *
 115  * The "inh_flags" field determines how this function behaves.
 116  *
 117  * Normally any values which are set in the default are not copied from the
 118  * destination and verify flags are ORed together.
 119  *
 120  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
 121  * to the destination. Effectively the values in "to" become default values
 122  * which will be used only if nothing new is set in "from".
 123  *
 124  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
 125  * they are set or not. Flags is still Ored though.
 126  *
 127  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
 128  * of ORed.
 129  *
 130  * If X509_VP_FLAG_LOCKED is set then no values are copied.
 131  *
 132  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
 133  * after the next call.
 134  */
 135
 136 /* Macro to test if a field should be copied from src to dest */
 137
 138 #define test_x509_verify_param_copy(field, def) \
 139         (to_overwrite || \
 140                 ((src->field != def) && (to_default || (dest->field == def))))
 141
 142 /* Macro to test and copy a field if necessary */
 143
 144 #define x509_verify_param_copy(field, def) \
 145         if (test_x509_verify_param_copy(field, def)) \
 146                 dest->field = src->field
 147
 148
 149 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
 150                                                 const X509_VERIFY_PARAM *src)
 151         {
 152         unsigned long inh_flags;
 153         int to_default, to_overwrite;
 154         if (!src)
 155                 return 1;
 156         inh_flags = dest->inh_flags | src->inh_flags;
 157
 158         if (inh_flags & X509_VP_FLAG_ONCE)
 159                 dest->inh_flags = 0;
 160
 161         if (inh_flags & X509_VP_FLAG_LOCKED)
 162                 return 1;
 163
 164         if (inh_flags & X509_VP_FLAG_DEFAULT)
 165                 to_default = 1;
 166         else
 167                 to_default = 0;
 168
 169         if (inh_flags & X509_VP_FLAG_OVERWRITE)
 170                 to_overwrite = 1;
 171         else
 172                 to_overwrite = 0;
 173
 174         x509_verify_param_copy(purpose, 0);
 175         x509_verify_param_copy(trust, 0);
 176         x509_verify_param_copy(depth, -1);
 177
 178         /* If overwrite or check time not set, copy across */
 179
 180         if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME))
 181                 {
 182                 dest->check_time = src->check_time;
 183                 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
 184                 /* Don't need to copy flag: that is done below */
 185                 }
 186
 187         if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
 188                 dest->flags = 0;
 189
 190         dest->flags |= src->flags;
 191
 192         if (test_x509_verify_param_copy(policies, NULL))
 193                 {
 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, unsigned long flags)
 231         {
 232         param->flags &= ~flags;
 233         return 1;
 234         }
 235
 236 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
 237         {
 238         return param->flags;
 239         }
 240
 241 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
 242         {
 243         return X509_PURPOSE_set(&param->purpose, purpose);
 244         }
 245
 246 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
 247         {
 248         return X509_TRUST_set(&param->trust, trust);
 249         }
 250
 251 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
 252         {
 253         param->depth = depth;
 254         }
 255
 256 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
 257         {
 258         param->check_time = t;
 259         param->flags |= X509_V_FLAG_USE_CHECK_TIME;
 260         }
 261
 262 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param, ASN1_OBJECT *policy)
 263         {
 264         if (!param->policies)
 265                 {
 266                 param->policies = sk_ASN1_OBJECT_new_null();
 267                 if (!param->policies)
 268                         return 0;
 269                 }
 270         if (!sk_ASN1_OBJECT_push(param->policies, policy))
 271                 return 0;
 272         return 1;
 273         }
 274
 275 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
 276                                         STACK_OF(ASN1_OBJECT) *policies)
 277         {
 278         int i;
 279         ASN1_OBJECT *oid, *doid;
 280         if (!param)
 281                 return 0;
 282         if (param->policies)
 283                 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
 284
 285         if (!policies)
 286                 {
 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                 {
 297                 oid = sk_ASN1_OBJECT_value(policies, i);
 298                 doid = OBJ_dup(oid);
 299                 if (!doid)
 300                         return 0;
 301                 if (!sk_ASN1_OBJECT_push(param->policies, doid))
 302                         {
 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 /* Default verify parameters: these are used for various
 317  * applications and can be overridden by the user specified table.
 318  * NB: the 'name' field *must* be in alphabetical order because it
 319  * 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 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
 375
 376 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
 377
 378         {
 379         return strcmp(a->name, b->name);
 380         }
 381
 382 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM,
 383                            table);
 384 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM,
 385                              table);
 386
 387 static int param_cmp(const X509_VERIFY_PARAM * const *a,
 388                         const X509_VERIFY_PARAM * const *b)
 389         {
 390         return strcmp((*a)->name, (*b)->name);
 391         }
 392
 393 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
 394         {
 395         int idx;
 396         X509_VERIFY_PARAM *ptmp;
 397         if (!param_table)
 398                 {
 399                 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
 400                 if (!param_table)
 401                         return 0;
 402                 }
 403         else
 404                 {
 405                 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
 406                 if (idx != -1)
 407                         {
 408                         ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
 409                         X509_VERIFY_PARAM_free(ptmp);
 410                         (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
 411                         }
 412                 }
 413         if (!sk_X509_VERIFY_PARAM_push(param_table, param))
 414                 return 0;
 415         return 1;
 416         }
 417
 418 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
 419         {
 420         int idx;
 421         X509_VERIFY_PARAM pm;
 422
 423         pm.name = (char *)name;
 424         if (param_table)
 425                 {
 426                 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
 427                 if (idx != -1)
 428                         return sk_X509_VERIFY_PARAM_value(param_table, idx);
 429                 }
 430         return OBJ_bsearch_table(&pm, default_table,
 431                            sizeof(default_table)/sizeof(X509_VERIFY_PARAM));
 432         }
 433
 434 void X509_VERIFY_PARAM_table_cleanup(void)
 435         {
 436         if (param_table)
 437                 sk_X509_VERIFY_PARAM_pop_free(param_table,
 438                                                 X509_VERIFY_PARAM_free);
 439         param_table = NULL;
 440         }