2 * Copyright 2019-2022 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
11 #include <openssl/trace.h>
12 #include <openssl/err.h>
13 #include <openssl/conf.h>
14 #include <openssl/safestack.h>
15 #include <openssl/provider.h>
16 #include "internal/provider.h"
17 #include "internal/cryptlib.h"
18 #include "provider_local.h"
19 #include "crypto/context.h"
21 DEFINE_STACK_OF(OSSL_PROVIDER)
23 /* PROVIDER config module */
27 STACK_OF(OSSL_PROVIDER) *activated_providers;
28 } PROVIDER_CONF_GLOBAL;
30 void *ossl_prov_conf_ctx_new(OSSL_LIB_CTX *libctx)
32 PROVIDER_CONF_GLOBAL *pcgbl = OPENSSL_zalloc(sizeof(*pcgbl));
37 pcgbl->lock = CRYPTO_THREAD_lock_new();
38 if (pcgbl->lock == NULL) {
46 void ossl_prov_conf_ctx_free(void *vpcgbl)
48 PROVIDER_CONF_GLOBAL *pcgbl = vpcgbl;
50 sk_OSSL_PROVIDER_pop_free(pcgbl->activated_providers,
53 OSSL_TRACE(CONF, "Cleaned up providers\n");
54 CRYPTO_THREAD_lock_free(pcgbl->lock);
58 static const char *skip_dot(const char *name)
60 const char *p = strchr(name, '.');
67 static int provider_conf_params(OSSL_PROVIDER *prov,
68 OSSL_PROVIDER_INFO *provinfo,
69 const char *name, const char *value,
72 STACK_OF(CONF_VALUE) *sect;
75 sect = NCONF_get_section(cnf, value);
79 size_t buffer_len = 0;
81 OSSL_TRACE1(CONF, "Provider params: start section %s\n", value);
84 OPENSSL_strlcpy(buffer, name, sizeof(buffer));
85 OPENSSL_strlcat(buffer, ".", sizeof(buffer));
86 buffer_len = strlen(buffer);
89 for (i = 0; i < sk_CONF_VALUE_num(sect); i++) {
90 CONF_VALUE *sectconf = sk_CONF_VALUE_value(sect, i);
92 if (buffer_len + strlen(sectconf->name) >= sizeof(buffer))
94 buffer[buffer_len] = '\0';
95 OPENSSL_strlcat(buffer, sectconf->name, sizeof(buffer));
96 if (!provider_conf_params(prov, provinfo, buffer, sectconf->value,
101 OSSL_TRACE1(CONF, "Provider params: finish section %s\n", value);
103 OSSL_TRACE2(CONF, "Provider params: %s = %s\n", name, value);
105 ok = ossl_provider_add_parameter(prov, name, value);
107 ok = ossl_provider_info_add_parameter(provinfo, name, value);
113 static int prov_already_activated(const char *name,
114 STACK_OF(OSSL_PROVIDER) *activated)
118 if (activated == NULL)
121 max = sk_OSSL_PROVIDER_num(activated);
122 for (i = 0; i < max; i++) {
123 OSSL_PROVIDER *tstprov = sk_OSSL_PROVIDER_value(activated, i);
125 if (strcmp(OSSL_PROVIDER_get0_name(tstprov), name) == 0) {
133 static int provider_conf_activate(OSSL_LIB_CTX *libctx, const char *name,
134 const char *value, const char *path,
135 int soft, const CONF *cnf)
137 PROVIDER_CONF_GLOBAL *pcgbl
138 = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_PROVIDER_CONF_INDEX);
139 OSSL_PROVIDER *prov = NULL, *actual = NULL;
142 if (pcgbl == NULL || !CRYPTO_THREAD_write_lock(pcgbl->lock)) {
143 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
146 if (!prov_already_activated(name, pcgbl->activated_providers)) {
148 * There is an attempt to activate a provider, so we should disable
149 * loading of fallbacks. Otherwise a misconfiguration could mean the
150 * intended provider does not get loaded. Subsequent fetches could
151 * then fallback to the default provider - which may be the wrong
154 if (!ossl_provider_disable_fallback_loading(libctx)) {
155 CRYPTO_THREAD_unlock(pcgbl->lock);
156 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
159 prov = ossl_provider_find(libctx, name, 1);
161 prov = ossl_provider_new(libctx, name, NULL, 1);
163 CRYPTO_THREAD_unlock(pcgbl->lock);
170 ossl_provider_set_module_path(prov, path);
172 ok = provider_conf_params(prov, NULL, NULL, value, cnf);
175 if (!ossl_provider_activate(prov, 1, 0)) {
177 } else if (!ossl_provider_add_to_store(prov, &actual, 0)) {
178 ossl_provider_deactivate(prov, 1);
180 } else if (actual != prov
181 && !ossl_provider_activate(actual, 1, 0)) {
182 ossl_provider_free(actual);
185 if (pcgbl->activated_providers == NULL)
186 pcgbl->activated_providers = sk_OSSL_PROVIDER_new_null();
187 if (pcgbl->activated_providers == NULL
188 || !sk_OSSL_PROVIDER_push(pcgbl->activated_providers,
190 ossl_provider_deactivate(actual, 1);
191 ossl_provider_free(actual);
199 ossl_provider_free(prov);
201 CRYPTO_THREAD_unlock(pcgbl->lock);
206 static int provider_conf_load(OSSL_LIB_CTX *libctx, const char *name,
207 const char *value, const CONF *cnf)
210 STACK_OF(CONF_VALUE) *ecmds;
212 const char *path = NULL;
216 name = skip_dot(name);
217 OSSL_TRACE1(CONF, "Configuring provider %s\n", name);
218 /* Value is a section containing PROVIDER commands */
219 ecmds = NCONF_get_section(cnf, value);
222 ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_SECTION_ERROR,
223 "section=%s not found", value);
227 /* Find the needed data first */
228 for (i = 0; i < sk_CONF_VALUE_num(ecmds); i++) {
229 CONF_VALUE *ecmd = sk_CONF_VALUE_value(ecmds, i);
230 const char *confname = skip_dot(ecmd->name);
231 const char *confvalue = ecmd->value;
233 OSSL_TRACE2(CONF, "Provider command: %s = %s\n",
234 confname, confvalue);
236 /* First handle some special pseudo confs */
238 /* Override provider name to use */
239 if (strcmp(confname, "identity") == 0)
241 else if (strcmp(confname, "soft_load") == 0)
243 /* Load a dynamic PROVIDER */
244 else if (strcmp(confname, "module") == 0)
246 else if (strcmp(confname, "activate") == 0)
251 ok = provider_conf_activate(libctx, name, value, path, soft, cnf);
253 OSSL_PROVIDER_INFO entry;
255 memset(&entry, 0, sizeof(entry));
258 entry.name = OPENSSL_strdup(name);
259 if (entry.name == NULL)
262 if (ok && path != NULL) {
263 entry.path = OPENSSL_strdup(path);
264 if (entry.path == NULL)
268 ok = provider_conf_params(NULL, &entry, NULL, value, cnf);
269 if (ok && (entry.path != NULL || entry.parameters != NULL))
270 ok = ossl_provider_info_add_to_store(libctx, &entry);
271 if (!ok || (entry.path == NULL && entry.parameters == NULL)) {
272 ossl_provider_info_clear(&entry);
278 * Even if ok is 0, we still return success. Failure to load a provider is
279 * not fatal. We want to continue to load the rest of the config file.
284 static int provider_conf_init(CONF_IMODULE *md, const CONF *cnf)
286 STACK_OF(CONF_VALUE) *elist;
290 OSSL_TRACE1(CONF, "Loading providers module: section %s\n",
291 CONF_imodule_get_value(md));
293 /* Value is a section containing PROVIDERs to configure */
294 elist = NCONF_get_section(cnf, CONF_imodule_get_value(md));
297 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_SECTION_ERROR);
301 for (i = 0; i < sk_CONF_VALUE_num(elist); i++) {
302 cval = sk_CONF_VALUE_value(elist, i);
303 if (!provider_conf_load(NCONF_get0_libctx((CONF *)cnf),
304 cval->name, cval->value, cnf))
311 void ossl_provider_add_conf_module(void)
313 OSSL_TRACE(CONF, "Adding config module 'providers'\n");
314 CONF_module_add("providers", provider_conf_init, NULL);