2 * Copyright 2019-2020 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
10 #include <openssl/core.h>
11 #include <openssl/core_dispatch.h>
12 #include <openssl/core_names.h>
13 #include <openssl/provider.h>
14 #include <openssl/params.h>
15 #include <openssl/opensslv.h>
16 #include "crypto/cryptlib.h"
17 #include "crypto/evp.h" /* evp_method_store_flush */
18 #include "crypto/rand.h"
19 #include "internal/nelem.h"
20 #include "internal/thread_once.h"
21 #include "internal/provider.h"
22 #include "internal/refcount.h"
23 #include "provider_local.h"
25 # include <openssl/self_test.h>
28 static OSSL_PROVIDER
*provider_new(const char *name
,
29 OSSL_provider_init_fn
*init_function
);
32 * Provider Object structure
33 * =========================
40 DEFINE_STACK_OF(INFOPAIR
)
42 struct provider_store_st
; /* Forward declaration */
44 struct ossl_provider_st
{
46 unsigned int flag_initialized
:1;
47 unsigned int flag_activated
:1;
48 unsigned int flag_fallback
:1; /* Can be used as fallback */
49 unsigned int flag_activated_as_fallback
:1;
51 /* OpenSSL library side data */
52 CRYPTO_REF_COUNT refcnt
;
53 CRYPTO_RWLOCK
*refcnt_lock
; /* For the ref counter */
54 CRYPTO_REF_COUNT activatecnt
;
55 CRYPTO_RWLOCK
*activatecnt_lock
; /* For the activate counter */
59 OSSL_provider_init_fn
*init_function
;
60 STACK_OF(INFOPAIR
) *parameters
;
61 OSSL_LIB_CTX
*libctx
; /* The library context this instance is in */
62 struct provider_store_st
*store
; /* The store this instance belongs to */
65 * In the FIPS module inner provider, this isn't needed, since the
66 * error upcalls are always direct calls to the outer provider.
68 int error_lib
; /* ERR library number, one for each provider */
69 # ifndef OPENSSL_NO_ERR
70 ERR_STRING_DATA
*error_strings
; /* Copy of what the provider gives us */
74 /* Provider side functions */
75 OSSL_FUNC_provider_teardown_fn
*teardown
;
76 OSSL_FUNC_provider_gettable_params_fn
*gettable_params
;
77 OSSL_FUNC_provider_get_params_fn
*get_params
;
78 OSSL_FUNC_provider_get_capabilities_fn
*get_capabilities
;
79 OSSL_FUNC_provider_self_test_fn
*self_test
;
80 OSSL_FUNC_provider_query_operation_fn
*query_operation
;
83 * Cache of bit to indicate of query_operation() has been called on
84 * a specific operation or not.
86 unsigned char *operation_bits
;
87 size_t operation_bits_sz
;
88 CRYPTO_RWLOCK
*opbits_lock
;
90 /* Provider side data */
93 DEFINE_STACK_OF(OSSL_PROVIDER
)
95 static int ossl_provider_cmp(const OSSL_PROVIDER
* const *a
,
96 const OSSL_PROVIDER
* const *b
)
98 return strcmp((*a
)->name
, (*b
)->name
);
102 * Provider Object store
103 * =====================
105 * The Provider Object store is a library context object, and therefore needs
109 struct provider_store_st
{
110 STACK_OF(OSSL_PROVIDER
) *providers
;
113 unsigned int use_fallbacks
:1;
117 * provider_deactivate_free() is a wrapper around ossl_provider_deactivate()
118 * and ossl_provider_free(), called as needed.
119 * Since this is only called when the provider store is being emptied, we
120 * don't need to care about any lock.
122 static void provider_deactivate_free(OSSL_PROVIDER
*prov
)
124 if (prov
->flag_activated
)
125 ossl_provider_deactivate(prov
);
126 ossl_provider_free(prov
);
129 static void provider_store_free(void *vstore
)
131 struct provider_store_st
*store
= vstore
;
135 OPENSSL_free(store
->default_path
);
136 sk_OSSL_PROVIDER_pop_free(store
->providers
, provider_deactivate_free
);
137 CRYPTO_THREAD_lock_free(store
->lock
);
141 static void *provider_store_new(OSSL_LIB_CTX
*ctx
)
143 struct provider_store_st
*store
= OPENSSL_zalloc(sizeof(*store
));
144 const struct predefined_providers_st
*p
= NULL
;
147 || (store
->providers
= sk_OSSL_PROVIDER_new(ossl_provider_cmp
)) == NULL
148 || (store
->lock
= CRYPTO_THREAD_lock_new()) == NULL
) {
149 provider_store_free(store
);
152 store
->use_fallbacks
= 1;
154 for (p
= predefined_providers
; p
->name
!= NULL
; p
++) {
155 OSSL_PROVIDER
*prov
= NULL
;
158 * We use the internal constructor directly here,
159 * otherwise we get a call loop
161 prov
= provider_new(p
->name
, p
->init
);
164 || sk_OSSL_PROVIDER_push(store
->providers
, prov
) == 0) {
165 ossl_provider_free(prov
);
166 provider_store_free(store
);
167 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_INTERNAL_ERROR
);
173 prov
->error_lib
= ERR_get_next_error_library();
176 ossl_provider_set_fallback(prov
);
182 static const OSSL_LIB_CTX_METHOD provider_store_method
= {
187 static struct provider_store_st
*get_provider_store(OSSL_LIB_CTX
*libctx
)
189 struct provider_store_st
*store
= NULL
;
191 store
= ossl_lib_ctx_get_data(libctx
, OSSL_LIB_CTX_PROVIDER_STORE_INDEX
,
192 &provider_store_method
);
194 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_INTERNAL_ERROR
);
198 int ossl_provider_disable_fallback_loading(OSSL_LIB_CTX
*libctx
)
200 struct provider_store_st
*store
;
202 if ((store
= get_provider_store(libctx
)) != NULL
) {
203 store
->use_fallbacks
= 0;
209 OSSL_PROVIDER
*ossl_provider_find(OSSL_LIB_CTX
*libctx
, const char *name
,
212 struct provider_store_st
*store
= NULL
;
213 OSSL_PROVIDER
*prov
= NULL
;
215 if ((store
= get_provider_store(libctx
)) != NULL
) {
216 OSSL_PROVIDER tmpl
= { 0, };
221 * Make sure any providers are loaded from config before we try to find
225 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG
, NULL
);
228 tmpl
.name
= (char *)name
;
229 CRYPTO_THREAD_write_lock(store
->lock
);
230 if ((i
= sk_OSSL_PROVIDER_find(store
->providers
, &tmpl
)) == -1
231 || (prov
= sk_OSSL_PROVIDER_value(store
->providers
, i
)) == NULL
232 || !ossl_provider_up_ref(prov
))
234 CRYPTO_THREAD_unlock(store
->lock
);
241 * Provider Object methods
242 * =======================
245 static OSSL_PROVIDER
*provider_new(const char *name
,
246 OSSL_provider_init_fn
*init_function
)
248 OSSL_PROVIDER
*prov
= NULL
;
250 if ((prov
= OPENSSL_zalloc(sizeof(*prov
))) == NULL
252 || (prov
->refcnt_lock
= CRYPTO_THREAD_lock_new()) == NULL
253 || (prov
->activatecnt_lock
= CRYPTO_THREAD_lock_new()) == NULL
255 || !ossl_provider_up_ref(prov
) /* +1 One reference to be returned */
256 || (prov
->opbits_lock
= CRYPTO_THREAD_lock_new()) == NULL
257 || (prov
->name
= OPENSSL_strdup(name
)) == NULL
) {
258 ossl_provider_free(prov
);
259 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_MALLOC_FAILURE
);
263 prov
->init_function
= init_function
;
267 int ossl_provider_up_ref(OSSL_PROVIDER
*prov
)
271 if (CRYPTO_UP_REF(&prov
->refcnt
, &ref
, prov
->refcnt_lock
) <= 0)
276 OSSL_PROVIDER
*ossl_provider_new(OSSL_LIB_CTX
*libctx
, const char *name
,
277 OSSL_provider_init_fn
*init_function
,
280 struct provider_store_st
*store
= NULL
;
281 OSSL_PROVIDER
*prov
= NULL
;
283 if ((store
= get_provider_store(libctx
)) == NULL
)
286 if ((prov
= ossl_provider_find(libctx
, name
,
287 noconfig
)) != NULL
) { /* refcount +1 */
288 ossl_provider_free(prov
); /* refcount -1 */
289 ERR_raise_data(ERR_LIB_CRYPTO
, CRYPTO_R_PROVIDER_ALREADY_EXISTS
,
294 /* provider_new() generates an error, so no need here */
295 if ((prov
= provider_new(name
, init_function
)) == NULL
)
298 CRYPTO_THREAD_write_lock(store
->lock
);
299 if (!ossl_provider_up_ref(prov
)) { /* +1 One reference for the store */
300 ossl_provider_free(prov
); /* -1 Reference that was to be returned */
302 } else if (sk_OSSL_PROVIDER_push(store
->providers
, prov
) == 0) {
303 ossl_provider_free(prov
); /* -1 Store reference */
304 ossl_provider_free(prov
); /* -1 Reference that was to be returned */
307 prov
->libctx
= libctx
;
310 prov
->error_lib
= ERR_get_next_error_library();
313 CRYPTO_THREAD_unlock(store
->lock
);
316 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_MALLOC_FAILURE
);
319 * At this point, the provider is only partially "loaded". To be
320 * fully "loaded", ossl_provider_activate() must also be called.
326 static void free_infopair(INFOPAIR
*pair
)
328 OPENSSL_free(pair
->name
);
329 OPENSSL_free(pair
->value
);
333 void ossl_provider_free(OSSL_PROVIDER
*prov
)
338 CRYPTO_DOWN_REF(&prov
->refcnt
, &ref
, prov
->refcnt_lock
);
341 * When the refcount drops to zero, we clean up the provider.
342 * Note that this also does teardown, which may seem late,
343 * considering that init happens on first activation. However,
344 * there may be other structures hanging on to the provider after
345 * the last deactivation and may therefore need full access to the
346 * provider's services. Therefore, we deinit late.
349 if (prov
->flag_initialized
) {
351 ossl_init_thread_deregister(prov
);
353 if (prov
->teardown
!= NULL
)
354 prov
->teardown(prov
->provctx
);
355 #ifndef OPENSSL_NO_ERR
357 if (prov
->error_strings
!= NULL
) {
358 ERR_unload_strings(prov
->error_lib
, prov
->error_strings
);
359 OPENSSL_free(prov
->error_strings
);
360 prov
->error_strings
= NULL
;
364 OPENSSL_free(prov
->operation_bits
);
365 prov
->operation_bits
= NULL
;
366 prov
->operation_bits_sz
= 0;
367 prov
->flag_initialized
= 0;
371 DSO_free(prov
->module
);
373 OPENSSL_free(prov
->name
);
374 OPENSSL_free(prov
->path
);
375 sk_INFOPAIR_pop_free(prov
->parameters
, free_infopair
);
376 CRYPTO_THREAD_lock_free(prov
->opbits_lock
);
378 CRYPTO_THREAD_lock_free(prov
->refcnt_lock
);
379 CRYPTO_THREAD_lock_free(prov
->activatecnt_lock
);
387 int ossl_provider_set_module_path(OSSL_PROVIDER
*prov
, const char *module_path
)
389 OPENSSL_free(prov
->path
);
390 if (module_path
== NULL
)
392 if ((prov
->path
= OPENSSL_strdup(module_path
)) != NULL
)
394 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_MALLOC_FAILURE
);
398 int ossl_provider_add_parameter(OSSL_PROVIDER
*prov
,
399 const char *name
, const char *value
)
401 INFOPAIR
*pair
= NULL
;
403 if ((pair
= OPENSSL_zalloc(sizeof(*pair
))) != NULL
404 && (prov
->parameters
!= NULL
405 || (prov
->parameters
= sk_INFOPAIR_new_null()) != NULL
)
406 && (pair
->name
= OPENSSL_strdup(name
)) != NULL
407 && (pair
->value
= OPENSSL_strdup(value
)) != NULL
408 && sk_INFOPAIR_push(prov
->parameters
, pair
) > 0)
412 OPENSSL_free(pair
->name
);
413 OPENSSL_free(pair
->value
);
416 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_MALLOC_FAILURE
);
421 * Provider activation.
423 * What "activation" means depends on the provider form; for built in
424 * providers (in the library or the application alike), the provider
425 * can already be considered to be loaded, all that's needed is to
426 * initialize it. However, for dynamically loadable provider modules,
427 * we must first load that module.
429 * Built in modules are distinguished from dynamically loaded modules
430 * with an already assigned init function.
432 static const OSSL_DISPATCH
*core_dispatch
; /* Define further down */
434 int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX
*libctx
,
437 struct provider_store_st
*store
;
441 p
= OPENSSL_strdup(path
);
443 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_MALLOC_FAILURE
);
447 if ((store
= get_provider_store(libctx
)) != NULL
448 && CRYPTO_THREAD_write_lock(store
->lock
)) {
449 OPENSSL_free(store
->default_path
);
450 store
->default_path
= p
;
451 CRYPTO_THREAD_unlock(store
->lock
);
459 * Internal version that doesn't affect the store flags, and thereby avoid
460 * locking. Direct callers must remember to set the store flags when
463 static int provider_init(OSSL_PROVIDER
*prov
)
465 const OSSL_DISPATCH
*provider_dispatch
= NULL
;
466 void *tmp_provctx
= NULL
; /* safety measure */
467 #ifndef OPENSSL_NO_ERR
469 OSSL_FUNC_provider_get_reason_strings_fn
*p_get_reason_strings
= NULL
;
473 if (prov
->flag_initialized
)
477 * If the init function isn't set, it indicates that this provider is
480 if (prov
->init_function
== NULL
) {
484 if (prov
->module
== NULL
) {
485 char *allocated_path
= NULL
;
486 const char *module_path
= NULL
;
487 char *merged_path
= NULL
;
488 const char *load_dir
= NULL
;
489 struct provider_store_st
*store
;
491 if ((prov
->module
= DSO_new()) == NULL
) {
492 /* DSO_new() generates an error already */
496 if ((store
= get_provider_store(prov
->libctx
)) == NULL
497 || !CRYPTO_THREAD_read_lock(store
->lock
))
499 load_dir
= store
->default_path
;
501 if (load_dir
== NULL
) {
502 load_dir
= ossl_safe_getenv("OPENSSL_MODULES");
503 if (load_dir
== NULL
)
504 load_dir
= MODULESDIR
;
507 DSO_ctrl(prov
->module
, DSO_CTRL_SET_FLAGS
,
508 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY
, NULL
);
510 module_path
= prov
->path
;
511 if (module_path
== NULL
)
512 module_path
= allocated_path
=
513 DSO_convert_filename(prov
->module
, prov
->name
);
514 if (module_path
!= NULL
)
515 merged_path
= DSO_merge(prov
->module
, module_path
, load_dir
);
516 CRYPTO_THREAD_unlock(store
->lock
);
518 if (merged_path
== NULL
519 || (DSO_load(prov
->module
, merged_path
, NULL
, 0)) == NULL
) {
520 DSO_free(prov
->module
);
524 OPENSSL_free(merged_path
);
525 OPENSSL_free(allocated_path
);
528 if (prov
->module
!= NULL
)
529 prov
->init_function
= (OSSL_provider_init_fn
*)
530 DSO_bind_func(prov
->module
, "OSSL_provider_init");
534 /* Call the initialise function for the provider. */
535 if (prov
->init_function
== NULL
536 || !prov
->init_function((OSSL_CORE_HANDLE
*)prov
, core_dispatch
,
537 &provider_dispatch
, &tmp_provctx
)) {
538 ERR_raise_data(ERR_LIB_CRYPTO
, ERR_R_INIT_FAIL
,
539 "name=%s", prov
->name
);
541 DSO_free(prov
->module
);
546 prov
->provctx
= tmp_provctx
;
548 for (; provider_dispatch
->function_id
!= 0; provider_dispatch
++) {
549 switch (provider_dispatch
->function_id
) {
550 case OSSL_FUNC_PROVIDER_TEARDOWN
:
552 OSSL_FUNC_provider_teardown(provider_dispatch
);
554 case OSSL_FUNC_PROVIDER_GETTABLE_PARAMS
:
555 prov
->gettable_params
=
556 OSSL_FUNC_provider_gettable_params(provider_dispatch
);
558 case OSSL_FUNC_PROVIDER_GET_PARAMS
:
560 OSSL_FUNC_provider_get_params(provider_dispatch
);
562 case OSSL_FUNC_PROVIDER_SELF_TEST
:
564 OSSL_FUNC_provider_self_test(provider_dispatch
);
566 case OSSL_FUNC_PROVIDER_GET_CAPABILITIES
:
567 prov
->get_capabilities
=
568 OSSL_FUNC_provider_get_capabilities(provider_dispatch
);
570 case OSSL_FUNC_PROVIDER_QUERY_OPERATION
:
571 prov
->query_operation
=
572 OSSL_FUNC_provider_query_operation(provider_dispatch
);
574 #ifndef OPENSSL_NO_ERR
576 case OSSL_FUNC_PROVIDER_GET_REASON_STRINGS
:
577 p_get_reason_strings
=
578 OSSL_FUNC_provider_get_reason_strings(provider_dispatch
);
585 #ifndef OPENSSL_NO_ERR
587 if (p_get_reason_strings
!= NULL
) {
588 const OSSL_ITEM
*reasonstrings
= p_get_reason_strings(prov
->provctx
);
592 * ERR_load_strings() handles ERR_STRING_DATA rather than OSSL_ITEM,
593 * although they are essentially the same type.
594 * Furthermore, ERR_load_strings() patches the array's error number
595 * with the error library number, so we need to make a copy of that
599 while (reasonstrings
[cnt
].id
!= 0) {
600 if (ERR_GET_LIB(reasonstrings
[cnt
].id
) != 0)
604 cnt
++; /* One for the terminating item */
606 /* Allocate one extra item for the "library" name */
607 prov
->error_strings
=
608 OPENSSL_zalloc(sizeof(ERR_STRING_DATA
) * (cnt
+ 1));
609 if (prov
->error_strings
== NULL
)
613 * Set the "library" name.
615 prov
->error_strings
[0].error
= ERR_PACK(prov
->error_lib
, 0, 0);
616 prov
->error_strings
[0].string
= prov
->name
;
618 * Copy reasonstrings item 0..cnt-1 to prov->error_trings positions
621 for (cnt2
= 1; cnt2
<= cnt
; cnt2
++) {
622 prov
->error_strings
[cnt2
].error
= (int)reasonstrings
[cnt2
-1].id
;
623 prov
->error_strings
[cnt2
].string
= reasonstrings
[cnt2
-1].ptr
;
626 ERR_load_strings(prov
->error_lib
, prov
->error_strings
);
631 /* With this flag set, this provider has become fully "loaded". */
632 prov
->flag_initialized
= 1;
636 static int provider_deactivate(OSSL_PROVIDER
*prov
)
640 if (!ossl_assert(prov
!= NULL
))
643 if (CRYPTO_DOWN_REF(&prov
->activatecnt
, &ref
, prov
->activatecnt_lock
) <= 0)
647 prov
->flag_activated
= 0;
649 /* We don't deinit here, that's done in ossl_provider_free() */
653 static int provider_activate(OSSL_PROVIDER
*prov
)
657 if (CRYPTO_UP_REF(&prov
->activatecnt
, &ref
, prov
->activatecnt_lock
) <= 0)
660 if (provider_init(prov
)) {
661 prov
->flag_activated
= 1;
666 provider_deactivate(prov
);
670 int ossl_provider_activate(OSSL_PROVIDER
*prov
)
674 if (provider_activate(prov
)) {
675 CRYPTO_THREAD_write_lock(prov
->store
->lock
);
676 prov
->store
->use_fallbacks
= 0;
677 CRYPTO_THREAD_unlock(prov
->store
->lock
);
683 int ossl_provider_deactivate(OSSL_PROVIDER
*prov
)
687 return provider_deactivate(prov
);
690 void *ossl_provider_ctx(const OSSL_PROVIDER
*prov
)
692 return prov
->provctx
;
696 static int provider_forall_loaded(struct provider_store_st
*store
,
697 int *found_activated
,
698 int (*cb
)(OSSL_PROVIDER
*provider
,
706 num_provs
= sk_OSSL_PROVIDER_num(store
->providers
);
708 if (found_activated
!= NULL
)
709 *found_activated
= 0;
710 for (i
= 0; i
< num_provs
; i
++) {
711 OSSL_PROVIDER
*prov
=
712 sk_OSSL_PROVIDER_value(store
->providers
, i
);
714 if (prov
->flag_activated
) {
715 if (found_activated
!= NULL
)
716 *found_activated
= 1;
717 if (!(ret
= cb(prov
, cbdata
)))
726 * This function only does something once when store->use_fallbacks == 1,
727 * and then sets store->use_fallbacks = 0, so the second call and so on is
728 * effectively a no-op.
730 static void provider_activate_fallbacks(struct provider_store_st
*store
)
734 int activated_fallback_count
= 0;
737 CRYPTO_THREAD_read_lock(store
->lock
);
738 use_fallbacks
= store
->use_fallbacks
;
739 CRYPTO_THREAD_unlock(store
->lock
);
743 CRYPTO_THREAD_write_lock(store
->lock
);
744 /* Check again, just in case another thread changed it */
745 use_fallbacks
= store
->use_fallbacks
;
746 if (!use_fallbacks
) {
747 CRYPTO_THREAD_unlock(store
->lock
);
751 num_provs
= sk_OSSL_PROVIDER_num(store
->providers
);
752 for (i
= 0; i
< num_provs
; i
++) {
753 OSSL_PROVIDER
*prov
= sk_OSSL_PROVIDER_value(store
->providers
, i
);
755 if (ossl_provider_up_ref(prov
)) {
756 if (prov
->flag_fallback
) {
757 if (provider_activate(prov
)) {
758 prov
->flag_activated_as_fallback
= 1;
759 activated_fallback_count
++;
762 ossl_provider_free(prov
);
767 * We assume that all fallbacks have been added to the store before
768 * any fallback is activated.
769 * TODO: We may have to reconsider this, IF we find ourselves adding
770 * fallbacks after any previous fallback has been activated.
772 if (activated_fallback_count
> 0)
773 store
->use_fallbacks
= 0;
775 CRYPTO_THREAD_unlock(store
->lock
);
778 int ossl_provider_forall_loaded(OSSL_LIB_CTX
*ctx
,
779 int (*cb
)(OSSL_PROVIDER
*provider
,
784 struct provider_store_st
*store
= get_provider_store(ctx
);
788 * Make sure any providers are loaded from config before we try to use
791 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG
, NULL
);
795 provider_activate_fallbacks(store
);
797 CRYPTO_THREAD_read_lock(store
->lock
);
799 * Now, we sweep through all providers
801 ret
= provider_forall_loaded(store
, NULL
, cb
, cbdata
);
803 CRYPTO_THREAD_unlock(store
->lock
);
809 int ossl_provider_available(OSSL_PROVIDER
*prov
)
812 provider_activate_fallbacks(prov
->store
);
814 return prov
->flag_activated
;
819 /* Setters of Provider Object data */
820 int ossl_provider_set_fallback(OSSL_PROVIDER
*prov
)
825 prov
->flag_fallback
= 1;
829 /* Getters of Provider Object data */
830 const char *ossl_provider_name(const OSSL_PROVIDER
*prov
)
835 const DSO
*ossl_provider_dso(const OSSL_PROVIDER
*prov
)
840 const char *ossl_provider_module_name(const OSSL_PROVIDER
*prov
)
845 return DSO_get_filename(prov
->module
);
849 const char *ossl_provider_module_path(const OSSL_PROVIDER
*prov
)
854 /* FIXME: Ensure it's a full path */
855 return DSO_get_filename(prov
->module
);
859 void *ossl_provider_prov_ctx(const OSSL_PROVIDER
*prov
)
862 return prov
->provctx
;
867 OSSL_LIB_CTX
*ossl_provider_libctx(const OSSL_PROVIDER
*prov
)
869 /* TODO(3.0) just: return prov->libctx; */
870 return prov
!= NULL
? prov
->libctx
: NULL
;
873 /* Wrappers around calls to the provider */
874 void ossl_provider_teardown(const OSSL_PROVIDER
*prov
)
876 if (prov
->teardown
!= NULL
)
877 prov
->teardown(prov
->provctx
);
880 const OSSL_PARAM
*ossl_provider_gettable_params(const OSSL_PROVIDER
*prov
)
882 return prov
->gettable_params
== NULL
883 ? NULL
: prov
->gettable_params(prov
->provctx
);
886 int ossl_provider_get_params(const OSSL_PROVIDER
*prov
, OSSL_PARAM params
[])
888 return prov
->get_params
== NULL
889 ? 0 : prov
->get_params(prov
->provctx
, params
);
892 int ossl_provider_self_test(const OSSL_PROVIDER
*prov
)
896 if (prov
->self_test
== NULL
)
898 ret
= prov
->self_test(prov
->provctx
);
900 evp_method_store_flush(ossl_provider_libctx(prov
));
904 int ossl_provider_get_capabilities(const OSSL_PROVIDER
*prov
,
905 const char *capability
,
909 return prov
->get_capabilities
== NULL
910 ? 1 : prov
->get_capabilities(prov
->provctx
, capability
, cb
, arg
);
913 const OSSL_ALGORITHM
*ossl_provider_query_operation(const OSSL_PROVIDER
*prov
,
917 return prov
->query_operation
== NULL
918 ? NULL
: prov
->query_operation(prov
->provctx
, operation_id
, no_cache
);
921 int ossl_provider_set_operation_bit(OSSL_PROVIDER
*provider
, size_t bitnum
)
923 size_t byte
= bitnum
/ 8;
924 unsigned char bit
= (1 << (bitnum
% 8)) & 0xFF;
926 CRYPTO_THREAD_write_lock(provider
->opbits_lock
);
927 if (provider
->operation_bits_sz
<= byte
) {
928 unsigned char *tmp
= OPENSSL_realloc(provider
->operation_bits
,
932 CRYPTO_THREAD_unlock(provider
->opbits_lock
);
933 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_MALLOC_FAILURE
);
936 provider
->operation_bits
= tmp
;
937 memset(provider
->operation_bits
+ provider
->operation_bits_sz
,
938 '\0', byte
+ 1 - provider
->operation_bits_sz
);
939 provider
->operation_bits_sz
= byte
+ 1;
941 provider
->operation_bits
[byte
] |= bit
;
942 CRYPTO_THREAD_unlock(provider
->opbits_lock
);
946 int ossl_provider_test_operation_bit(OSSL_PROVIDER
*provider
, size_t bitnum
,
949 size_t byte
= bitnum
/ 8;
950 unsigned char bit
= (1 << (bitnum
% 8)) & 0xFF;
952 if (!ossl_assert(result
!= NULL
)) {
953 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_PASSED_NULL_PARAMETER
);
958 CRYPTO_THREAD_read_lock(provider
->opbits_lock
);
959 if (provider
->operation_bits_sz
> byte
)
960 *result
= ((provider
->operation_bits
[byte
] & bit
) != 0);
961 CRYPTO_THREAD_unlock(provider
->opbits_lock
);
966 * Core functions for the provider
967 * ===============================
969 * This is the set of functions that the core makes available to the provider
973 * This returns a list of Provider Object parameters with their types, for
974 * discovery. We do not expect that many providers will use this, but one
977 static const OSSL_PARAM param_types
[] = {
978 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_VERSION
, OSSL_PARAM_UTF8_PTR
, NULL
, 0),
979 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_PROV_NAME
, OSSL_PARAM_UTF8_PTR
,
982 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_MODULE_FILENAME
, OSSL_PARAM_UTF8_PTR
,
989 * Forward declare all the functions that are provided aa dispatch.
990 * This ensures that the compiler will complain if they aren't defined
991 * with the correct signature.
993 static OSSL_FUNC_core_gettable_params_fn core_gettable_params
;
994 static OSSL_FUNC_core_get_params_fn core_get_params
;
995 static OSSL_FUNC_core_thread_start_fn core_thread_start
;
996 static OSSL_FUNC_core_get_libctx_fn core_get_libctx
;
998 static OSSL_FUNC_core_new_error_fn core_new_error
;
999 static OSSL_FUNC_core_set_error_debug_fn core_set_error_debug
;
1000 static OSSL_FUNC_core_vset_error_fn core_vset_error
;
1001 static OSSL_FUNC_core_set_error_mark_fn core_set_error_mark
;
1002 static OSSL_FUNC_core_clear_last_error_mark_fn core_clear_last_error_mark
;
1003 static OSSL_FUNC_core_pop_error_to_mark_fn core_pop_error_to_mark
;
1006 static const OSSL_PARAM
*core_gettable_params(const OSSL_CORE_HANDLE
*handle
)
1011 static int core_get_params(const OSSL_CORE_HANDLE
*handle
, OSSL_PARAM params
[])
1016 * We created this object originally and we know it is actually an
1017 * OSSL_PROVIDER *, so the cast is safe
1019 OSSL_PROVIDER
*prov
= (OSSL_PROVIDER
*)handle
;
1021 if ((p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_CORE_VERSION
)) != NULL
)
1022 OSSL_PARAM_set_utf8_ptr(p
, OPENSSL_VERSION_STR
);
1023 if ((p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_CORE_PROV_NAME
)) != NULL
)
1024 OSSL_PARAM_set_utf8_ptr(p
, prov
->name
);
1027 if ((p
= OSSL_PARAM_locate(params
,
1028 OSSL_PROV_PARAM_CORE_MODULE_FILENAME
)) != NULL
)
1029 OSSL_PARAM_set_utf8_ptr(p
, ossl_provider_module_path(prov
));
1032 if (prov
->parameters
== NULL
)
1035 for (i
= 0; i
< sk_INFOPAIR_num(prov
->parameters
); i
++) {
1036 INFOPAIR
*pair
= sk_INFOPAIR_value(prov
->parameters
, i
);
1038 if ((p
= OSSL_PARAM_locate(params
, pair
->name
)) != NULL
)
1039 OSSL_PARAM_set_utf8_ptr(p
, pair
->value
);
1044 static OPENSSL_CORE_CTX
*core_get_libctx(const OSSL_CORE_HANDLE
*handle
)
1047 * We created this object originally and we know it is actually an
1048 * OSSL_PROVIDER *, so the cast is safe
1050 OSSL_PROVIDER
*prov
= (OSSL_PROVIDER
*)handle
;
1052 return (OPENSSL_CORE_CTX
*)ossl_provider_libctx(prov
);
1055 static int core_thread_start(const OSSL_CORE_HANDLE
*handle
,
1056 OSSL_thread_stop_handler_fn handfn
)
1059 * We created this object originally and we know it is actually an
1060 * OSSL_PROVIDER *, so the cast is safe
1062 OSSL_PROVIDER
*prov
= (OSSL_PROVIDER
*)handle
;
1064 return ossl_init_thread_start(prov
, prov
->provctx
, handfn
);
1068 * The FIPS module inner provider doesn't implement these. They aren't
1069 * needed there, since the FIPS module upcalls are always the outer provider
1074 * TODO(3.0) These error functions should use |handle| to select the proper
1075 * library context to report in the correct error stack, at least if error
1076 * stacks become tied to the library context.
1077 * We cannot currently do that since there's no support for it in the
1080 static void core_new_error(const OSSL_CORE_HANDLE
*handle
)
1085 static void core_set_error_debug(const OSSL_CORE_HANDLE
*handle
,
1086 const char *file
, int line
, const char *func
)
1088 ERR_set_debug(file
, line
, func
);
1091 static void core_vset_error(const OSSL_CORE_HANDLE
*handle
,
1092 uint32_t reason
, const char *fmt
, va_list args
)
1095 * We created this object originally and we know it is actually an
1096 * OSSL_PROVIDER *, so the cast is safe
1098 OSSL_PROVIDER
*prov
= (OSSL_PROVIDER
*)handle
;
1101 * If the uppermost 8 bits are non-zero, it's an OpenSSL library
1102 * error and will be treated as such. Otherwise, it's a new style
1103 * provider error and will be treated as such.
1105 if (ERR_GET_LIB(reason
) != 0) {
1106 ERR_vset_error(ERR_GET_LIB(reason
), ERR_GET_REASON(reason
), fmt
, args
);
1108 ERR_vset_error(prov
->error_lib
, (int)reason
, fmt
, args
);
1112 static int core_set_error_mark(const OSSL_CORE_HANDLE
*handle
)
1114 return ERR_set_mark();
1117 static int core_clear_last_error_mark(const OSSL_CORE_HANDLE
*handle
)
1119 return ERR_clear_last_mark();
1122 static int core_pop_error_to_mark(const OSSL_CORE_HANDLE
*handle
)
1124 return ERR_pop_to_mark();
1126 #endif /* FIPS_MODULE */
1129 * Functions provided by the core.
1131 static const OSSL_DISPATCH core_dispatch_
[] = {
1132 { OSSL_FUNC_CORE_GETTABLE_PARAMS
, (void (*)(void))core_gettable_params
},
1133 { OSSL_FUNC_CORE_GET_PARAMS
, (void (*)(void))core_get_params
},
1134 { OSSL_FUNC_CORE_GET_LIBCTX
, (void (*)(void))core_get_libctx
},
1135 { OSSL_FUNC_CORE_THREAD_START
, (void (*)(void))core_thread_start
},
1137 { OSSL_FUNC_CORE_NEW_ERROR
, (void (*)(void))core_new_error
},
1138 { OSSL_FUNC_CORE_SET_ERROR_DEBUG
, (void (*)(void))core_set_error_debug
},
1139 { OSSL_FUNC_CORE_VSET_ERROR
, (void (*)(void))core_vset_error
},
1140 { OSSL_FUNC_CORE_SET_ERROR_MARK
, (void (*)(void))core_set_error_mark
},
1141 { OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK
,
1142 (void (*)(void))core_clear_last_error_mark
},
1143 { OSSL_FUNC_CORE_POP_ERROR_TO_MARK
, (void (*)(void))core_pop_error_to_mark
},
1144 { OSSL_FUNC_BIO_NEW_FILE
, (void (*)(void))BIO_new_file
},
1145 { OSSL_FUNC_BIO_NEW_MEMBUF
, (void (*)(void))BIO_new_mem_buf
},
1146 { OSSL_FUNC_BIO_READ_EX
, (void (*)(void))BIO_read_ex
},
1147 { OSSL_FUNC_BIO_WRITE_EX
, (void (*)(void))BIO_write_ex
},
1148 { OSSL_FUNC_BIO_GETS
, (void (*)(void))BIO_gets
},
1149 { OSSL_FUNC_BIO_PUTS
, (void (*)(void))BIO_puts
},
1150 { OSSL_FUNC_BIO_CTRL
, (void (*)(void))BIO_ctrl
},
1151 { OSSL_FUNC_BIO_FREE
, (void (*)(void))BIO_free
},
1152 { OSSL_FUNC_BIO_VPRINTF
, (void (*)(void))BIO_vprintf
},
1153 { OSSL_FUNC_BIO_VSNPRINTF
, (void (*)(void))BIO_vsnprintf
},
1154 { OSSL_FUNC_SELF_TEST_CB
, (void (*)(void))OSSL_SELF_TEST_get_callback
},
1155 { OSSL_FUNC_GET_ENTROPY
, (void (*)(void))ossl_rand_get_entropy
},
1156 { OSSL_FUNC_CLEANUP_ENTROPY
, (void (*)(void))ossl_rand_cleanup_entropy
},
1157 { OSSL_FUNC_GET_NONCE
, (void (*)(void))ossl_rand_get_nonce
},
1158 { OSSL_FUNC_CLEANUP_NONCE
, (void (*)(void))ossl_rand_cleanup_nonce
},
1160 { OSSL_FUNC_CRYPTO_MALLOC
, (void (*)(void))CRYPTO_malloc
},
1161 { OSSL_FUNC_CRYPTO_ZALLOC
, (void (*)(void))CRYPTO_zalloc
},
1162 { OSSL_FUNC_CRYPTO_FREE
, (void (*)(void))CRYPTO_free
},
1163 { OSSL_FUNC_CRYPTO_CLEAR_FREE
, (void (*)(void))CRYPTO_clear_free
},
1164 { OSSL_FUNC_CRYPTO_REALLOC
, (void (*)(void))CRYPTO_realloc
},
1165 { OSSL_FUNC_CRYPTO_CLEAR_REALLOC
, (void (*)(void))CRYPTO_clear_realloc
},
1166 { OSSL_FUNC_CRYPTO_SECURE_MALLOC
, (void (*)(void))CRYPTO_secure_malloc
},
1167 { OSSL_FUNC_CRYPTO_SECURE_ZALLOC
, (void (*)(void))CRYPTO_secure_zalloc
},
1168 { OSSL_FUNC_CRYPTO_SECURE_FREE
, (void (*)(void))CRYPTO_secure_free
},
1169 { OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE
,
1170 (void (*)(void))CRYPTO_secure_clear_free
},
1171 { OSSL_FUNC_CRYPTO_SECURE_ALLOCATED
,
1172 (void (*)(void))CRYPTO_secure_allocated
},
1173 { OSSL_FUNC_OPENSSL_CLEANSE
, (void (*)(void))OPENSSL_cleanse
},
1177 static const OSSL_DISPATCH
*core_dispatch
= core_dispatch_
;