1 /* crypto/x509/x509_lu.c */
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/lhash.h>
62 #include <openssl/x509.h>
63 #include <openssl/x509v3.h>
66 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method)
70 ret = (X509_LOOKUP *)OPENSSL_malloc(sizeof(X509_LOOKUP));
77 ret->method_data = NULL;
78 ret->store_ctx = NULL;
79 if ((method->new_item != NULL) && !method->new_item(ret)) {
86 void X509_LOOKUP_free(X509_LOOKUP *ctx)
90 if ((ctx->method != NULL) && (ctx->method->free != NULL))
91 (*ctx->method->free) (ctx);
95 int X509_LOOKUP_init(X509_LOOKUP *ctx)
97 if (ctx->method == NULL)
99 if (ctx->method->init != NULL)
100 return ctx->method->init(ctx);
105 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx)
107 if (ctx->method == NULL)
109 if (ctx->method->shutdown != NULL)
110 return ctx->method->shutdown(ctx);
115 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, long argl,
118 if (ctx->method == NULL)
120 if (ctx->method->ctrl != NULL)
121 return ctx->method->ctrl(ctx, cmd, argc, argl, ret);
126 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
129 if ((ctx->method == NULL) || (ctx->method->get_by_subject == NULL))
133 return ctx->method->get_by_subject(ctx, type, name, ret);
136 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
137 ASN1_INTEGER *serial, X509_OBJECT *ret)
139 if ((ctx->method == NULL) || (ctx->method->get_by_issuer_serial == NULL))
141 return ctx->method->get_by_issuer_serial(ctx, type, name, serial, ret);
144 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
145 unsigned char *bytes, int len,
148 if ((ctx->method == NULL) || (ctx->method->get_by_fingerprint == NULL))
150 return ctx->method->get_by_fingerprint(ctx, type, bytes, len, ret);
153 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str, int len,
156 if ((ctx->method == NULL) || (ctx->method->get_by_alias == NULL))
158 return ctx->method->get_by_alias(ctx, type, str, len, ret);
161 static int x509_object_cmp(const X509_OBJECT *const *a,
162 const X509_OBJECT *const *b)
166 ret = ((*a)->type - (*b)->type);
169 switch ((*a)->type) {
171 ret = X509_subject_name_cmp((*a)->data.x509, (*b)->data.x509);
174 ret = X509_CRL_cmp((*a)->data.crl, (*b)->data.crl);
183 X509_STORE *X509_STORE_new(void)
187 if ((ret = (X509_STORE *)OPENSSL_malloc(sizeof(X509_STORE))) == NULL)
189 ret->objs = sk_X509_OBJECT_new(x509_object_cmp);
191 ret->get_cert_methods = sk_X509_LOOKUP_new_null();
195 if ((ret->param = X509_VERIFY_PARAM_new()) == NULL)
199 ret->check_issued = 0;
200 ret->check_revocation = 0;
204 ret->lookup_certs = 0;
205 ret->lookup_crls = 0;
208 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_X509_STORE, ret, &ret->ex_data)) {
209 sk_X509_OBJECT_free(ret->objs);
218 static void cleanup(X509_OBJECT *a)
220 if (a->type == X509_LU_X509) {
221 X509_free(a->data.x509);
222 } else if (a->type == X509_LU_CRL) {
223 X509_CRL_free(a->data.crl);
231 void X509_STORE_free(X509_STORE *vfy)
234 STACK_OF(X509_LOOKUP) *sk;
240 i = CRYPTO_add(&vfy->references, -1, CRYPTO_LOCK_X509_STORE);
242 REF_PRINT("X509_STORE", vfy);
248 fprintf(stderr, "X509_STORE_free, bad reference count\n");
253 sk = vfy->get_cert_methods;
254 for (i = 0; i < sk_X509_LOOKUP_num(sk); i++) {
255 lu = sk_X509_LOOKUP_value(sk, i);
256 X509_LOOKUP_shutdown(lu);
257 X509_LOOKUP_free(lu);
259 sk_X509_LOOKUP_free(sk);
260 sk_X509_OBJECT_pop_free(vfy->objs, cleanup);
262 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_X509_STORE, vfy, &vfy->ex_data);
264 X509_VERIFY_PARAM_free(vfy->param);
268 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m)
271 STACK_OF(X509_LOOKUP) *sk;
274 sk = v->get_cert_methods;
275 for (i = 0; i < sk_X509_LOOKUP_num(sk); i++) {
276 lu = sk_X509_LOOKUP_value(sk, i);
277 if (m == lu->method) {
282 lu = X509_LOOKUP_new(m);
287 if (sk_X509_LOOKUP_push(v->get_cert_methods, lu))
290 X509_LOOKUP_free(lu);
296 int X509_STORE_get_by_subject(X509_STORE_CTX *vs, int type, X509_NAME *name,
299 X509_STORE *ctx = vs->ctx;
301 X509_OBJECT stmp, *tmp;
304 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
305 tmp = X509_OBJECT_retrieve_by_subject(ctx->objs, type, name);
306 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
308 if (tmp == NULL || type == X509_LU_CRL) {
309 for (i = vs->current_method;
310 i < sk_X509_LOOKUP_num(ctx->get_cert_methods); i++) {
311 lu = sk_X509_LOOKUP_value(ctx->get_cert_methods, i);
312 j = X509_LOOKUP_by_subject(lu, type, name, &stmp);
314 vs->current_method = j;
321 vs->current_method = 0;
326 /*- if (ret->data.ptr != NULL)
327 X509_OBJECT_free_contents(ret); */
329 ret->type = tmp->type;
330 ret->data.ptr = tmp->data.ptr;
332 X509_OBJECT_up_ref_count(ret);
337 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x)
344 obj = (X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
346 X509err(X509_F_X509_STORE_ADD_CERT, ERR_R_MALLOC_FAILURE);
349 obj->type = X509_LU_X509;
352 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
354 X509_OBJECT_up_ref_count(obj);
356 if (X509_OBJECT_retrieve_match(ctx->objs, obj)) {
357 X509_OBJECT_free_contents(obj);
359 X509err(X509_F_X509_STORE_ADD_CERT,
360 X509_R_CERT_ALREADY_IN_HASH_TABLE);
363 sk_X509_OBJECT_push(ctx->objs, obj);
365 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
370 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x)
377 obj = (X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
379 X509err(X509_F_X509_STORE_ADD_CRL, ERR_R_MALLOC_FAILURE);
382 obj->type = X509_LU_CRL;
385 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
387 X509_OBJECT_up_ref_count(obj);
389 if (X509_OBJECT_retrieve_match(ctx->objs, obj)) {
390 X509_OBJECT_free_contents(obj);
392 X509err(X509_F_X509_STORE_ADD_CRL, X509_R_CERT_ALREADY_IN_HASH_TABLE);
395 sk_X509_OBJECT_push(ctx->objs, obj);
397 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
402 void X509_OBJECT_up_ref_count(X509_OBJECT *a)
406 CRYPTO_add(&a->data.x509->references, 1, CRYPTO_LOCK_X509);
409 CRYPTO_add(&a->data.crl->references, 1, CRYPTO_LOCK_X509_CRL);
414 void X509_OBJECT_free_contents(X509_OBJECT *a)
418 X509_free(a->data.x509);
421 X509_CRL_free(a->data.crl);
426 static int x509_object_idx_cnt(STACK_OF(X509_OBJECT) *h, int type,
427 X509_NAME *name, int *pnmatch)
433 X509_CRL_INFO crl_info_s;
439 stmp.data.x509 = &x509_s;
440 x509_s.cert_info = &cinf_s;
441 cinf_s.subject = name;
444 stmp.data.crl = &crl_s;
445 crl_s.crl = &crl_info_s;
446 crl_info_s.issuer = name;
453 idx = sk_X509_OBJECT_find(h, &stmp);
454 if (idx >= 0 && pnmatch) {
456 const X509_OBJECT *tobj, *pstmp;
459 for (tidx = idx + 1; tidx < sk_X509_OBJECT_num(h); tidx++) {
460 tobj = sk_X509_OBJECT_value(h, tidx);
461 if (x509_object_cmp(&tobj, &pstmp))
469 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type,
472 return x509_object_idx_cnt(h, type, name, NULL);
475 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h,
476 int type, X509_NAME *name)
479 idx = X509_OBJECT_idx_by_subject(h, type, name);
482 return sk_X509_OBJECT_value(h, idx);
485 STACK_OF(X509) *X509_STORE_get1_certs(X509_STORE_CTX *ctx, X509_NAME *nm)
491 sk = sk_X509_new_null();
492 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
493 idx = x509_object_idx_cnt(ctx->ctx->objs, X509_LU_X509, nm, &cnt);
496 * Nothing found in cache: do lookup to possibly add new objects to
500 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
501 if (!X509_STORE_get_by_subject(ctx, X509_LU_X509, nm, &xobj)) {
505 X509_OBJECT_free_contents(&xobj);
506 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
507 idx = x509_object_idx_cnt(ctx->ctx->objs, X509_LU_X509, nm, &cnt);
509 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
514 for (i = 0; i < cnt; i++, idx++) {
515 obj = sk_X509_OBJECT_value(ctx->ctx->objs, idx);
517 CRYPTO_add(&x->references, 1, CRYPTO_LOCK_X509);
518 if (!sk_X509_push(sk, x)) {
519 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
521 sk_X509_pop_free(sk, X509_free);
525 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
530 STACK_OF(X509_CRL) *X509_STORE_get1_crls(X509_STORE_CTX *ctx, X509_NAME *nm)
533 STACK_OF(X509_CRL) *sk;
535 X509_OBJECT *obj, xobj;
536 sk = sk_X509_CRL_new_null();
537 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
538 /* Check cache first */
539 idx = x509_object_idx_cnt(ctx->ctx->objs, X509_LU_CRL, nm, &cnt);
542 * Always do lookup to possibly add new CRLs to cache
544 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
545 if (!X509_STORE_get_by_subject(ctx, X509_LU_CRL, nm, &xobj)) {
546 sk_X509_CRL_free(sk);
549 X509_OBJECT_free_contents(&xobj);
550 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
551 idx = x509_object_idx_cnt(ctx->ctx->objs, X509_LU_CRL, nm, &cnt);
553 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
554 sk_X509_CRL_free(sk);
558 for (i = 0; i < cnt; i++, idx++) {
559 obj = sk_X509_OBJECT_value(ctx->ctx->objs, idx);
561 CRYPTO_add(&x->references, 1, CRYPTO_LOCK_X509_CRL);
562 if (!sk_X509_CRL_push(sk, x)) {
563 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
565 sk_X509_CRL_pop_free(sk, X509_CRL_free);
569 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
573 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h,
578 idx = sk_X509_OBJECT_find(h, x);
581 if ((x->type != X509_LU_X509) && (x->type != X509_LU_CRL))
582 return sk_X509_OBJECT_value(h, idx);
583 for (i = idx; i < sk_X509_OBJECT_num(h); i++) {
584 obj = sk_X509_OBJECT_value(h, i);
586 ((const X509_OBJECT **)&obj, (const X509_OBJECT **)&x))
588 if (x->type == X509_LU_X509) {
589 if (!X509_cmp(obj->data.x509, x->data.x509))
591 } else if (x->type == X509_LU_CRL) {
592 if (!X509_CRL_match(obj->data.crl, x->data.crl))
601 * Try to get issuer certificate from store. Due to limitations
602 * of the API this can only retrieve a single certificate matching
603 * a given subject name. However it will fill the cache with all
604 * matching certificates, so we can examine the cache for all
608 * 1 lookup successful.
609 * 0 certificate not found.
610 * -1 some other error.
612 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x)
615 X509_OBJECT obj, *pobj;
618 xn = X509_get_issuer_name(x);
619 ok = X509_STORE_get_by_subject(ctx, X509_LU_X509, xn, &obj);
620 if (ok != X509_LU_X509) {
621 if (ok == X509_LU_RETRY) {
622 X509_OBJECT_free_contents(&obj);
623 X509err(X509_F_X509_STORE_CTX_GET1_ISSUER, X509_R_SHOULD_RETRY);
625 } else if (ok != X509_LU_FAIL) {
626 X509_OBJECT_free_contents(&obj);
627 /* not good :-(, break anyway */
632 /* If certificate matches all OK */
633 if (ctx->check_issued(ctx, x, obj.data.x509)) {
634 if (x509_check_cert_time(ctx, obj.data.x509, 1)) {
635 *issuer = obj.data.x509;
639 X509_OBJECT_free_contents(&obj);
641 /* Else find index of first cert accepted by 'check_issued' */
643 CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
644 idx = X509_OBJECT_idx_by_subject(ctx->ctx->objs, X509_LU_X509, xn);
645 if (idx != -1) { /* should be true as we've had at least one
647 /* Look through all matching certs for suitable issuer */
648 for (i = idx; i < sk_X509_OBJECT_num(ctx->ctx->objs); i++) {
649 pobj = sk_X509_OBJECT_value(ctx->ctx->objs, i);
650 /* See if we've run past the matches */
651 if (pobj->type != X509_LU_X509)
653 if (X509_NAME_cmp(xn, X509_get_subject_name(pobj->data.x509)))
655 if (ctx->check_issued(ctx, x, pobj->data.x509)) {
656 *issuer = pobj->data.x509;
659 * If times check, exit with match,
660 * otherwise keep looking. Leave last
661 * match in issuer so we return nearest
662 * match if no certificate time is OK.
665 if (x509_check_cert_time(ctx, *issuer, 1))
670 CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
672 CRYPTO_add(&(*issuer)->references, 1, CRYPTO_LOCK_X509);
676 int X509_STORE_set_flags(X509_STORE *ctx, unsigned long flags)
678 return X509_VERIFY_PARAM_set_flags(ctx->param, flags);
681 int X509_STORE_set_depth(X509_STORE *ctx, int depth)
683 X509_VERIFY_PARAM_set_depth(ctx->param, depth);
687 int X509_STORE_set_purpose(X509_STORE *ctx, int purpose)
689 return X509_VERIFY_PARAM_set_purpose(ctx->param, purpose);
692 int X509_STORE_set_trust(X509_STORE *ctx, int trust)
694 return X509_VERIFY_PARAM_set_trust(ctx->param, trust);
697 int X509_STORE_set1_param(X509_STORE *ctx, X509_VERIFY_PARAM *param)
699 return X509_VERIFY_PARAM_set1(ctx->param, param);
702 void X509_STORE_set_verify_cb(X509_STORE *ctx,
703 int (*verify_cb) (int, X509_STORE_CTX *))
705 ctx->verify_cb = verify_cb;
708 void X509_STORE_set_lookup_crls_cb(X509_STORE *ctx,
709 STACK_OF(X509_CRL) *(*cb) (X509_STORE_CTX
713 ctx->lookup_crls = cb;
716 X509_STORE *X509_STORE_CTX_get0_store(X509_STORE_CTX *ctx)