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/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"
19 #include "crypto/decoder.h" /* ossl_decoder_store_cache_flush */
20 #include "crypto/encoder.h" /* ossl_encoder_store_cache_flush */
21 #include "crypto/store.h" /* ossl_store_loader_store_cache_flush */
23 #include "crypto/evp.h" /* evp_method_store_cache_flush */
24 #include "crypto/rand.h"
25 #include "internal/nelem.h"
26 #include "internal/thread_once.h"
27 #include "internal/provider.h"
28 #include "internal/refcount.h"
29 #include "internal/bio.h"
30 #include "internal/core.h"
31 #include "provider_local.h"
32 #include "crypto/context.h"
34 # include <openssl/self_test.h>
38 * This file defines and uses a number of different structures:
40 * OSSL_PROVIDER (provider_st): Used to represent all information related to a
41 * single instance of a provider.
43 * provider_store_st: Holds information about the collection of providers that
44 * are available within the current library context (OSSL_LIB_CTX). It also
45 * holds configuration information about providers that could be loaded at some
48 * OSSL_PROVIDER_CHILD_CB: An instance of this structure holds the callbacks
49 * that have been registered for a child library context and the associated
50 * provider that registered those callbacks.
52 * Where a child library context exists then it has its own instance of the
53 * provider store. Each provider that exists in the parent provider store, has
54 * an associated child provider in the child library context's provider store.
55 * As providers get activated or deactivated this needs to be mirrored in the
56 * associated child providers.
61 * There are a number of different locks used in this file and it is important
62 * to understand how they should be used in order to avoid deadlocks.
64 * Fields within a structure can often be "write once" on creation, and then
65 * "read many". Creation of a structure is done by a single thread, and
66 * therefore no lock is required for the "write once/read many" fields. It is
67 * safe for multiple threads to read these fields without a lock, because they
68 * will never be changed.
70 * However some fields may be changed after a structure has been created and
71 * shared between multiple threads. Where this is the case a lock is required.
73 * The locks available are:
75 * The provider flag_lock: Used to control updates to the various provider
76 * "flags" (flag_initialized and flag_activated) and associated
77 * "counts" (activatecnt).
79 * The provider refcnt_lock: Only ever used to control updates to the provider
82 * The provider optbits_lock: Used to control access to the provider's
83 * operation_bits and operation_bits_sz fields.
85 * The store default_path_lock: Used to control access to the provider store's
86 * default search path value (default_path)
88 * The store lock: Used to control the stack of provider's held within the
89 * provider store, as well as the stack of registered child provider callbacks.
91 * As a general rule-of-thumb it is best to:
92 * - keep the scope of the code that is protected by a lock to the absolute
94 * - try to keep the scope of the lock to within a single function (i.e. avoid
95 * making calls to other functions while holding a lock);
96 * - try to only ever hold one lock at a time.
98 * Unfortunately, it is not always possible to stick to the above guidelines.
99 * Where they are not adhered to there is always a danger of inadvertently
100 * introducing the possibility of deadlock. The following rules MUST be adhered
101 * to in order to avoid that:
102 * - Holding multiple locks at the same time is only allowed for the
103 * provider store lock, the provider flag_lock and the provider refcnt_lock.
104 * - When holding multiple locks they must be acquired in the following order of
106 * 1) provider store lock
107 * 2) provider flag_lock
108 * 3) provider refcnt_lock
109 * - When releasing locks they must be released in the reverse order to which
111 * - No locks may be held when making an upcall. NOTE: Some common functions
112 * can make upcalls as part of their normal operation. If you need to call
113 * some other function while holding a lock make sure you know whether it
114 * will make any upcalls or not. For example ossl_provider_up_ref() can call
115 * ossl_provider_up_ref_parent() which can call the c_prov_up_ref() upcall.
116 * - It is permissible to hold the store and flag locks when calling child
117 * provider callbacks. No other locks may be held during such callbacks.
120 static OSSL_PROVIDER
*provider_new(const char *name
,
121 OSSL_provider_init_fn
*init_function
,
122 STACK_OF(INFOPAIR
) *parameters
);
125 * Provider Object structure
126 * =========================
132 int (*create_cb
)(const OSSL_CORE_HANDLE
*provider
, void *cbdata
);
133 int (*remove_cb
)(const OSSL_CORE_HANDLE
*provider
, void *cbdata
);
134 int (*global_props_cb
)(const char *props
, void *cbdata
);
136 } OSSL_PROVIDER_CHILD_CB
;
137 DEFINE_STACK_OF(OSSL_PROVIDER_CHILD_CB
)
140 struct provider_store_st
; /* Forward declaration */
142 struct ossl_provider_st
{
144 unsigned int flag_initialized
:1;
145 unsigned int flag_activated
:1;
147 /* Getting and setting the flags require synchronization */
148 CRYPTO_RWLOCK
*flag_lock
;
150 /* OpenSSL library side data */
151 CRYPTO_REF_COUNT refcnt
;
152 CRYPTO_RWLOCK
*refcnt_lock
; /* For the ref counter */
157 OSSL_provider_init_fn
*init_function
;
158 STACK_OF(INFOPAIR
) *parameters
;
159 OSSL_LIB_CTX
*libctx
; /* The library context this instance is in */
160 struct provider_store_st
*store
; /* The store this instance belongs to */
163 * In the FIPS module inner provider, this isn't needed, since the
164 * error upcalls are always direct calls to the outer provider.
166 int error_lib
; /* ERR library number, one for each provider */
167 # ifndef OPENSSL_NO_ERR
168 ERR_STRING_DATA
*error_strings
; /* Copy of what the provider gives us */
172 /* Provider side functions */
173 OSSL_FUNC_provider_teardown_fn
*teardown
;
174 OSSL_FUNC_provider_gettable_params_fn
*gettable_params
;
175 OSSL_FUNC_provider_get_params_fn
*get_params
;
176 OSSL_FUNC_provider_get_capabilities_fn
*get_capabilities
;
177 OSSL_FUNC_provider_self_test_fn
*self_test
;
178 OSSL_FUNC_provider_query_operation_fn
*query_operation
;
179 OSSL_FUNC_provider_unquery_operation_fn
*unquery_operation
;
182 * Cache of bit to indicate of query_operation() has been called on
183 * a specific operation or not.
185 unsigned char *operation_bits
;
186 size_t operation_bits_sz
;
187 CRYPTO_RWLOCK
*opbits_lock
;
190 /* Whether this provider is the child of some other provider */
191 const OSSL_CORE_HANDLE
*handle
;
192 unsigned int ischild
:1;
195 /* Provider side data */
197 const OSSL_DISPATCH
*dispatch
;
199 DEFINE_STACK_OF(OSSL_PROVIDER
)
201 static int ossl_provider_cmp(const OSSL_PROVIDER
* const *a
,
202 const OSSL_PROVIDER
* const *b
)
204 return strcmp((*a
)->name
, (*b
)->name
);
208 * Provider Object store
209 * =====================
211 * The Provider Object store is a library context object, and therefore needs
215 struct provider_store_st
{
216 OSSL_LIB_CTX
*libctx
;
217 STACK_OF(OSSL_PROVIDER
) *providers
;
218 STACK_OF(OSSL_PROVIDER_CHILD_CB
) *child_cbs
;
219 CRYPTO_RWLOCK
*default_path_lock
;
222 OSSL_PROVIDER_INFO
*provinfo
;
225 unsigned int use_fallbacks
:1;
226 unsigned int freeing
:1;
230 * provider_deactivate_free() is a wrapper around ossl_provider_deactivate()
231 * and ossl_provider_free(), called as needed.
232 * Since this is only called when the provider store is being emptied, we
233 * don't need to care about any lock.
235 static void provider_deactivate_free(OSSL_PROVIDER
*prov
)
237 if (prov
->flag_activated
)
238 ossl_provider_deactivate(prov
, 1);
239 ossl_provider_free(prov
);
243 static void ossl_provider_child_cb_free(OSSL_PROVIDER_CHILD_CB
*cb
)
249 static void infopair_free(INFOPAIR
*pair
)
251 OPENSSL_free(pair
->name
);
252 OPENSSL_free(pair
->value
);
256 static INFOPAIR
*infopair_copy(const INFOPAIR
*src
)
258 INFOPAIR
*dest
= OPENSSL_zalloc(sizeof(*dest
));
262 if (src
->name
!= NULL
) {
263 dest
->name
= OPENSSL_strdup(src
->name
);
264 if (dest
->name
== NULL
)
267 if (src
->value
!= NULL
) {
268 dest
->value
= OPENSSL_strdup(src
->value
);
269 if (dest
->value
== NULL
)
274 OPENSSL_free(dest
->name
);
279 void ossl_provider_info_clear(OSSL_PROVIDER_INFO
*info
)
281 OPENSSL_free(info
->name
);
282 OPENSSL_free(info
->path
);
283 sk_INFOPAIR_pop_free(info
->parameters
, infopair_free
);
286 void ossl_provider_store_free(void *vstore
)
288 struct provider_store_st
*store
= vstore
;
294 OPENSSL_free(store
->default_path
);
295 sk_OSSL_PROVIDER_pop_free(store
->providers
, provider_deactivate_free
);
297 sk_OSSL_PROVIDER_CHILD_CB_pop_free(store
->child_cbs
,
298 ossl_provider_child_cb_free
);
300 CRYPTO_THREAD_lock_free(store
->default_path_lock
);
301 CRYPTO_THREAD_lock_free(store
->lock
);
302 for (i
= 0; i
< store
->numprovinfo
; i
++)
303 ossl_provider_info_clear(&store
->provinfo
[i
]);
304 OPENSSL_free(store
->provinfo
);
308 void *ossl_provider_store_new(OSSL_LIB_CTX
*ctx
)
310 struct provider_store_st
*store
= OPENSSL_zalloc(sizeof(*store
));
313 || (store
->providers
= sk_OSSL_PROVIDER_new(ossl_provider_cmp
)) == NULL
314 || (store
->default_path_lock
= CRYPTO_THREAD_lock_new()) == NULL
316 || (store
->child_cbs
= sk_OSSL_PROVIDER_CHILD_CB_new_null()) == NULL
318 || (store
->lock
= CRYPTO_THREAD_lock_new()) == NULL
) {
319 ossl_provider_store_free(store
);
323 store
->use_fallbacks
= 1;
328 static struct provider_store_st
*get_provider_store(OSSL_LIB_CTX
*libctx
)
330 struct provider_store_st
*store
= NULL
;
332 store
= ossl_lib_ctx_get_data(libctx
, OSSL_LIB_CTX_PROVIDER_STORE_INDEX
);
334 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_INTERNAL_ERROR
);
338 int ossl_provider_disable_fallback_loading(OSSL_LIB_CTX
*libctx
)
340 struct provider_store_st
*store
;
342 if ((store
= get_provider_store(libctx
)) != NULL
) {
343 if (!CRYPTO_THREAD_write_lock(store
->lock
))
345 store
->use_fallbacks
= 0;
346 CRYPTO_THREAD_unlock(store
->lock
);
352 #define BUILTINS_BLOCK_SIZE 10
354 int ossl_provider_info_add_to_store(OSSL_LIB_CTX
*libctx
,
355 OSSL_PROVIDER_INFO
*entry
)
357 struct provider_store_st
*store
= get_provider_store(libctx
);
360 if (entry
->name
== NULL
) {
361 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_PASSED_NULL_PARAMETER
);
366 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_INTERNAL_ERROR
);
370 if (!CRYPTO_THREAD_write_lock(store
->lock
))
372 if (store
->provinfosz
== 0) {
373 store
->provinfo
= OPENSSL_zalloc(sizeof(*store
->provinfo
)
374 * BUILTINS_BLOCK_SIZE
);
375 if (store
->provinfo
== NULL
)
377 store
->provinfosz
= BUILTINS_BLOCK_SIZE
;
378 } else if (store
->numprovinfo
== store
->provinfosz
) {
379 OSSL_PROVIDER_INFO
*tmpbuiltins
;
380 size_t newsz
= store
->provinfosz
+ BUILTINS_BLOCK_SIZE
;
382 tmpbuiltins
= OPENSSL_realloc(store
->provinfo
,
383 sizeof(*store
->provinfo
) * newsz
);
384 if (tmpbuiltins
== NULL
)
386 store
->provinfo
= tmpbuiltins
;
387 store
->provinfosz
= newsz
;
389 store
->provinfo
[store
->numprovinfo
] = *entry
;
390 store
->numprovinfo
++;
394 CRYPTO_THREAD_unlock(store
->lock
);
398 OSSL_PROVIDER
*ossl_provider_find(OSSL_LIB_CTX
*libctx
, const char *name
,
401 struct provider_store_st
*store
= NULL
;
402 OSSL_PROVIDER
*prov
= NULL
;
404 if ((store
= get_provider_store(libctx
)) != NULL
) {
405 OSSL_PROVIDER tmpl
= { 0, };
410 * Make sure any providers are loaded from config before we try to find
414 if (ossl_lib_ctx_is_default(libctx
))
415 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG
, NULL
);
419 tmpl
.name
= (char *)name
;
421 * A "find" operation can sort the stack, and therefore a write lock is
424 if (!CRYPTO_THREAD_write_lock(store
->lock
))
426 if ((i
= sk_OSSL_PROVIDER_find(store
->providers
, &tmpl
)) != -1)
427 prov
= sk_OSSL_PROVIDER_value(store
->providers
, i
);
428 CRYPTO_THREAD_unlock(store
->lock
);
429 if (prov
!= NULL
&& !ossl_provider_up_ref(prov
))
437 * Provider Object methods
438 * =======================
441 static OSSL_PROVIDER
*provider_new(const char *name
,
442 OSSL_provider_init_fn
*init_function
,
443 STACK_OF(INFOPAIR
) *parameters
)
445 OSSL_PROVIDER
*prov
= NULL
;
447 if ((prov
= OPENSSL_zalloc(sizeof(*prov
))) == NULL
)
450 if ((prov
->refcnt_lock
= CRYPTO_THREAD_lock_new()) == NULL
) {
452 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_CRYPTO_LIB
);
457 prov
->refcnt
= 1; /* 1 One reference to be returned */
459 if ((prov
->opbits_lock
= CRYPTO_THREAD_lock_new()) == NULL
460 || (prov
->flag_lock
= CRYPTO_THREAD_lock_new()) == NULL
461 || (prov
->parameters
= sk_INFOPAIR_deep_copy(parameters
,
463 infopair_free
)) == NULL
) {
464 ossl_provider_free(prov
);
465 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_CRYPTO_LIB
);
468 if ((prov
->name
= OPENSSL_strdup(name
)) == NULL
) {
469 ossl_provider_free(prov
);
473 prov
->init_function
= init_function
;
478 int ossl_provider_up_ref(OSSL_PROVIDER
*prov
)
482 if (CRYPTO_UP_REF(&prov
->refcnt
, &ref
, prov
->refcnt_lock
) <= 0)
487 if (!ossl_provider_up_ref_parent(prov
, 0)) {
488 ossl_provider_free(prov
);
498 static int provider_up_ref_intern(OSSL_PROVIDER
*prov
, int activate
)
501 return ossl_provider_activate(prov
, 1, 0);
503 return ossl_provider_up_ref(prov
);
506 static int provider_free_intern(OSSL_PROVIDER
*prov
, int deactivate
)
509 return ossl_provider_deactivate(prov
, 1);
511 ossl_provider_free(prov
);
517 * We assume that the requested provider does not already exist in the store.
518 * The caller should check. If it does exist then adding it to the store later
521 OSSL_PROVIDER
*ossl_provider_new(OSSL_LIB_CTX
*libctx
, const char *name
,
522 OSSL_provider_init_fn
*init_function
,
525 struct provider_store_st
*store
= NULL
;
526 OSSL_PROVIDER_INFO
template;
527 OSSL_PROVIDER
*prov
= NULL
;
529 if ((store
= get_provider_store(libctx
)) == NULL
)
532 memset(&template, 0, sizeof(template));
533 if (init_function
== NULL
) {
534 const OSSL_PROVIDER_INFO
*p
;
537 /* Check if this is a predefined builtin provider */
538 for (p
= ossl_predefined_providers
; p
->name
!= NULL
; p
++) {
539 if (strcmp(p
->name
, name
) == 0) {
544 if (p
->name
== NULL
) {
545 /* Check if this is a user added builtin provider */
546 if (!CRYPTO_THREAD_read_lock(store
->lock
))
548 for (i
= 0, p
= store
->provinfo
; i
< store
->numprovinfo
; p
++, i
++) {
549 if (strcmp(p
->name
, name
) == 0) {
554 CRYPTO_THREAD_unlock(store
->lock
);
557 template.init
= init_function
;
560 /* provider_new() generates an error, so no need here */
561 if ((prov
= provider_new(name
, template.init
, template.parameters
)) == NULL
)
564 prov
->libctx
= libctx
;
566 prov
->error_lib
= ERR_get_next_error_library();
570 * At this point, the provider is only partially "loaded". To be
571 * fully "loaded", ossl_provider_activate() must also be called and it must
572 * then be added to the provider store.
578 /* Assumes that the store lock is held */
579 static int create_provider_children(OSSL_PROVIDER
*prov
)
583 struct provider_store_st
*store
= prov
->store
;
584 OSSL_PROVIDER_CHILD_CB
*child_cb
;
587 max
= sk_OSSL_PROVIDER_CHILD_CB_num(store
->child_cbs
);
588 for (i
= 0; i
< max
; i
++) {
590 * This is newly activated (activatecnt == 1), so we need to
591 * create child providers as necessary.
593 child_cb
= sk_OSSL_PROVIDER_CHILD_CB_value(store
->child_cbs
, i
);
594 ret
&= child_cb
->create_cb((OSSL_CORE_HANDLE
*)prov
, child_cb
->cbdata
);
601 int ossl_provider_add_to_store(OSSL_PROVIDER
*prov
, OSSL_PROVIDER
**actualprov
,
602 int retain_fallbacks
)
604 struct provider_store_st
*store
;
606 OSSL_PROVIDER tmpl
= { 0, };
607 OSSL_PROVIDER
*actualtmp
= NULL
;
609 if (actualprov
!= NULL
)
612 if ((store
= get_provider_store(prov
->libctx
)) == NULL
)
615 if (!CRYPTO_THREAD_write_lock(store
->lock
))
618 tmpl
.name
= (char *)prov
->name
;
619 idx
= sk_OSSL_PROVIDER_find(store
->providers
, &tmpl
);
623 actualtmp
= sk_OSSL_PROVIDER_value(store
->providers
, idx
);
626 if (sk_OSSL_PROVIDER_push(store
->providers
, prov
) == 0)
629 if (!create_provider_children(prov
)) {
630 sk_OSSL_PROVIDER_delete_ptr(store
->providers
, prov
);
633 if (!retain_fallbacks
)
634 store
->use_fallbacks
= 0;
637 CRYPTO_THREAD_unlock(store
->lock
);
639 if (actualprov
!= NULL
) {
640 if (!ossl_provider_up_ref(actualtmp
)) {
641 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_CRYPTO_LIB
);
645 *actualprov
= actualtmp
;
650 * The provider is already in the store. Probably two threads
651 * independently initialised their own provider objects with the same
652 * name and raced to put them in the store. This thread lost. We
653 * deactivate the one we just created and use the one that already
655 * If we get here then we know we did not create provider children
656 * above, so we inform ossl_provider_deactivate not to attempt to remove
659 ossl_provider_deactivate(prov
, 0);
660 ossl_provider_free(prov
);
666 CRYPTO_THREAD_unlock(store
->lock
);
670 void ossl_provider_free(OSSL_PROVIDER
*prov
)
675 CRYPTO_DOWN_REF(&prov
->refcnt
, &ref
, prov
->refcnt_lock
);
678 * When the refcount drops to zero, we clean up the provider.
679 * Note that this also does teardown, which may seem late,
680 * considering that init happens on first activation. However,
681 * there may be other structures hanging on to the provider after
682 * the last deactivation and may therefore need full access to the
683 * provider's services. Therefore, we deinit late.
686 if (prov
->flag_initialized
) {
687 ossl_provider_teardown(prov
);
688 #ifndef OPENSSL_NO_ERR
690 if (prov
->error_strings
!= NULL
) {
691 ERR_unload_strings(prov
->error_lib
, prov
->error_strings
);
692 OPENSSL_free(prov
->error_strings
);
693 prov
->error_strings
= NULL
;
697 OPENSSL_free(prov
->operation_bits
);
698 prov
->operation_bits
= NULL
;
699 prov
->operation_bits_sz
= 0;
700 prov
->flag_initialized
= 0;
705 * We deregister thread handling whether or not the provider was
706 * initialized. If init was attempted but was not successful then
707 * the provider may still have registered a thread handler.
709 ossl_init_thread_deregister(prov
);
710 DSO_free(prov
->module
);
712 OPENSSL_free(prov
->name
);
713 OPENSSL_free(prov
->path
);
714 sk_INFOPAIR_pop_free(prov
->parameters
, infopair_free
);
715 CRYPTO_THREAD_lock_free(prov
->opbits_lock
);
716 CRYPTO_THREAD_lock_free(prov
->flag_lock
);
718 CRYPTO_THREAD_lock_free(prov
->refcnt_lock
);
723 else if (prov
->ischild
) {
724 ossl_provider_free_parent(prov
, 0);
731 int ossl_provider_set_module_path(OSSL_PROVIDER
*prov
, const char *module_path
)
733 OPENSSL_free(prov
->path
);
735 if (module_path
== NULL
)
737 if ((prov
->path
= OPENSSL_strdup(module_path
)) != NULL
)
742 static int infopair_add(STACK_OF(INFOPAIR
) **infopairsk
, const char *name
,
745 INFOPAIR
*pair
= NULL
;
747 if ((pair
= OPENSSL_zalloc(sizeof(*pair
))) == NULL
748 || (pair
->name
= OPENSSL_strdup(name
)) == NULL
749 || (pair
->value
= OPENSSL_strdup(value
)) == NULL
)
752 if ((*infopairsk
== NULL
753 && (*infopairsk
= sk_INFOPAIR_new_null()) == NULL
)
754 || sk_INFOPAIR_push(*infopairsk
, pair
) <= 0) {
755 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_CRYPTO_LIB
);
763 OPENSSL_free(pair
->name
);
764 OPENSSL_free(pair
->value
);
770 int ossl_provider_add_parameter(OSSL_PROVIDER
*prov
,
771 const char *name
, const char *value
)
773 return infopair_add(&prov
->parameters
, name
, value
);
776 int ossl_provider_info_add_parameter(OSSL_PROVIDER_INFO
*provinfo
,
780 return infopair_add(&provinfo
->parameters
, name
, value
);
784 * Provider activation.
786 * What "activation" means depends on the provider form; for built in
787 * providers (in the library or the application alike), the provider
788 * can already be considered to be loaded, all that's needed is to
789 * initialize it. However, for dynamically loadable provider modules,
790 * we must first load that module.
792 * Built in modules are distinguished from dynamically loaded modules
793 * with an already assigned init function.
795 static const OSSL_DISPATCH
*core_dispatch
; /* Define further down */
797 int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX
*libctx
,
800 struct provider_store_st
*store
;
804 p
= OPENSSL_strdup(path
);
808 if ((store
= get_provider_store(libctx
)) != NULL
809 && CRYPTO_THREAD_write_lock(store
->default_path_lock
)) {
810 OPENSSL_free(store
->default_path
);
811 store
->default_path
= p
;
812 CRYPTO_THREAD_unlock(store
->default_path_lock
);
819 const char *OSSL_PROVIDER_get0_default_search_path(OSSL_LIB_CTX
*libctx
)
821 struct provider_store_st
*store
;
824 if ((store
= get_provider_store(libctx
)) != NULL
825 && CRYPTO_THREAD_read_lock(store
->default_path_lock
)) {
826 path
= store
->default_path
;
827 CRYPTO_THREAD_unlock(store
->default_path_lock
);
833 * Internal version that doesn't affect the store flags, and thereby avoid
834 * locking. Direct callers must remember to set the store flags when
837 static int provider_init(OSSL_PROVIDER
*prov
)
839 const OSSL_DISPATCH
*provider_dispatch
= NULL
;
840 void *tmp_provctx
= NULL
; /* safety measure */
841 #ifndef OPENSSL_NO_ERR
843 OSSL_FUNC_provider_get_reason_strings_fn
*p_get_reason_strings
= NULL
;
848 if (!ossl_assert(!prov
->flag_initialized
)) {
849 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_INTERNAL_ERROR
);
854 * If the init function isn't set, it indicates that this provider is
857 if (prov
->init_function
== NULL
) {
861 if (prov
->module
== NULL
) {
862 char *allocated_path
= NULL
;
863 const char *module_path
= NULL
;
864 char *merged_path
= NULL
;
865 const char *load_dir
= NULL
;
866 char *allocated_load_dir
= NULL
;
867 struct provider_store_st
*store
;
869 if ((prov
->module
= DSO_new()) == NULL
) {
870 /* DSO_new() generates an error already */
874 if ((store
= get_provider_store(prov
->libctx
)) == NULL
875 || !CRYPTO_THREAD_read_lock(store
->default_path_lock
))
878 if (store
->default_path
!= NULL
) {
879 allocated_load_dir
= OPENSSL_strdup(store
->default_path
);
880 CRYPTO_THREAD_unlock(store
->default_path_lock
);
881 if (allocated_load_dir
== NULL
)
883 load_dir
= allocated_load_dir
;
885 CRYPTO_THREAD_unlock(store
->default_path_lock
);
888 if (load_dir
== NULL
) {
889 load_dir
= ossl_safe_getenv("OPENSSL_MODULES");
890 if (load_dir
== NULL
)
891 load_dir
= MODULESDIR
;
894 DSO_ctrl(prov
->module
, DSO_CTRL_SET_FLAGS
,
895 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY
, NULL
);
897 module_path
= prov
->path
;
898 if (module_path
== NULL
)
899 module_path
= allocated_path
=
900 DSO_convert_filename(prov
->module
, prov
->name
);
901 if (module_path
!= NULL
)
902 merged_path
= DSO_merge(prov
->module
, module_path
, load_dir
);
904 if (merged_path
== NULL
905 || (DSO_load(prov
->module
, merged_path
, NULL
, 0)) == NULL
) {
906 DSO_free(prov
->module
);
910 OPENSSL_free(merged_path
);
911 OPENSSL_free(allocated_path
);
912 OPENSSL_free(allocated_load_dir
);
915 if (prov
->module
== NULL
) {
916 /* DSO has already recorded errors, this is just a tracepoint */
917 ERR_raise_data(ERR_LIB_CRYPTO
, ERR_R_DSO_LIB
,
918 "name=%s", prov
->name
);
922 prov
->init_function
= (OSSL_provider_init_fn
*)
923 DSO_bind_func(prov
->module
, "OSSL_provider_init");
927 /* Check for and call the initialise function for the provider. */
928 if (prov
->init_function
== NULL
) {
929 ERR_raise_data(ERR_LIB_CRYPTO
, ERR_R_UNSUPPORTED
,
930 "name=%s, provider has no provider init function",
935 if (!prov
->init_function((OSSL_CORE_HANDLE
*)prov
, core_dispatch
,
936 &provider_dispatch
, &tmp_provctx
)) {
937 ERR_raise_data(ERR_LIB_CRYPTO
, ERR_R_INIT_FAIL
,
938 "name=%s", prov
->name
);
941 prov
->provctx
= tmp_provctx
;
942 prov
->dispatch
= provider_dispatch
;
944 for (; provider_dispatch
->function_id
!= 0; provider_dispatch
++) {
945 switch (provider_dispatch
->function_id
) {
946 case OSSL_FUNC_PROVIDER_TEARDOWN
:
948 OSSL_FUNC_provider_teardown(provider_dispatch
);
950 case OSSL_FUNC_PROVIDER_GETTABLE_PARAMS
:
951 prov
->gettable_params
=
952 OSSL_FUNC_provider_gettable_params(provider_dispatch
);
954 case OSSL_FUNC_PROVIDER_GET_PARAMS
:
956 OSSL_FUNC_provider_get_params(provider_dispatch
);
958 case OSSL_FUNC_PROVIDER_SELF_TEST
:
960 OSSL_FUNC_provider_self_test(provider_dispatch
);
962 case OSSL_FUNC_PROVIDER_GET_CAPABILITIES
:
963 prov
->get_capabilities
=
964 OSSL_FUNC_provider_get_capabilities(provider_dispatch
);
966 case OSSL_FUNC_PROVIDER_QUERY_OPERATION
:
967 prov
->query_operation
=
968 OSSL_FUNC_provider_query_operation(provider_dispatch
);
970 case OSSL_FUNC_PROVIDER_UNQUERY_OPERATION
:
971 prov
->unquery_operation
=
972 OSSL_FUNC_provider_unquery_operation(provider_dispatch
);
974 #ifndef OPENSSL_NO_ERR
976 case OSSL_FUNC_PROVIDER_GET_REASON_STRINGS
:
977 p_get_reason_strings
=
978 OSSL_FUNC_provider_get_reason_strings(provider_dispatch
);
985 #ifndef OPENSSL_NO_ERR
987 if (p_get_reason_strings
!= NULL
) {
988 const OSSL_ITEM
*reasonstrings
= p_get_reason_strings(prov
->provctx
);
992 * ERR_load_strings() handles ERR_STRING_DATA rather than OSSL_ITEM,
993 * although they are essentially the same type.
994 * Furthermore, ERR_load_strings() patches the array's error number
995 * with the error library number, so we need to make a copy of that
999 while (reasonstrings
[cnt
].id
!= 0) {
1000 if (ERR_GET_LIB(reasonstrings
[cnt
].id
) != 0)
1004 cnt
++; /* One for the terminating item */
1006 /* Allocate one extra item for the "library" name */
1007 prov
->error_strings
=
1008 OPENSSL_zalloc(sizeof(ERR_STRING_DATA
) * (cnt
+ 1));
1009 if (prov
->error_strings
== NULL
)
1013 * Set the "library" name.
1015 prov
->error_strings
[0].error
= ERR_PACK(prov
->error_lib
, 0, 0);
1016 prov
->error_strings
[0].string
= prov
->name
;
1018 * Copy reasonstrings item 0..cnt-1 to prov->error_trings positions
1021 for (cnt2
= 1; cnt2
<= cnt
; cnt2
++) {
1022 prov
->error_strings
[cnt2
].error
= (int)reasonstrings
[cnt2
-1].id
;
1023 prov
->error_strings
[cnt2
].string
= reasonstrings
[cnt2
-1].ptr
;
1026 ERR_load_strings(prov
->error_lib
, prov
->error_strings
);
1031 /* With this flag set, this provider has become fully "loaded". */
1032 prov
->flag_initialized
= 1;
1040 * Deactivate a provider. If upcalls is 0 then we suppress any upcalls to a
1041 * parent provider. If removechildren is 0 then we suppress any calls to remove
1043 * Return -1 on failure and the activation count on success
1045 static int provider_deactivate(OSSL_PROVIDER
*prov
, int upcalls
,
1049 struct provider_store_st
*store
;
1055 if (!ossl_assert(prov
!= NULL
))
1059 * No need to lock if we've got no store because we've not been shared with
1062 store
= get_provider_store(prov
->libctx
);
1066 if (lock
&& !CRYPTO_THREAD_read_lock(store
->lock
))
1068 if (lock
&& !CRYPTO_THREAD_write_lock(prov
->flag_lock
)) {
1069 CRYPTO_THREAD_unlock(store
->lock
);
1074 if (prov
->activatecnt
>= 2 && prov
->ischild
&& upcalls
) {
1076 * We have had a direct activation in this child libctx so we need to
1077 * now down the ref count in the parent provider. We do the actual down
1078 * ref outside of the flag_lock, since it could involve getting other
1085 if ((count
= --prov
->activatecnt
) < 1)
1086 prov
->flag_activated
= 0;
1093 if (removechildren
&& store
!= NULL
) {
1094 int i
, max
= sk_OSSL_PROVIDER_CHILD_CB_num(store
->child_cbs
);
1095 OSSL_PROVIDER_CHILD_CB
*child_cb
;
1097 for (i
= 0; i
< max
; i
++) {
1098 child_cb
= sk_OSSL_PROVIDER_CHILD_CB_value(store
->child_cbs
, i
);
1099 child_cb
->remove_cb((OSSL_CORE_HANDLE
*)prov
, child_cb
->cbdata
);
1104 CRYPTO_THREAD_unlock(prov
->flag_lock
);
1105 CRYPTO_THREAD_unlock(store
->lock
);
1109 ossl_provider_free_parent(prov
, 1);
1112 /* We don't deinit here, that's done in ossl_provider_free() */
1117 * Activate a provider.
1118 * Return -1 on failure and the activation count on success
1120 static int provider_activate(OSSL_PROVIDER
*prov
, int lock
, int upcalls
)
1123 struct provider_store_st
*store
;
1126 store
= prov
->store
;
1128 * If the provider hasn't been added to the store, then we don't need
1129 * any locks because we've not shared it with other threads.
1131 if (store
== NULL
) {
1133 if (!provider_init(prov
))
1138 if (prov
->ischild
&& upcalls
&& !ossl_provider_up_ref_parent(prov
, 1))
1142 if (lock
&& !CRYPTO_THREAD_read_lock(store
->lock
)) {
1144 if (prov
->ischild
&& upcalls
)
1145 ossl_provider_free_parent(prov
, 1);
1150 if (lock
&& !CRYPTO_THREAD_write_lock(prov
->flag_lock
)) {
1151 CRYPTO_THREAD_unlock(store
->lock
);
1153 if (prov
->ischild
&& upcalls
)
1154 ossl_provider_free_parent(prov
, 1);
1159 count
= ++prov
->activatecnt
;
1160 prov
->flag_activated
= 1;
1162 if (prov
->activatecnt
== 1 && store
!= NULL
) {
1163 ret
= create_provider_children(prov
);
1166 CRYPTO_THREAD_unlock(prov
->flag_lock
);
1167 CRYPTO_THREAD_unlock(store
->lock
);
1176 static int provider_flush_store_cache(const OSSL_PROVIDER
*prov
)
1178 struct provider_store_st
*store
;
1181 if ((store
= get_provider_store(prov
->libctx
)) == NULL
)
1184 if (!CRYPTO_THREAD_read_lock(store
->lock
))
1186 freeing
= store
->freeing
;
1187 CRYPTO_THREAD_unlock(store
->lock
);
1191 = evp_method_store_cache_flush(prov
->libctx
)
1193 + ossl_encoder_store_cache_flush(prov
->libctx
)
1194 + ossl_decoder_store_cache_flush(prov
->libctx
)
1195 + ossl_store_loader_store_cache_flush(prov
->libctx
)
1208 static int provider_remove_store_methods(OSSL_PROVIDER
*prov
)
1210 struct provider_store_st
*store
;
1213 if ((store
= get_provider_store(prov
->libctx
)) == NULL
)
1216 if (!CRYPTO_THREAD_read_lock(store
->lock
))
1218 freeing
= store
->freeing
;
1219 CRYPTO_THREAD_unlock(store
->lock
);
1224 if (!CRYPTO_THREAD_write_lock(prov
->opbits_lock
))
1226 OPENSSL_free(prov
->operation_bits
);
1227 prov
->operation_bits
= NULL
;
1228 prov
->operation_bits_sz
= 0;
1229 CRYPTO_THREAD_unlock(prov
->opbits_lock
);
1231 acc
= evp_method_store_remove_all_provided(prov
)
1233 + ossl_encoder_store_remove_all_provided(prov
)
1234 + ossl_decoder_store_remove_all_provided(prov
)
1235 + ossl_store_loader_store_remove_all_provided(prov
)
1248 int ossl_provider_activate(OSSL_PROVIDER
*prov
, int upcalls
, int aschild
)
1256 * If aschild is true, then we only actually do the activation if the
1257 * provider is a child. If its not, this is still success.
1259 if (aschild
&& !prov
->ischild
)
1262 if ((count
= provider_activate(prov
, 1, upcalls
)) > 0)
1263 return count
== 1 ? provider_flush_store_cache(prov
) : 1;
1268 int ossl_provider_deactivate(OSSL_PROVIDER
*prov
, int removechildren
)
1273 || (count
= provider_deactivate(prov
, 1, removechildren
)) < 0)
1275 return count
== 0 ? provider_remove_store_methods(prov
) : 1;
1278 void *ossl_provider_ctx(const OSSL_PROVIDER
*prov
)
1280 return prov
!= NULL
? prov
->provctx
: NULL
;
1284 * This function only does something once when store->use_fallbacks == 1,
1285 * and then sets store->use_fallbacks = 0, so the second call and so on is
1286 * effectively a no-op.
1288 static int provider_activate_fallbacks(struct provider_store_st
*store
)
1291 int activated_fallback_count
= 0;
1293 const OSSL_PROVIDER_INFO
*p
;
1295 if (!CRYPTO_THREAD_read_lock(store
->lock
))
1297 use_fallbacks
= store
->use_fallbacks
;
1298 CRYPTO_THREAD_unlock(store
->lock
);
1302 if (!CRYPTO_THREAD_write_lock(store
->lock
))
1304 /* Check again, just in case another thread changed it */
1305 use_fallbacks
= store
->use_fallbacks
;
1306 if (!use_fallbacks
) {
1307 CRYPTO_THREAD_unlock(store
->lock
);
1311 for (p
= ossl_predefined_providers
; p
->name
!= NULL
; p
++) {
1312 OSSL_PROVIDER
*prov
= NULL
;
1314 if (!p
->is_fallback
)
1317 * We use the internal constructor directly here,
1318 * otherwise we get a call loop
1320 prov
= provider_new(p
->name
, p
->init
, NULL
);
1323 prov
->libctx
= store
->libctx
;
1325 prov
->error_lib
= ERR_get_next_error_library();
1329 * We are calling provider_activate while holding the store lock. This
1330 * means the init function will be called while holding a lock. Normally
1331 * we try to avoid calling a user callback while holding a lock.
1332 * However, fallbacks are never third party providers so we accept this.
1334 if (provider_activate(prov
, 0, 0) < 0) {
1335 ossl_provider_free(prov
);
1338 prov
->store
= store
;
1339 if (sk_OSSL_PROVIDER_push(store
->providers
, prov
) == 0) {
1340 ossl_provider_free(prov
);
1343 activated_fallback_count
++;
1346 if (activated_fallback_count
> 0) {
1347 store
->use_fallbacks
= 0;
1351 CRYPTO_THREAD_unlock(store
->lock
);
1355 int ossl_provider_doall_activated(OSSL_LIB_CTX
*ctx
,
1356 int (*cb
)(OSSL_PROVIDER
*provider
,
1360 int ret
= 0, curr
, max
, ref
= 0;
1361 struct provider_store_st
*store
= get_provider_store(ctx
);
1362 STACK_OF(OSSL_PROVIDER
) *provs
= NULL
;
1366 * Make sure any providers are loaded from config before we try to use
1369 if (ossl_lib_ctx_is_default(ctx
))
1370 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG
, NULL
);
1375 if (!provider_activate_fallbacks(store
))
1379 * Under lock, grab a copy of the provider list and up_ref each
1380 * provider so that they don't disappear underneath us.
1382 if (!CRYPTO_THREAD_read_lock(store
->lock
))
1384 provs
= sk_OSSL_PROVIDER_dup(store
->providers
);
1385 if (provs
== NULL
) {
1386 CRYPTO_THREAD_unlock(store
->lock
);
1389 max
= sk_OSSL_PROVIDER_num(provs
);
1391 * We work backwards through the stack so that we can safely delete items
1394 for (curr
= max
- 1; curr
>= 0; curr
--) {
1395 OSSL_PROVIDER
*prov
= sk_OSSL_PROVIDER_value(provs
, curr
);
1397 if (!CRYPTO_THREAD_write_lock(prov
->flag_lock
))
1399 if (prov
->flag_activated
) {
1401 * We call CRYPTO_UP_REF directly rather than ossl_provider_up_ref
1402 * to avoid upping the ref count on the parent provider, which we
1403 * must not do while holding locks.
1405 if (CRYPTO_UP_REF(&prov
->refcnt
, &ref
, prov
->refcnt_lock
) <= 0) {
1406 CRYPTO_THREAD_unlock(prov
->flag_lock
);
1410 * It's already activated, but we up the activated count to ensure
1411 * it remains activated until after we've called the user callback.
1412 * We do this with no locking (because we already hold the locks)
1413 * and no upcalls (which must not be called when locks are held). In
1414 * theory this could mean the parent provider goes inactive, whilst
1415 * still activated in the child for a short period. That's ok.
1417 if (provider_activate(prov
, 0, 0) < 0) {
1418 CRYPTO_DOWN_REF(&prov
->refcnt
, &ref
, prov
->refcnt_lock
);
1419 CRYPTO_THREAD_unlock(prov
->flag_lock
);
1423 sk_OSSL_PROVIDER_delete(provs
, curr
);
1426 CRYPTO_THREAD_unlock(prov
->flag_lock
);
1428 CRYPTO_THREAD_unlock(store
->lock
);
1431 * Now, we sweep through all providers not under lock
1433 for (curr
= 0; curr
< max
; curr
++) {
1434 OSSL_PROVIDER
*prov
= sk_OSSL_PROVIDER_value(provs
, curr
);
1436 if (!cb(prov
, cbdata
)) {
1447 CRYPTO_THREAD_unlock(store
->lock
);
1450 * The pop_free call doesn't do what we want on an error condition. We
1451 * either start from the first item in the stack, or part way through if
1452 * we only processed some of the items.
1454 for (curr
++; curr
< max
; curr
++) {
1455 OSSL_PROVIDER
*prov
= sk_OSSL_PROVIDER_value(provs
, curr
);
1457 provider_deactivate(prov
, 0, 1);
1459 * As above where we did the up-ref, we don't call ossl_provider_free
1460 * to avoid making upcalls. There should always be at least one ref
1461 * to the provider in the store, so this should never drop to 0.
1463 CRYPTO_DOWN_REF(&prov
->refcnt
, &ref
, prov
->refcnt_lock
);
1465 * Not much we can do if this assert ever fails. So we don't use
1470 sk_OSSL_PROVIDER_free(provs
);
1474 int OSSL_PROVIDER_available(OSSL_LIB_CTX
*libctx
, const char *name
)
1476 OSSL_PROVIDER
*prov
= NULL
;
1478 struct provider_store_st
*store
= get_provider_store(libctx
);
1480 if (store
== NULL
|| !provider_activate_fallbacks(store
))
1483 prov
= ossl_provider_find(libctx
, name
, 0);
1485 if (!CRYPTO_THREAD_read_lock(prov
->flag_lock
))
1487 available
= prov
->flag_activated
;
1488 CRYPTO_THREAD_unlock(prov
->flag_lock
);
1489 ossl_provider_free(prov
);
1494 /* Getters of Provider Object data */
1495 const char *ossl_provider_name(const OSSL_PROVIDER
*prov
)
1500 const DSO
*ossl_provider_dso(const OSSL_PROVIDER
*prov
)
1502 return prov
->module
;
1505 const char *ossl_provider_module_name(const OSSL_PROVIDER
*prov
)
1510 return DSO_get_filename(prov
->module
);
1514 const char *ossl_provider_module_path(const OSSL_PROVIDER
*prov
)
1519 /* FIXME: Ensure it's a full path */
1520 return DSO_get_filename(prov
->module
);
1524 void *ossl_provider_prov_ctx(const OSSL_PROVIDER
*prov
)
1527 return prov
->provctx
;
1532 const OSSL_DISPATCH
*ossl_provider_get0_dispatch(const OSSL_PROVIDER
*prov
)
1535 return prov
->dispatch
;
1540 OSSL_LIB_CTX
*ossl_provider_libctx(const OSSL_PROVIDER
*prov
)
1542 return prov
!= NULL
? prov
->libctx
: NULL
;
1545 /* Wrappers around calls to the provider */
1546 void ossl_provider_teardown(const OSSL_PROVIDER
*prov
)
1548 if (prov
->teardown
!= NULL
1553 prov
->teardown(prov
->provctx
);
1556 const OSSL_PARAM
*ossl_provider_gettable_params(const OSSL_PROVIDER
*prov
)
1558 return prov
->gettable_params
== NULL
1559 ? NULL
: prov
->gettable_params(prov
->provctx
);
1562 int ossl_provider_get_params(const OSSL_PROVIDER
*prov
, OSSL_PARAM params
[])
1564 return prov
->get_params
== NULL
1565 ? 0 : prov
->get_params(prov
->provctx
, params
);
1568 int ossl_provider_self_test(const OSSL_PROVIDER
*prov
)
1572 if (prov
->self_test
== NULL
)
1574 ret
= prov
->self_test(prov
->provctx
);
1576 (void)provider_remove_store_methods((OSSL_PROVIDER
*)prov
);
1580 int ossl_provider_get_capabilities(const OSSL_PROVIDER
*prov
,
1581 const char *capability
,
1585 return prov
->get_capabilities
== NULL
1586 ? 1 : prov
->get_capabilities(prov
->provctx
, capability
, cb
, arg
);
1589 const OSSL_ALGORITHM
*ossl_provider_query_operation(const OSSL_PROVIDER
*prov
,
1593 const OSSL_ALGORITHM
*res
;
1595 if (prov
->query_operation
== NULL
)
1597 res
= prov
->query_operation(prov
->provctx
, operation_id
, no_cache
);
1598 #if defined(OPENSSL_NO_CACHED_FETCH)
1599 /* Forcing the non-caching of queries */
1600 if (no_cache
!= NULL
)
1606 void ossl_provider_unquery_operation(const OSSL_PROVIDER
*prov
,
1608 const OSSL_ALGORITHM
*algs
)
1610 if (prov
->unquery_operation
!= NULL
)
1611 prov
->unquery_operation(prov
->provctx
, operation_id
, algs
);
1614 int ossl_provider_set_operation_bit(OSSL_PROVIDER
*provider
, size_t bitnum
)
1616 size_t byte
= bitnum
/ 8;
1617 unsigned char bit
= (1 << (bitnum
% 8)) & 0xFF;
1619 if (!CRYPTO_THREAD_write_lock(provider
->opbits_lock
))
1621 if (provider
->operation_bits_sz
<= byte
) {
1622 unsigned char *tmp
= OPENSSL_realloc(provider
->operation_bits
,
1626 CRYPTO_THREAD_unlock(provider
->opbits_lock
);
1629 provider
->operation_bits
= tmp
;
1630 memset(provider
->operation_bits
+ provider
->operation_bits_sz
,
1631 '\0', byte
+ 1 - provider
->operation_bits_sz
);
1632 provider
->operation_bits_sz
= byte
+ 1;
1634 provider
->operation_bits
[byte
] |= bit
;
1635 CRYPTO_THREAD_unlock(provider
->opbits_lock
);
1639 int ossl_provider_test_operation_bit(OSSL_PROVIDER
*provider
, size_t bitnum
,
1642 size_t byte
= bitnum
/ 8;
1643 unsigned char bit
= (1 << (bitnum
% 8)) & 0xFF;
1645 if (!ossl_assert(result
!= NULL
)) {
1646 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_PASSED_NULL_PARAMETER
);
1651 if (!CRYPTO_THREAD_read_lock(provider
->opbits_lock
))
1653 if (provider
->operation_bits_sz
> byte
)
1654 *result
= ((provider
->operation_bits
[byte
] & bit
) != 0);
1655 CRYPTO_THREAD_unlock(provider
->opbits_lock
);
1660 const OSSL_CORE_HANDLE
*ossl_provider_get_parent(OSSL_PROVIDER
*prov
)
1662 return prov
->handle
;
1665 int ossl_provider_is_child(const OSSL_PROVIDER
*prov
)
1667 return prov
->ischild
;
1670 int ossl_provider_set_child(OSSL_PROVIDER
*prov
, const OSSL_CORE_HANDLE
*handle
)
1672 prov
->handle
= handle
;
1678 int ossl_provider_default_props_update(OSSL_LIB_CTX
*libctx
, const char *props
)
1681 struct provider_store_st
*store
= NULL
;
1683 OSSL_PROVIDER_CHILD_CB
*child_cb
;
1685 if ((store
= get_provider_store(libctx
)) == NULL
)
1688 if (!CRYPTO_THREAD_read_lock(store
->lock
))
1691 max
= sk_OSSL_PROVIDER_CHILD_CB_num(store
->child_cbs
);
1692 for (i
= 0; i
< max
; i
++) {
1693 child_cb
= sk_OSSL_PROVIDER_CHILD_CB_value(store
->child_cbs
, i
);
1694 child_cb
->global_props_cb(props
, child_cb
->cbdata
);
1697 CRYPTO_THREAD_unlock(store
->lock
);
1702 static int ossl_provider_register_child_cb(const OSSL_CORE_HANDLE
*handle
,
1704 const OSSL_CORE_HANDLE
*provider
,
1707 const OSSL_CORE_HANDLE
*provider
,
1709 int (*global_props_cb
)(
1715 * This is really an OSSL_PROVIDER that we created and cast to
1716 * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
1718 OSSL_PROVIDER
*thisprov
= (OSSL_PROVIDER
*)handle
;
1719 OSSL_PROVIDER
*prov
;
1720 OSSL_LIB_CTX
*libctx
= thisprov
->libctx
;
1721 struct provider_store_st
*store
= NULL
;
1722 int ret
= 0, i
, max
;
1723 OSSL_PROVIDER_CHILD_CB
*child_cb
;
1724 char *propsstr
= NULL
;
1726 if ((store
= get_provider_store(libctx
)) == NULL
)
1729 child_cb
= OPENSSL_malloc(sizeof(*child_cb
));
1730 if (child_cb
== NULL
)
1732 child_cb
->prov
= thisprov
;
1733 child_cb
->create_cb
= create_cb
;
1734 child_cb
->remove_cb
= remove_cb
;
1735 child_cb
->global_props_cb
= global_props_cb
;
1736 child_cb
->cbdata
= cbdata
;
1738 if (!CRYPTO_THREAD_write_lock(store
->lock
)) {
1739 OPENSSL_free(child_cb
);
1742 propsstr
= evp_get_global_properties_str(libctx
, 0);
1744 if (propsstr
!= NULL
) {
1745 global_props_cb(propsstr
, cbdata
);
1746 OPENSSL_free(propsstr
);
1748 max
= sk_OSSL_PROVIDER_num(store
->providers
);
1749 for (i
= 0; i
< max
; i
++) {
1752 prov
= sk_OSSL_PROVIDER_value(store
->providers
, i
);
1754 if (!CRYPTO_THREAD_read_lock(prov
->flag_lock
))
1756 activated
= prov
->flag_activated
;
1757 CRYPTO_THREAD_unlock(prov
->flag_lock
);
1759 * We hold the store lock while calling the user callback. This means
1760 * that the user callback must be short and simple and not do anything
1761 * likely to cause a deadlock. We don't hold the flag_lock during this
1762 * call. In theory this means that another thread could deactivate it
1763 * while we are calling create. This is ok because the other thread
1764 * will also call remove_cb, but won't be able to do so until we release
1767 if (activated
&& !create_cb((OSSL_CORE_HANDLE
*)prov
, cbdata
))
1772 ret
= sk_OSSL_PROVIDER_CHILD_CB_push(store
->child_cbs
, child_cb
);
1774 if (i
!= max
|| ret
<= 0) {
1775 /* Failed during creation. Remove everything we just added */
1776 for (; i
>= 0; i
--) {
1777 prov
= sk_OSSL_PROVIDER_value(store
->providers
, i
);
1778 remove_cb((OSSL_CORE_HANDLE
*)prov
, cbdata
);
1780 OPENSSL_free(child_cb
);
1783 CRYPTO_THREAD_unlock(store
->lock
);
1788 static void ossl_provider_deregister_child_cb(const OSSL_CORE_HANDLE
*handle
)
1791 * This is really an OSSL_PROVIDER that we created and cast to
1792 * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
1794 OSSL_PROVIDER
*thisprov
= (OSSL_PROVIDER
*)handle
;
1795 OSSL_LIB_CTX
*libctx
= thisprov
->libctx
;
1796 struct provider_store_st
*store
= NULL
;
1798 OSSL_PROVIDER_CHILD_CB
*child_cb
;
1800 if ((store
= get_provider_store(libctx
)) == NULL
)
1803 if (!CRYPTO_THREAD_write_lock(store
->lock
))
1805 max
= sk_OSSL_PROVIDER_CHILD_CB_num(store
->child_cbs
);
1806 for (i
= 0; i
< max
; i
++) {
1807 child_cb
= sk_OSSL_PROVIDER_CHILD_CB_value(store
->child_cbs
, i
);
1808 if (child_cb
->prov
== thisprov
) {
1809 /* Found an entry */
1810 sk_OSSL_PROVIDER_CHILD_CB_delete(store
->child_cbs
, i
);
1811 OPENSSL_free(child_cb
);
1815 CRYPTO_THREAD_unlock(store
->lock
);
1820 * Core functions for the provider
1821 * ===============================
1823 * This is the set of functions that the core makes available to the provider
1827 * This returns a list of Provider Object parameters with their types, for
1828 * discovery. We do not expect that many providers will use this, but one
1831 static const OSSL_PARAM param_types
[] = {
1832 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_VERSION
, OSSL_PARAM_UTF8_PTR
, NULL
, 0),
1833 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_PROV_NAME
, OSSL_PARAM_UTF8_PTR
,
1836 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_MODULE_FILENAME
, OSSL_PARAM_UTF8_PTR
,
1843 * Forward declare all the functions that are provided aa dispatch.
1844 * This ensures that the compiler will complain if they aren't defined
1845 * with the correct signature.
1847 static OSSL_FUNC_core_gettable_params_fn core_gettable_params
;
1848 static OSSL_FUNC_core_get_params_fn core_get_params
;
1849 static OSSL_FUNC_core_get_libctx_fn core_get_libctx
;
1850 static OSSL_FUNC_core_thread_start_fn core_thread_start
;
1852 static OSSL_FUNC_core_new_error_fn core_new_error
;
1853 static OSSL_FUNC_core_set_error_debug_fn core_set_error_debug
;
1854 static OSSL_FUNC_core_vset_error_fn core_vset_error
;
1855 static OSSL_FUNC_core_set_error_mark_fn core_set_error_mark
;
1856 static OSSL_FUNC_core_clear_last_error_mark_fn core_clear_last_error_mark
;
1857 static OSSL_FUNC_core_pop_error_to_mark_fn core_pop_error_to_mark
;
1858 OSSL_FUNC_BIO_new_file_fn ossl_core_bio_new_file
;
1859 OSSL_FUNC_BIO_new_membuf_fn ossl_core_bio_new_mem_buf
;
1860 OSSL_FUNC_BIO_read_ex_fn ossl_core_bio_read_ex
;
1861 OSSL_FUNC_BIO_write_ex_fn ossl_core_bio_write_ex
;
1862 OSSL_FUNC_BIO_gets_fn ossl_core_bio_gets
;
1863 OSSL_FUNC_BIO_puts_fn ossl_core_bio_puts
;
1864 OSSL_FUNC_BIO_up_ref_fn ossl_core_bio_up_ref
;
1865 OSSL_FUNC_BIO_free_fn ossl_core_bio_free
;
1866 OSSL_FUNC_BIO_vprintf_fn ossl_core_bio_vprintf
;
1867 OSSL_FUNC_BIO_vsnprintf_fn BIO_vsnprintf
;
1868 static OSSL_FUNC_self_test_cb_fn core_self_test_get_callback
;
1869 OSSL_FUNC_get_entropy_fn ossl_rand_get_entropy
;
1870 OSSL_FUNC_cleanup_entropy_fn ossl_rand_cleanup_entropy
;
1871 OSSL_FUNC_get_nonce_fn ossl_rand_get_nonce
;
1872 OSSL_FUNC_cleanup_nonce_fn ossl_rand_cleanup_nonce
;
1874 OSSL_FUNC_CRYPTO_malloc_fn CRYPTO_malloc
;
1875 OSSL_FUNC_CRYPTO_zalloc_fn CRYPTO_zalloc
;
1876 OSSL_FUNC_CRYPTO_free_fn CRYPTO_free
;
1877 OSSL_FUNC_CRYPTO_clear_free_fn CRYPTO_clear_free
;
1878 OSSL_FUNC_CRYPTO_realloc_fn CRYPTO_realloc
;
1879 OSSL_FUNC_CRYPTO_clear_realloc_fn CRYPTO_clear_realloc
;
1880 OSSL_FUNC_CRYPTO_secure_malloc_fn CRYPTO_secure_malloc
;
1881 OSSL_FUNC_CRYPTO_secure_zalloc_fn CRYPTO_secure_zalloc
;
1882 OSSL_FUNC_CRYPTO_secure_free_fn CRYPTO_secure_free
;
1883 OSSL_FUNC_CRYPTO_secure_clear_free_fn CRYPTO_secure_clear_free
;
1884 OSSL_FUNC_CRYPTO_secure_allocated_fn CRYPTO_secure_allocated
;
1885 OSSL_FUNC_OPENSSL_cleanse_fn OPENSSL_cleanse
;
1887 OSSL_FUNC_provider_register_child_cb_fn ossl_provider_register_child_cb
;
1888 OSSL_FUNC_provider_deregister_child_cb_fn ossl_provider_deregister_child_cb
;
1889 static OSSL_FUNC_provider_name_fn core_provider_get0_name
;
1890 static OSSL_FUNC_provider_get0_provider_ctx_fn core_provider_get0_provider_ctx
;
1891 static OSSL_FUNC_provider_get0_dispatch_fn core_provider_get0_dispatch
;
1892 static OSSL_FUNC_provider_up_ref_fn core_provider_up_ref_intern
;
1893 static OSSL_FUNC_provider_free_fn core_provider_free_intern
;
1894 static OSSL_FUNC_core_obj_add_sigid_fn core_obj_add_sigid
;
1895 static OSSL_FUNC_core_obj_create_fn core_obj_create
;
1898 static const OSSL_PARAM
*core_gettable_params(const OSSL_CORE_HANDLE
*handle
)
1903 static int core_get_params(const OSSL_CORE_HANDLE
*handle
, OSSL_PARAM params
[])
1908 * We created this object originally and we know it is actually an
1909 * OSSL_PROVIDER *, so the cast is safe
1911 OSSL_PROVIDER
*prov
= (OSSL_PROVIDER
*)handle
;
1913 if ((p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_CORE_VERSION
)) != NULL
)
1914 OSSL_PARAM_set_utf8_ptr(p
, OPENSSL_VERSION_STR
);
1915 if ((p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_CORE_PROV_NAME
)) != NULL
)
1916 OSSL_PARAM_set_utf8_ptr(p
, prov
->name
);
1919 if ((p
= OSSL_PARAM_locate(params
,
1920 OSSL_PROV_PARAM_CORE_MODULE_FILENAME
)) != NULL
)
1921 OSSL_PARAM_set_utf8_ptr(p
, ossl_provider_module_path(prov
));
1924 if (prov
->parameters
== NULL
)
1927 for (i
= 0; i
< sk_INFOPAIR_num(prov
->parameters
); i
++) {
1928 INFOPAIR
*pair
= sk_INFOPAIR_value(prov
->parameters
, i
);
1930 if ((p
= OSSL_PARAM_locate(params
, pair
->name
)) != NULL
)
1931 OSSL_PARAM_set_utf8_ptr(p
, pair
->value
);
1936 static OPENSSL_CORE_CTX
*core_get_libctx(const OSSL_CORE_HANDLE
*handle
)
1939 * We created this object originally and we know it is actually an
1940 * OSSL_PROVIDER *, so the cast is safe
1942 OSSL_PROVIDER
*prov
= (OSSL_PROVIDER
*)handle
;
1945 * Using ossl_provider_libctx would be wrong as that returns
1946 * NULL for |prov| == NULL and NULL libctx has a special meaning
1947 * that does not apply here. Here |prov| == NULL can happen only in
1948 * case of a coding error.
1950 assert(prov
!= NULL
);
1951 return (OPENSSL_CORE_CTX
*)prov
->libctx
;
1954 static int core_thread_start(const OSSL_CORE_HANDLE
*handle
,
1955 OSSL_thread_stop_handler_fn handfn
,
1959 * We created this object originally and we know it is actually an
1960 * OSSL_PROVIDER *, so the cast is safe
1962 OSSL_PROVIDER
*prov
= (OSSL_PROVIDER
*)handle
;
1964 return ossl_init_thread_start(prov
, arg
, handfn
);
1968 * The FIPS module inner provider doesn't implement these. They aren't
1969 * needed there, since the FIPS module upcalls are always the outer provider
1974 * These error functions should use |handle| to select the proper
1975 * library context to report in the correct error stack if error
1976 * stacks become tied to the library context.
1977 * We cannot currently do that since there's no support for it in the
1980 static void core_new_error(const OSSL_CORE_HANDLE
*handle
)
1985 static void core_set_error_debug(const OSSL_CORE_HANDLE
*handle
,
1986 const char *file
, int line
, const char *func
)
1988 ERR_set_debug(file
, line
, func
);
1991 static void core_vset_error(const OSSL_CORE_HANDLE
*handle
,
1992 uint32_t reason
, const char *fmt
, va_list args
)
1995 * We created this object originally and we know it is actually an
1996 * OSSL_PROVIDER *, so the cast is safe
1998 OSSL_PROVIDER
*prov
= (OSSL_PROVIDER
*)handle
;
2001 * If the uppermost 8 bits are non-zero, it's an OpenSSL library
2002 * error and will be treated as such. Otherwise, it's a new style
2003 * provider error and will be treated as such.
2005 if (ERR_GET_LIB(reason
) != 0) {
2006 ERR_vset_error(ERR_GET_LIB(reason
), ERR_GET_REASON(reason
), fmt
, args
);
2008 ERR_vset_error(prov
->error_lib
, (int)reason
, fmt
, args
);
2012 static int core_set_error_mark(const OSSL_CORE_HANDLE
*handle
)
2014 return ERR_set_mark();
2017 static int core_clear_last_error_mark(const OSSL_CORE_HANDLE
*handle
)
2019 return ERR_clear_last_mark();
2022 static int core_pop_error_to_mark(const OSSL_CORE_HANDLE
*handle
)
2024 return ERR_pop_to_mark();
2027 static void core_self_test_get_callback(OPENSSL_CORE_CTX
*libctx
,
2028 OSSL_CALLBACK
**cb
, void **cbarg
)
2030 OSSL_SELF_TEST_get_callback((OSSL_LIB_CTX
*)libctx
, cb
, cbarg
);
2033 static const char *core_provider_get0_name(const OSSL_CORE_HANDLE
*prov
)
2035 return OSSL_PROVIDER_get0_name((const OSSL_PROVIDER
*)prov
);
2038 static void *core_provider_get0_provider_ctx(const OSSL_CORE_HANDLE
*prov
)
2040 return OSSL_PROVIDER_get0_provider_ctx((const OSSL_PROVIDER
*)prov
);
2043 static const OSSL_DISPATCH
*
2044 core_provider_get0_dispatch(const OSSL_CORE_HANDLE
*prov
)
2046 return OSSL_PROVIDER_get0_dispatch((const OSSL_PROVIDER
*)prov
);
2049 static int core_provider_up_ref_intern(const OSSL_CORE_HANDLE
*prov
,
2052 return provider_up_ref_intern((OSSL_PROVIDER
*)prov
, activate
);
2055 static int core_provider_free_intern(const OSSL_CORE_HANDLE
*prov
,
2058 return provider_free_intern((OSSL_PROVIDER
*)prov
, deactivate
);
2061 static int core_obj_add_sigid(const OSSL_CORE_HANDLE
*prov
,
2062 const char *sign_name
, const char *digest_name
,
2063 const char *pkey_name
)
2065 int sign_nid
= OBJ_txt2nid(sign_name
);
2066 int digest_nid
= NID_undef
;
2067 int pkey_nid
= OBJ_txt2nid(pkey_name
);
2069 if (digest_name
!= NULL
&& digest_name
[0] != '\0'
2070 && (digest_nid
= OBJ_txt2nid(digest_name
)) == NID_undef
)
2073 if (sign_nid
== NID_undef
)
2077 * Check if it already exists. This is a success if so (even if we don't
2078 * have nids for the digest/pkey)
2080 if (OBJ_find_sigid_algs(sign_nid
, NULL
, NULL
))
2083 if (pkey_nid
== NID_undef
)
2086 return OBJ_add_sigid(sign_nid
, digest_nid
, pkey_nid
);
2089 static int core_obj_create(const OSSL_CORE_HANDLE
*prov
, const char *oid
,
2090 const char *sn
, const char *ln
)
2092 /* Check if it already exists and create it if not */
2093 return OBJ_txt2nid(oid
) != NID_undef
2094 || OBJ_create(oid
, sn
, ln
) != NID_undef
;
2096 #endif /* FIPS_MODULE */
2099 * Functions provided by the core.
2101 static const OSSL_DISPATCH core_dispatch_
[] = {
2102 { OSSL_FUNC_CORE_GETTABLE_PARAMS
, (void (*)(void))core_gettable_params
},
2103 { OSSL_FUNC_CORE_GET_PARAMS
, (void (*)(void))core_get_params
},
2104 { OSSL_FUNC_CORE_GET_LIBCTX
, (void (*)(void))core_get_libctx
},
2105 { OSSL_FUNC_CORE_THREAD_START
, (void (*)(void))core_thread_start
},
2107 { OSSL_FUNC_CORE_NEW_ERROR
, (void (*)(void))core_new_error
},
2108 { OSSL_FUNC_CORE_SET_ERROR_DEBUG
, (void (*)(void))core_set_error_debug
},
2109 { OSSL_FUNC_CORE_VSET_ERROR
, (void (*)(void))core_vset_error
},
2110 { OSSL_FUNC_CORE_SET_ERROR_MARK
, (void (*)(void))core_set_error_mark
},
2111 { OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK
,
2112 (void (*)(void))core_clear_last_error_mark
},
2113 { OSSL_FUNC_CORE_POP_ERROR_TO_MARK
, (void (*)(void))core_pop_error_to_mark
},
2114 { OSSL_FUNC_BIO_NEW_FILE
, (void (*)(void))ossl_core_bio_new_file
},
2115 { OSSL_FUNC_BIO_NEW_MEMBUF
, (void (*)(void))ossl_core_bio_new_mem_buf
},
2116 { OSSL_FUNC_BIO_READ_EX
, (void (*)(void))ossl_core_bio_read_ex
},
2117 { OSSL_FUNC_BIO_WRITE_EX
, (void (*)(void))ossl_core_bio_write_ex
},
2118 { OSSL_FUNC_BIO_GETS
, (void (*)(void))ossl_core_bio_gets
},
2119 { OSSL_FUNC_BIO_PUTS
, (void (*)(void))ossl_core_bio_puts
},
2120 { OSSL_FUNC_BIO_CTRL
, (void (*)(void))ossl_core_bio_ctrl
},
2121 { OSSL_FUNC_BIO_UP_REF
, (void (*)(void))ossl_core_bio_up_ref
},
2122 { OSSL_FUNC_BIO_FREE
, (void (*)(void))ossl_core_bio_free
},
2123 { OSSL_FUNC_BIO_VPRINTF
, (void (*)(void))ossl_core_bio_vprintf
},
2124 { OSSL_FUNC_BIO_VSNPRINTF
, (void (*)(void))BIO_vsnprintf
},
2125 { OSSL_FUNC_SELF_TEST_CB
, (void (*)(void))core_self_test_get_callback
},
2126 { OSSL_FUNC_GET_ENTROPY
, (void (*)(void))ossl_rand_get_entropy
},
2127 { OSSL_FUNC_CLEANUP_ENTROPY
, (void (*)(void))ossl_rand_cleanup_entropy
},
2128 { OSSL_FUNC_GET_NONCE
, (void (*)(void))ossl_rand_get_nonce
},
2129 { OSSL_FUNC_CLEANUP_NONCE
, (void (*)(void))ossl_rand_cleanup_nonce
},
2131 { OSSL_FUNC_CRYPTO_MALLOC
, (void (*)(void))CRYPTO_malloc
},
2132 { OSSL_FUNC_CRYPTO_ZALLOC
, (void (*)(void))CRYPTO_zalloc
},
2133 { OSSL_FUNC_CRYPTO_FREE
, (void (*)(void))CRYPTO_free
},
2134 { OSSL_FUNC_CRYPTO_CLEAR_FREE
, (void (*)(void))CRYPTO_clear_free
},
2135 { OSSL_FUNC_CRYPTO_REALLOC
, (void (*)(void))CRYPTO_realloc
},
2136 { OSSL_FUNC_CRYPTO_CLEAR_REALLOC
, (void (*)(void))CRYPTO_clear_realloc
},
2137 { OSSL_FUNC_CRYPTO_SECURE_MALLOC
, (void (*)(void))CRYPTO_secure_malloc
},
2138 { OSSL_FUNC_CRYPTO_SECURE_ZALLOC
, (void (*)(void))CRYPTO_secure_zalloc
},
2139 { OSSL_FUNC_CRYPTO_SECURE_FREE
, (void (*)(void))CRYPTO_secure_free
},
2140 { OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE
,
2141 (void (*)(void))CRYPTO_secure_clear_free
},
2142 { OSSL_FUNC_CRYPTO_SECURE_ALLOCATED
,
2143 (void (*)(void))CRYPTO_secure_allocated
},
2144 { OSSL_FUNC_OPENSSL_CLEANSE
, (void (*)(void))OPENSSL_cleanse
},
2146 { OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB
,
2147 (void (*)(void))ossl_provider_register_child_cb
},
2148 { OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB
,
2149 (void (*)(void))ossl_provider_deregister_child_cb
},
2150 { OSSL_FUNC_PROVIDER_NAME
,
2151 (void (*)(void))core_provider_get0_name
},
2152 { OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX
,
2153 (void (*)(void))core_provider_get0_provider_ctx
},
2154 { OSSL_FUNC_PROVIDER_GET0_DISPATCH
,
2155 (void (*)(void))core_provider_get0_dispatch
},
2156 { OSSL_FUNC_PROVIDER_UP_REF
,
2157 (void (*)(void))core_provider_up_ref_intern
},
2158 { OSSL_FUNC_PROVIDER_FREE
,
2159 (void (*)(void))core_provider_free_intern
},
2160 { OSSL_FUNC_CORE_OBJ_ADD_SIGID
, (void (*)(void))core_obj_add_sigid
},
2161 { OSSL_FUNC_CORE_OBJ_CREATE
, (void (*)(void))core_obj_create
},
2165 static const OSSL_DISPATCH
*core_dispatch
= core_dispatch_
;