12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742 |
- /*
- * 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
- * in the file LICENSE in the source distribution or at
- * https://www.openssl.org/source/license.html
- */
- #include <assert.h>
- #include <openssl/core.h>
- #include <openssl/core_dispatch.h>
- #include <openssl/core_names.h>
- #include <openssl/provider.h>
- #include <openssl/params.h>
- #include <openssl/opensslv.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);
- /*-
- * 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);
- 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 */
- struct ossl_provider_st {
- /* Flag bits */
- unsigned int flag_initialized: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;
- OSSL_LIB_CTX *libctx; /* The library context this instance is in */
- struct provider_store_st *store; /* The store this instance belongs to */
- #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.
- */
- int error_lib; /* ERR library number, one for each provider */
- # ifndef OPENSSL_NO_ERR
- ERR_STRING_DATA *error_strings; /* Copy of what the provider gives us */
- # endif
- #endif
- /* Provider side functions */
- 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)
- static int ossl_provider_cmp(const OSSL_PROVIDER * const *a,
- const OSSL_PROVIDER * const *b)
- {
- return strcmp((*a)->name, (*b)->name);
- }
- /*-
- * Provider Object store
- * =====================
- *
- * The Provider Object store is a library context object, and therefore needs
- * an index.
- */
- 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;
- 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(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 = {
- /* 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(OSSL_LIB_CTX *libctx)
- {
- struct provider_store_st *store = NULL;
- store = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_PROVIDER_STORE_INDEX,
- &provider_store_method);
- if (store == NULL)
- ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
- return store;
- }
- 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;
- if ((store = get_provider_store(libctx)) != 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);
- }
- #endif
- tmpl.name = (char *)name;
- 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 = NULL;
- CRYPTO_THREAD_unlock(store->lock);
- }
- return prov;
- }
- /*-
- * Provider Object methods
- * =======================
- */
- static OSSL_PROVIDER *provider_new(const char *name,
- OSSL_provider_init_fn *init_function)
- {
- OSSL_PROVIDER *prov = NULL;
- if ((prov = OPENSSL_zalloc(sizeof(*prov))) == NULL
- #ifndef HAVE_ATOMICS
- || (prov->refcnt_lock = CRYPTO_THREAD_lock_new()) == NULL
- #endif
- || (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);
- 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;
- #ifndef FIPS_MODULE
- prov->flag_couldbechild = 1;
- #endif
- return prov;
- }
- int ossl_provider_up_ref(OSSL_PROVIDER *prov)
- {
- int ref = 0;
- 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, 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,
- 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;
- }
- /* provider_new() generates an error, so no need here */
- if ((prov = provider_new(name, init_function)) == 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;
- #ifndef FIPS_MODULE
- 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.
- */
- return prov;
- }
- static void free_infopair(INFOPAIR *pair)
- {
- OPENSSL_free(pair->name);
- OPENSSL_free(pair->value);
- OPENSSL_free(pair);
- }
- void ossl_provider_free(OSSL_PROVIDER *prov)
- {
- if (prov != NULL) {
- int ref = 0;
- CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
- /*
- * 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 == 0) {
- if (prov->flag_initialized) {
- ossl_provider_teardown(prov);
- #ifndef OPENSSL_NO_ERR
- # 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
- OPENSSL_free(prov->operation_bits);
- prov->operation_bits = NULL;
- prov->operation_bits_sz = 0;
- prov->flag_initialized = 0;
- }
- #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
- }
- }
- /* Setters */
- int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *module_path)
- {
- OPENSSL_free(prov->path);
- if (module_path == NULL)
- return 1;
- if ((prov->path = OPENSSL_strdup(module_path)) != NULL)
- return 1;
- ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
- return 0;
- }
- int ossl_provider_add_parameter(OSSL_PROVIDER *prov,
- 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)
- && (pair->name = OPENSSL_strdup(name)) != NULL
- && (pair->value = OPENSSL_strdup(value)) != NULL
- && sk_INFOPAIR_push(prov->parameters, pair) > 0)
- return 1;
- if (pair != NULL) {
- OPENSSL_free(pair->name);
- OPENSSL_free(pair->value);
- OPENSSL_free(pair);
- }
- ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
- return 0;
- }
- /*
- * Provider activation.
- *
- * What "activation" means depends on the provider form; for built in
- * providers (in the library or the application alike), the provider
- * can already be considered to be loaded, all that's needed is to
- * initialize it. However, for dynamically loadable provider modules,
- * we must first load that module.
- *
- * Built in modules are distinguished from dynamically loaded modules
- * with an already assigned init function.
- */
- 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_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_MODULE
- OSSL_FUNC_provider_get_reason_strings_fn *p_get_reason_strings = NULL;
- # endif
- #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;
- 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_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 = NULL;
- char *allocated_load_dir = NULL;
- struct provider_store_st *store;
- if ((prov->module = DSO_new()) == NULL) {
- /* DSO_new() generates an error already */
- goto end;
- }
- 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);
- module_path = prov->path;
- if (module_path == NULL)
- module_path = allocated_path =
- DSO_convert_filename(prov->module, prov->name);
- if (module_path != NULL)
- merged_path = DSO_merge(prov->module, module_path, load_dir);
- if (merged_path == NULL
- || (DSO_load(prov->module, merged_path, NULL, 0)) == NULL) {
- DSO_free(prov->module);
- prov->module = NULL;
- }
- OPENSSL_free(merged_path);
- OPENSSL_free(allocated_path);
- OPENSSL_free(allocated_load_dir);
- }
- if (prov->module != NULL)
- prov->init_function = (OSSL_provider_init_fn *)
- DSO_bind_func(prov->module, "OSSL_provider_init");
- #endif
- }
- /* Call the initialise function for the provider. */
- if (prov->init_function == NULL
- || !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_FUNC_provider_teardown(provider_dispatch);
- break;
- 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_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_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_MODULE
- case OSSL_FUNC_PROVIDER_GET_REASON_STRINGS:
- p_get_reason_strings =
- OSSL_FUNC_provider_get_reason_strings(provider_dispatch);
- break;
- # endif
- #endif
- }
- }
- #ifndef OPENSSL_NO_ERR
- # ifndef FIPS_MODULE
- if (p_get_reason_strings != NULL) {
- const OSSL_ITEM *reasonstrings = p_get_reason_strings(prov->provctx);
- size_t cnt, cnt2;
- /*
- * ERR_load_strings() handles ERR_STRING_DATA rather than OSSL_ITEM,
- * although they are essentially the same type.
- * Furthermore, ERR_load_strings() patches the array's error number
- * with the error library number, so we need to make a copy of that
- * array either way.
- */
- cnt = 0;
- while (reasonstrings[cnt].id != 0) {
- if (ERR_GET_LIB(reasonstrings[cnt].id) != 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)
- goto end;
- /*
- * Set the "library" name.
- */
- prov->error_strings[0].error = ERR_PACK(prov->error_lib, 0, 0);
- prov->error_strings[0].string = prov->name;
- /*
- * Copy reasonstrings item 0..cnt-1 to prov->error_trings positions
- * 1..cnt.
- */
- for (cnt2 = 1; cnt2 <= cnt; cnt2++) {
- prov->error_strings[cnt2].error = (int)reasonstrings[cnt2-1].id;
- prov->error_strings[cnt2].string = reasonstrings[cnt2-1].ptr;
- }
- ERR_load_strings(prov->error_lib, prov->error_strings);
- }
- # endif
- #endif
- /* With this flag set, this provider has become fully "loaded". */
- prov->flag_initialized = 1;
- ok = 1;
- end:
- if (flag_lock)
- CRYPTO_THREAD_unlock(prov->flag_lock);
- return ok;
- }
- /*
- * Deactivate a provider.
- * Return -1 on failure and the activation count on success
- */
- static int provider_deactivate(OSSL_PROVIDER *prov)
- {
- 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;
- }
- /*
- * 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;
- 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 (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);
- }
- }
- /*
- * We assume that all fallbacks have been added to the store before
- * any fallback is activated.
- */
- if (activated_fallback_count > 0)
- store->use_fallbacks = 0;
- CRYPTO_THREAD_unlock(store->lock);
- }
- int ossl_provider_doall_activated(OSSL_LIB_CTX *ctx,
- int (*cb)(OSSL_PROVIDER *provider,
- void *cbdata),
- void *cbdata)
- {
- int ret = 0, curr, max;
- struct provider_store_st *store = get_provider_store(ctx);
- STACK_OF(OSSL_PROVIDER) *provs = NULL;
- #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);
- #endif
- if (store == NULL)
- return 1;
- provider_activate_fallbacks(store);
- /*
- * 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;
- }
- /*
- * 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(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)
- {
- if (prov == NULL)
- return 0;
- prov->flag_fallback = 1;
- return 1;
- }
- /* Getters of Provider Object data */
- const char *ossl_provider_name(const OSSL_PROVIDER *prov)
- {
- return prov->name;
- }
- const DSO *ossl_provider_dso(const OSSL_PROVIDER *prov)
- {
- return prov->module;
- }
- const char *ossl_provider_module_name(const OSSL_PROVIDER *prov)
- {
- #ifdef FIPS_MODULE
- return NULL;
- #else
- return DSO_get_filename(prov->module);
- #endif
- }
- const char *ossl_provider_module_path(const OSSL_PROVIDER *prov)
- {
- #ifdef FIPS_MODULE
- return NULL;
- #else
- /* FIXME: Ensure it's a full path */
- return DSO_get_filename(prov->module);
- #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
- #ifndef FIPS_MODULE
- && !prov->ischild
- #endif
- )
- prov->teardown(prov->provctx);
- }
- const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov)
- {
- return prov->gettable_params == NULL
- ? NULL : prov->gettable_params(prov->provctx);
- }
- int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
- {
- return prov->get_params == NULL
- ? 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)
- {
- 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;
- }
- 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),
- int (*remove_cb)(
- const OSSL_CORE_HANDLE *provider,
- void *cbdata),
- int (*global_props_cb)(
- const char *props,
- 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;
- char *propsstr = NULL;
- 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->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++) {
- 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
- * ===============================
- *
- * This is the set of functions that the core makes available to the provider
- */
- /*
- * This returns a list of Provider Object parameters with their types, for
- * discovery. We do not expect that many providers will use this, but one
- * never knows.
- */
- static const OSSL_PARAM param_types[] = {
- 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
- };
- /*
- * 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_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, OSSL_PROV_PARAM_CORE_VERSION)) != NULL)
- OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR);
- 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;
- for (i = 0; i < sk_INFOPAIR_num(prov->parameters); i++) {
- INFOPAIR *pair = sk_INFOPAIR_value(prov->parameters, i);
- if ((p = OSSL_PARAM_locate(params, pair->name)) != NULL)
- OSSL_PARAM_set_utf8_ptr(p, pair->value);
- }
- return 1;
- }
- static OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle)
- {
- /*
- * 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_CORE_HANDLE *handle,
- OSSL_thread_stop_handler_fn handfn,
- void *arg)
- {
- /*
- * 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, arg, handfn);
- }
- /*
- * The FIPS module inner provider doesn't implement these. They aren't
- * needed there, since the FIPS module upcalls are always the outer provider
- * ones.
- */
- #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_vset_error(ERR_GET_LIB(reason), ERR_GET_REASON(reason), fmt, args);
- } else {
- ERR_vset_error(prov->error_lib, (int)reason, fmt, args);
- }
- }
- static int core_set_error_mark(const OSSL_CORE_HANDLE *handle)
- {
- return ERR_set_mark();
- }
- static int core_clear_last_error_mark(const OSSL_CORE_HANDLE *handle)
- {
- return ERR_clear_last_mark();
- }
- 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.
- */
- static const OSSL_DISPATCH core_dispatch_[] = {
- { OSSL_FUNC_CORE_GETTABLE_PARAMS, (void (*)(void))core_gettable_params },
- { OSSL_FUNC_CORE_GET_PARAMS, (void (*)(void))core_get_params },
- { OSSL_FUNC_CORE_GET_LIBCTX, (void (*)(void))core_get_libctx },
- { OSSL_FUNC_CORE_THREAD_START, (void (*)(void))core_thread_start },
- #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_CLEAR_FREE, (void (*)(void))CRYPTO_clear_free },
- { OSSL_FUNC_CRYPTO_REALLOC, (void (*)(void))CRYPTO_realloc },
- { OSSL_FUNC_CRYPTO_CLEAR_REALLOC, (void (*)(void))CRYPTO_clear_realloc },
- { OSSL_FUNC_CRYPTO_SECURE_MALLOC, (void (*)(void))CRYPTO_secure_malloc },
- { OSSL_FUNC_CRYPTO_SECURE_ZALLOC, (void (*)(void))CRYPTO_secure_zalloc },
- { OSSL_FUNC_CRYPTO_SECURE_FREE, (void (*)(void))CRYPTO_secure_free },
- { OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE,
- (void (*)(void))CRYPTO_secure_clear_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_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 },
- #endif
- { 0, NULL }
- };
- static const OSSL_DISPATCH *core_dispatch = core_dispatch_;
|