2 * Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #include <openssl/store.h>
11 #include "internal/cryptlib.h"
12 #include "crypto/x509.h"
13 #include "x509_local.h"
15 /* Generic object loader, given expected type and criterion */
16 static int cache_objects(X509_LOOKUP *lctx, const char *uri,
17 const OSSL_STORE_SEARCH *criterion,
21 OSSL_STORE_CTX *ctx = NULL;
22 X509_STORE *xstore = X509_LOOKUP_get_store(lctx);
24 if ((ctx = OSSL_STORE_open(uri, NULL, NULL, NULL, NULL)) == NULL)
28 * We try to set the criterion, but don't care if it was valid or not.
29 * For a OSSL_STORE, it merely serves as an optimization, the expectation
30 * being that if the criterion couldn't be used, we will get *everything*
31 * from the container that the URI represents rather than the subset that
32 * the criterion indicates, so the biggest harm is that we cache more
33 * objects certs and CRLs than we may expect, but that's ok.
35 * Specifically for OpenSSL's own file: scheme, the only workable
36 * criterion is the BY_NAME one, which it can only apply on directories,
37 * but it's possible that the URI is a single file rather than a directory,
38 * and in that case, the BY_NAME criterion is pointless.
40 * We could very simply not apply any criterion at all here, and just let
41 * the code that selects certs and CRLs from the cached objects do its job,
42 * but it's a nice optimization when it can be applied (such as on an
43 * actual directory with a thousand CA certs).
45 if (criterion != NULL)
46 OSSL_STORE_find(ctx, criterion);
49 OSSL_STORE_INFO *info = OSSL_STORE_load(ctx);
52 /* NULL means error or "end of file". Either way, we break. */
56 infotype = OSSL_STORE_INFO_get_type(info);
59 if (infotype == OSSL_STORE_INFO_NAME) {
61 * This is an entry in the "directory" represented by the current
62 * uri. if |depth| allows, dive into it.
65 ok = cache_objects(lctx, OSSL_STORE_INFO_get0_NAME(info),
66 criterion, depth - 1);
69 * We know that X509_STORE_add_{cert|crl} increments the object's
70 * refcount, so we can safely use OSSL_STORE_INFO_get0_{cert,crl}
74 case OSSL_STORE_INFO_CERT:
75 ok = X509_STORE_add_cert(xstore,
76 OSSL_STORE_INFO_get0_CERT(info));
78 case OSSL_STORE_INFO_CRL:
79 ok = X509_STORE_add_crl(xstore,
80 OSSL_STORE_INFO_get0_CRL(info));
85 OSSL_STORE_INFO_free(info);
89 OSSL_STORE_close(ctx);
95 /* Because OPENSSL_free is a macro and for C type match */
96 static void free_uri(OPENSSL_STRING data)
101 static void by_store_free(X509_LOOKUP *ctx)
103 STACK_OF(OPENSSL_STRING) *uris = X509_LOOKUP_get_method_data(ctx);
104 sk_OPENSSL_STRING_pop_free(uris, free_uri);
107 static int by_store_ctrl(X509_LOOKUP *ctx, int cmd,
108 const char *argp, long argl,
112 case X509_L_ADD_STORE:
113 /* If no URI is given, use the default cert dir as default URI */
115 argp = ossl_safe_getenv(X509_get_default_cert_dir_env());
117 argp = X509_get_default_cert_dir();
120 STACK_OF(OPENSSL_STRING) *uris = X509_LOOKUP_get_method_data(ctx);
123 uris = sk_OPENSSL_STRING_new_null();
124 X509_LOOKUP_set_method_data(ctx, uris);
126 return sk_OPENSSL_STRING_push(uris, OPENSSL_strdup(argp)) > 0;
128 case X509_L_LOAD_STORE:
129 /* This is a shortcut for quick loading of specific containers */
130 return cache_objects(ctx, argp, NULL, 0);
136 static int by_store(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
137 const OSSL_STORE_SEARCH *criterion, X509_OBJECT *ret)
139 STACK_OF(OPENSSL_STRING) *uris = X509_LOOKUP_get_method_data(ctx);
143 for (i = 0; i < sk_OPENSSL_STRING_num(uris); i++) {
144 ok = cache_objects(ctx, sk_OPENSSL_STRING_value(uris, i), criterion,
153 static int by_store_subject(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
154 X509_NAME *name, X509_OBJECT *ret)
156 OSSL_STORE_SEARCH *criterion = OSSL_STORE_SEARCH_by_name(name);
157 int ok = by_store(ctx, type, criterion, ret);
158 STACK_OF(X509_OBJECT) *store_objects =
159 X509_STORE_get0_objects(X509_LOOKUP_get_store(ctx));
160 X509_OBJECT *tmp = NULL;
162 OSSL_STORE_SEARCH_free(criterion);
165 tmp = X509_OBJECT_retrieve_by_subject(store_objects, type, name);
170 * This could also be done like this:
177 * However, we want to exercise the documented API to the max, so
178 * we do it the hard way.
180 * To be noted is that X509_OBJECT_set1_* increment the refcount,
181 * but so does X509_STORE_CTX_get_by_subject upon return of this
182 * function, so we must ensure the the refcount is decremented
183 * before we return, or we will get a refcount leak. We cannot do
184 * this with X509_OBJECT_free(), though, as that will free a bit
189 ok = X509_OBJECT_set1_X509(ret, tmp->data.x509);
191 X509_free(tmp->data.x509);
194 ok = X509_OBJECT_set1_X509_CRL(ret, tmp->data.crl);
196 X509_CRL_free(tmp->data.crl);
206 * We lack the implementations for get_by_issuer_serial, get_by_fingerprint
207 * and get_by_alias. There's simply not enough support in the X509_LOOKUP
208 * or X509_STORE APIs.
211 static X509_LOOKUP_METHOD x509_store_lookup = {
212 "Load certs from STORE URIs",
214 by_store_free, /* free */
217 by_store_ctrl, /* ctrl */
218 by_store_subject, /* get_by_subject */
219 NULL, /* get_by_issuer_serial */
220 NULL, /* get_by_fingerprint */
221 NULL, /* get_by_alias */
224 X509_LOOKUP_METHOD *X509_LOOKUP_store(void)
226 return &x509_store_lookup;