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
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 "internal/bio.h"
24 #include "provider_local.h"
26 # include <openssl/self_test.h>
29 static OSSL_PROVIDER *provider_new(const char *name,
30 OSSL_provider_init_fn *init_function);
33 * Provider Object structure
34 * =========================
41 DEFINE_STACK_OF(INFOPAIR)
43 struct provider_store_st; /* Forward declaration */
45 struct ossl_provider_st {
47 unsigned int flag_initialized:1;
48 unsigned int flag_activated:1;
49 unsigned int flag_fallback:1; /* Can be used as fallback */
50 unsigned int flag_activated_as_fallback:1;
52 /* Getting and setting the flags require synchronization */
53 CRYPTO_RWLOCK *flag_lock;
55 /* OpenSSL library side data */
56 CRYPTO_REF_COUNT refcnt;
57 CRYPTO_RWLOCK *refcnt_lock; /* For the ref counter */
58 CRYPTO_REF_COUNT activatecnt;
59 CRYPTO_RWLOCK *activatecnt_lock; /* For the activate counter */
63 OSSL_provider_init_fn *init_function;
64 STACK_OF(INFOPAIR) *parameters;
65 OSSL_LIB_CTX *libctx; /* The library context this instance is in */
66 struct provider_store_st *store; /* The store this instance belongs to */
69 * In the FIPS module inner provider, this isn't needed, since the
70 * error upcalls are always direct calls to the outer provider.
72 int error_lib; /* ERR library number, one for each provider */
73 # ifndef OPENSSL_NO_ERR
74 ERR_STRING_DATA *error_strings; /* Copy of what the provider gives us */
78 /* Provider side functions */
79 OSSL_FUNC_provider_teardown_fn *teardown;
80 OSSL_FUNC_provider_gettable_params_fn *gettable_params;
81 OSSL_FUNC_provider_get_params_fn *get_params;
82 OSSL_FUNC_provider_get_capabilities_fn *get_capabilities;
83 OSSL_FUNC_provider_self_test_fn *self_test;
84 OSSL_FUNC_provider_query_operation_fn *query_operation;
85 OSSL_FUNC_provider_unquery_operation_fn *unquery_operation;
88 * Cache of bit to indicate of query_operation() has been called on
89 * a specific operation or not.
91 unsigned char *operation_bits;
92 size_t operation_bits_sz;
93 CRYPTO_RWLOCK *opbits_lock;
95 /* Provider side data */
98 DEFINE_STACK_OF(OSSL_PROVIDER)
100 static int ossl_provider_cmp(const OSSL_PROVIDER * const *a,
101 const OSSL_PROVIDER * const *b)
103 return strcmp((*a)->name, (*b)->name);
107 * Provider Object store
108 * =====================
110 * The Provider Object store is a library context object, and therefore needs
114 struct provider_store_st {
115 STACK_OF(OSSL_PROVIDER) *providers;
118 unsigned int use_fallbacks:1;
122 * provider_deactivate_free() is a wrapper around ossl_provider_deactivate()
123 * and ossl_provider_free(), called as needed.
124 * Since this is only called when the provider store is being emptied, we
125 * don't need to care about any lock.
127 static void provider_deactivate_free(OSSL_PROVIDER *prov)
129 if (prov->flag_activated)
130 ossl_provider_deactivate(prov);
131 ossl_provider_free(prov);
134 static void provider_store_free(void *vstore)
136 struct provider_store_st *store = vstore;
140 OPENSSL_free(store->default_path);
141 sk_OSSL_PROVIDER_pop_free(store->providers, provider_deactivate_free);
142 CRYPTO_THREAD_lock_free(store->lock);
146 static void *provider_store_new(OSSL_LIB_CTX *ctx)
148 struct provider_store_st *store = OPENSSL_zalloc(sizeof(*store));
149 const struct predefined_providers_st *p = NULL;
152 || (store->providers = sk_OSSL_PROVIDER_new(ossl_provider_cmp)) == NULL
153 || (store->lock = CRYPTO_THREAD_lock_new()) == NULL) {
154 provider_store_free(store);
157 store->use_fallbacks = 1;
159 for (p = predefined_providers; p->name != NULL; p++) {
160 OSSL_PROVIDER *prov = NULL;
163 * We use the internal constructor directly here,
164 * otherwise we get a call loop
166 prov = provider_new(p->name, p->init);
169 || sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
170 ossl_provider_free(prov);
171 provider_store_free(store);
172 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
178 prov->error_lib = ERR_get_next_error_library();
181 ossl_provider_set_fallback(prov);
187 static const OSSL_LIB_CTX_METHOD provider_store_method = {
192 static struct provider_store_st *get_provider_store(OSSL_LIB_CTX *libctx)
194 struct provider_store_st *store = NULL;
196 store = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_PROVIDER_STORE_INDEX,
197 &provider_store_method);
199 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
203 int ossl_provider_disable_fallback_loading(OSSL_LIB_CTX *libctx)
205 struct provider_store_st *store;
207 if ((store = get_provider_store(libctx)) != NULL) {
208 CRYPTO_THREAD_write_lock(store->lock);
209 store->use_fallbacks = 0;
210 CRYPTO_THREAD_unlock(store->lock);
216 OSSL_PROVIDER *ossl_provider_find(OSSL_LIB_CTX *libctx, const char *name,
219 struct provider_store_st *store = NULL;
220 OSSL_PROVIDER *prov = NULL;
222 if ((store = get_provider_store(libctx)) != NULL) {
223 OSSL_PROVIDER tmpl = { 0, };
228 * Make sure any providers are loaded from config before we try to find
232 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
235 tmpl.name = (char *)name;
236 CRYPTO_THREAD_write_lock(store->lock);
237 if ((i = sk_OSSL_PROVIDER_find(store->providers, &tmpl)) == -1
238 || (prov = sk_OSSL_PROVIDER_value(store->providers, i)) == NULL
239 || !ossl_provider_up_ref(prov))
241 CRYPTO_THREAD_unlock(store->lock);
248 * Provider Object methods
249 * =======================
252 static OSSL_PROVIDER *provider_new(const char *name,
253 OSSL_provider_init_fn *init_function)
255 OSSL_PROVIDER *prov = NULL;
257 if ((prov = OPENSSL_zalloc(sizeof(*prov))) == NULL
259 || (prov->refcnt_lock = CRYPTO_THREAD_lock_new()) == NULL
260 || (prov->activatecnt_lock = CRYPTO_THREAD_lock_new()) == NULL
262 || !ossl_provider_up_ref(prov) /* +1 One reference to be returned */
263 || (prov->opbits_lock = CRYPTO_THREAD_lock_new()) == NULL
264 || (prov->flag_lock = CRYPTO_THREAD_lock_new()) == NULL
265 || (prov->name = OPENSSL_strdup(name)) == NULL) {
266 ossl_provider_free(prov);
267 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
271 prov->init_function = init_function;
275 int ossl_provider_up_ref(OSSL_PROVIDER *prov)
279 if (CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock) <= 0)
284 OSSL_PROVIDER *ossl_provider_new(OSSL_LIB_CTX *libctx, const char *name,
285 OSSL_provider_init_fn *init_function,
288 struct provider_store_st *store = NULL;
289 OSSL_PROVIDER *prov = NULL;
291 if ((store = get_provider_store(libctx)) == NULL)
294 if ((prov = ossl_provider_find(libctx, name,
295 noconfig)) != NULL) { /* refcount +1 */
296 ossl_provider_free(prov); /* refcount -1 */
297 ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_ALREADY_EXISTS,
302 /* provider_new() generates an error, so no need here */
303 if ((prov = provider_new(name, init_function)) == NULL)
306 CRYPTO_THREAD_write_lock(store->lock);
307 if (!ossl_provider_up_ref(prov)) { /* +1 One reference for the store */
308 ossl_provider_free(prov); /* -1 Reference that was to be returned */
310 } else if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
311 ossl_provider_free(prov); /* -1 Store reference */
312 ossl_provider_free(prov); /* -1 Reference that was to be returned */
315 prov->libctx = libctx;
318 prov->error_lib = ERR_get_next_error_library();
321 CRYPTO_THREAD_unlock(store->lock);
324 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
327 * At this point, the provider is only partially "loaded". To be
328 * fully "loaded", ossl_provider_activate() must also be called.
334 static void free_infopair(INFOPAIR *pair)
336 OPENSSL_free(pair->name);
337 OPENSSL_free(pair->value);
341 void ossl_provider_free(OSSL_PROVIDER *prov)
346 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
349 * When the refcount drops to zero, we clean up the provider.
350 * Note that this also does teardown, which may seem late,
351 * considering that init happens on first activation. However,
352 * there may be other structures hanging on to the provider after
353 * the last deactivation and may therefore need full access to the
354 * provider's services. Therefore, we deinit late.
357 if (prov->flag_initialized) {
359 ossl_init_thread_deregister(prov);
361 if (prov->teardown != NULL)
362 prov->teardown(prov->provctx);
363 #ifndef OPENSSL_NO_ERR
365 if (prov->error_strings != NULL) {
366 ERR_unload_strings(prov->error_lib, prov->error_strings);
367 OPENSSL_free(prov->error_strings);
368 prov->error_strings = NULL;
372 OPENSSL_free(prov->operation_bits);
373 prov->operation_bits = NULL;
374 prov->operation_bits_sz = 0;
375 prov->flag_initialized = 0;
379 DSO_free(prov->module);
381 OPENSSL_free(prov->name);
382 OPENSSL_free(prov->path);
383 sk_INFOPAIR_pop_free(prov->parameters, free_infopair);
384 CRYPTO_THREAD_lock_free(prov->opbits_lock);
385 CRYPTO_THREAD_lock_free(prov->flag_lock);
387 CRYPTO_THREAD_lock_free(prov->refcnt_lock);
388 CRYPTO_THREAD_lock_free(prov->activatecnt_lock);
396 int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *module_path)
398 OPENSSL_free(prov->path);
399 if (module_path == NULL)
401 if ((prov->path = OPENSSL_strdup(module_path)) != NULL)
403 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
407 int ossl_provider_add_parameter(OSSL_PROVIDER *prov,
408 const char *name, const char *value)
410 INFOPAIR *pair = NULL;
412 if ((pair = OPENSSL_zalloc(sizeof(*pair))) != NULL
413 && (prov->parameters != NULL
414 || (prov->parameters = sk_INFOPAIR_new_null()) != NULL)
415 && (pair->name = OPENSSL_strdup(name)) != NULL
416 && (pair->value = OPENSSL_strdup(value)) != NULL
417 && sk_INFOPAIR_push(prov->parameters, pair) > 0)
421 OPENSSL_free(pair->name);
422 OPENSSL_free(pair->value);
425 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
430 * Provider activation.
432 * What "activation" means depends on the provider form; for built in
433 * providers (in the library or the application alike), the provider
434 * can already be considered to be loaded, all that's needed is to
435 * initialize it. However, for dynamically loadable provider modules,
436 * we must first load that module.
438 * Built in modules are distinguished from dynamically loaded modules
439 * with an already assigned init function.
441 static const OSSL_DISPATCH *core_dispatch; /* Define further down */
443 int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *libctx,
446 struct provider_store_st *store;
450 p = OPENSSL_strdup(path);
452 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
456 if ((store = get_provider_store(libctx)) != NULL
457 && CRYPTO_THREAD_write_lock(store->lock)) {
458 OPENSSL_free(store->default_path);
459 store->default_path = p;
460 CRYPTO_THREAD_unlock(store->lock);
468 * Internal version that doesn't affect the store flags, and thereby avoid
469 * locking. Direct callers must remember to set the store flags when
472 static int provider_init(OSSL_PROVIDER *prov)
474 const OSSL_DISPATCH *provider_dispatch = NULL;
475 void *tmp_provctx = NULL; /* safety measure */
476 #ifndef OPENSSL_NO_ERR
478 OSSL_FUNC_provider_get_reason_strings_fn *p_get_reason_strings = NULL;
484 * The flag lock is used to lock init, not only because the flag is
485 * checked here and set at the end, but also because this function
486 * modifies a number of things in the provider structure that this
487 * function needs to perform under lock anyway.
489 CRYPTO_THREAD_write_lock(prov->flag_lock);
490 if (prov->flag_initialized) {
496 * If the init function isn't set, it indicates that this provider is
499 if (prov->init_function == NULL) {
503 if (prov->module == NULL) {
504 char *allocated_path = NULL;
505 const char *module_path = NULL;
506 char *merged_path = NULL;
507 const char *load_dir = NULL;
508 struct provider_store_st *store;
510 if ((prov->module = DSO_new()) == NULL) {
511 /* DSO_new() generates an error already */
515 if ((store = get_provider_store(prov->libctx)) == NULL
516 || !CRYPTO_THREAD_read_lock(store->lock))
518 load_dir = store->default_path;
519 CRYPTO_THREAD_unlock(store->lock);
521 if (load_dir == NULL) {
522 load_dir = ossl_safe_getenv("OPENSSL_MODULES");
523 if (load_dir == NULL)
524 load_dir = MODULESDIR;
527 DSO_ctrl(prov->module, DSO_CTRL_SET_FLAGS,
528 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY, NULL);
530 module_path = prov->path;
531 if (module_path == NULL)
532 module_path = allocated_path =
533 DSO_convert_filename(prov->module, prov->name);
534 if (module_path != NULL)
535 merged_path = DSO_merge(prov->module, module_path, load_dir);
537 if (merged_path == NULL
538 || (DSO_load(prov->module, merged_path, NULL, 0)) == NULL) {
539 DSO_free(prov->module);
543 OPENSSL_free(merged_path);
544 OPENSSL_free(allocated_path);
547 if (prov->module != NULL)
548 prov->init_function = (OSSL_provider_init_fn *)
549 DSO_bind_func(prov->module, "OSSL_provider_init");
553 /* Call the initialise function for the provider. */
554 if (prov->init_function == NULL
555 || !prov->init_function((OSSL_CORE_HANDLE *)prov, core_dispatch,
556 &provider_dispatch, &tmp_provctx)) {
557 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INIT_FAIL,
558 "name=%s", prov->name);
560 DSO_free(prov->module);
565 prov->provctx = tmp_provctx;
567 for (; provider_dispatch->function_id != 0; provider_dispatch++) {
568 switch (provider_dispatch->function_id) {
569 case OSSL_FUNC_PROVIDER_TEARDOWN:
571 OSSL_FUNC_provider_teardown(provider_dispatch);
573 case OSSL_FUNC_PROVIDER_GETTABLE_PARAMS:
574 prov->gettable_params =
575 OSSL_FUNC_provider_gettable_params(provider_dispatch);
577 case OSSL_FUNC_PROVIDER_GET_PARAMS:
579 OSSL_FUNC_provider_get_params(provider_dispatch);
581 case OSSL_FUNC_PROVIDER_SELF_TEST:
583 OSSL_FUNC_provider_self_test(provider_dispatch);
585 case OSSL_FUNC_PROVIDER_GET_CAPABILITIES:
586 prov->get_capabilities =
587 OSSL_FUNC_provider_get_capabilities(provider_dispatch);
589 case OSSL_FUNC_PROVIDER_QUERY_OPERATION:
590 prov->query_operation =
591 OSSL_FUNC_provider_query_operation(provider_dispatch);
593 case OSSL_FUNC_PROVIDER_UNQUERY_OPERATION:
594 prov->unquery_operation =
595 OSSL_FUNC_provider_unquery_operation(provider_dispatch);
597 #ifndef OPENSSL_NO_ERR
599 case OSSL_FUNC_PROVIDER_GET_REASON_STRINGS:
600 p_get_reason_strings =
601 OSSL_FUNC_provider_get_reason_strings(provider_dispatch);
608 #ifndef OPENSSL_NO_ERR
610 if (p_get_reason_strings != NULL) {
611 const OSSL_ITEM *reasonstrings = p_get_reason_strings(prov->provctx);
615 * ERR_load_strings() handles ERR_STRING_DATA rather than OSSL_ITEM,
616 * although they are essentially the same type.
617 * Furthermore, ERR_load_strings() patches the array's error number
618 * with the error library number, so we need to make a copy of that
622 while (reasonstrings[cnt].id != 0) {
623 if (ERR_GET_LIB(reasonstrings[cnt].id) != 0)
627 cnt++; /* One for the terminating item */
629 /* Allocate one extra item for the "library" name */
630 prov->error_strings =
631 OPENSSL_zalloc(sizeof(ERR_STRING_DATA) * (cnt + 1));
632 if (prov->error_strings == NULL)
636 * Set the "library" name.
638 prov->error_strings[0].error = ERR_PACK(prov->error_lib, 0, 0);
639 prov->error_strings[0].string = prov->name;
641 * Copy reasonstrings item 0..cnt-1 to prov->error_trings positions
644 for (cnt2 = 1; cnt2 <= cnt; cnt2++) {
645 prov->error_strings[cnt2].error = (int)reasonstrings[cnt2-1].id;
646 prov->error_strings[cnt2].string = reasonstrings[cnt2-1].ptr;
649 ERR_load_strings(prov->error_lib, prov->error_strings);
654 /* With this flag set, this provider has become fully "loaded". */
655 prov->flag_initialized = 1;
659 CRYPTO_THREAD_unlock(prov->flag_lock);
663 static int provider_deactivate(OSSL_PROVIDER *prov)
667 if (!ossl_assert(prov != NULL))
670 if (CRYPTO_DOWN_REF(&prov->activatecnt, &ref, prov->activatecnt_lock) <= 0)
674 CRYPTO_THREAD_write_lock(prov->flag_lock);
675 prov->flag_activated = 0;
676 CRYPTO_THREAD_unlock(prov->flag_lock);
679 /* We don't deinit here, that's done in ossl_provider_free() */
683 static int provider_activate(OSSL_PROVIDER *prov)
687 if (CRYPTO_UP_REF(&prov->activatecnt, &ref, prov->activatecnt_lock) <= 0)
690 if (provider_init(prov)) {
691 CRYPTO_THREAD_write_lock(prov->flag_lock);
692 prov->flag_activated = 1;
693 CRYPTO_THREAD_unlock(prov->flag_lock);
698 provider_deactivate(prov);
702 int ossl_provider_activate(OSSL_PROVIDER *prov, int retain_fallbacks)
706 if (provider_activate(prov)) {
707 if (!retain_fallbacks) {
708 CRYPTO_THREAD_write_lock(prov->store->lock);
709 prov->store->use_fallbacks = 0;
710 CRYPTO_THREAD_unlock(prov->store->lock);
717 int ossl_provider_deactivate(OSSL_PROVIDER *prov)
721 return provider_deactivate(prov);
724 void *ossl_provider_ctx(const OSSL_PROVIDER *prov)
726 return prov->provctx;
730 * This function only does something once when store->use_fallbacks == 1,
731 * and then sets store->use_fallbacks = 0, so the second call and so on is
732 * effectively a no-op.
734 static void provider_activate_fallbacks(struct provider_store_st *store)
738 int activated_fallback_count = 0;
741 CRYPTO_THREAD_read_lock(store->lock);
742 use_fallbacks = store->use_fallbacks;
743 CRYPTO_THREAD_unlock(store->lock);
747 CRYPTO_THREAD_write_lock(store->lock);
748 /* Check again, just in case another thread changed it */
749 use_fallbacks = store->use_fallbacks;
750 if (!use_fallbacks) {
751 CRYPTO_THREAD_unlock(store->lock);
755 num_provs = sk_OSSL_PROVIDER_num(store->providers);
756 for (i = 0; i < num_provs; i++) {
757 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(store->providers, i);
759 if (ossl_provider_up_ref(prov)) {
760 if (prov->flag_fallback) {
761 if (provider_activate(prov)) {
762 prov->flag_activated_as_fallback = 1;
763 activated_fallback_count++;
766 ossl_provider_free(prov);
771 * We assume that all fallbacks have been added to the store before
772 * any fallback is activated.
773 * TODO: We may have to reconsider this, IF we find ourselves adding
774 * fallbacks after any previous fallback has been activated.
776 if (activated_fallback_count > 0)
777 store->use_fallbacks = 0;
779 CRYPTO_THREAD_unlock(store->lock);
782 int ossl_provider_forall_loaded(OSSL_LIB_CTX *ctx,
783 int (*cb)(OSSL_PROVIDER *provider,
788 struct provider_store_st *store = get_provider_store(ctx);
789 STACK_OF(OSSL_PROVIDER) *provs = NULL;
793 * Make sure any providers are loaded from config before we try to use
796 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
801 provider_activate_fallbacks(store);
804 * Under lock, grab a copy of the provider list and up_ref each
805 * provider so that they don't disappear underneath us.
807 CRYPTO_THREAD_read_lock(store->lock);
808 provs = sk_OSSL_PROVIDER_dup(store->providers);
810 CRYPTO_THREAD_unlock(store->lock);
813 j = sk_OSSL_PROVIDER_num(provs);
814 for (i = 0; i < j; i++)
815 if (!ossl_provider_up_ref(sk_OSSL_PROVIDER_value(provs, i)))
817 CRYPTO_THREAD_unlock(store->lock);
820 * Now, we sweep through all providers not under lock
822 for (j = 0; j < i; j++) {
823 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, j);
825 if (prov->flag_activated && !cb(prov, cbdata))
833 CRYPTO_THREAD_unlock(store->lock);
835 /* The pop_free call doesn't do what we want on an error condition */
836 for (j = 0; j < i; j++)
837 ossl_provider_free(sk_OSSL_PROVIDER_value(provs, j));
838 sk_OSSL_PROVIDER_free(provs);
842 int ossl_provider_available(OSSL_PROVIDER *prov)
845 provider_activate_fallbacks(prov->store);
847 return prov->flag_activated;
852 /* Setters of Provider Object data */
853 int ossl_provider_set_fallback(OSSL_PROVIDER *prov)
858 prov->flag_fallback = 1;
862 /* Getters of Provider Object data */
863 const char *ossl_provider_name(const OSSL_PROVIDER *prov)
868 const DSO *ossl_provider_dso(const OSSL_PROVIDER *prov)
873 const char *ossl_provider_module_name(const OSSL_PROVIDER *prov)
878 return DSO_get_filename(prov->module);
882 const char *ossl_provider_module_path(const OSSL_PROVIDER *prov)
887 /* FIXME: Ensure it's a full path */
888 return DSO_get_filename(prov->module);
892 void *ossl_provider_prov_ctx(const OSSL_PROVIDER *prov)
895 return prov->provctx;
900 OSSL_LIB_CTX *ossl_provider_libctx(const OSSL_PROVIDER *prov)
902 /* TODO(3.0) just: return prov->libctx; */
903 return prov != NULL ? prov->libctx : NULL;
906 /* Wrappers around calls to the provider */
907 void ossl_provider_teardown(const OSSL_PROVIDER *prov)
909 if (prov->teardown != NULL)
910 prov->teardown(prov->provctx);
913 const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov)
915 return prov->gettable_params == NULL
916 ? NULL : prov->gettable_params(prov->provctx);
919 int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
921 return prov->get_params == NULL
922 ? 0 : prov->get_params(prov->provctx, params);
925 int ossl_provider_self_test(const OSSL_PROVIDER *prov)
929 if (prov->self_test == NULL)
931 ret = prov->self_test(prov->provctx);
933 evp_method_store_flush(ossl_provider_libctx(prov));
937 int ossl_provider_get_capabilities(const OSSL_PROVIDER *prov,
938 const char *capability,
942 return prov->get_capabilities == NULL
943 ? 1 : prov->get_capabilities(prov->provctx, capability, cb, arg);
946 const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov,
950 const OSSL_ALGORITHM *res;
952 if (prov->query_operation == NULL)
954 res = prov->query_operation(prov->provctx, operation_id, no_cache);
955 #if defined(OPENSSL_NO_CACHED_FETCH)
956 /* Forcing the non-caching of queries */
957 if (no_cache != NULL)
963 void ossl_provider_unquery_operation(const OSSL_PROVIDER *prov,
965 const OSSL_ALGORITHM *algs)
967 if (prov->unquery_operation != NULL)
968 prov->unquery_operation(prov->provctx, operation_id, algs);
971 int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum)
973 size_t byte = bitnum / 8;
974 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
976 CRYPTO_THREAD_write_lock(provider->opbits_lock);
977 if (provider->operation_bits_sz <= byte) {
978 unsigned char *tmp = OPENSSL_realloc(provider->operation_bits,
982 CRYPTO_THREAD_unlock(provider->opbits_lock);
983 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
986 provider->operation_bits = tmp;
987 memset(provider->operation_bits + provider->operation_bits_sz,
988 '\0', byte + 1 - provider->operation_bits_sz);
989 provider->operation_bits_sz = byte + 1;
991 provider->operation_bits[byte] |= bit;
992 CRYPTO_THREAD_unlock(provider->opbits_lock);
996 int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum,
999 size_t byte = bitnum / 8;
1000 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
1002 if (!ossl_assert(result != NULL)) {
1003 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
1008 CRYPTO_THREAD_read_lock(provider->opbits_lock);
1009 if (provider->operation_bits_sz > byte)
1010 *result = ((provider->operation_bits[byte] & bit) != 0);
1011 CRYPTO_THREAD_unlock(provider->opbits_lock);
1016 * Core functions for the provider
1017 * ===============================
1019 * This is the set of functions that the core makes available to the provider
1023 * This returns a list of Provider Object parameters with their types, for
1024 * discovery. We do not expect that many providers will use this, but one
1027 static const OSSL_PARAM param_types[] = {
1028 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
1029 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_PROV_NAME, OSSL_PARAM_UTF8_PTR,
1032 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_MODULE_FILENAME, OSSL_PARAM_UTF8_PTR,
1039 * Forward declare all the functions that are provided aa dispatch.
1040 * This ensures that the compiler will complain if they aren't defined
1041 * with the correct signature.
1043 static OSSL_FUNC_core_gettable_params_fn core_gettable_params;
1044 static OSSL_FUNC_core_get_params_fn core_get_params;
1045 static OSSL_FUNC_core_thread_start_fn core_thread_start;
1046 static OSSL_FUNC_core_get_libctx_fn core_get_libctx;
1048 static OSSL_FUNC_core_new_error_fn core_new_error;
1049 static OSSL_FUNC_core_set_error_debug_fn core_set_error_debug;
1050 static OSSL_FUNC_core_vset_error_fn core_vset_error;
1051 static OSSL_FUNC_core_set_error_mark_fn core_set_error_mark;
1052 static OSSL_FUNC_core_clear_last_error_mark_fn core_clear_last_error_mark;
1053 static OSSL_FUNC_core_pop_error_to_mark_fn core_pop_error_to_mark;
1056 static const OSSL_PARAM *core_gettable_params(const OSSL_CORE_HANDLE *handle)
1061 static int core_get_params(const OSSL_CORE_HANDLE *handle, OSSL_PARAM params[])
1066 * We created this object originally and we know it is actually an
1067 * OSSL_PROVIDER *, so the cast is safe
1069 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1071 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_VERSION)) != NULL)
1072 OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR);
1073 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_PROV_NAME)) != NULL)
1074 OSSL_PARAM_set_utf8_ptr(p, prov->name);
1077 if ((p = OSSL_PARAM_locate(params,
1078 OSSL_PROV_PARAM_CORE_MODULE_FILENAME)) != NULL)
1079 OSSL_PARAM_set_utf8_ptr(p, ossl_provider_module_path(prov));
1082 if (prov->parameters == NULL)
1085 for (i = 0; i < sk_INFOPAIR_num(prov->parameters); i++) {
1086 INFOPAIR *pair = sk_INFOPAIR_value(prov->parameters, i);
1088 if ((p = OSSL_PARAM_locate(params, pair->name)) != NULL)
1089 OSSL_PARAM_set_utf8_ptr(p, pair->value);
1094 static OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle)
1097 * We created this object originally and we know it is actually an
1098 * OSSL_PROVIDER *, so the cast is safe
1100 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1102 return (OPENSSL_CORE_CTX *)ossl_provider_libctx(prov);
1105 static int core_thread_start(const OSSL_CORE_HANDLE *handle,
1106 OSSL_thread_stop_handler_fn handfn)
1109 * We created this object originally and we know it is actually an
1110 * OSSL_PROVIDER *, so the cast is safe
1112 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1114 return ossl_init_thread_start(prov, prov->provctx, handfn);
1118 * The FIPS module inner provider doesn't implement these. They aren't
1119 * needed there, since the FIPS module upcalls are always the outer provider
1124 * TODO(3.0) These error functions should use |handle| to select the proper
1125 * library context to report in the correct error stack, at least if error
1126 * stacks become tied to the library context.
1127 * We cannot currently do that since there's no support for it in the
1130 static void core_new_error(const OSSL_CORE_HANDLE *handle)
1135 static void core_set_error_debug(const OSSL_CORE_HANDLE *handle,
1136 const char *file, int line, const char *func)
1138 ERR_set_debug(file, line, func);
1141 static void core_vset_error(const OSSL_CORE_HANDLE *handle,
1142 uint32_t reason, const char *fmt, va_list args)
1145 * We created this object originally and we know it is actually an
1146 * OSSL_PROVIDER *, so the cast is safe
1148 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1151 * If the uppermost 8 bits are non-zero, it's an OpenSSL library
1152 * error and will be treated as such. Otherwise, it's a new style
1153 * provider error and will be treated as such.
1155 if (ERR_GET_LIB(reason) != 0) {
1156 ERR_vset_error(ERR_GET_LIB(reason), ERR_GET_REASON(reason), fmt, args);
1158 ERR_vset_error(prov->error_lib, (int)reason, fmt, args);
1162 static int core_set_error_mark(const OSSL_CORE_HANDLE *handle)
1164 return ERR_set_mark();
1167 static int core_clear_last_error_mark(const OSSL_CORE_HANDLE *handle)
1169 return ERR_clear_last_mark();
1172 static int core_pop_error_to_mark(const OSSL_CORE_HANDLE *handle)
1174 return ERR_pop_to_mark();
1176 #endif /* FIPS_MODULE */
1179 * Functions provided by the core.
1181 static const OSSL_DISPATCH core_dispatch_[] = {
1182 { OSSL_FUNC_CORE_GETTABLE_PARAMS, (void (*)(void))core_gettable_params },
1183 { OSSL_FUNC_CORE_GET_PARAMS, (void (*)(void))core_get_params },
1184 { OSSL_FUNC_CORE_GET_LIBCTX, (void (*)(void))core_get_libctx },
1185 { OSSL_FUNC_CORE_THREAD_START, (void (*)(void))core_thread_start },
1187 { OSSL_FUNC_CORE_NEW_ERROR, (void (*)(void))core_new_error },
1188 { OSSL_FUNC_CORE_SET_ERROR_DEBUG, (void (*)(void))core_set_error_debug },
1189 { OSSL_FUNC_CORE_VSET_ERROR, (void (*)(void))core_vset_error },
1190 { OSSL_FUNC_CORE_SET_ERROR_MARK, (void (*)(void))core_set_error_mark },
1191 { OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK,
1192 (void (*)(void))core_clear_last_error_mark },
1193 { OSSL_FUNC_CORE_POP_ERROR_TO_MARK, (void (*)(void))core_pop_error_to_mark },
1194 { OSSL_FUNC_BIO_NEW_FILE, (void (*)(void))ossl_core_bio_new_file },
1195 { OSSL_FUNC_BIO_NEW_MEMBUF, (void (*)(void))ossl_core_bio_new_mem_buf },
1196 { OSSL_FUNC_BIO_READ_EX, (void (*)(void))ossl_core_bio_read_ex },
1197 { OSSL_FUNC_BIO_WRITE_EX, (void (*)(void))ossl_core_bio_write_ex },
1198 { OSSL_FUNC_BIO_GETS, (void (*)(void))ossl_core_bio_gets },
1199 { OSSL_FUNC_BIO_PUTS, (void (*)(void))ossl_core_bio_puts },
1200 { OSSL_FUNC_BIO_CTRL, (void (*)(void))ossl_core_bio_ctrl },
1201 { OSSL_FUNC_BIO_UP_REF, (void (*)(void))ossl_core_bio_up_ref },
1202 { OSSL_FUNC_BIO_FREE, (void (*)(void))ossl_core_bio_free },
1203 { OSSL_FUNC_BIO_VPRINTF, (void (*)(void))ossl_core_bio_vprintf },
1204 { OSSL_FUNC_BIO_VSNPRINTF, (void (*)(void))BIO_vsnprintf },
1205 { OSSL_FUNC_SELF_TEST_CB, (void (*)(void))OSSL_SELF_TEST_get_callback },
1206 { OSSL_FUNC_GET_ENTROPY, (void (*)(void))ossl_rand_get_entropy },
1207 { OSSL_FUNC_CLEANUP_ENTROPY, (void (*)(void))ossl_rand_cleanup_entropy },
1208 { OSSL_FUNC_GET_NONCE, (void (*)(void))ossl_rand_get_nonce },
1209 { OSSL_FUNC_CLEANUP_NONCE, (void (*)(void))ossl_rand_cleanup_nonce },
1211 { OSSL_FUNC_CRYPTO_MALLOC, (void (*)(void))CRYPTO_malloc },
1212 { OSSL_FUNC_CRYPTO_ZALLOC, (void (*)(void))CRYPTO_zalloc },
1213 { OSSL_FUNC_CRYPTO_FREE, (void (*)(void))CRYPTO_free },
1214 { OSSL_FUNC_CRYPTO_CLEAR_FREE, (void (*)(void))CRYPTO_clear_free },
1215 { OSSL_FUNC_CRYPTO_REALLOC, (void (*)(void))CRYPTO_realloc },
1216 { OSSL_FUNC_CRYPTO_CLEAR_REALLOC, (void (*)(void))CRYPTO_clear_realloc },
1217 { OSSL_FUNC_CRYPTO_SECURE_MALLOC, (void (*)(void))CRYPTO_secure_malloc },
1218 { OSSL_FUNC_CRYPTO_SECURE_ZALLOC, (void (*)(void))CRYPTO_secure_zalloc },
1219 { OSSL_FUNC_CRYPTO_SECURE_FREE, (void (*)(void))CRYPTO_secure_free },
1220 { OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE,
1221 (void (*)(void))CRYPTO_secure_clear_free },
1222 { OSSL_FUNC_CRYPTO_SECURE_ALLOCATED,
1223 (void (*)(void))CRYPTO_secure_allocated },
1224 { OSSL_FUNC_OPENSSL_CLEANSE, (void (*)(void))OPENSSL_cleanse },
1228 static const OSSL_DISPATCH *core_dispatch = core_dispatch_;