2 * Copyright 2016-2022 The OpenSSL Project Authors. All Rights Reserved.
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
10 /* We need to use some engine deprecated APIs */
11 #define OPENSSL_SUPPRESS_DEPRECATED
13 #include "internal/e_os.h"
14 #include "crypto/cryptlib.h"
15 #include <openssl/err.h>
16 #include "crypto/rand.h"
17 #include "internal/bio.h"
18 #include <openssl/evp.h>
19 #include "crypto/evp.h"
20 #include "internal/conf.h"
21 #include "crypto/async.h"
22 #include "crypto/engine.h"
23 #include "internal/comp.h"
24 #include "internal/err.h"
25 #include "crypto/err.h"
26 #include "crypto/objects.h"
29 #include "internal/thread_once.h"
30 #include "crypto/dso_conf.h"
31 #include "internal/dso.h"
32 #include "crypto/store.h"
33 #include <openssl/cmp_util.h> /* for OSSL_CMP_log_close() */
34 #include <openssl/trace.h>
35 #include "crypto/ctype.h"
37 static int stopped = 0;
38 static uint64_t optsdone = 0;
40 typedef struct ossl_init_stop_st OPENSSL_INIT_STOP;
41 struct ossl_init_stop_st {
42 void (*handler)(void);
43 OPENSSL_INIT_STOP *next;
46 static OPENSSL_INIT_STOP *stop_handlers = NULL;
47 /* Guards access to the optsdone variable on platforms without atomics */
48 static CRYPTO_RWLOCK *optsdone_lock = NULL;
49 /* Guards simultaneous INIT_LOAD_CONFIG calls with non-NULL settings */
50 static CRYPTO_RWLOCK *init_lock = NULL;
51 static CRYPTO_THREAD_LOCAL in_init_config_local;
53 static CRYPTO_ONCE base = CRYPTO_ONCE_STATIC_INIT;
54 static int base_inited = 0;
55 DEFINE_RUN_ONCE_STATIC(ossl_init_base)
57 /* no need to init trace */
59 OSSL_TRACE(INIT, "ossl_init_base: setting up stop handlers\n");
60 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
61 ossl_malloc_setup_failures();
64 if ((optsdone_lock = CRYPTO_THREAD_lock_new()) == NULL
65 || (init_lock = CRYPTO_THREAD_lock_new()) == NULL)
68 OPENSSL_cpuid_setup();
70 if (!ossl_init_thread())
73 if (!CRYPTO_THREAD_init_local(&in_init_config_local, NULL))
80 OSSL_TRACE(INIT, "ossl_init_base failed!\n");
81 CRYPTO_THREAD_lock_free(optsdone_lock);
83 CRYPTO_THREAD_lock_free(init_lock);
89 static CRYPTO_ONCE register_atexit = CRYPTO_ONCE_STATIC_INIT;
90 #if !defined(OPENSSL_SYS_UEFI) && defined(_WIN32)
91 static int win32atexit(void)
98 DEFINE_RUN_ONCE_STATIC(ossl_init_register_atexit)
100 #ifdef OPENSSL_INIT_DEBUG
101 fprintf(stderr, "OPENSSL_INIT: ossl_init_register_atexit()\n");
103 #ifndef OPENSSL_SYS_UEFI
104 # if defined(_WIN32) && !defined(__BORLANDC__)
105 /* We use _onexit() in preference because it gets called on DLL unload */
106 if (_onexit(win32atexit) == NULL)
109 if (atexit(OPENSSL_cleanup) != 0)
117 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_register_atexit,
118 ossl_init_register_atexit)
120 #ifdef OPENSSL_INIT_DEBUG
121 fprintf(stderr, "OPENSSL_INIT: ossl_init_no_register_atexit ok!\n");
123 /* Do nothing in this case */
127 static CRYPTO_ONCE load_crypto_nodelete = CRYPTO_ONCE_STATIC_INIT;
128 DEFINE_RUN_ONCE_STATIC(ossl_init_load_crypto_nodelete)
130 OSSL_TRACE(INIT, "ossl_init_load_crypto_nodelete()\n");
132 #if !defined(OPENSSL_USE_NODELETE) \
133 && !defined(OPENSSL_NO_PINSHARED)
134 # if defined(DSO_WIN32) && !defined(_WIN32_WCE)
136 HMODULE handle = NULL;
139 /* We don't use the DSO route for WIN32 because there is a better way */
140 ret = GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
141 | GET_MODULE_HANDLE_EX_FLAG_PIN,
142 (void *)&base_inited, &handle);
145 "ossl_init_load_crypto_nodelete: "
146 "obtained DSO reference? %s\n",
147 (ret == TRUE ? "No!" : "Yes."));
148 return (ret == TRUE) ? 1 : 0;
150 # elif !defined(DSO_NONE)
152 * Deliberately leak a reference to ourselves. This will force the library
153 * to remain loaded until the atexit() handler is run at process exit.
159 if (!err_shelve_state(&err))
162 dso = DSO_dsobyaddr(&base_inited, DSO_FLAG_NO_UNLOAD_ON_FREE);
164 * In case of No!, it is uncertain our exit()-handlers can still be
165 * called. After dlclose() the whole library might have been unloaded
168 OSSL_TRACE1(INIT, "obtained DSO reference? %s\n",
169 (dso == NULL ? "No!" : "Yes."));
171 err_unshelve_state(err);
179 static CRYPTO_ONCE load_crypto_strings = CRYPTO_ONCE_STATIC_INIT;
181 DEFINE_RUN_ONCE_STATIC(ossl_init_load_crypto_strings)
185 * OPENSSL_NO_AUTOERRINIT is provided here to prevent at compile time
186 * pulling in all the error strings during static linking
188 #if !defined(OPENSSL_NO_ERR) && !defined(OPENSSL_NO_AUTOERRINIT)
191 if (!err_shelve_state(&err))
194 OSSL_TRACE(INIT, "ossl_err_load_crypto_strings()\n");
195 ret = ossl_err_load_crypto_strings();
197 err_unshelve_state(err);
202 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_load_crypto_strings,
203 ossl_init_load_crypto_strings)
205 /* Do nothing in this case */
209 static CRYPTO_ONCE add_all_ciphers = CRYPTO_ONCE_STATIC_INIT;
210 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_ciphers)
213 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
214 * pulling in all the ciphers during static linking
216 #ifndef OPENSSL_NO_AUTOALGINIT
217 OSSL_TRACE(INIT, "openssl_add_all_ciphers_int()\n");
218 openssl_add_all_ciphers_int();
223 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_add_all_ciphers,
224 ossl_init_add_all_ciphers)
230 static CRYPTO_ONCE add_all_digests = CRYPTO_ONCE_STATIC_INIT;
231 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_digests)
234 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
235 * pulling in all the ciphers during static linking
237 #ifndef OPENSSL_NO_AUTOALGINIT
238 OSSL_TRACE(INIT, "openssl_add_all_digests()\n");
239 openssl_add_all_digests_int();
244 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_add_all_digests,
245 ossl_init_add_all_digests)
251 static CRYPTO_ONCE config = CRYPTO_ONCE_STATIC_INIT;
252 static int config_inited = 0;
253 static const OPENSSL_INIT_SETTINGS *conf_settings = NULL;
254 DEFINE_RUN_ONCE_STATIC(ossl_init_config)
256 int ret = ossl_config_int(NULL);
261 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_config_settings, ossl_init_config)
263 int ret = ossl_config_int(conf_settings);
268 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_config, ossl_init_config)
270 OSSL_TRACE(INIT, "ossl_no_config_int()\n");
271 ossl_no_config_int();
276 static CRYPTO_ONCE async = CRYPTO_ONCE_STATIC_INIT;
277 static int async_inited = 0;
278 DEFINE_RUN_ONCE_STATIC(ossl_init_async)
280 OSSL_TRACE(INIT, "async_init()\n");
287 #ifndef OPENSSL_NO_ENGINE
288 static CRYPTO_ONCE engine_openssl = CRYPTO_ONCE_STATIC_INIT;
289 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_openssl)
291 OSSL_TRACE(INIT, "engine_load_openssl_int()\n");
292 engine_load_openssl_int();
295 # ifndef OPENSSL_NO_RDRAND
296 static CRYPTO_ONCE engine_rdrand = CRYPTO_ONCE_STATIC_INIT;
297 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_rdrand)
299 OSSL_TRACE(INIT, "engine_load_rdrand_int()\n");
300 engine_load_rdrand_int();
304 static CRYPTO_ONCE engine_dynamic = CRYPTO_ONCE_STATIC_INIT;
305 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_dynamic)
307 OSSL_TRACE(INIT, "engine_load_dynamic_int()\n");
308 engine_load_dynamic_int();
311 # ifndef OPENSSL_NO_STATIC_ENGINE
312 # ifndef OPENSSL_NO_DEVCRYPTOENG
313 static CRYPTO_ONCE engine_devcrypto = CRYPTO_ONCE_STATIC_INIT;
314 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_devcrypto)
316 OSSL_TRACE(INIT, "engine_load_devcrypto_int()\n");
317 engine_load_devcrypto_int();
321 # if !defined(OPENSSL_NO_PADLOCKENG)
322 static CRYPTO_ONCE engine_padlock = CRYPTO_ONCE_STATIC_INIT;
323 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_padlock)
325 OSSL_TRACE(INIT, "engine_load_padlock_int()\n");
326 engine_load_padlock_int();
330 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
331 static CRYPTO_ONCE engine_capi = CRYPTO_ONCE_STATIC_INIT;
332 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_capi)
334 OSSL_TRACE(INIT, "engine_load_capi_int()\n");
335 engine_load_capi_int();
339 # if !defined(OPENSSL_NO_AFALGENG)
340 static CRYPTO_ONCE engine_afalg = CRYPTO_ONCE_STATIC_INIT;
341 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_afalg)
343 OSSL_TRACE(INIT, "engine_load_afalg_int()\n");
344 engine_load_afalg_int();
351 void OPENSSL_cleanup(void)
353 OPENSSL_INIT_STOP *currhandler, *lasthandler;
356 * At some point we should consider looking at this function with a view to
357 * moving most/all of this into onfree handlers in OSSL_LIB_CTX.
360 /* If we've not been inited then no need to deinit */
364 /* Might be explicitly called and also by atexit */
370 * Thread stop may not get automatically called by the thread library for
371 * the very last thread in some situations, so call it directly.
373 OPENSSL_thread_stop();
375 currhandler = stop_handlers;
376 while (currhandler != NULL) {
377 currhandler->handler();
378 lasthandler = currhandler;
379 currhandler = currhandler->next;
380 OPENSSL_free(lasthandler);
382 stop_handlers = NULL;
384 CRYPTO_THREAD_lock_free(optsdone_lock);
385 optsdone_lock = NULL;
386 CRYPTO_THREAD_lock_free(init_lock);
389 CRYPTO_THREAD_cleanup_local(&in_init_config_local);
392 * We assume we are single-threaded for this function, i.e. no race
393 * conditions for the various "*_inited" vars below.
396 #ifndef OPENSSL_NO_COMP
397 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_comp_zlib_cleanup()\n");
398 ossl_comp_zlib_cleanup();
399 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_comp_brotli_cleanup()\n");
400 ossl_comp_brotli_cleanup();
401 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_comp_zstd_cleanup()\n");
402 ossl_comp_zstd_cleanup();
406 OSSL_TRACE(INIT, "OPENSSL_cleanup: async_deinit()\n");
411 * Note that cleanup order is important:
412 * - ossl_rand_cleanup_int could call an ENGINE's RAND cleanup function so
413 * must be called before engine_cleanup_int()
414 * - ENGINEs use CRYPTO_EX_DATA and therefore, must be cleaned up
415 * before the ex data handlers are wiped during default ossl_lib_ctx deinit.
416 * - ossl_config_modules_free() can end up in ENGINE code so must be called
417 * before engine_cleanup_int()
418 * - ENGINEs and additional EVP algorithms might use added OIDs names so
419 * ossl_obj_cleanup_int() must be called last
421 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_rand_cleanup_int()\n");
422 ossl_rand_cleanup_int();
424 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_config_modules_free()\n");
425 ossl_config_modules_free();
427 #ifndef OPENSSL_NO_ENGINE
428 OSSL_TRACE(INIT, "OPENSSL_cleanup: engine_cleanup_int()\n");
429 engine_cleanup_int();
432 #ifndef OPENSSL_NO_DEPRECATED_3_0
433 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_store_cleanup_int()\n");
434 ossl_store_cleanup_int();
437 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_lib_ctx_default_deinit()\n");
438 ossl_lib_ctx_default_deinit();
440 ossl_cleanup_thread();
442 OSSL_TRACE(INIT, "OPENSSL_cleanup: bio_cleanup()\n");
445 OSSL_TRACE(INIT, "OPENSSL_cleanup: evp_cleanup_int()\n");
448 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_obj_cleanup_int()\n");
449 ossl_obj_cleanup_int();
451 OSSL_TRACE(INIT, "OPENSSL_cleanup: err_int()\n");
454 OSSL_TRACE(INIT, "OPENSSL_cleanup: CRYPTO_secure_malloc_done()\n");
455 CRYPTO_secure_malloc_done();
457 #ifndef OPENSSL_NO_CMP
458 OSSL_TRACE(INIT, "OPENSSL_cleanup: OSSL_CMP_log_close()\n");
459 OSSL_CMP_log_close();
462 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_trace_cleanup()\n");
463 ossl_trace_cleanup();
469 * If this function is called with a non NULL settings value then it must be
470 * called prior to any threads making calls to any OpenSSL functions,
471 * i.e. passing a non-null settings value is assumed to be single-threaded.
473 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings)
478 /* Applications depend on 0 being returned when cleanup was already done */
480 if (!(opts & OPENSSL_INIT_BASE_ONLY))
481 ERR_raise(ERR_LIB_CRYPTO, ERR_R_INIT_FAIL);
486 * We ignore failures from this function. It is probably because we are
487 * on a platform that doesn't support lockless atomic loads (we may not
488 * have created optsdone_lock yet so we can't use it). This is just an
489 * optimisation to skip the full checks in this function if we don't need
490 * to, so we carry on regardless in the event of failure.
492 * There could be a race here with other threads, so that optsdone has not
493 * been updated yet, even though the options have in fact been initialised.
494 * This doesn't matter - it just means we will run the full function
495 * unnecessarily - but all the critical code is contained in RUN_ONCE
496 * functions anyway so we are safe.
498 if (CRYPTO_atomic_load(&optsdone, &tmp, NULL)) {
499 if ((tmp & opts) == opts)
505 * At some point we should look at this function with a view to moving
506 * most/all of this into OSSL_LIB_CTX.
508 * When the caller specifies OPENSSL_INIT_BASE_ONLY, that should be the
509 * *only* option specified. With that option we return immediately after
510 * doing the requested limited initialization. Note that
511 * err_shelve_state() called by us via ossl_init_load_crypto_nodelete()
512 * re-enters OPENSSL_init_crypto() with OPENSSL_INIT_BASE_ONLY, but with
513 * base already initialized this is a harmless NOOP.
515 * If we remain the only caller of err_shelve_state() the recursion should
516 * perhaps be removed, but if in doubt, it can be left in place.
518 if (!RUN_ONCE(&base, ossl_init_base))
521 if (opts & OPENSSL_INIT_BASE_ONLY)
525 * optsdone_lock should definitely be set up now, so we can now repeat the
526 * same check from above but be sure that it will work even on platforms
527 * without lockless CRYPTO_atomic_load
530 if (!CRYPTO_atomic_load(&optsdone, &tmp, optsdone_lock))
532 if ((tmp & opts) == opts)
537 * Now we don't always set up exit handlers, the INIT_BASE_ONLY calls
538 * should not have the side-effect of setting up exit handlers, and
539 * therefore, this code block is below the INIT_BASE_ONLY-conditioned early
542 if ((opts & OPENSSL_INIT_NO_ATEXIT) != 0) {
543 if (!RUN_ONCE_ALT(®ister_atexit, ossl_init_no_register_atexit,
544 ossl_init_register_atexit))
546 } else if (!RUN_ONCE(®ister_atexit, ossl_init_register_atexit)) {
550 if (!RUN_ONCE(&load_crypto_nodelete, ossl_init_load_crypto_nodelete))
553 if ((opts & OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS)
554 && !RUN_ONCE_ALT(&load_crypto_strings,
555 ossl_init_no_load_crypto_strings,
556 ossl_init_load_crypto_strings))
559 if ((opts & OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
560 && !RUN_ONCE(&load_crypto_strings, ossl_init_load_crypto_strings))
563 if ((opts & OPENSSL_INIT_NO_ADD_ALL_CIPHERS)
564 && !RUN_ONCE_ALT(&add_all_ciphers, ossl_init_no_add_all_ciphers,
565 ossl_init_add_all_ciphers))
568 if ((opts & OPENSSL_INIT_ADD_ALL_CIPHERS)
569 && !RUN_ONCE(&add_all_ciphers, ossl_init_add_all_ciphers))
572 if ((opts & OPENSSL_INIT_NO_ADD_ALL_DIGESTS)
573 && !RUN_ONCE_ALT(&add_all_digests, ossl_init_no_add_all_digests,
574 ossl_init_add_all_digests))
577 if ((opts & OPENSSL_INIT_ADD_ALL_DIGESTS)
578 && !RUN_ONCE(&add_all_digests, ossl_init_add_all_digests))
581 if ((opts & OPENSSL_INIT_ATFORK)
582 && !openssl_init_fork_handlers())
585 if ((opts & OPENSSL_INIT_NO_LOAD_CONFIG)
586 && !RUN_ONCE_ALT(&config, ossl_init_no_config, ossl_init_config))
589 if (opts & OPENSSL_INIT_LOAD_CONFIG) {
590 int loading = CRYPTO_THREAD_get_local(&in_init_config_local) != NULL;
592 /* If called recursively from OBJ_ calls, just skip it. */
596 if (!CRYPTO_THREAD_set_local(&in_init_config_local, (void *)-1))
598 if (settings == NULL) {
599 ret = RUN_ONCE(&config, ossl_init_config);
601 if (!CRYPTO_THREAD_write_lock(init_lock))
603 conf_settings = settings;
604 ret = RUN_ONCE_ALT(&config, ossl_init_config_settings,
606 conf_settings = NULL;
607 CRYPTO_THREAD_unlock(init_lock);
615 if ((opts & OPENSSL_INIT_ASYNC)
616 && !RUN_ONCE(&async, ossl_init_async))
619 #ifndef OPENSSL_NO_ENGINE
620 if ((opts & OPENSSL_INIT_ENGINE_OPENSSL)
621 && !RUN_ONCE(&engine_openssl, ossl_init_engine_openssl))
623 # ifndef OPENSSL_NO_RDRAND
624 if ((opts & OPENSSL_INIT_ENGINE_RDRAND)
625 && !RUN_ONCE(&engine_rdrand, ossl_init_engine_rdrand))
628 if ((opts & OPENSSL_INIT_ENGINE_DYNAMIC)
629 && !RUN_ONCE(&engine_dynamic, ossl_init_engine_dynamic))
631 # ifndef OPENSSL_NO_STATIC_ENGINE
632 # ifndef OPENSSL_NO_DEVCRYPTOENG
633 if ((opts & OPENSSL_INIT_ENGINE_CRYPTODEV)
634 && !RUN_ONCE(&engine_devcrypto, ossl_init_engine_devcrypto))
637 # if !defined(OPENSSL_NO_PADLOCKENG)
638 if ((opts & OPENSSL_INIT_ENGINE_PADLOCK)
639 && !RUN_ONCE(&engine_padlock, ossl_init_engine_padlock))
642 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
643 if ((opts & OPENSSL_INIT_ENGINE_CAPI)
644 && !RUN_ONCE(&engine_capi, ossl_init_engine_capi))
647 # if !defined(OPENSSL_NO_AFALGENG)
648 if ((opts & OPENSSL_INIT_ENGINE_AFALG)
649 && !RUN_ONCE(&engine_afalg, ossl_init_engine_afalg))
653 if (opts & (OPENSSL_INIT_ENGINE_ALL_BUILTIN
654 | OPENSSL_INIT_ENGINE_OPENSSL
655 | OPENSSL_INIT_ENGINE_AFALG)) {
656 ENGINE_register_all_complete();
660 if (!CRYPTO_atomic_or(&optsdone, opts, &tmp, optsdone_lock))
666 int OPENSSL_atexit(void (*handler)(void))
668 OPENSSL_INIT_STOP *newhand;
670 #if !defined(OPENSSL_USE_NODELETE)\
671 && !defined(OPENSSL_NO_PINSHARED)
673 # if defined(DSO_WIN32) && !defined(_WIN32_WCE)
674 HMODULE handle = NULL;
681 handlersym.func = handler;
684 * We don't use the DSO route for WIN32 because there is a better
687 ret = GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
688 | GET_MODULE_HANDLE_EX_FLAG_PIN,
689 handlersym.sym, &handle);
693 # elif !defined(DSO_NONE)
695 * Deliberately leak a reference to the handler. This will force the
696 * library/code containing the handler to remain loaded until we run the
697 * atexit handler. If -znodelete has been used then this is
706 handlersym.func = handler;
709 dso = DSO_dsobyaddr(handlersym.sym, DSO_FLAG_NO_UNLOAD_ON_FREE);
710 /* See same code above in ossl_init_base() for an explanation. */
712 "atexit: obtained DSO reference? %s\n",
713 (dso == NULL ? "No!" : "Yes."));
720 if ((newhand = OPENSSL_malloc(sizeof(*newhand))) == NULL)
723 newhand->handler = handler;
724 newhand->next = stop_handlers;
725 stop_handlers = newhand;