# include <openssl/self_test.h>
#endif
+/*
+ * This file defines and uses a number of different structures:
+ *
+ * OSSL_PROVIDER (provider_st): Used to represent all information related to a
+ * single instance of a provider.
+ *
+ * provider_store_st: Holds information about the collection of providers that
+ * are available within the current library context (OSSL_LIB_CTX). It also
+ * holds configuration information about providers that could be loaded at some
+ * future point.
+ *
+ * OSSL_PROVIDER_CHILD_CB: An instance of this structure holds the callbacks
+ * that have been registered for a child library context and the associated
+ * provider that registered those callbacks.
+ *
+ * Where a child library context exists then it has its own instance of the
+ * provider store. Each provider that exists in the parent provider store, has
+ * an associated child provider in the child library context's provider store.
+ * As providers get activated or deactivated this needs to be mirrored in the
+ * associated child providers.
+ *
+ * LOCKING
+ * =======
+ *
+ * There are a number of different locks used in this file and it is important
+ * to understand how they should be used in order to avoid deadlocks.
+ *
+ * Fields within a structure can often be "write once" on creation, and then
+ * "read many". Creation of a structure is done by a single thread, and
+ * therefore no lock is required for the "write once/read many" fields. It is
+ * safe for multiple threads to read these fields without a lock, because they
+ * will never be changed.
+ *
+ * However some fields may be changed after a structure has been created and
+ * shared between multiple threads. Where this is the case a lock is required.
+ *
+ * The locks available are:
+ *
+ * The provider flag_lock: Used to control updates to the various provider
+ * "flags" (flag_initialized and flag_activated) and associated
+ * "counts" (activatecnt).
+ *
+ * The provider refcnt_lock: Only ever used to control updates to the provider
+ * refcnt value.
+ *
+ * The provider optbits_lock: Used to control access to the provider's
+ * operation_bits and operation_bits_sz fields.
+ *
+ * The store default_path_lock: Used to control access to the provider store's
+ * default search path value (default_path)
+ *
+ * The store lock: Used to control the stack of provider's held within the
+ * provider store, as well as the stack of registered child provider callbacks.
+ *
+ * As a general rule-of-thumb it is best to:
+ * - keep the scope of the code that is protected by a lock to the absolute
+ * minimum possible;
+ * - try to keep the scope of the lock to within a single function (i.e. avoid
+ * making calls to other functions while holding a lock);
+ * - try to only ever hold one lock at a time.
+ *
+ * Unfortunately, it is not always possible to stick to the above guidelines.
+ * Where they are not adhered to there is always a danger of inadvertently
+ * introducing the possibility of deadlock. The following rules MUST be adhered
+ * to in order to avoid that:
+ * - Holding multiple locks at the same time is only allowed for the
+ * provider store lock, the provider flag_lock and the provider refcnt_lock.
+ * - When holding multiple locks they must be acquired in the following order of
+ * precedence:
+ * 1) provider store lock
+ * 2) provider flag_lock
+ * 3) provider refcnt_lock
+ * - When releasing locks they must be released in the reverse order to which
+ * they were acquired
+ * - No locks may be held when making an upcall. NOTE: Some common functions
+ * can make upcalls as part of their normal operation. If you need to call
+ * some other function while holding a lock make sure you know whether it
+ * will make any upcalls or not. For example ossl_provider_up_ref() can call
+ * ossl_provider_up_ref_parent() which can call the c_prov_up_ref() upcall.
+ * - It is permissible to hold the store and flag locks when calling child
+ * provider callbacks. No other locks may be held during such callbacks.
+ */
+
static OSSL_PROVIDER *provider_new(const char *name,
- OSSL_provider_init_fn *init_function);
+ OSSL_provider_init_fn *init_function,
+ STACK_OF(INFOPAIR) *parameters);
/*-
* Provider Object structure
* =========================
*/
-typedef struct {
- char *name;
- char *value;
-} 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);
+ int (*remove_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata);
+ int (*global_props_cb)(const char *props, void *cbdata);
void *cbdata;
} OSSL_PROVIDER_CHILD_CB;
DEFINE_STACK_OF(OSSL_PROVIDER_CHILD_CB)
+#endif
struct provider_store_st; /* Forward declaration */
/* Flag bits */
unsigned int flag_initialized:1;
unsigned int flag_activated:1;
- unsigned int flag_fallback:1; /* Can be used as fallback */
/* Getting and setting the flags require synchronization */
CRYPTO_RWLOCK *flag_lock;
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;
*/
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;
+ OSSL_PROVIDER_INFO *provinfo;
+ size_t numprovinfo;
+ size_t provinfosz;
unsigned int use_fallbacks:1;
unsigned int freeing:1;
};
static void provider_deactivate_free(OSSL_PROVIDER *prov)
{
if (prov->flag_activated)
- ossl_provider_deactivate(prov);
+ ossl_provider_deactivate(prov, 1);
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 infopair_free(INFOPAIR *pair)
+{
+ OPENSSL_free(pair->name);
+ OPENSSL_free(pair->value);
+ OPENSSL_free(pair);
+}
+
+static INFOPAIR *infopair_copy(const INFOPAIR *src)
+{
+ INFOPAIR *dest = OPENSSL_zalloc(sizeof(*dest));
+
+ if (dest == NULL)
+ return NULL;
+ if (src->name != NULL) {
+ dest->name = OPENSSL_strdup(src->name);
+ if (dest->name == NULL)
+ goto err;
+ }
+ if (src->value != NULL) {
+ dest->value = OPENSSL_strdup(src->value);
+ if (dest->value == NULL)
+ goto err;
+ }
+ return dest;
+ err:
+ OPENSSL_free(dest->name);
+ OPENSSL_free(dest);
+ return NULL;
+}
+
+void ossl_provider_info_clear(OSSL_PROVIDER_INFO *info)
+{
+ OPENSSL_free(info->name);
+ OPENSSL_free(info->path);
+ sk_INFOPAIR_pop_free(info->parameters, infopair_free);
+}
static void provider_store_free(void *vstore)
{
struct provider_store_st *store = vstore;
+ size_t i;
if (store == NULL)
return;
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);
+ for (i = 0; i < store->numprovinfo; i++)
+ ossl_provider_info_clear(&store->provinfo[i]);
+ OPENSSL_free(store->provinfo);
OPENSSL_free(store);
}
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 = ossl_predefined_providers; p->name != NULL; p++) {
- OSSL_PROVIDER *prov = NULL;
-
- /*
- * We use the internal constructor directly here,
- * otherwise we get a call loop
- */
- prov = provider_new(p->name, p->init);
-
- if (prov == NULL
- || sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
- ossl_provider_free(prov);
- provider_store_free(store);
- ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
- return NULL;
- }
- prov->libctx = ctx;
- prov->store = store;
-#ifndef FIPS_MODULE
- prov->error_lib = ERR_get_next_error_library();
-#endif
- if(p->is_fallback)
- ossl_provider_set_fallback(prov);
- }
-
return store;
}
static const OSSL_LIB_CTX_METHOD provider_store_method = {
- OSSL_LIB_CTX_METHOD_DEFAULT_PRIORITY,
+ /* Needs to be freed before the child provider data is freed */
+ OSSL_LIB_CTX_METHOD_PRIORITY_1,
provider_store_new,
provider_store_free,
};
return 0;
}
+#define BUILTINS_BLOCK_SIZE 10
+
+int ossl_provider_info_add_to_store(OSSL_LIB_CTX *libctx,
+ OSSL_PROVIDER_INFO *entry)
+{
+ struct provider_store_st *store = get_provider_store(libctx);
+ int ret = 0;
+
+ if (entry->name == NULL) {
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
+ return 0;
+ }
+
+ if (store == NULL) {
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
+ return 0;
+ }
+
+ if (!CRYPTO_THREAD_write_lock(store->lock))
+ return 0;
+ if (store->provinfosz == 0) {
+ store->provinfo = OPENSSL_zalloc(sizeof(*store->provinfo)
+ * BUILTINS_BLOCK_SIZE);
+ if (store->provinfo == NULL) {
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
+ goto err;
+ }
+ store->provinfosz = BUILTINS_BLOCK_SIZE;
+ } else if (store->numprovinfo == store->provinfosz) {
+ OSSL_PROVIDER_INFO *tmpbuiltins;
+ size_t newsz = store->provinfosz + BUILTINS_BLOCK_SIZE;
+
+ tmpbuiltins = OPENSSL_realloc(store->provinfo,
+ sizeof(*store->provinfo) * newsz);
+ if (tmpbuiltins == NULL) {
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
+ goto err;
+ }
+ store->provinfo = tmpbuiltins;
+ store->provinfosz = newsz;
+ }
+ store->provinfo[store->numprovinfo] = *entry;
+ store->numprovinfo++;
+
+ ret = 1;
+ err:
+ CRYPTO_THREAD_unlock(store->lock);
+ return ret;
+}
+
OSSL_PROVIDER *ossl_provider_find(OSSL_LIB_CTX *libctx, const char *name,
int noconfig)
{
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;
- if (!CRYPTO_THREAD_read_lock(store->lock))
+ /*
+ * A "find" operation can sort the stack, and therefore a write lock is
+ * required.
+ */
+ if (!CRYPTO_THREAD_write_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 = NULL;
+ if ((i = sk_OSSL_PROVIDER_find(store->providers, &tmpl)) != -1)
+ prov = sk_OSSL_PROVIDER_value(store->providers, i);
CRYPTO_THREAD_unlock(store->lock);
+ if (prov != NULL && !ossl_provider_up_ref(prov))
+ prov = NULL;
}
return prov;
*/
static OSSL_PROVIDER *provider_new(const char *name,
- OSSL_provider_init_fn *init_function)
+ OSSL_provider_init_fn *init_function,
+ STACK_OF(INFOPAIR) *parameters)
{
OSSL_PROVIDER *prov = NULL;
#ifndef HAVE_ATOMICS
|| (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) {
+ || (prov->name = OPENSSL_strdup(name)) == NULL
+ || (prov->parameters = sk_INFOPAIR_deep_copy(parameters,
+ infopair_copy,
+ infopair_free)) == NULL) {
ossl_provider_free(prov);
ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
return NULL;
}
+ prov->refcnt = 1; /* 1 One reference to be returned */
prov->init_function = init_function;
+
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;
}
+#ifndef FIPS_MODULE
+static int provider_up_ref_intern(OSSL_PROVIDER *prov, int activate)
+{
+ if (activate)
+ return ossl_provider_activate(prov, 1, 0);
+
+ return ossl_provider_up_ref(prov);
+}
+
+static int provider_free_intern(OSSL_PROVIDER *prov, int deactivate)
+{
+ if (deactivate)
+ return ossl_provider_deactivate(prov, 1);
+
+ ossl_provider_free(prov);
+ return 1;
+}
+#endif
+
+/*
+ * We assume that the requested provider does not already exist in the store.
+ * The caller should check. If it does exist then adding it to the store later
+ * will fail.
+ */
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_INFO template;
OSSL_PROVIDER *prov = NULL;
if ((store = get_provider_store(libctx)) == NULL)
return NULL;
- if ((prov = ossl_provider_find(libctx, name,
- noconfig)) != NULL) { /* refcount +1 */
- ossl_provider_free(prov); /* refcount -1 */
- ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_PROVIDER_ALREADY_EXISTS,
- "name=%s", name);
- return NULL;
+ memset(&template, 0, sizeof(template));
+ if (init_function == NULL) {
+ const OSSL_PROVIDER_INFO *p;
+ size_t i;
+
+ /* Check if this is a predefined builtin provider */
+ for (p = ossl_predefined_providers; p->name != NULL; p++) {
+ if (strcmp(p->name, name) == 0) {
+ template = *p;
+ break;
+ }
+ }
+ if (p->name == NULL) {
+ /* Check if this is a user added builtin provider */
+ if (!CRYPTO_THREAD_read_lock(store->lock))
+ return NULL;
+ for (i = 0, p = store->provinfo; i < store->numprovinfo; p++, i++) {
+ if (strcmp(p->name, name) == 0) {
+ template = *p;
+ break;
+ }
+ }
+ CRYPTO_THREAD_unlock(store->lock);
+ }
+ } else {
+ template.init = init_function;
}
/* provider_new() generates an error, so no need here */
- if ((prov = provider_new(name, init_function)) == NULL)
+ if ((prov = provider_new(name, template.init, template.parameters)) == NULL)
return NULL;
- 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 if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
- ossl_provider_free(prov); /* -1 Store reference */
- ossl_provider_free(prov); /* -1 Reference that was to be returned */
- prov = NULL;
- } else {
- prov->libctx = libctx;
- prov->store = store;
+ prov->libctx = libctx;
#ifndef FIPS_MODULE
- prov->error_lib = ERR_get_next_error_library();
+ prov->error_lib = ERR_get_next_error_library();
#endif
- }
- CRYPTO_THREAD_unlock(store->lock);
-
- if (prov == NULL)
- ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
/*
* At this point, the provider is only partially "loaded". To be
- * fully "loaded", ossl_provider_activate() must also be called.
+ * fully "loaded", ossl_provider_activate() must also be called and it must
+ * then be added to the provider store.
*/
return prov;
}
-static void free_infopair(INFOPAIR *pair)
+/* Assumes that the store lock is held */
+static int create_provider_children(OSSL_PROVIDER *prov)
{
- OPENSSL_free(pair->name);
- OPENSSL_free(pair->value);
- OPENSSL_free(pair);
+ int ret = 1;
+#ifndef FIPS_MODULE
+ struct provider_store_st *store = prov->store;
+ 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
+
+ return ret;
+}
+
+int ossl_provider_add_to_store(OSSL_PROVIDER *prov, OSSL_PROVIDER **actualprov,
+ int retain_fallbacks)
+{
+ struct provider_store_st *store;
+ int idx;
+ OSSL_PROVIDER tmpl = { 0, };
+ OSSL_PROVIDER *actualtmp = NULL;
+
+ if (actualprov != NULL)
+ *actualprov = NULL;
+
+ if ((store = get_provider_store(prov->libctx)) == NULL)
+ return 0;
+
+ if (!CRYPTO_THREAD_write_lock(store->lock))
+ return 0;
+
+ tmpl.name = (char *)prov->name;
+ idx = sk_OSSL_PROVIDER_find(store->providers, &tmpl);
+ if (idx == -1)
+ actualtmp = prov;
+ else
+ actualtmp = sk_OSSL_PROVIDER_value(store->providers, idx);
+
+ if (idx == -1) {
+ if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0)
+ goto err;
+ prov->store = store;
+ if (!create_provider_children(prov)) {
+ sk_OSSL_PROVIDER_delete_ptr(store->providers, prov);
+ goto err;
+ }
+ if (!retain_fallbacks)
+ store->use_fallbacks = 0;
+ }
+
+ CRYPTO_THREAD_unlock(store->lock);
+
+ if (actualprov != NULL) {
+ if (!ossl_provider_up_ref(actualtmp)) {
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
+ actualtmp = NULL;
+ goto err;
+ }
+ *actualprov = actualtmp;
+ }
+
+ if (idx >= 0) {
+ /*
+ * The provider is already in the store. Probably two threads
+ * independently initialised their own provider objects with the same
+ * name and raced to put them in the store. This thread lost. We
+ * deactivate the one we just created and use the one that already
+ * exists instead.
+ * If we get here then we know we did not create provider children
+ * above, so we inform ossl_provider_deactivate not to attempt to remove
+ * any.
+ */
+ ossl_provider_deactivate(prov, 0);
+ ossl_provider_free(prov);
+ }
+
+ return 1;
+
+ err:
+ CRYPTO_THREAD_unlock(store->lock);
+ if (actualprov != NULL)
+ ossl_provider_free(*actualprov);
+ return 0;
}
void ossl_provider_free(OSSL_PROVIDER *prov)
#endif
OPENSSL_free(prov->name);
OPENSSL_free(prov->path);
- sk_INFOPAIR_pop_free(prov->parameters, free_infopair);
+ sk_INFOPAIR_pop_free(prov->parameters, infopair_free);
CRYPTO_THREAD_lock_free(prov->opbits_lock);
CRYPTO_THREAD_lock_free(prov->flag_lock);
#ifndef HAVE_ATOMICS
#endif
OPENSSL_free(prov);
}
+#ifndef FIPS_MODULE
+ else if (prov->ischild) {
+ ossl_provider_free_parent(prov, 0);
+ }
+#endif
}
}
int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *module_path)
{
OPENSSL_free(prov->path);
+ prov->path = NULL;
if (module_path == NULL)
return 1;
if ((prov->path = OPENSSL_strdup(module_path)) != NULL)
return 0;
}
-int ossl_provider_add_parameter(OSSL_PROVIDER *prov,
- const char *name, const char *value)
+static int infopair_add(STACK_OF(INFOPAIR) **infopairsk, const char *name,
+ const char *value)
{
INFOPAIR *pair = NULL;
if ((pair = OPENSSL_zalloc(sizeof(*pair))) != NULL
- && (prov->parameters != NULL
- || (prov->parameters = sk_INFOPAIR_new_null()) != NULL)
+ && (*infopairsk != NULL
+ || (*infopairsk = sk_INFOPAIR_new_null()) != NULL)
&& (pair->name = OPENSSL_strdup(name)) != NULL
&& (pair->value = OPENSSL_strdup(value)) != NULL
- && sk_INFOPAIR_push(prov->parameters, pair) > 0)
+ && sk_INFOPAIR_push(*infopairsk, pair) > 0)
return 1;
if (pair != NULL) {
return 0;
}
+int ossl_provider_add_parameter(OSSL_PROVIDER *prov,
+ const char *name, const char *value)
+{
+ return infopair_add(&prov->parameters, name, value);
+}
+
+int ossl_provider_info_add_parameter(OSSL_PROVIDER_INFO *provinfo,
+ const char *name,
+ const char *value)
+{
+ return infopair_add(&provinfo->parameters, name, value);
+}
+
/*
* Provider activation.
*
* locking. Direct callers must remember to set the store flags when
* appropriate.
*/
-static int provider_init(OSSL_PROVIDER *prov, int flag_lock)
+static int provider_init(OSSL_PROVIDER *prov)
{
const OSSL_DISPATCH *provider_dispatch = NULL;
void *tmp_provctx = NULL; /* safety measure */
#endif
int ok = 0;
- /*
- * 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;
+ if (!ossl_assert(!prov->flag_initialized)) {
+ ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
goto end;
}
ok = 1;
end:
- if (flag_lock)
- CRYPTO_THREAD_unlock(prov->flag_lock);
return ok;
}
/*
- * Deactivate a provider.
+ * Deactivate a provider. If upcalls is 0 then we suppress any upcalls to a
+ * parent provider. If removechildren is 0 then we suppress any calls to remove
+ * child providers.
* Return -1 on failure and the activation count on success
*/
-static int provider_deactivate(OSSL_PROVIDER *prov)
+static int provider_deactivate(OSSL_PROVIDER *prov, int upcalls,
+ int removechildren)
{
int count;
struct provider_store_st *store;
+#ifndef FIPS_MODULE
+ int freeparent = 0;
+#endif
+ int lock = 1;
if (!ossl_assert(prov != NULL))
return -1;
+ /*
+ * No need to lock if we've got no store because we've not been shared with
+ * other threads.
+ */
store = get_provider_store(prov->libctx);
if (store == NULL)
- return 0;
+ lock = 0;
- if (!CRYPTO_THREAD_read_lock(store->lock))
- return 0;
- if (!CRYPTO_THREAD_write_lock(prov->flag_lock))
+ 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;
+ }
- if ((count = --prov->activatecnt) < 1) {
+#ifndef FIPS_MODULE
+ if (prov->activatecnt >= 2 && prov->ischild && upcalls) {
+ /*
+ * We have had a direct activation in this child libctx so we need to
+ * now down the ref count in the parent provider. We do the actual down
+ * ref outside of the flag_lock, since it could involve getting other
+ * locks.
+ */
+ freeparent = 1;
+ }
+#endif
+
+ if ((count = --prov->activatecnt) < 1)
+ prov->flag_activated = 0;
+#ifndef FIPS_MODULE
+ else
+ removechildren = 0;
+#endif
+
+#ifndef FIPS_MODULE
+ if (removechildren && store != NULL) {
int i, max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
OSSL_PROVIDER_CHILD_CB *child_cb;
- prov->flag_activated = 0;
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);
}
}
-
- CRYPTO_THREAD_unlock(prov->flag_lock);
- CRYPTO_THREAD_unlock(store->lock);
+#endif
+ if (lock) {
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ CRYPTO_THREAD_unlock(store->lock);
+ }
+#ifndef FIPS_MODULE
+ if (freeparent)
+ ossl_provider_free_parent(prov, 1);
+#endif
/* 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)
+static int provider_activate(OSSL_PROVIDER *prov, int lock, int upcalls)
{
int count = -1;
+ struct provider_store_st *store;
+ int ret = 1;
- if (provider_init(prov, lock)) {
- int i, max, ret;
- OSSL_PROVIDER_CHILD_CB *child_cb;
- struct provider_store_st *store;
+ store = prov->store;
+ /*
+ * If the provider hasn't been added to the store, then we don't need
+ * any locks because we've not shared it with other threads.
+ */
+ if (store == NULL) {
+ lock = 0;
+ if (!provider_init(prov))
+ return -1;
+ }
- store = get_provider_store(prov->libctx);
- if (store == NULL)
- return 0;
+#ifndef FIPS_MODULE
+ if (prov->ischild && upcalls && !ossl_provider_up_ref_parent(prov, 1))
+ return -1;
+#endif
- if (lock && !CRYPTO_THREAD_read_lock(store->lock))
- return 0;
+ if (lock && !CRYPTO_THREAD_read_lock(store->lock)) {
+#ifndef FIPS_MODULE
+ if (prov->ischild && upcalls)
+ ossl_provider_free_parent(prov, 1);
+#endif
+ return -1;
+ }
- max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
- if (lock && !CRYPTO_THREAD_write_lock(prov->flag_lock))
- return 0;
- if (ret) {
- count = ++prov->activatecnt;
- prov->flag_activated = 1;
+ if (lock && !CRYPTO_THREAD_write_lock(prov->flag_lock)) {
+ CRYPTO_THREAD_unlock(store->lock);
+#ifndef FIPS_MODULE
+ if (prov->ischild && upcalls)
+ ossl_provider_free_parent(prov, 1);
+#endif
+ return -1;
+ }
- for (i = 0; i < max; i++) {
- child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
- child_cb->create_cb((OSSL_CORE_HANDLE *)prov, child_cb->cbdata);
- }
- }
- if (lock) {
- CRYPTO_THREAD_unlock(prov->flag_lock);
- CRYPTO_THREAD_unlock(store->lock);
- }
+ count = ++prov->activatecnt;
+ prov->flag_activated = 1;
+
+ if (prov->activatecnt == 1 && store != NULL) {
+ ret = create_provider_children(prov);
+ }
+ if (lock) {
+ CRYPTO_THREAD_unlock(prov->flag_lock);
+ CRYPTO_THREAD_unlock(store->lock);
}
+ if (!ret)
+ return -1;
+
return count;
}
return 1;
}
-int ossl_provider_activate(OSSL_PROVIDER *prov, int retain_fallbacks)
+int ossl_provider_activate(OSSL_PROVIDER *prov, int upcalls, int aschild)
{
int count;
if (prov == NULL)
return 0;
- if ((count = provider_activate(prov, 1)) > 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);
- }
+#ifndef FIPS_MODULE
+ /*
+ * If aschild is true, then we only actually do the activation if the
+ * provider is a child. If its not, this is still success.
+ */
+ if (aschild && !prov->ischild)
+ return 1;
+#endif
+ if ((count = provider_activate(prov, 1, upcalls)) > 0)
return count == 1 ? provider_flush_store_cache(prov) : 1;
- }
+
return 0;
}
-int ossl_provider_deactivate(OSSL_PROVIDER *prov)
+int ossl_provider_deactivate(OSSL_PROVIDER *prov, int removechildren)
{
int count;
- if (prov == NULL || (count = provider_deactivate(prov)) < 0)
+ if (prov == NULL
+ || (count = provider_deactivate(prov, 1, removechildren)) < 0)
return 0;
return count == 0 ? provider_flush_store_cache(prov) : 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)
+static int provider_activate_fallbacks(struct provider_store_st *store)
{
int use_fallbacks;
- int num_provs;
int activated_fallback_count = 0;
- int i;
+ int ret = 0;
+ const OSSL_PROVIDER_INFO *p;
if (!CRYPTO_THREAD_read_lock(store->lock))
- return;
+ return 0;
use_fallbacks = store->use_fallbacks;
CRYPTO_THREAD_unlock(store->lock);
if (!use_fallbacks)
- return;
+ return 1;
if (!CRYPTO_THREAD_write_lock(store->lock))
- return;
+ return 0;
/* Check again, just in case another thread changed it */
use_fallbacks = store->use_fallbacks;
if (!use_fallbacks) {
CRYPTO_THREAD_unlock(store->lock);
- return;
+ return 1;
}
- 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);
+ for (p = ossl_predefined_providers; p->name != NULL; p++) {
+ OSSL_PROVIDER *prov = NULL;
- if (ossl_provider_up_ref(prov)) {
- if (CRYPTO_THREAD_write_lock(prov->flag_lock)) {
- if (prov->flag_fallback) {
- if (provider_activate(prov, 0) > 0)
- activated_fallback_count++;
- }
- CRYPTO_THREAD_unlock(prov->flag_lock);
- }
+ if (!p->is_fallback)
+ continue;
+ /*
+ * We use the internal constructor directly here,
+ * otherwise we get a call loop
+ */
+ prov = provider_new(p->name, p->init, NULL);
+ if (prov == NULL)
+ goto err;
+ prov->libctx = store->libctx;
+#ifndef FIPS_MODULE
+ prov->error_lib = ERR_get_next_error_library();
+#endif
+
+ /*
+ * We are calling provider_activate while holding the store lock. This
+ * means the init function will be called while holding a lock. Normally
+ * we try to avoid calling a user callback while holding a lock.
+ * However, fallbacks are never third party providers so we accept this.
+ */
+ if (provider_activate(prov, 0, 0) < 0) {
+ ossl_provider_free(prov);
+ goto err;
+ }
+ prov->store = store;
+ if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
ossl_provider_free(prov);
+ goto err;
}
+ activated_fallback_count++;
}
- /*
- * 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)
+ if (activated_fallback_count > 0) {
store->use_fallbacks = 0;
-
+ ret = 1;
+ }
+ err:
CRYPTO_THREAD_unlock(store->lock);
+ return ret;
}
int ossl_provider_doall_activated(OSSL_LIB_CTX *ctx,
void *cbdata),
void *cbdata)
{
- int ret = 0, curr, max;
+ int ret = 0, curr, max, ref = 0;
struct provider_store_st *store = get_provider_store(ctx);
STACK_OF(OSSL_PROVIDER) *provs = NULL;
*/
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
if (store == NULL)
return 1;
- provider_activate_fallbacks(store);
+ if (!provider_activate_fallbacks(store))
+ return 0;
/*
* Under lock, grab a copy of the provider list and up_ref each
if (!CRYPTO_THREAD_write_lock(prov->flag_lock))
goto err_unlock;
if (prov->flag_activated) {
- if (!ossl_provider_up_ref(prov)){
+ /*
+ * We call CRYPTO_UP_REF directly rather than ossl_provider_up_ref
+ * to avoid upping the ref count on the parent provider, which we
+ * must not do while holding locks.
+ */
+ if (CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock) <= 0) {
CRYPTO_THREAD_unlock(prov->flag_lock);
goto err_unlock;
}
/*
* It's already activated, but we up the activated count to ensure
* it remains activated until after we've called the user callback.
+ * We do this with no locking (because we already hold the locks)
+ * and no upcalls (which must not be called when locks are held). In
+ * theory this could mean the parent provider goes inactive, whilst
+ * still activated in the child for a short period. That's ok.
*/
- if (provider_activate(prov, 0) < 0) {
- ossl_provider_free(prov);
+ if (provider_activate(prov, 0, 0) < 0) {
+ CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
CRYPTO_THREAD_unlock(prov->flag_lock);
goto err_unlock;
}
for (curr++; curr < max; curr++) {
OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
- provider_deactivate(prov);
- ossl_provider_free(prov);
+ provider_deactivate(prov, 0, 1);
+ /*
+ * As above where we did the up-ref, we don't call ossl_provider_free
+ * to avoid making upcalls. There should always be at least one ref
+ * to the provider in the store, so this should never drop to 0.
+ */
+ CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
+ /*
+ * Not much we can do if this assert ever fails. So we don't use
+ * ossl_assert here.
+ */
+ assert(ref > 0);
}
sk_OSSL_PROVIDER_free(provs);
return ret;
}
-int ossl_provider_available(OSSL_PROVIDER *prov)
+int OSSL_PROVIDER_available(OSSL_LIB_CTX *libctx, const char *name)
{
- int ret;
+ OSSL_PROVIDER *prov = NULL;
+ int available = 0;
+ struct provider_store_st *store = get_provider_store(libctx);
- if (prov != NULL) {
- provider_activate_fallbacks(prov->store);
+ if (store == NULL || !provider_activate_fallbacks(store))
+ return 0;
+ prov = ossl_provider_find(libctx, name, 0);
+ if (prov != NULL) {
if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
return 0;
- ret = prov->flag_activated;
+ available = prov->flag_activated;
CRYPTO_THREAD_unlock(prov->flag_lock);
- return ret;
+ ossl_provider_free(prov);
}
- return 0;
-}
-
-/* Setters of Provider Object data */
-int ossl_provider_set_fallback(OSSL_PROVIDER *prov)
-{
- if (prov == NULL)
- return 0;
-
- prov->flag_fallback = 1;
- return 1;
+ return available;
}
/* Getters of Provider Object data */
/* Wrappers around calls to the provider */
void ossl_provider_teardown(const OSSL_PROVIDER *prov)
{
- if (prov->teardown != NULL && !prov->ischild)
+ if (prov->teardown != NULL
+#ifndef FIPS_MODULE
+ && !prov->ischild
+#endif
+ )
prov->teardown(prov->provctx);
}
return 1;
}
-void ossl_provider_set_child(OSSL_PROVIDER *prov)
+#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_default_props_update(OSSL_LIB_CTX *libctx, const char *props)
+{
#ifndef FIPS_MODULE
+ struct provider_store_st *store = NULL;
+ int i, max;
+ OSSL_PROVIDER_CHILD_CB *child_cb;
+
+ if ((store = get_provider_store(libctx)) == NULL)
+ return 0;
+
+ if (!CRYPTO_THREAD_read_lock(store->lock))
+ return 0;
+
+ 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);
+ child_cb->global_props_cb(props, child_cb->cbdata);
+ }
+
+ CRYPTO_THREAD_unlock(store->lock);
+#endif
+ 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)(
+ int (*remove_cb)(
const OSSL_CORE_HANDLE *provider,
void *cbdata),
+ int (*global_props_cb)(
+ const char *props,
+ void *cbdata),
void *cbdata)
{
/*
struct provider_store_st *store = NULL;
int ret = 0, i, max;
OSSL_PROVIDER_CHILD_CB *child_cb;
+ char *propsstr = NULL;
if ((store = get_provider_store(libctx)) == NULL)
return 0;
child_cb->prov = thisprov;
child_cb->create_cb = create_cb;
child_cb->remove_cb = remove_cb;
+ child_cb->global_props_cb = global_props_cb;
child_cb->cbdata = cbdata;
if (!CRYPTO_THREAD_write_lock(store->lock)) {
OPENSSL_free(child_cb);
return 0;
}
+ propsstr = evp_get_global_properties_str(libctx, 0);
+
+ if (propsstr != NULL) {
+ global_props_cb(propsstr, cbdata);
+ OPENSSL_free(propsstr);
+ }
max = sk_OSSL_PROVIDER_num(store->providers);
for (i = 0; i < max; i++) {
+ int activated;
+
prov = sk_OSSL_PROVIDER_value(store->providers, i);
+
if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
break;
+ activated = prov->flag_activated;
+ CRYPTO_THREAD_unlock(prov->flag_lock);
/*
- * 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.
+ * We hold the store 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. We don't hold the flag_lock during this
+ * call. In theory this means that another thread could deactivate it
+ * while we are calling create. This is ok because the other thread
+ * will also call remove_cb, but won't be able to do so until we release
+ * the store lock.
*/
- if (prov->flag_activated
- && !create_cb((OSSL_CORE_HANDLE *)prov, cbdata))
+ if (activated && !create_cb((OSSL_CORE_HANDLE *)prov, cbdata))
break;
- CRYPTO_THREAD_unlock(prov->flag_lock);
}
if (i == max) {
/* Success */
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;
+static OSSL_FUNC_core_obj_add_sigid_fn core_obj_add_sigid;
+static OSSL_FUNC_core_obj_create_fn core_obj_create;
#endif
static const OSSL_PARAM *core_gettable_params(const OSSL_CORE_HANDLE *handle)
}
static int core_thread_start(const OSSL_CORE_HANDLE *handle,
- OSSL_thread_stop_handler_fn handfn)
+ OSSL_thread_stop_handler_fn handfn,
+ void *arg)
{
/*
* We created this object originally and we know it is actually an
*/
OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
- return ossl_init_thread_start(prov, prov->provctx, handfn);
+ return ossl_init_thread_start(prov, arg, handfn);
}
/*
{
return ERR_pop_to_mark();
}
+
+static int core_obj_add_sigid(const OSSL_CORE_HANDLE *prov,
+ const char *sign_name, const char *digest_name,
+ const char *pkey_name)
+{
+ int sign_nid = OBJ_txt2nid(sign_name);
+ int digest_nid = NID_undef;
+ int pkey_nid = OBJ_txt2nid(pkey_name);
+
+ if (digest_name != NULL && digest_name[0] != '\0'
+ && (digest_nid = OBJ_txt2nid(digest_name)) == NID_undef)
+ return 0;
+
+ if (sign_nid == NID_undef)
+ return 0;
+
+ /*
+ * Check if it already exists. This is a success if so (even if we don't
+ * have nids for the digest/pkey)
+ */
+ if (OBJ_find_sigid_algs(sign_nid, NULL, NULL))
+ return 1;
+
+ if (pkey_nid == NID_undef)
+ return 0;
+
+ return OBJ_add_sigid(sign_nid, digest_nid, pkey_nid);
+}
+
+static int core_obj_create(const OSSL_CORE_HANDLE *prov, const char *oid,
+ const char *sn, const char *ln)
+{
+ /* Check if it already exists and create it if not */
+ return OBJ_txt2nid(oid) != NID_undef
+ || OBJ_create(oid, sn, ln) != NID_undef;
+}
#endif /* FIPS_MODULE */
/*
{ OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB,
(void (*)(void))ossl_provider_deregister_child_cb },
{ OSSL_FUNC_PROVIDER_NAME,
- (void (*)(void))OSSL_PROVIDER_name },
+ (void (*)(void))OSSL_PROVIDER_get0_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 },
+ { OSSL_FUNC_CORE_OBJ_ADD_SIGID, (void (*)(void))core_obj_add_sigid },
+ { OSSL_FUNC_CORE_OBJ_CREATE, (void (*)(void))core_obj_create },
#endif
{ 0, NULL }
};
projects / openssl.git / blobdiff