crypto/x509/x509_lu.c

   1 /* crypto/x509/x509_lu.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 #include <stdio.h>
  60 #include "cryptlib.h"
  61 #include <openssl/lhash.h>
  62 #include <openssl/x509.h>
  63 #include <openssl/x509v3.h>
  64
  65 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method)
  66 {
  67     X509_LOOKUP *ret;
  68
  69     ret = (X509_LOOKUP *)OPENSSL_malloc(sizeof(X509_LOOKUP));
  70     if (ret == NULL)
  71         return NULL;
  72
  73     ret->init = 0;
  74     ret->skip = 0;
  75     ret->method = method;
  76     ret->method_data = NULL;
  77     ret->store_ctx = NULL;
  78     if ((method->new_item != NULL) && !method->new_item(ret)) {
  79         OPENSSL_free(ret);
  80         return NULL;
  81     }
  82     return ret;
  83 }
  84
  85 void X509_LOOKUP_free(X509_LOOKUP *ctx)
  86 {
  87     if (ctx == NULL)
  88         return;
  89     if ((ctx->method != NULL) && (ctx->method->free != NULL))
  90         ctx->method->free(ctx);
  91     OPENSSL_free(ctx);
  92 }
  93
  94 int X509_LOOKUP_init(X509_LOOKUP *ctx)
  95 {
  96     if (ctx->method == NULL)
  97         return 0;
  98     if (ctx->method->init != NULL)
  99         return ctx->method->init(ctx);
 100     else
 101         return 1;
 102 }
 103
 104 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx)
 105 {
 106     if (ctx->method == NULL)
 107         return 0;
 108     if (ctx->method->shutdown != NULL)
 109         return ctx->method->shutdown(ctx);
 110     else
 111         return 1;
 112 }
 113
 114 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, long argl,
 115                      char **ret)
 116 {
 117     if (ctx->method == NULL)
 118         return -1;
 119     if (ctx->method->ctrl != NULL)
 120         return ctx->method->ctrl(ctx, cmd, argc, argl, ret);
 121     else
 122         return 1;
 123 }
 124
 125 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
 126                            X509_OBJECT *ret)
 127 {
 128     if ((ctx->method == NULL) || (ctx->method->get_by_subject == NULL))
 129         return X509_LU_FAIL;
 130     if (ctx->skip)
 131         return 0;
 132     return ctx->method->get_by_subject(ctx, type, name, ret);
 133 }
 134
 135 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
 136                                  ASN1_INTEGER *serial, X509_OBJECT *ret)
 137 {
 138     if ((ctx->method == NULL) || (ctx->method->get_by_issuer_serial == NULL))
 139         return X509_LU_FAIL;
 140     return ctx->method->get_by_issuer_serial(ctx, type, name, serial, ret);
 141 }
 142
 143 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
 144                                unsigned char *bytes, int len,
 145                                X509_OBJECT *ret)
 146 {
 147     if ((ctx->method == NULL) || (ctx->method->get_by_fingerprint == NULL))
 148         return X509_LU_FAIL;
 149     return ctx->method->get_by_fingerprint(ctx, type, bytes, len, ret);
 150 }
 151
 152 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str, int len,
 153                          X509_OBJECT *ret)
 154 {
 155     if ((ctx->method == NULL) || (ctx->method->get_by_alias == NULL))
 156         return X509_LU_FAIL;
 157     return ctx->method->get_by_alias(ctx, type, str, len, ret);
 158 }
 159
 160 static int x509_object_cmp(const X509_OBJECT *const *a,
 161                            const X509_OBJECT *const *b)
 162 {
 163     int ret;
 164
 165     ret = ((*a)->type - (*b)->type);
 166     if (ret)
 167         return ret;
 168     switch ((*a)->type) {
 169     case X509_LU_X509:
 170         ret = X509_subject_name_cmp((*a)->data.x509, (*b)->data.x509);
 171         break;
 172     case X509_LU_CRL:
 173         ret = X509_CRL_cmp((*a)->data.crl, (*b)->data.crl);
 174         break;
 175     default:
 176         /* abort(); */
 177         return 0;
 178     }
 179     return ret;
 180 }
 181
 182 X509_STORE *X509_STORE_new(void)
 183 {
 184     X509_STORE *ret;
 185
 186     if ((ret = (X509_STORE *)OPENSSL_malloc(sizeof(X509_STORE))) == NULL)
 187         return NULL;
 188     ret->objs = sk_X509_OBJECT_new(x509_object_cmp);
 189     ret->cache = 1;
 190     ret->get_cert_methods = sk_X509_LOOKUP_new_null();
 191     ret->verify = 0;
 192     ret->verify_cb = 0;
 193
 194     if ((ret->param = X509_VERIFY_PARAM_new()) == NULL)
 195         return NULL;
 196
 197     ret->get_issuer = 0;
 198     ret->check_issued = 0;
 199     ret->check_revocation = 0;
 200     ret->get_crl = 0;
 201     ret->check_crl = 0;
 202     ret->cert_crl = 0;
 203     ret->cleanup = 0;
 204
 205     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_X509_STORE, ret, &ret->ex_data)) {
 206         sk_X509_OBJECT_free(ret->objs);
 207         OPENSSL_free(ret);
 208         return NULL;
 209     }
 210
 211     ret->references = 1;
 212     return ret;
 213 }
 214
 215 static void cleanup(X509_OBJECT *a)
 216 {
 217     if (a->type == X509_LU_X509) {
 218         X509_free(a->data.x509);
 219     } else if (a->type == X509_LU_CRL) {
 220         X509_CRL_free(a->data.crl);
 221     } else {
 222         /* abort(); */
 223     }
 224
 225     OPENSSL_free(a);
 226 }
 227
 228 void X509_STORE_free(X509_STORE *vfy)
 229 {
 230     int i;
 231     STACK_OF(X509_LOOKUP) *sk;
 232     X509_LOOKUP *lu;
 233
 234     if (vfy == NULL)
 235         return;
 236
 237     sk = vfy->get_cert_methods;
 238     for (i = 0; i < sk_X509_LOOKUP_num(sk); i++) {
 239         lu = sk_X509_LOOKUP_value(sk, i);
 240         X509_LOOKUP_shutdown(lu);
 241         X509_LOOKUP_free(lu);
 242     }
 243     sk_X509_LOOKUP_free(sk);
 244     sk_X509_OBJECT_pop_free(vfy->objs, cleanup);
 245
 246     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_X509_STORE, vfy, &vfy->ex_data);
 247     if (vfy->param)
 248         X509_VERIFY_PARAM_free(vfy->param);
 249     OPENSSL_free(vfy);
 250 }
 251
 252 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m)
 253 {
 254     int i;
 255     STACK_OF(X509_LOOKUP) *sk;
 256     X509_LOOKUP *lu;
 257
 258     sk = v->get_cert_methods;
 259     for (i = 0; i < sk_X509_LOOKUP_num(sk); i++) {
 260         lu = sk_X509_LOOKUP_value(sk, i);
 261         if (m == lu->method) {
 262             return lu;
 263         }
 264     }
 265     /* a new one */
 266     lu = X509_LOOKUP_new(m);
 267     if (lu == NULL)
 268         return NULL;
 269     else {
 270         lu->store_ctx = v;
 271         if (sk_X509_LOOKUP_push(v->get_cert_methods, lu))
 272             return lu;
 273         else {
 274             X509_LOOKUP_free(lu);
 275             return NULL;
 276         }
 277     }
 278 }
 279
 280 int X509_STORE_get_by_subject(X509_STORE_CTX *vs, int type, X509_NAME *name,
 281                               X509_OBJECT *ret)
 282 {
 283     X509_STORE *ctx = vs->ctx;
 284     X509_LOOKUP *lu;
 285     X509_OBJECT stmp, *tmp;
 286     int i, j;
 287
 288     CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
 289     tmp = X509_OBJECT_retrieve_by_subject(ctx->objs, type, name);
 290     CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
 291
 292     if (tmp == NULL) {
 293         for (i = vs->current_method;
 294              i < sk_X509_LOOKUP_num(ctx->get_cert_methods); i++) {
 295             lu = sk_X509_LOOKUP_value(ctx->get_cert_methods, i);
 296             j = X509_LOOKUP_by_subject(lu, type, name, &stmp);
 297             if (j < 0) {
 298                 vs->current_method = j;
 299                 return j;
 300             } else if (j) {
 301                 tmp = &stmp;
 302                 break;
 303             }
 304         }
 305         vs->current_method = 0;
 306         if (tmp == NULL)
 307             return 0;
 308     }
 309
 310 /*- if (ret->data.ptr != NULL)
 311             X509_OBJECT_free_contents(ret); */
 312
 313     ret->type = tmp->type;
 314     ret->data.ptr = tmp->data.ptr;
 315
 316     X509_OBJECT_up_ref_count(ret);
 317
 318     return 1;
 319 }
 320
 321 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x)
 322 {
 323     X509_OBJECT *obj;
 324     int ret = 1;
 325
 326     if (x == NULL)
 327         return 0;
 328     obj = (X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
 329     if (obj == NULL) {
 330         X509err(X509_F_X509_STORE_ADD_CERT, ERR_R_MALLOC_FAILURE);
 331         return 0;
 332     }
 333     obj->type = X509_LU_X509;
 334     obj->data.x509 = x;
 335
 336     CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
 337
 338     X509_OBJECT_up_ref_count(obj);
 339
 340     if (X509_OBJECT_retrieve_match(ctx->objs, obj)) {
 341         X509_OBJECT_free_contents(obj);
 342         OPENSSL_free(obj);
 343         X509err(X509_F_X509_STORE_ADD_CERT,
 344                 X509_R_CERT_ALREADY_IN_HASH_TABLE);
 345         ret = 0;
 346     } else
 347         sk_X509_OBJECT_push(ctx->objs, obj);
 348
 349     CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
 350
 351     return ret;
 352 }
 353
 354 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x)
 355 {
 356     X509_OBJECT *obj;
 357     int ret = 1;
 358
 359     if (x == NULL)
 360         return 0;
 361     obj = (X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
 362     if (obj == NULL) {
 363         X509err(X509_F_X509_STORE_ADD_CRL, ERR_R_MALLOC_FAILURE);
 364         return 0;
 365     }
 366     obj->type = X509_LU_CRL;
 367     obj->data.crl = x;
 368
 369     CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
 370
 371     X509_OBJECT_up_ref_count(obj);
 372
 373     if (X509_OBJECT_retrieve_match(ctx->objs, obj)) {
 374         X509_OBJECT_free_contents(obj);
 375         OPENSSL_free(obj);
 376         X509err(X509_F_X509_STORE_ADD_CRL, X509_R_CERT_ALREADY_IN_HASH_TABLE);
 377         ret = 0;
 378     } else
 379         sk_X509_OBJECT_push(ctx->objs, obj);
 380
 381     CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
 382
 383     return ret;
 384 }
 385
 386 void X509_OBJECT_up_ref_count(X509_OBJECT *a)
 387 {
 388     switch (a->type) {
 389     case X509_LU_X509:
 390         CRYPTO_add(&a->data.x509->references, 1, CRYPTO_LOCK_X509);
 391         break;
 392     case X509_LU_CRL:
 393         CRYPTO_add(&a->data.crl->references, 1, CRYPTO_LOCK_X509_CRL);
 394         break;
 395     }
 396 }
 397
 398 void X509_OBJECT_free_contents(X509_OBJECT *a)
 399 {
 400     switch (a->type) {
 401     case X509_LU_X509:
 402         X509_free(a->data.x509);
 403         break;
 404     case X509_LU_CRL:
 405         X509_CRL_free(a->data.crl);
 406         break;
 407     }
 408 }
 409
 410 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type,
 411                                X509_NAME *name)
 412 {
 413     X509_OBJECT stmp;
 414     X509 x509_s;
 415     X509_CINF cinf_s;
 416     X509_CRL crl_s;
 417     X509_CRL_INFO crl_info_s;
 418
 419     stmp.type = type;
 420     switch (type) {
 421     case X509_LU_X509:
 422         stmp.data.x509 = &x509_s;
 423         x509_s.cert_info = &cinf_s;
 424         cinf_s.subject = name;
 425         break;
 426     case X509_LU_CRL:
 427         stmp.data.crl = &crl_s;
 428         crl_s.crl = &crl_info_s;
 429         crl_info_s.issuer = name;
 430         break;
 431     default:
 432         /* abort(); */
 433         return -1;
 434     }
 435
 436     return sk_X509_OBJECT_find(h, &stmp);
 437 }
 438
 439 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h,
 440                                              int type, X509_NAME *name)
 441 {
 442     int idx;
 443     idx = X509_OBJECT_idx_by_subject(h, type, name);
 444     if (idx == -1)
 445         return NULL;
 446     return sk_X509_OBJECT_value(h, idx);
 447 }
 448
 449 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h,
 450                                         X509_OBJECT *x)
 451 {
 452     int idx, i;
 453     X509_OBJECT *obj;
 454     idx = sk_X509_OBJECT_find(h, x);
 455     if (idx == -1)
 456         return NULL;
 457     if (x->type != X509_LU_X509)
 458         return sk_X509_OBJECT_value(h, idx);
 459     for (i = idx; i < sk_X509_OBJECT_num(h); i++) {
 460         obj = sk_X509_OBJECT_value(h, i);
 461         if (x509_object_cmp
 462             ((const X509_OBJECT **)&obj, (const X509_OBJECT **)&x))
 463             return NULL;
 464         if ((x->type != X509_LU_X509)
 465             || !X509_cmp(obj->data.x509, x->data.x509))
 466             return obj;
 467     }
 468     return NULL;
 469 }
 470
 471 /*-
 472  * Try to get issuer certificate from store. Due to limitations
 473  * of the API this can only retrieve a single certificate matching
 474  * a given subject name. However it will fill the cache with all
 475  * matching certificates, so we can examine the cache for all
 476  * matches.
 477  *
 478  * Return values are:
 479  *  1 lookup successful.
 480  *  0 certificate not found.
 481  * -1 some other error.
 482  */
 483 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x)
 484 {
 485     X509_NAME *xn;
 486     X509_OBJECT obj, *pobj;
 487     int i, ok, idx, ret;
 488     xn = X509_get_issuer_name(x);
 489     ok = X509_STORE_get_by_subject(ctx, X509_LU_X509, xn, &obj);
 490     if (ok != X509_LU_X509) {
 491         if (ok == X509_LU_RETRY) {
 492             X509_OBJECT_free_contents(&obj);
 493             X509err(X509_F_X509_STORE_CTX_GET1_ISSUER, X509_R_SHOULD_RETRY);
 494             return -1;
 495         } else if (ok != X509_LU_FAIL) {
 496             X509_OBJECT_free_contents(&obj);
 497             /* not good :-(, break anyway */
 498             return -1;
 499         }
 500         return 0;
 501     }
 502     /* If certificate matches all OK */
 503     if (ctx->check_issued(ctx, x, obj.data.x509)) {
 504         *issuer = obj.data.x509;
 505         return 1;
 506     }
 507     X509_OBJECT_free_contents(&obj);
 508
 509     /* Else find index of first cert accepted by 'check_issued' */
 510     ret = 0;
 511     CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
 512     idx = X509_OBJECT_idx_by_subject(ctx->ctx->objs, X509_LU_X509, xn);
 513     if (idx != -1) {            /* should be true as we've had at least one
 514                                  * match */
 515         /* Look through all matching certs for suitable issuer */
 516         for (i = idx; i < sk_X509_OBJECT_num(ctx->ctx->objs); i++) {
 517             pobj = sk_X509_OBJECT_value(ctx->ctx->objs, i);
 518             /* See if we've run past the matches */
 519             if (pobj->type != X509_LU_X509)
 520                 break;
 521             if (X509_NAME_cmp(xn, X509_get_subject_name(pobj->data.x509)))
 522                 break;
 523             if (ctx->check_issued(ctx, x, pobj->data.x509)) {
 524                 *issuer = pobj->data.x509;
 525                 X509_OBJECT_up_ref_count(pobj);
 526                 ret = 1;
 527                 break;
 528             }
 529         }
 530     }
 531     CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
 532     return ret;
 533 }
 534
 535 int X509_STORE_set_flags(X509_STORE *ctx, unsigned long flags)
 536 {
 537     return X509_VERIFY_PARAM_set_flags(ctx->param, flags);
 538 }
 539
 540 int X509_STORE_set_depth(X509_STORE *ctx, int depth)
 541 {
 542     X509_VERIFY_PARAM_set_depth(ctx->param, depth);
 543     return 1;
 544 }
 545
 546 int X509_STORE_set_purpose(X509_STORE *ctx, int purpose)
 547 {
 548     return X509_VERIFY_PARAM_set_purpose(ctx->param, purpose);
 549 }
 550
 551 int X509_STORE_set_trust(X509_STORE *ctx, int trust)
 552 {
 553     return X509_VERIFY_PARAM_set_trust(ctx->param, trust);
 554 }
 555
 556 int X509_STORE_set1_param(X509_STORE *ctx, X509_VERIFY_PARAM *param)
 557 {
 558     return X509_VERIFY_PARAM_set1(ctx->param, param);
 559 }
 560
 561 IMPLEMENT_STACK_OF(X509_LOOKUP)
 562
 563 IMPLEMENT_STACK_OF(X509_OBJECT)