1 /* x509_vpm.c */ 2 /* 3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project 4 * 2004. 5 */ 6 /* ==================================================================== 7 * Copyright (c) 2004 The OpenSSL Project. All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. All advertising materials mentioning features or use of this 22 * software must display the following acknowledgment: 23 * "This product includes software developed by the OpenSSL Project 24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 25 * 26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 27 * endorse or promote products derived from this software without 28 * prior written permission. For written permission, please contact 29 * licensing@OpenSSL.org. 30 * 31 * 5. Products derived from this software may not be called "OpenSSL" 32 * nor may "OpenSSL" appear in their names without prior written 33 * permission of the OpenSSL Project. 34 * 35 * 6. Redistributions of any form whatsoever must retain the following 36 * acknowledgment: 37 * "This product includes software developed by the OpenSSL Project 38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 39 * 40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 51 * OF THE POSSIBILITY OF SUCH DAMAGE. 52 * ==================================================================== 53 * 54 * This product includes cryptographic software written by Eric Young 55 * (eay@cryptsoft.com). This product includes software written by Tim 56 * Hudson (tjh@cryptsoft.com). 57 * 58 */ 59 60 #include <stdio.h> 61 62 #include "cryptlib.h" 63 #include <openssl/crypto.h> 64 #include <openssl/lhash.h> 65 #include <openssl/buffer.h> 66 #include <openssl/x509.h> 67 #include <openssl/x509v3.h> 68 69 #include "vpm_int.h" 70 71 /* X509_VERIFY_PARAM functions */ 72 73 #define SET_HOST 0 74 #define ADD_HOST 1 75 76 static char *str_copy(const char *s) 77 { 78 return OPENSSL_strdup(s); 79 } 80 81 static void str_free(char *s) 82 { 83 OPENSSL_free(s); 84 } 85 86 #define string_stack_free(sk) sk_OPENSSL_STRING_pop_free(sk, str_free) 87 88 static int int_x509_param_set_hosts(X509_VERIFY_PARAM_ID *id, int mode, 89 const char *name, size_t namelen) 90 { 91 char *copy; 92 93 /* 94 * Refuse names with embedded NUL bytes, except perhaps as final byte. 95 * XXX: Do we need to push an error onto the error stack? 96 */ 97 if (namelen == 0 || name == NULL) 98 namelen = name ? strlen(name) : 0; 99 else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen)) 100 return 0; 101 if (namelen > 0 && name[namelen - 1] == '\0') 102 --namelen; 103 104 if (mode == SET_HOST && id->hosts) { 105 string_stack_free(id->hosts); 106 id->hosts = NULL; 107 } 108 if (name == NULL || namelen == 0) 109 return 1; 110 111 copy = BUF_strndup(name, namelen); 112 if (copy == NULL) 113 return 0; 114 115 if (id->hosts == NULL && 116 (id->hosts = sk_OPENSSL_STRING_new_null()) == NULL) { 117 OPENSSL_free(copy); 118 return 0; 119 } 120 121 if (!sk_OPENSSL_STRING_push(id->hosts, copy)) { 122 OPENSSL_free(copy); 123 if (sk_OPENSSL_STRING_num(id->hosts) == 0) { 124 sk_OPENSSL_STRING_free(id->hosts); 125 id->hosts = NULL; 126 } 127 return 0; 128 } 129 130 return 1; 131 } 132 133 static void x509_verify_param_zero(X509_VERIFY_PARAM *param) 134 { 135 X509_VERIFY_PARAM_ID *paramid; 136 if (!param) 137 return; 138 param->name = NULL; 139 param->purpose = 0; 140 param->trust = 0; 141 /* 142 * param->inh_flags = X509_VP_FLAG_DEFAULT; 143 */ 144 param->inh_flags = 0; 145 param->flags = 0; 146 param->depth = -1; 147 if (param->policies) { 148 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free); 149 param->policies = NULL; 150 } 151 paramid = param->id; 152 if (paramid->hosts) { 153 string_stack_free(paramid->hosts); 154 paramid->hosts = NULL; 155 } 156 if (paramid->peername) 157 OPENSSL_free(paramid->peername); 158 paramid->peername = NULL; 159 if (paramid->email) { 160 OPENSSL_free(paramid->email); 161 paramid->email = NULL; 162 paramid->emaillen = 0; 163 } 164 if (paramid->ip) { 165 OPENSSL_free(paramid->ip); 166 paramid->ip = NULL; 167 paramid->iplen = 0; 168 } 169 } 170 171 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void) 172 { 173 X509_VERIFY_PARAM *param; 174 X509_VERIFY_PARAM_ID *paramid; 175 176 param = OPENSSL_malloc(sizeof *param); 177 if (!param) 178 return NULL; 179 memset(param, 0, sizeof(*param)); 180 181 paramid = OPENSSL_malloc(sizeof(*paramid)); 182 if (!paramid) { 183 OPENSSL_free(param); 184 return NULL; 185 } 186 memset(paramid, 0, sizeof(*paramid)); 187 /* Exotic platforms may have non-zero bit representation of NULL */ 188 paramid->hosts = NULL; 189 paramid->peername = NULL; 190 paramid->email = NULL; 191 paramid->ip = NULL; 192 193 param->id = paramid; 194 x509_verify_param_zero(param); 195 return param; 196 } 197 198 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param) 199 { 200 if (param == NULL) 201 return; 202 x509_verify_param_zero(param); 203 OPENSSL_free(param->id); 204 OPENSSL_free(param); 205 } 206 207 /*- 208 * This function determines how parameters are "inherited" from one structure 209 * to another. There are several different ways this can happen. 210 * 211 * 1. If a child structure needs to have its values initialized from a parent 212 * they are simply copied across. For example SSL_CTX copied to SSL. 213 * 2. If the structure should take on values only if they are currently unset. 214 * For example the values in an SSL structure will take appropriate value 215 * for SSL servers or clients but only if the application has not set new 216 * ones. 217 * 218 * The "inh_flags" field determines how this function behaves. 219 * 220 * Normally any values which are set in the default are not copied from the 221 * destination and verify flags are ORed together. 222 * 223 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied 224 * to the destination. Effectively the values in "to" become default values 225 * which will be used only if nothing new is set in "from". 226 * 227 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether 228 * they are set or not. Flags is still Ored though. 229 * 230 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead 231 * of ORed. 232 * 233 * If X509_VP_FLAG_LOCKED is set then no values are copied. 234 * 235 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed 236 * after the next call. 237 */ 238 239 /* Macro to test if a field should be copied from src to dest */ 240 241 #define test_x509_verify_param_copy(field, def) \ 242 (to_overwrite || \ 243 ((src->field != def) && (to_default || (dest->field == def)))) 244 245 /* As above but for ID fields */ 246 247 #define test_x509_verify_param_copy_id(idf, def) \ 248 test_x509_verify_param_copy(id->idf, def) 249 250 /* Macro to test and copy a field if necessary */ 251 252 #define x509_verify_param_copy(field, def) \ 253 if (test_x509_verify_param_copy(field, def)) \ 254 dest->field = src->field 255 256 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest, 257 const X509_VERIFY_PARAM *src) 258 { 259 unsigned long inh_flags; 260 int to_default, to_overwrite; 261 X509_VERIFY_PARAM_ID *id; 262 if (!src) 263 return 1; 264 id = src->id; 265 inh_flags = dest->inh_flags | src->inh_flags; 266 267 if (inh_flags & X509_VP_FLAG_ONCE) 268 dest->inh_flags = 0; 269 270 if (inh_flags & X509_VP_FLAG_LOCKED) 271 return 1; 272 273 if (inh_flags & X509_VP_FLAG_DEFAULT) 274 to_default = 1; 275 else 276 to_default = 0; 277 278 if (inh_flags & X509_VP_FLAG_OVERWRITE) 279 to_overwrite = 1; 280 else 281 to_overwrite = 0; 282 283 x509_verify_param_copy(purpose, 0); 284 x509_verify_param_copy(trust, 0); 285 x509_verify_param_copy(depth, -1); 286 287 /* If overwrite or check time not set, copy across */ 288 289 if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) { 290 dest->check_time = src->check_time; 291 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME; 292 /* Don't need to copy flag: that is done below */ 293 } 294 295 if (inh_flags & X509_VP_FLAG_RESET_FLAGS) 296 dest->flags = 0; 297 298 dest->flags |= src->flags; 299 300 if (test_x509_verify_param_copy(policies, NULL)) { 301 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies)) 302 return 0; 303 } 304 305 /* Copy the host flags if and only if we're copying the host list */ 306 if (test_x509_verify_param_copy_id(hosts, NULL)) { 307 if (dest->id->hosts) { 308 string_stack_free(dest->id->hosts); 309 dest->id->hosts = NULL; 310 } 311 if (id->hosts) { 312 dest->id->hosts = 313 sk_OPENSSL_STRING_deep_copy(id->hosts, str_copy, str_free); 314 if (dest->id->hosts == NULL) 315 return 0; 316 dest->id->hostflags = id->hostflags; 317 } 318 } 319 320 if (test_x509_verify_param_copy_id(email, NULL)) { 321 if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen)) 322 return 0; 323 } 324 325 if (test_x509_verify_param_copy_id(ip, NULL)) { 326 if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen)) 327 return 0; 328 } 329 330 return 1; 331 } 332 333 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to, 334 const X509_VERIFY_PARAM *from) 335 { 336 unsigned long save_flags = to->inh_flags; 337 int ret; 338 to->inh_flags |= X509_VP_FLAG_DEFAULT; 339 ret = X509_VERIFY_PARAM_inherit(to, from); 340 to->inh_flags = save_flags; 341 return ret; 342 } 343 344 static int int_x509_param_set1(char **pdest, size_t *pdestlen, 345 const char *src, size_t srclen) 346 { 347 void *tmp; 348 if (src) { 349 if (srclen == 0) { 350 tmp = BUF_strdup(src); 351 srclen = strlen(src); 352 } else 353 tmp = BUF_memdup(src, srclen); 354 if (!tmp) 355 return 0; 356 } else { 357 tmp = NULL; 358 srclen = 0; 359 } 360 if (*pdest) 361 OPENSSL_free(*pdest); 362 *pdest = tmp; 363 if (pdestlen) 364 *pdestlen = srclen; 365 return 1; 366 } 367 368 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name) 369 { 370 if (param->name) 371 OPENSSL_free(param->name); 372 param->name = BUF_strdup(name); 373 if (param->name) 374 return 1; 375 return 0; 376 } 377 378 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags) 379 { 380 param->flags |= flags; 381 if (flags & X509_V_FLAG_POLICY_MASK) 382 param->flags |= X509_V_FLAG_POLICY_CHECK; 383 return 1; 384 } 385 386 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param, 387 unsigned long flags) 388 { 389 param->flags &= ~flags; 390 return 1; 391 } 392 393 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param) 394 { 395 return param->flags; 396 } 397 398 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose) 399 { 400 return X509_PURPOSE_set(¶m->purpose, purpose); 401 } 402 403 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust) 404 { 405 return X509_TRUST_set(¶m->trust, trust); 406 } 407 408 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth) 409 { 410 param->depth = depth; 411 } 412 413 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t) 414 { 415 param->check_time = t; 416 param->flags |= X509_V_FLAG_USE_CHECK_TIME; 417 } 418 419 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param, 420 ASN1_OBJECT *policy) 421 { 422 if (!param->policies) { 423 param->policies = sk_ASN1_OBJECT_new_null(); 424 if (!param->policies) 425 return 0; 426 } 427 if (!sk_ASN1_OBJECT_push(param->policies, policy)) 428 return 0; 429 return 1; 430 } 431 432 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param, 433 STACK_OF(ASN1_OBJECT) *policies) 434 { 435 int i; 436 ASN1_OBJECT *oid, *doid; 437 if (!param) 438 return 0; 439 if (param->policies) 440 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free); 441 442 if (!policies) { 443 param->policies = NULL; 444 return 1; 445 } 446 447 param->policies = sk_ASN1_OBJECT_new_null(); 448 if (!param->policies) 449 return 0; 450 451 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) { 452 oid = sk_ASN1_OBJECT_value(policies, i); 453 doid = OBJ_dup(oid); 454 if (!doid) 455 return 0; 456 if (!sk_ASN1_OBJECT_push(param->policies, doid)) { 457 ASN1_OBJECT_free(doid); 458 return 0; 459 } 460 } 461 param->flags |= X509_V_FLAG_POLICY_CHECK; 462 return 1; 463 } 464 465 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param, 466 const char *name, size_t namelen) 467 { 468 return int_x509_param_set_hosts(param->id, SET_HOST, name, namelen); 469 } 470 471 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param, 472 const char *name, size_t namelen) 473 { 474 return int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen); 475 } 476 477 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param, 478 unsigned int flags) 479 { 480 param->id->hostflags = flags; 481 } 482 483 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param) 484 { 485 return param->id->peername; 486 } 487 488 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param, 489 const char *email, size_t emaillen) 490 { 491 return int_x509_param_set1(¶m->id->email, ¶m->id->emaillen, 492 email, emaillen); 493 } 494 495 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param, 496 const unsigned char *ip, size_t iplen) 497 { 498 if (iplen != 0 && iplen != 4 && iplen != 16) 499 return 0; 500 return int_x509_param_set1((char **)¶m->id->ip, ¶m->id->iplen, 501 (char *)ip, iplen); 502 } 503 504 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc) 505 { 506 unsigned char ipout[16]; 507 size_t iplen; 508 509 iplen = (size_t)a2i_ipadd(ipout, ipasc); 510 if (iplen == 0) 511 return 0; 512 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen); 513 } 514 515 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param) 516 { 517 return param->depth; 518 } 519 520 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param) 521 { 522 return param->name; 523 } 524 525 static X509_VERIFY_PARAM_ID _empty_id = { NULL, 0U, NULL, NULL, 0, NULL, 0 }; 526 527 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id 528 529 /* 530 * Default verify parameters: these are used for various applications and can 531 * be overridden by the user specified table. NB: the 'name' field *must* be 532 * in alphabetical order because it will be searched using OBJ_search. 533 */ 534 535 static const X509_VERIFY_PARAM default_table[] = { 536 { 537 "default", /* X509 default parameters */ 538 0, /* Check time */ 539 0, /* internal flags */ 540 0, /* flags */ 541 0, /* purpose */ 542 0, /* trust */ 543 100, /* depth */ 544 NULL, /* policies */ 545 vpm_empty_id}, 546 { 547 "pkcs7", /* S/MIME sign parameters */ 548 0, /* Check time */ 549 0, /* internal flags */ 550 0, /* flags */ 551 X509_PURPOSE_SMIME_SIGN, /* purpose */ 552 X509_TRUST_EMAIL, /* trust */ 553 -1, /* depth */ 554 NULL, /* policies */ 555 vpm_empty_id}, 556 { 557 "smime_sign", /* S/MIME sign parameters */ 558 0, /* Check time */ 559 0, /* internal flags */ 560 0, /* flags */ 561 X509_PURPOSE_SMIME_SIGN, /* purpose */ 562 X509_TRUST_EMAIL, /* trust */ 563 -1, /* depth */ 564 NULL, /* policies */ 565 vpm_empty_id}, 566 { 567 "ssl_client", /* SSL/TLS client parameters */ 568 0, /* Check time */ 569 0, /* internal flags */ 570 0, /* flags */ 571 X509_PURPOSE_SSL_CLIENT, /* purpose */ 572 X509_TRUST_SSL_CLIENT, /* trust */ 573 -1, /* depth */ 574 NULL, /* policies */ 575 vpm_empty_id}, 576 { 577 "ssl_server", /* SSL/TLS server parameters */ 578 0, /* Check time */ 579 0, /* internal flags */ 580 0, /* flags */ 581 X509_PURPOSE_SSL_SERVER, /* purpose */ 582 X509_TRUST_SSL_SERVER, /* trust */ 583 -1, /* depth */ 584 NULL, /* policies */ 585 vpm_empty_id} 586 }; 587 588 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL; 589 590 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b) 591 { 592 return strcmp(a->name, b->name); 593 } 594 595 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table); 596 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table); 597 598 static int param_cmp(const X509_VERIFY_PARAM *const *a, 599 const X509_VERIFY_PARAM *const *b) 600 { 601 return strcmp((*a)->name, (*b)->name); 602 } 603 604 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param) 605 { 606 int idx; 607 X509_VERIFY_PARAM *ptmp; 608 if (!param_table) { 609 param_table = sk_X509_VERIFY_PARAM_new(param_cmp); 610 if (!param_table) 611 return 0; 612 } else { 613 idx = sk_X509_VERIFY_PARAM_find(param_table, param); 614 if (idx != -1) { 615 ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx); 616 X509_VERIFY_PARAM_free(ptmp); 617 (void)sk_X509_VERIFY_PARAM_delete(param_table, idx); 618 } 619 } 620 if (!sk_X509_VERIFY_PARAM_push(param_table, param)) 621 return 0; 622 return 1; 623 } 624 625 int X509_VERIFY_PARAM_get_count(void) 626 { 627 int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM); 628 if (param_table) 629 num += sk_X509_VERIFY_PARAM_num(param_table); 630 return num; 631 } 632 633 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id) 634 { 635 int num = sizeof(default_table) / sizeof(X509_VERIFY_PARAM); 636 if (id < num) 637 return default_table + id; 638 return sk_X509_VERIFY_PARAM_value(param_table, id - num); 639 } 640 641 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name) 642 { 643 int idx; 644 X509_VERIFY_PARAM pm; 645 646 pm.name = (char *)name; 647 if (param_table) { 648 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm); 649 if (idx != -1) 650 return sk_X509_VERIFY_PARAM_value(param_table, idx); 651 } 652 return OBJ_bsearch_table(&pm, default_table, 653 sizeof(default_table) / 654 sizeof(X509_VERIFY_PARAM)); 655 } 656 657 void X509_VERIFY_PARAM_table_cleanup(void) 658 { 659 if (param_table) 660 sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free); 661 param_table = NULL; 662 } 663