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/core.h>
12 #include <openssl/core_dispatch.h>
13 #include <openssl/core_names.h>
14 #include <openssl/provider.h>
15 #include <openssl/params.h>
16 #include <openssl/opensslv.h>
17 #include "crypto/cryptlib.h"
18 #include "crypto/evp.h" /* evp_method_store_flush */
19 #include "crypto/rand.h"
20 #include "internal/nelem.h"
21 #include "internal/thread_once.h"
22 #include "internal/provider.h"
23 #include "internal/refcount.h"
24 #include "internal/bio.h"
25 #include "internal/core.h"
26 #include "provider_local.h"
28 # include <openssl/self_test.h>
32 * This file defines and uses a number of different structures:
34 * OSSL_PROVIDER (provider_st): Used to represent all information related to a
35 * single instance of a provider.
37 * provider_store_st: Holds information about the collection of providers that
38 * are available within the current library context (OSSL_LIB_CTX). It also
39 * holds configuration information about providers that could be loaded at some
42 * OSSL_PROVIDER_CHILD_CB: An instance of this structure holds the callbacks
43 * that have been registered for a child library context and the associated
44 * provider that registered those callbacks.
46 * Where a child library context exists then it has its own instance of the
47 * provider store. Each provider that exists in the parent provider store, has
48 * an associated child provider in the child library context's provider store.
49 * As providers get activated or deactivated this needs to be mirrored in the
50 * associated child providers.
55 * There are a number of different locks used in this file and it is important
56 * to understand how they should be used in order to avoid deadlocks.
58 * Fields within a structure can often be "write once" on creation, and then
59 * "read many". Creation of a structure is done by a single thread, and
60 * therefore no lock is required for the "write once/read many" fields. It is
61 * safe for multiple threads to read these fields without a lock, because they
62 * will never be changed.
64 * However some fields may be changed after a structure has been created and
65 * shared between multiple threads. Where this is the case a lock is required.
67 * The locks available are:
69 * The provider flag_lock: Used to control updates to the various provider
70 * "flags" (flag_initialized and flag_activated) and associated
71 * "counts" (activatecnt).
73 * The provider refcnt_lock: Only ever used to control updates to the provider
76 * The provider optbits_lock: Used to control access to the provider's
77 * operation_bits and operation_bits_sz fields.
79 * The store default_path_lock: Used to control access to the provider store's
80 * default search path value (default_path)
82 * The store lock: Used to control the stack of provider's held within the
83 * provider store, as well as the stack of registered child provider callbacks.
85 * As a general rule-of-thumb it is best to:
86 * - keep the scope of the code that is protected by a lock to the absolute
88 * - try to keep the scope of the lock to within a single function (i.e. avoid
89 * making calls to other functions while holding a lock);
90 * - try to only ever hold one lock at a time.
92 * Unfortunately, it is not always possible to stick to the above guidelines.
93 * Where they are not adhered to there is always a danger of inadvertently
94 * introducing the possibility of deadlock. The following rules MUST be adhered
95 * to in order to avoid that:
96 * - Holding multiple locks at the same time is only allowed for the
97 * provider store lock, the provider flag_lock and the provider refcnt_lock.
98 * - When holding multiple locks they must be acquired in the following order of
100 * 1) provider store lock
101 * 2) provider flag_lock
102 * 3) provider refcnt_lock
103 * - When releasing locks they must be released in the reverse order to which
105 * - No locks may be held when making an upcall. NOTE: Some common functions
106 * can make upcalls as part of their normal operation. If you need to call
107 * some other function while holding a lock make sure you know whether it
108 * will make any upcalls or not. For example ossl_provider_up_ref() can call
109 * ossl_provider_up_ref_parent() which can call the c_prov_up_ref() upcall.
110 * - It is permissible to hold the store and flag locks when calling child
111 * provider callbacks. No other locks may be held during such callbacks.
114 static OSSL_PROVIDER *provider_new(const char *name,
115 OSSL_provider_init_fn *init_function,
116 STACK_OF(INFOPAIR) *parameters);
119 * Provider Object structure
120 * =========================
126 int (*create_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata);
127 int (*remove_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata);
128 int (*global_props_cb)(const char *props, void *cbdata);
130 } OSSL_PROVIDER_CHILD_CB;
131 DEFINE_STACK_OF(OSSL_PROVIDER_CHILD_CB)
134 struct provider_store_st; /* Forward declaration */
136 struct ossl_provider_st {
138 unsigned int flag_initialized:1;
139 unsigned int flag_activated:1;
141 /* Getting and setting the flags require synchronization */
142 CRYPTO_RWLOCK *flag_lock;
144 /* OpenSSL library side data */
145 CRYPTO_REF_COUNT refcnt;
146 CRYPTO_RWLOCK *refcnt_lock; /* For the ref counter */
151 OSSL_provider_init_fn *init_function;
152 STACK_OF(INFOPAIR) *parameters;
153 OSSL_LIB_CTX *libctx; /* The library context this instance is in */
154 struct provider_store_st *store; /* The store this instance belongs to */
157 * In the FIPS module inner provider, this isn't needed, since the
158 * error upcalls are always direct calls to the outer provider.
160 int error_lib; /* ERR library number, one for each provider */
161 # ifndef OPENSSL_NO_ERR
162 ERR_STRING_DATA *error_strings; /* Copy of what the provider gives us */
166 /* Provider side functions */
167 OSSL_FUNC_provider_teardown_fn *teardown;
168 OSSL_FUNC_provider_gettable_params_fn *gettable_params;
169 OSSL_FUNC_provider_get_params_fn *get_params;
170 OSSL_FUNC_provider_get_capabilities_fn *get_capabilities;
171 OSSL_FUNC_provider_self_test_fn *self_test;
172 OSSL_FUNC_provider_query_operation_fn *query_operation;
173 OSSL_FUNC_provider_unquery_operation_fn *unquery_operation;
176 * Cache of bit to indicate of query_operation() has been called on
177 * a specific operation or not.
179 unsigned char *operation_bits;
180 size_t operation_bits_sz;
181 CRYPTO_RWLOCK *opbits_lock;
184 /* Whether this provider is the child of some other provider */
185 const OSSL_CORE_HANDLE *handle;
186 unsigned int ischild:1;
189 /* Provider side data */
191 const OSSL_DISPATCH *dispatch;
193 DEFINE_STACK_OF(OSSL_PROVIDER)
195 static int ossl_provider_cmp(const OSSL_PROVIDER * const *a,
196 const OSSL_PROVIDER * const *b)
198 return strcmp((*a)->name, (*b)->name);
202 * Provider Object store
203 * =====================
205 * The Provider Object store is a library context object, and therefore needs
209 struct provider_store_st {
210 OSSL_LIB_CTX *libctx;
211 STACK_OF(OSSL_PROVIDER) *providers;
212 STACK_OF(OSSL_PROVIDER_CHILD_CB) *child_cbs;
213 CRYPTO_RWLOCK *default_path_lock;
216 OSSL_PROVIDER_INFO *provinfo;
219 unsigned int use_fallbacks:1;
220 unsigned int freeing:1;
224 * provider_deactivate_free() is a wrapper around ossl_provider_deactivate()
225 * and ossl_provider_free(), called as needed.
226 * Since this is only called when the provider store is being emptied, we
227 * don't need to care about any lock.
229 static void provider_deactivate_free(OSSL_PROVIDER *prov)
231 if (prov->flag_activated)
232 ossl_provider_deactivate(prov, 1);
233 ossl_provider_free(prov);
237 static void ossl_provider_child_cb_free(OSSL_PROVIDER_CHILD_CB *cb)
243 static void infopair_free(INFOPAIR *pair)
245 OPENSSL_free(pair->name);
246 OPENSSL_free(pair->value);
250 static INFOPAIR *infopair_copy(const INFOPAIR *src)
252 INFOPAIR *dest = OPENSSL_zalloc(sizeof(*dest));
256 if (src->name != NULL) {
257 dest->name = OPENSSL_strdup(src->name);
258 if (dest->name == NULL)
261 if (src->value != NULL) {
262 dest->value = OPENSSL_strdup(src->value);
263 if (dest->value == NULL)
268 OPENSSL_free(dest->name);
273 void ossl_provider_info_clear(OSSL_PROVIDER_INFO *info)
275 OPENSSL_free(info->name);
276 OPENSSL_free(info->path);
277 sk_INFOPAIR_pop_free(info->parameters, infopair_free);
280 static void provider_store_free(void *vstore)
282 struct provider_store_st *store = vstore;
288 OPENSSL_free(store->default_path);
289 sk_OSSL_PROVIDER_pop_free(store->providers, provider_deactivate_free);
291 sk_OSSL_PROVIDER_CHILD_CB_pop_free(store->child_cbs,
292 ossl_provider_child_cb_free);
294 CRYPTO_THREAD_lock_free(store->default_path_lock);
295 CRYPTO_THREAD_lock_free(store->lock);
296 for (i = 0; i < store->numprovinfo; i++)
297 ossl_provider_info_clear(&store->provinfo[i]);
298 OPENSSL_free(store->provinfo);
302 static void *provider_store_new(OSSL_LIB_CTX *ctx)
304 struct provider_store_st *store = OPENSSL_zalloc(sizeof(*store));
307 || (store->providers = sk_OSSL_PROVIDER_new(ossl_provider_cmp)) == NULL
308 || (store->default_path_lock = CRYPTO_THREAD_lock_new()) == NULL
310 || (store->child_cbs = sk_OSSL_PROVIDER_CHILD_CB_new_null()) == NULL
312 || (store->lock = CRYPTO_THREAD_lock_new()) == NULL) {
313 provider_store_free(store);
317 store->use_fallbacks = 1;
322 static const OSSL_LIB_CTX_METHOD provider_store_method = {
323 /* Needs to be freed before the child provider data is freed */
324 OSSL_LIB_CTX_METHOD_PRIORITY_1,
329 static struct provider_store_st *get_provider_store(OSSL_LIB_CTX *libctx)
331 struct provider_store_st *store = NULL;
333 store = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_PROVIDER_STORE_INDEX,
334 &provider_store_method);
336 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
340 int ossl_provider_disable_fallback_loading(OSSL_LIB_CTX *libctx)
342 struct provider_store_st *store;
344 if ((store = get_provider_store(libctx)) != NULL) {
345 if (!CRYPTO_THREAD_write_lock(store->lock))
347 store->use_fallbacks = 0;
348 CRYPTO_THREAD_unlock(store->lock);
354 #define BUILTINS_BLOCK_SIZE 10
356 int ossl_provider_info_add_to_store(OSSL_LIB_CTX *libctx,
357 OSSL_PROVIDER_INFO *entry)
359 struct provider_store_st *store = get_provider_store(libctx);
362 if (entry->name == NULL) {
363 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
368 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
372 if (!CRYPTO_THREAD_write_lock(store->lock))
374 if (store->provinfosz == 0) {
375 store->provinfo = OPENSSL_zalloc(sizeof(*store->provinfo)
376 * BUILTINS_BLOCK_SIZE);
377 if (store->provinfo == NULL) {
378 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
381 store->provinfosz = BUILTINS_BLOCK_SIZE;
382 } else if (store->numprovinfo == store->provinfosz) {
383 OSSL_PROVIDER_INFO *tmpbuiltins;
384 size_t newsz = store->provinfosz + BUILTINS_BLOCK_SIZE;
386 tmpbuiltins = OPENSSL_realloc(store->provinfo,
387 sizeof(*store->provinfo) * newsz);
388 if (tmpbuiltins == NULL) {
389 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
392 store->provinfo = tmpbuiltins;
393 store->provinfosz = newsz;
395 store->provinfo[store->numprovinfo] = *entry;
396 store->numprovinfo++;
400 CRYPTO_THREAD_unlock(store->lock);
404 OSSL_PROVIDER *ossl_provider_find(OSSL_LIB_CTX *libctx, const char *name,
407 struct provider_store_st *store = NULL;
408 OSSL_PROVIDER *prov = NULL;
410 if ((store = get_provider_store(libctx)) != NULL) {
411 OSSL_PROVIDER tmpl = { 0, };
416 * Make sure any providers are loaded from config before we try to find
420 if (ossl_lib_ctx_is_default(libctx))
421 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
425 tmpl.name = (char *)name;
427 * A "find" operation can sort the stack, and therefore a write lock is
430 if (!CRYPTO_THREAD_write_lock(store->lock))
432 if ((i = sk_OSSL_PROVIDER_find(store->providers, &tmpl)) != -1)
433 prov = sk_OSSL_PROVIDER_value(store->providers, i);
434 CRYPTO_THREAD_unlock(store->lock);
435 if (prov != NULL && !ossl_provider_up_ref(prov))
443 * Provider Object methods
444 * =======================
447 static OSSL_PROVIDER *provider_new(const char *name,
448 OSSL_provider_init_fn *init_function,
449 STACK_OF(INFOPAIR) *parameters)
451 OSSL_PROVIDER *prov = NULL;
453 if ((prov = OPENSSL_zalloc(sizeof(*prov))) == NULL
455 || (prov->refcnt_lock = CRYPTO_THREAD_lock_new()) == NULL
457 || (prov->opbits_lock = CRYPTO_THREAD_lock_new()) == NULL
458 || (prov->flag_lock = CRYPTO_THREAD_lock_new()) == NULL
459 || (prov->name = OPENSSL_strdup(name)) == NULL
460 || (prov->parameters = sk_INFOPAIR_deep_copy(parameters,
462 infopair_free)) == NULL) {
463 ossl_provider_free(prov);
464 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
468 prov->refcnt = 1; /* 1 One reference to be returned */
469 prov->init_function = init_function;
474 int ossl_provider_up_ref(OSSL_PROVIDER *prov)
478 if (CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock) <= 0)
483 if (!ossl_provider_up_ref_parent(prov, 0)) {
484 ossl_provider_free(prov);
494 static int provider_up_ref_intern(OSSL_PROVIDER *prov, int activate)
497 return ossl_provider_activate(prov, 1, 0);
499 return ossl_provider_up_ref(prov);
502 static int provider_free_intern(OSSL_PROVIDER *prov, int deactivate)
505 return ossl_provider_deactivate(prov, 1);
507 ossl_provider_free(prov);
513 * We assume that the requested provider does not already exist in the store.
514 * The caller should check. If it does exist then adding it to the store later
517 OSSL_PROVIDER *ossl_provider_new(OSSL_LIB_CTX *libctx, const char *name,
518 OSSL_provider_init_fn *init_function,
521 struct provider_store_st *store = NULL;
522 OSSL_PROVIDER_INFO template;
523 OSSL_PROVIDER *prov = NULL;
525 if ((store = get_provider_store(libctx)) == NULL)
528 memset(&template, 0, sizeof(template));
529 if (init_function == NULL) {
530 const OSSL_PROVIDER_INFO *p;
533 /* Check if this is a predefined builtin provider */
534 for (p = ossl_predefined_providers; p->name != NULL; p++) {
535 if (strcmp(p->name, name) == 0) {
540 if (p->name == NULL) {
541 /* Check if this is a user added builtin provider */
542 if (!CRYPTO_THREAD_read_lock(store->lock))
544 for (i = 0, p = store->provinfo; i < store->numprovinfo; p++, i++) {
545 if (strcmp(p->name, name) == 0) {
550 CRYPTO_THREAD_unlock(store->lock);
553 template.init = init_function;
556 /* provider_new() generates an error, so no need here */
557 if ((prov = provider_new(name, template.init, template.parameters)) == NULL)
560 prov->libctx = libctx;
562 prov->error_lib = ERR_get_next_error_library();
566 * At this point, the provider is only partially "loaded". To be
567 * fully "loaded", ossl_provider_activate() must also be called and it must
568 * then be added to the provider store.
574 /* Assumes that the store lock is held */
575 static int create_provider_children(OSSL_PROVIDER *prov)
579 struct provider_store_st *store = prov->store;
580 OSSL_PROVIDER_CHILD_CB *child_cb;
583 max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
584 for (i = 0; i < max; i++) {
586 * This is newly activated (activatecnt == 1), so we need to
587 * create child providers as necessary.
589 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
590 ret &= child_cb->create_cb((OSSL_CORE_HANDLE *)prov, child_cb->cbdata);
597 int ossl_provider_add_to_store(OSSL_PROVIDER *prov, OSSL_PROVIDER **actualprov,
598 int retain_fallbacks)
600 struct provider_store_st *store;
602 OSSL_PROVIDER tmpl = { 0, };
603 OSSL_PROVIDER *actualtmp = NULL;
605 if ((store = get_provider_store(prov->libctx)) == NULL)
608 if (!CRYPTO_THREAD_write_lock(store->lock))
611 tmpl.name = (char *)prov->name;
612 idx = sk_OSSL_PROVIDER_find(store->providers, &tmpl);
616 actualtmp = sk_OSSL_PROVIDER_value(store->providers, idx);
619 if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0)
622 if (!create_provider_children(prov)) {
623 sk_OSSL_PROVIDER_delete_ptr(store->providers, prov);
626 if (!retain_fallbacks)
627 store->use_fallbacks = 0;
630 CRYPTO_THREAD_unlock(store->lock);
632 if (actualprov != NULL) {
633 if (!ossl_provider_up_ref(actualtmp)) {
634 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
638 *actualprov = actualtmp;
643 * The provider is already in the store. Probably two threads
644 * independently initialised their own provider objects with the same
645 * name and raced to put them in the store. This thread lost. We
646 * deactivate the one we just created and use the one that already
648 * If we get here then we know we did not create provider children
649 * above, so we inform ossl_provider_deactivate not to attempt to remove
652 ossl_provider_deactivate(prov, 0);
653 ossl_provider_free(prov);
659 CRYPTO_THREAD_unlock(store->lock);
660 if (actualprov != NULL)
661 ossl_provider_free(actualtmp);
665 void ossl_provider_free(OSSL_PROVIDER *prov)
670 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
673 * When the refcount drops to zero, we clean up the provider.
674 * Note that this also does teardown, which may seem late,
675 * considering that init happens on first activation. However,
676 * there may be other structures hanging on to the provider after
677 * the last deactivation and may therefore need full access to the
678 * provider's services. Therefore, we deinit late.
681 if (prov->flag_initialized) {
682 ossl_provider_teardown(prov);
683 #ifndef OPENSSL_NO_ERR
685 if (prov->error_strings != NULL) {
686 ERR_unload_strings(prov->error_lib, prov->error_strings);
687 OPENSSL_free(prov->error_strings);
688 prov->error_strings = NULL;
692 OPENSSL_free(prov->operation_bits);
693 prov->operation_bits = NULL;
694 prov->operation_bits_sz = 0;
695 prov->flag_initialized = 0;
700 * We deregister thread handling whether or not the provider was
701 * initialized. If init was attempted but was not successful then
702 * the provider may still have registered a thread handler.
704 ossl_init_thread_deregister(prov);
705 DSO_free(prov->module);
707 OPENSSL_free(prov->name);
708 OPENSSL_free(prov->path);
709 sk_INFOPAIR_pop_free(prov->parameters, infopair_free);
710 CRYPTO_THREAD_lock_free(prov->opbits_lock);
711 CRYPTO_THREAD_lock_free(prov->flag_lock);
713 CRYPTO_THREAD_lock_free(prov->refcnt_lock);
718 else if (prov->ischild) {
719 ossl_provider_free_parent(prov, 0);
726 int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *module_path)
728 OPENSSL_free(prov->path);
730 if (module_path == NULL)
732 if ((prov->path = OPENSSL_strdup(module_path)) != NULL)
734 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
738 static int infopair_add(STACK_OF(INFOPAIR) **infopairsk, const char *name,
741 INFOPAIR *pair = NULL;
743 if ((pair = OPENSSL_zalloc(sizeof(*pair))) != NULL
744 && (*infopairsk != NULL
745 || (*infopairsk = sk_INFOPAIR_new_null()) != NULL)
746 && (pair->name = OPENSSL_strdup(name)) != NULL
747 && (pair->value = OPENSSL_strdup(value)) != NULL
748 && sk_INFOPAIR_push(*infopairsk, pair) > 0)
752 OPENSSL_free(pair->name);
753 OPENSSL_free(pair->value);
756 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
760 int ossl_provider_add_parameter(OSSL_PROVIDER *prov,
761 const char *name, const char *value)
763 return infopair_add(&prov->parameters, name, value);
766 int ossl_provider_info_add_parameter(OSSL_PROVIDER_INFO *provinfo,
770 return infopair_add(&provinfo->parameters, name, value);
774 * Provider activation.
776 * What "activation" means depends on the provider form; for built in
777 * providers (in the library or the application alike), the provider
778 * can already be considered to be loaded, all that's needed is to
779 * initialize it. However, for dynamically loadable provider modules,
780 * we must first load that module.
782 * Built in modules are distinguished from dynamically loaded modules
783 * with an already assigned init function.
785 static const OSSL_DISPATCH *core_dispatch; /* Define further down */
787 int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *libctx,
790 struct provider_store_st *store;
794 p = OPENSSL_strdup(path);
796 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
800 if ((store = get_provider_store(libctx)) != NULL
801 && CRYPTO_THREAD_write_lock(store->default_path_lock)) {
802 OPENSSL_free(store->default_path);
803 store->default_path = p;
804 CRYPTO_THREAD_unlock(store->default_path_lock);
812 * Internal version that doesn't affect the store flags, and thereby avoid
813 * locking. Direct callers must remember to set the store flags when
816 static int provider_init(OSSL_PROVIDER *prov)
818 const OSSL_DISPATCH *provider_dispatch = NULL;
819 void *tmp_provctx = NULL; /* safety measure */
820 #ifndef OPENSSL_NO_ERR
822 OSSL_FUNC_provider_get_reason_strings_fn *p_get_reason_strings = NULL;
827 if (!ossl_assert(!prov->flag_initialized)) {
828 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
833 * If the init function isn't set, it indicates that this provider is
836 if (prov->init_function == NULL) {
840 if (prov->module == NULL) {
841 char *allocated_path = NULL;
842 const char *module_path = NULL;
843 char *merged_path = NULL;
844 const char *load_dir = NULL;
845 char *allocated_load_dir = NULL;
846 struct provider_store_st *store;
848 if ((prov->module = DSO_new()) == NULL) {
849 /* DSO_new() generates an error already */
853 if ((store = get_provider_store(prov->libctx)) == NULL
854 || !CRYPTO_THREAD_read_lock(store->default_path_lock))
857 if (store->default_path != NULL) {
858 allocated_load_dir = OPENSSL_strdup(store->default_path);
859 CRYPTO_THREAD_unlock(store->default_path_lock);
860 if (allocated_load_dir == NULL) {
861 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
864 load_dir = allocated_load_dir;
866 CRYPTO_THREAD_unlock(store->default_path_lock);
869 if (load_dir == NULL) {
870 load_dir = ossl_safe_getenv("OPENSSL_MODULES");
871 if (load_dir == NULL)
872 load_dir = MODULESDIR;
875 DSO_ctrl(prov->module, DSO_CTRL_SET_FLAGS,
876 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY, NULL);
878 module_path = prov->path;
879 if (module_path == NULL)
880 module_path = allocated_path =
881 DSO_convert_filename(prov->module, prov->name);
882 if (module_path != NULL)
883 merged_path = DSO_merge(prov->module, module_path, load_dir);
885 if (merged_path == NULL
886 || (DSO_load(prov->module, merged_path, NULL, 0)) == NULL) {
887 DSO_free(prov->module);
891 OPENSSL_free(merged_path);
892 OPENSSL_free(allocated_path);
893 OPENSSL_free(allocated_load_dir);
896 if (prov->module != NULL)
897 prov->init_function = (OSSL_provider_init_fn *)
898 DSO_bind_func(prov->module, "OSSL_provider_init");
902 /* Call the initialise function for the provider. */
903 if (prov->init_function == NULL
904 || !prov->init_function((OSSL_CORE_HANDLE *)prov, core_dispatch,
905 &provider_dispatch, &tmp_provctx)) {
906 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INIT_FAIL,
907 "name=%s", prov->name);
910 prov->provctx = tmp_provctx;
911 prov->dispatch = provider_dispatch;
913 for (; provider_dispatch->function_id != 0; provider_dispatch++) {
914 switch (provider_dispatch->function_id) {
915 case OSSL_FUNC_PROVIDER_TEARDOWN:
917 OSSL_FUNC_provider_teardown(provider_dispatch);
919 case OSSL_FUNC_PROVIDER_GETTABLE_PARAMS:
920 prov->gettable_params =
921 OSSL_FUNC_provider_gettable_params(provider_dispatch);
923 case OSSL_FUNC_PROVIDER_GET_PARAMS:
925 OSSL_FUNC_provider_get_params(provider_dispatch);
927 case OSSL_FUNC_PROVIDER_SELF_TEST:
929 OSSL_FUNC_provider_self_test(provider_dispatch);
931 case OSSL_FUNC_PROVIDER_GET_CAPABILITIES:
932 prov->get_capabilities =
933 OSSL_FUNC_provider_get_capabilities(provider_dispatch);
935 case OSSL_FUNC_PROVIDER_QUERY_OPERATION:
936 prov->query_operation =
937 OSSL_FUNC_provider_query_operation(provider_dispatch);
939 case OSSL_FUNC_PROVIDER_UNQUERY_OPERATION:
940 prov->unquery_operation =
941 OSSL_FUNC_provider_unquery_operation(provider_dispatch);
943 #ifndef OPENSSL_NO_ERR
945 case OSSL_FUNC_PROVIDER_GET_REASON_STRINGS:
946 p_get_reason_strings =
947 OSSL_FUNC_provider_get_reason_strings(provider_dispatch);
954 #ifndef OPENSSL_NO_ERR
956 if (p_get_reason_strings != NULL) {
957 const OSSL_ITEM *reasonstrings = p_get_reason_strings(prov->provctx);
961 * ERR_load_strings() handles ERR_STRING_DATA rather than OSSL_ITEM,
962 * although they are essentially the same type.
963 * Furthermore, ERR_load_strings() patches the array's error number
964 * with the error library number, so we need to make a copy of that
968 while (reasonstrings[cnt].id != 0) {
969 if (ERR_GET_LIB(reasonstrings[cnt].id) != 0)
973 cnt++; /* One for the terminating item */
975 /* Allocate one extra item for the "library" name */
976 prov->error_strings =
977 OPENSSL_zalloc(sizeof(ERR_STRING_DATA) * (cnt + 1));
978 if (prov->error_strings == NULL)
982 * Set the "library" name.
984 prov->error_strings[0].error = ERR_PACK(prov->error_lib, 0, 0);
985 prov->error_strings[0].string = prov->name;
987 * Copy reasonstrings item 0..cnt-1 to prov->error_trings positions
990 for (cnt2 = 1; cnt2 <= cnt; cnt2++) {
991 prov->error_strings[cnt2].error = (int)reasonstrings[cnt2-1].id;
992 prov->error_strings[cnt2].string = reasonstrings[cnt2-1].ptr;
995 ERR_load_strings(prov->error_lib, prov->error_strings);
1000 /* With this flag set, this provider has become fully "loaded". */
1001 prov->flag_initialized = 1;
1009 * Deactivate a provider. If upcalls is 0 then we suppress any upcalls to a
1010 * parent provider. If removechildren is 0 then we suppress any calls to remove
1012 * Return -1 on failure and the activation count on success
1014 static int provider_deactivate(OSSL_PROVIDER *prov, int upcalls,
1018 struct provider_store_st *store;
1024 if (!ossl_assert(prov != NULL))
1028 * No need to lock if we've got no store because we've not been shared with
1031 store = get_provider_store(prov->libctx);
1035 if (lock && !CRYPTO_THREAD_read_lock(store->lock))
1037 if (lock && !CRYPTO_THREAD_write_lock(prov->flag_lock)) {
1038 CRYPTO_THREAD_unlock(store->lock);
1043 if (prov->activatecnt >= 2 && prov->ischild && upcalls) {
1045 * We have had a direct activation in this child libctx so we need to
1046 * now down the ref count in the parent provider. We do the actual down
1047 * ref outside of the flag_lock, since it could involve getting other
1054 if ((count = --prov->activatecnt) < 1)
1055 prov->flag_activated = 0;
1062 if (removechildren && store != NULL) {
1063 int i, max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
1064 OSSL_PROVIDER_CHILD_CB *child_cb;
1066 for (i = 0; i < max; i++) {
1067 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
1068 child_cb->remove_cb((OSSL_CORE_HANDLE *)prov, child_cb->cbdata);
1073 CRYPTO_THREAD_unlock(prov->flag_lock);
1074 CRYPTO_THREAD_unlock(store->lock);
1078 ossl_provider_free_parent(prov, 1);
1081 /* We don't deinit here, that's done in ossl_provider_free() */
1086 * Activate a provider.
1087 * Return -1 on failure and the activation count on success
1089 static int provider_activate(OSSL_PROVIDER *prov, int lock, int upcalls)
1092 struct provider_store_st *store;
1095 store = prov->store;
1097 * If the provider hasn't been added to the store, then we don't need
1098 * any locks because we've not shared it with other threads.
1100 if (store == NULL) {
1102 if (!provider_init(prov))
1107 if (prov->ischild && upcalls && !ossl_provider_up_ref_parent(prov, 1))
1111 if (lock && !CRYPTO_THREAD_read_lock(store->lock)) {
1113 if (prov->ischild && upcalls)
1114 ossl_provider_free_parent(prov, 1);
1119 if (lock && !CRYPTO_THREAD_write_lock(prov->flag_lock)) {
1120 CRYPTO_THREAD_unlock(store->lock);
1122 if (prov->ischild && upcalls)
1123 ossl_provider_free_parent(prov, 1);
1128 count = ++prov->activatecnt;
1129 prov->flag_activated = 1;
1131 if (prov->activatecnt == 1 && store != NULL) {
1132 ret = create_provider_children(prov);
1135 CRYPTO_THREAD_unlock(prov->flag_lock);
1136 CRYPTO_THREAD_unlock(store->lock);
1145 static int provider_flush_store_cache(const OSSL_PROVIDER *prov)
1147 struct provider_store_st *store;
1150 if ((store = get_provider_store(prov->libctx)) == NULL)
1153 if (!CRYPTO_THREAD_read_lock(store->lock))
1155 freeing = store->freeing;
1156 CRYPTO_THREAD_unlock(store->lock);
1159 return evp_method_store_flush(prov->libctx);
1163 int ossl_provider_activate(OSSL_PROVIDER *prov, int upcalls, int aschild)
1171 * If aschild is true, then we only actually do the activation if the
1172 * provider is a child. If its not, this is still success.
1174 if (aschild && !prov->ischild)
1177 if ((count = provider_activate(prov, 1, upcalls)) > 0)
1178 return count == 1 ? provider_flush_store_cache(prov) : 1;
1183 int ossl_provider_deactivate(OSSL_PROVIDER *prov, int removechildren)
1188 || (count = provider_deactivate(prov, 1, removechildren)) < 0)
1190 return count == 0 ? provider_flush_store_cache(prov) : 1;
1193 void *ossl_provider_ctx(const OSSL_PROVIDER *prov)
1195 return prov->provctx;
1199 * This function only does something once when store->use_fallbacks == 1,
1200 * and then sets store->use_fallbacks = 0, so the second call and so on is
1201 * effectively a no-op.
1203 static int provider_activate_fallbacks(struct provider_store_st *store)
1206 int activated_fallback_count = 0;
1208 const OSSL_PROVIDER_INFO *p;
1210 if (!CRYPTO_THREAD_read_lock(store->lock))
1212 use_fallbacks = store->use_fallbacks;
1213 CRYPTO_THREAD_unlock(store->lock);
1217 if (!CRYPTO_THREAD_write_lock(store->lock))
1219 /* Check again, just in case another thread changed it */
1220 use_fallbacks = store->use_fallbacks;
1221 if (!use_fallbacks) {
1222 CRYPTO_THREAD_unlock(store->lock);
1226 for (p = ossl_predefined_providers; p->name != NULL; p++) {
1227 OSSL_PROVIDER *prov = NULL;
1229 if (!p->is_fallback)
1232 * We use the internal constructor directly here,
1233 * otherwise we get a call loop
1235 prov = provider_new(p->name, p->init, NULL);
1238 prov->libctx = store->libctx;
1240 prov->error_lib = ERR_get_next_error_library();
1244 * We are calling provider_activate while holding the store lock. This
1245 * means the init function will be called while holding a lock. Normally
1246 * we try to avoid calling a user callback while holding a lock.
1247 * However, fallbacks are never third party providers so we accept this.
1249 if (provider_activate(prov, 0, 0) < 0) {
1250 ossl_provider_free(prov);
1253 prov->store = store;
1254 if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
1255 ossl_provider_free(prov);
1258 activated_fallback_count++;
1261 if (activated_fallback_count > 0) {
1262 store->use_fallbacks = 0;
1266 CRYPTO_THREAD_unlock(store->lock);
1270 int ossl_provider_doall_activated(OSSL_LIB_CTX *ctx,
1271 int (*cb)(OSSL_PROVIDER *provider,
1275 int ret = 0, curr, max, ref = 0;
1276 struct provider_store_st *store = get_provider_store(ctx);
1277 STACK_OF(OSSL_PROVIDER) *provs = NULL;
1281 * Make sure any providers are loaded from config before we try to use
1284 if (ossl_lib_ctx_is_default(ctx))
1285 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
1290 if (!provider_activate_fallbacks(store))
1294 * Under lock, grab a copy of the provider list and up_ref each
1295 * provider so that they don't disappear underneath us.
1297 if (!CRYPTO_THREAD_read_lock(store->lock))
1299 provs = sk_OSSL_PROVIDER_dup(store->providers);
1300 if (provs == NULL) {
1301 CRYPTO_THREAD_unlock(store->lock);
1304 max = sk_OSSL_PROVIDER_num(provs);
1306 * We work backwards through the stack so that we can safely delete items
1309 for (curr = max - 1; curr >= 0; curr--) {
1310 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
1312 if (!CRYPTO_THREAD_write_lock(prov->flag_lock))
1314 if (prov->flag_activated) {
1316 * We call CRYPTO_UP_REF directly rather than ossl_provider_up_ref
1317 * to avoid upping the ref count on the parent provider, which we
1318 * must not do while holding locks.
1320 if (CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock) <= 0) {
1321 CRYPTO_THREAD_unlock(prov->flag_lock);
1325 * It's already activated, but we up the activated count to ensure
1326 * it remains activated until after we've called the user callback.
1327 * We do this with no locking (because we already hold the locks)
1328 * and no upcalls (which must not be called when locks are held). In
1329 * theory this could mean the parent provider goes inactive, whilst
1330 * still activated in the child for a short period. That's ok.
1332 if (provider_activate(prov, 0, 0) < 0) {
1333 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
1334 CRYPTO_THREAD_unlock(prov->flag_lock);
1338 sk_OSSL_PROVIDER_delete(provs, curr);
1341 CRYPTO_THREAD_unlock(prov->flag_lock);
1343 CRYPTO_THREAD_unlock(store->lock);
1346 * Now, we sweep through all providers not under lock
1348 for (curr = 0; curr < max; curr++) {
1349 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
1351 if (!cb(prov, cbdata))
1360 CRYPTO_THREAD_unlock(store->lock);
1363 * The pop_free call doesn't do what we want on an error condition. We
1364 * either start from the first item in the stack, or part way through if
1365 * we only processed some of the items.
1367 for (curr++; curr < max; curr++) {
1368 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
1370 provider_deactivate(prov, 0, 1);
1372 * As above where we did the up-ref, we don't call ossl_provider_free
1373 * to avoid making upcalls. There should always be at least one ref
1374 * to the provider in the store, so this should never drop to 0.
1376 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
1378 * Not much we can do if this assert ever fails. So we don't use
1383 sk_OSSL_PROVIDER_free(provs);
1387 int OSSL_PROVIDER_available(OSSL_LIB_CTX *libctx, const char *name)
1389 OSSL_PROVIDER *prov = NULL;
1391 struct provider_store_st *store = get_provider_store(libctx);
1393 if (store == NULL || !provider_activate_fallbacks(store))
1396 prov = ossl_provider_find(libctx, name, 0);
1398 if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
1400 available = prov->flag_activated;
1401 CRYPTO_THREAD_unlock(prov->flag_lock);
1402 ossl_provider_free(prov);
1407 /* Getters of Provider Object data */
1408 const char *ossl_provider_name(const OSSL_PROVIDER *prov)
1413 const DSO *ossl_provider_dso(const OSSL_PROVIDER *prov)
1415 return prov->module;
1418 const char *ossl_provider_module_name(const OSSL_PROVIDER *prov)
1423 return DSO_get_filename(prov->module);
1427 const char *ossl_provider_module_path(const OSSL_PROVIDER *prov)
1432 /* FIXME: Ensure it's a full path */
1433 return DSO_get_filename(prov->module);
1437 void *ossl_provider_prov_ctx(const OSSL_PROVIDER *prov)
1440 return prov->provctx;
1445 const OSSL_DISPATCH *ossl_provider_get0_dispatch(const OSSL_PROVIDER *prov)
1448 return prov->dispatch;
1453 OSSL_LIB_CTX *ossl_provider_libctx(const OSSL_PROVIDER *prov)
1455 return prov != NULL ? prov->libctx : NULL;
1458 /* Wrappers around calls to the provider */
1459 void ossl_provider_teardown(const OSSL_PROVIDER *prov)
1461 if (prov->teardown != NULL
1466 prov->teardown(prov->provctx);
1469 const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov)
1471 return prov->gettable_params == NULL
1472 ? NULL : prov->gettable_params(prov->provctx);
1475 int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
1477 return prov->get_params == NULL
1478 ? 0 : prov->get_params(prov->provctx, params);
1481 int ossl_provider_self_test(const OSSL_PROVIDER *prov)
1485 if (prov->self_test == NULL)
1487 ret = prov->self_test(prov->provctx);
1489 (void)provider_flush_store_cache(prov);
1493 int ossl_provider_get_capabilities(const OSSL_PROVIDER *prov,
1494 const char *capability,
1498 return prov->get_capabilities == NULL
1499 ? 1 : prov->get_capabilities(prov->provctx, capability, cb, arg);
1502 const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov,
1506 const OSSL_ALGORITHM *res;
1508 if (prov->query_operation == NULL)
1510 res = prov->query_operation(prov->provctx, operation_id, no_cache);
1511 #if defined(OPENSSL_NO_CACHED_FETCH)
1512 /* Forcing the non-caching of queries */
1513 if (no_cache != NULL)
1519 void ossl_provider_unquery_operation(const OSSL_PROVIDER *prov,
1521 const OSSL_ALGORITHM *algs)
1523 if (prov->unquery_operation != NULL)
1524 prov->unquery_operation(prov->provctx, operation_id, algs);
1527 int ossl_provider_clear_all_operation_bits(OSSL_LIB_CTX *libctx)
1529 struct provider_store_st *store;
1530 OSSL_PROVIDER *provider;
1531 int i, num, res = 1;
1533 if ((store = get_provider_store(libctx)) != NULL) {
1534 if (!CRYPTO_THREAD_read_lock(store->lock))
1536 num = sk_OSSL_PROVIDER_num(store->providers);
1537 for (i = 0; i < num; i++) {
1538 provider = sk_OSSL_PROVIDER_value(store->providers, i);
1539 if (!CRYPTO_THREAD_write_lock(provider->opbits_lock)) {
1543 if (provider->operation_bits != NULL)
1544 memset(provider->operation_bits, 0,
1545 provider->operation_bits_sz);
1546 CRYPTO_THREAD_unlock(provider->opbits_lock);
1548 CRYPTO_THREAD_unlock(store->lock);
1554 int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum)
1556 size_t byte = bitnum / 8;
1557 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
1559 if (!CRYPTO_THREAD_write_lock(provider->opbits_lock))
1561 if (provider->operation_bits_sz <= byte) {
1562 unsigned char *tmp = OPENSSL_realloc(provider->operation_bits,
1566 CRYPTO_THREAD_unlock(provider->opbits_lock);
1567 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
1570 provider->operation_bits = tmp;
1571 memset(provider->operation_bits + provider->operation_bits_sz,
1572 '\0', byte + 1 - provider->operation_bits_sz);
1573 provider->operation_bits_sz = byte + 1;
1575 provider->operation_bits[byte] |= bit;
1576 CRYPTO_THREAD_unlock(provider->opbits_lock);
1580 int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum,
1583 size_t byte = bitnum / 8;
1584 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
1586 if (!ossl_assert(result != NULL)) {
1587 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
1592 if (!CRYPTO_THREAD_read_lock(provider->opbits_lock))
1594 if (provider->operation_bits_sz > byte)
1595 *result = ((provider->operation_bits[byte] & bit) != 0);
1596 CRYPTO_THREAD_unlock(provider->opbits_lock);
1601 const OSSL_CORE_HANDLE *ossl_provider_get_parent(OSSL_PROVIDER *prov)
1603 return prov->handle;
1606 int ossl_provider_is_child(const OSSL_PROVIDER *prov)
1608 return prov->ischild;
1611 int ossl_provider_set_child(OSSL_PROVIDER *prov, const OSSL_CORE_HANDLE *handle)
1613 prov->handle = handle;
1619 int ossl_provider_default_props_update(OSSL_LIB_CTX *libctx, const char *props)
1622 struct provider_store_st *store = NULL;
1624 OSSL_PROVIDER_CHILD_CB *child_cb;
1626 if ((store = get_provider_store(libctx)) == NULL)
1629 if (!CRYPTO_THREAD_read_lock(store->lock))
1632 max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
1633 for (i = 0; i < max; i++) {
1634 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
1635 child_cb->global_props_cb(props, child_cb->cbdata);
1638 CRYPTO_THREAD_unlock(store->lock);
1643 static int ossl_provider_register_child_cb(const OSSL_CORE_HANDLE *handle,
1645 const OSSL_CORE_HANDLE *provider,
1648 const OSSL_CORE_HANDLE *provider,
1650 int (*global_props_cb)(
1656 * This is really an OSSL_PROVIDER that we created and cast to
1657 * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
1659 OSSL_PROVIDER *thisprov = (OSSL_PROVIDER *)handle;
1660 OSSL_PROVIDER *prov;
1661 OSSL_LIB_CTX *libctx = thisprov->libctx;
1662 struct provider_store_st *store = NULL;
1663 int ret = 0, i, max;
1664 OSSL_PROVIDER_CHILD_CB *child_cb;
1665 char *propsstr = NULL;
1667 if ((store = get_provider_store(libctx)) == NULL)
1670 child_cb = OPENSSL_malloc(sizeof(*child_cb));
1671 if (child_cb == NULL)
1673 child_cb->prov = thisprov;
1674 child_cb->create_cb = create_cb;
1675 child_cb->remove_cb = remove_cb;
1676 child_cb->global_props_cb = global_props_cb;
1677 child_cb->cbdata = cbdata;
1679 if (!CRYPTO_THREAD_write_lock(store->lock)) {
1680 OPENSSL_free(child_cb);
1683 propsstr = evp_get_global_properties_str(libctx, 0);
1685 if (propsstr != NULL) {
1686 global_props_cb(propsstr, cbdata);
1687 OPENSSL_free(propsstr);
1689 max = sk_OSSL_PROVIDER_num(store->providers);
1690 for (i = 0; i < max; i++) {
1693 prov = sk_OSSL_PROVIDER_value(store->providers, i);
1695 if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
1697 activated = prov->flag_activated;
1698 CRYPTO_THREAD_unlock(prov->flag_lock);
1700 * We hold the store lock while calling the user callback. This means
1701 * that the user callback must be short and simple and not do anything
1702 * likely to cause a deadlock. We don't hold the flag_lock during this
1703 * call. In theory this means that another thread could deactivate it
1704 * while we are calling create. This is ok because the other thread
1705 * will also call remove_cb, but won't be able to do so until we release
1708 if (activated && !create_cb((OSSL_CORE_HANDLE *)prov, cbdata))
1713 ret = sk_OSSL_PROVIDER_CHILD_CB_push(store->child_cbs, child_cb);
1715 if (i != max || ret <= 0) {
1716 /* Failed during creation. Remove everything we just added */
1717 for (; i >= 0; i--) {
1718 prov = sk_OSSL_PROVIDER_value(store->providers, i);
1719 remove_cb((OSSL_CORE_HANDLE *)prov, cbdata);
1721 OPENSSL_free(child_cb);
1724 CRYPTO_THREAD_unlock(store->lock);
1729 static void ossl_provider_deregister_child_cb(const OSSL_CORE_HANDLE *handle)
1732 * This is really an OSSL_PROVIDER that we created and cast to
1733 * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
1735 OSSL_PROVIDER *thisprov = (OSSL_PROVIDER *)handle;
1736 OSSL_LIB_CTX *libctx = thisprov->libctx;
1737 struct provider_store_st *store = NULL;
1739 OSSL_PROVIDER_CHILD_CB *child_cb;
1741 if ((store = get_provider_store(libctx)) == NULL)
1744 if (!CRYPTO_THREAD_write_lock(store->lock))
1746 max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
1747 for (i = 0; i < max; i++) {
1748 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
1749 if (child_cb->prov == thisprov) {
1750 /* Found an entry */
1751 sk_OSSL_PROVIDER_CHILD_CB_delete(store->child_cbs, i);
1752 OPENSSL_free(child_cb);
1756 CRYPTO_THREAD_unlock(store->lock);
1761 * Core functions for the provider
1762 * ===============================
1764 * This is the set of functions that the core makes available to the provider
1768 * This returns a list of Provider Object parameters with their types, for
1769 * discovery. We do not expect that many providers will use this, but one
1772 static const OSSL_PARAM param_types[] = {
1773 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
1774 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_PROV_NAME, OSSL_PARAM_UTF8_PTR,
1777 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_MODULE_FILENAME, OSSL_PARAM_UTF8_PTR,
1784 * Forward declare all the functions that are provided aa dispatch.
1785 * This ensures that the compiler will complain if they aren't defined
1786 * with the correct signature.
1788 static OSSL_FUNC_core_gettable_params_fn core_gettable_params;
1789 static OSSL_FUNC_core_get_params_fn core_get_params;
1790 static OSSL_FUNC_core_thread_start_fn core_thread_start;
1791 static OSSL_FUNC_core_get_libctx_fn core_get_libctx;
1793 static OSSL_FUNC_core_new_error_fn core_new_error;
1794 static OSSL_FUNC_core_set_error_debug_fn core_set_error_debug;
1795 static OSSL_FUNC_core_vset_error_fn core_vset_error;
1796 static OSSL_FUNC_core_set_error_mark_fn core_set_error_mark;
1797 static OSSL_FUNC_core_clear_last_error_mark_fn core_clear_last_error_mark;
1798 static OSSL_FUNC_core_pop_error_to_mark_fn core_pop_error_to_mark;
1799 static OSSL_FUNC_core_obj_add_sigid_fn core_obj_add_sigid;
1800 static OSSL_FUNC_core_obj_create_fn core_obj_create;
1803 static const OSSL_PARAM *core_gettable_params(const OSSL_CORE_HANDLE *handle)
1808 static int core_get_params(const OSSL_CORE_HANDLE *handle, OSSL_PARAM params[])
1813 * We created this object originally and we know it is actually an
1814 * OSSL_PROVIDER *, so the cast is safe
1816 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1818 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_VERSION)) != NULL)
1819 OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR);
1820 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_PROV_NAME)) != NULL)
1821 OSSL_PARAM_set_utf8_ptr(p, prov->name);
1824 if ((p = OSSL_PARAM_locate(params,
1825 OSSL_PROV_PARAM_CORE_MODULE_FILENAME)) != NULL)
1826 OSSL_PARAM_set_utf8_ptr(p, ossl_provider_module_path(prov));
1829 if (prov->parameters == NULL)
1832 for (i = 0; i < sk_INFOPAIR_num(prov->parameters); i++) {
1833 INFOPAIR *pair = sk_INFOPAIR_value(prov->parameters, i);
1835 if ((p = OSSL_PARAM_locate(params, pair->name)) != NULL)
1836 OSSL_PARAM_set_utf8_ptr(p, pair->value);
1841 static OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle)
1844 * We created this object originally and we know it is actually an
1845 * OSSL_PROVIDER *, so the cast is safe
1847 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1850 * Using ossl_provider_libctx would be wrong as that returns
1851 * NULL for |prov| == NULL and NULL libctx has a special meaning
1852 * that does not apply here. Here |prov| == NULL can happen only in
1853 * case of a coding error.
1855 assert(prov != NULL);
1856 return (OPENSSL_CORE_CTX *)prov->libctx;
1859 static int core_thread_start(const OSSL_CORE_HANDLE *handle,
1860 OSSL_thread_stop_handler_fn handfn,
1864 * We created this object originally and we know it is actually an
1865 * OSSL_PROVIDER *, so the cast is safe
1867 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1869 return ossl_init_thread_start(prov, arg, handfn);
1873 * The FIPS module inner provider doesn't implement these. They aren't
1874 * needed there, since the FIPS module upcalls are always the outer provider
1879 * These error functions should use |handle| to select the proper
1880 * library context to report in the correct error stack if error
1881 * stacks become tied to the library context.
1882 * We cannot currently do that since there's no support for it in the
1885 static void core_new_error(const OSSL_CORE_HANDLE *handle)
1890 static void core_set_error_debug(const OSSL_CORE_HANDLE *handle,
1891 const char *file, int line, const char *func)
1893 ERR_set_debug(file, line, func);
1896 static void core_vset_error(const OSSL_CORE_HANDLE *handle,
1897 uint32_t reason, const char *fmt, va_list args)
1900 * We created this object originally and we know it is actually an
1901 * OSSL_PROVIDER *, so the cast is safe
1903 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1906 * If the uppermost 8 bits are non-zero, it's an OpenSSL library
1907 * error and will be treated as such. Otherwise, it's a new style
1908 * provider error and will be treated as such.
1910 if (ERR_GET_LIB(reason) != 0) {
1911 ERR_vset_error(ERR_GET_LIB(reason), ERR_GET_REASON(reason), fmt, args);
1913 ERR_vset_error(prov->error_lib, (int)reason, fmt, args);
1917 static int core_set_error_mark(const OSSL_CORE_HANDLE *handle)
1919 return ERR_set_mark();
1922 static int core_clear_last_error_mark(const OSSL_CORE_HANDLE *handle)
1924 return ERR_clear_last_mark();
1927 static int core_pop_error_to_mark(const OSSL_CORE_HANDLE *handle)
1929 return ERR_pop_to_mark();
1932 static int core_obj_add_sigid(const OSSL_CORE_HANDLE *prov,
1933 const char *sign_name, const char *digest_name,
1934 const char *pkey_name)
1936 int sign_nid = OBJ_txt2nid(sign_name);
1937 int digest_nid = NID_undef;
1938 int pkey_nid = OBJ_txt2nid(pkey_name);
1940 if (digest_name != NULL && digest_name[0] != '\0'
1941 && (digest_nid = OBJ_txt2nid(digest_name)) == NID_undef)
1944 if (sign_nid == NID_undef)
1948 * Check if it already exists. This is a success if so (even if we don't
1949 * have nids for the digest/pkey)
1951 if (OBJ_find_sigid_algs(sign_nid, NULL, NULL))
1954 if (pkey_nid == NID_undef)
1957 return OBJ_add_sigid(sign_nid, digest_nid, pkey_nid);
1960 static int core_obj_create(const OSSL_CORE_HANDLE *prov, const char *oid,
1961 const char *sn, const char *ln)
1963 /* Check if it already exists and create it if not */
1964 return OBJ_txt2nid(oid) != NID_undef
1965 || OBJ_create(oid, sn, ln) != NID_undef;
1967 #endif /* FIPS_MODULE */
1970 * Functions provided by the core.
1972 static const OSSL_DISPATCH core_dispatch_[] = {
1973 { OSSL_FUNC_CORE_GETTABLE_PARAMS, (void (*)(void))core_gettable_params },
1974 { OSSL_FUNC_CORE_GET_PARAMS, (void (*)(void))core_get_params },
1975 { OSSL_FUNC_CORE_GET_LIBCTX, (void (*)(void))core_get_libctx },
1976 { OSSL_FUNC_CORE_THREAD_START, (void (*)(void))core_thread_start },
1978 { OSSL_FUNC_CORE_NEW_ERROR, (void (*)(void))core_new_error },
1979 { OSSL_FUNC_CORE_SET_ERROR_DEBUG, (void (*)(void))core_set_error_debug },
1980 { OSSL_FUNC_CORE_VSET_ERROR, (void (*)(void))core_vset_error },
1981 { OSSL_FUNC_CORE_SET_ERROR_MARK, (void (*)(void))core_set_error_mark },
1982 { OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK,
1983 (void (*)(void))core_clear_last_error_mark },
1984 { OSSL_FUNC_CORE_POP_ERROR_TO_MARK, (void (*)(void))core_pop_error_to_mark },
1985 { OSSL_FUNC_BIO_NEW_FILE, (void (*)(void))ossl_core_bio_new_file },
1986 { OSSL_FUNC_BIO_NEW_MEMBUF, (void (*)(void))ossl_core_bio_new_mem_buf },
1987 { OSSL_FUNC_BIO_READ_EX, (void (*)(void))ossl_core_bio_read_ex },
1988 { OSSL_FUNC_BIO_WRITE_EX, (void (*)(void))ossl_core_bio_write_ex },
1989 { OSSL_FUNC_BIO_GETS, (void (*)(void))ossl_core_bio_gets },
1990 { OSSL_FUNC_BIO_PUTS, (void (*)(void))ossl_core_bio_puts },
1991 { OSSL_FUNC_BIO_CTRL, (void (*)(void))ossl_core_bio_ctrl },
1992 { OSSL_FUNC_BIO_UP_REF, (void (*)(void))ossl_core_bio_up_ref },
1993 { OSSL_FUNC_BIO_FREE, (void (*)(void))ossl_core_bio_free },
1994 { OSSL_FUNC_BIO_VPRINTF, (void (*)(void))ossl_core_bio_vprintf },
1995 { OSSL_FUNC_BIO_VSNPRINTF, (void (*)(void))BIO_vsnprintf },
1996 { OSSL_FUNC_SELF_TEST_CB, (void (*)(void))OSSL_SELF_TEST_get_callback },
1997 { OSSL_FUNC_GET_ENTROPY, (void (*)(void))ossl_rand_get_entropy },
1998 { OSSL_FUNC_CLEANUP_ENTROPY, (void (*)(void))ossl_rand_cleanup_entropy },
1999 { OSSL_FUNC_GET_NONCE, (void (*)(void))ossl_rand_get_nonce },
2000 { OSSL_FUNC_CLEANUP_NONCE, (void (*)(void))ossl_rand_cleanup_nonce },
2002 { OSSL_FUNC_CRYPTO_MALLOC, (void (*)(void))CRYPTO_malloc },
2003 { OSSL_FUNC_CRYPTO_ZALLOC, (void (*)(void))CRYPTO_zalloc },
2004 { OSSL_FUNC_CRYPTO_FREE, (void (*)(void))CRYPTO_free },
2005 { OSSL_FUNC_CRYPTO_CLEAR_FREE, (void (*)(void))CRYPTO_clear_free },
2006 { OSSL_FUNC_CRYPTO_REALLOC, (void (*)(void))CRYPTO_realloc },
2007 { OSSL_FUNC_CRYPTO_CLEAR_REALLOC, (void (*)(void))CRYPTO_clear_realloc },
2008 { OSSL_FUNC_CRYPTO_SECURE_MALLOC, (void (*)(void))CRYPTO_secure_malloc },
2009 { OSSL_FUNC_CRYPTO_SECURE_ZALLOC, (void (*)(void))CRYPTO_secure_zalloc },
2010 { OSSL_FUNC_CRYPTO_SECURE_FREE, (void (*)(void))CRYPTO_secure_free },
2011 { OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE,
2012 (void (*)(void))CRYPTO_secure_clear_free },
2013 { OSSL_FUNC_CRYPTO_SECURE_ALLOCATED,
2014 (void (*)(void))CRYPTO_secure_allocated },
2015 { OSSL_FUNC_OPENSSL_CLEANSE, (void (*)(void))OPENSSL_cleanse },
2017 { OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB,
2018 (void (*)(void))ossl_provider_register_child_cb },
2019 { OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB,
2020 (void (*)(void))ossl_provider_deregister_child_cb },
2021 { OSSL_FUNC_PROVIDER_NAME,
2022 (void (*)(void))OSSL_PROVIDER_get0_name },
2023 { OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX,
2024 (void (*)(void))OSSL_PROVIDER_get0_provider_ctx },
2025 { OSSL_FUNC_PROVIDER_GET0_DISPATCH,
2026 (void (*)(void))OSSL_PROVIDER_get0_dispatch },
2027 { OSSL_FUNC_PROVIDER_UP_REF,
2028 (void (*)(void))provider_up_ref_intern },
2029 { OSSL_FUNC_PROVIDER_FREE,
2030 (void (*)(void))provider_free_intern },
2031 { OSSL_FUNC_CORE_OBJ_ADD_SIGID, (void (*)(void))core_obj_add_sigid },
2032 { OSSL_FUNC_CORE_OBJ_CREATE, (void (*)(void))core_obj_create },
2036 static const OSSL_DISPATCH *core_dispatch = core_dispatch_;