/*
- * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
+ * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
*
* Licensed under the Apache License 2.0 (the "License"). You may not use
* this file except in compliance with the License. You can obtain a copy
* https://www.openssl.org/source/license.html
*/
+#include <assert.h>
#include <openssl/core.h>
-#include <openssl/core_numbers.h>
+#include <openssl/core_dispatch.h>
+#include <openssl/core_names.h>
+#include <openssl/provider.h>
#include <openssl/params.h>
#include <openssl/opensslv.h>
-#include "internal/cryptlib_int.h"
+#include "crypto/cryptlib.h"
+#include "crypto/evp.h" /* evp_method_store_flush */
+#include "crypto/rand.h"
#include "internal/nelem.h"
#include "internal/thread_once.h"
#include "internal/provider.h"
#include "internal/refcount.h"
+#include "internal/bio.h"
+#include "internal/core.h"
#include "provider_local.h"
+#ifndef FIPS_MODULE
+# include <openssl/self_test.h>
+#endif
static OSSL_PROVIDER *provider_new(const char *name,
OSSL_provider_init_fn *init_function);
} INFOPAIR;
DEFINE_STACK_OF(INFOPAIR)
+#ifndef FIPS_MODULE
+typedef struct {
+ OSSL_PROVIDER *prov;
+ int (*create_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata);
+ void (*remove_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata);
+ void *cbdata;
+} OSSL_PROVIDER_CHILD_CB;
+DEFINE_STACK_OF(OSSL_PROVIDER_CHILD_CB)
+#endif
+
struct provider_store_st; /* Forward declaration */
struct ossl_provider_st {
/* Flag bits */
unsigned int flag_initialized:1;
- unsigned int flag_fallback:1;
+ unsigned int flag_activated:1;
+ unsigned int flag_fallback:1; /* Can be used as fallback */
+#ifndef FIPS_MODULE
+ unsigned int flag_couldbechild:1;
+#endif
+
+ /* Getting and setting the flags require synchronization */
+ CRYPTO_RWLOCK *flag_lock;
/* OpenSSL library side data */
CRYPTO_REF_COUNT refcnt;
CRYPTO_RWLOCK *refcnt_lock; /* For the ref counter */
+ int activatecnt;
char *name;
char *path;
DSO *module;
OSSL_provider_init_fn *init_function;
STACK_OF(INFOPAIR) *parameters;
- OPENSSL_CTX *libctx; /* The library context this instance is in */
+ OSSL_LIB_CTX *libctx; /* The library context this instance is in */
struct provider_store_st *store; /* The store this instance belongs to */
-#ifndef FIPS_MODE
+#ifndef FIPS_MODULE
/*
* In the FIPS module inner provider, this isn't needed, since the
* error upcalls are always direct calls to the outer provider.
#endif
/* Provider side functions */
- OSSL_provider_teardown_fn *teardown;
- OSSL_provider_get_param_types_fn *get_param_types;
- OSSL_provider_get_params_fn *get_params;
- OSSL_provider_query_operation_fn *query_operation;
+ OSSL_FUNC_provider_teardown_fn *teardown;
+ OSSL_FUNC_provider_gettable_params_fn *gettable_params;
+ OSSL_FUNC_provider_get_params_fn *get_params;
+ OSSL_FUNC_provider_get_capabilities_fn *get_capabilities;
+ OSSL_FUNC_provider_self_test_fn *self_test;
+ OSSL_FUNC_provider_query_operation_fn *query_operation;
+ OSSL_FUNC_provider_unquery_operation_fn *unquery_operation;
+
+ /*
+ * Cache of bit to indicate of query_operation() has been called on
+ * a specific operation or not.
+ */
+ unsigned char *operation_bits;
+ size_t operation_bits_sz;
+ CRYPTO_RWLOCK *opbits_lock;
+
+#ifndef FIPS_MODULE
+ /* Whether this provider is the child of some other provider */
+ const OSSL_CORE_HANDLE *handle;
+ unsigned int ischild:1;
+#endif
/* Provider side data */
void *provctx;
+ const OSSL_DISPATCH *dispatch;
};
DEFINE_STACK_OF(OSSL_PROVIDER)
*/
struct provider_store_st {
+ OSSL_LIB_CTX *libctx;
STACK_OF(OSSL_PROVIDER) *providers;
+ STACK_OF(OSSL_PROVIDER_CHILD_CB) *child_cbs;
+ CRYPTO_RWLOCK *default_path_lock;
CRYPTO_RWLOCK *lock;
+ char *default_path;
unsigned int use_fallbacks:1;
+ unsigned int freeing:1;
};
+/*
+ * provider_deactivate_free() is a wrapper around ossl_provider_deactivate()
+ * and ossl_provider_free(), called as needed.
+ * Since this is only called when the provider store is being emptied, we
+ * don't need to care about any lock.
+ */
+static void provider_deactivate_free(OSSL_PROVIDER *prov)
+{
+ if (prov->flag_activated)
+ ossl_provider_deactivate(prov);
+ ossl_provider_free(prov);
+}
+
+#ifndef FIPS_MODULE
+static void ossl_provider_child_cb_free(OSSL_PROVIDER_CHILD_CB *cb)
+{
+ OPENSSL_free(cb);
+}
+#endif
+
static void provider_store_free(void *vstore)
{
struct provider_store_st *store = vstore;
if (store == NULL)
return;
- sk_OSSL_PROVIDER_pop_free(store->providers, ossl_provider_free);
+ store->freeing = 1;
+ OPENSSL_free(store->default_path);
+ sk_OSSL_PROVIDER_pop_free(store->providers, provider_deactivate_free);
+#ifndef FIPS_MODULE
+ sk_OSSL_PROVIDER_CHILD_CB_pop_free(store->child_cbs,
+ ossl_provider_child_cb_free);
+#endif
+ CRYPTO_THREAD_lock_free(store->default_path_lock);
CRYPTO_THREAD_lock_free(store->lock);
OPENSSL_free(store);
}
-static void *provider_store_new(OPENSSL_CTX *ctx)
+static void *provider_store_new(OSSL_LIB_CTX *ctx)
{
struct provider_store_st *store = OPENSSL_zalloc(sizeof(*store));
const struct predefined_providers_st *p = NULL;
if (store == NULL
|| (store->providers = sk_OSSL_PROVIDER_new(ossl_provider_cmp)) == NULL
+ || (store->default_path_lock = CRYPTO_THREAD_lock_new()) == NULL
+#ifndef FIPS_MODULE
+ || (store->child_cbs = sk_OSSL_PROVIDER_CHILD_CB_new_null()) == NULL
+#endif
|| (store->lock = CRYPTO_THREAD_lock_new()) == NULL) {
provider_store_free(store);
return NULL;
}
+ store->libctx = ctx;
store->use_fallbacks = 1;
- for (p = predefined_providers; p->name != NULL; p++) {
+ for (p = ossl_predefined_providers; p->name != NULL; p++) {
OSSL_PROVIDER *prov = NULL;
/*
|| sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
ossl_provider_free(prov);
provider_store_free(store);
- CRYPTOerr(CRYPTO_F_PROVIDER_STORE_NEW, ERR_R_INTERNAL_ERROR);
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
return NULL;
}
prov->libctx = ctx;
prov->store = store;
-#ifndef FIPS_MODE
+#ifndef FIPS_MODULE
prov->error_lib = ERR_get_next_error_library();
#endif
if(p->is_fallback)
return store;
}
-static const OPENSSL_CTX_METHOD provider_store_method = {
+static const OSSL_LIB_CTX_METHOD provider_store_method = {
+ /* Needs to be freed before the child provider data is freed */
+ OSSL_LIB_CTX_METHOD_PRIORITY_1,
provider_store_new,
provider_store_free,
};
-static struct provider_store_st *get_provider_store(OPENSSL_CTX *libctx)
+static struct provider_store_st *get_provider_store(OSSL_LIB_CTX *libctx)
{
struct provider_store_st *store = NULL;
- store = openssl_ctx_get_data(libctx, OPENSSL_CTX_PROVIDER_STORE_INDEX,
- &provider_store_method);
+ store = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_PROVIDER_STORE_INDEX,
+ &provider_store_method);
if (store == NULL)
- CRYPTOerr(CRYPTO_F_GET_PROVIDER_STORE, ERR_R_INTERNAL_ERROR);
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
return store;
}
-OSSL_PROVIDER *ossl_provider_find(OPENSSL_CTX *libctx, const char *name)
+int ossl_provider_disable_fallback_loading(OSSL_LIB_CTX *libctx)
+{
+ struct provider_store_st *store;
+
+ if ((store = get_provider_store(libctx)) != NULL) {
+ if (!CRYPTO_THREAD_write_lock(store->lock))
+ return 0;
+ store->use_fallbacks = 0;
+ CRYPTO_THREAD_unlock(store->lock);
+ return 1;
+ }
+ return 0;
+}
+
+OSSL_PROVIDER *ossl_provider_find(OSSL_LIB_CTX *libctx, const char *name,
+ int noconfig)
{
struct provider_store_st *store = NULL;
OSSL_PROVIDER *prov = NULL;
OSSL_PROVIDER tmpl = { 0, };
int i;
+#ifndef FIPS_MODULE
+ /*
+ * Make sure any providers are loaded from config before we try to find
+ * them.
+ */
+ if (!noconfig) {
+ if (ossl_lib_ctx_is_default(libctx))
+ OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
+ if (ossl_lib_ctx_is_child(libctx)
+ && !ossl_provider_init_child_providers(libctx))
+ return NULL;
+ }
+#endif
+
tmpl.name = (char *)name;
- CRYPTO_THREAD_write_lock(store->lock);
+ if (!CRYPTO_THREAD_read_lock(store->lock))
+ return NULL;
if ((i = sk_OSSL_PROVIDER_find(store->providers, &tmpl)) == -1
|| (prov = sk_OSSL_PROVIDER_value(store->providers, i)) == NULL
|| !ossl_provider_up_ref(prov))
|| (prov->refcnt_lock = CRYPTO_THREAD_lock_new()) == NULL
#endif
|| !ossl_provider_up_ref(prov) /* +1 One reference to be returned */
+ || (prov->opbits_lock = CRYPTO_THREAD_lock_new()) == NULL
+ || (prov->flag_lock = CRYPTO_THREAD_lock_new()) == NULL
|| (prov->name = OPENSSL_strdup(name)) == NULL) {
ossl_provider_free(prov);
- CRYPTOerr(CRYPTO_F_PROVIDER_NEW, ERR_R_MALLOC_FAILURE);
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
return NULL;
}
prov->init_function = init_function;
+#ifndef FIPS_MODULE
+ prov->flag_couldbechild = 1;
+#endif
return prov;
}
if (CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock) <= 0)
return 0;
+
+#ifndef FIPS_MODULE
+ if (prov->ischild) {
+ if (!ossl_provider_up_ref_parent(prov, 0)) {
+ ossl_provider_free(prov);
+ return 0;
+ }
+ }
+#endif
+
return ref;
}
-OSSL_PROVIDER *ossl_provider_new(OPENSSL_CTX *libctx, const char *name,
- OSSL_provider_init_fn *init_function)
+#ifndef FIPS_MODULE
+static int provider_up_ref_intern(OSSL_PROVIDER *prov, int activate)
+{
+ if (activate)
+ return ossl_provider_activate(prov, 0, 1);
+
+ return ossl_provider_up_ref(prov);
+}
+
+static int provider_free_intern(OSSL_PROVIDER *prov, int deactivate)
+{
+ if (deactivate)
+ return ossl_provider_deactivate(prov);
+
+ ossl_provider_free(prov);
+ return 1;
+}
+#endif
+
+OSSL_PROVIDER *ossl_provider_new(OSSL_LIB_CTX *libctx, const char *name,
+ OSSL_provider_init_fn *init_function,
+ int noconfig)
{
struct provider_store_st *store = NULL;
OSSL_PROVIDER *prov = NULL;
if ((store = get_provider_store(libctx)) == NULL)
return NULL;
- if ((prov = ossl_provider_find(libctx, name)) != NULL) { /* refcount +1 */
+ if ((prov = ossl_provider_find(libctx, name,
+ noconfig)) != NULL) { /* refcount +1 */
ossl_provider_free(prov); /* refcount -1 */
- CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_NEW,
- CRYPTO_R_PROVIDER_ALREADY_EXISTS);
- ERR_add_error_data(2, "name=", name);
+ ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_ALREADY_EXISTS,
+ "name=%s", name);
return NULL;
}
if ((prov = provider_new(name, init_function)) == NULL)
return NULL;
- CRYPTO_THREAD_write_lock(store->lock);
+ if (!CRYPTO_THREAD_write_lock(store->lock))
+ return NULL;
if (!ossl_provider_up_ref(prov)) { /* +1 One reference for the store */
ossl_provider_free(prov); /* -1 Reference that was to be returned */
prov = NULL;
} else {
prov->libctx = libctx;
prov->store = store;
-#ifndef FIPS_MODE
+#ifndef FIPS_MODULE
prov->error_lib = ERR_get_next_error_library();
#endif
}
CRYPTO_THREAD_unlock(store->lock);
if (prov == NULL)
- CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_NEW, ERR_R_MALLOC_FAILURE);
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
/*
* At this point, the provider is only partially "loaded". To be
CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
/*
- * When the refcount drops below two, the store is the only
- * possible reference, or it has already been taken away from
- * the store (this may happen if a provider was activated
- * because it's a fallback, but isn't currently used)
- * When that happens, the provider is inactivated.
+ * When the refcount drops to zero, we clean up the provider.
+ * Note that this also does teardown, which may seem late,
+ * considering that init happens on first activation. However,
+ * there may be other structures hanging on to the provider after
+ * the last deactivation and may therefore need full access to the
+ * provider's services. Therefore, we deinit late.
*/
- if (ref < 2 && prov->flag_initialized) {
-#ifndef FIPS_MODE
- ossl_init_thread_deregister(prov);
-#endif
- if (prov->teardown != NULL)
- prov->teardown(prov->provctx);
+ if (ref == 0) {
+ if (prov->flag_initialized) {
+ ossl_provider_teardown(prov);
#ifndef OPENSSL_NO_ERR
-# ifndef FIPS_MODE
- if (prov->error_strings != NULL) {
- ERR_unload_strings(prov->error_lib, prov->error_strings);
- OPENSSL_free(prov->error_strings);
- prov->error_strings = NULL;
- }
+# ifndef FIPS_MODULE
+ if (prov->error_strings != NULL) {
+ ERR_unload_strings(prov->error_lib, prov->error_strings);
+ OPENSSL_free(prov->error_strings);
+ prov->error_strings = NULL;
+ }
# endif
#endif
- prov->flag_initialized = 0;
- }
+ OPENSSL_free(prov->operation_bits);
+ prov->operation_bits = NULL;
+ prov->operation_bits_sz = 0;
+ prov->flag_initialized = 0;
+ }
- /*
- * When the refcount drops to zero, it has been taken out of
- * the store. All we have to do here is clean it out.
- */
- if (ref == 0) {
-#ifndef FIPS_MODE
+#ifndef FIPS_MODULE
+ /*
+ * We deregister thread handling whether or not the provider was
+ * initialized. If init was attempted but was not successful then
+ * the provider may still have registered a thread handler.
+ */
+ ossl_init_thread_deregister(prov);
DSO_free(prov->module);
#endif
OPENSSL_free(prov->name);
OPENSSL_free(prov->path);
sk_INFOPAIR_pop_free(prov->parameters, free_infopair);
+ CRYPTO_THREAD_lock_free(prov->opbits_lock);
+ CRYPTO_THREAD_lock_free(prov->flag_lock);
#ifndef HAVE_ATOMICS
CRYPTO_THREAD_lock_free(prov->refcnt_lock);
#endif
OPENSSL_free(prov);
}
+#ifndef FIPS_MODULE
+ else if (prov->ischild) {
+ ossl_provider_free_parent(prov, 0);
+ }
+#endif
}
}
return 1;
if ((prov->path = OPENSSL_strdup(module_path)) != NULL)
return 1;
- CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_SET_MODULE_PATH, ERR_R_MALLOC_FAILURE);
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
return 0;
}
OPENSSL_free(pair->value);
OPENSSL_free(pair);
}
- CRYPTOerr(CRYPTO_F_OSSL_PROVIDER_ADD_PARAMETER, ERR_R_MALLOC_FAILURE);
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
return 0;
}
*/
static const OSSL_DISPATCH *core_dispatch; /* Define further down */
+int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *libctx,
+ const char *path)
+{
+ struct provider_store_st *store;
+ char *p = NULL;
+
+ if (path != NULL) {
+ p = OPENSSL_strdup(path);
+ if (p == NULL) {
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
+ return 0;
+ }
+ }
+ if ((store = get_provider_store(libctx)) != NULL
+ && CRYPTO_THREAD_write_lock(store->default_path_lock)) {
+ OPENSSL_free(store->default_path);
+ store->default_path = p;
+ CRYPTO_THREAD_unlock(store->default_path_lock);
+ return 1;
+ }
+ OPENSSL_free(p);
+ return 0;
+}
+
/*
* Internal version that doesn't affect the store flags, and thereby avoid
* locking. Direct callers must remember to set the store flags when
* appropriate.
*/
-static int provider_activate(OSSL_PROVIDER *prov)
+static int provider_init(OSSL_PROVIDER *prov, int flag_lock)
{
const OSSL_DISPATCH *provider_dispatch = NULL;
+ void *tmp_provctx = NULL; /* safety measure */
#ifndef OPENSSL_NO_ERR
-# ifndef FIPS_MODE
- OSSL_provider_get_reason_strings_fn *p_get_reason_strings = NULL;
+# ifndef FIPS_MODULE
+ OSSL_FUNC_provider_get_reason_strings_fn *p_get_reason_strings = NULL;
# endif
#endif
+ int ok = 0;
- if (prov->flag_initialized)
- return 1;
+ /*
+ * The flag lock is used to lock init, not only because the flag is
+ * checked here and set at the end, but also because this function
+ * modifies a number of things in the provider structure that this
+ * function needs to perform under lock anyway.
+ */
+ if (flag_lock && !CRYPTO_THREAD_write_lock(prov->flag_lock))
+ goto end;
+ if (prov->flag_initialized) {
+ ok = 1;
+ goto end;
+ }
/*
* If the init function isn't set, it indicates that this provider is
* a loadable module.
*/
if (prov->init_function == NULL) {
-#ifdef FIPS_MODE
- return 0;
+#ifdef FIPS_MODULE
+ goto end;
#else
if (prov->module == NULL) {
char *allocated_path = NULL;
const char *module_path = NULL;
char *merged_path = NULL;
- const char *load_dir = ossl_safe_getenv("OPENSSL_MODULES");
+ const char *load_dir = NULL;
+ char *allocated_load_dir = NULL;
+ struct provider_store_st *store;
if ((prov->module = DSO_new()) == NULL) {
/* DSO_new() generates an error already */
- return 0;
+ goto end;
}
- if (load_dir == NULL)
- load_dir = MODULESDIR;
+ if ((store = get_provider_store(prov->libctx)) == NULL
+ || !CRYPTO_THREAD_read_lock(store->default_path_lock))
+ goto end;
+
+ if (store->default_path != NULL) {
+ allocated_load_dir = OPENSSL_strdup(store->default_path);
+ CRYPTO_THREAD_unlock(store->default_path_lock);
+ if (allocated_load_dir == NULL) {
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
+ goto end;
+ }
+ load_dir = allocated_load_dir;
+ } else {
+ CRYPTO_THREAD_unlock(store->default_path_lock);
+ }
+
+ if (load_dir == NULL) {
+ load_dir = ossl_safe_getenv("OPENSSL_MODULES");
+ if (load_dir == NULL)
+ load_dir = MODULESDIR;
+ }
DSO_ctrl(prov->module, DSO_CTRL_SET_FLAGS,
DSO_FLAG_NAME_TRANSLATION_EXT_ONLY, NULL);
OPENSSL_free(merged_path);
OPENSSL_free(allocated_path);
+ OPENSSL_free(allocated_load_dir);
}
if (prov->module != NULL)
/* Call the initialise function for the provider. */
if (prov->init_function == NULL
- || !prov->init_function(prov, core_dispatch, &provider_dispatch,
- &prov->provctx)) {
- CRYPTOerr(CRYPTO_F_PROVIDER_ACTIVATE, ERR_R_INIT_FAIL);
- ERR_add_error_data(2, "name=", prov->name);
-#ifndef FIPS_MODE
- DSO_free(prov->module);
- prov->module = NULL;
-#endif
- return 0;
+ || !prov->init_function((OSSL_CORE_HANDLE *)prov, core_dispatch,
+ &provider_dispatch, &tmp_provctx)) {
+ ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INIT_FAIL,
+ "name=%s", prov->name);
+ goto end;
}
+ prov->provctx = tmp_provctx;
+ prov->dispatch = provider_dispatch;
+#ifndef FIPS_MODULE
+ prov->flag_couldbechild = 0;
+#endif
for (; provider_dispatch->function_id != 0; provider_dispatch++) {
switch (provider_dispatch->function_id) {
case OSSL_FUNC_PROVIDER_TEARDOWN:
prov->teardown =
- OSSL_get_provider_teardown(provider_dispatch);
+ OSSL_FUNC_provider_teardown(provider_dispatch);
break;
- case OSSL_FUNC_PROVIDER_GET_PARAM_TYPES:
- prov->get_param_types =
- OSSL_get_provider_get_param_types(provider_dispatch);
+ case OSSL_FUNC_PROVIDER_GETTABLE_PARAMS:
+ prov->gettable_params =
+ OSSL_FUNC_provider_gettable_params(provider_dispatch);
break;
case OSSL_FUNC_PROVIDER_GET_PARAMS:
prov->get_params =
- OSSL_get_provider_get_params(provider_dispatch);
+ OSSL_FUNC_provider_get_params(provider_dispatch);
+ break;
+ case OSSL_FUNC_PROVIDER_SELF_TEST:
+ prov->self_test =
+ OSSL_FUNC_provider_self_test(provider_dispatch);
+ break;
+ case OSSL_FUNC_PROVIDER_GET_CAPABILITIES:
+ prov->get_capabilities =
+ OSSL_FUNC_provider_get_capabilities(provider_dispatch);
break;
case OSSL_FUNC_PROVIDER_QUERY_OPERATION:
prov->query_operation =
- OSSL_get_provider_query_operation(provider_dispatch);
+ OSSL_FUNC_provider_query_operation(provider_dispatch);
+ break;
+ case OSSL_FUNC_PROVIDER_UNQUERY_OPERATION:
+ prov->unquery_operation =
+ OSSL_FUNC_provider_unquery_operation(provider_dispatch);
break;
#ifndef OPENSSL_NO_ERR
-# ifndef FIPS_MODE
+# ifndef FIPS_MODULE
case OSSL_FUNC_PROVIDER_GET_REASON_STRINGS:
p_get_reason_strings =
- OSSL_get_provider_get_reason_strings(provider_dispatch);
+ OSSL_FUNC_provider_get_reason_strings(provider_dispatch);
break;
# endif
#endif
}
#ifndef OPENSSL_NO_ERR
-# ifndef FIPS_MODE
+# ifndef FIPS_MODULE
if (p_get_reason_strings != NULL) {
const OSSL_ITEM *reasonstrings = p_get_reason_strings(prov->provctx);
size_t cnt, cnt2;
* with the error library number, so we need to make a copy of that
* array either way.
*/
- cnt = 1; /* One for the terminating item */
+ cnt = 0;
while (reasonstrings[cnt].id != 0) {
if (ERR_GET_LIB(reasonstrings[cnt].id) != 0)
- return 0;
+ goto end;
cnt++;
}
+ cnt++; /* One for the terminating item */
/* Allocate one extra item for the "library" name */
prov->error_strings =
OPENSSL_zalloc(sizeof(ERR_STRING_DATA) * (cnt + 1));
if (prov->error_strings == NULL)
- return 0;
+ goto end;
/*
* Set the "library" name.
/* With this flag set, this provider has become fully "loaded". */
prov->flag_initialized = 1;
+ ok = 1;
- return 1;
+ end:
+ if (flag_lock)
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ return ok;
}
-int ossl_provider_activate(OSSL_PROVIDER *prov)
+/*
+ * Deactivate a provider.
+ * Return -1 on failure and the activation count on success
+ */
+static int provider_deactivate(OSSL_PROVIDER *prov)
{
- if (provider_activate(prov)) {
- CRYPTO_THREAD_write_lock(prov->store->lock);
- prov->store->use_fallbacks = 0;
- CRYPTO_THREAD_unlock(prov->store->lock);
- return 1;
+ int count;
+ struct provider_store_st *store;
+
+ if (!ossl_assert(prov != NULL))
+ return -1;
+
+ store = get_provider_store(prov->libctx);
+ if (store == NULL)
+ return -1;
+
+ if (!CRYPTO_THREAD_read_lock(store->lock))
+ return -1;
+ if (!CRYPTO_THREAD_write_lock(prov->flag_lock)) {
+ CRYPTO_THREAD_unlock(store->lock);
+ return -1;
+ }
+
+#ifndef FIPS_MODULE
+ if (prov->activatecnt == 2 && prov->ischild) {
+ /*
+ * We have had a direct activation in this child libctx so we need to
+ * now down the ref count in the parent provider.
+ */
+ ossl_provider_free_parent(prov, 1);
+ }
+#endif
+
+ if ((count = --prov->activatecnt) < 1) {
+ prov->flag_activated = 0;
+#ifndef FIPS_MODULE
+ {
+ int i, max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
+ OSSL_PROVIDER_CHILD_CB *child_cb;
+
+ for (i = 0; i < max; i++) {
+ child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
+ child_cb->remove_cb((OSSL_CORE_HANDLE *)prov, child_cb->cbdata);
+ }
+ }
+#endif
+ }
+
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ CRYPTO_THREAD_unlock(store->lock);
+
+ /* We don't deinit here, that's done in ossl_provider_free() */
+ return count;
+}
+
+/*
+ * Activate a provider.
+ * Return -1 on failure and the activation count on success
+ */
+static int provider_activate(OSSL_PROVIDER *prov, int lock, int upcalls)
+{
+ int count = -1;
+
+ if (provider_init(prov, lock)) {
+ int ret = 1;
+ struct provider_store_st *store;
+
+ store = get_provider_store(prov->libctx);
+ if (store == NULL)
+ return -1;
+
+ if (lock && !CRYPTO_THREAD_read_lock(store->lock))
+ return -1;
+
+ if (lock && !CRYPTO_THREAD_write_lock(prov->flag_lock)) {
+ CRYPTO_THREAD_unlock(store->lock);
+ return -1;
+ }
+
+#ifndef FIPS_MODULE
+ if (prov->ischild && upcalls)
+ ret = ossl_provider_up_ref_parent(prov, 1);
+#endif
+
+ if (ret) {
+ count = ++prov->activatecnt;
+ prov->flag_activated = 1;
+
+#ifndef FIPS_MODULE
+ if (prov->activatecnt == 1) {
+ OSSL_PROVIDER_CHILD_CB *child_cb;
+ int i, max;
+
+ max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
+ for (i = 0; i < max; i++) {
+ /*
+ * This is newly activated (activatecnt == 1), so we need to
+ * create child providers as necessary.
+ */
+ child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs,
+ i);
+ ret &= child_cb->create_cb((OSSL_CORE_HANDLE *)prov,
+ child_cb->cbdata);
+ }
+ }
+#endif
+ }
+
+ if (lock) {
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ CRYPTO_THREAD_unlock(store->lock);
+ }
+ if (!ret)
+ return -1;
}
+ return count;
+}
+
+static int provider_flush_store_cache(const OSSL_PROVIDER *prov)
+{
+ struct provider_store_st *store;
+ int freeing;
+
+ if ((store = get_provider_store(prov->libctx)) == NULL)
+ return 0;
+
+ if (!CRYPTO_THREAD_read_lock(store->lock))
+ return 0;
+ freeing = store->freeing;
+ CRYPTO_THREAD_unlock(store->lock);
+
+ if (!freeing)
+ return evp_method_store_flush(prov->libctx);
+ return 1;
+}
+
+int ossl_provider_activate(OSSL_PROVIDER *prov, int retain_fallbacks,
+ int upcalls)
+{
+ int count;
+
+ if (prov == NULL)
+ return 0;
+ if ((count = provider_activate(prov, 1, upcalls)) > 0) {
+ if (!retain_fallbacks) {
+ if (!CRYPTO_THREAD_write_lock(prov->store->lock)) {
+ provider_deactivate(prov);
+ return 0;
+ }
+ prov->store->use_fallbacks = 0;
+ CRYPTO_THREAD_unlock(prov->store->lock);
+ }
+ return count == 1 ? provider_flush_store_cache(prov) : 1;
+ }
return 0;
}
+int ossl_provider_deactivate(OSSL_PROVIDER *prov)
+{
+ int count;
+
+ if (prov == NULL || (count = provider_deactivate(prov)) < 0)
+ return 0;
+ return count == 0 ? provider_flush_store_cache(prov) : 1;
+}
+
void *ossl_provider_ctx(const OSSL_PROVIDER *prov)
{
return prov->provctx;
}
-
-static int provider_forall_loaded(struct provider_store_st *store,
- int *found_activated,
- int (*cb)(OSSL_PROVIDER *provider,
- void *cbdata),
- void *cbdata)
+/*
+ * This function only does something once when store->use_fallbacks == 1,
+ * and then sets store->use_fallbacks = 0, so the second call and so on is
+ * effectively a no-op.
+ */
+static void provider_activate_fallbacks(struct provider_store_st *store)
{
+ int use_fallbacks;
+ int num_provs;
+ int activated_fallback_count = 0;
int i;
- int ret = 1;
- int num_provs = sk_OSSL_PROVIDER_num(store->providers);
- if (found_activated != NULL)
- *found_activated = 0;
+ if (!CRYPTO_THREAD_read_lock(store->lock))
+ return;
+ use_fallbacks = store->use_fallbacks;
+ CRYPTO_THREAD_unlock(store->lock);
+ if (!use_fallbacks)
+ return;
+
+ if (!CRYPTO_THREAD_write_lock(store->lock))
+ return;
+ /* Check again, just in case another thread changed it */
+ use_fallbacks = store->use_fallbacks;
+ if (!use_fallbacks) {
+ CRYPTO_THREAD_unlock(store->lock);
+ return;
+ }
+
+ num_provs = sk_OSSL_PROVIDER_num(store->providers);
for (i = 0; i < num_provs; i++) {
- OSSL_PROVIDER *prov =
- sk_OSSL_PROVIDER_value(store->providers, i);
-
- if (prov->flag_initialized) {
- if (found_activated != NULL)
- *found_activated = 1;
- if (!(ret = cb(prov, cbdata)))
- break;
+ OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(store->providers, i);
+
+ if (ossl_provider_up_ref(prov)) {
+ if (CRYPTO_THREAD_write_lock(prov->flag_lock)) {
+ if (prov->flag_fallback) {
+ if (provider_activate(prov, 0, 0) > 0)
+ activated_fallback_count++;
+ }
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ }
+ ossl_provider_free(prov);
}
}
- return ret;
+ /*
+ * We assume that all fallbacks have been added to the store before
+ * any fallback is activated.
+ * TODO: We may have to reconsider this, IF we find ourselves adding
+ * fallbacks after any previous fallback has been activated.
+ */
+ if (activated_fallback_count > 0)
+ store->use_fallbacks = 0;
+
+ CRYPTO_THREAD_unlock(store->lock);
}
-int ossl_provider_forall_loaded(OPENSSL_CTX *ctx,
- int (*cb)(OSSL_PROVIDER *provider,
- void *cbdata),
- void *cbdata)
+int ossl_provider_doall_activated(OSSL_LIB_CTX *ctx,
+ int (*cb)(OSSL_PROVIDER *provider,
+ void *cbdata),
+ void *cbdata)
{
- int ret = 1;
- int i;
+ int ret = 0, curr, max;
struct provider_store_st *store = get_provider_store(ctx);
+ STACK_OF(OSSL_PROVIDER) *provs = NULL;
- if (store != NULL) {
- int found_activated = 0;
+#ifndef FIPS_MODULE
+ /*
+ * Make sure any providers are loaded from config before we try to use
+ * them.
+ */
+ if (ossl_lib_ctx_is_default(ctx))
+ OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
+ if (ossl_lib_ctx_is_child(ctx)
+ && !ossl_provider_init_child_providers(ctx))
+ return 0;
+#endif
- CRYPTO_THREAD_read_lock(store->lock);
- ret = provider_forall_loaded(store, &found_activated, cb, cbdata);
+ if (store == NULL)
+ return 1;
+ provider_activate_fallbacks(store);
- /*
- * If there's nothing activated ever in this store, try to activate
- * all fallbacks.
- */
- if (!found_activated && store->use_fallbacks) {
- int num_provs = sk_OSSL_PROVIDER_num(store->providers);
- int activated_fallback_count = 0;
-
- for (i = 0; i < num_provs; i++) {
- OSSL_PROVIDER *prov =
- sk_OSSL_PROVIDER_value(store->providers, i);
-
- /*
- * Note that we don't care if the activation succeeds or
- * not. If it doesn't succeed, then the next loop will
- * fail anyway.
- */
- if (prov->flag_fallback) {
- activated_fallback_count++;
- provider_activate(prov);
- }
+ /*
+ * Under lock, grab a copy of the provider list and up_ref each
+ * provider so that they don't disappear underneath us.
+ */
+ if (!CRYPTO_THREAD_read_lock(store->lock))
+ return 0;
+ provs = sk_OSSL_PROVIDER_dup(store->providers);
+ if (provs == NULL) {
+ CRYPTO_THREAD_unlock(store->lock);
+ return 0;
+ }
+ max = sk_OSSL_PROVIDER_num(provs);
+ /*
+ * We work backwards through the stack so that we can safely delete items
+ * as we go.
+ */
+ for (curr = max - 1; curr >= 0; curr--) {
+ OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
+
+ if (!CRYPTO_THREAD_write_lock(prov->flag_lock))
+ goto err_unlock;
+ if (prov->flag_activated) {
+ if (!ossl_provider_up_ref(prov)){
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ goto err_unlock;
}
-
- if (activated_fallback_count > 0) {
- /*
- * We assume that all fallbacks have been added to the store
- * before any fallback is activated.
- * TODO: We may have to reconsider this, IF we find ourselves
- * adding fallbacks after any previous fallback has been
- * activated.
- */
- store->use_fallbacks = 0;
-
- /*
- * Now that we've activated available fallbacks, try a
- * second sweep
- */
- ret = provider_forall_loaded(store, NULL, cb, cbdata);
+ /*
+ * It's already activated, but we up the activated count to ensure
+ * it remains activated until after we've called the user callback.
+ */
+ if (provider_activate(prov, 0, 1) < 0) {
+ ossl_provider_free(prov);
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ goto err_unlock;
}
+ } else {
+ sk_OSSL_PROVIDER_delete(provs, curr);
+ max--;
}
- CRYPTO_THREAD_unlock(store->lock);
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ }
+ CRYPTO_THREAD_unlock(store->lock);
+
+ /*
+ * Now, we sweep through all providers not under lock
+ */
+ for (curr = 0; curr < max; curr++) {
+ OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
+
+ if (!cb(prov, cbdata))
+ goto finish;
}
+ curr = -1;
+
+ ret = 1;
+ goto finish;
+
+ err_unlock:
+ CRYPTO_THREAD_unlock(store->lock);
+ finish:
+ /*
+ * The pop_free call doesn't do what we want on an error condition. We
+ * either start from the first item in the stack, or part way through if
+ * we only processed some of the items.
+ */
+ for (curr++; curr < max; curr++) {
+ OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
+ provider_deactivate(prov);
+ ossl_provider_free(prov);
+ }
+ sk_OSSL_PROVIDER_free(provs);
return ret;
}
+int ossl_provider_available(OSSL_PROVIDER *prov)
+{
+ int ret;
+
+ if (prov != NULL) {
+ provider_activate_fallbacks(prov->store);
+
+ if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
+ return 0;
+ ret = prov->flag_activated;
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ return ret;
+ }
+ return 0;
+}
+
/* Setters of Provider Object data */
int ossl_provider_set_fallback(OSSL_PROVIDER *prov)
{
const char *ossl_provider_module_name(const OSSL_PROVIDER *prov)
{
-#ifdef FIPS_MODE
+#ifdef FIPS_MODULE
return NULL;
#else
return DSO_get_filename(prov->module);
const char *ossl_provider_module_path(const OSSL_PROVIDER *prov)
{
-#ifdef FIPS_MODE
+#ifdef FIPS_MODULE
return NULL;
#else
/* FIXME: Ensure it's a full path */
#endif
}
+void *ossl_provider_prov_ctx(const OSSL_PROVIDER *prov)
+{
+ if (prov != NULL)
+ return prov->provctx;
+
+ return NULL;
+}
+
+const OSSL_DISPATCH *ossl_provider_get0_dispatch(const OSSL_PROVIDER *prov)
+{
+ if (prov != NULL)
+ return prov->dispatch;
+
+ return NULL;
+}
+
+OSSL_LIB_CTX *ossl_provider_libctx(const OSSL_PROVIDER *prov)
+{
+ return prov != NULL ? prov->libctx : NULL;
+}
+
/* Wrappers around calls to the provider */
void ossl_provider_teardown(const OSSL_PROVIDER *prov)
{
- if (prov->teardown != NULL)
+ if (prov->teardown != NULL
+#ifndef FIPS_MODULE
+ && !prov->ischild
+#endif
+ )
prov->teardown(prov->provctx);
}
-const OSSL_PARAM *ossl_provider_get_param_types(const OSSL_PROVIDER *prov)
+const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov)
{
- return prov->get_param_types == NULL
- ? NULL : prov->get_param_types(prov->provctx);
+ return prov->gettable_params == NULL
+ ? NULL : prov->gettable_params(prov->provctx);
}
int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
? 0 : prov->get_params(prov->provctx, params);
}
+int ossl_provider_self_test(const OSSL_PROVIDER *prov)
+{
+ int ret;
+
+ if (prov->self_test == NULL)
+ return 1;
+ ret = prov->self_test(prov->provctx);
+ if (ret == 0)
+ (void)provider_flush_store_cache(prov);
+ return ret;
+}
+
+int ossl_provider_get_capabilities(const OSSL_PROVIDER *prov,
+ const char *capability,
+ OSSL_CALLBACK *cb,
+ void *arg)
+{
+ return prov->get_capabilities == NULL
+ ? 1 : prov->get_capabilities(prov->provctx, capability, cb, arg);
+}
const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov,
int operation_id,
int *no_cache)
{
- return prov->query_operation(prov->provctx, operation_id, no_cache);
+ const OSSL_ALGORITHM *res;
+
+ if (prov->query_operation == NULL)
+ return NULL;
+ res = prov->query_operation(prov->provctx, operation_id, no_cache);
+#if defined(OPENSSL_NO_CACHED_FETCH)
+ /* Forcing the non-caching of queries */
+ if (no_cache != NULL)
+ *no_cache = 1;
+#endif
+ return res;
+}
+
+void ossl_provider_unquery_operation(const OSSL_PROVIDER *prov,
+ int operation_id,
+ const OSSL_ALGORITHM *algs)
+{
+ if (prov->unquery_operation != NULL)
+ prov->unquery_operation(prov->provctx, operation_id, algs);
+}
+
+int ossl_provider_clear_all_operation_bits(OSSL_LIB_CTX *libctx)
+{
+ struct provider_store_st *store;
+ OSSL_PROVIDER *provider;
+ int i, num, res = 1;
+
+ if ((store = get_provider_store(libctx)) != NULL) {
+ if (!CRYPTO_THREAD_read_lock(store->lock))
+ return 0;
+ num = sk_OSSL_PROVIDER_num(store->providers);
+ for (i = 0; i < num; i++) {
+ provider = sk_OSSL_PROVIDER_value(store->providers, i);
+ if (!CRYPTO_THREAD_write_lock(provider->opbits_lock)) {
+ res = 0;
+ continue;
+ }
+ if (provider->operation_bits != NULL)
+ memset(provider->operation_bits, 0,
+ provider->operation_bits_sz);
+ CRYPTO_THREAD_unlock(provider->opbits_lock);
+ }
+ CRYPTO_THREAD_unlock(store->lock);
+ return res;
+ }
+ return 0;
+}
+
+int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum)
+{
+ size_t byte = bitnum / 8;
+ unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
+
+ if (!CRYPTO_THREAD_write_lock(provider->opbits_lock))
+ return 0;
+ if (provider->operation_bits_sz <= byte) {
+ unsigned char *tmp = OPENSSL_realloc(provider->operation_bits,
+ byte + 1);
+
+ if (tmp == NULL) {
+ CRYPTO_THREAD_unlock(provider->opbits_lock);
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
+ return 0;
+ }
+ provider->operation_bits = tmp;
+ memset(provider->operation_bits + provider->operation_bits_sz,
+ '\0', byte + 1 - provider->operation_bits_sz);
+ provider->operation_bits_sz = byte + 1;
+ }
+ provider->operation_bits[byte] |= bit;
+ CRYPTO_THREAD_unlock(provider->opbits_lock);
+ return 1;
+}
+
+int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum,
+ int *result)
+{
+ size_t byte = bitnum / 8;
+ unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
+
+ if (!ossl_assert(result != NULL)) {
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
+ return 0;
+ }
+
+ *result = 0;
+ if (!CRYPTO_THREAD_read_lock(provider->opbits_lock))
+ return 0;
+ if (provider->operation_bits_sz > byte)
+ *result = ((provider->operation_bits[byte] & bit) != 0);
+ CRYPTO_THREAD_unlock(provider->opbits_lock);
+ return 1;
+}
+
+#ifndef FIPS_MODULE
+const OSSL_CORE_HANDLE *ossl_provider_get_parent(OSSL_PROVIDER *prov)
+{
+ return prov->handle;
+}
+
+int ossl_provider_is_child(const OSSL_PROVIDER *prov)
+{
+ return prov->ischild;
+}
+
+int ossl_provider_set_child(OSSL_PROVIDER *prov, const OSSL_CORE_HANDLE *handle)
+{
+ prov->handle = handle;
+ prov->ischild = 1;
+
+ return 1;
+}
+
+int ossl_provider_convert_to_child(OSSL_PROVIDER *prov,
+ const OSSL_CORE_HANDLE *handle,
+ OSSL_provider_init_fn *init_function)
+{
+ int flush = 0;
+
+ if (!CRYPTO_THREAD_write_lock(prov->store->lock))
+ return 0;
+ if (!CRYPTO_THREAD_write_lock(prov->flag_lock)) {
+ CRYPTO_THREAD_unlock(prov->store->lock);
+ return 0;
+ }
+ /*
+ * The provider could be in one of three states: (1) Already a child,
+ * (2) Not a child (but eligible to be one), or (3) Not a child (not
+ * eligible to be one).
+ */
+ if (prov->flag_couldbechild) {
+ ossl_provider_set_child(prov, handle);
+ prov->init_function = init_function;
+ }
+ if (prov->ischild && provider_activate(prov, 0, 0)) {
+ flush = 1;
+ prov->store->use_fallbacks = 0;
+ }
+
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ CRYPTO_THREAD_unlock(prov->store->lock);
+
+ if (flush)
+ provider_flush_store_cache(prov);
+
+ /*
+ * We report success whether or not the provider was eligible for conversion
+ * to a child. If its not elgibile then it has already been loaded as a non
+ * child provider and we should keep it like that.
+ */
+ return 1;
+}
+
+static int ossl_provider_register_child_cb(const OSSL_CORE_HANDLE *handle,
+ int (*create_cb)(
+ const OSSL_CORE_HANDLE *provider,
+ void *cbdata),
+ void (*remove_cb)(
+ const OSSL_CORE_HANDLE *provider,
+ void *cbdata),
+ void *cbdata)
+{
+ /*
+ * This is really an OSSL_PROVIDER that we created and cast to
+ * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
+ */
+ OSSL_PROVIDER *thisprov = (OSSL_PROVIDER *)handle;
+ OSSL_PROVIDER *prov;
+ OSSL_LIB_CTX *libctx = thisprov->libctx;
+ struct provider_store_st *store = NULL;
+ int ret = 0, i, max;
+ OSSL_PROVIDER_CHILD_CB *child_cb;
+
+ if ((store = get_provider_store(libctx)) == NULL)
+ return 0;
+
+ child_cb = OPENSSL_malloc(sizeof(*child_cb));
+ if (child_cb == NULL)
+ return 0;
+ child_cb->prov = thisprov;
+ child_cb->create_cb = create_cb;
+ child_cb->remove_cb = remove_cb;
+ child_cb->cbdata = cbdata;
+
+ if (!CRYPTO_THREAD_write_lock(store->lock)) {
+ OPENSSL_free(child_cb);
+ return 0;
+ }
+ max = sk_OSSL_PROVIDER_num(store->providers);
+ for (i = 0; i < max; i++) {
+ prov = sk_OSSL_PROVIDER_value(store->providers, i);
+ /*
+ * We require register_child_cb to be called during a provider init
+ * function. The currently initing provider will never be activated yet
+ * and we we should not attempt to aquire the flag_lock for it.
+ */
+ if (prov == thisprov)
+ continue;
+ if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
+ break;
+ /*
+ * We hold the lock while calling the user callback. This means that the
+ * user callback must be short and simple and not do anything likely to
+ * cause a deadlock.
+ */
+ if (prov->flag_activated
+ && !create_cb((OSSL_CORE_HANDLE *)prov, cbdata))
+ break;
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ }
+ if (i == max) {
+ /* Success */
+ ret = sk_OSSL_PROVIDER_CHILD_CB_push(store->child_cbs, child_cb);
+ }
+ if (i != max || ret <= 0) {
+ /* Failed during creation. Remove everything we just added */
+ for (; i >= 0; i--) {
+ prov = sk_OSSL_PROVIDER_value(store->providers, i);
+ remove_cb((OSSL_CORE_HANDLE *)prov, cbdata);
+ }
+ OPENSSL_free(child_cb);
+ ret = 0;
+ }
+ CRYPTO_THREAD_unlock(store->lock);
+
+ return ret;
+}
+
+static void ossl_provider_deregister_child_cb(const OSSL_CORE_HANDLE *handle)
+{
+ /*
+ * This is really an OSSL_PROVIDER that we created and cast to
+ * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
+ */
+ OSSL_PROVIDER *thisprov = (OSSL_PROVIDER *)handle;
+ OSSL_LIB_CTX *libctx = thisprov->libctx;
+ struct provider_store_st *store = NULL;
+ int i, max;
+ OSSL_PROVIDER_CHILD_CB *child_cb;
+
+ if ((store = get_provider_store(libctx)) == NULL)
+ return;
+
+ if (!CRYPTO_THREAD_write_lock(store->lock))
+ return;
+ max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
+ for (i = 0; i < max; i++) {
+ child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
+ if (child_cb->prov == thisprov) {
+ /* Found an entry */
+ sk_OSSL_PROVIDER_CHILD_CB_delete(store->child_cbs, i);
+ OPENSSL_free(child_cb);
+ break;
+ }
+ }
+ CRYPTO_THREAD_unlock(store->lock);
}
+#endif
/*-
* Core functions for the provider
* never knows.
*/
static const OSSL_PARAM param_types[] = {
- OSSL_PARAM_DEFN("openssl-verstion", OSSL_PARAM_UTF8_PTR, NULL, 0),
- OSSL_PARAM_DEFN("provider-name", OSSL_PARAM_UTF8_PTR, NULL, 0),
+ OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
+ OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_PROV_NAME, OSSL_PARAM_UTF8_PTR,
+ NULL, 0),
+#ifndef FIPS_MODULE
+ OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_MODULE_FILENAME, OSSL_PARAM_UTF8_PTR,
+ NULL, 0),
+#endif
OSSL_PARAM_END
};
-static const OSSL_PARAM *core_get_param_types(const OSSL_PROVIDER *prov)
+/*
+ * Forward declare all the functions that are provided aa dispatch.
+ * This ensures that the compiler will complain if they aren't defined
+ * with the correct signature.
+ */
+static OSSL_FUNC_core_gettable_params_fn core_gettable_params;
+static OSSL_FUNC_core_get_params_fn core_get_params;
+static OSSL_FUNC_core_thread_start_fn core_thread_start;
+static OSSL_FUNC_core_get_libctx_fn core_get_libctx;
+#ifndef FIPS_MODULE
+static OSSL_FUNC_core_new_error_fn core_new_error;
+static OSSL_FUNC_core_set_error_debug_fn core_set_error_debug;
+static OSSL_FUNC_core_vset_error_fn core_vset_error;
+static OSSL_FUNC_core_set_error_mark_fn core_set_error_mark;
+static OSSL_FUNC_core_clear_last_error_mark_fn core_clear_last_error_mark;
+static OSSL_FUNC_core_pop_error_to_mark_fn core_pop_error_to_mark;
+#endif
+
+static const OSSL_PARAM *core_gettable_params(const OSSL_CORE_HANDLE *handle)
{
return param_types;
}
-static int core_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
+static int core_get_params(const OSSL_CORE_HANDLE *handle, OSSL_PARAM params[])
{
int i;
OSSL_PARAM *p;
+ /*
+ * We created this object originally and we know it is actually an
+ * OSSL_PROVIDER *, so the cast is safe
+ */
+ OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
- if ((p = OSSL_PARAM_locate(params, "openssl-version")) != NULL)
+ if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_VERSION)) != NULL)
OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR);
- if ((p = OSSL_PARAM_locate(params, "provider-name")) != NULL)
+ if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_PROV_NAME)) != NULL)
OSSL_PARAM_set_utf8_ptr(p, prov->name);
+#ifndef FIPS_MODULE
+ if ((p = OSSL_PARAM_locate(params,
+ OSSL_PROV_PARAM_CORE_MODULE_FILENAME)) != NULL)
+ OSSL_PARAM_set_utf8_ptr(p, ossl_provider_module_path(prov));
+#endif
+
if (prov->parameters == NULL)
return 1;
if ((p = OSSL_PARAM_locate(params, pair->name)) != NULL)
OSSL_PARAM_set_utf8_ptr(p, pair->value);
}
-
return 1;
}
-static OSSL_core_get_library_context_fn core_get_libctx; /* Check */
-static OPENSSL_CTX *core_get_libctx(const OSSL_PROVIDER *prov)
+static OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle)
{
- return prov->libctx;
+ /*
+ * We created this object originally and we know it is actually an
+ * OSSL_PROVIDER *, so the cast is safe
+ */
+ OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
+
+ /*
+ * Using ossl_provider_libctx would be wrong as that returns
+ * NULL for |prov| == NULL and NULL libctx has a special meaning
+ * that does not apply here. Here |prov| == NULL can happen only in
+ * case of a coding error.
+ */
+ assert(prov != NULL);
+ return (OPENSSL_CORE_CTX *)prov->libctx;
}
-static int core_thread_start(const OSSL_PROVIDER *prov,
+static int core_thread_start(const OSSL_CORE_HANDLE *handle,
OSSL_thread_stop_handler_fn handfn)
{
+ /*
+ * We created this object originally and we know it is actually an
+ * OSSL_PROVIDER *, so the cast is safe
+ */
+ OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
+
return ossl_init_thread_start(prov, prov->provctx, handfn);
}
* needed there, since the FIPS module upcalls are always the outer provider
* ones.
*/
-#ifndef FIPS_MODE
-static void core_put_error(const OSSL_PROVIDER *prov,
- uint32_t reason, const char *file, int line)
+#ifndef FIPS_MODULE
+/*
+ * These error functions should use |handle| to select the proper
+ * library context to report in the correct error stack if error
+ * stacks become tied to the library context.
+ * We cannot currently do that since there's no support for it in the
+ * ERR subsystem.
+ */
+static void core_new_error(const OSSL_CORE_HANDLE *handle)
{
+ ERR_new();
+}
+
+static void core_set_error_debug(const OSSL_CORE_HANDLE *handle,
+ const char *file, int line, const char *func)
+{
+ ERR_set_debug(file, line, func);
+}
+
+static void core_vset_error(const OSSL_CORE_HANDLE *handle,
+ uint32_t reason, const char *fmt, va_list args)
+{
+ /*
+ * We created this object originally and we know it is actually an
+ * OSSL_PROVIDER *, so the cast is safe
+ */
+ OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
+
/*
* If the uppermost 8 bits are non-zero, it's an OpenSSL library
* error and will be treated as such. Otherwise, it's a new style
* provider error and will be treated as such.
*/
if (ERR_GET_LIB(reason) != 0) {
- ERR_PUT_error(ERR_GET_LIB(reason),
- ERR_GET_FUNC(reason),
- ERR_GET_REASON(reason),
- file, line);
+ ERR_vset_error(ERR_GET_LIB(reason), ERR_GET_REASON(reason), fmt, args);
} else {
- ERR_PUT_error(prov->error_lib, 0, (int)reason, file, line);
+ ERR_vset_error(prov->error_lib, (int)reason, fmt, args);
}
}
-/*
- * TODO(3.0) This, as well as core_put_error above, should use |prov|
- * to select the proper library context to report in the correct error
- * stack, at least if error stacks become tied to the library context.
- * We cannot currently do that since there's no support for it in the
- * ERR subsystem.
- */
-static void core_add_error_vdata(const OSSL_PROVIDER *prov,
- int num, va_list args)
+static int core_set_error_mark(const OSSL_CORE_HANDLE *handle)
{
- ERR_add_error_vdata(num, args);
+ return ERR_set_mark();
+}
+
+static int core_clear_last_error_mark(const OSSL_CORE_HANDLE *handle)
+{
+ return ERR_clear_last_mark();
}
-#endif
+
+static int core_pop_error_to_mark(const OSSL_CORE_HANDLE *handle)
+{
+ return ERR_pop_to_mark();
+}
+#endif /* FIPS_MODULE */
/*
- * Functions provided by the core. Blank line separates "families" of related
- * functions.
+ * Functions provided by the core.
*/
static const OSSL_DISPATCH core_dispatch_[] = {
- { OSSL_FUNC_CORE_GET_PARAM_TYPES, (void (*)(void))core_get_param_types },
+ { OSSL_FUNC_CORE_GETTABLE_PARAMS, (void (*)(void))core_gettable_params },
{ OSSL_FUNC_CORE_GET_PARAMS, (void (*)(void))core_get_params },
- { OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT, (void (*)(void))core_get_libctx },
+ { OSSL_FUNC_CORE_GET_LIBCTX, (void (*)(void))core_get_libctx },
{ OSSL_FUNC_CORE_THREAD_START, (void (*)(void))core_thread_start },
-#ifndef FIPS_MODE
- { OSSL_FUNC_CORE_PUT_ERROR, (void (*)(void))core_put_error },
- { OSSL_FUNC_CORE_ADD_ERROR_VDATA, (void (*)(void))core_add_error_vdata },
+#ifndef FIPS_MODULE
+ { OSSL_FUNC_CORE_NEW_ERROR, (void (*)(void))core_new_error },
+ { OSSL_FUNC_CORE_SET_ERROR_DEBUG, (void (*)(void))core_set_error_debug },
+ { OSSL_FUNC_CORE_VSET_ERROR, (void (*)(void))core_vset_error },
+ { OSSL_FUNC_CORE_SET_ERROR_MARK, (void (*)(void))core_set_error_mark },
+ { OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK,
+ (void (*)(void))core_clear_last_error_mark },
+ { OSSL_FUNC_CORE_POP_ERROR_TO_MARK, (void (*)(void))core_pop_error_to_mark },
+ { OSSL_FUNC_BIO_NEW_FILE, (void (*)(void))ossl_core_bio_new_file },
+ { OSSL_FUNC_BIO_NEW_MEMBUF, (void (*)(void))ossl_core_bio_new_mem_buf },
+ { OSSL_FUNC_BIO_READ_EX, (void (*)(void))ossl_core_bio_read_ex },
+ { OSSL_FUNC_BIO_WRITE_EX, (void (*)(void))ossl_core_bio_write_ex },
+ { OSSL_FUNC_BIO_GETS, (void (*)(void))ossl_core_bio_gets },
+ { OSSL_FUNC_BIO_PUTS, (void (*)(void))ossl_core_bio_puts },
+ { OSSL_FUNC_BIO_CTRL, (void (*)(void))ossl_core_bio_ctrl },
+ { OSSL_FUNC_BIO_UP_REF, (void (*)(void))ossl_core_bio_up_ref },
+ { OSSL_FUNC_BIO_FREE, (void (*)(void))ossl_core_bio_free },
+ { OSSL_FUNC_BIO_VPRINTF, (void (*)(void))ossl_core_bio_vprintf },
+ { OSSL_FUNC_BIO_VSNPRINTF, (void (*)(void))BIO_vsnprintf },
+ { OSSL_FUNC_SELF_TEST_CB, (void (*)(void))OSSL_SELF_TEST_get_callback },
+ { OSSL_FUNC_GET_ENTROPY, (void (*)(void))ossl_rand_get_entropy },
+ { OSSL_FUNC_CLEANUP_ENTROPY, (void (*)(void))ossl_rand_cleanup_entropy },
+ { OSSL_FUNC_GET_NONCE, (void (*)(void))ossl_rand_get_nonce },
+ { OSSL_FUNC_CLEANUP_NONCE, (void (*)(void))ossl_rand_cleanup_nonce },
#endif
-
{ OSSL_FUNC_CRYPTO_MALLOC, (void (*)(void))CRYPTO_malloc },
{ OSSL_FUNC_CRYPTO_ZALLOC, (void (*)(void))CRYPTO_zalloc },
{ OSSL_FUNC_CRYPTO_FREE, (void (*)(void))CRYPTO_free },
{ OSSL_FUNC_CRYPTO_SECURE_ALLOCATED,
(void (*)(void))CRYPTO_secure_allocated },
{ OSSL_FUNC_OPENSSL_CLEANSE, (void (*)(void))OPENSSL_cleanse },
-
+#ifndef FIPS_MODULE
+ { OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB,
+ (void (*)(void))ossl_provider_register_child_cb },
+ { OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB,
+ (void (*)(void))ossl_provider_deregister_child_cb },
+ { OSSL_FUNC_PROVIDER_NAME,
+ (void (*)(void))OSSL_PROVIDER_name },
+ { OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX,
+ (void (*)(void))OSSL_PROVIDER_get0_provider_ctx },
+ { OSSL_FUNC_PROVIDER_GET0_DISPATCH,
+ (void (*)(void))OSSL_PROVIDER_get0_dispatch },
+ { OSSL_FUNC_PROVIDER_UP_REF,
+ (void (*)(void))provider_up_ref_intern },
+ { OSSL_FUNC_PROVIDER_FREE,
+ (void (*)(void))provider_free_intern },
+#endif
{ 0, NULL }
};
static const OSSL_DISPATCH *core_dispatch = core_dispatch_;
projects / openssl.git / blobdiff