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