VirtualBox

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

最後變更 在這個檔案從105945是 105945,由 vboxsync 提交於 7 月 前

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

檔案大小: 71.0 KB
 
1/*
2 * Copyright 2019-2024 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 prov = provider_new(name, template.init, template.parameters);
563
564 if (prov == NULL)
565 return NULL;
566
567 if (!ossl_provider_set_module_path(prov, template.path)) {
568 ossl_provider_free(prov);
569 return NULL;
570 }
571
572 prov->libctx = libctx;
573#ifndef FIPS_MODULE
574 prov->error_lib = ERR_get_next_error_library();
575#endif
576
577 /*
578 * At this point, the provider is only partially "loaded". To be
579 * fully "loaded", ossl_provider_activate() must also be called and it must
580 * then be added to the provider store.
581 */
582
583 return prov;
584}
585
586/* Assumes that the store lock is held */
587static int create_provider_children(OSSL_PROVIDER *prov)
588{
589 int ret = 1;
590#ifndef FIPS_MODULE
591 struct provider_store_st *store = prov->store;
592 OSSL_PROVIDER_CHILD_CB *child_cb;
593 int i, max;
594
595 max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
596 for (i = 0; i < max; i++) {
597 /*
598 * This is newly activated (activatecnt == 1), so we need to
599 * create child providers as necessary.
600 */
601 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
602 ret &= child_cb->create_cb((OSSL_CORE_HANDLE *)prov, child_cb->cbdata);
603 }
604#endif
605
606 return ret;
607}
608
609int ossl_provider_add_to_store(OSSL_PROVIDER *prov, OSSL_PROVIDER **actualprov,
610 int retain_fallbacks)
611{
612 struct provider_store_st *store;
613 int idx;
614 OSSL_PROVIDER tmpl = { 0, };
615 OSSL_PROVIDER *actualtmp = NULL;
616
617 if (actualprov != NULL)
618 *actualprov = NULL;
619
620 if ((store = get_provider_store(prov->libctx)) == NULL)
621 return 0;
622
623 if (!CRYPTO_THREAD_write_lock(store->lock))
624 return 0;
625
626 tmpl.name = (char *)prov->name;
627 idx = sk_OSSL_PROVIDER_find(store->providers, &tmpl);
628 if (idx == -1)
629 actualtmp = prov;
630 else
631 actualtmp = sk_OSSL_PROVIDER_value(store->providers, idx);
632
633 if (idx == -1) {
634 if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0)
635 goto err;
636 prov->store = store;
637 if (!create_provider_children(prov)) {
638 sk_OSSL_PROVIDER_delete_ptr(store->providers, prov);
639 goto err;
640 }
641 if (!retain_fallbacks)
642 store->use_fallbacks = 0;
643 }
644
645 CRYPTO_THREAD_unlock(store->lock);
646
647 if (actualprov != NULL) {
648 if (!ossl_provider_up_ref(actualtmp)) {
649 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
650 actualtmp = NULL;
651 return 0;
652 }
653 *actualprov = actualtmp;
654 }
655
656 if (idx >= 0) {
657 /*
658 * The provider is already in the store. Probably two threads
659 * independently initialised their own provider objects with the same
660 * name and raced to put them in the store. This thread lost. We
661 * deactivate the one we just created and use the one that already
662 * exists instead.
663 * If we get here then we know we did not create provider children
664 * above, so we inform ossl_provider_deactivate not to attempt to remove
665 * any.
666 */
667 ossl_provider_deactivate(prov, 0);
668 ossl_provider_free(prov);
669 }
670
671 return 1;
672
673 err:
674 CRYPTO_THREAD_unlock(store->lock);
675 return 0;
676}
677
678void ossl_provider_free(OSSL_PROVIDER *prov)
679{
680 if (prov != NULL) {
681 int ref = 0;
682
683 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
684
685 /*
686 * When the refcount drops to zero, we clean up the provider.
687 * Note that this also does teardown, which may seem late,
688 * considering that init happens on first activation. However,
689 * there may be other structures hanging on to the provider after
690 * the last deactivation and may therefore need full access to the
691 * provider's services. Therefore, we deinit late.
692 */
693 if (ref == 0) {
694 if (prov->flag_initialized) {
695 ossl_provider_teardown(prov);
696#ifndef OPENSSL_NO_ERR
697# ifndef FIPS_MODULE
698 if (prov->error_strings != NULL) {
699 ERR_unload_strings(prov->error_lib, prov->error_strings);
700 OPENSSL_free(prov->error_strings);
701 prov->error_strings = NULL;
702 }
703# endif
704#endif
705 OPENSSL_free(prov->operation_bits);
706 prov->operation_bits = NULL;
707 prov->operation_bits_sz = 0;
708 prov->flag_initialized = 0;
709 }
710
711#ifndef FIPS_MODULE
712 /*
713 * We deregister thread handling whether or not the provider was
714 * initialized. If init was attempted but was not successful then
715 * the provider may still have registered a thread handler.
716 */
717 ossl_init_thread_deregister(prov);
718 DSO_free(prov->module);
719#endif
720 OPENSSL_free(prov->name);
721 OPENSSL_free(prov->path);
722 sk_INFOPAIR_pop_free(prov->parameters, infopair_free);
723 CRYPTO_THREAD_lock_free(prov->opbits_lock);
724 CRYPTO_THREAD_lock_free(prov->flag_lock);
725#ifndef HAVE_ATOMICS
726 CRYPTO_THREAD_lock_free(prov->refcnt_lock);
727#endif
728 OPENSSL_free(prov);
729 }
730#ifndef FIPS_MODULE
731 else if (prov->ischild) {
732 ossl_provider_free_parent(prov, 0);
733 }
734#endif
735 }
736}
737
738/* Setters */
739int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *module_path)
740{
741 OPENSSL_free(prov->path);
742 prov->path = NULL;
743 if (module_path == NULL)
744 return 1;
745 if ((prov->path = OPENSSL_strdup(module_path)) != NULL)
746 return 1;
747 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
748 return 0;
749}
750
751static int infopair_add(STACK_OF(INFOPAIR) **infopairsk, const char *name,
752 const char *value)
753{
754 INFOPAIR *pair = NULL;
755
756 if ((pair = OPENSSL_zalloc(sizeof(*pair))) != NULL
757 && (*infopairsk != NULL
758 || (*infopairsk = sk_INFOPAIR_new_null()) != NULL)
759 && (pair->name = OPENSSL_strdup(name)) != NULL
760 && (pair->value = OPENSSL_strdup(value)) != NULL
761 && sk_INFOPAIR_push(*infopairsk, pair) > 0)
762 return 1;
763
764 if (pair != NULL) {
765 OPENSSL_free(pair->name);
766 OPENSSL_free(pair->value);
767 OPENSSL_free(pair);
768 }
769 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
770 return 0;
771}
772
773int ossl_provider_add_parameter(OSSL_PROVIDER *prov,
774 const char *name, const char *value)
775{
776 return infopair_add(&prov->parameters, name, value);
777}
778
779int ossl_provider_info_add_parameter(OSSL_PROVIDER_INFO *provinfo,
780 const char *name,
781 const char *value)
782{
783 return infopair_add(&provinfo->parameters, name, value);
784}
785
786/*
787 * Provider activation.
788 *
789 * What "activation" means depends on the provider form; for built in
790 * providers (in the library or the application alike), the provider
791 * can already be considered to be loaded, all that's needed is to
792 * initialize it. However, for dynamically loadable provider modules,
793 * we must first load that module.
794 *
795 * Built in modules are distinguished from dynamically loaded modules
796 * with an already assigned init function.
797 */
798static const OSSL_DISPATCH *core_dispatch; /* Define further down */
799
800int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *libctx,
801 const char *path)
802{
803 struct provider_store_st *store;
804 char *p = NULL;
805
806 if (path != NULL) {
807 p = OPENSSL_strdup(path);
808 if (p == NULL) {
809 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
810 return 0;
811 }
812 }
813 if ((store = get_provider_store(libctx)) != NULL
814 && CRYPTO_THREAD_write_lock(store->default_path_lock)) {
815 OPENSSL_free(store->default_path);
816 store->default_path = p;
817 CRYPTO_THREAD_unlock(store->default_path_lock);
818 return 1;
819 }
820 OPENSSL_free(p);
821 return 0;
822}
823
824/*
825 * Internal version that doesn't affect the store flags, and thereby avoid
826 * locking. Direct callers must remember to set the store flags when
827 * appropriate.
828 */
829static int provider_init(OSSL_PROVIDER *prov)
830{
831 const OSSL_DISPATCH *provider_dispatch = NULL;
832 void *tmp_provctx = NULL; /* safety measure */
833#ifndef OPENSSL_NO_ERR
834# ifndef FIPS_MODULE
835 OSSL_FUNC_provider_get_reason_strings_fn *p_get_reason_strings = NULL;
836# endif
837#endif
838 int ok = 0;
839
840 if (!ossl_assert(!prov->flag_initialized)) {
841 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
842 goto end;
843 }
844
845#ifndef VBOX /* Don't want loadable modules in our static build. */
846 /*
847 * If the init function isn't set, it indicates that this provider is
848 * a loadable module.
849 */
850 if (prov->init_function == NULL) {
851#ifdef FIPS_MODULE
852 goto end;
853#else
854 if (prov->module == NULL) {
855 char *allocated_path = NULL;
856 const char *module_path = NULL;
857 char *merged_path = NULL;
858 const char *load_dir = NULL;
859 char *allocated_load_dir = NULL;
860 struct provider_store_st *store;
861
862 if ((prov->module = DSO_new()) == NULL) {
863 /* DSO_new() generates an error already */
864 goto end;
865 }
866
867 if ((store = get_provider_store(prov->libctx)) == NULL
868 || !CRYPTO_THREAD_read_lock(store->default_path_lock))
869 goto end;
870
871 if (store->default_path != NULL) {
872 allocated_load_dir = OPENSSL_strdup(store->default_path);
873 CRYPTO_THREAD_unlock(store->default_path_lock);
874 if (allocated_load_dir == NULL) {
875 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
876 goto end;
877 }
878 load_dir = allocated_load_dir;
879 } else {
880 CRYPTO_THREAD_unlock(store->default_path_lock);
881 }
882
883 if (load_dir == NULL) {
884 load_dir = ossl_safe_getenv("OPENSSL_MODULES");
885 if (load_dir == NULL)
886 load_dir = MODULESDIR;
887 }
888
889 DSO_ctrl(prov->module, DSO_CTRL_SET_FLAGS,
890 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY, NULL);
891
892 module_path = prov->path;
893 if (module_path == NULL)
894 module_path = allocated_path =
895 DSO_convert_filename(prov->module, prov->name);
896 if (module_path != NULL)
897 merged_path = DSO_merge(prov->module, module_path, load_dir);
898
899 if (merged_path == NULL
900 || (DSO_load(prov->module, merged_path, NULL, 0)) == NULL) {
901 DSO_free(prov->module);
902 prov->module = NULL;
903 }
904
905 OPENSSL_free(merged_path);
906 OPENSSL_free(allocated_path);
907 OPENSSL_free(allocated_load_dir);
908 }
909
910 if (prov->module == NULL) {
911 /* DSO has already recorded errors, this is just a tracepoint */
912 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_DSO_LIB,
913 "name=%s", prov->name);
914 goto end;
915 }
916
917 prov->init_function = (OSSL_provider_init_fn *)
918 DSO_bind_func(prov->module, "OSSL_provider_init");
919#endif
920 }
921#endif /* VBOX */
922
923 /* Check for and call the initialise function for the provider. */
924 if (prov->init_function == NULL) {
925 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_UNSUPPORTED,
926 "name=%s, provider has no provider init function",
927 prov->name);
928 goto end;
929 }
930
931 if (!prov->init_function((OSSL_CORE_HANDLE *)prov, core_dispatch,
932 &provider_dispatch, &tmp_provctx)) {
933 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INIT_FAIL,
934 "name=%s", prov->name);
935 goto end;
936 }
937 prov->provctx = tmp_provctx;
938 prov->dispatch = provider_dispatch;
939
940 if (provider_dispatch != NULL) {
941 for (; provider_dispatch->function_id != 0; provider_dispatch++) {
942 switch (provider_dispatch->function_id) {
943 case OSSL_FUNC_PROVIDER_TEARDOWN:
944 prov->teardown =
945 OSSL_FUNC_provider_teardown(provider_dispatch);
946 break;
947 case OSSL_FUNC_PROVIDER_GETTABLE_PARAMS:
948 prov->gettable_params =
949 OSSL_FUNC_provider_gettable_params(provider_dispatch);
950 break;
951 case OSSL_FUNC_PROVIDER_GET_PARAMS:
952 prov->get_params =
953 OSSL_FUNC_provider_get_params(provider_dispatch);
954 break;
955 case OSSL_FUNC_PROVIDER_SELF_TEST:
956 prov->self_test =
957 OSSL_FUNC_provider_self_test(provider_dispatch);
958 break;
959 case OSSL_FUNC_PROVIDER_GET_CAPABILITIES:
960 prov->get_capabilities =
961 OSSL_FUNC_provider_get_capabilities(provider_dispatch);
962 break;
963 case OSSL_FUNC_PROVIDER_QUERY_OPERATION:
964 prov->query_operation =
965 OSSL_FUNC_provider_query_operation(provider_dispatch);
966 break;
967 case OSSL_FUNC_PROVIDER_UNQUERY_OPERATION:
968 prov->unquery_operation =
969 OSSL_FUNC_provider_unquery_operation(provider_dispatch);
970 break;
971#ifndef OPENSSL_NO_ERR
972# ifndef FIPS_MODULE
973 case OSSL_FUNC_PROVIDER_GET_REASON_STRINGS:
974 p_get_reason_strings =
975 OSSL_FUNC_provider_get_reason_strings(provider_dispatch);
976 break;
977# endif
978#endif
979 }
980 }
981 }
982
983#ifndef OPENSSL_NO_ERR
984# ifndef FIPS_MODULE
985 if (p_get_reason_strings != NULL) {
986 const OSSL_ITEM *reasonstrings = p_get_reason_strings(prov->provctx);
987 size_t cnt, cnt2;
988
989 /*
990 * ERR_load_strings() handles ERR_STRING_DATA rather than OSSL_ITEM,
991 * although they are essentially the same type.
992 * Furthermore, ERR_load_strings() patches the array's error number
993 * with the error library number, so we need to make a copy of that
994 * array either way.
995 */
996 cnt = 0;
997 while (reasonstrings[cnt].id != 0) {
998 if (ERR_GET_LIB(reasonstrings[cnt].id) != 0)
999 goto end;
1000 cnt++;
1001 }
1002 cnt++; /* One for the terminating item */
1003
1004 /* Allocate one extra item for the "library" name */
1005 prov->error_strings =
1006 OPENSSL_zalloc(sizeof(ERR_STRING_DATA) * (cnt + 1));
1007 if (prov->error_strings == NULL)
1008 goto end;
1009
1010 /*
1011 * Set the "library" name.
1012 */
1013 prov->error_strings[0].error = ERR_PACK(prov->error_lib, 0, 0);
1014 prov->error_strings[0].string = prov->name;
1015 /*
1016 * Copy reasonstrings item 0..cnt-1 to prov->error_trings positions
1017 * 1..cnt.
1018 */
1019 for (cnt2 = 1; cnt2 <= cnt; cnt2++) {
1020 prov->error_strings[cnt2].error = (int)reasonstrings[cnt2-1].id;
1021 prov->error_strings[cnt2].string = reasonstrings[cnt2-1].ptr;
1022 }
1023
1024 ERR_load_strings(prov->error_lib, prov->error_strings);
1025 }
1026# endif
1027#endif
1028
1029 /* With this flag set, this provider has become fully "loaded". */
1030 prov->flag_initialized = 1;
1031 ok = 1;
1032
1033 end:
1034 return ok;
1035}
1036
1037/*
1038 * Deactivate a provider. If upcalls is 0 then we suppress any upcalls to a
1039 * parent provider. If removechildren is 0 then we suppress any calls to remove
1040 * child providers.
1041 * Return -1 on failure and the activation count on success
1042 */
1043static int provider_deactivate(OSSL_PROVIDER *prov, int upcalls,
1044 int removechildren)
1045{
1046 int count;
1047 struct provider_store_st *store;
1048#ifndef FIPS_MODULE
1049 int freeparent = 0;
1050#endif
1051 int lock = 1;
1052
1053 if (!ossl_assert(prov != NULL))
1054 return -1;
1055
1056 /*
1057 * No need to lock if we've got no store because we've not been shared with
1058 * other threads.
1059 */
1060 store = get_provider_store(prov->libctx);
1061 if (store == NULL)
1062 lock = 0;
1063
1064 if (lock && !CRYPTO_THREAD_read_lock(store->lock))
1065 return -1;
1066 if (lock && !CRYPTO_THREAD_write_lock(prov->flag_lock)) {
1067 CRYPTO_THREAD_unlock(store->lock);
1068 return -1;
1069 }
1070
1071#ifndef FIPS_MODULE
1072 if (prov->activatecnt >= 2 && prov->ischild && upcalls) {
1073 /*
1074 * We have had a direct activation in this child libctx so we need to
1075 * now down the ref count in the parent provider. We do the actual down
1076 * ref outside of the flag_lock, since it could involve getting other
1077 * locks.
1078 */
1079 freeparent = 1;
1080 }
1081#endif
1082
1083 if ((count = --prov->activatecnt) < 1)
1084 prov->flag_activated = 0;
1085#ifndef FIPS_MODULE
1086 else
1087 removechildren = 0;
1088#endif
1089
1090#ifndef FIPS_MODULE
1091 if (removechildren && store != NULL) {
1092 int i, max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
1093 OSSL_PROVIDER_CHILD_CB *child_cb;
1094
1095 for (i = 0; i < max; i++) {
1096 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
1097 child_cb->remove_cb((OSSL_CORE_HANDLE *)prov, child_cb->cbdata);
1098 }
1099 }
1100#endif
1101 if (lock) {
1102 CRYPTO_THREAD_unlock(prov->flag_lock);
1103 CRYPTO_THREAD_unlock(store->lock);
1104 }
1105#ifndef FIPS_MODULE
1106 if (freeparent)
1107 ossl_provider_free_parent(prov, 1);
1108#endif
1109
1110 /* We don't deinit here, that's done in ossl_provider_free() */
1111 return count;
1112}
1113
1114/*
1115 * Activate a provider.
1116 * Return -1 on failure and the activation count on success
1117 */
1118static int provider_activate(OSSL_PROVIDER *prov, int lock, int upcalls)
1119{
1120 int count = -1;
1121 struct provider_store_st *store;
1122 int ret = 1;
1123
1124 store = prov->store;
1125 /*
1126 * If the provider hasn't been added to the store, then we don't need
1127 * any locks because we've not shared it with other threads.
1128 */
1129 if (store == NULL) {
1130 lock = 0;
1131 if (!provider_init(prov))
1132 return -1;
1133 }
1134
1135#ifndef FIPS_MODULE
1136 if (prov->ischild && upcalls && !ossl_provider_up_ref_parent(prov, 1))
1137 return -1;
1138#endif
1139
1140 if (lock && !CRYPTO_THREAD_read_lock(store->lock)) {
1141#ifndef FIPS_MODULE
1142 if (prov->ischild && upcalls)
1143 ossl_provider_free_parent(prov, 1);
1144#endif
1145 return -1;
1146 }
1147
1148 if (lock && !CRYPTO_THREAD_write_lock(prov->flag_lock)) {
1149 CRYPTO_THREAD_unlock(store->lock);
1150#ifndef FIPS_MODULE
1151 if (prov->ischild && upcalls)
1152 ossl_provider_free_parent(prov, 1);
1153#endif
1154 return -1;
1155 }
1156
1157 count = ++prov->activatecnt;
1158 prov->flag_activated = 1;
1159
1160 if (prov->activatecnt == 1 && store != NULL) {
1161 ret = create_provider_children(prov);
1162 }
1163 if (lock) {
1164 CRYPTO_THREAD_unlock(prov->flag_lock);
1165 CRYPTO_THREAD_unlock(store->lock);
1166 }
1167
1168 if (!ret)
1169 return -1;
1170
1171 return count;
1172}
1173
1174static int provider_flush_store_cache(const OSSL_PROVIDER *prov)
1175{
1176 struct provider_store_st *store;
1177 int freeing;
1178
1179 if ((store = get_provider_store(prov->libctx)) == NULL)
1180 return 0;
1181
1182 if (!CRYPTO_THREAD_read_lock(store->lock))
1183 return 0;
1184 freeing = store->freeing;
1185 CRYPTO_THREAD_unlock(store->lock);
1186
1187 if (!freeing) {
1188 int acc
1189 = evp_method_store_cache_flush(prov->libctx)
1190#ifndef FIPS_MODULE
1191 + ossl_encoder_store_cache_flush(prov->libctx)
1192 + ossl_decoder_store_cache_flush(prov->libctx)
1193 + ossl_store_loader_store_cache_flush(prov->libctx)
1194#endif
1195 ;
1196
1197#ifndef FIPS_MODULE
1198 return acc == 4;
1199#else
1200 return acc == 1;
1201#endif
1202 }
1203 return 1;
1204}
1205
1206static int provider_remove_store_methods(OSSL_PROVIDER *prov)
1207{
1208 struct provider_store_st *store;
1209 int freeing;
1210
1211 if ((store = get_provider_store(prov->libctx)) == NULL)
1212 return 0;
1213
1214 if (!CRYPTO_THREAD_read_lock(store->lock))
1215 return 0;
1216 freeing = store->freeing;
1217 CRYPTO_THREAD_unlock(store->lock);
1218
1219 if (!freeing) {
1220 int acc;
1221
1222 if (!CRYPTO_THREAD_write_lock(prov->opbits_lock))
1223 return 0;
1224 OPENSSL_free(prov->operation_bits);
1225 prov->operation_bits = NULL;
1226 prov->operation_bits_sz = 0;
1227 CRYPTO_THREAD_unlock(prov->opbits_lock);
1228
1229 acc = evp_method_store_remove_all_provided(prov)
1230#ifndef FIPS_MODULE
1231 + ossl_encoder_store_remove_all_provided(prov)
1232 + ossl_decoder_store_remove_all_provided(prov)
1233 + ossl_store_loader_store_remove_all_provided(prov)
1234#endif
1235 ;
1236
1237#ifndef FIPS_MODULE
1238 return acc == 4;
1239#else
1240 return acc == 1;
1241#endif
1242 }
1243 return 1;
1244}
1245
1246int ossl_provider_activate(OSSL_PROVIDER *prov, int upcalls, int aschild)
1247{
1248 int count;
1249
1250 if (prov == NULL)
1251 return 0;
1252#ifndef FIPS_MODULE
1253 /*
1254 * If aschild is true, then we only actually do the activation if the
1255 * provider is a child. If its not, this is still success.
1256 */
1257 if (aschild && !prov->ischild)
1258 return 1;
1259#endif
1260 if ((count = provider_activate(prov, 1, upcalls)) > 0)
1261 return count == 1 ? provider_flush_store_cache(prov) : 1;
1262
1263 return 0;
1264}
1265
1266int ossl_provider_deactivate(OSSL_PROVIDER *prov, int removechildren)
1267{
1268 int count;
1269
1270 if (prov == NULL
1271 || (count = provider_deactivate(prov, 1, removechildren)) < 0)
1272 return 0;
1273 return count == 0 ? provider_remove_store_methods(prov) : 1;
1274}
1275
1276void *ossl_provider_ctx(const OSSL_PROVIDER *prov)
1277{
1278 return prov != NULL ? prov->provctx : NULL;
1279}
1280
1281/*
1282 * This function only does something once when store->use_fallbacks == 1,
1283 * and then sets store->use_fallbacks = 0, so the second call and so on is
1284 * effectively a no-op.
1285 */
1286static int provider_activate_fallbacks(struct provider_store_st *store)
1287{
1288 int use_fallbacks;
1289 int activated_fallback_count = 0;
1290 int ret = 0;
1291 const OSSL_PROVIDER_INFO *p;
1292
1293 if (!CRYPTO_THREAD_read_lock(store->lock))
1294 return 0;
1295 use_fallbacks = store->use_fallbacks;
1296 CRYPTO_THREAD_unlock(store->lock);
1297 if (!use_fallbacks)
1298 return 1;
1299
1300 if (!CRYPTO_THREAD_write_lock(store->lock))
1301 return 0;
1302 /* Check again, just in case another thread changed it */
1303 use_fallbacks = store->use_fallbacks;
1304 if (!use_fallbacks) {
1305 CRYPTO_THREAD_unlock(store->lock);
1306 return 1;
1307 }
1308
1309 for (p = ossl_predefined_providers; p->name != NULL; p++) {
1310 OSSL_PROVIDER *prov = NULL;
1311
1312 if (!p->is_fallback)
1313 continue;
1314 /*
1315 * We use the internal constructor directly here,
1316 * otherwise we get a call loop
1317 */
1318 prov = provider_new(p->name, p->init, NULL);
1319 if (prov == NULL)
1320 goto err;
1321 prov->libctx = store->libctx;
1322#ifndef FIPS_MODULE
1323 prov->error_lib = ERR_get_next_error_library();
1324#endif
1325
1326 /*
1327 * We are calling provider_activate while holding the store lock. This
1328 * means the init function will be called while holding a lock. Normally
1329 * we try to avoid calling a user callback while holding a lock.
1330 * However, fallbacks are never third party providers so we accept this.
1331 */
1332 if (provider_activate(prov, 0, 0) < 0) {
1333 ossl_provider_free(prov);
1334 goto err;
1335 }
1336 prov->store = store;
1337 if (sk_OSSL_PROVIDER_push(store->providers, prov) == 0) {
1338 ossl_provider_free(prov);
1339 goto err;
1340 }
1341 activated_fallback_count++;
1342 }
1343
1344 if (activated_fallback_count > 0) {
1345 store->use_fallbacks = 0;
1346 ret = 1;
1347 }
1348 err:
1349 CRYPTO_THREAD_unlock(store->lock);
1350 return ret;
1351}
1352
1353int ossl_provider_doall_activated(OSSL_LIB_CTX *ctx,
1354 int (*cb)(OSSL_PROVIDER *provider,
1355 void *cbdata),
1356 void *cbdata)
1357{
1358 int ret = 0, curr, max, ref = 0;
1359 struct provider_store_st *store = get_provider_store(ctx);
1360 STACK_OF(OSSL_PROVIDER) *provs = NULL;
1361
1362#if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_AUTOLOAD_CONFIG)
1363 /*
1364 * Make sure any providers are loaded from config before we try to use
1365 * them.
1366 */
1367 if (ossl_lib_ctx_is_default(ctx))
1368 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
1369#endif
1370
1371 if (store == NULL)
1372 return 1;
1373 if (!provider_activate_fallbacks(store))
1374 return 0;
1375
1376 /*
1377 * Under lock, grab a copy of the provider list and up_ref each
1378 * provider so that they don't disappear underneath us.
1379 */
1380 if (!CRYPTO_THREAD_read_lock(store->lock))
1381 return 0;
1382 provs = sk_OSSL_PROVIDER_dup(store->providers);
1383 if (provs == NULL) {
1384 CRYPTO_THREAD_unlock(store->lock);
1385 return 0;
1386 }
1387 max = sk_OSSL_PROVIDER_num(provs);
1388 /*
1389 * We work backwards through the stack so that we can safely delete items
1390 * as we go.
1391 */
1392 for (curr = max - 1; curr >= 0; curr--) {
1393 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
1394
1395 if (!CRYPTO_THREAD_write_lock(prov->flag_lock))
1396 goto err_unlock;
1397 if (prov->flag_activated) {
1398 /*
1399 * We call CRYPTO_UP_REF directly rather than ossl_provider_up_ref
1400 * to avoid upping the ref count on the parent provider, which we
1401 * must not do while holding locks.
1402 */
1403 if (CRYPTO_UP_REF(&prov->refcnt, &ref, prov->refcnt_lock) <= 0) {
1404 CRYPTO_THREAD_unlock(prov->flag_lock);
1405 goto err_unlock;
1406 }
1407 /*
1408 * It's already activated, but we up the activated count to ensure
1409 * it remains activated until after we've called the user callback.
1410 * We do this with no locking (because we already hold the locks)
1411 * and no upcalls (which must not be called when locks are held). In
1412 * theory this could mean the parent provider goes inactive, whilst
1413 * still activated in the child for a short period. That's ok.
1414 */
1415 if (provider_activate(prov, 0, 0) < 0) {
1416 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
1417 CRYPTO_THREAD_unlock(prov->flag_lock);
1418 goto err_unlock;
1419 }
1420 } else {
1421 sk_OSSL_PROVIDER_delete(provs, curr);
1422 max--;
1423 }
1424 CRYPTO_THREAD_unlock(prov->flag_lock);
1425 }
1426 CRYPTO_THREAD_unlock(store->lock);
1427
1428 /*
1429 * Now, we sweep through all providers not under lock
1430 */
1431 for (curr = 0; curr < max; curr++) {
1432 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
1433
1434 if (!cb(prov, cbdata)) {
1435 curr = -1;
1436 goto finish;
1437 }
1438 }
1439 curr = -1;
1440
1441 ret = 1;
1442 goto finish;
1443
1444 err_unlock:
1445 CRYPTO_THREAD_unlock(store->lock);
1446 finish:
1447 /*
1448 * The pop_free call doesn't do what we want on an error condition. We
1449 * either start from the first item in the stack, or part way through if
1450 * we only processed some of the items.
1451 */
1452 for (curr++; curr < max; curr++) {
1453 OSSL_PROVIDER *prov = sk_OSSL_PROVIDER_value(provs, curr);
1454
1455 provider_deactivate(prov, 0, 1);
1456 /*
1457 * As above where we did the up-ref, we don't call ossl_provider_free
1458 * to avoid making upcalls. There should always be at least one ref
1459 * to the provider in the store, so this should never drop to 0.
1460 */
1461 CRYPTO_DOWN_REF(&prov->refcnt, &ref, prov->refcnt_lock);
1462 /*
1463 * Not much we can do if this assert ever fails. So we don't use
1464 * ossl_assert here.
1465 */
1466 assert(ref > 0);
1467 }
1468 sk_OSSL_PROVIDER_free(provs);
1469 return ret;
1470}
1471
1472int OSSL_PROVIDER_available(OSSL_LIB_CTX *libctx, const char *name)
1473{
1474 OSSL_PROVIDER *prov = NULL;
1475 int available = 0;
1476 struct provider_store_st *store = get_provider_store(libctx);
1477
1478 if (store == NULL || !provider_activate_fallbacks(store))
1479 return 0;
1480
1481 prov = ossl_provider_find(libctx, name, 0);
1482 if (prov != NULL) {
1483 if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
1484 return 0;
1485 available = prov->flag_activated;
1486 CRYPTO_THREAD_unlock(prov->flag_lock);
1487 ossl_provider_free(prov);
1488 }
1489 return available;
1490}
1491
1492/* Getters of Provider Object data */
1493const char *ossl_provider_name(const OSSL_PROVIDER *prov)
1494{
1495 return prov->name;
1496}
1497
1498const DSO *ossl_provider_dso(const OSSL_PROVIDER *prov)
1499{
1500 return prov->module;
1501}
1502
1503const char *ossl_provider_module_name(const OSSL_PROVIDER *prov)
1504{
1505#ifdef FIPS_MODULE
1506 return NULL;
1507#else
1508 return DSO_get_filename(prov->module);
1509#endif
1510}
1511
1512const char *ossl_provider_module_path(const OSSL_PROVIDER *prov)
1513{
1514#ifdef FIPS_MODULE
1515 return NULL;
1516#else
1517 /* FIXME: Ensure it's a full path */
1518 return DSO_get_filename(prov->module);
1519#endif
1520}
1521
1522void *ossl_provider_prov_ctx(const OSSL_PROVIDER *prov)
1523{
1524 if (prov != NULL)
1525 return prov->provctx;
1526
1527 return NULL;
1528}
1529
1530const OSSL_DISPATCH *ossl_provider_get0_dispatch(const OSSL_PROVIDER *prov)
1531{
1532 if (prov != NULL)
1533 return prov->dispatch;
1534
1535 return NULL;
1536}
1537
1538OSSL_LIB_CTX *ossl_provider_libctx(const OSSL_PROVIDER *prov)
1539{
1540 return prov != NULL ? prov->libctx : NULL;
1541}
1542
1543/* Wrappers around calls to the provider */
1544void ossl_provider_teardown(const OSSL_PROVIDER *prov)
1545{
1546 if (prov->teardown != NULL
1547#ifndef FIPS_MODULE
1548 && !prov->ischild
1549#endif
1550 )
1551 prov->teardown(prov->provctx);
1552}
1553
1554const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov)
1555{
1556 return prov->gettable_params == NULL
1557 ? NULL : prov->gettable_params(prov->provctx);
1558}
1559
1560int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
1561{
1562 return prov->get_params == NULL
1563 ? 0 : prov->get_params(prov->provctx, params);
1564}
1565
1566int ossl_provider_self_test(const OSSL_PROVIDER *prov)
1567{
1568 int ret;
1569
1570 if (prov->self_test == NULL)
1571 return 1;
1572 ret = prov->self_test(prov->provctx);
1573 if (ret == 0)
1574 (void)provider_remove_store_methods((OSSL_PROVIDER *)prov);
1575 return ret;
1576}
1577
1578int ossl_provider_get_capabilities(const OSSL_PROVIDER *prov,
1579 const char *capability,
1580 OSSL_CALLBACK *cb,
1581 void *arg)
1582{
1583 return prov->get_capabilities == NULL
1584 ? 1 : prov->get_capabilities(prov->provctx, capability, cb, arg);
1585}
1586
1587const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov,
1588 int operation_id,
1589 int *no_cache)
1590{
1591 const OSSL_ALGORITHM *res;
1592
1593 if (prov->query_operation == NULL)
1594 return NULL;
1595 res = prov->query_operation(prov->provctx, operation_id, no_cache);
1596#if defined(OPENSSL_NO_CACHED_FETCH)
1597 /* Forcing the non-caching of queries */
1598 if (no_cache != NULL)
1599 *no_cache = 1;
1600#endif
1601 return res;
1602}
1603
1604void ossl_provider_unquery_operation(const OSSL_PROVIDER *prov,
1605 int operation_id,
1606 const OSSL_ALGORITHM *algs)
1607{
1608 if (prov->unquery_operation != NULL)
1609 prov->unquery_operation(prov->provctx, operation_id, algs);
1610}
1611
1612int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum)
1613{
1614 size_t byte = bitnum / 8;
1615 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
1616
1617 if (!CRYPTO_THREAD_write_lock(provider->opbits_lock))
1618 return 0;
1619 if (provider->operation_bits_sz <= byte) {
1620 unsigned char *tmp = OPENSSL_realloc(provider->operation_bits,
1621 byte + 1);
1622
1623 if (tmp == NULL) {
1624 CRYPTO_THREAD_unlock(provider->opbits_lock);
1625 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
1626 return 0;
1627 }
1628 provider->operation_bits = tmp;
1629 memset(provider->operation_bits + provider->operation_bits_sz,
1630 '\0', byte + 1 - provider->operation_bits_sz);
1631 provider->operation_bits_sz = byte + 1;
1632 }
1633 provider->operation_bits[byte] |= bit;
1634 CRYPTO_THREAD_unlock(provider->opbits_lock);
1635 return 1;
1636}
1637
1638int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum,
1639 int *result)
1640{
1641 size_t byte = bitnum / 8;
1642 unsigned char bit = (1 << (bitnum % 8)) & 0xFF;
1643
1644 if (!ossl_assert(result != NULL)) {
1645 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
1646 return 0;
1647 }
1648
1649 *result = 0;
1650 if (!CRYPTO_THREAD_read_lock(provider->opbits_lock))
1651 return 0;
1652 if (provider->operation_bits_sz > byte)
1653 *result = ((provider->operation_bits[byte] & bit) != 0);
1654 CRYPTO_THREAD_unlock(provider->opbits_lock);
1655 return 1;
1656}
1657
1658#ifndef FIPS_MODULE
1659const OSSL_CORE_HANDLE *ossl_provider_get_parent(OSSL_PROVIDER *prov)
1660{
1661 return prov->handle;
1662}
1663
1664int ossl_provider_is_child(const OSSL_PROVIDER *prov)
1665{
1666 return prov->ischild;
1667}
1668
1669int ossl_provider_set_child(OSSL_PROVIDER *prov, const OSSL_CORE_HANDLE *handle)
1670{
1671 prov->handle = handle;
1672 prov->ischild = 1;
1673
1674 return 1;
1675}
1676
1677int ossl_provider_default_props_update(OSSL_LIB_CTX *libctx, const char *props)
1678{
1679#ifndef FIPS_MODULE
1680 struct provider_store_st *store = NULL;
1681 int i, max;
1682 OSSL_PROVIDER_CHILD_CB *child_cb;
1683
1684 if ((store = get_provider_store(libctx)) == NULL)
1685 return 0;
1686
1687 if (!CRYPTO_THREAD_read_lock(store->lock))
1688 return 0;
1689
1690 max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
1691 for (i = 0; i < max; i++) {
1692 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
1693 child_cb->global_props_cb(props, child_cb->cbdata);
1694 }
1695
1696 CRYPTO_THREAD_unlock(store->lock);
1697#endif
1698 return 1;
1699}
1700
1701static int ossl_provider_register_child_cb(const OSSL_CORE_HANDLE *handle,
1702 int (*create_cb)(
1703 const OSSL_CORE_HANDLE *provider,
1704 void *cbdata),
1705 int (*remove_cb)(
1706 const OSSL_CORE_HANDLE *provider,
1707 void *cbdata),
1708 int (*global_props_cb)(
1709 const char *props,
1710 void *cbdata),
1711 void *cbdata)
1712{
1713 /*
1714 * This is really an OSSL_PROVIDER that we created and cast to
1715 * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
1716 */
1717 OSSL_PROVIDER *thisprov = (OSSL_PROVIDER *)handle;
1718 OSSL_PROVIDER *prov;
1719 OSSL_LIB_CTX *libctx = thisprov->libctx;
1720 struct provider_store_st *store = NULL;
1721 int ret = 0, i, max;
1722 OSSL_PROVIDER_CHILD_CB *child_cb;
1723 char *propsstr = NULL;
1724
1725 if ((store = get_provider_store(libctx)) == NULL)
1726 return 0;
1727
1728 child_cb = OPENSSL_malloc(sizeof(*child_cb));
1729 if (child_cb == NULL)
1730 return 0;
1731 child_cb->prov = thisprov;
1732 child_cb->create_cb = create_cb;
1733 child_cb->remove_cb = remove_cb;
1734 child_cb->global_props_cb = global_props_cb;
1735 child_cb->cbdata = cbdata;
1736
1737 if (!CRYPTO_THREAD_write_lock(store->lock)) {
1738 OPENSSL_free(child_cb);
1739 return 0;
1740 }
1741 propsstr = evp_get_global_properties_str(libctx, 0);
1742
1743 if (propsstr != NULL) {
1744 global_props_cb(propsstr, cbdata);
1745 OPENSSL_free(propsstr);
1746 }
1747 max = sk_OSSL_PROVIDER_num(store->providers);
1748 for (i = 0; i < max; i++) {
1749 int activated;
1750
1751 prov = sk_OSSL_PROVIDER_value(store->providers, i);
1752
1753 if (!CRYPTO_THREAD_read_lock(prov->flag_lock))
1754 break;
1755 activated = prov->flag_activated;
1756 CRYPTO_THREAD_unlock(prov->flag_lock);
1757 /*
1758 * We hold the store lock while calling the user callback. This means
1759 * that the user callback must be short and simple and not do anything
1760 * likely to cause a deadlock. We don't hold the flag_lock during this
1761 * call. In theory this means that another thread could deactivate it
1762 * while we are calling create. This is ok because the other thread
1763 * will also call remove_cb, but won't be able to do so until we release
1764 * the store lock.
1765 */
1766 if (activated && !create_cb((OSSL_CORE_HANDLE *)prov, cbdata))
1767 break;
1768 }
1769 if (i == max) {
1770 /* Success */
1771 ret = sk_OSSL_PROVIDER_CHILD_CB_push(store->child_cbs, child_cb);
1772 }
1773 if (i != max || ret <= 0) {
1774 /* Failed during creation. Remove everything we just added */
1775 for (; i >= 0; i--) {
1776 prov = sk_OSSL_PROVIDER_value(store->providers, i);
1777 remove_cb((OSSL_CORE_HANDLE *)prov, cbdata);
1778 }
1779 OPENSSL_free(child_cb);
1780 ret = 0;
1781 }
1782 CRYPTO_THREAD_unlock(store->lock);
1783
1784 return ret;
1785}
1786
1787static void ossl_provider_deregister_child_cb(const OSSL_CORE_HANDLE *handle)
1788{
1789 /*
1790 * This is really an OSSL_PROVIDER that we created and cast to
1791 * OSSL_CORE_HANDLE originally. Therefore it is safe to cast it back.
1792 */
1793 OSSL_PROVIDER *thisprov = (OSSL_PROVIDER *)handle;
1794 OSSL_LIB_CTX *libctx = thisprov->libctx;
1795 struct provider_store_st *store = NULL;
1796 int i, max;
1797 OSSL_PROVIDER_CHILD_CB *child_cb;
1798
1799 if ((store = get_provider_store(libctx)) == NULL)
1800 return;
1801
1802 if (!CRYPTO_THREAD_write_lock(store->lock))
1803 return;
1804 max = sk_OSSL_PROVIDER_CHILD_CB_num(store->child_cbs);
1805 for (i = 0; i < max; i++) {
1806 child_cb = sk_OSSL_PROVIDER_CHILD_CB_value(store->child_cbs, i);
1807 if (child_cb->prov == thisprov) {
1808 /* Found an entry */
1809 sk_OSSL_PROVIDER_CHILD_CB_delete(store->child_cbs, i);
1810 OPENSSL_free(child_cb);
1811 break;
1812 }
1813 }
1814 CRYPTO_THREAD_unlock(store->lock);
1815}
1816#endif
1817
1818/*-
1819 * Core functions for the provider
1820 * ===============================
1821 *
1822 * This is the set of functions that the core makes available to the provider
1823 */
1824
1825/*
1826 * This returns a list of Provider Object parameters with their types, for
1827 * discovery. We do not expect that many providers will use this, but one
1828 * never knows.
1829 */
1830static const OSSL_PARAM param_types[] = {
1831 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
1832 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_PROV_NAME, OSSL_PARAM_UTF8_PTR,
1833 NULL, 0),
1834#ifndef FIPS_MODULE
1835 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_CORE_MODULE_FILENAME, OSSL_PARAM_UTF8_PTR,
1836 NULL, 0),
1837#endif
1838 OSSL_PARAM_END
1839};
1840
1841/*
1842 * Forward declare all the functions that are provided aa dispatch.
1843 * This ensures that the compiler will complain if they aren't defined
1844 * with the correct signature.
1845 */
1846static OSSL_FUNC_core_gettable_params_fn core_gettable_params;
1847static OSSL_FUNC_core_get_params_fn core_get_params;
1848static OSSL_FUNC_core_get_libctx_fn core_get_libctx;
1849static OSSL_FUNC_core_thread_start_fn core_thread_start;
1850#ifndef FIPS_MODULE
1851static OSSL_FUNC_core_new_error_fn core_new_error;
1852static OSSL_FUNC_core_set_error_debug_fn core_set_error_debug;
1853static OSSL_FUNC_core_vset_error_fn core_vset_error;
1854static OSSL_FUNC_core_set_error_mark_fn core_set_error_mark;
1855static OSSL_FUNC_core_clear_last_error_mark_fn core_clear_last_error_mark;
1856static OSSL_FUNC_core_pop_error_to_mark_fn core_pop_error_to_mark;
1857OSSL_FUNC_BIO_new_file_fn ossl_core_bio_new_file;
1858OSSL_FUNC_BIO_new_membuf_fn ossl_core_bio_new_mem_buf;
1859OSSL_FUNC_BIO_read_ex_fn ossl_core_bio_read_ex;
1860OSSL_FUNC_BIO_write_ex_fn ossl_core_bio_write_ex;
1861OSSL_FUNC_BIO_gets_fn ossl_core_bio_gets;
1862OSSL_FUNC_BIO_puts_fn ossl_core_bio_puts;
1863OSSL_FUNC_BIO_up_ref_fn ossl_core_bio_up_ref;
1864OSSL_FUNC_BIO_free_fn ossl_core_bio_free;
1865OSSL_FUNC_BIO_vprintf_fn ossl_core_bio_vprintf;
1866OSSL_FUNC_BIO_vsnprintf_fn BIO_vsnprintf;
1867static OSSL_FUNC_self_test_cb_fn core_self_test_get_callback;
1868static OSSL_FUNC_get_entropy_fn rand_get_entropy;
1869static OSSL_FUNC_get_user_entropy_fn rand_get_user_entropy;
1870static OSSL_FUNC_cleanup_entropy_fn rand_cleanup_entropy;
1871static OSSL_FUNC_cleanup_user_entropy_fn rand_cleanup_user_entropy;
1872static OSSL_FUNC_get_nonce_fn rand_get_nonce;
1873static OSSL_FUNC_get_user_nonce_fn rand_get_user_nonce;
1874static OSSL_FUNC_cleanup_nonce_fn rand_cleanup_nonce;
1875static OSSL_FUNC_cleanup_user_nonce_fn rand_cleanup_user_nonce;
1876#endif
1877OSSL_FUNC_CRYPTO_malloc_fn CRYPTO_malloc;
1878OSSL_FUNC_CRYPTO_zalloc_fn CRYPTO_zalloc;
1879OSSL_FUNC_CRYPTO_free_fn CRYPTO_free;
1880OSSL_FUNC_CRYPTO_clear_free_fn CRYPTO_clear_free;
1881OSSL_FUNC_CRYPTO_realloc_fn CRYPTO_realloc;
1882OSSL_FUNC_CRYPTO_clear_realloc_fn CRYPTO_clear_realloc;
1883OSSL_FUNC_CRYPTO_secure_malloc_fn CRYPTO_secure_malloc;
1884OSSL_FUNC_CRYPTO_secure_zalloc_fn CRYPTO_secure_zalloc;
1885OSSL_FUNC_CRYPTO_secure_free_fn CRYPTO_secure_free;
1886OSSL_FUNC_CRYPTO_secure_clear_free_fn CRYPTO_secure_clear_free;
1887OSSL_FUNC_CRYPTO_secure_allocated_fn CRYPTO_secure_allocated;
1888OSSL_FUNC_OPENSSL_cleanse_fn OPENSSL_cleanse;
1889#ifndef FIPS_MODULE
1890OSSL_FUNC_provider_register_child_cb_fn ossl_provider_register_child_cb;
1891OSSL_FUNC_provider_deregister_child_cb_fn ossl_provider_deregister_child_cb;
1892static OSSL_FUNC_provider_name_fn core_provider_get0_name;
1893static OSSL_FUNC_provider_get0_provider_ctx_fn core_provider_get0_provider_ctx;
1894static OSSL_FUNC_provider_get0_dispatch_fn core_provider_get0_dispatch;
1895static OSSL_FUNC_provider_up_ref_fn core_provider_up_ref_intern;
1896static OSSL_FUNC_provider_free_fn core_provider_free_intern;
1897static OSSL_FUNC_core_obj_add_sigid_fn core_obj_add_sigid;
1898static OSSL_FUNC_core_obj_create_fn core_obj_create;
1899#endif
1900
1901static const OSSL_PARAM *core_gettable_params(const OSSL_CORE_HANDLE *handle)
1902{
1903 return param_types;
1904}
1905
1906static int core_get_params(const OSSL_CORE_HANDLE *handle, OSSL_PARAM params[])
1907{
1908 int i;
1909 OSSL_PARAM *p;
1910 /*
1911 * We created this object originally and we know it is actually an
1912 * OSSL_PROVIDER *, so the cast is safe
1913 */
1914 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1915
1916 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_VERSION)) != NULL)
1917 OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR);
1918 if ((p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_CORE_PROV_NAME)) != NULL)
1919 OSSL_PARAM_set_utf8_ptr(p, prov->name);
1920
1921#ifndef FIPS_MODULE
1922 if ((p = OSSL_PARAM_locate(params,
1923 OSSL_PROV_PARAM_CORE_MODULE_FILENAME)) != NULL)
1924 OSSL_PARAM_set_utf8_ptr(p, ossl_provider_module_path(prov));
1925#endif
1926
1927 if (prov->parameters == NULL)
1928 return 1;
1929
1930 for (i = 0; i < sk_INFOPAIR_num(prov->parameters); i++) {
1931 INFOPAIR *pair = sk_INFOPAIR_value(prov->parameters, i);
1932
1933 if ((p = OSSL_PARAM_locate(params, pair->name)) != NULL)
1934 OSSL_PARAM_set_utf8_ptr(p, pair->value);
1935 }
1936 return 1;
1937}
1938
1939static OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle)
1940{
1941 /*
1942 * We created this object originally and we know it is actually an
1943 * OSSL_PROVIDER *, so the cast is safe
1944 */
1945 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1946
1947 /*
1948 * Using ossl_provider_libctx would be wrong as that returns
1949 * NULL for |prov| == NULL and NULL libctx has a special meaning
1950 * that does not apply here. Here |prov| == NULL can happen only in
1951 * case of a coding error.
1952 */
1953 assert(prov != NULL);
1954 return (OPENSSL_CORE_CTX *)prov->libctx;
1955}
1956
1957static int core_thread_start(const OSSL_CORE_HANDLE *handle,
1958 OSSL_thread_stop_handler_fn handfn,
1959 void *arg)
1960{
1961 /*
1962 * We created this object originally and we know it is actually an
1963 * OSSL_PROVIDER *, so the cast is safe
1964 */
1965 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
1966
1967 return ossl_init_thread_start(prov, arg, handfn);
1968}
1969
1970/*
1971 * The FIPS module inner provider doesn't implement these. They aren't
1972 * needed there, since the FIPS module upcalls are always the outer provider
1973 * ones.
1974 */
1975#ifndef FIPS_MODULE
1976/*
1977 * These error functions should use |handle| to select the proper
1978 * library context to report in the correct error stack if error
1979 * stacks become tied to the library context.
1980 * We cannot currently do that since there's no support for it in the
1981 * ERR subsystem.
1982 */
1983static void core_new_error(const OSSL_CORE_HANDLE *handle)
1984{
1985 ERR_new();
1986}
1987
1988static void core_set_error_debug(const OSSL_CORE_HANDLE *handle,
1989 const char *file, int line, const char *func)
1990{
1991 ERR_set_debug(file, line, func);
1992}
1993
1994static void core_vset_error(const OSSL_CORE_HANDLE *handle,
1995 uint32_t reason, const char *fmt, va_list args)
1996{
1997 /*
1998 * We created this object originally and we know it is actually an
1999 * OSSL_PROVIDER *, so the cast is safe
2000 */
2001 OSSL_PROVIDER *prov = (OSSL_PROVIDER *)handle;
2002
2003 /*
2004 * If the uppermost 8 bits are non-zero, it's an OpenSSL library
2005 * error and will be treated as such. Otherwise, it's a new style
2006 * provider error and will be treated as such.
2007 */
2008 if (ERR_GET_LIB(reason) != 0) {
2009 ERR_vset_error(ERR_GET_LIB(reason), ERR_GET_REASON(reason), fmt, args);
2010 } else {
2011 ERR_vset_error(prov->error_lib, (int)reason, fmt, args);
2012 }
2013}
2014
2015static int core_set_error_mark(const OSSL_CORE_HANDLE *handle)
2016{
2017 return ERR_set_mark();
2018}
2019
2020static int core_clear_last_error_mark(const OSSL_CORE_HANDLE *handle)
2021{
2022 return ERR_clear_last_mark();
2023}
2024
2025static int core_pop_error_to_mark(const OSSL_CORE_HANDLE *handle)
2026{
2027 return ERR_pop_to_mark();
2028}
2029
2030static void core_self_test_get_callback(OPENSSL_CORE_CTX *libctx,
2031 OSSL_CALLBACK **cb, void **cbarg)
2032{
2033 OSSL_SELF_TEST_get_callback((OSSL_LIB_CTX *)libctx, cb, cbarg);
2034}
2035
2036static size_t rand_get_entropy(const OSSL_CORE_HANDLE *handle,
2037 unsigned char **pout, int entropy,
2038 size_t min_len, size_t max_len)
2039{
2040 return ossl_rand_get_entropy((OSSL_LIB_CTX *)core_get_libctx(handle),
2041 pout, entropy, min_len, max_len);
2042}
2043
2044static size_t rand_get_user_entropy(const OSSL_CORE_HANDLE *handle,
2045 unsigned char **pout, int entropy,
2046 size_t min_len, size_t max_len)
2047{
2048 return ossl_rand_get_user_entropy((OSSL_LIB_CTX *)core_get_libctx(handle),
2049 pout, entropy, min_len, max_len);
2050}
2051
2052static void rand_cleanup_entropy(const OSSL_CORE_HANDLE *handle,
2053 unsigned char *buf, size_t len)
2054{
2055 ossl_rand_cleanup_entropy((OSSL_LIB_CTX *)core_get_libctx(handle),
2056 buf, len);
2057}
2058
2059static void rand_cleanup_user_entropy(const OSSL_CORE_HANDLE *handle,
2060 unsigned char *buf, size_t len)
2061{
2062 ossl_rand_cleanup_user_entropy((OSSL_LIB_CTX *)core_get_libctx(handle),
2063 buf, len);
2064}
2065
2066static size_t rand_get_nonce(const OSSL_CORE_HANDLE *handle,
2067 unsigned char **pout,
2068 size_t min_len, size_t max_len,
2069 const void *salt, size_t salt_len)
2070{
2071 return ossl_rand_get_nonce((OSSL_LIB_CTX *)core_get_libctx(handle),
2072 pout, min_len, max_len, salt, salt_len);
2073}
2074
2075static size_t rand_get_user_nonce(const OSSL_CORE_HANDLE *handle,
2076 unsigned char **pout,
2077 size_t min_len, size_t max_len,
2078 const void *salt, size_t salt_len)
2079{
2080 return ossl_rand_get_user_nonce((OSSL_LIB_CTX *)core_get_libctx(handle),
2081 pout, min_len, max_len, salt, salt_len);
2082}
2083
2084static void rand_cleanup_nonce(const OSSL_CORE_HANDLE *handle,
2085 unsigned char *buf, size_t len)
2086{
2087 ossl_rand_cleanup_nonce((OSSL_LIB_CTX *)core_get_libctx(handle),
2088 buf, len);
2089}
2090
2091static void rand_cleanup_user_nonce(const OSSL_CORE_HANDLE *handle,
2092 unsigned char *buf, size_t len)
2093{
2094 ossl_rand_cleanup_user_nonce((OSSL_LIB_CTX *)core_get_libctx(handle),
2095 buf, len);
2096}
2097
2098static const char *core_provider_get0_name(const OSSL_CORE_HANDLE *prov)
2099{
2100 return OSSL_PROVIDER_get0_name((const OSSL_PROVIDER *)prov);
2101}
2102
2103static void *core_provider_get0_provider_ctx(const OSSL_CORE_HANDLE *prov)
2104{
2105 return OSSL_PROVIDER_get0_provider_ctx((const OSSL_PROVIDER *)prov);
2106}
2107
2108static const OSSL_DISPATCH *
2109core_provider_get0_dispatch(const OSSL_CORE_HANDLE *prov)
2110{
2111 return OSSL_PROVIDER_get0_dispatch((const OSSL_PROVIDER *)prov);
2112}
2113
2114static int core_provider_up_ref_intern(const OSSL_CORE_HANDLE *prov,
2115 int activate)
2116{
2117 return provider_up_ref_intern((OSSL_PROVIDER *)prov, activate);
2118}
2119
2120static int core_provider_free_intern(const OSSL_CORE_HANDLE *prov,
2121 int deactivate)
2122{
2123 return provider_free_intern((OSSL_PROVIDER *)prov, deactivate);
2124}
2125
2126static int core_obj_add_sigid(const OSSL_CORE_HANDLE *prov,
2127 const char *sign_name, const char *digest_name,
2128 const char *pkey_name)
2129{
2130 int sign_nid = OBJ_txt2nid(sign_name);
2131 int digest_nid = NID_undef;
2132 int pkey_nid = OBJ_txt2nid(pkey_name);
2133
2134 if (digest_name != NULL && digest_name[0] != '\0'
2135 && (digest_nid = OBJ_txt2nid(digest_name)) == NID_undef)
2136 return 0;
2137
2138 if (sign_nid == NID_undef)
2139 return 0;
2140
2141 /*
2142 * Check if it already exists. This is a success if so (even if we don't
2143 * have nids for the digest/pkey)
2144 */
2145 if (OBJ_find_sigid_algs(sign_nid, NULL, NULL))
2146 return 1;
2147
2148 if (pkey_nid == NID_undef)
2149 return 0;
2150
2151 return OBJ_add_sigid(sign_nid, digest_nid, pkey_nid);
2152}
2153
2154static int core_obj_create(const OSSL_CORE_HANDLE *prov, const char *oid,
2155 const char *sn, const char *ln)
2156{
2157 /* Check if it already exists and create it if not */
2158 return OBJ_txt2nid(oid) != NID_undef
2159 || OBJ_create(oid, sn, ln) != NID_undef;
2160}
2161#endif /* FIPS_MODULE */
2162
2163/*
2164 * Functions provided by the core.
2165 */
2166static const OSSL_DISPATCH core_dispatch_[] = {
2167 { OSSL_FUNC_CORE_GETTABLE_PARAMS, (void (*)(void))core_gettable_params },
2168 { OSSL_FUNC_CORE_GET_PARAMS, (void (*)(void))core_get_params },
2169 { OSSL_FUNC_CORE_GET_LIBCTX, (void (*)(void))core_get_libctx },
2170 { OSSL_FUNC_CORE_THREAD_START, (void (*)(void))core_thread_start },
2171#ifndef FIPS_MODULE
2172 { OSSL_FUNC_CORE_NEW_ERROR, (void (*)(void))core_new_error },
2173 { OSSL_FUNC_CORE_SET_ERROR_DEBUG, (void (*)(void))core_set_error_debug },
2174 { OSSL_FUNC_CORE_VSET_ERROR, (void (*)(void))core_vset_error },
2175 { OSSL_FUNC_CORE_SET_ERROR_MARK, (void (*)(void))core_set_error_mark },
2176 { OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK,
2177 (void (*)(void))core_clear_last_error_mark },
2178 { OSSL_FUNC_CORE_POP_ERROR_TO_MARK, (void (*)(void))core_pop_error_to_mark },
2179 { OSSL_FUNC_BIO_NEW_FILE, (void (*)(void))ossl_core_bio_new_file },
2180 { OSSL_FUNC_BIO_NEW_MEMBUF, (void (*)(void))ossl_core_bio_new_mem_buf },
2181 { OSSL_FUNC_BIO_READ_EX, (void (*)(void))ossl_core_bio_read_ex },
2182 { OSSL_FUNC_BIO_WRITE_EX, (void (*)(void))ossl_core_bio_write_ex },
2183 { OSSL_FUNC_BIO_GETS, (void (*)(void))ossl_core_bio_gets },
2184 { OSSL_FUNC_BIO_PUTS, (void (*)(void))ossl_core_bio_puts },
2185 { OSSL_FUNC_BIO_CTRL, (void (*)(void))ossl_core_bio_ctrl },
2186 { OSSL_FUNC_BIO_UP_REF, (void (*)(void))ossl_core_bio_up_ref },
2187 { OSSL_FUNC_BIO_FREE, (void (*)(void))ossl_core_bio_free },
2188 { OSSL_FUNC_BIO_VPRINTF, (void (*)(void))ossl_core_bio_vprintf },
2189 { OSSL_FUNC_BIO_VSNPRINTF, (void (*)(void))BIO_vsnprintf },
2190 { OSSL_FUNC_SELF_TEST_CB, (void (*)(void))core_self_test_get_callback },
2191 { OSSL_FUNC_GET_ENTROPY, (void (*)(void))rand_get_entropy },
2192 { OSSL_FUNC_GET_USER_ENTROPY, (void (*)(void))rand_get_user_entropy },
2193 { OSSL_FUNC_CLEANUP_ENTROPY, (void (*)(void))rand_cleanup_entropy },
2194 { OSSL_FUNC_CLEANUP_USER_ENTROPY, (void (*)(void))rand_cleanup_user_entropy },
2195 { OSSL_FUNC_GET_NONCE, (void (*)(void))rand_get_nonce },
2196 { OSSL_FUNC_GET_USER_NONCE, (void (*)(void))rand_get_user_nonce },
2197 { OSSL_FUNC_CLEANUP_NONCE, (void (*)(void))rand_cleanup_nonce },
2198 { OSSL_FUNC_CLEANUP_USER_NONCE, (void (*)(void))rand_cleanup_user_nonce },
2199#endif
2200 { OSSL_FUNC_CRYPTO_MALLOC, (void (*)(void))CRYPTO_malloc },
2201 { OSSL_FUNC_CRYPTO_ZALLOC, (void (*)(void))CRYPTO_zalloc },
2202 { OSSL_FUNC_CRYPTO_FREE, (void (*)(void))CRYPTO_free },
2203 { OSSL_FUNC_CRYPTO_CLEAR_FREE, (void (*)(void))CRYPTO_clear_free },
2204 { OSSL_FUNC_CRYPTO_REALLOC, (void (*)(void))CRYPTO_realloc },
2205 { OSSL_FUNC_CRYPTO_CLEAR_REALLOC, (void (*)(void))CRYPTO_clear_realloc },
2206 { OSSL_FUNC_CRYPTO_SECURE_MALLOC, (void (*)(void))CRYPTO_secure_malloc },
2207 { OSSL_FUNC_CRYPTO_SECURE_ZALLOC, (void (*)(void))CRYPTO_secure_zalloc },
2208 { OSSL_FUNC_CRYPTO_SECURE_FREE, (void (*)(void))CRYPTO_secure_free },
2209 { OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE,
2210 (void (*)(void))CRYPTO_secure_clear_free },
2211 { OSSL_FUNC_CRYPTO_SECURE_ALLOCATED,
2212 (void (*)(void))CRYPTO_secure_allocated },
2213 { OSSL_FUNC_OPENSSL_CLEANSE, (void (*)(void))OPENSSL_cleanse },
2214#ifndef FIPS_MODULE
2215 { OSSL_FUNC_PROVIDER_REGISTER_CHILD_CB,
2216 (void (*)(void))ossl_provider_register_child_cb },
2217 { OSSL_FUNC_PROVIDER_DEREGISTER_CHILD_CB,
2218 (void (*)(void))ossl_provider_deregister_child_cb },
2219 { OSSL_FUNC_PROVIDER_NAME,
2220 (void (*)(void))core_provider_get0_name },
2221 { OSSL_FUNC_PROVIDER_GET0_PROVIDER_CTX,
2222 (void (*)(void))core_provider_get0_provider_ctx },
2223 { OSSL_FUNC_PROVIDER_GET0_DISPATCH,
2224 (void (*)(void))core_provider_get0_dispatch },
2225 { OSSL_FUNC_PROVIDER_UP_REF,
2226 (void (*)(void))core_provider_up_ref_intern },
2227 { OSSL_FUNC_PROVIDER_FREE,
2228 (void (*)(void))core_provider_free_intern },
2229 { OSSL_FUNC_CORE_OBJ_ADD_SIGID, (void (*)(void))core_obj_add_sigid },
2230 { OSSL_FUNC_CORE_OBJ_CREATE, (void (*)(void))core_obj_create },
2231#endif
2232 { 0, NULL }
2233};
2234static const OSSL_DISPATCH *core_dispatch = core_dispatch_;
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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