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/crypto.h>
12 #include <openssl/core_dispatch.h>
13 #include <openssl/core_names.h>
14 #include <openssl/provider.h>
15 #include "internal/provider.h"
16 #include "internal/cryptlib.h"
18 DEFINE_STACK_OF(OSSL_PROVIDER)
20 struct child_prov_globals {
21 const OSSL_CORE_HANDLE *handle;
22 const OSSL_CORE_HANDLE *curr_prov;
23 unsigned int isinited:1;
25 OSSL_FUNC_core_get_libctx_fn *c_get_libctx;
26 OSSL_FUNC_provider_register_child_cb_fn *c_provider_register_child_cb;
27 OSSL_FUNC_provider_deregister_child_cb_fn *c_provider_deregister_child_cb;
28 OSSL_FUNC_provider_name_fn *c_prov_name;
29 OSSL_FUNC_provider_get0_provider_ctx_fn *c_prov_get0_provider_ctx;
30 OSSL_FUNC_provider_get0_dispatch_fn *c_prov_get0_dispatch;
31 OSSL_FUNC_provider_up_ref_fn *c_prov_up_ref;
32 OSSL_FUNC_provider_free_fn *c_prov_free;
35 static void *child_prov_ossl_ctx_new(OSSL_LIB_CTX *libctx)
37 return OPENSSL_zalloc(sizeof(struct child_prov_globals));
40 static void child_prov_ossl_ctx_free(void *vgbl)
42 struct child_prov_globals *gbl = vgbl;
44 gbl->c_provider_deregister_child_cb(gbl->handle);
45 CRYPTO_THREAD_lock_free(gbl->lock);
49 static const OSSL_LIB_CTX_METHOD child_prov_ossl_ctx_method = {
50 OSSL_LIB_CTX_METHOD_DEFAULT_PRIORITY,
51 child_prov_ossl_ctx_new,
52 child_prov_ossl_ctx_free,
55 static OSSL_provider_init_fn ossl_child_provider_init;
57 static int ossl_child_provider_init(const OSSL_CORE_HANDLE *handle,
58 const OSSL_DISPATCH *in,
59 const OSSL_DISPATCH **out,
62 OSSL_FUNC_core_get_libctx_fn *c_get_libctx = NULL;
64 struct child_prov_globals *gbl;
66 for (; in->function_id != 0; in++) {
67 switch (in->function_id) {
68 case OSSL_FUNC_CORE_GET_LIBCTX:
69 c_get_libctx = OSSL_FUNC_core_get_libctx(in);
72 /* Just ignore anything we don't understand */
77 if (c_get_libctx == NULL)
81 * We need an OSSL_LIB_CTX but c_get_libctx returns OPENSSL_CORE_CTX. We are
82 * a built-in provider and so we can get away with this cast. Normal
83 * providers can't do this.
85 ctx = (OSSL_LIB_CTX *)c_get_libctx(handle);
87 gbl = ossl_lib_ctx_get_data(ctx, OSSL_LIB_CTX_CHILD_PROVIDER_INDEX,
88 &child_prov_ossl_ctx_method);
92 *provctx = gbl->c_prov_get0_provider_ctx(gbl->curr_prov);
93 *out = gbl->c_prov_get0_dispatch(gbl->curr_prov);
98 static int provider_create_child_cb(const OSSL_CORE_HANDLE *prov, void *cbdata)
100 OSSL_LIB_CTX *ctx = cbdata;
101 struct child_prov_globals *gbl;
102 const char *provname;
103 OSSL_PROVIDER *cprov;
106 gbl = ossl_lib_ctx_get_data(ctx, OSSL_LIB_CTX_CHILD_PROVIDER_INDEX,
107 &child_prov_ossl_ctx_method);
112 * If !gbl->isinited, then we are still initing and we already hold the
113 * lock - so don't take it again.
115 if (gbl->isinited && !CRYPTO_THREAD_write_lock(gbl->lock))
118 provname = gbl->c_prov_name(prov);
121 * We're operating under a lock so we can store the "current" provider in
124 gbl->curr_prov = prov;
126 if ((cprov = ossl_provider_find(ctx, provname, 1)) != NULL) {
128 * We free the newly created ref. We rely on the provider sticking around
129 * in the provider store.
131 ossl_provider_free(cprov);
134 * The provider already exists. It could be an unused built-in, or a
135 * previously created child, or it could have been explicitly loaded. If
136 * explicitly loaded it cannot be converted to a child and we ignore it
137 * - i.e. we don't start treating it like a child.
139 if (!ossl_provider_convert_to_child(cprov, prov,
140 ossl_child_provider_init))
144 * Create it - passing 1 as final param so we don't try and recursively
147 if ((cprov = ossl_provider_new(ctx, provname, ossl_child_provider_init,
152 * We free the newly created ref. We rely on the provider sticking around
153 * in the provider store.
155 ossl_provider_free(cprov);
157 if (!ossl_provider_activate(cprov, 0, 0))
160 if (!ossl_provider_set_child(cprov, prov)) {
161 ossl_provider_deactivate(cprov);
169 CRYPTO_THREAD_unlock(gbl->lock);
173 static int provider_remove_child_cb(const OSSL_CORE_HANDLE *prov, void *cbdata)
175 OSSL_LIB_CTX *ctx = cbdata;
176 struct child_prov_globals *gbl;
177 const char *provname;
178 OSSL_PROVIDER *cprov;
180 gbl = ossl_lib_ctx_get_data(ctx, OSSL_LIB_CTX_CHILD_PROVIDER_INDEX,
181 &child_prov_ossl_ctx_method);
185 provname = gbl->c_prov_name(prov);
186 cprov = ossl_provider_find(ctx, provname, 1);
190 * ossl_provider_find ups the ref count, so we free it again here. We can
191 * rely on the provider store reference count.
193 ossl_provider_free(cprov);
194 if (ossl_provider_is_child(cprov)
195 && !ossl_provider_deactivate(cprov))
201 int ossl_provider_init_child_providers(OSSL_LIB_CTX *ctx)
203 struct child_prov_globals *gbl;
205 /* Should never happen */
209 gbl = ossl_lib_ctx_get_data(ctx, OSSL_LIB_CTX_CHILD_PROVIDER_INDEX,
210 &child_prov_ossl_ctx_method);
214 if (!CRYPTO_THREAD_read_lock(gbl->lock))
217 CRYPTO_THREAD_unlock(gbl->lock);
220 CRYPTO_THREAD_unlock(gbl->lock);
222 if (!CRYPTO_THREAD_write_lock(gbl->lock))
224 if (!gbl->isinited) {
225 if (!gbl->c_provider_register_child_cb(gbl->handle,
226 provider_create_child_cb,
227 provider_remove_child_cb,
229 CRYPTO_THREAD_unlock(gbl->lock);
234 CRYPTO_THREAD_unlock(gbl->lock);
239 int ossl_provider_init_as_child(OSSL_LIB_CTX *ctx,
240 const OSSL_CORE_HANDLE *handle,
241 const OSSL_DISPATCH *in)
243 struct child_prov_globals *gbl;
248 gbl = ossl_lib_ctx_get_data(ctx, OSSL_LIB_CTX_CHILD_PROVIDER_INDEX,
249 &child_prov_ossl_ctx_method);
253 gbl->handle = handle;
254 for (; in->function_id != 0; in++) {
255 switch (in->function_id) {
256 case OSSL_FUNC_CORE_GET_LIBCTX:
257 gbl->c_get_libctx = OSSL_FUNC_core_get_libctx(in);
259 case OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB:
260 gbl->c_provider_register_child_cb
261 = OSSL_FUNC_provider_register_child_cb(in);
263 case OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB:
264 gbl->c_provider_deregister_child_cb
265 = OSSL_FUNC_provider_deregister_child_cb(in);
267 case OSSL_FUNC_PROVIDER_NAME:
268 gbl->c_prov_name = OSSL_FUNC_provider_name(in);
270 case OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX:
271 gbl->c_prov_get0_provider_ctx
272 = OSSL_FUNC_provider_get0_provider_ctx(in);
274 case OSSL_FUNC_PROVIDER_GET0_DISPATCH:
275 gbl->c_prov_get0_dispatch = OSSL_FUNC_provider_get0_dispatch(in);
277 case OSSL_FUNC_PROVIDER_UP_REF:
279 = OSSL_FUNC_provider_up_ref(in);
281 case OSSL_FUNC_PROVIDER_FREE:
282 gbl->c_prov_free = OSSL_FUNC_provider_free(in);
285 /* Just ignore anything we don't understand */
290 if (gbl->c_get_libctx == NULL
291 || gbl->c_provider_register_child_cb == NULL
292 || gbl->c_prov_name == NULL
293 || gbl->c_prov_get0_provider_ctx == NULL
294 || gbl->c_prov_get0_dispatch == NULL
295 || gbl->c_prov_up_ref == NULL
296 || gbl->c_prov_free == NULL)
299 gbl->lock = CRYPTO_THREAD_lock_new();
300 if (gbl->lock == NULL)
306 int ossl_provider_up_ref_parent(OSSL_PROVIDER *prov, int activate)
308 struct child_prov_globals *gbl;
310 gbl = ossl_lib_ctx_get_data(ossl_provider_libctx(prov),
311 OSSL_LIB_CTX_CHILD_PROVIDER_INDEX,
312 &child_prov_ossl_ctx_method);
316 return gbl->c_prov_up_ref(ossl_provider_get_parent(prov), activate);
319 int ossl_provider_free_parent(OSSL_PROVIDER *prov, int deactivate)
321 struct child_prov_globals *gbl;
323 gbl = ossl_lib_ctx_get_data(ossl_provider_libctx(prov),
324 OSSL_LIB_CTX_CHILD_PROVIDER_INDEX,
325 &child_prov_ossl_ctx_method);
329 return gbl->c_prov_free(ossl_provider_get_parent(prov), deactivate);