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 #include "vpm_int.h"
  69
  70 /* X509_VERIFY_PARAM functions */
  71
  72 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
  73         {
  74         X509_VERIFY_PARAM_ID *paramid;
  75         if (!param)
  76                 return;
  77         param->name = NULL;
  78         param->purpose = 0;
  79         param->trust = 0;
  80         /*param->inh_flags = X509_VP_FLAG_DEFAULT;*/
  81         param->inh_flags = 0;
  82         param->flags = 0;
  83         param->depth = -1;
  84         if (param->policies)
  85                 {
  86                 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
  87                 param->policies = NULL;
  88                 }
  89         paramid = param->id;
  90         if (paramid->host)
  91                 {
  92                 OPENSSL_free(paramid->host);
  93                 paramid->host = NULL;
  94                 paramid->hostlen = 0;
  95                 }
  96         if (paramid->email)
  97                 {
  98                 OPENSSL_free(paramid->email);
  99                 paramid->email = NULL;
 100                 paramid->emaillen = 0;
 101                 }
 102         if (paramid->ip)
 103                 {
 104                 OPENSSL_free(paramid->ip);
 105                 paramid->ip = NULL;
 106                 paramid->iplen = 0;
 107                 }
 108
 109         }
 110
 111 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
 112         {
 113         X509_VERIFY_PARAM *param;
 114         X509_VERIFY_PARAM_ID *paramid;
 115         param = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
 116         if (!param)
 117                 return NULL;
 118         paramid = OPENSSL_malloc(sizeof(X509_VERIFY_PARAM));
 119         if (!paramid)
 120                 {
 121                 OPENSSL_free(param);
 122                 return NULL;
 123                 }
 124         memset(param, 0, sizeof(X509_VERIFY_PARAM));
 125         memset(paramid, 0, sizeof(X509_VERIFY_PARAM_ID));
 126         param->id = paramid;
 127         x509_verify_param_zero(param);
 128         return param;
 129         }
 130
 131 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
 132         {
 133         x509_verify_param_zero(param);
 134         OPENSSL_free(param->id);
 135         OPENSSL_free(param);
 136         }
 137
 138 /* This function determines how parameters are "inherited" from one structure
 139  * to another. There are several different ways this can happen.
 140  *
 141  * 1. If a child structure needs to have its values initialized from a parent
 142  *    they are simply copied across. For example SSL_CTX copied to SSL.
 143  * 2. If the structure should take on values only if they are currently unset.
 144  *    For example the values in an SSL structure will take appropriate value
 145  *    for SSL servers or clients but only if the application has not set new
 146  *    ones.
 147  *
 148  * The "inh_flags" field determines how this function behaves.
 149  *
 150  * Normally any values which are set in the default are not copied from the
 151  * destination and verify flags are ORed together.
 152  *
 153  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
 154  * to the destination. Effectively the values in "to" become default values
 155  * which will be used only if nothing new is set in "from".
 156  *
 157  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
 158  * they are set or not. Flags is still Ored though.
 159  *
 160  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
 161  * of ORed.
 162  *
 163  * If X509_VP_FLAG_LOCKED is set then no values are copied.
 164  *
 165  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
 166  * after the next call.
 167  */
 168
 169 /* Macro to test if a field should be copied from src to dest */
 170
 171 #define test_x509_verify_param_copy(field, def) \
 172         (to_overwrite || \
 173                 ((src->field != def) && (to_default || (dest->field == def))))
 174
 175 /* As above but for ID fields */
 176
 177 #define test_x509_verify_param_copy_id(idf, def) \
 178         test_x509_verify_param_copy(id->idf, def)
 179
 180 /* Macro to test and copy a field if necessary */
 181
 182 #define x509_verify_param_copy(field, def) \
 183         if (test_x509_verify_param_copy(field, def)) \
 184                 dest->field = src->field
 185
 186
 187 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
 188                                                 const X509_VERIFY_PARAM *src)
 189         {
 190         unsigned long inh_flags;
 191         int to_default, to_overwrite;
 192         X509_VERIFY_PARAM_ID *id;
 193         if (!src)
 194                 return 1;
 195         id = src->id;
 196         inh_flags = dest->inh_flags | src->inh_flags;
 197
 198         if (inh_flags & X509_VP_FLAG_ONCE)
 199                 dest->inh_flags = 0;
 200
 201         if (inh_flags & X509_VP_FLAG_LOCKED)
 202                 return 1;
 203
 204         if (inh_flags & X509_VP_FLAG_DEFAULT)
 205                 to_default = 1;
 206         else
 207                 to_default = 0;
 208
 209         if (inh_flags & X509_VP_FLAG_OVERWRITE)
 210                 to_overwrite = 1;
 211         else
 212                 to_overwrite = 0;
 213
 214         x509_verify_param_copy(purpose, 0);
 215         x509_verify_param_copy(trust, 0);
 216         x509_verify_param_copy(depth, -1);
 217
 218         /* If overwrite or check time not set, copy across */
 219
 220         if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME))
 221                 {
 222                 dest->check_time = src->check_time;
 223                 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
 224                 /* Don't need to copy flag: that is done below */
 225                 }
 226
 227         if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
 228                 dest->flags = 0;
 229
 230         dest->flags |= src->flags;
 231
 232         if (test_x509_verify_param_copy(policies, NULL))
 233                 {
 234                 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
 235                         return 0;
 236                 }
 237
 238         if (test_x509_verify_param_copy_id(host, NULL))
 239                 {
 240                 if (!X509_VERIFY_PARAM_set1_host(dest, id->host, id->hostlen))
 241                         return 0;
 242                 }
 243
 244         if (test_x509_verify_param_copy_id(email, NULL))
 245                 {
 246                 if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
 247                         return 0;
 248                 }
 249
 250         if (test_x509_verify_param_copy_id(ip, NULL))
 251                 {
 252                 if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
 253                         return 0;
 254                 }
 255
 256         return 1;
 257         }
 258
 259 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
 260                                                 const X509_VERIFY_PARAM *from)
 261         {
 262         unsigned long save_flags = to->inh_flags;
 263         int ret;
 264         to->inh_flags |= X509_VP_FLAG_DEFAULT;
 265         ret = X509_VERIFY_PARAM_inherit(to, from);
 266         to->inh_flags = save_flags;
 267         return ret;
 268         }
 269
 270 static int int_x509_param_set1(unsigned char **pdest, size_t *pdestlen,
 271                                 const unsigned char *src, size_t srclen)
 272         {
 273         void *tmp;
 274         if (src)
 275                 {
 276                 if (srclen == 0)
 277                         {
 278                         tmp = BUF_strdup((char *)src);
 279                         srclen = strlen((char *)src);
 280                         }
 281                 else
 282                         tmp = BUF_memdup(src, srclen);
 283                 if (!tmp)
 284                         return 0;
 285                 }
 286         else
 287                 {
 288                 tmp = NULL;
 289                 srclen = 0;
 290                 }
 291         if (*pdest)
 292                 OPENSSL_free(*pdest);
 293         *pdest = tmp;
 294         if (pdestlen)
 295                 *pdestlen = srclen;
 296         return 1;
 297         }
 298
 299 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
 300         {
 301         if (param->name)
 302                 OPENSSL_free(param->name);
 303         param->name = BUF_strdup(name);
 304         if (param->name)
 305                 return 1;
 306         return 0;
 307         }
 308
 309 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
 310         {
 311         param->flags |= flags;
 312         if (flags & X509_V_FLAG_POLICY_MASK)
 313                 param->flags |= X509_V_FLAG_POLICY_CHECK;
 314         return 1;
 315         }
 316
 317 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param, unsigned long flags)
 318         {
 319         param->flags &= ~flags;
 320         return 1;
 321         }
 322
 323 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
 324         {
 325         return param->flags;
 326         }
 327
 328 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
 329         {
 330         return X509_PURPOSE_set(&param->purpose, purpose);
 331         }
 332
 333 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
 334         {
 335         return X509_TRUST_set(&param->trust, trust);
 336         }
 337
 338 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
 339         {
 340         param->depth = depth;
 341         }
 342
 343 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
 344         {
 345         param->check_time = t;
 346         param->flags |= X509_V_FLAG_USE_CHECK_TIME;
 347         }
 348
 349 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param, ASN1_OBJECT *policy)
 350         {
 351         if (!param->policies)
 352                 {
 353                 param->policies = sk_ASN1_OBJECT_new_null();
 354                 if (!param->policies)
 355                         return 0;
 356                 }
 357         if (!sk_ASN1_OBJECT_push(param->policies, policy))
 358                 return 0;
 359         return 1;
 360         }
 361
 362 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
 363                                         STACK_OF(ASN1_OBJECT) *policies)
 364         {
 365         int i;
 366         ASN1_OBJECT *oid, *doid;
 367         if (!param)
 368                 return 0;
 369         if (param->policies)
 370                 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
 371
 372         if (!policies)
 373                 {
 374                 param->policies = NULL;
 375                 return 1;
 376                 }
 377
 378         param->policies = sk_ASN1_OBJECT_new_null();
 379         if (!param->policies)
 380                 return 0;
 381
 382         for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++)
 383                 {
 384                 oid = sk_ASN1_OBJECT_value(policies, i);
 385                 doid = OBJ_dup(oid);
 386                 if (!doid)
 387                         return 0;
 388                 if (!sk_ASN1_OBJECT_push(param->policies, doid))
 389                         {
 390                         ASN1_OBJECT_free(doid);
 391                         return 0;
 392                         }
 393                 }
 394         param->flags |= X509_V_FLAG_POLICY_CHECK;
 395         return 1;
 396         }
 397
 398 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
 399                                 const unsigned char *name, size_t namelen)
 400         {
 401         return int_x509_param_set1(&param->id->host, &param->id->hostlen,
 402                                         name, namelen);
 403         }
 404
 405 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
 406                                 const unsigned char *email, size_t emaillen)
 407         {
 408         return int_x509_param_set1(&param->id->email, &param->id->emaillen,
 409                                         email, emaillen);
 410         }
 411
 412 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
 413                                         const unsigned char *ip, size_t iplen)
 414         {
 415         if (iplen != 0 && iplen != 4 && iplen != 16)
 416                 return 0;
 417         return int_x509_param_set1(&param->id->ip, &param->id->iplen, ip, iplen);
 418         }
 419
 420 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
 421         {
 422         unsigned char ipout[16];
 423         int iplen;
 424         iplen = a2i_ipadd(ipout, ipasc);
 425         if (iplen == 0)
 426                 return 0;
 427         return X509_VERIFY_PARAM_set1_ip(param, ipout, (size_t)iplen);
 428         }
 429
 430 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
 431         {
 432         return param->depth;
 433         }
 434
 435 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
 436         {
 437         return param->name;
 438         }
 439
 440 static X509_VERIFY_PARAM_ID _empty_id = {NULL, 0, NULL, 0, NULL, 0};
 441
 442 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
 443
 444
 445 /* Default verify parameters: these are used for various
 446  * applications and can be overridden by the user specified table.
 447  * NB: the 'name' field *must* be in alphabetical order because it
 448  * will be searched using OBJ_search.
 449  */
 450
 451 static const X509_VERIFY_PARAM default_table[] = {
 452         {
 453         "default",      /* X509 default parameters */
 454         0,              /* Check time */
 455         0,              /* internal flags */
 456         0,              /* flags */
 457         0,              /* purpose */
 458         0,              /* trust */
 459         100,            /* depth */
 460         NULL,           /* policies */
 461         vpm_empty_id
 462         },
 463         {
 464         "pkcs7",                        /* S/MIME sign parameters */
 465         0,                              /* Check time */
 466         0,                              /* internal flags */
 467         0,                              /* flags */
 468         X509_PURPOSE_SMIME_SIGN,        /* purpose */
 469         X509_TRUST_EMAIL,               /* trust */
 470         -1,                             /* depth */
 471         NULL,                           /* policies */
 472         vpm_empty_id
 473         },
 474         {
 475         "smime_sign",                   /* S/MIME sign parameters */
 476         0,                              /* Check time */
 477         0,                              /* internal flags */
 478         0,                              /* flags */
 479         X509_PURPOSE_SMIME_SIGN,        /* purpose */
 480         X509_TRUST_EMAIL,               /* trust */
 481         -1,                             /* depth */
 482         NULL,                           /* policies */
 483         vpm_empty_id
 484         },
 485         {
 486         "ssl_client",                   /* SSL/TLS client parameters */
 487         0,                              /* Check time */
 488         0,                              /* internal flags */
 489         0,                              /* flags */
 490         X509_PURPOSE_SSL_CLIENT,        /* purpose */
 491         X509_TRUST_SSL_CLIENT,          /* trust */
 492         -1,                             /* depth */
 493         NULL,                           /* policies */
 494         vpm_empty_id
 495         },
 496         {
 497         "ssl_server",                   /* SSL/TLS server parameters */
 498         0,                              /* Check time */
 499         0,                              /* internal flags */
 500         0,                              /* flags */
 501         X509_PURPOSE_SSL_SERVER,        /* purpose */
 502         X509_TRUST_SSL_SERVER,          /* trust */
 503         -1,                             /* depth */
 504         NULL,                           /* policies */
 505         vpm_empty_id
 506         }};
 507
 508 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
 509
 510 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
 511
 512         {
 513         return strcmp(a->name, b->name);
 514         }
 515
 516 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM,
 517                            table);
 518 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM,
 519                              table);
 520
 521 static int param_cmp(const X509_VERIFY_PARAM * const *a,
 522                         const X509_VERIFY_PARAM * const *b)
 523         {
 524         return strcmp((*a)->name, (*b)->name);
 525         }
 526
 527 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
 528         {
 529         int idx;
 530         X509_VERIFY_PARAM *ptmp;
 531         if (!param_table)
 532                 {
 533                 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
 534                 if (!param_table)
 535                         return 0;
 536                 }
 537         else
 538                 {
 539                 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
 540                 if (idx != -1)
 541                         {
 542                         ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
 543                         X509_VERIFY_PARAM_free(ptmp);
 544                         (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
 545                         }
 546                 }
 547         if (!sk_X509_VERIFY_PARAM_push(param_table, param))
 548                 return 0;
 549         return 1;
 550         }
 551
 552 int X509_VERIFY_PARAM_get_count(void)
 553         {
 554         int num = sizeof(default_table)/sizeof(X509_VERIFY_PARAM);
 555         if (param_table)
 556                 num += sk_X509_VERIFY_PARAM_num(param_table);
 557         return num;
 558         }
 559
 560 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
 561         {
 562         int num = sizeof(default_table)/sizeof(X509_VERIFY_PARAM);
 563         if (id < num)
 564                 return default_table + id;
 565         return sk_X509_VERIFY_PARAM_value(param_table, id - num);
 566         }
 567
 568 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
 569         {
 570         int idx;
 571         X509_VERIFY_PARAM pm;
 572
 573         pm.name = (char *)name;
 574         if (param_table)
 575                 {
 576                 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
 577                 if (idx != -1)
 578                         return sk_X509_VERIFY_PARAM_value(param_table, idx);
 579                 }
 580         return OBJ_bsearch_table(&pm, default_table,
 581                            sizeof(default_table)/sizeof(X509_VERIFY_PARAM));
 582         }
 583
 584 void X509_VERIFY_PARAM_table_cleanup(void)
 585         {
 586         if (param_table)
 587                 sk_X509_VERIFY_PARAM_pop_free(param_table,
 588                                                 X509_VERIFY_PARAM_free);
 589         param_table = NULL;
 590         }