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