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 "internal/nelem.h"
18 #include "internal/thread_once.h"
19 #include "internal/provider.h"
20 #include "internal/refcount.h"
21 #include "provider_local.h"
23 # include <openssl/self_test.h>
26 static OSSL_PROVIDER *provider_new(const char *name,
27 OSSL_provider_init_fn *init_function);
30 * Provider Object structure
31 * =========================
38 DEFINE_STACK_OF(INFOPAIR)
40 struct provider_store_st; /* Forward declaration */
42 struct ossl_provider_st {
44 unsigned int flag_initialized:1;
45 unsigned int flag_fallback:1; /* Can be used as fallback */
46 unsigned int flag_activated_as_fallback:1;
48 /* OpenSSL library side data */
49 CRYPTO_REF_COUNT refcnt;
50 CRYPTO_RWLOCK *refcnt_lock; /* For the ref counter */
54 OSSL_provider_init_fn *init_function;
55 STACK_OF(INFOPAIR) *parameters;
56 OPENSSL_CTX *libctx; /* The library context this instance is in */
57 struct provider_store_st *store; /* The store this instance belongs to */
60 * In the FIPS module inner provider, this isn't needed, since the
61 * error upcalls are always direct calls to the outer provider.
63 int error_lib; /* ERR library number, one for each provider */
64 # ifndef OPENSSL_NO_ERR
65 ERR_STRING_DATA *error_strings; /* Copy of what the provider gives us */
69 /* Provider side functions */
70 OSSL_FUNC_provider_teardown_fn *teardown;
71 OSSL_FUNC_provider_gettable_params_fn *gettable_params;
72 OSSL_FUNC_provider_get_params_fn *get_params;
73 OSSL_FUNC_provider_get_capabilities_fn *get_capabilities;
74 OSSL_FUNC_provider_query_operation_fn *query_operation;
77 * Cache of bit to indicate of query_operation() has been called on
78 * a specific operation or not.
80 unsigned char *operation_bits;
81 size_t operation_bits_sz;
83 /* Provider side data */
86 DEFINE_STACK_OF(OSSL_PROVIDER)
88 static int ossl_provider_cmp(const OSSL_PROVIDER * const *a,
89 const OSSL_PROVIDER * const *b)
91 return strcmp((*a)->name, (*b)->name);
95 * Provider Object store
96 * =====================
98 * The Provider Object store is a library context object, and therefore needs
102 struct provider_store_st {
103 STACK_OF(OSSL_PROVIDER) *providers;
106 unsigned int use_fallbacks:1;
110 * provider_deactivate_free() is a wrapper around ossl_provider_free()
111 * that also makes sure that activated fallback providers are deactivated.
112 * This is simply done by freeing them an extra time, to compensate for the
113 * refcount that provider_activate_fallbacks() gives them.
114 * Since this is only called when the provider store is being emptied, we
115 * don't need to care about any lock.
117 static void provider_deactivate_free(OSSL_PROVIDER *prov)
119 int extra_free = (prov->flag_initialized
120 && prov->flag_activated_as_fallback);
123 ossl_provider_free(prov);
124 ossl_provider_free(prov);
127 static void provider_store_free(void *vstore)
129 struct provider_store_st *store = vstore;
133 OPENSSL_free(store->default_path);
134 sk_OSSL_PROVIDER_pop_free(store->providers, provider_deactivate_free);
135 CRYPTO_THREAD_lock_free(store->lock);
139 static void *provider_store_new(OPENSSL_CTX *ctx)
141 struct provider_store_st *store = OPENSSL_zalloc(sizeof(*store));
142 const struct predefined_providers_st *p = NULL;
145 || (store->providers = sk_OSSL_PROVIDER_new(ossl_provider_cmp)) == NULL
146 || (store->lock = CRYPTO_THREAD_lock_new()) == NULL) {
147 provider_store_free(store);
150 store->use_fallbacks = 1;
152 for (p = predefined_providers; p->name != NULL; p++) {
153 OSSL_PROVIDER *prov = NULL;
156 * We use the internal constructor directly here,
157 * otherwise we get a call loop
159 prov = provider_new(p->name, p->init);
162 || sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
163 ossl_provider_free(prov);
164 provider_store_free(store);
165 CRYPTOerr(CRYPTO_F_PROVIDER_STORE_NEW, ERR_R_INTERNAL_ERROR);
171 prov->error_lib = ERR_get_next_error_library();
174 ossl_provider_set_fallback(prov);
180 static const OPENSSL_CTX_METHOD provider_store_method = {
185 static struct provider_store_st *get_provider_store(OPENSSL_CTX *libctx)
187 struct provider_store_st *store = NULL;
189 store = openssl_ctx_get_data(libctx, OPENSSL_CTX_PROVIDER_STORE_INDEX,
190 &provider_store_method);
192 CRYPTOerr(CRYPTO_F_GET_PROVIDER_STORE, ERR_R_INTERNAL_ERROR);
196 OSSL_PROVIDER *ossl_provider_find(OPENSSL_CTX *libctx, const char *name,
199 struct provider_store_st *store = NULL;
200 OSSL_PROVIDER *prov = NULL;
202 if ((store = get_provider_store(libctx)) != NULL) {
203 OSSL_PROVIDER tmpl = { 0, };
208 * Make sure any providers are loaded from config before we try to find
212 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
215 tmpl.name = (char *)name;
216 CRYPTO_THREAD_write_lock(store->lock);
217 if ((i = sk_OSSL_PROVIDER_find(store->providers, &tmpl)) == -1
218 || (prov = sk_OSSL_PROVIDER_value(store->providers, i)) == NULL
219 || !ossl_provider_up_ref(prov))
221 CRYPTO_THREAD_unlock(store->lock);
228 * Provider Object methods
229 * =======================
232 static OSSL_PROVIDER *provider_new(const char *name,
233 OSSL_provider_init_fn *init_function)
235 OSSL_PROVIDER *prov = NULL;
237 if ((prov = OPENSSL_zalloc(sizeof(*prov))) == NULL
239 || (prov->refcnt_lock = CRYPTO_THREAD_lock_new()) == NULL
241 || !ossl_provider_up_ref(prov) /* +1 One reference to be returned */
242 || (prov->name = OPENSSL_strdup(name)) == NULL) {
243 ossl_provider_free(prov);
244 CRYPTOerr(CRYPTO_F_PROVIDER_NEW, ERR_R_MALLOC_FAILURE);
248 prov->init_function = init_function;
252 int ossl_provider_up_ref(OSSL_PROVIDER *prov)
256 if (CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock) <= 0)
261 OSSL_PROVIDER *ossl_provider_new(OPENSSL_CTX *libctx, const char *name,
262 OSSL_provider_init_fn *init_function,
265 struct provider_store_st *store = NULL;
266 OSSL_PROVIDER *prov = NULL;
268 if ((store = get_provider_store(libctx)) == NULL)
271 if ((prov = ossl_provider_find(libctx, name,
272 noconfig)) != NULL) { /* refcount +1 */
273 ossl_provider_free(prov); /* refcount -1 */
274 ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_ALREADY_EXISTS, NULL,
279 /* provider_new() generates an error, so no need here */
280 if ((prov = provider_new(name, init_function)) == NULL)
283 CRYPTO_THREAD_write_lock(store->lock);
284 if (!ossl_provider_up_ref(prov)) { /* +1 One reference for the store */
285 ossl_provider_free(prov); /* -1 Reference that was to be returned */
287 } else if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
288 ossl_provider_free(prov); /* -1 Store reference */
289 ossl_provider_free(prov); /* -1 Reference that was to be returned */
292 prov->libctx = libctx;
295 prov->error_lib = ERR_get_next_error_library();
298 CRYPTO_THREAD_unlock(store->lock);
301 CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_NEW, ERR_R_MALLOC_FAILURE);
304 * At this point, the provider is only partially "loaded". To be
305 * fully "loaded", ossl_provider_activate() must also be called.
311 static void free_infopair(INFOPAIR *pair)
313 OPENSSL_free(pair->name);
314 OPENSSL_free(pair->value);
318 void ossl_provider_free(OSSL_PROVIDER *prov)
323 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
326 * When the refcount drops below two, the store is the only
327 * possible reference, or it has already been taken away from
328 * the store (this may happen if a provider was activated
329 * because it's a fallback, but isn't currently used)
330 * When that happens, the provider is inactivated.
332 if (ref < 2 && prov->flag_initialized) {
334 ossl_init_thread_deregister(prov);
336 if (prov->teardown != NULL)
337 prov->teardown(prov->provctx);
338 #ifndef OPENSSL_NO_ERR
340 if (prov->error_strings != NULL) {
341 ERR_unload_strings(prov->error_lib, prov->error_strings);
342 OPENSSL_free(prov->error_strings);
343 prov->error_strings = NULL;
347 OPENSSL_free(prov->operation_bits);
348 prov->operation_bits = NULL;
349 prov->operation_bits_sz = 0;
350 prov->flag_initialized = 0;
354 * When the refcount drops to zero, it has been taken out of
355 * the store. All we have to do here is clean it out.
359 DSO_free(prov->module);
361 OPENSSL_free(prov->name);
362 OPENSSL_free(prov->path);
363 sk_INFOPAIR_pop_free(prov->parameters, free_infopair);
365 CRYPTO_THREAD_lock_free(prov->refcnt_lock);
373 int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *module_path)
375 OPENSSL_free(prov->path);
376 if (module_path == NULL)
378 if ((prov->path = OPENSSL_strdup(module_path)) != NULL)
380 CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_SET_MODULE_PATH, ERR_R_MALLOC_FAILURE);
384 int ossl_provider_add_parameter(OSSL_PROVIDER *prov,
385 const char *name, const char *value)
387 INFOPAIR *pair = NULL;
389 if ((pair = OPENSSL_zalloc(sizeof(*pair))) != NULL
390 && (prov->parameters != NULL
391 || (prov->parameters = sk_INFOPAIR_new_null()) != NULL)
392 && (pair->name = OPENSSL_strdup(name)) != NULL
393 && (pair->value = OPENSSL_strdup(value)) != NULL
394 && sk_INFOPAIR_push(prov->parameters, pair) > 0)
398 OPENSSL_free(pair->name);
399 OPENSSL_free(pair->value);
402 CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_ADD_PARAMETER, ERR_R_MALLOC_FAILURE);
407 * Provider activation.
409 * What "activation" means depends on the provider form; for built in
410 * providers (in the library or the application alike), the provider
411 * can already be considered to be loaded, all that's needed is to
412 * initialize it. However, for dynamically loadable provider modules,
413 * we must first load that module.
415 * Built in modules are distinguished from dynamically loaded modules
416 * with an already assigned init function.
418 static const OSSL_DISPATCH *core_dispatch; /* Define further down */
420 int OSSL_PROVIDER_set_default_search_path(OPENSSL_CTX *libctx, const char *path)
422 struct provider_store_st *store;
426 p = OPENSSL_strdup(path);
428 CRYPTOerr(0, ERR_R_MALLOC_FAILURE);
432 if ((store = get_provider_store(libctx)) != NULL
433 && CRYPTO_THREAD_write_lock(store->lock)) {
434 OPENSSL_free(store->default_path);
435 store->default_path = p;
436 CRYPTO_THREAD_unlock(store->lock);
444 * Internal version that doesn't affect the store flags, and thereby avoid
445 * locking. Direct callers must remember to set the store flags when
448 static int provider_activate(OSSL_PROVIDER *prov)
450 const OSSL_DISPATCH *provider_dispatch = NULL;
451 void *tmp_provctx = NULL; /* safety measure */
452 #ifndef OPENSSL_NO_ERR
454 OSSL_FUNC_provider_get_reason_strings_fn *p_get_reason_strings = NULL;
458 if (prov->flag_initialized)
462 * If the init function isn't set, it indicates that this provider is
465 if (prov->init_function == NULL) {
469 if (prov->module == NULL) {
470 char *allocated_path = NULL;
471 const char *module_path = NULL;
472 char *merged_path = NULL;
473 const char *load_dir = NULL;
474 struct provider_store_st *store;
476 if ((prov->module = DSO_new()) == NULL) {
477 /* DSO_new() generates an error already */
481 if ((store = get_provider_store(prov->libctx)) == NULL
482 || !CRYPTO_THREAD_read_lock(store->lock))
484 load_dir = store->default_path;
486 if (load_dir == NULL) {
487 load_dir = ossl_safe_getenv("OPENSSL_MODULES");
488 if (load_dir == NULL)
489 load_dir = MODULESDIR;
492 DSO_ctrl(prov->module, DSO_CTRL_SET_FLAGS,
493 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY, NULL);
495 module_path = prov->path;
496 if (module_path == NULL)
497 module_path = allocated_path =
498 DSO_convert_filename(prov->module, prov->name);
499 if (module_path != NULL)
500 merged_path = DSO_merge(prov->module, module_path, load_dir);
501 CRYPTO_THREAD_unlock(store->lock);
503 if (merged_path == NULL
504 || (DSO_load(prov->module, merged_path, NULL, 0)) == NULL) {
505 DSO_free(prov->module);
509 OPENSSL_free(merged_path);
510 OPENSSL_free(allocated_path);
513 if (prov->module != NULL)
514 prov->init_function = (OSSL_provider_init_fn *)
515 DSO_bind_func(prov->module, "OSSL_provider_init");
519 /* Call the initialise function for the provider. */
520 if (prov->init_function == NULL
521 || !prov->init_function((OSSL_CORE_HANDLE *)prov, core_dispatch,
522 &provider_dispatch, &tmp_provctx)) {
523 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INIT_FAIL, NULL,
524 "name=%s", prov->name);
526 DSO_free(prov->module);
531 prov->provctx = tmp_provctx;
533 for (; provider_dispatch->function_id != 0; provider_dispatch++) {
534 switch (provider_dispatch->function_id) {
535 case OSSL_FUNC_PROVIDER_TEARDOWN:
537 OSSL_FUNC_provider_teardown(provider_dispatch);
539 case OSSL_FUNC_PROVIDER_GETTABLE_PARAMS:
540 prov->gettable_params =
541 OSSL_FUNC_provider_gettable_params(provider_dispatch);
543 case OSSL_FUNC_PROVIDER_GET_PARAMS:
545 OSSL_FUNC_provider_get_params(provider_dispatch);
547 case OSSL_FUNC_PROVIDER_GET_CAPABILITIES:
548 prov->get_capabilities =
549 OSSL_FUNC_provider_get_capabilities(provider_dispatch);
551 case OSSL_FUNC_PROVIDER_QUERY_OPERATION:
552 prov->query_operation =
553 OSSL_FUNC_provider_query_operation(provider_dispatch);
555 #ifndef OPENSSL_NO_ERR
557 case OSSL_FUNC_PROVIDER_GET_REASON_STRINGS:
558 p_get_reason_strings =
559 OSSL_FUNC_provider_get_reason_strings(provider_dispatch);
566 #ifndef OPENSSL_NO_ERR
568 if (p_get_reason_strings != NULL) {
569 const OSSL_ITEM *reasonstrings = p_get_reason_strings(prov->provctx);
573 * ERR_load_strings() handles ERR_STRING_DATA rather than OSSL_ITEM,
574 * although they are essentially the same type.
575 * Furthermore, ERR_load_strings() patches the array's error number
576 * with the error library number, so we need to make a copy of that
580 while (reasonstrings[cnt].id != 0) {
581 if (ERR_GET_LIB(reasonstrings[cnt].id) != 0)
585 cnt++; /* One for the terminating item */
587 /* Allocate one extra item for the "library" name */
588 prov->error_strings =
589 OPENSSL_zalloc(sizeof(ERR_STRING_DATA) * (cnt + 1));
590 if (prov->error_strings == NULL)
594 * Set the "library" name.
596 prov->error_strings[0].error = ERR_PACK(prov->error_lib, 0, 0);
597 prov->error_strings[0].string = prov->name;
599 * Copy reasonstrings item 0..cnt-1 to prov->error_trings positions
602 for (cnt2 = 1; cnt2 <= cnt; cnt2++) {
603 prov->error_strings[cnt2].error = (int)reasonstrings[cnt2-1].id;
604 prov->error_strings[cnt2].string = reasonstrings[cnt2-1].ptr;
607 ERR_load_strings(prov->error_lib, prov->error_strings);
612 /* With this flag set, this provider has become fully "loaded". */
613 prov->flag_initialized = 1;
617 int ossl_provider_activate(OSSL_PROVIDER *prov)
619 if (provider_activate(prov)) {
620 CRYPTO_THREAD_write_lock(prov->store->lock);
621 prov->store->use_fallbacks = 0;
622 CRYPTO_THREAD_unlock(prov->store->lock);
629 void *ossl_provider_ctx(const OSSL_PROVIDER *prov)
631 return prov->provctx;
635 static int provider_forall_loaded(struct provider_store_st *store,
636 int *found_activated,
637 int (*cb)(OSSL_PROVIDER *provider,
645 num_provs = sk_OSSL_PROVIDER_num(store->providers);
647 if (found_activated != NULL)
648 *found_activated = 0;
649 for (i = 0; i < num_provs; i++) {
650 OSSL_PROVIDER *prov =
651 sk_OSSL_PROVIDER_value(store->providers, i);
653 if (prov->flag_initialized) {
654 if (found_activated != NULL)
655 *found_activated = 1;
656 if (!(ret = cb(prov, cbdata)))
665 * This function only does something once when store->use_fallbacks == 1,
666 * and then sets store->use_fallbacks = 0, so the second call and so on is
667 * effectively a no-op.
669 static void provider_activate_fallbacks(struct provider_store_st *store)
671 if (store->use_fallbacks) {
672 int num_provs = sk_OSSL_PROVIDER_num(store->providers);
673 int activated_fallback_count = 0;
676 for (i = 0; i < num_provs; i++) {
677 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(store->providers, i);
680 * Activated fallback providers get an extra refcount, to
681 * simulate a regular load.
682 * Note that we don't care if the activation succeeds or not,
683 * other than to maintain a correct refcount. If the activation
684 * doesn't succeed, then any future attempt to use the fallback
685 * provider will fail anyway.
687 if (prov->flag_fallback) {
688 if (ossl_provider_up_ref(prov)) {
689 if (!provider_activate(prov)) {
690 ossl_provider_free(prov);
692 prov->flag_activated_as_fallback = 1;
693 activated_fallback_count++;
700 * We assume that all fallbacks have been added to the store before
701 * any fallback is activated.
702 * TODO: We may have to reconsider this, IF we find ourselves adding
703 * fallbacks after any previous fallback has been activated.
705 if (activated_fallback_count > 0)
706 store->use_fallbacks = 0;
710 int ossl_provider_forall_loaded(OPENSSL_CTX *ctx,
711 int (*cb)(OSSL_PROVIDER *provider,
716 struct provider_store_st *store = get_provider_store(ctx);
720 * Make sure any providers are loaded from config before we try to use
723 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
727 CRYPTO_THREAD_read_lock(store->lock);
729 provider_activate_fallbacks(store);
732 * Now, we sweep through all providers
734 ret = provider_forall_loaded(store, NULL, cb, cbdata);
736 CRYPTO_THREAD_unlock(store->lock);
742 int ossl_provider_available(OSSL_PROVIDER *prov)
745 CRYPTO_THREAD_read_lock(prov->store->lock);
746 provider_activate_fallbacks(prov->store);
747 CRYPTO_THREAD_unlock(prov->store->lock);
749 return prov->flag_initialized;
754 /* Setters of Provider Object data */
755 int ossl_provider_set_fallback(OSSL_PROVIDER *prov)
760 prov->flag_fallback = 1;
764 /* Getters of Provider Object data */
765 const char *ossl_provider_name(const OSSL_PROVIDER *prov)
770 const DSO *ossl_provider_dso(const OSSL_PROVIDER *prov)
775 const char *ossl_provider_module_name(const OSSL_PROVIDER *prov)
780 return DSO_get_filename(prov->module);
784 const char *ossl_provider_module_path(const OSSL_PROVIDER *prov)
789 /* FIXME: Ensure it's a full path */
790 return DSO_get_filename(prov->module);
794 void *ossl_provider_prov_ctx(const OSSL_PROVIDER *prov)
797 return prov->provctx;
802 OPENSSL_CTX *ossl_provider_library_context(const OSSL_PROVIDER *prov)
804 /* TODO(3.0) just: return prov->libctx; */
805 return prov != NULL ? prov->libctx : NULL;
808 /* Wrappers around calls to the provider */
809 void ossl_provider_teardown(const OSSL_PROVIDER *prov)
811 if (prov->teardown != NULL)
812 prov->teardown(prov->provctx);
815 const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov)
817 return prov->gettable_params == NULL
818 ? NULL : prov->gettable_params(prov->provctx);
821 int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
823 return prov->get_params == NULL
824 ? 0 : prov->get_params(prov->provctx, params);
827 int ossl_provider_get_capabilities(const OSSL_PROVIDER *prov,
828 const char *capability,
832 return prov->get_capabilities == NULL
833 ? 1 : prov->get_capabilities(prov->provctx, capability, cb, arg);
837 const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov,
841 return prov->query_operation(prov->provctx, operation_id, no_cache);
844 int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum)
846 size_t byte = bitnum / 8;
847 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
849 if (provider->operation_bits_sz <= byte) {
850 provider->operation_bits = OPENSSL_realloc(provider->operation_bits,
852 if (provider->operation_bits == NULL) {
853 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
856 memset(provider->operation_bits + provider->operation_bits_sz,
857 '\0', byte + 1 - provider->operation_bits_sz);
859 provider->operation_bits[byte] |= bit;
863 int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum,
866 size_t byte = bitnum / 8;
867 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
869 if (!ossl_assert(result != NULL)) {
870 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
875 if (provider->operation_bits_sz > byte)
876 *result = ((provider->operation_bits[byte] & bit) != 0);
881 * Core functions for the provider
882 * ===============================
884 * This is the set of functions that the core makes available to the provider
888 * This returns a list of Provider Object parameters with their types, for
889 * discovery. We do not expect that many providers will use this, but one
892 static const OSSL_PARAM param_types[] = {
893 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
894 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_PROV_NAME, OSSL_PARAM_UTF8_PTR,
897 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_MODULE_FILENAME, OSSL_PARAM_UTF8_PTR,
904 * Forward declare all the functions that are provided aa dispatch.
905 * This ensures that the compiler will complain if they aren't defined
906 * with the correct signature.
908 static OSSL_FUNC_core_gettable_params_fn core_gettable_params;
909 static OSSL_FUNC_core_get_params_fn core_get_params;
910 static OSSL_FUNC_core_thread_start_fn core_thread_start;
911 static OSSL_FUNC_core_get_library_context_fn core_get_libctx;
913 static OSSL_FUNC_core_new_error_fn core_new_error;
914 static OSSL_FUNC_core_set_error_debug_fn core_set_error_debug;
915 static OSSL_FUNC_core_vset_error_fn core_vset_error;
916 static OSSL_FUNC_core_set_error_mark_fn core_set_error_mark;
917 static OSSL_FUNC_core_clear_last_error_mark_fn core_clear_last_error_mark;
918 static OSSL_FUNC_core_pop_error_to_mark_fn core_pop_error_to_mark;
921 static const OSSL_PARAM *core_gettable_params(const OSSL_CORE_HANDLE *handle)
926 static int core_get_params(const OSSL_CORE_HANDLE *handle, OSSL_PARAM params[])
931 * We created this object originally and we know it is actually an
932 * OSSL_PROVIDER *, so the cast is safe
934 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
936 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_VERSION)) != NULL)
937 OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR);
938 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_PROV_NAME)) != NULL)
939 OSSL_PARAM_set_utf8_ptr(p, prov->name);
942 if ((p = OSSL_PARAM_locate(params,
943 OSSL_PROV_PARAM_CORE_MODULE_FILENAME)) != NULL)
944 OSSL_PARAM_set_utf8_ptr(p, ossl_provider_module_path(prov));
947 if (prov->parameters == NULL)
950 for (i = 0; i < sk_INFOPAIR_num(prov->parameters); i++) {
951 INFOPAIR *pair = sk_INFOPAIR_value(prov->parameters, i);
953 if ((p = OSSL_PARAM_locate(params, pair->name)) != NULL)
954 OSSL_PARAM_set_utf8_ptr(p, pair->value);
959 static OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle)
962 * We created this object originally and we know it is actually an
963 * OSSL_PROVIDER *, so the cast is safe
965 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
967 return (OPENSSL_CORE_CTX *)ossl_provider_library_context(prov);
970 static int core_thread_start(const OSSL_CORE_HANDLE *handle,
971 OSSL_thread_stop_handler_fn handfn)
974 * We created this object originally and we know it is actually an
975 * OSSL_PROVIDER *, so the cast is safe
977 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
979 return ossl_init_thread_start(prov, prov->provctx, handfn);
983 * The FIPS module inner provider doesn't implement these. They aren't
984 * needed there, since the FIPS module upcalls are always the outer provider
989 * TODO(3.0) These error functions should use |handle| to select the proper
990 * library context to report in the correct error stack, at least if error
991 * stacks become tied to the library context.
992 * We cannot currently do that since there's no support for it in the
995 static void core_new_error(const OSSL_CORE_HANDLE *handle)
1000 static void core_set_error_debug(const OSSL_CORE_HANDLE *handle,
1001 const char *file, int line, const char *func)
1003 ERR_set_debug(file, line, func);
1006 static void core_vset_error(const OSSL_CORE_HANDLE *handle,
1007 uint32_t reason, const char *fmt, va_list args)
1010 * We created this object originally and we know it is actually an
1011 * OSSL_PROVIDER *, so the cast is safe
1013 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1016 * If the uppermost 8 bits are non-zero, it's an OpenSSL library
1017 * error and will be treated as such. Otherwise, it's a new style
1018 * provider error and will be treated as such.
1020 if (ERR_GET_LIB(reason) != 0) {
1021 ERR_vset_error(ERR_GET_LIB(reason), ERR_GET_REASON(reason), fmt, args);
1023 ERR_vset_error(prov->error_lib, (int)reason, fmt, args);
1027 static int core_set_error_mark(const OSSL_CORE_HANDLE *handle)
1029 return ERR_set_mark();
1032 static int core_clear_last_error_mark(const OSSL_CORE_HANDLE *handle)
1034 return ERR_clear_last_mark();
1037 static int core_pop_error_to_mark(const OSSL_CORE_HANDLE *handle)
1039 return ERR_pop_to_mark();
1041 #endif /* FIPS_MODULE */
1044 * Functions provided by the core. Blank line separates "families" of related
1047 static const OSSL_DISPATCH core_dispatch_[] = {
1048 { OSSL_FUNC_CORE_GETTABLE_PARAMS, (void (*)(void))core_gettable_params },
1049 { OSSL_FUNC_CORE_GET_PARAMS, (void (*)(void))core_get_params },
1050 { OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT, (void (*)(void))core_get_libctx },
1051 { OSSL_FUNC_CORE_THREAD_START, (void (*)(void))core_thread_start },
1053 { OSSL_FUNC_CORE_NEW_ERROR, (void (*)(void))core_new_error },
1054 { OSSL_FUNC_CORE_SET_ERROR_DEBUG, (void (*)(void))core_set_error_debug },
1055 { OSSL_FUNC_CORE_VSET_ERROR, (void (*)(void))core_vset_error },
1056 { OSSL_FUNC_CORE_SET_ERROR_MARK, (void (*)(void))core_set_error_mark },
1057 { OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK,
1058 (void (*)(void))core_clear_last_error_mark },
1059 { OSSL_FUNC_CORE_POP_ERROR_TO_MARK, (void (*)(void))core_pop_error_to_mark },
1060 { OSSL_FUNC_BIO_NEW_FILE, (void (*)(void))BIO_new_file },
1061 { OSSL_FUNC_BIO_NEW_MEMBUF, (void (*)(void))BIO_new_mem_buf },
1062 { OSSL_FUNC_BIO_READ_EX, (void (*)(void))BIO_read_ex },
1063 { OSSL_FUNC_BIO_WRITE_EX, (void (*)(void))BIO_write_ex },
1064 { OSSL_FUNC_BIO_GETS, (void (*)(void))BIO_gets },
1065 { OSSL_FUNC_BIO_PUTS, (void (*)(void))BIO_puts },
1066 { OSSL_FUNC_BIO_FREE, (void (*)(void))BIO_free },
1067 { OSSL_FUNC_BIO_VPRINTF, (void (*)(void))BIO_vprintf },
1068 { OSSL_FUNC_BIO_VSNPRINTF, (void (*)(void))BIO_vsnprintf },
1069 { OSSL_FUNC_SELF_TEST_CB, (void (*)(void))OSSL_SELF_TEST_get_callback },
1071 { OSSL_FUNC_CRYPTO_MALLOC, (void (*)(void))CRYPTO_malloc },
1072 { OSSL_FUNC_CRYPTO_ZALLOC, (void (*)(void))CRYPTO_zalloc },
1073 { OSSL_FUNC_CRYPTO_FREE, (void (*)(void))CRYPTO_free },
1074 { OSSL_FUNC_CRYPTO_CLEAR_FREE, (void (*)(void))CRYPTO_clear_free },
1075 { OSSL_FUNC_CRYPTO_REALLOC, (void (*)(void))CRYPTO_realloc },
1076 { OSSL_FUNC_CRYPTO_CLEAR_REALLOC, (void (*)(void))CRYPTO_clear_realloc },
1077 { OSSL_FUNC_CRYPTO_SECURE_MALLOC, (void (*)(void))CRYPTO_secure_malloc },
1078 { OSSL_FUNC_CRYPTO_SECURE_ZALLOC, (void (*)(void))CRYPTO_secure_zalloc },
1079 { OSSL_FUNC_CRYPTO_SECURE_FREE, (void (*)(void))CRYPTO_secure_free },
1080 { OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE,
1081 (void (*)(void))CRYPTO_secure_clear_free },
1082 { OSSL_FUNC_CRYPTO_SECURE_ALLOCATED,
1083 (void (*)(void))CRYPTO_secure_allocated },
1084 { OSSL_FUNC_OPENSSL_CLEANSE, (void (*)(void))OPENSSL_cleanse },
1088 static const OSSL_DISPATCH *core_dispatch = core_dispatch_;