2 * Copyright 2019-2021 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"
20 DEFINE_STACK_OF(OSSL_PROVIDER
)
22 /* PROVIDER config module */
26 STACK_OF(OSSL_PROVIDER
) *activated_providers
;
27 } PROVIDER_CONF_GLOBAL
;
29 static void *prov_conf_ossl_ctx_new(OSSL_LIB_CTX
*libctx
)
31 PROVIDER_CONF_GLOBAL
*pcgbl
= OPENSSL_zalloc(sizeof(*pcgbl
));
36 pcgbl
->lock
= CRYPTO_THREAD_lock_new();
37 if (pcgbl
->lock
== NULL
) {
45 static void prov_conf_ossl_ctx_free(void *vpcgbl
)
47 PROVIDER_CONF_GLOBAL
*pcgbl
= vpcgbl
;
49 sk_OSSL_PROVIDER_pop_free(pcgbl
->activated_providers
,
52 OSSL_TRACE(CONF
, "Cleaned up providers\n");
53 CRYPTO_THREAD_lock_free(pcgbl
->lock
);
57 static const OSSL_LIB_CTX_METHOD provider_conf_ossl_ctx_method
= {
58 /* Must be freed before the provider store is freed */
59 OSSL_LIB_CTX_METHOD_PRIORITY_2
,
60 prov_conf_ossl_ctx_new
,
61 prov_conf_ossl_ctx_free
,
64 static const char *skip_dot(const char *name
)
66 const char *p
= strchr(name
, '.');
73 static int provider_conf_params(OSSL_PROVIDER
*prov
,
74 OSSL_PROVIDER_INFO
*provinfo
,
75 const char *name
, const char *value
,
78 STACK_OF(CONF_VALUE
) *sect
;
81 sect
= NCONF_get_section(cnf
, value
);
85 size_t buffer_len
= 0;
87 OSSL_TRACE1(CONF
, "Provider params: start section %s\n", value
);
90 OPENSSL_strlcpy(buffer
, name
, sizeof(buffer
));
91 OPENSSL_strlcat(buffer
, ".", sizeof(buffer
));
92 buffer_len
= strlen(buffer
);
95 for (i
= 0; i
< sk_CONF_VALUE_num(sect
); i
++) {
96 CONF_VALUE
*sectconf
= sk_CONF_VALUE_value(sect
, i
);
98 if (buffer_len
+ strlen(sectconf
->name
) >= sizeof(buffer
))
100 buffer
[buffer_len
] = '\0';
101 OPENSSL_strlcat(buffer
, sectconf
->name
, sizeof(buffer
));
102 if (!provider_conf_params(prov
, provinfo
, buffer
, sectconf
->value
,
107 OSSL_TRACE1(CONF
, "Provider params: finish section %s\n", value
);
109 OSSL_TRACE2(CONF
, "Provider params: %s = %s\n", name
, value
);
111 ok
= ossl_provider_add_parameter(prov
, name
, value
);
113 ok
= ossl_provider_info_add_parameter(provinfo
, name
, value
);
119 static int prov_already_activated(const char *name
,
120 STACK_OF(OSSL_PROVIDER
) *activated
)
124 if (activated
== NULL
)
127 max
= sk_OSSL_PROVIDER_num(activated
);
128 for (i
= 0; i
< max
; i
++) {
129 OSSL_PROVIDER
*tstprov
= sk_OSSL_PROVIDER_value(activated
, i
);
131 if (strcmp(OSSL_PROVIDER_get0_name(tstprov
), name
) == 0) {
139 static int provider_conf_activate(OSSL_LIB_CTX
*libctx
, const char *name
,
140 const char *value
, const char *path
,
141 int soft
, const CONF
*cnf
)
143 PROVIDER_CONF_GLOBAL
*pcgbl
144 = ossl_lib_ctx_get_data(libctx
, OSSL_LIB_CTX_PROVIDER_CONF_INDEX
,
145 &provider_conf_ossl_ctx_method
);
146 OSSL_PROVIDER
*prov
= NULL
, *actual
= NULL
;
149 if (pcgbl
== NULL
|| !CRYPTO_THREAD_write_lock(pcgbl
->lock
)) {
150 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_INTERNAL_ERROR
);
153 if (!prov_already_activated(name
, pcgbl
->activated_providers
)) {
155 * There is an attempt to activate a provider, so we should disable
156 * loading of fallbacks. Otherwise a misconfiguration could mean the
157 * intended provider does not get loaded. Subsequent fetches could
158 * then fallback to the default provider - which may be the wrong
161 if (!ossl_provider_disable_fallback_loading(libctx
)) {
162 CRYPTO_THREAD_unlock(pcgbl
->lock
);
163 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_INTERNAL_ERROR
);
166 prov
= ossl_provider_find(libctx
, name
, 1);
168 prov
= ossl_provider_new(libctx
, name
, NULL
, 1);
170 CRYPTO_THREAD_unlock(pcgbl
->lock
);
177 ossl_provider_set_module_path(prov
, path
);
179 ok
= provider_conf_params(prov
, NULL
, NULL
, value
, cnf
);
182 if (!ossl_provider_activate(prov
, 1, 0)) {
184 } else if (!ossl_provider_add_to_store(prov
, &actual
, 0)) {
185 ossl_provider_deactivate(prov
, 1);
187 } else if (actual
!= prov
188 && !ossl_provider_activate(actual
, 1, 0)) {
189 ossl_provider_free(actual
);
192 if (pcgbl
->activated_providers
== NULL
)
193 pcgbl
->activated_providers
= sk_OSSL_PROVIDER_new_null();
194 if (pcgbl
->activated_providers
== NULL
195 || !sk_OSSL_PROVIDER_push(pcgbl
->activated_providers
,
197 ossl_provider_deactivate(actual
, 1);
198 ossl_provider_free(actual
);
206 ossl_provider_free(prov
);
208 CRYPTO_THREAD_unlock(pcgbl
->lock
);
213 static int provider_conf_load(OSSL_LIB_CTX
*libctx
, const char *name
,
214 const char *value
, const CONF
*cnf
)
217 STACK_OF(CONF_VALUE
) *ecmds
;
219 const char *path
= NULL
;
223 name
= skip_dot(name
);
224 OSSL_TRACE1(CONF
, "Configuring provider %s\n", name
);
225 /* Value is a section containing PROVIDER commands */
226 ecmds
= NCONF_get_section(cnf
, value
);
229 ERR_raise_data(ERR_LIB_CRYPTO
, CRYPTO_R_PROVIDER_SECTION_ERROR
,
230 "section=%s not found", value
);
234 /* Find the needed data first */
235 for (i
= 0; i
< sk_CONF_VALUE_num(ecmds
); i
++) {
236 CONF_VALUE
*ecmd
= sk_CONF_VALUE_value(ecmds
, i
);
237 const char *confname
= skip_dot(ecmd
->name
);
238 const char *confvalue
= ecmd
->value
;
240 OSSL_TRACE2(CONF
, "Provider command: %s = %s\n",
241 confname
, confvalue
);
243 /* First handle some special pseudo confs */
245 /* Override provider name to use */
246 if (strcmp(confname
, "identity") == 0)
248 else if (strcmp(confname
, "soft_load") == 0)
250 /* Load a dynamic PROVIDER */
251 else if (strcmp(confname
, "module") == 0)
253 else if (strcmp(confname
, "activate") == 0)
258 ok
= provider_conf_activate(libctx
, name
, value
, path
, soft
, cnf
);
260 OSSL_PROVIDER_INFO entry
;
262 memset(&entry
, 0, sizeof(entry
));
265 entry
.name
= OPENSSL_strdup(name
);
266 if (entry
.name
== NULL
) {
267 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_MALLOC_FAILURE
);
271 if (ok
&& path
!= NULL
) {
272 entry
.path
= OPENSSL_strdup(path
);
273 if (entry
.path
== NULL
) {
274 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_MALLOC_FAILURE
);
279 ok
= provider_conf_params(NULL
, &entry
, NULL
, value
, cnf
);
280 if (ok
&& (entry
.path
!= NULL
|| entry
.parameters
!= NULL
))
281 ok
= ossl_provider_info_add_to_store(libctx
, &entry
);
282 if (!ok
|| (entry
.path
== NULL
&& entry
.parameters
== NULL
)) {
283 ossl_provider_info_clear(&entry
);
289 * Even if ok is 0, we still return success. Failure to load a provider is
290 * not fatal. We want to continue to load the rest of the config file.
295 static int provider_conf_init(CONF_IMODULE
*md
, const CONF
*cnf
)
297 STACK_OF(CONF_VALUE
) *elist
;
301 OSSL_TRACE1(CONF
, "Loading providers module: section %s\n",
302 CONF_imodule_get_value(md
));
304 /* Value is a section containing PROVIDERs to configure */
305 elist
= NCONF_get_section(cnf
, CONF_imodule_get_value(md
));
308 ERR_raise(ERR_LIB_CRYPTO
, CRYPTO_R_PROVIDER_SECTION_ERROR
);
312 for (i
= 0; i
< sk_CONF_VALUE_num(elist
); i
++) {
313 cval
= sk_CONF_VALUE_value(elist
, i
);
314 if (!provider_conf_load(NCONF_get0_libctx((CONF
*)cnf
),
315 cval
->name
, cval
->value
, cnf
))
322 void ossl_provider_add_conf_module(void)
324 OSSL_TRACE(CONF
, "Adding config module 'providers'\n");
325 CONF_module_add("providers", provider_conf_init
, NULL
);