VirtualBox

source: vbox/trunk/src/libs/openssl-3.1.7/crypto/provider_core.c@ 105949

Last change on this file since 105949 was 105949, checked in by vboxsync, 5 months ago

openssl-3.1.7: Applied and adjusted our OpenSSL changes to 3.1.7. bugref:10757

File size: 70.9 KB
Line 
1/*
2 * Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10#include <assert.h>
11#include <openssl/core.h>
12#include <openssl/core_dispatch.h>
13#include <openssl/core_names.h>
14#include <openssl/provider.h>
15#include <openssl/params.h>
16#include <openssl/opensslv.h>
17#include "crypto/cryptlib.h"
18#ifndef FIPS_MODULE
19#include "crypto/decoder.h" /* ossl_decoder_store_cache_flush */
20#include "crypto/encoder.h" /* ossl_encoder_store_cache_flush */
21#include "crypto/store.h" /* ossl_store_loader_store_cache_flush */
22#endif
23#include "crypto/evp.h" /* evp_method_store_cache_flush */
24#include "crypto/rand.h"
25#include "internal/nelem.h"
26#include "internal/thread_once.h"
27#include "internal/provider.h"
28#include "internal/refcount.h"
29#include "internal/bio.h"
30#include "internal/core.h"
31#include "provider_local.h"
32#include "crypto/context.h"
33#ifndef FIPS_MODULE
34# include <openssl/self_test.h>
35#endif
36
37/*
38 * This file defines and uses a number of different structures:
39 *
40 * OSSL_PROVIDER (provider_st): Used to represent all information related to a
41 * single instance of a provider.
42 *
43 * provider_store_st: Holds information about the collection of providers that
44 * are available within the current library context (OSSL_LIB_CTX). It also
45 * holds configuration information about providers that could be loaded at some
46 * future point.
47 *
48 * OSSL_PROVIDER_CHILD_CB: An instance of this structure holds the callbacks
49 * that have been registered for a child library context and the associated
50 * provider that registered those callbacks.
51 *
52 * Where a child library context exists then it has its own instance of the
53 * provider store. Each provider that exists in the parent provider store, has
54 * an associated child provider in the child library context's provider store.
55 * As providers get activated or deactivated this needs to be mirrored in the
56 * associated child providers.
57 *
58 * LOCKING
59 * =======
60 *
61 * There are a number of different locks used in this file and it is important
62 * to understand how they should be used in order to avoid deadlocks.
63 *
64 * Fields within a structure can often be "write once" on creation, and then
65 * "read many". Creation of a structure is done by a single thread, and
66 * therefore no lock is required for the "write once/read many" fields. It is
67 * safe for multiple threads to read these fields without a lock, because they
68 * will never be changed.
69 *
70 * However some fields may be changed after a structure has been created and
71 * shared between multiple threads. Where this is the case a lock is required.
72 *
73 * The locks available are:
74 *
75 * The provider flag_lock: Used to control updates to the various provider
76 * "flags" (flag_initialized and flag_activated) and associated
77 * "counts" (activatecnt).
78 *
79 * The provider refcnt_lock: Only ever used to control updates to the provider
80 * refcnt value.
81 *
82 * The provider optbits_lock: Used to control access to the provider's
83 * operation_bits and operation_bits_sz fields.
84 *
85 * The store default_path_lock: Used to control access to the provider store's
86 * default search path value (default_path)
87 *
88 * The store lock: Used to control the stack of provider's held within the
89 * provider store, as well as the stack of registered child provider callbacks.
90 *
91 * As a general rule-of-thumb it is best to:
92 * - keep the scope of the code that is protected by a lock to the absolute
93 * minimum possible;
94 * - try to keep the scope of the lock to within a single function (i.e. avoid
95 * making calls to other functions while holding a lock);
96 * - try to only ever hold one lock at a time.
97 *
98 * Unfortunately, it is not always possible to stick to the above guidelines.
99 * Where they are not adhered to there is always a danger of inadvertently
100 * introducing the possibility of deadlock. The following rules MUST be adhered
101 * to in order to avoid that:
102 * - Holding multiple locks at the same time is only allowed for the
103 * provider store lock, the provider flag_lock and the provider refcnt_lock.
104 * - When holding multiple locks they must be acquired in the following order of
105 * precedence:
106 * 1) provider store lock
107 * 2) provider flag_lock
108 * 3) provider refcnt_lock
109 * - When releasing locks they must be released in the reverse order to which
110 * they were acquired
111 * - No locks may be held when making an upcall. NOTE: Some common functions
112 * can make upcalls as part of their normal operation. If you need to call
113 * some other function while holding a lock make sure you know whether it
114 * will make any upcalls or not. For example ossl_provider_up_ref() can call
115 * ossl_provider_up_ref_parent() which can call the c_prov_up_ref() upcall.
116 * - It is permissible to hold the store and flag locks when calling child
117 * provider callbacks. No other locks may be held during such callbacks.
118 */
119
120static OSSL_PROVIDER *provider_new(const char *name,
121 OSSL_provider_init_fn *init_function,
122 STACK_OF(INFOPAIR) *parameters);
123
124/*-
125 * Provider Object structure
126 * =========================
127 */
128
129#ifndef FIPS_MODULE
130typedef struct {
131 OSSL_PROVIDER *prov;
132 int (*create_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata);
133 int (*remove_cb)(const OSSL_CORE_HANDLE *provider, void *cbdata);
134 int (*global_props_cb)(const char *props, void *cbdata);
135 void *cbdata;
136} OSSL_PROVIDER_CHILD_CB;
137DEFINE_STACK_OF(OSSL_PROVIDER_CHILD_CB)
138#endif
139
140struct provider_store_st; /* Forward declaration */
141
142struct ossl_provider_st {
143 /* Flag bits */
144 unsigned int flag_initialized:1;
145 unsigned int flag_activated:1;
146
147 /* Getting and setting the flags require synchronization */
148 CRYPTO_RWLOCK *flag_lock;
149
150 /* OpenSSL library side data */
151 CRYPTO_REF_COUNT refcnt;
152 CRYPTO_RWLOCK *refcnt_lock; /* For the ref counter */
153 int activatecnt;
154 char *name;
155 char *path;
156 DSO *module;
157 OSSL_provider_init_fn *init_function;
158 STACK_OF(INFOPAIR) *parameters;
159 OSSL_LIB_CTX *libctx; /* The library context this instance is in */
160 struct provider_store_st *store; /* The store this instance belongs to */
161#ifndef FIPS_MODULE
162 /*
163 * In the FIPS module inner provider, this isn't needed, since the
164 * error upcalls are always direct calls to the outer provider.
165 */
166 int error_lib; /* ERR library number, one for each provider */
167# ifndef OPENSSL_NO_ERR
168 ERR_STRING_DATA *error_strings; /* Copy of what the provider gives us */
169# endif
170#endif
171
172 /* Provider side functions */
173 OSSL_FUNC_provider_teardown_fn *teardown;
174 OSSL_FUNC_provider_gettable_params_fn *gettable_params;
175 OSSL_FUNC_provider_get_params_fn *get_params;
176 OSSL_FUNC_provider_get_capabilities_fn *get_capabilities;
177 OSSL_FUNC_provider_self_test_fn *self_test;
178 OSSL_FUNC_provider_query_operation_fn *query_operation;
179 OSSL_FUNC_provider_unquery_operation_fn *unquery_operation;
180
181 /*
182 * Cache of bit to indicate of query_operation() has been called on
183 * a specific operation or not.
184 */
185 unsigned char *operation_bits;
186 size_t operation_bits_sz;
187 CRYPTO_RWLOCK *opbits_lock;
188
189#ifndef FIPS_MODULE
190 /* Whether this provider is the child of some other provider */
191 const OSSL_CORE_HANDLE *handle;
192 unsigned int ischild:1;
193#endif
194
195 /* Provider side data */
196 void *provctx;
197 const OSSL_DISPATCH *dispatch;
198};
199DEFINE_STACK_OF(OSSL_PROVIDER)
200
201static int ossl_provider_cmp(const OSSL_PROVIDER * const *a,
202 const OSSL_PROVIDER * const *b)
203{
204 return strcmp((*a)->name, (*b)->name);
205}
206
207/*-
208 * Provider Object store
209 * =====================
210 *
211 * The Provider Object store is a library context object, and therefore needs
212 * an index.
213 */
214
215struct provider_store_st {
216 OSSL_LIB_CTX *libctx;
217 STACK_OF(OSSL_PROVIDER) *providers;
218 STACK_OF(OSSL_PROVIDER_CHILD_CB) *child_cbs;
219 CRYPTO_RWLOCK *default_path_lock;
220 CRYPTO_RWLOCK *lock;
221 char *default_path;
222 OSSL_PROVIDER_INFO *provinfo;
223 size_t numprovinfo;
224 size_t provinfosz;
225 unsigned int use_fallbacks:1;
226 unsigned int freeing:1;
227};
228
229/*
230 * provider_deactivate_free() is a wrapper around ossl_provider_deactivate()
231 * and ossl_provider_free(), called as needed.
232 * Since this is only called when the provider store is being emptied, we
233 * don't need to care about any lock.
234 */
235static void provider_deactivate_free(OSSL_PROVIDER *prov)
236{
237 if (prov->flag_activated)
238 ossl_provider_deactivate(prov, 1);
239 ossl_provider_free(prov);
240}
241
242#ifndef FIPS_MODULE
243static void ossl_provider_child_cb_free(OSSL_PROVIDER_CHILD_CB *cb)
244{
245 OPENSSL_free(cb);
246}
247#endif
248
249static void infopair_free(INFOPAIR *pair)
250{
251 OPENSSL_free(pair->name);
252 OPENSSL_free(pair->value);
253 OPENSSL_free(pair);
254}
255
256static INFOPAIR *infopair_copy(const INFOPAIR *src)
257{
258 INFOPAIR *dest = OPENSSL_zalloc(sizeof(*dest));
259
260 if (dest == NULL)
261 return NULL;
262 if (src->name != NULL) {
263 dest->name = OPENSSL_strdup(src->name);
264 if (dest->name == NULL)
265 goto err;
266 }
267 if (src->value != NULL) {
268 dest->value = OPENSSL_strdup(src->value);
269 if (dest->value == NULL)
270 goto err;
271 }
272 return dest;
273 err:
274 OPENSSL_free(dest->name);
275 OPENSSL_free(dest);
276 return NULL;
277}
278
279void ossl_provider_info_clear(OSSL_PROVIDER_INFO *info)
280{
281 OPENSSL_free(info->name);
282 OPENSSL_free(info->path);
283 sk_INFOPAIR_pop_free(info->parameters, infopair_free);
284}
285
286void ossl_provider_store_free(void *vstore)
287{
288 struct provider_store_st *store = vstore;
289 size_t i;
290
291 if (store == NULL)
292 return;
293 store->freeing = 1;
294 OPENSSL_free(store->default_path);
295 sk_OSSL_PROVIDER_pop_free(store->providers, provider_deactivate_free);
296#ifndef FIPS_MODULE
297 sk_OSSL_PROVIDER_CHILD_CB_pop_free(store->child_cbs,
298 ossl_provider_child_cb_free);
299#endif
300 CRYPTO_THREAD_lock_free(store->default_path_lock);
301 CRYPTO_THREAD_lock_free(store->lock);
302 for (i = 0; i < store->numprovinfo; i++)
303 ossl_provider_info_clear(&store->provinfo[i]);
304 OPENSSL_free(store->provinfo);
305 OPENSSL_free(store);
306}
307
308void *ossl_provider_store_new(OSSL_LIB_CTX *ctx)
309{
310 struct provider_store_st *store = OPENSSL_zalloc(sizeof(*store));
311
312 if (store == NULL
313 || (store->providers = sk_OSSL_PROVIDER_new(ossl_provider_cmp)) == NULL
314 || (store->default_path_lock = CRYPTO_THREAD_lock_new()) == NULL
315#ifndef FIPS_MODULE
316 || (store->child_cbs = sk_OSSL_PROVIDER_CHILD_CB_new_null()) == NULL
317#endif
318 || (store->lock = CRYPTO_THREAD_lock_new()) == NULL) {
319 ossl_provider_store_free(store);
320 return NULL;
321 }
322 store->libctx = ctx;
323 store->use_fallbacks = 1;
324
325 return store;
326}
327
328static struct provider_store_st *get_provider_store(OSSL_LIB_CTX *libctx)
329{
330 struct provider_store_st *store = NULL;
331
332 store = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_PROVIDER_STORE_INDEX);
333 if (store == NULL)
334 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
335 return store;
336}
337
338int ossl_provider_disable_fallback_loading(OSSL_LIB_CTX *libctx)
339{
340 struct provider_store_st *store;
341
342 if ((store = get_provider_store(libctx)) != NULL) {
343 if (!CRYPTO_THREAD_write_lock(store->lock))
344 return 0;
345 store->use_fallbacks = 0;
346 CRYPTO_THREAD_unlock(store->lock);
347 return 1;
348 }
349 return 0;
350}
351
352#define BUILTINS_BLOCK_SIZE 10
353
354int ossl_provider_info_add_to_store(OSSL_LIB_CTX *libctx,
355 OSSL_PROVIDER_INFO *entry)
356{
357 struct provider_store_st *store = get_provider_store(libctx);
358 int ret = 0;
359
360 if (entry->name == NULL) {
361 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
362 return 0;
363 }
364
365 if (store == NULL) {
366 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
367 return 0;
368 }
369
370 if (!CRYPTO_THREAD_write_lock(store->lock))
371 return 0;
372 if (store->provinfosz == 0) {
373 store->provinfo = OPENSSL_zalloc(sizeof(*store->provinfo)
374 * BUILTINS_BLOCK_SIZE);
375 if (store->provinfo == NULL) {
376 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
377 goto err;
378 }
379 store->provinfosz = BUILTINS_BLOCK_SIZE;
380 } else if (store->numprovinfo == store->provinfosz) {
381 OSSL_PROVIDER_INFO *tmpbuiltins;
382 size_t newsz = store->provinfosz + BUILTINS_BLOCK_SIZE;
383
384 tmpbuiltins = OPENSSL_realloc(store->provinfo,
385 sizeof(*store->provinfo) * newsz);
386 if (tmpbuiltins == NULL) {
387 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
388 goto err;
389 }
390 store->provinfo = tmpbuiltins;
391 store->provinfosz = newsz;
392 }
393 store->provinfo[store->numprovinfo] = *entry;
394 store->numprovinfo++;
395
396 ret = 1;
397 err:
398 CRYPTO_THREAD_unlock(store->lock);
399 return ret;
400}
401
402OSSL_PROVIDER *ossl_provider_find(OSSL_LIB_CTX *libctx, const char *name,
403 ossl_unused int noconfig)
404{
405 struct provider_store_st *store = NULL;
406 OSSL_PROVIDER *prov = NULL;
407
408 if ((store = get_provider_store(libctx)) != NULL) {
409 OSSL_PROVIDER tmpl = { 0, };
410 int i;
411
412#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_AUTOLOAD_CONFIG)
413 /*
414 * Make sure any providers are loaded from config before we try to find
415 * them.
416 */
417 if (!noconfig) {
418 if (ossl_lib_ctx_is_default(libctx))
419 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
420 }
421#endif
422
423 tmpl.name = (char *)name;
424 /*
425 * A "find" operation can sort the stack, and therefore a write lock is
426 * required.
427 */
428 if (!CRYPTO_THREAD_write_lock(store->lock))
429 return NULL;
430 if ((i = sk_OSSL_PROVIDER_find(store->providers, &tmpl)) != -1)
431 prov = sk_OSSL_PROVIDER_value(store->providers, i);
432 CRYPTO_THREAD_unlock(store->lock);
433 if (prov != NULL && !ossl_provider_up_ref(prov))
434 prov = NULL;
435 }
436
437 return prov;
438}
439
440/*-
441 * Provider Object methods
442 * =======================
443 */
444
445static OSSL_PROVIDER *provider_new(const char *name,
446 OSSL_provider_init_fn *init_function,
447 STACK_OF(INFOPAIR) *parameters)
448{
449 OSSL_PROVIDER *prov = NULL;
450
451 if ((prov = OPENSSL_zalloc(sizeof(*prov))) == NULL
452#ifndef HAVE_ATOMICS
453 || (prov->refcnt_lock = CRYPTO_THREAD_lock_new()) == NULL
454#endif
455 ) {
456 OPENSSL_free(prov);
457 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
458 return NULL;
459 }
460
461 prov->refcnt = 1; /* 1 One reference to be returned */
462
463 if ((prov->opbits_lock = CRYPTO_THREAD_lock_new()) == NULL
464 || (prov->flag_lock = CRYPTO_THREAD_lock_new()) == NULL
465 || (prov->name = OPENSSL_strdup(name)) == NULL
466 || (prov->parameters = sk_INFOPAIR_deep_copy(parameters,
467 infopair_copy,
468 infopair_free)) == NULL) {
469 ossl_provider_free(prov);
470 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
471 return NULL;
472 }
473
474 prov->init_function = init_function;
475
476 return prov;
477}
478
479int ossl_provider_up_ref(OSSL_PROVIDER *prov)
480{
481 int ref = 0;
482
483 if (CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock) <= 0)
484 return 0;
485
486#ifndef FIPS_MODULE
487 if (prov->ischild) {
488 if (!ossl_provider_up_ref_parent(prov, 0)) {
489 ossl_provider_free(prov);
490 return 0;
491 }
492 }
493#endif
494
495 return ref;
496}
497
498#ifndef FIPS_MODULE
499static int provider_up_ref_intern(OSSL_PROVIDER *prov, int activate)
500{
501 if (activate)
502 return ossl_provider_activate(prov, 1, 0);
503
504 return ossl_provider_up_ref(prov);
505}
506
507static int provider_free_intern(OSSL_PROVIDER *prov, int deactivate)
508{
509 if (deactivate)
510 return ossl_provider_deactivate(prov, 1);
511
512 ossl_provider_free(prov);
513 return 1;
514}
515#endif
516
517/*
518 * We assume that the requested provider does not already exist in the store.
519 * The caller should check. If it does exist then adding it to the store later
520 * will fail.
521 */
522OSSL_PROVIDER *ossl_provider_new(OSSL_LIB_CTX *libctx, const char *name,
523 OSSL_provider_init_fn *init_function,
524 int noconfig)
525{
526 struct provider_store_st *store = NULL;
527 OSSL_PROVIDER_INFO template;
528 OSSL_PROVIDER *prov = NULL;
529
530 if ((store = get_provider_store(libctx)) == NULL)
531 return NULL;
532
533 memset(&template, 0, sizeof(template));
534 if (init_function == NULL) {
535 const OSSL_PROVIDER_INFO *p;
536 size_t i;
537
538 /* Check if this is a predefined builtin provider */
539 for (p = ossl_predefined_providers; p->name != NULL; p++) {
540 if (strcmp(p->name, name) == 0) {
541 template = *p;
542 break;
543 }
544 }
545 if (p->name == NULL) {
546 /* Check if this is a user added builtin provider */
547 if (!CRYPTO_THREAD_read_lock(store->lock))
548 return NULL;
549 for (i = 0, p = store->provinfo; i < store->numprovinfo; p++, i++) {
550 if (strcmp(p->name, name) == 0) {
551 template = *p;
552 break;
553 }
554 }
555 CRYPTO_THREAD_unlock(store->lock);
556 }
557 } else {
558 template.init = init_function;
559 }
560
561 /* provider_new() generates an error, so no need here */
562 if ((prov = provider_new(name, template.init, template.parameters)) == NULL)
563 return NULL;
564
565 prov->libctx = libctx;
566#ifndef FIPS_MODULE
567 prov->error_lib = ERR_get_next_error_library();
568#endif
569
570 /*
571 * At this point, the provider is only partially "loaded". To be
572 * fully "loaded", ossl_provider_activate() must also be called and it must
573 * then be added to the provider store.
574 */
575
576 return prov;
577}
578
579/* Assumes that the store lock is held */
580static int create_provider_children(OSSL_PROVIDER *prov)
581{
582 int ret = 1;
583#ifndef FIPS_MODULE
584 struct provider_store_st *store = prov->store;
585 OSSL_PROVIDER_CHILD_CB *child_cb;
586 int i, max;
587
588 max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
589 for (i = 0; i < max; i++) {
590 /*
591 * This is newly activated (activatecnt == 1), so we need to
592 * create child providers as necessary.
593 */
594 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
595 ret &= child_cb->create_cb((OSSL_CORE_HANDLE *)prov, child_cb->cbdata);
596 }
597#endif
598
599 return ret;
600}
601
602int ossl_provider_add_to_store(OSSL_PROVIDER *prov, OSSL_PROVIDER **actualprov,
603 int retain_fallbacks)
604{
605 struct provider_store_st *store;
606 int idx;
607 OSSL_PROVIDER tmpl = { 0, };
608 OSSL_PROVIDER *actualtmp = NULL;
609
610 if (actualprov != NULL)
611 *actualprov = NULL;
612
613 if ((store = get_provider_store(prov->libctx)) == NULL)
614 return 0;
615
616 if (!CRYPTO_THREAD_write_lock(store->lock))
617 return 0;
618
619 tmpl.name = (char *)prov->name;
620 idx = sk_OSSL_PROVIDER_find(store->providers, &tmpl);
621 if (idx == -1)
622 actualtmp = prov;
623 else
624 actualtmp = sk_OSSL_PROVIDER_value(store->providers, idx);
625
626 if (idx == -1) {
627 if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0)
628 goto err;
629 prov->store = store;
630 if (!create_provider_children(prov)) {
631 sk_OSSL_PROVIDER_delete_ptr(store->providers, prov);
632 goto err;
633 }
634 if (!retain_fallbacks)
635 store->use_fallbacks = 0;
636 }
637
638 CRYPTO_THREAD_unlock(store->lock);
639
640 if (actualprov != NULL) {
641 if (!ossl_provider_up_ref(actualtmp)) {
642 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
643 actualtmp = NULL;
644 return 0;
645 }
646 *actualprov = actualtmp;
647 }
648
649 if (idx >= 0) {
650 /*
651 * The provider is already in the store. Probably two threads
652 * independently initialised their own provider objects with the same
653 * name and raced to put them in the store. This thread lost. We
654 * deactivate the one we just created and use the one that already
655 * exists instead.
656 * If we get here then we know we did not create provider children
657 * above, so we inform ossl_provider_deactivate not to attempt to remove
658 * any.
659 */
660 ossl_provider_deactivate(prov, 0);
661 ossl_provider_free(prov);
662 }
663
664 return 1;
665
666 err:
667 CRYPTO_THREAD_unlock(store->lock);
668 return 0;
669}
670
671void ossl_provider_free(OSSL_PROVIDER *prov)
672{
673 if (prov != NULL) {
674 int ref = 0;
675
676 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
677
678 /*
679 * When the refcount drops to zero, we clean up the provider.
680 * Note that this also does teardown, which may seem late,
681 * considering that init happens on first activation. However,
682 * there may be other structures hanging on to the provider after
683 * the last deactivation and may therefore need full access to the
684 * provider's services. Therefore, we deinit late.
685 */
686 if (ref == 0) {
687 if (prov->flag_initialized) {
688 ossl_provider_teardown(prov);
689#ifndef OPENSSL_NO_ERR
690# ifndef FIPS_MODULE
691 if (prov->error_strings != NULL) {
692 ERR_unload_strings(prov->error_lib, prov->error_strings);
693 OPENSSL_free(prov->error_strings);
694 prov->error_strings = NULL;
695 }
696# endif
697#endif
698 OPENSSL_free(prov->operation_bits);
699 prov->operation_bits = NULL;
700 prov->operation_bits_sz = 0;
701 prov->flag_initialized = 0;
702 }
703
704#ifndef FIPS_MODULE
705 /*
706 * We deregister thread handling whether or not the provider was
707 * initialized. If init was attempted but was not successful then
708 * the provider may still have registered a thread handler.
709 */
710 ossl_init_thread_deregister(prov);
711 DSO_free(prov->module);
712#endif
713 OPENSSL_free(prov->name);
714 OPENSSL_free(prov->path);
715 sk_INFOPAIR_pop_free(prov->parameters, infopair_free);
716 CRYPTO_THREAD_lock_free(prov->opbits_lock);
717 CRYPTO_THREAD_lock_free(prov->flag_lock);
718#ifndef HAVE_ATOMICS
719 CRYPTO_THREAD_lock_free(prov->refcnt_lock);
720#endif
721 OPENSSL_free(prov);
722 }
723#ifndef FIPS_MODULE
724 else if (prov->ischild) {
725 ossl_provider_free_parent(prov, 0);
726 }
727#endif
728 }
729}
730
731/* Setters */
732int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *module_path)
733{
734 OPENSSL_free(prov->path);
735 prov->path = NULL;
736 if (module_path == NULL)
737 return 1;
738 if ((prov->path = OPENSSL_strdup(module_path)) != NULL)
739 return 1;
740 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
741 return 0;
742}
743
744static int infopair_add(STACK_OF(INFOPAIR) **infopairsk, const char *name,
745 const char *value)
746{
747 INFOPAIR *pair = NULL;
748
749 if ((pair = OPENSSL_zalloc(sizeof(*pair))) != NULL
750 && (*infopairsk != NULL
751 || (*infopairsk = sk_INFOPAIR_new_null()) != NULL)
752 && (pair->name = OPENSSL_strdup(name)) != NULL
753 && (pair->value = OPENSSL_strdup(value)) != NULL
754 && sk_INFOPAIR_push(*infopairsk, pair) > 0)
755 return 1;
756
757 if (pair != NULL) {
758 OPENSSL_free(pair->name);
759 OPENSSL_free(pair->value);
760 OPENSSL_free(pair);
761 }
762 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
763 return 0;
764}
765
766int ossl_provider_add_parameter(OSSL_PROVIDER *prov,
767 const char *name, const char *value)
768{
769 return infopair_add(&prov->parameters, name, value);
770}
771
772int ossl_provider_info_add_parameter(OSSL_PROVIDER_INFO *provinfo,
773 const char *name,
774 const char *value)
775{
776 return infopair_add(&provinfo->parameters, name, value);
777}
778
779/*
780 * Provider activation.
781 *
782 * What "activation" means depends on the provider form; for built in
783 * providers (in the library or the application alike), the provider
784 * can already be considered to be loaded, all that's needed is to
785 * initialize it. However, for dynamically loadable provider modules,
786 * we must first load that module.
787 *
788 * Built in modules are distinguished from dynamically loaded modules
789 * with an already assigned init function.
790 */
791static const OSSL_DISPATCH *core_dispatch; /* Define further down */
792
793int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *libctx,
794 const char *path)
795{
796 struct provider_store_st *store;
797 char *p = NULL;
798
799 if (path != NULL) {
800 p = OPENSSL_strdup(path);
801 if (p == NULL) {
802 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
803 return 0;
804 }
805 }
806 if ((store = get_provider_store(libctx)) != NULL
807 && CRYPTO_THREAD_write_lock(store->default_path_lock)) {
808 OPENSSL_free(store->default_path);
809 store->default_path = p;
810 CRYPTO_THREAD_unlock(store->default_path_lock);
811 return 1;
812 }
813 OPENSSL_free(p);
814 return 0;
815}
816
817/*
818 * Internal version that doesn't affect the store flags, and thereby avoid
819 * locking. Direct callers must remember to set the store flags when
820 * appropriate.
821 */
822static int provider_init(OSSL_PROVIDER *prov)
823{
824 const OSSL_DISPATCH *provider_dispatch = NULL;
825 void *tmp_provctx = NULL; /* safety measure */
826#ifndef OPENSSL_NO_ERR
827# ifndef FIPS_MODULE
828 OSSL_FUNC_provider_get_reason_strings_fn *p_get_reason_strings = NULL;
829# endif
830#endif
831 int ok = 0;
832
833 if (!ossl_assert(!prov->flag_initialized)) {
834 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
835 goto end;
836 }
837
838#ifndef VBOX /* Don't want loadable modules in our static build. */
839 /*
840 * If the init function isn't set, it indicates that this provider is
841 * a loadable module.
842 */
843 if (prov->init_function == NULL) {
844#ifdef FIPS_MODULE
845 goto end;
846#else
847 if (prov->module == NULL) {
848 char *allocated_path = NULL;
849 const char *module_path = NULL;
850 char *merged_path = NULL;
851 const char *load_dir = NULL;
852 char *allocated_load_dir = NULL;
853 struct provider_store_st *store;
854
855 if ((prov->module = DSO_new()) == NULL) {
856 /* DSO_new() generates an error already */
857 goto end;
858 }
859
860 if ((store = get_provider_store(prov->libctx)) == NULL
861 || !CRYPTO_THREAD_read_lock(store->default_path_lock))
862 goto end;
863
864 if (store->default_path != NULL) {
865 allocated_load_dir = OPENSSL_strdup(store->default_path);
866 CRYPTO_THREAD_unlock(store->default_path_lock);
867 if (allocated_load_dir == NULL) {
868 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
869 goto end;
870 }
871 load_dir = allocated_load_dir;
872 } else {
873 CRYPTO_THREAD_unlock(store->default_path_lock);
874 }
875
876 if (load_dir == NULL) {
877 load_dir = ossl_safe_getenv("OPENSSL_MODULES");
878 if (load_dir == NULL)
879 load_dir = MODULESDIR;
880 }
881
882 DSO_ctrl(prov->module, DSO_CTRL_SET_FLAGS,
883 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY, NULL);
884
885 module_path = prov->path;
886 if (module_path == NULL)
887 module_path = allocated_path =
888 DSO_convert_filename(prov->module, prov->name);
889 if (module_path != NULL)
890 merged_path = DSO_merge(prov->module, module_path, load_dir);
891
892 if (merged_path == NULL
893 || (DSO_load(prov->module, merged_path, NULL, 0)) == NULL) {
894 DSO_free(prov->module);
895 prov->module = NULL;
896 }
897
898 OPENSSL_free(merged_path);
899 OPENSSL_free(allocated_path);
900 OPENSSL_free(allocated_load_dir);
901 }
902
903 if (prov->module == NULL) {
904 /* DSO has already recorded errors, this is just a tracepoint */
905 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_DSO_LIB,
906 "name=%s", prov->name);
907 goto end;
908 }
909
910 prov->init_function = (OSSL_provider_init_fn *)
911 DSO_bind_func(prov->module, "OSSL_provider_init");
912#endif
913 }
914#endif /* VBOX */
915
916 /* Check for and call the initialise function for the provider. */
917 if (prov->init_function == NULL) {
918 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_UNSUPPORTED,
919 "name=%s, provider has no provider init function",
920 prov->name);
921 goto end;
922 }
923
924 if (!prov->init_function((OSSL_CORE_HANDLE *)prov, core_dispatch,
925 &provider_dispatch, &tmp_provctx)) {
926 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INIT_FAIL,
927 "name=%s", prov->name);
928 goto end;
929 }
930 prov->provctx = tmp_provctx;
931 prov->dispatch = provider_dispatch;
932
933 if (provider_dispatch != NULL) {
934 for (; provider_dispatch->function_id != 0; provider_dispatch++) {
935 switch (provider_dispatch->function_id) {
936 case OSSL_FUNC_PROVIDER_TEARDOWN:
937 prov->teardown =
938 OSSL_FUNC_provider_teardown(provider_dispatch);
939 break;
940 case OSSL_FUNC_PROVIDER_GETTABLE_PARAMS:
941 prov->gettable_params =
942 OSSL_FUNC_provider_gettable_params(provider_dispatch);
943 break;
944 case OSSL_FUNC_PROVIDER_GET_PARAMS:
945 prov->get_params =
946 OSSL_FUNC_provider_get_params(provider_dispatch);
947 break;
948 case OSSL_FUNC_PROVIDER_SELF_TEST:
949 prov->self_test =
950 OSSL_FUNC_provider_self_test(provider_dispatch);
951 break;
952 case OSSL_FUNC_PROVIDER_GET_CAPABILITIES:
953 prov->get_capabilities =
954 OSSL_FUNC_provider_get_capabilities(provider_dispatch);
955 break;
956 case OSSL_FUNC_PROVIDER_QUERY_OPERATION:
957 prov->query_operation =
958 OSSL_FUNC_provider_query_operation(provider_dispatch);
959 break;
960 case OSSL_FUNC_PROVIDER_UNQUERY_OPERATION:
961 prov->unquery_operation =
962 OSSL_FUNC_provider_unquery_operation(provider_dispatch);
963 break;
964#ifndef OPENSSL_NO_ERR
965# ifndef FIPS_MODULE
966 case OSSL_FUNC_PROVIDER_GET_REASON_STRINGS:
967 p_get_reason_strings =
968 OSSL_FUNC_provider_get_reason_strings(provider_dispatch);
969 break;
970# endif
971#endif
972 }
973 }
974 }
975
976#ifndef OPENSSL_NO_ERR
977# ifndef FIPS_MODULE
978 if (p_get_reason_strings != NULL) {
979 const OSSL_ITEM *reasonstrings = p_get_reason_strings(prov->provctx);
980 size_t cnt, cnt2;
981
982 /*
983 * ERR_load_strings() handles ERR_STRING_DATA rather than OSSL_ITEM,
984 * although they are essentially the same type.
985 * Furthermore, ERR_load_strings() patches the array's error number
986 * with the error library number, so we need to make a copy of that
987 * array either way.
988 */
989 cnt = 0;
990 while (reasonstrings[cnt].id != 0) {
991 if (ERR_GET_LIB(reasonstrings[cnt].id) != 0)
992 goto end;
993 cnt++;
994 }
995 cnt++; /* One for the terminating item */
996
997 /* Allocate one extra item for the "library" name */
998 prov->error_strings =
999 OPENSSL_zalloc(sizeof(ERR_STRING_DATA) * (cnt + 1));
1000 if (prov->error_strings == NULL)
1001 goto end;
1002
1003 /*
1004 * Set the "library" name.
1005 */
1006 prov->error_strings[0].error = ERR_PACK(prov->error_lib, 0, 0);
1007 prov->error_strings[0].string = prov->name;
1008 /*
1009 * Copy reasonstrings item 0..cnt-1 to prov->error_trings positions
1010 * 1..cnt.
1011 */
1012 for (cnt2 = 1; cnt2 <= cnt; cnt2++) {
1013 prov->error_strings[cnt2].error = (int)reasonstrings[cnt2-1].id;
1014 prov->error_strings[cnt2].string = reasonstrings[cnt2-1].ptr;
1015 }
1016
1017 ERR_load_strings(prov->error_lib, prov->error_strings);
1018 }
1019# endif
1020#endif
1021
1022 /* With this flag set, this provider has become fully "loaded". */
1023 prov->flag_initialized = 1;
1024 ok = 1;
1025
1026 end:
1027 return ok;
1028}
1029
1030/*
1031 * Deactivate a provider. If upcalls is 0 then we suppress any upcalls to a
1032 * parent provider. If removechildren is 0 then we suppress any calls to remove
1033 * child providers.
1034 * Return -1 on failure and the activation count on success
1035 */
1036static int provider_deactivate(OSSL_PROVIDER *prov, int upcalls,
1037 int removechildren)
1038{
1039 int count;
1040 struct provider_store_st *store;
1041#ifndef FIPS_MODULE
1042 int freeparent = 0;
1043#endif
1044 int lock = 1;
1045
1046 if (!ossl_assert(prov != NULL))
1047 return -1;
1048
1049 /*
1050 * No need to lock if we've got no store because we've not been shared with
1051 * other threads.
1052 */
1053 store = get_provider_store(prov->libctx);
1054 if (store == NULL)
1055 lock = 0;
1056
1057 if (lock && !CRYPTO_THREAD_read_lock(store->lock))
1058 return -1;
1059 if (lock && !CRYPTO_THREAD_write_lock(prov->flag_lock)) {
1060 CRYPTO_THREAD_unlock(store->lock);
1061 return -1;
1062 }
1063
1064#ifndef FIPS_MODULE
1065 if (prov->activatecnt >= 2 && prov->ischild && upcalls) {
1066 /*
1067 * We have had a direct activation in this child libctx so we need to
1068 * now down the ref count in the parent provider. We do the actual down
1069 * ref outside of the flag_lock, since it could involve getting other
1070 * locks.
1071 */
1072 freeparent = 1;
1073 }
1074#endif
1075
1076 if ((count = --prov->activatecnt) < 1)
1077 prov->flag_activated = 0;
1078#ifndef FIPS_MODULE
1079 else
1080 removechildren = 0;
1081#endif
1082
1083#ifndef FIPS_MODULE
1084 if (removechildren && store != NULL) {
1085 int i, max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
1086 OSSL_PROVIDER_CHILD_CB *child_cb;
1087
1088 for (i = 0; i < max; i++) {
1089 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
1090 child_cb->remove_cb((OSSL_CORE_HANDLE *)prov, child_cb->cbdata);
1091 }
1092 }
1093#endif
1094 if (lock) {
1095 CRYPTO_THREAD_unlock(prov->flag_lock);
1096 CRYPTO_THREAD_unlock(store->lock);
1097 }
1098#ifndef FIPS_MODULE
1099 if (freeparent)
1100 ossl_provider_free_parent(prov, 1);
1101#endif
1102
1103 /* We don't deinit here, that's done in ossl_provider_free() */
1104 return count;
1105}
1106
1107/*
1108 * Activate a provider.
1109 * Return -1 on failure and the activation count on success
1110 */
1111static int provider_activate(OSSL_PROVIDER *prov, int lock, int upcalls)
1112{
1113 int count = -1;
1114 struct provider_store_st *store;
1115 int ret = 1;
1116
1117 store = prov->store;
1118 /*
1119 * If the provider hasn't been added to the store, then we don't need
1120 * any locks because we've not shared it with other threads.
1121 */
1122 if (store == NULL) {
1123 lock = 0;
1124 if (!provider_init(prov))
1125 return -1;
1126 }
1127
1128#ifndef FIPS_MODULE
1129 if (prov->ischild && upcalls && !ossl_provider_up_ref_parent(prov, 1))
1130 return -1;
1131#endif
1132
1133 if (lock && !CRYPTO_THREAD_read_lock(store->lock)) {
1134#ifndef FIPS_MODULE
1135 if (prov->ischild && upcalls)
1136 ossl_provider_free_parent(prov, 1);
1137#endif
1138 return -1;
1139 }
1140
1141 if (lock && !CRYPTO_THREAD_write_lock(prov->flag_lock)) {
1142 CRYPTO_THREAD_unlock(store->lock);
1143#ifndef FIPS_MODULE
1144 if (prov->ischild && upcalls)
1145 ossl_provider_free_parent(prov, 1);
1146#endif
1147 return -1;
1148 }
1149
1150 count = ++prov->activatecnt;
1151 prov->flag_activated = 1;
1152
1153 if (prov->activatecnt == 1 && store != NULL) {
1154 ret = create_provider_children(prov);
1155 }
1156 if (lock) {
1157 CRYPTO_THREAD_unlock(prov->flag_lock);
1158 CRYPTO_THREAD_unlock(store->lock);
1159 }
1160
1161 if (!ret)
1162 return -1;
1163
1164 return count;
1165}
1166
1167static int provider_flush_store_cache(const OSSL_PROVIDER *prov)
1168{
1169 struct provider_store_st *store;
1170 int freeing;
1171
1172 if ((store = get_provider_store(prov->libctx)) == NULL)
1173 return 0;
1174
1175 if (!CRYPTO_THREAD_read_lock(store->lock))
1176 return 0;
1177 freeing = store->freeing;
1178 CRYPTO_THREAD_unlock(store->lock);
1179
1180 if (!freeing) {
1181 int acc
1182 = evp_method_store_cache_flush(prov->libctx)
1183#ifndef FIPS_MODULE
1184 + ossl_encoder_store_cache_flush(prov->libctx)
1185 + ossl_decoder_store_cache_flush(prov->libctx)
1186 + ossl_store_loader_store_cache_flush(prov->libctx)
1187#endif
1188 ;
1189
1190#ifndef FIPS_MODULE
1191 return acc == 4;
1192#else
1193 return acc == 1;
1194#endif
1195 }
1196 return 1;
1197}
1198
1199static int provider_remove_store_methods(OSSL_PROVIDER *prov)
1200{
1201 struct provider_store_st *store;
1202 int freeing;
1203
1204 if ((store = get_provider_store(prov->libctx)) == NULL)
1205 return 0;
1206
1207 if (!CRYPTO_THREAD_read_lock(store->lock))
1208 return 0;
1209 freeing = store->freeing;
1210 CRYPTO_THREAD_unlock(store->lock);
1211
1212 if (!freeing) {
1213 int acc;
1214
1215 if (!CRYPTO_THREAD_write_lock(prov->opbits_lock))
1216 return 0;
1217 OPENSSL_free(prov->operation_bits);
1218 prov->operation_bits = NULL;
1219 prov->operation_bits_sz = 0;
1220 CRYPTO_THREAD_unlock(prov->opbits_lock);
1221
1222 acc = evp_method_store_remove_all_provided(prov)
1223#ifndef FIPS_MODULE
1224 + ossl_encoder_store_remove_all_provided(prov)
1225 + ossl_decoder_store_remove_all_provided(prov)
1226 + ossl_store_loader_store_remove_all_provided(prov)
1227#endif
1228 ;
1229
1230#ifndef FIPS_MODULE
1231 return acc == 4;
1232#else
1233 return acc == 1;
1234#endif
1235 }
1236 return 1;
1237}
1238
1239int ossl_provider_activate(OSSL_PROVIDER *prov, int upcalls, int aschild)
1240{
1241 int count;
1242
1243 if (prov == NULL)
1244 return 0;
1245#ifndef FIPS_MODULE
1246 /*
1247 * If aschild is true, then we only actually do the activation if the
1248 * provider is a child. If its not, this is still success.
1249 */
1250 if (aschild && !prov->ischild)
1251 return 1;
1252#endif
1253 if ((count = provider_activate(prov, 1, upcalls)) > 0)
1254 return count == 1 ? provider_flush_store_cache(prov) : 1;
1255
1256 return 0;
1257}
1258
1259int ossl_provider_deactivate(OSSL_PROVIDER *prov, int removechildren)
1260{
1261 int count;
1262
1263 if (prov == NULL
1264 || (count = provider_deactivate(prov, 1, removechildren)) < 0)
1265 return 0;
1266 return count == 0 ? provider_remove_store_methods(prov) : 1;
1267}
1268
1269void *ossl_provider_ctx(const OSSL_PROVIDER *prov)
1270{
1271 return prov != NULL ? prov->provctx : NULL;
1272}
1273
1274/*
1275 * This function only does something once when store->use_fallbacks == 1,
1276 * and then sets store->use_fallbacks = 0, so the second call and so on is
1277 * effectively a no-op.
1278 */
1279static int provider_activate_fallbacks(struct provider_store_st *store)
1280{
1281 int use_fallbacks;
1282 int activated_fallback_count = 0;
1283 int ret = 0;
1284 const OSSL_PROVIDER_INFO *p;
1285
1286 if (!CRYPTO_THREAD_read_lock(store->lock))
1287 return 0;
1288 use_fallbacks = store->use_fallbacks;
1289 CRYPTO_THREAD_unlock(store->lock);
1290 if (!use_fallbacks)
1291 return 1;
1292
1293 if (!CRYPTO_THREAD_write_lock(store->lock))
1294 return 0;
1295 /* Check again, just in case another thread changed it */
1296 use_fallbacks = store->use_fallbacks;
1297 if (!use_fallbacks) {
1298 CRYPTO_THREAD_unlock(store->lock);
1299 return 1;
1300 }
1301
1302 for (p = ossl_predefined_providers; p->name != NULL; p++) {
1303 OSSL_PROVIDER *prov = NULL;
1304
1305 if (!p->is_fallback)
1306 continue;
1307 /*
1308 * We use the internal constructor directly here,
1309 * otherwise we get a call loop
1310 */
1311 prov = provider_new(p->name, p->init, NULL);
1312 if (prov == NULL)
1313 goto err;
1314 prov->libctx = store->libctx;
1315#ifndef FIPS_MODULE
1316 prov->error_lib = ERR_get_next_error_library();
1317#endif
1318
1319 /*
1320 * We are calling provider_activate while holding the store lock. This
1321 * means the init function will be called while holding a lock. Normally
1322 * we try to avoid calling a user callback while holding a lock.
1323 * However, fallbacks are never third party providers so we accept this.
1324 */
1325 if (provider_activate(prov, 0, 0) < 0) {
1326 ossl_provider_free(prov);
1327 goto err;
1328 }
1329 prov->store = store;
1330 if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
1331 ossl_provider_free(prov);
1332 goto err;
1333 }
1334 activated_fallback_count++;
1335 }
1336
1337 if (activated_fallback_count > 0) {
1338 store->use_fallbacks = 0;
1339 ret = 1;
1340 }
1341 err:
1342 CRYPTO_THREAD_unlock(store->lock);
1343 return ret;
1344}
1345
1346int ossl_provider_doall_activated(OSSL_LIB_CTX *ctx,
1347 int (*cb)(OSSL_PROVIDER *provider,
1348 void *cbdata),
1349 void *cbdata)
1350{
1351 int ret = 0, curr, max, ref = 0;
1352 struct provider_store_st *store = get_provider_store(ctx);
1353 STACK_OF(OSSL_PROVIDER) *provs = NULL;
1354
1355#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_AUTOLOAD_CONFIG)
1356 /*
1357 * Make sure any providers are loaded from config before we try to use
1358 * them.
1359 */
1360 if (ossl_lib_ctx_is_default(ctx))
1361 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
1362#endif
1363
1364 if (store == NULL)
1365 return 1;
1366 if (!provider_activate_fallbacks(store))
1367 return 0;
1368
1369 /*
1370 * Under lock, grab a copy of the provider list and up_ref each
1371 * provider so that they don't disappear underneath us.
1372 */
1373 if (!CRYPTO_THREAD_read_lock(store->lock))
1374 return 0;
1375 provs = sk_OSSL_PROVIDER_dup(store->providers);
1376 if (provs == NULL) {
1377 CRYPTO_THREAD_unlock(store->lock);
1378 return 0;
1379 }
1380 max = sk_OSSL_PROVIDER_num(provs);
1381 /*
1382 * We work backwards through the stack so that we can safely delete items
1383 * as we go.
1384 */
1385 for (curr = max - 1; curr >= 0; curr--) {
1386 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
1387
1388 if (!CRYPTO_THREAD_write_lock(prov->flag_lock))
1389 goto err_unlock;
1390 if (prov->flag_activated) {
1391 /*
1392 * We call CRYPTO_UP_REF directly rather than ossl_provider_up_ref
1393 * to avoid upping the ref count on the parent provider, which we
1394 * must not do while holding locks.
1395 */
1396 if (CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock) <= 0) {
1397 CRYPTO_THREAD_unlock(prov->flag_lock);
1398 goto err_unlock;
1399 }
1400 /*
1401 * It's already activated, but we up the activated count to ensure
1402 * it remains activated until after we've called the user callback.
1403 * We do this with no locking (because we already hold the locks)
1404 * and no upcalls (which must not be called when locks are held). In
1405 * theory this could mean the parent provider goes inactive, whilst
1406 * still activated in the child for a short period. That's ok.
1407 */
1408 if (provider_activate(prov, 0, 0) < 0) {
1409 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
1410 CRYPTO_THREAD_unlock(prov->flag_lock);
1411 goto err_unlock;
1412 }
1413 } else {
1414 sk_OSSL_PROVIDER_delete(provs, curr);
1415 max--;
1416 }
1417 CRYPTO_THREAD_unlock(prov->flag_lock);
1418 }
1419 CRYPTO_THREAD_unlock(store->lock);
1420
1421 /*
1422 * Now, we sweep through all providers not under lock
1423 */
1424 for (curr = 0; curr < max; curr++) {
1425 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
1426
1427 if (!cb(prov, cbdata)) {
1428 curr = -1;
1429 goto finish;
1430 }
1431 }
1432 curr = -1;
1433
1434 ret = 1;
1435 goto finish;
1436
1437 err_unlock:
1438 CRYPTO_THREAD_unlock(store->lock);
1439 finish:
1440 /*
1441 * The pop_free call doesn't do what we want on an error condition. We
1442 * either start from the first item in the stack, or part way through if
1443 * we only processed some of the items.
1444 */
1445 for (curr++; curr < max; curr++) {
1446 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
1447
1448 provider_deactivate(prov, 0, 1);
1449 /*
1450 * As above where we did the up-ref, we don't call ossl_provider_free
1451 * to avoid making upcalls. There should always be at least one ref
1452 * to the provider in the store, so this should never drop to 0.
1453 */
1454 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
1455 /*
1456 * Not much we can do if this assert ever fails. So we don't use
1457 * ossl_assert here.
1458 */
1459 assert(ref > 0);
1460 }
1461 sk_OSSL_PROVIDER_free(provs);
1462 return ret;
1463}
1464
1465int OSSL_PROVIDER_available(OSSL_LIB_CTX *libctx, const char *name)
1466{
1467 OSSL_PROVIDER *prov = NULL;
1468 int available = 0;
1469 struct provider_store_st *store = get_provider_store(libctx);
1470
1471 if (store == NULL || !provider_activate_fallbacks(store))
1472 return 0;
1473
1474 prov = ossl_provider_find(libctx, name, 0);
1475 if (prov != NULL) {
1476 if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
1477 return 0;
1478 available = prov->flag_activated;
1479 CRYPTO_THREAD_unlock(prov->flag_lock);
1480 ossl_provider_free(prov);
1481 }
1482 return available;
1483}
1484
1485/* Getters of Provider Object data */
1486const char *ossl_provider_name(const OSSL_PROVIDER *prov)
1487{
1488 return prov->name;
1489}
1490
1491const DSO *ossl_provider_dso(const OSSL_PROVIDER *prov)
1492{
1493 return prov->module;
1494}
1495
1496const char *ossl_provider_module_name(const OSSL_PROVIDER *prov)
1497{
1498#ifdef FIPS_MODULE
1499 return NULL;
1500#else
1501 return DSO_get_filename(prov->module);
1502#endif
1503}
1504
1505const char *ossl_provider_module_path(const OSSL_PROVIDER *prov)
1506{
1507#ifdef FIPS_MODULE
1508 return NULL;
1509#else
1510 /* FIXME: Ensure it's a full path */
1511 return DSO_get_filename(prov->module);
1512#endif
1513}
1514
1515void *ossl_provider_prov_ctx(const OSSL_PROVIDER *prov)
1516{
1517 if (prov != NULL)
1518 return prov->provctx;
1519
1520 return NULL;
1521}
1522
1523const OSSL_DISPATCH *ossl_provider_get0_dispatch(const OSSL_PROVIDER *prov)
1524{
1525 if (prov != NULL)
1526 return prov->dispatch;
1527
1528 return NULL;
1529}
1530
1531OSSL_LIB_CTX *ossl_provider_libctx(const OSSL_PROVIDER *prov)
1532{
1533 return prov != NULL ? prov->libctx : NULL;
1534}
1535
1536/* Wrappers around calls to the provider */
1537void ossl_provider_teardown(const OSSL_PROVIDER *prov)
1538{
1539 if (prov->teardown != NULL
1540#ifndef FIPS_MODULE
1541 && !prov->ischild
1542#endif
1543 )
1544 prov->teardown(prov->provctx);
1545}
1546
1547const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov)
1548{
1549 return prov->gettable_params == NULL
1550 ? NULL : prov->gettable_params(prov->provctx);
1551}
1552
1553int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
1554{
1555 return prov->get_params == NULL
1556 ? 0 : prov->get_params(prov->provctx, params);
1557}
1558
1559int ossl_provider_self_test(const OSSL_PROVIDER *prov)
1560{
1561 int ret;
1562
1563 if (prov->self_test == NULL)
1564 return 1;
1565 ret = prov->self_test(prov->provctx);
1566 if (ret == 0)
1567 (void)provider_remove_store_methods((OSSL_PROVIDER *)prov);
1568 return ret;
1569}
1570
1571int ossl_provider_get_capabilities(const OSSL_PROVIDER *prov,
1572 const char *capability,
1573 OSSL_CALLBACK *cb,
1574 void *arg)
1575{
1576 return prov->get_capabilities == NULL
1577 ? 1 : prov->get_capabilities(prov->provctx, capability, cb, arg);
1578}
1579
1580const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov,
1581 int operation_id,
1582 int *no_cache)
1583{
1584 const OSSL_ALGORITHM *res;
1585
1586 if (prov->query_operation == NULL)
1587 return NULL;
1588 res = prov->query_operation(prov->provctx, operation_id, no_cache);
1589#if defined(OPENSSL_NO_CACHED_FETCH)
1590 /* Forcing the non-caching of queries */
1591 if (no_cache != NULL)
1592 *no_cache = 1;
1593#endif
1594 return res;
1595}
1596
1597void ossl_provider_unquery_operation(const OSSL_PROVIDER *prov,
1598 int operation_id,
1599 const OSSL_ALGORITHM *algs)
1600{
1601 if (prov->unquery_operation != NULL)
1602 prov->unquery_operation(prov->provctx, operation_id, algs);
1603}
1604
1605int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum)
1606{
1607 size_t byte = bitnum / 8;
1608 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
1609
1610 if (!CRYPTO_THREAD_write_lock(provider->opbits_lock))
1611 return 0;
1612 if (provider->operation_bits_sz <= byte) {
1613 unsigned char *tmp = OPENSSL_realloc(provider->operation_bits,
1614 byte + 1);
1615
1616 if (tmp == NULL) {
1617 CRYPTO_THREAD_unlock(provider->opbits_lock);
1618 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
1619 return 0;
1620 }
1621 provider->operation_bits = tmp;
1622 memset(provider->operation_bits + provider->operation_bits_sz,
1623 '\0', byte + 1 - provider->operation_bits_sz);
1624 provider->operation_bits_sz = byte + 1;
1625 }
1626 provider->operation_bits[byte] |= bit;
1627 CRYPTO_THREAD_unlock(provider->opbits_lock);
1628 return 1;
1629}
1630
1631int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum,
1632 int *result)
1633{
1634 size_t byte = bitnum / 8;
1635 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
1636
1637 if (!ossl_assert(result != NULL)) {
1638 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
1639 return 0;
1640 }
1641
1642 *result = 0;
1643 if (!CRYPTO_THREAD_read_lock(provider->opbits_lock))
1644 return 0;
1645 if (provider->operation_bits_sz > byte)
1646 *result = ((provider->operation_bits[byte] & bit) != 0);
1647 CRYPTO_THREAD_unlock(provider->opbits_lock);
1648 return 1;
1649}
1650
1651#ifndef FIPS_MODULE
1652const OSSL_CORE_HANDLE *ossl_provider_get_parent(OSSL_PROVIDER *prov)
1653{
1654 return prov->handle;
1655}
1656
1657int ossl_provider_is_child(const OSSL_PROVIDER *prov)
1658{
1659 return prov->ischild;
1660}
1661
1662int ossl_provider_set_child(OSSL_PROVIDER *prov, const OSSL_CORE_HANDLE *handle)
1663{
1664 prov->handle = handle;
1665 prov->ischild = 1;
1666
1667 return 1;
1668}
1669
1670int ossl_provider_default_props_update(OSSL_LIB_CTX *libctx, const char *props)
1671{
1672#ifndef FIPS_MODULE
1673 struct provider_store_st *store = NULL;
1674 int i, max;
1675 OSSL_PROVIDER_CHILD_CB *child_cb;
1676
1677 if ((store = get_provider_store(libctx)) == NULL)
1678 return 0;
1679
1680 if (!CRYPTO_THREAD_read_lock(store->lock))
1681 return 0;
1682
1683 max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
1684 for (i = 0; i < max; i++) {
1685 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
1686 child_cb->global_props_cb(props, child_cb->cbdata);
1687 }
1688
1689 CRYPTO_THREAD_unlock(store->lock);
1690#endif
1691 return 1;
1692}
1693
1694static int ossl_provider_register_child_cb(const OSSL_CORE_HANDLE *handle,
1695 int (*create_cb)(
1696 const OSSL_CORE_HANDLE *provider,
1697 void *cbdata),
1698 int (*remove_cb)(
1699 const OSSL_CORE_HANDLE *provider,
1700 void *cbdata),
1701 int (*global_props_cb)(
1702 const char *props,
1703 void *cbdata),
1704 void *cbdata)
1705{
1706 /*
1707 * This is really an OSSL_PROVIDER that we created and cast to
1708 * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
1709 */
1710 OSSL_PROVIDER *thisprov = (OSSL_PROVIDER *)handle;
1711 OSSL_PROVIDER *prov;
1712 OSSL_LIB_CTX *libctx = thisprov->libctx;
1713 struct provider_store_st *store = NULL;
1714 int ret = 0, i, max;
1715 OSSL_PROVIDER_CHILD_CB *child_cb;
1716 char *propsstr = NULL;
1717
1718 if ((store = get_provider_store(libctx)) == NULL)
1719 return 0;
1720
1721 child_cb = OPENSSL_malloc(sizeof(*child_cb));
1722 if (child_cb == NULL)
1723 return 0;
1724 child_cb->prov = thisprov;
1725 child_cb->create_cb = create_cb;
1726 child_cb->remove_cb = remove_cb;
1727 child_cb->global_props_cb = global_props_cb;
1728 child_cb->cbdata = cbdata;
1729
1730 if (!CRYPTO_THREAD_write_lock(store->lock)) {
1731 OPENSSL_free(child_cb);
1732 return 0;
1733 }
1734 propsstr = evp_get_global_properties_str(libctx, 0);
1735
1736 if (propsstr != NULL) {
1737 global_props_cb(propsstr, cbdata);
1738 OPENSSL_free(propsstr);
1739 }
1740 max = sk_OSSL_PROVIDER_num(store->providers);
1741 for (i = 0; i < max; i++) {
1742 int activated;
1743
1744 prov = sk_OSSL_PROVIDER_value(store->providers, i);
1745
1746 if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
1747 break;
1748 activated = prov->flag_activated;
1749 CRYPTO_THREAD_unlock(prov->flag_lock);
1750 /*
1751 * We hold the store lock while calling the user callback. This means
1752 * that the user callback must be short and simple and not do anything
1753 * likely to cause a deadlock. We don't hold the flag_lock during this
1754 * call. In theory this means that another thread could deactivate it
1755 * while we are calling create. This is ok because the other thread
1756 * will also call remove_cb, but won't be able to do so until we release
1757 * the store lock.
1758 */
1759 if (activated && !create_cb((OSSL_CORE_HANDLE *)prov, cbdata))
1760 break;
1761 }
1762 if (i == max) {
1763 /* Success */
1764 ret = sk_OSSL_PROVIDER_CHILD_CB_push(store->child_cbs, child_cb);
1765 }
1766 if (i != max || ret <= 0) {
1767 /* Failed during creation. Remove everything we just added */
1768 for (; i >= 0; i--) {
1769 prov = sk_OSSL_PROVIDER_value(store->providers, i);
1770 remove_cb((OSSL_CORE_HANDLE *)prov, cbdata);
1771 }
1772 OPENSSL_free(child_cb);
1773 ret = 0;
1774 }
1775 CRYPTO_THREAD_unlock(store->lock);
1776
1777 return ret;
1778}
1779
1780static void ossl_provider_deregister_child_cb(const OSSL_CORE_HANDLE *handle)
1781{
1782 /*
1783 * This is really an OSSL_PROVIDER that we created and cast to
1784 * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
1785 */
1786 OSSL_PROVIDER *thisprov = (OSSL_PROVIDER *)handle;
1787 OSSL_LIB_CTX *libctx = thisprov->libctx;
1788 struct provider_store_st *store = NULL;
1789 int i, max;
1790 OSSL_PROVIDER_CHILD_CB *child_cb;
1791
1792 if ((store = get_provider_store(libctx)) == NULL)
1793 return;
1794
1795 if (!CRYPTO_THREAD_write_lock(store->lock))
1796 return;
1797 max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
1798 for (i = 0; i < max; i++) {
1799 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
1800 if (child_cb->prov == thisprov) {
1801 /* Found an entry */
1802 sk_OSSL_PROVIDER_CHILD_CB_delete(store->child_cbs, i);
1803 OPENSSL_free(child_cb);
1804 break;
1805 }
1806 }
1807 CRYPTO_THREAD_unlock(store->lock);
1808}
1809#endif
1810
1811/*-
1812 * Core functions for the provider
1813 * ===============================
1814 *
1815 * This is the set of functions that the core makes available to the provider
1816 */
1817
1818/*
1819 * This returns a list of Provider Object parameters with their types, for
1820 * discovery. We do not expect that many providers will use this, but one
1821 * never knows.
1822 */
1823static const OSSL_PARAM param_types[] = {
1824 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
1825 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_PROV_NAME, OSSL_PARAM_UTF8_PTR,
1826 NULL, 0),
1827#ifndef FIPS_MODULE
1828 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_MODULE_FILENAME, OSSL_PARAM_UTF8_PTR,
1829 NULL, 0),
1830#endif
1831 OSSL_PARAM_END
1832};
1833
1834/*
1835 * Forward declare all the functions that are provided aa dispatch.
1836 * This ensures that the compiler will complain if they aren't defined
1837 * with the correct signature.
1838 */
1839static OSSL_FUNC_core_gettable_params_fn core_gettable_params;
1840static OSSL_FUNC_core_get_params_fn core_get_params;
1841static OSSL_FUNC_core_get_libctx_fn core_get_libctx;
1842static OSSL_FUNC_core_thread_start_fn core_thread_start;
1843#ifndef FIPS_MODULE
1844static OSSL_FUNC_core_new_error_fn core_new_error;
1845static OSSL_FUNC_core_set_error_debug_fn core_set_error_debug;
1846static OSSL_FUNC_core_vset_error_fn core_vset_error;
1847static OSSL_FUNC_core_set_error_mark_fn core_set_error_mark;
1848static OSSL_FUNC_core_clear_last_error_mark_fn core_clear_last_error_mark;
1849static OSSL_FUNC_core_pop_error_to_mark_fn core_pop_error_to_mark;
1850OSSL_FUNC_BIO_new_file_fn ossl_core_bio_new_file;
1851OSSL_FUNC_BIO_new_membuf_fn ossl_core_bio_new_mem_buf;
1852OSSL_FUNC_BIO_read_ex_fn ossl_core_bio_read_ex;
1853OSSL_FUNC_BIO_write_ex_fn ossl_core_bio_write_ex;
1854OSSL_FUNC_BIO_gets_fn ossl_core_bio_gets;
1855OSSL_FUNC_BIO_puts_fn ossl_core_bio_puts;
1856OSSL_FUNC_BIO_up_ref_fn ossl_core_bio_up_ref;
1857OSSL_FUNC_BIO_free_fn ossl_core_bio_free;
1858OSSL_FUNC_BIO_vprintf_fn ossl_core_bio_vprintf;
1859OSSL_FUNC_BIO_vsnprintf_fn BIO_vsnprintf;
1860static OSSL_FUNC_self_test_cb_fn core_self_test_get_callback;
1861static OSSL_FUNC_get_entropy_fn rand_get_entropy;
1862static OSSL_FUNC_get_user_entropy_fn rand_get_user_entropy;
1863static OSSL_FUNC_cleanup_entropy_fn rand_cleanup_entropy;
1864static OSSL_FUNC_cleanup_user_entropy_fn rand_cleanup_user_entropy;
1865static OSSL_FUNC_get_nonce_fn rand_get_nonce;
1866static OSSL_FUNC_get_user_nonce_fn rand_get_user_nonce;
1867static OSSL_FUNC_cleanup_nonce_fn rand_cleanup_nonce;
1868static OSSL_FUNC_cleanup_user_nonce_fn rand_cleanup_user_nonce;
1869#endif
1870OSSL_FUNC_CRYPTO_malloc_fn CRYPTO_malloc;
1871OSSL_FUNC_CRYPTO_zalloc_fn CRYPTO_zalloc;
1872OSSL_FUNC_CRYPTO_free_fn CRYPTO_free;
1873OSSL_FUNC_CRYPTO_clear_free_fn CRYPTO_clear_free;
1874OSSL_FUNC_CRYPTO_realloc_fn CRYPTO_realloc;
1875OSSL_FUNC_CRYPTO_clear_realloc_fn CRYPTO_clear_realloc;
1876OSSL_FUNC_CRYPTO_secure_malloc_fn CRYPTO_secure_malloc;
1877OSSL_FUNC_CRYPTO_secure_zalloc_fn CRYPTO_secure_zalloc;
1878OSSL_FUNC_CRYPTO_secure_free_fn CRYPTO_secure_free;
1879OSSL_FUNC_CRYPTO_secure_clear_free_fn CRYPTO_secure_clear_free;
1880OSSL_FUNC_CRYPTO_secure_allocated_fn CRYPTO_secure_allocated;
1881OSSL_FUNC_OPENSSL_cleanse_fn OPENSSL_cleanse;
1882#ifndef FIPS_MODULE
1883OSSL_FUNC_provider_register_child_cb_fn ossl_provider_register_child_cb;
1884OSSL_FUNC_provider_deregister_child_cb_fn ossl_provider_deregister_child_cb;
1885static OSSL_FUNC_provider_name_fn core_provider_get0_name;
1886static OSSL_FUNC_provider_get0_provider_ctx_fn core_provider_get0_provider_ctx;
1887static OSSL_FUNC_provider_get0_dispatch_fn core_provider_get0_dispatch;
1888static OSSL_FUNC_provider_up_ref_fn core_provider_up_ref_intern;
1889static OSSL_FUNC_provider_free_fn core_provider_free_intern;
1890static OSSL_FUNC_core_obj_add_sigid_fn core_obj_add_sigid;
1891static OSSL_FUNC_core_obj_create_fn core_obj_create;
1892#endif
1893
1894static const OSSL_PARAM *core_gettable_params(const OSSL_CORE_HANDLE *handle)
1895{
1896 return param_types;
1897}
1898
1899static int core_get_params(const OSSL_CORE_HANDLE *handle, OSSL_PARAM params[])
1900{
1901 int i;
1902 OSSL_PARAM *p;
1903 /*
1904 * We created this object originally and we know it is actually an
1905 * OSSL_PROVIDER *, so the cast is safe
1906 */
1907 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1908
1909 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_VERSION)) != NULL)
1910 OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR);
1911 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_PROV_NAME)) != NULL)
1912 OSSL_PARAM_set_utf8_ptr(p, prov->name);
1913
1914#ifndef FIPS_MODULE
1915 if ((p = OSSL_PARAM_locate(params,
1916 OSSL_PROV_PARAM_CORE_MODULE_FILENAME)) != NULL)
1917 OSSL_PARAM_set_utf8_ptr(p, ossl_provider_module_path(prov));
1918#endif
1919
1920 if (prov->parameters == NULL)
1921 return 1;
1922
1923 for (i = 0; i < sk_INFOPAIR_num(prov->parameters); i++) {
1924 INFOPAIR *pair = sk_INFOPAIR_value(prov->parameters, i);
1925
1926 if ((p = OSSL_PARAM_locate(params, pair->name)) != NULL)
1927 OSSL_PARAM_set_utf8_ptr(p, pair->value);
1928 }
1929 return 1;
1930}
1931
1932static OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle)
1933{
1934 /*
1935 * We created this object originally and we know it is actually an
1936 * OSSL_PROVIDER *, so the cast is safe
1937 */
1938 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1939
1940 /*
1941 * Using ossl_provider_libctx would be wrong as that returns
1942 * NULL for |prov| == NULL and NULL libctx has a special meaning
1943 * that does not apply here. Here |prov| == NULL can happen only in
1944 * case of a coding error.
1945 */
1946 assert(prov != NULL);
1947 return (OPENSSL_CORE_CTX *)prov->libctx;
1948}
1949
1950static int core_thread_start(const OSSL_CORE_HANDLE *handle,
1951 OSSL_thread_stop_handler_fn handfn,
1952 void *arg)
1953{
1954 /*
1955 * We created this object originally and we know it is actually an
1956 * OSSL_PROVIDER *, so the cast is safe
1957 */
1958 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1959
1960 return ossl_init_thread_start(prov, arg, handfn);
1961}
1962
1963/*
1964 * The FIPS module inner provider doesn't implement these. They aren't
1965 * needed there, since the FIPS module upcalls are always the outer provider
1966 * ones.
1967 */
1968#ifndef FIPS_MODULE
1969/*
1970 * These error functions should use |handle| to select the proper
1971 * library context to report in the correct error stack if error
1972 * stacks become tied to the library context.
1973 * We cannot currently do that since there's no support for it in the
1974 * ERR subsystem.
1975 */
1976static void core_new_error(const OSSL_CORE_HANDLE *handle)
1977{
1978 ERR_new();
1979}
1980
1981static void core_set_error_debug(const OSSL_CORE_HANDLE *handle,
1982 const char *file, int line, const char *func)
1983{
1984 ERR_set_debug(file, line, func);
1985}
1986
1987static void core_vset_error(const OSSL_CORE_HANDLE *handle,
1988 uint32_t reason, const char *fmt, va_list args)
1989{
1990 /*
1991 * We created this object originally and we know it is actually an
1992 * OSSL_PROVIDER *, so the cast is safe
1993 */
1994 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1995
1996 /*
1997 * If the uppermost 8 bits are non-zero, it's an OpenSSL library
1998 * error and will be treated as such. Otherwise, it's a new style
1999 * provider error and will be treated as such.
2000 */
2001 if (ERR_GET_LIB(reason) != 0) {
2002 ERR_vset_error(ERR_GET_LIB(reason), ERR_GET_REASON(reason), fmt, args);
2003 } else {
2004 ERR_vset_error(prov->error_lib, (int)reason, fmt, args);
2005 }
2006}
2007
2008static int core_set_error_mark(const OSSL_CORE_HANDLE *handle)
2009{
2010 return ERR_set_mark();
2011}
2012
2013static int core_clear_last_error_mark(const OSSL_CORE_HANDLE *handle)
2014{
2015 return ERR_clear_last_mark();
2016}
2017
2018static int core_pop_error_to_mark(const OSSL_CORE_HANDLE *handle)
2019{
2020 return ERR_pop_to_mark();
2021}
2022
2023static void core_self_test_get_callback(OPENSSL_CORE_CTX *libctx,
2024 OSSL_CALLBACK **cb, void **cbarg)
2025{
2026 OSSL_SELF_TEST_get_callback((OSSL_LIB_CTX *)libctx, cb, cbarg);
2027}
2028
2029static size_t rand_get_entropy(const OSSL_CORE_HANDLE *handle,
2030 unsigned char **pout, int entropy,
2031 size_t min_len, size_t max_len)
2032{
2033 return ossl_rand_get_entropy((OSSL_LIB_CTX *)core_get_libctx(handle),
2034 pout, entropy, min_len, max_len);
2035}
2036
2037static size_t rand_get_user_entropy(const OSSL_CORE_HANDLE *handle,
2038 unsigned char **pout, int entropy,
2039 size_t min_len, size_t max_len)
2040{
2041 return ossl_rand_get_user_entropy((OSSL_LIB_CTX *)core_get_libctx(handle),
2042 pout, entropy, min_len, max_len);
2043}
2044
2045static void rand_cleanup_entropy(const OSSL_CORE_HANDLE *handle,
2046 unsigned char *buf, size_t len)
2047{
2048 ossl_rand_cleanup_entropy((OSSL_LIB_CTX *)core_get_libctx(handle),
2049 buf, len);
2050}
2051
2052static void rand_cleanup_user_entropy(const OSSL_CORE_HANDLE *handle,
2053 unsigned char *buf, size_t len)
2054{
2055 ossl_rand_cleanup_user_entropy((OSSL_LIB_CTX *)core_get_libctx(handle),
2056 buf, len);
2057}
2058
2059static size_t rand_get_nonce(const OSSL_CORE_HANDLE *handle,
2060 unsigned char **pout,
2061 size_t min_len, size_t max_len,
2062 const void *salt, size_t salt_len)
2063{
2064 return ossl_rand_get_nonce((OSSL_LIB_CTX *)core_get_libctx(handle),
2065 pout, min_len, max_len, salt, salt_len);
2066}
2067
2068static size_t rand_get_user_nonce(const OSSL_CORE_HANDLE *handle,
2069 unsigned char **pout,
2070 size_t min_len, size_t max_len,
2071 const void *salt, size_t salt_len)
2072{
2073 return ossl_rand_get_user_nonce((OSSL_LIB_CTX *)core_get_libctx(handle),
2074 pout, min_len, max_len, salt, salt_len);
2075}
2076
2077static void rand_cleanup_nonce(const OSSL_CORE_HANDLE *handle,
2078 unsigned char *buf, size_t len)
2079{
2080 ossl_rand_cleanup_nonce((OSSL_LIB_CTX *)core_get_libctx(handle),
2081 buf, len);
2082}
2083
2084static void rand_cleanup_user_nonce(const OSSL_CORE_HANDLE *handle,
2085 unsigned char *buf, size_t len)
2086{
2087 ossl_rand_cleanup_user_nonce((OSSL_LIB_CTX *)core_get_libctx(handle),
2088 buf, len);
2089}
2090
2091static const char *core_provider_get0_name(const OSSL_CORE_HANDLE *prov)
2092{
2093 return OSSL_PROVIDER_get0_name((const OSSL_PROVIDER *)prov);
2094}
2095
2096static void *core_provider_get0_provider_ctx(const OSSL_CORE_HANDLE *prov)
2097{
2098 return OSSL_PROVIDER_get0_provider_ctx((const OSSL_PROVIDER *)prov);
2099}
2100
2101static const OSSL_DISPATCH *
2102core_provider_get0_dispatch(const OSSL_CORE_HANDLE *prov)
2103{
2104 return OSSL_PROVIDER_get0_dispatch((const OSSL_PROVIDER *)prov);
2105}
2106
2107static int core_provider_up_ref_intern(const OSSL_CORE_HANDLE *prov,
2108 int activate)
2109{
2110 return provider_up_ref_intern((OSSL_PROVIDER *)prov, activate);
2111}
2112
2113static int core_provider_free_intern(const OSSL_CORE_HANDLE *prov,
2114 int deactivate)
2115{
2116 return provider_free_intern((OSSL_PROVIDER *)prov, deactivate);
2117}
2118
2119static int core_obj_add_sigid(const OSSL_CORE_HANDLE *prov,
2120 const char *sign_name, const char *digest_name,
2121 const char *pkey_name)
2122{
2123 int sign_nid = OBJ_txt2nid(sign_name);
2124 int digest_nid = NID_undef;
2125 int pkey_nid = OBJ_txt2nid(pkey_name);
2126
2127 if (digest_name != NULL && digest_name[0] != '\0'
2128 && (digest_nid = OBJ_txt2nid(digest_name)) == NID_undef)
2129 return 0;
2130
2131 if (sign_nid == NID_undef)
2132 return 0;
2133
2134 /*
2135 * Check if it already exists. This is a success if so (even if we don't
2136 * have nids for the digest/pkey)
2137 */
2138 if (OBJ_find_sigid_algs(sign_nid, NULL, NULL))
2139 return 1;
2140
2141 if (pkey_nid == NID_undef)
2142 return 0;
2143
2144 return OBJ_add_sigid(sign_nid, digest_nid, pkey_nid);
2145}
2146
2147static int core_obj_create(const OSSL_CORE_HANDLE *prov, const char *oid,
2148 const char *sn, const char *ln)
2149{
2150 /* Check if it already exists and create it if not */
2151 return OBJ_txt2nid(oid) != NID_undef
2152 || OBJ_create(oid, sn, ln) != NID_undef;
2153}
2154#endif /* FIPS_MODULE */
2155
2156/*
2157 * Functions provided by the core.
2158 */
2159static const OSSL_DISPATCH core_dispatch_[] = {
2160 { OSSL_FUNC_CORE_GETTABLE_PARAMS, (void (*)(void))core_gettable_params },
2161 { OSSL_FUNC_CORE_GET_PARAMS, (void (*)(void))core_get_params },
2162 { OSSL_FUNC_CORE_GET_LIBCTX, (void (*)(void))core_get_libctx },
2163 { OSSL_FUNC_CORE_THREAD_START, (void (*)(void))core_thread_start },
2164#ifndef FIPS_MODULE
2165 { OSSL_FUNC_CORE_NEW_ERROR, (void (*)(void))core_new_error },
2166 { OSSL_FUNC_CORE_SET_ERROR_DEBUG, (void (*)(void))core_set_error_debug },
2167 { OSSL_FUNC_CORE_VSET_ERROR, (void (*)(void))core_vset_error },
2168 { OSSL_FUNC_CORE_SET_ERROR_MARK, (void (*)(void))core_set_error_mark },
2169 { OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK,
2170 (void (*)(void))core_clear_last_error_mark },
2171 { OSSL_FUNC_CORE_POP_ERROR_TO_MARK, (void (*)(void))core_pop_error_to_mark },
2172 { OSSL_FUNC_BIO_NEW_FILE, (void (*)(void))ossl_core_bio_new_file },
2173 { OSSL_FUNC_BIO_NEW_MEMBUF, (void (*)(void))ossl_core_bio_new_mem_buf },
2174 { OSSL_FUNC_BIO_READ_EX, (void (*)(void))ossl_core_bio_read_ex },
2175 { OSSL_FUNC_BIO_WRITE_EX, (void (*)(void))ossl_core_bio_write_ex },
2176 { OSSL_FUNC_BIO_GETS, (void (*)(void))ossl_core_bio_gets },
2177 { OSSL_FUNC_BIO_PUTS, (void (*)(void))ossl_core_bio_puts },
2178 { OSSL_FUNC_BIO_CTRL, (void (*)(void))ossl_core_bio_ctrl },
2179 { OSSL_FUNC_BIO_UP_REF, (void (*)(void))ossl_core_bio_up_ref },
2180 { OSSL_FUNC_BIO_FREE, (void (*)(void))ossl_core_bio_free },
2181 { OSSL_FUNC_BIO_VPRINTF, (void (*)(void))ossl_core_bio_vprintf },
2182 { OSSL_FUNC_BIO_VSNPRINTF, (void (*)(void))BIO_vsnprintf },
2183 { OSSL_FUNC_SELF_TEST_CB, (void (*)(void))core_self_test_get_callback },
2184 { OSSL_FUNC_GET_ENTROPY, (void (*)(void))rand_get_entropy },
2185 { OSSL_FUNC_GET_USER_ENTROPY, (void (*)(void))rand_get_user_entropy },
2186 { OSSL_FUNC_CLEANUP_ENTROPY, (void (*)(void))rand_cleanup_entropy },
2187 { OSSL_FUNC_CLEANUP_USER_ENTROPY, (void (*)(void))rand_cleanup_user_entropy },
2188 { OSSL_FUNC_GET_NONCE, (void (*)(void))rand_get_nonce },
2189 { OSSL_FUNC_GET_USER_NONCE, (void (*)(void))rand_get_user_nonce },
2190 { OSSL_FUNC_CLEANUP_NONCE, (void (*)(void))rand_cleanup_nonce },
2191 { OSSL_FUNC_CLEANUP_USER_NONCE, (void (*)(void))rand_cleanup_user_nonce },
2192#endif
2193 { OSSL_FUNC_CRYPTO_MALLOC, (void (*)(void))CRYPTO_malloc },
2194 { OSSL_FUNC_CRYPTO_ZALLOC, (void (*)(void))CRYPTO_zalloc },
2195 { OSSL_FUNC_CRYPTO_FREE, (void (*)(void))CRYPTO_free },
2196 { OSSL_FUNC_CRYPTO_CLEAR_FREE, (void (*)(void))CRYPTO_clear_free },
2197 { OSSL_FUNC_CRYPTO_REALLOC, (void (*)(void))CRYPTO_realloc },
2198 { OSSL_FUNC_CRYPTO_CLEAR_REALLOC, (void (*)(void))CRYPTO_clear_realloc },
2199 { OSSL_FUNC_CRYPTO_SECURE_MALLOC, (void (*)(void))CRYPTO_secure_malloc },
2200 { OSSL_FUNC_CRYPTO_SECURE_ZALLOC, (void (*)(void))CRYPTO_secure_zalloc },
2201 { OSSL_FUNC_CRYPTO_SECURE_FREE, (void (*)(void))CRYPTO_secure_free },
2202 { OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE,
2203 (void (*)(void))CRYPTO_secure_clear_free },
2204 { OSSL_FUNC_CRYPTO_SECURE_ALLOCATED,
2205 (void (*)(void))CRYPTO_secure_allocated },
2206 { OSSL_FUNC_OPENSSL_CLEANSE, (void (*)(void))OPENSSL_cleanse },
2207#ifndef FIPS_MODULE
2208 { OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB,
2209 (void (*)(void))ossl_provider_register_child_cb },
2210 { OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB,
2211 (void (*)(void))ossl_provider_deregister_child_cb },
2212 { OSSL_FUNC_PROVIDER_NAME,
2213 (void (*)(void))core_provider_get0_name },
2214 { OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX,
2215 (void (*)(void))core_provider_get0_provider_ctx },
2216 { OSSL_FUNC_PROVIDER_GET0_DISPATCH,
2217 (void (*)(void))core_provider_get0_dispatch },
2218 { OSSL_FUNC_PROVIDER_UP_REF,
2219 (void (*)(void))core_provider_up_ref_intern },
2220 { OSSL_FUNC_PROVIDER_FREE,
2221 (void (*)(void))core_provider_free_intern },
2222 { OSSL_FUNC_CORE_OBJ_ADD_SIGID, (void (*)(void))core_obj_add_sigid },
2223 { OSSL_FUNC_CORE_OBJ_CREATE, (void (*)(void))core_obj_create },
2224#endif
2225 { 0, NULL }
2226};
2227static const OSSL_DISPATCH *core_dispatch = core_dispatch_;
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette