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, '.');
68 * Parse the provider params section
71 * 0 for non-fatal errors
72 * < 0 for fatal errors
74 static int provider_conf_params_internal(OSSL_PROVIDER *prov,
75 OSSL_PROVIDER_INFO *provinfo,
76 const char *name, const char *value,
78 STACK_OF(OPENSSL_CSTRING) *visited)
80 STACK_OF(CONF_VALUE) *sect;
84 sect = NCONF_get_section(cnf, value);
88 size_t buffer_len = 0;
90 OSSL_TRACE1(CONF, "Provider params: start section %s\n", value);
93 * Check to see if the provided section value has already
94 * been visited. If it has, then we have a recursive lookup
95 * in the configuration which isn't valid. As such we should error
98 for (i = 0; i < sk_OPENSSL_CSTRING_num(visited); i++) {
99 if (sk_OPENSSL_CSTRING_value(visited, i) == value) {
100 ERR_raise(ERR_LIB_CONF, CONF_R_RECURSIVE_SECTION_REFERENCE);
106 * We've not visited this node yet, so record it on the stack
108 if (!sk_OPENSSL_CSTRING_push(visited, value))
112 OPENSSL_strlcpy(buffer, name, sizeof(buffer));
113 OPENSSL_strlcat(buffer, ".", sizeof(buffer));
114 buffer_len = strlen(buffer);
117 for (i = 0; i < sk_CONF_VALUE_num(sect); i++) {
118 CONF_VALUE *sectconf = sk_CONF_VALUE_value(sect, i);
120 if (buffer_len + strlen(sectconf->name) >= sizeof(buffer)) {
121 sk_OPENSSL_CSTRING_pop(visited);
124 buffer[buffer_len] = '\0';
125 OPENSSL_strlcat(buffer, sectconf->name, sizeof(buffer));
126 rc = provider_conf_params_internal(prov, provinfo, buffer,
127 sectconf->value, cnf, visited);
129 sk_OPENSSL_CSTRING_pop(visited);
133 sk_OPENSSL_CSTRING_pop(visited);
135 OSSL_TRACE1(CONF, "Provider params: finish section %s\n", value);
137 OSSL_TRACE2(CONF, "Provider params: %s = %s\n", name, value);
139 ok = ossl_provider_add_parameter(prov, name, value);
141 ok = ossl_provider_info_add_parameter(provinfo, name, value);
148 * recursively parse the provider configuration section
149 * of the config file.
152 * 0 on non-fatal error
153 * < 0 on fatal errors
155 static int provider_conf_params(OSSL_PROVIDER *prov,
156 OSSL_PROVIDER_INFO *provinfo,
157 const char *name, const char *value,
161 STACK_OF(OPENSSL_CSTRING) *visited = sk_OPENSSL_CSTRING_new_null();
166 rc = provider_conf_params_internal(prov, provinfo, name,
167 value, cnf, visited);
169 sk_OPENSSL_CSTRING_free(visited);
174 static int prov_already_activated(const char *name,
175 STACK_OF(OSSL_PROVIDER) *activated)
179 if (activated == NULL)
182 max = sk_OSSL_PROVIDER_num(activated);
183 for (i = 0; i < max; i++) {
184 OSSL_PROVIDER *tstprov = sk_OSSL_PROVIDER_value(activated, i);
186 if (strcmp(OSSL_PROVIDER_get0_name(tstprov), name) == 0) {
195 * Attempt to activate a provider
197 * 1 on successful activation
198 * 0 on failed activation for non-fatal error
199 * < 0 on failed activation for fatal errors
201 static int provider_conf_activate(OSSL_LIB_CTX *libctx, const char *name,
202 const char *value, const char *path,
203 int soft, const CONF *cnf)
205 PROVIDER_CONF_GLOBAL *pcgbl
206 = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_PROVIDER_CONF_INDEX);
207 OSSL_PROVIDER *prov = NULL, *actual = NULL;
210 if (pcgbl == NULL || !CRYPTO_THREAD_write_lock(pcgbl->lock)) {
211 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
214 if (!prov_already_activated(name, pcgbl->activated_providers)) {
216 * There is an attempt to activate a provider, so we should disable
217 * loading of fallbacks. Otherwise a misconfiguration could mean the
218 * intended provider does not get loaded. Subsequent fetches could
219 * then fallback to the default provider - which may be the wrong
222 if (!ossl_provider_disable_fallback_loading(libctx)) {
223 CRYPTO_THREAD_unlock(pcgbl->lock);
224 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
227 prov = ossl_provider_find(libctx, name, 1);
229 prov = ossl_provider_new(libctx, name, NULL, 1);
231 CRYPTO_THREAD_unlock(pcgbl->lock);
234 return (soft == 0) ? -1 : 0;
238 ossl_provider_set_module_path(prov, path);
240 ok = provider_conf_params(prov, NULL, NULL, value, cnf);
243 if (!ossl_provider_activate(prov, 1, 0)) {
245 } else if (!ossl_provider_add_to_store(prov, &actual, 0)) {
246 ossl_provider_deactivate(prov, 1);
248 } else if (actual != prov
249 && !ossl_provider_activate(actual, 1, 0)) {
250 ossl_provider_free(actual);
253 if (pcgbl->activated_providers == NULL)
254 pcgbl->activated_providers = sk_OSSL_PROVIDER_new_null();
255 if (pcgbl->activated_providers == NULL
256 || !sk_OSSL_PROVIDER_push(pcgbl->activated_providers,
258 ossl_provider_deactivate(actual, 1);
259 ossl_provider_free(actual);
268 ossl_provider_free(prov);
270 CRYPTO_THREAD_unlock(pcgbl->lock);
275 static int provider_conf_load(OSSL_LIB_CTX *libctx, const char *name,
276 const char *value, const CONF *cnf)
279 STACK_OF(CONF_VALUE) *ecmds;
281 const char *path = NULL;
286 name = skip_dot(name);
287 OSSL_TRACE1(CONF, "Configuring provider %s\n", name);
288 /* Value is a section containing PROVIDER commands */
289 ecmds = NCONF_get_section(cnf, value);
292 ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_SECTION_ERROR,
293 "section=%s not found", value);
297 /* Find the needed data first */
298 for (i = 0; i < sk_CONF_VALUE_num(ecmds); i++) {
299 CONF_VALUE *ecmd = sk_CONF_VALUE_value(ecmds, i);
300 const char *confname = skip_dot(ecmd->name);
301 const char *confvalue = ecmd->value;
303 OSSL_TRACE2(CONF, "Provider command: %s = %s\n",
304 confname, confvalue);
306 /* First handle some special pseudo confs */
308 /* Override provider name to use */
309 if (strcmp(confname, "identity") == 0)
311 else if (strcmp(confname, "soft_load") == 0)
313 /* Load a dynamic PROVIDER */
314 else if (strcmp(confname, "module") == 0)
316 else if (strcmp(confname, "activate") == 0)
321 ok = provider_conf_activate(libctx, name, value, path, soft, cnf);
323 OSSL_PROVIDER_INFO entry;
325 memset(&entry, 0, sizeof(entry));
328 entry.name = OPENSSL_strdup(name);
329 if (entry.name == NULL) {
330 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
334 if (ok && path != NULL) {
335 entry.path = OPENSSL_strdup(path);
336 if (entry.path == NULL) {
337 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
342 ok = provider_conf_params(NULL, &entry, NULL, value, cnf);
343 if (ok >= 1 && (entry.path != NULL || entry.parameters != NULL)) {
344 ok = ossl_provider_info_add_to_store(libctx, &entry);
348 ossl_provider_info_clear(&entry);
352 * Provider activation returns a tristate:
353 * 1 for successful activation
354 * 0 for non-fatal activation failure
355 * < 0 for fatal activation failure
356 * We return success (1) for activation, (1) for non-fatal activation
357 * failure, and (0) for fatal activation failure
362 static int provider_conf_init(CONF_IMODULE *md, const CONF *cnf)
364 STACK_OF(CONF_VALUE) *elist;
368 OSSL_TRACE1(CONF, "Loading providers module: section %s\n",
369 CONF_imodule_get_value(md));
371 /* Value is a section containing PROVIDERs to configure */
372 elist = NCONF_get_section(cnf, CONF_imodule_get_value(md));
375 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_SECTION_ERROR);
379 for (i = 0; i < sk_CONF_VALUE_num(elist); i++) {
380 cval = sk_CONF_VALUE_value(elist, i);
381 if (!provider_conf_load(NCONF_get0_libctx((CONF *)cnf),
382 cval->name, cval->value, cnf))
389 void ossl_provider_add_conf_module(void)
391 OSSL_TRACE(CONF, "Adding config module 'providers'\n");
392 CONF_module_add("providers", provider_conf_init, NULL);