1 /* $OpenBSD: x509_lu.c,v 1.30 2018/08/24 19:21:09 tb Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
61 #include <openssl/err.h>
62 #include <openssl/lhash.h>
63 #include <openssl/x509.h>
64 #include <openssl/x509v3.h>
67 static void X509_OBJECT_dec_ref_count(X509_OBJECT *a);
70 X509_LOOKUP_new(X509_LOOKUP_METHOD *method)
74 ret = malloc(sizeof(X509_LOOKUP));
81 ret->method_data = NULL;
82 ret->store_ctx = NULL;
83 if ((method->new_item != NULL) && !method->new_item(ret)) {
91 X509_LOOKUP_free(X509_LOOKUP *ctx)
95 if ((ctx->method != NULL) && (ctx->method->free != NULL))
96 (*ctx->method->free)(ctx);
101 X509_LOOKUP_init(X509_LOOKUP *ctx)
103 if (ctx->method == NULL)
105 if (ctx->method->init != NULL)
106 return ctx->method->init(ctx);
112 X509_LOOKUP_shutdown(X509_LOOKUP *ctx)
114 if (ctx->method == NULL)
116 if (ctx->method->shutdown != NULL)
117 return ctx->method->shutdown(ctx);
123 X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, long argl,
126 if (ctx->method == NULL)
128 if (ctx->method->ctrl != NULL)
129 return ctx->method->ctrl(ctx, cmd, argc, argl, ret);
135 X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
138 if ((ctx->method == NULL) || (ctx->method->get_by_subject == NULL))
142 return ctx->method->get_by_subject(ctx, type, name, ret);
146 X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
147 ASN1_INTEGER *serial, X509_OBJECT *ret)
149 if ((ctx->method == NULL) ||
150 (ctx->method->get_by_issuer_serial == NULL))
152 return ctx->method->get_by_issuer_serial(ctx, type, name, serial, ret);
156 X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
157 const unsigned char *bytes, int len, X509_OBJECT *ret)
159 if ((ctx->method == NULL) || (ctx->method->get_by_fingerprint == NULL))
161 return ctx->method->get_by_fingerprint(ctx, type, bytes, len, ret);
165 X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, const char *str, int len,
168 if ((ctx->method == NULL) || (ctx->method->get_by_alias == NULL))
170 return ctx->method->get_by_alias(ctx, type, str, len, ret);
174 x509_object_cmp(const X509_OBJECT * const *a, const X509_OBJECT * const *b)
178 ret = ((*a)->type - (*b)->type);
181 switch ((*a)->type) {
183 ret = X509_subject_name_cmp((*a)->data.x509, (*b)->data.x509);
186 ret = X509_CRL_cmp((*a)->data.crl, (*b)->data.crl);
200 if ((ret = malloc(sizeof(X509_STORE))) == NULL)
202 ret->objs = sk_X509_OBJECT_new(x509_object_cmp);
204 ret->get_cert_methods = sk_X509_LOOKUP_new_null();
208 if ((ret->param = X509_VERIFY_PARAM_new()) == NULL)
212 ret->check_issued = 0;
213 ret->check_revocation = 0;
217 ret->lookup_certs = 0;
218 ret->lookup_crls = 0;
221 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_X509_STORE, ret, &ret->ex_data))
228 X509_VERIFY_PARAM_free(ret->param);
229 sk_X509_LOOKUP_free(ret->get_cert_methods);
230 sk_X509_OBJECT_free(ret->objs);
236 X509_OBJECT_free(X509_OBJECT *a)
238 X509_OBJECT_free_contents(a);
243 X509_STORE_free(X509_STORE *vfy)
246 STACK_OF(X509_LOOKUP) *sk;
252 i = CRYPTO_add(&vfy->references, -1, CRYPTO_LOCK_X509_STORE);
256 sk = vfy->get_cert_methods;
257 for (i = 0; i < sk_X509_LOOKUP_num(sk); i++) {
258 lu = sk_X509_LOOKUP_value(sk, i);
259 X509_LOOKUP_shutdown(lu);
260 X509_LOOKUP_free(lu);
262 sk_X509_LOOKUP_free(sk);
263 sk_X509_OBJECT_pop_free(vfy->objs, X509_OBJECT_free);
265 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_X509_STORE, vfy, &vfy->ex_data);
266 X509_VERIFY_PARAM_free(vfy->param);
271 X509_STORE_up_ref(X509_STORE *x)
273 int refs = CRYPTO_add(&x->references, 1, CRYPTO_LOCK_X509_STORE);
274 return (refs > 1) ? 1 : 0;
278 X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m)
281 STACK_OF(X509_LOOKUP) *sk;
284 sk = v->get_cert_methods;
285 for (i = 0; i < sk_X509_LOOKUP_num(sk); i++) {
286 lu = sk_X509_LOOKUP_value(sk, i);
287 if (m == lu->method) {
292 lu = X509_LOOKUP_new(m);
297 if (sk_X509_LOOKUP_push(v->get_cert_methods, lu))
300 X509_LOOKUP_free(lu);
307 X509_STORE_get_by_subject(X509_STORE_CTX *vs, int type, X509_NAME *name,
310 X509_STORE *ctx = vs->ctx;
312 X509_OBJECT stmp, *tmp;
315 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
316 tmp = X509_OBJECT_retrieve_by_subject(ctx->objs, type, name);
317 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
319 if (tmp == NULL || type == X509_LU_CRL) {
320 for (i = vs->current_method;
321 i < sk_X509_LOOKUP_num(ctx->get_cert_methods); i++) {
322 lu = sk_X509_LOOKUP_value(ctx->get_cert_methods, i);
323 j = X509_LOOKUP_by_subject(lu, type, name, &stmp);
325 vs->current_method = j;
332 vs->current_method = 0;
337 /* if (ret->data.ptr != NULL)
338 X509_OBJECT_free_contents(ret); */
340 ret->type = tmp->type;
341 ret->data.ptr = tmp->data.ptr;
343 X509_OBJECT_up_ref_count(ret);
349 X509_STORE_add_cert(X509_STORE *ctx, X509 *x)
356 obj = malloc(sizeof(X509_OBJECT));
358 X509error(ERR_R_MALLOC_FAILURE);
361 obj->type = X509_LU_X509;
364 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
366 X509_OBJECT_up_ref_count(obj);
368 if (X509_OBJECT_retrieve_match(ctx->objs, obj)) {
369 X509error(X509_R_CERT_ALREADY_IN_HASH_TABLE);
372 if (sk_X509_OBJECT_push(ctx->objs, obj) == 0) {
373 X509error(ERR_R_MALLOC_FAILURE);
379 X509_OBJECT_dec_ref_count(obj);
381 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
384 obj->data.x509 = NULL; /* owned by the caller */
385 X509_OBJECT_free(obj);
392 X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x)
399 obj = malloc(sizeof(X509_OBJECT));
401 X509error(ERR_R_MALLOC_FAILURE);
404 obj->type = X509_LU_CRL;
407 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
409 X509_OBJECT_up_ref_count(obj);
411 if (X509_OBJECT_retrieve_match(ctx->objs, obj)) {
412 X509error(X509_R_CERT_ALREADY_IN_HASH_TABLE);
415 if (sk_X509_OBJECT_push(ctx->objs, obj) == 0) {
416 X509error(ERR_R_MALLOC_FAILURE);
422 X509_OBJECT_dec_ref_count(obj);
424 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
427 obj->data.crl = NULL; /* owned by the caller */
428 X509_OBJECT_free(obj);
435 X509_OBJECT_dec_ref_count(X509_OBJECT *a)
439 CRYPTO_add(&a->data.x509->references, -1, CRYPTO_LOCK_X509);
442 CRYPTO_add(&a->data.crl->references, -1, CRYPTO_LOCK_X509_CRL);
448 X509_OBJECT_up_ref_count(X509_OBJECT *a)
452 return X509_up_ref(a->data.x509);
454 return X509_CRL_up_ref(a->data.crl);
460 X509_OBJECT_get_type(const X509_OBJECT *a)
466 X509_OBJECT_free_contents(X509_OBJECT *a)
470 X509_free(a->data.x509);
473 X509_CRL_free(a->data.crl);
479 x509_object_idx_cnt(STACK_OF(X509_OBJECT) *h, int type, X509_NAME *name,
486 X509_CRL_INFO crl_info_s;
492 stmp.data.x509 = &x509_s;
493 x509_s.cert_info = &cinf_s;
494 cinf_s.subject = name;
497 stmp.data.crl = &crl_s;
498 crl_s.crl = &crl_info_s;
499 crl_info_s.issuer = name;
506 idx = sk_X509_OBJECT_find(h, &stmp);
507 if (idx >= 0 && pnmatch) {
509 const X509_OBJECT *tobj, *pstmp;
512 for (tidx = idx + 1; tidx < sk_X509_OBJECT_num(h); tidx++) {
513 tobj = sk_X509_OBJECT_value(h, tidx);
514 if (x509_object_cmp(&tobj, &pstmp))
523 X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type, X509_NAME *name)
525 return x509_object_idx_cnt(h, type, name, NULL);
529 X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h, int type,
534 idx = X509_OBJECT_idx_by_subject(h, type, name);
537 return sk_X509_OBJECT_value(h, idx);
541 X509_OBJECT_get0_X509(const X509_OBJECT *xo)
543 if (xo != NULL && xo->type == X509_LU_X509)
544 return xo->data.x509;
549 X509_OBJECT_get0_X509_CRL(X509_OBJECT *xo)
551 if (xo != NULL && xo->type == X509_LU_CRL)
557 X509_STORE_get1_certs(X509_STORE_CTX *ctx, X509_NAME *nm)
564 sk = sk_X509_new_null();
567 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
568 idx = x509_object_idx_cnt(ctx->ctx->objs, X509_LU_X509, nm, &cnt);
570 /* Nothing found in cache: do lookup to possibly add new
574 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
575 if (!X509_STORE_get_by_subject(ctx, X509_LU_X509, nm, &xobj)) {
579 X509_OBJECT_free_contents(&xobj);
580 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
581 idx = x509_object_idx_cnt(ctx->ctx->objs,
582 X509_LU_X509, nm, &cnt);
584 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
589 for (i = 0; i < cnt; i++, idx++) {
590 obj = sk_X509_OBJECT_value(ctx->ctx->objs, idx);
592 CRYPTO_add(&x->references, 1, CRYPTO_LOCK_X509);
593 if (!sk_X509_push(sk, x)) {
594 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
596 sk_X509_pop_free(sk, X509_free);
600 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
606 X509_STORE_get1_crls(X509_STORE_CTX *ctx, X509_NAME *nm)
609 STACK_OF(X509_CRL) *sk;
611 X509_OBJECT *obj, xobj;
613 sk = sk_X509_CRL_new_null();
616 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
617 /* Check cache first */
618 idx = x509_object_idx_cnt(ctx->ctx->objs, X509_LU_CRL, nm, &cnt);
620 /* Always do lookup to possibly add new CRLs to cache
622 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
623 if (!X509_STORE_get_by_subject(ctx, X509_LU_CRL, nm, &xobj)) {
624 sk_X509_CRL_free(sk);
627 X509_OBJECT_free_contents(&xobj);
628 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
629 idx = x509_object_idx_cnt(ctx->ctx->objs, X509_LU_CRL, nm, &cnt);
631 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
632 sk_X509_CRL_free(sk);
636 for (i = 0; i < cnt; i++, idx++) {
637 obj = sk_X509_OBJECT_value(ctx->ctx->objs, idx);
639 CRYPTO_add(&x->references, 1, CRYPTO_LOCK_X509_CRL);
640 if (!sk_X509_CRL_push(sk, x)) {
641 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
643 sk_X509_CRL_pop_free(sk, X509_CRL_free);
647 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
652 X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h, X509_OBJECT *x)
657 idx = sk_X509_OBJECT_find(h, x);
660 if ((x->type != X509_LU_X509) && (x->type != X509_LU_CRL))
661 return sk_X509_OBJECT_value(h, idx);
662 for (i = idx; i < sk_X509_OBJECT_num(h); i++) {
663 obj = sk_X509_OBJECT_value(h, i);
664 if (x509_object_cmp((const X509_OBJECT **)&obj,
665 (const X509_OBJECT **)&x))
667 if (x->type == X509_LU_X509) {
668 if (!X509_cmp(obj->data.x509, x->data.x509))
670 } else if (x->type == X509_LU_CRL) {
671 if (!X509_CRL_match(obj->data.crl, x->data.crl))
679 /* Try to get issuer certificate from store. Due to limitations
680 * of the API this can only retrieve a single certificate matching
681 * a given subject name. However it will fill the cache with all
682 * matching certificates, so we can examine the cache for all
686 * 1 lookup successful.
687 * 0 certificate not found.
688 * -1 some other error.
691 X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x)
694 X509_OBJECT obj, *pobj;
698 xn = X509_get_issuer_name(x);
699 ok = X509_STORE_get_by_subject(ctx, X509_LU_X509, xn, &obj);
700 if (ok != X509_LU_X509) {
701 if (ok == X509_LU_RETRY) {
702 X509_OBJECT_free_contents(&obj);
703 X509error(X509_R_SHOULD_RETRY);
705 } else if (ok != X509_LU_FAIL) {
706 X509_OBJECT_free_contents(&obj);
707 /* not good :-(, break anyway */
712 /* If certificate matches all OK */
713 if (ctx->check_issued(ctx, x, obj.data.x509)) {
714 if (x509_check_cert_time(ctx, obj.data.x509, 1)) {
715 *issuer = obj.data.x509;
719 X509_OBJECT_free_contents(&obj);
721 /* Else find index of first cert accepted by 'check_issued' */
723 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
724 idx = X509_OBJECT_idx_by_subject(ctx->ctx->objs, X509_LU_X509, xn);
725 if (idx != -1) /* should be true as we've had at least one match */ {
726 /* Look through all matching certs for suitable issuer */
727 for (i = idx; i < sk_X509_OBJECT_num(ctx->ctx->objs); i++) {
728 pobj = sk_X509_OBJECT_value(ctx->ctx->objs, i);
729 /* See if we've run past the matches */
730 if (pobj->type != X509_LU_X509)
732 if (X509_NAME_cmp(xn,
733 X509_get_subject_name(pobj->data.x509)))
735 if (ctx->check_issued(ctx, x, pobj->data.x509)) {
736 *issuer = pobj->data.x509;
739 * If times check, exit with match,
740 * otherwise keep looking. Leave last
741 * match in issuer so we return nearest
742 * match if no certificate time is OK.
744 if (x509_check_cert_time(ctx, *issuer, 1))
749 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
751 CRYPTO_add(&(*issuer)->references, 1, CRYPTO_LOCK_X509);
755 STACK_OF(X509_OBJECT) *
756 X509_STORE_get0_objects(X509_STORE *xs)
762 X509_STORE_get_ex_data(X509_STORE *xs, int idx)
764 return CRYPTO_get_ex_data(&xs->ex_data, idx);
768 X509_STORE_set_ex_data(X509_STORE *xs, int idx, void *data)
770 return CRYPTO_set_ex_data(&xs->ex_data, idx, data);
774 X509_STORE_set_flags(X509_STORE *ctx, unsigned long flags)
776 return X509_VERIFY_PARAM_set_flags(ctx->param, flags);
780 X509_STORE_set_depth(X509_STORE *ctx, int depth)
782 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
787 X509_STORE_set_purpose(X509_STORE *ctx, int purpose)
789 return X509_VERIFY_PARAM_set_purpose(ctx->param, purpose);
793 X509_STORE_set_trust(X509_STORE *ctx, int trust)
795 return X509_VERIFY_PARAM_set_trust(ctx->param, trust);
799 X509_STORE_set1_param(X509_STORE *ctx, X509_VERIFY_PARAM *param)
801 return X509_VERIFY_PARAM_set1(ctx->param, param);
805 X509_STORE_get0_param(X509_STORE *ctx)
811 X509_STORE_set_verify_cb(X509_STORE *ctx,
812 int (*verify_cb)(int, X509_STORE_CTX *))
814 ctx->verify_cb = verify_cb;