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)
189 OSSL_TRACE(INIT
, "ossl_err_load_crypto_strings()\n");
190 ret
= ossl_err_load_crypto_strings();
195 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_load_crypto_strings
,
196 ossl_init_load_crypto_strings
)
198 /* Do nothing in this case */
202 static CRYPTO_ONCE add_all_ciphers
= CRYPTO_ONCE_STATIC_INIT
;
203 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_ciphers
)
206 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
207 * pulling in all the ciphers during static linking
209 #ifndef OPENSSL_NO_AUTOALGINIT
210 OSSL_TRACE(INIT
, "openssl_add_all_ciphers_int()\n");
211 openssl_add_all_ciphers_int();
216 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_add_all_ciphers
,
217 ossl_init_add_all_ciphers
)
223 static CRYPTO_ONCE add_all_digests
= CRYPTO_ONCE_STATIC_INIT
;
224 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_digests
)
227 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
228 * pulling in all the ciphers during static linking
230 #ifndef OPENSSL_NO_AUTOALGINIT
231 OSSL_TRACE(INIT
, "openssl_add_all_digests()\n");
232 openssl_add_all_digests_int();
237 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_add_all_digests
,
238 ossl_init_add_all_digests
)
244 static CRYPTO_ONCE config
= CRYPTO_ONCE_STATIC_INIT
;
245 static int config_inited
= 0;
246 static const OPENSSL_INIT_SETTINGS
*conf_settings
= NULL
;
247 DEFINE_RUN_ONCE_STATIC(ossl_init_config
)
249 int ret
= ossl_config_int(NULL
);
254 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_config_settings
, ossl_init_config
)
256 int ret
= ossl_config_int(conf_settings
);
261 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_config
, ossl_init_config
)
263 OSSL_TRACE(INIT
, "ossl_no_config_int()\n");
264 ossl_no_config_int();
269 static CRYPTO_ONCE async
= CRYPTO_ONCE_STATIC_INIT
;
270 static int async_inited
= 0;
271 DEFINE_RUN_ONCE_STATIC(ossl_init_async
)
273 OSSL_TRACE(INIT
, "async_init()\n");
280 #ifndef OPENSSL_NO_ENGINE
281 static CRYPTO_ONCE engine_openssl
= CRYPTO_ONCE_STATIC_INIT
;
282 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_openssl
)
284 OSSL_TRACE(INIT
, "engine_load_openssl_int()\n");
285 engine_load_openssl_int();
288 # ifndef OPENSSL_NO_RDRAND
289 static CRYPTO_ONCE engine_rdrand
= CRYPTO_ONCE_STATIC_INIT
;
290 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_rdrand
)
292 OSSL_TRACE(INIT
, "engine_load_rdrand_int()\n");
293 engine_load_rdrand_int();
297 static CRYPTO_ONCE engine_dynamic
= CRYPTO_ONCE_STATIC_INIT
;
298 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_dynamic
)
300 OSSL_TRACE(INIT
, "engine_load_dynamic_int()\n");
301 engine_load_dynamic_int();
304 # ifndef OPENSSL_NO_STATIC_ENGINE
305 # ifndef OPENSSL_NO_DEVCRYPTOENG
306 static CRYPTO_ONCE engine_devcrypto
= CRYPTO_ONCE_STATIC_INIT
;
307 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_devcrypto
)
309 OSSL_TRACE(INIT
, "engine_load_devcrypto_int()\n");
310 engine_load_devcrypto_int();
314 # if !defined(OPENSSL_NO_PADLOCKENG)
315 static CRYPTO_ONCE engine_padlock
= CRYPTO_ONCE_STATIC_INIT
;
316 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_padlock
)
318 OSSL_TRACE(INIT
, "engine_load_padlock_int()\n");
319 engine_load_padlock_int();
323 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
324 static CRYPTO_ONCE engine_capi
= CRYPTO_ONCE_STATIC_INIT
;
325 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_capi
)
327 OSSL_TRACE(INIT
, "engine_load_capi_int()\n");
328 engine_load_capi_int();
332 # if !defined(OPENSSL_NO_AFALGENG)
333 static CRYPTO_ONCE engine_afalg
= CRYPTO_ONCE_STATIC_INIT
;
334 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_afalg
)
336 OSSL_TRACE(INIT
, "engine_load_afalg_int()\n");
337 engine_load_afalg_int();
344 void OPENSSL_cleanup(void)
346 OPENSSL_INIT_STOP
*currhandler
, *lasthandler
;
349 * At some point we should consider looking at this function with a view to
350 * moving most/all of this into onfree handlers in OSSL_LIB_CTX.
353 /* If we've not been inited then no need to deinit */
357 /* Might be explicitly called and also by atexit */
363 * Thread stop may not get automatically called by the thread library for
364 * the very last thread in some situations, so call it directly.
366 OPENSSL_thread_stop();
368 currhandler
= stop_handlers
;
369 while (currhandler
!= NULL
) {
370 currhandler
->handler();
371 lasthandler
= currhandler
;
372 currhandler
= currhandler
->next
;
373 OPENSSL_free(lasthandler
);
375 stop_handlers
= NULL
;
377 CRYPTO_THREAD_lock_free(optsdone_lock
);
378 optsdone_lock
= NULL
;
379 CRYPTO_THREAD_lock_free(init_lock
);
382 CRYPTO_THREAD_cleanup_local(&in_init_config_local
);
385 * We assume we are single-threaded for this function, i.e. no race
386 * conditions for the various "*_inited" vars below.
389 #ifndef OPENSSL_NO_COMP
390 OSSL_TRACE(INIT
, "OPENSSL_cleanup: ossl_comp_zlib_cleanup()\n");
391 ossl_comp_zlib_cleanup();
395 OSSL_TRACE(INIT
, "OPENSSL_cleanup: async_deinit()\n");
400 * Note that cleanup order is important:
401 * - ossl_rand_cleanup_int could call an ENGINE's RAND cleanup function so
402 * must be called before engine_cleanup_int()
403 * - ENGINEs use CRYPTO_EX_DATA and therefore, must be cleaned up
404 * before the ex data handlers are wiped during default ossl_lib_ctx deinit.
405 * - ossl_config_modules_free() can end up in ENGINE code so must be called
406 * before engine_cleanup_int()
407 * - ENGINEs and additional EVP algorithms might use added OIDs names so
408 * ossl_obj_cleanup_int() must be called last
410 OSSL_TRACE(INIT
, "OPENSSL_cleanup: ossl_rand_cleanup_int()\n");
411 ossl_rand_cleanup_int();
413 OSSL_TRACE(INIT
, "OPENSSL_cleanup: ossl_config_modules_free()\n");
414 ossl_config_modules_free();
416 #ifndef OPENSSL_NO_ENGINE
417 OSSL_TRACE(INIT
, "OPENSSL_cleanup: engine_cleanup_int()\n");
418 engine_cleanup_int();
421 #ifndef OPENSSL_NO_DEPRECATED_3_0
422 OSSL_TRACE(INIT
, "OPENSSL_cleanup: ossl_store_cleanup_int()\n");
423 ossl_store_cleanup_int();
426 OSSL_TRACE(INIT
, "OPENSSL_cleanup: ossl_lib_ctx_default_deinit()\n");
427 ossl_lib_ctx_default_deinit();
429 ossl_cleanup_thread();
431 OSSL_TRACE(INIT
, "OPENSSL_cleanup: bio_cleanup()\n");
434 OSSL_TRACE(INIT
, "OPENSSL_cleanup: evp_cleanup_int()\n");
437 OSSL_TRACE(INIT
, "OPENSSL_cleanup: ossl_obj_cleanup_int()\n");
438 ossl_obj_cleanup_int();
440 OSSL_TRACE(INIT
, "OPENSSL_cleanup: err_int()\n");
443 OSSL_TRACE(INIT
, "OPENSSL_cleanup: CRYPTO_secure_malloc_done()\n");
444 CRYPTO_secure_malloc_done();
446 #ifndef OPENSSL_NO_CMP
447 OSSL_TRACE(INIT
, "OPENSSL_cleanup: OSSL_CMP_log_close()\n");
448 OSSL_CMP_log_close();
451 OSSL_TRACE(INIT
, "OPENSSL_cleanup: ossl_trace_cleanup()\n");
452 ossl_trace_cleanup();
458 * If this function is called with a non NULL settings value then it must be
459 * called prior to any threads making calls to any OpenSSL functions,
460 * i.e. passing a non-null settings value is assumed to be single-threaded.
462 int OPENSSL_init_crypto(uint64_t opts
, const OPENSSL_INIT_SETTINGS
*settings
)
467 /* Applications depend on 0 being returned when cleanup was already done */
469 if (!(opts
& OPENSSL_INIT_BASE_ONLY
))
470 ERR_raise(ERR_LIB_CRYPTO
, ERR_R_INIT_FAIL
);
475 * We ignore failures from this function. It is probably because we are
476 * on a platform that doesn't support lockless atomic loads (we may not
477 * have created optsdone_lock yet so we can't use it). This is just an
478 * optimisation to skip the full checks in this function if we don't need
479 * to, so we carry on regardless in the event of failure.
481 * There could be a race here with other threads, so that optsdone has not
482 * been updated yet, even though the options have in fact been initialised.
483 * This doesn't matter - it just means we will run the full function
484 * unnecessarily - but all the critical code is contained in RUN_ONCE
485 * functions anyway so we are safe.
487 if (CRYPTO_atomic_load(&optsdone
, &tmp
, NULL
)) {
488 if ((tmp
& opts
) == opts
)
494 * At some point we should look at this function with a view to moving
495 * most/all of this into OSSL_LIB_CTX.
497 * When the caller specifies OPENSSL_INIT_BASE_ONLY, that should be the
498 * *only* option specified. With that option we return immediately after
499 * doing the requested limited initialization. Note that
500 * err_shelve_state() called by us via ossl_init_load_crypto_nodelete()
501 * re-enters OPENSSL_init_crypto() with OPENSSL_INIT_BASE_ONLY, but with
502 * base already initialized this is a harmless NOOP.
504 * If we remain the only caller of err_shelve_state() the recursion should
505 * perhaps be removed, but if in doubt, it can be left in place.
507 if (!RUN_ONCE(&base
, ossl_init_base
))
510 if (opts
& OPENSSL_INIT_BASE_ONLY
)
514 * optsdone_lock should definitely be set up now, so we can now repeat the
515 * same check from above but be sure that it will work even on platforms
516 * without lockless CRYPTO_atomic_load
519 if (!CRYPTO_atomic_load(&optsdone
, &tmp
, optsdone_lock
))
521 if ((tmp
& opts
) == opts
)
526 * Now we don't always set up exit handlers, the INIT_BASE_ONLY calls
527 * should not have the side-effect of setting up exit handlers, and
528 * therefore, this code block is below the INIT_BASE_ONLY-conditioned early
531 if ((opts
& OPENSSL_INIT_NO_ATEXIT
) != 0) {
532 if (!RUN_ONCE_ALT(®ister_atexit
, ossl_init_no_register_atexit
,
533 ossl_init_register_atexit
))
535 } else if (!RUN_ONCE(®ister_atexit
, ossl_init_register_atexit
)) {
539 if (!RUN_ONCE(&load_crypto_nodelete
, ossl_init_load_crypto_nodelete
))
542 if ((opts
& OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS
)
543 && !RUN_ONCE_ALT(&load_crypto_strings
,
544 ossl_init_no_load_crypto_strings
,
545 ossl_init_load_crypto_strings
))
548 if ((opts
& OPENSSL_INIT_LOAD_CRYPTO_STRINGS
)
549 && !RUN_ONCE(&load_crypto_strings
, ossl_init_load_crypto_strings
))
552 if ((opts
& OPENSSL_INIT_NO_ADD_ALL_CIPHERS
)
553 && !RUN_ONCE_ALT(&add_all_ciphers
, ossl_init_no_add_all_ciphers
,
554 ossl_init_add_all_ciphers
))
557 if ((opts
& OPENSSL_INIT_ADD_ALL_CIPHERS
)
558 && !RUN_ONCE(&add_all_ciphers
, ossl_init_add_all_ciphers
))
561 if ((opts
& OPENSSL_INIT_NO_ADD_ALL_DIGESTS
)
562 && !RUN_ONCE_ALT(&add_all_digests
, ossl_init_no_add_all_digests
,
563 ossl_init_add_all_digests
))
566 if ((opts
& OPENSSL_INIT_ADD_ALL_DIGESTS
)
567 && !RUN_ONCE(&add_all_digests
, ossl_init_add_all_digests
))
570 if ((opts
& OPENSSL_INIT_ATFORK
)
571 && !openssl_init_fork_handlers())
574 if ((opts
& OPENSSL_INIT_NO_LOAD_CONFIG
)
575 && !RUN_ONCE_ALT(&config
, ossl_init_no_config
, ossl_init_config
))
578 if (opts
& OPENSSL_INIT_LOAD_CONFIG
) {
579 int loading
= CRYPTO_THREAD_get_local(&in_init_config_local
) != NULL
;
581 /* If called recursively from OBJ_ calls, just skip it. */
585 if (!CRYPTO_THREAD_set_local(&in_init_config_local
, (void *)-1))
587 if (settings
== NULL
) {
588 ret
= RUN_ONCE(&config
, ossl_init_config
);
590 if (!CRYPTO_THREAD_write_lock(init_lock
))
592 conf_settings
= settings
;
593 ret
= RUN_ONCE_ALT(&config
, ossl_init_config_settings
,
595 conf_settings
= NULL
;
596 CRYPTO_THREAD_unlock(init_lock
);
604 if ((opts
& OPENSSL_INIT_ASYNC
)
605 && !RUN_ONCE(&async
, ossl_init_async
))
608 #ifndef OPENSSL_NO_ENGINE
609 if ((opts
& OPENSSL_INIT_ENGINE_OPENSSL
)
610 && !RUN_ONCE(&engine_openssl
, ossl_init_engine_openssl
))
612 # ifndef OPENSSL_NO_RDRAND
613 if ((opts
& OPENSSL_INIT_ENGINE_RDRAND
)
614 && !RUN_ONCE(&engine_rdrand
, ossl_init_engine_rdrand
))
617 if ((opts
& OPENSSL_INIT_ENGINE_DYNAMIC
)
618 && !RUN_ONCE(&engine_dynamic
, ossl_init_engine_dynamic
))
620 # ifndef OPENSSL_NO_STATIC_ENGINE
621 # ifndef OPENSSL_NO_DEVCRYPTOENG
622 if ((opts
& OPENSSL_INIT_ENGINE_CRYPTODEV
)
623 && !RUN_ONCE(&engine_devcrypto
, ossl_init_engine_devcrypto
))
626 # if !defined(OPENSSL_NO_PADLOCKENG)
627 if ((opts
& OPENSSL_INIT_ENGINE_PADLOCK
)
628 && !RUN_ONCE(&engine_padlock
, ossl_init_engine_padlock
))
631 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
632 if ((opts
& OPENSSL_INIT_ENGINE_CAPI
)
633 && !RUN_ONCE(&engine_capi
, ossl_init_engine_capi
))
636 # if !defined(OPENSSL_NO_AFALGENG)
637 if ((opts
& OPENSSL_INIT_ENGINE_AFALG
)
638 && !RUN_ONCE(&engine_afalg
, ossl_init_engine_afalg
))
642 if (opts
& (OPENSSL_INIT_ENGINE_ALL_BUILTIN
643 | OPENSSL_INIT_ENGINE_OPENSSL
644 | OPENSSL_INIT_ENGINE_AFALG
)) {
645 ENGINE_register_all_complete();
649 if (!CRYPTO_atomic_or(&optsdone
, opts
, &tmp
, optsdone_lock
))
655 int OPENSSL_atexit(void (*handler
)(void))
657 OPENSSL_INIT_STOP
*newhand
;
659 #if !defined(OPENSSL_USE_NODELETE)\
660 && !defined(OPENSSL_NO_PINSHARED)
662 # if defined(DSO_WIN32) && !defined(_WIN32_WCE)
663 HMODULE handle
= NULL
;
670 handlersym
.func
= handler
;
673 * We don't use the DSO route for WIN32 because there is a better
676 ret
= GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
677 | GET_MODULE_HANDLE_EX_FLAG_PIN
,
678 handlersym
.sym
, &handle
);
682 # elif !defined(DSO_NONE)
684 * Deliberately leak a reference to the handler. This will force the
685 * library/code containing the handler to remain loaded until we run the
686 * atexit handler. If -znodelete has been used then this is
695 handlersym
.func
= handler
;
698 dso
= DSO_dsobyaddr(handlersym
.sym
, DSO_FLAG_NO_UNLOAD_ON_FREE
);
699 /* See same code above in ossl_init_base() for an explanation. */
701 "atexit: obtained DSO reference? %s\n",
702 (dso
== NULL
? "No!" : "Yes."));
709 if ((newhand
= OPENSSL_malloc(sizeof(*newhand
))) == NULL
)
712 newhand
->handler
= handler
;
713 newhand
->next
= stop_handlers
;
714 stop_handlers
= newhand
;