2 * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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 #include <internal/cryptlib_int.h>
11 #include <openssl/err.h>
12 #include <internal/rand.h>
13 #include <internal/bio.h>
14 #include <openssl/evp.h>
15 #include <internal/evp_int.h>
16 #include <internal/conf.h>
17 #include <internal/async.h>
18 #include <internal/engine.h>
19 #include <internal/comp.h>
20 #include <internal/err.h>
21 #include <internal/err_int.h>
22 #include <internal/objects.h>
25 #include <internal/thread_once.h>
26 #include <internal/dso.h>
28 static int stopped = 0;
30 static void ossl_init_thread_stop(struct thread_local_inits_st *locals);
32 static CRYPTO_THREAD_LOCAL threadstopkey;
34 static void ossl_init_thread_stop_wrap(void *local)
36 ossl_init_thread_stop((struct thread_local_inits_st *)local);
39 static struct thread_local_inits_st *ossl_init_get_thread_local(int alloc)
41 struct thread_local_inits_st *local =
42 CRYPTO_THREAD_get_local(&threadstopkey);
44 if (local == NULL && alloc) {
45 local = OPENSSL_zalloc(sizeof *local);
46 if (local != NULL && !CRYPTO_THREAD_set_local(&threadstopkey, local)) {
52 CRYPTO_THREAD_set_local(&threadstopkey, NULL);
58 typedef struct ossl_init_stop_st OPENSSL_INIT_STOP;
59 struct ossl_init_stop_st {
60 void (*handler)(void);
61 OPENSSL_INIT_STOP *next;
64 static OPENSSL_INIT_STOP *stop_handlers = NULL;
65 static CRYPTO_RWLOCK *init_lock = NULL;
67 static CRYPTO_ONCE base = CRYPTO_ONCE_STATIC_INIT;
68 static int base_inited = 0;
69 DEFINE_RUN_ONCE_STATIC(ossl_init_base)
71 #ifdef OPENSSL_INIT_DEBUG
72 fprintf(stderr, "OPENSSL_INIT: ossl_init_base: Setting up stop handlers\n");
74 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
75 ossl_malloc_setup_failures();
78 * We use a dummy thread local key here. We use the destructor to detect
79 * when the thread is going to stop (where that feature is available)
81 CRYPTO_THREAD_init_local(&threadstopkey, ossl_init_thread_stop_wrap);
82 #ifndef OPENSSL_SYS_UEFI
83 atexit(OPENSSL_cleanup);
85 if ((init_lock = CRYPTO_THREAD_lock_new()) == NULL)
87 OPENSSL_cpuid_setup();
91 * Everything needed to be initialized in this function before threads
92 * come along MUST happen before base_inited is set to 1, or we will
93 * see race conditions.
97 #if !defined(OPENSSL_NO_DSO) && !defined(OPENSSL_USE_NODELETE)
100 HMODULE handle = NULL;
103 /* We don't use the DSO route for WIN32 because there is a better way */
104 ret = GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
105 | GET_MODULE_HANDLE_EX_FLAG_PIN,
106 (void *)&base_inited, &handle);
108 return (ret == TRUE) ? 1 : 0;
112 * Deliberately leak a reference to ourselves. This will force the library
113 * to remain loaded until the atexit() handler is run at process exit.
119 dso = DSO_dsobyaddr(&base_inited, DSO_FLAG_NO_UNLOAD_ON_FREE);
129 static CRYPTO_ONCE load_crypto_strings = CRYPTO_ONCE_STATIC_INIT;
130 static int load_crypto_strings_inited = 0;
131 DEFINE_RUN_ONCE_STATIC(ossl_init_no_load_crypto_strings)
133 /* Do nothing in this case */
137 DEFINE_RUN_ONCE_STATIC(ossl_init_load_crypto_strings)
141 * OPENSSL_NO_AUTOERRINIT is provided here to prevent at compile time
142 * pulling in all the error strings during static linking
144 #if !defined(OPENSSL_NO_ERR) && !defined(OPENSSL_NO_AUTOERRINIT)
145 # ifdef OPENSSL_INIT_DEBUG
146 fprintf(stderr, "OPENSSL_INIT: ossl_init_load_crypto_strings: "
147 "err_load_crypto_strings_int()\n");
149 ret = err_load_crypto_strings_int();
150 load_crypto_strings_inited = 1;
155 static CRYPTO_ONCE add_all_ciphers = CRYPTO_ONCE_STATIC_INIT;
156 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_ciphers)
159 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
160 * pulling in all the ciphers during static linking
162 #ifndef OPENSSL_NO_AUTOALGINIT
163 # ifdef OPENSSL_INIT_DEBUG
164 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_ciphers: "
165 "openssl_add_all_ciphers_int()\n");
167 openssl_add_all_ciphers_int();
172 static CRYPTO_ONCE add_all_digests = CRYPTO_ONCE_STATIC_INIT;
173 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_digests)
176 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
177 * pulling in all the ciphers during static linking
179 #ifndef OPENSSL_NO_AUTOALGINIT
180 # ifdef OPENSSL_INIT_DEBUG
181 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_digests: "
182 "openssl_add_all_digests()\n");
184 openssl_add_all_digests_int();
189 DEFINE_RUN_ONCE_STATIC(ossl_init_no_add_algs)
195 static CRYPTO_ONCE config = CRYPTO_ONCE_STATIC_INIT;
196 static int config_inited = 0;
197 static const char *appname;
198 DEFINE_RUN_ONCE_STATIC(ossl_init_config)
200 #ifdef OPENSSL_INIT_DEBUG
202 "OPENSSL_INIT: ossl_init_config: openssl_config(%s)\n",
203 appname == NULL ? "NULL" : appname);
205 openssl_config_int(appname);
209 DEFINE_RUN_ONCE_STATIC(ossl_init_no_config)
211 #ifdef OPENSSL_INIT_DEBUG
213 "OPENSSL_INIT: ossl_init_config: openssl_no_config_int()\n");
215 openssl_no_config_int();
220 static CRYPTO_ONCE async = CRYPTO_ONCE_STATIC_INIT;
221 static int async_inited = 0;
222 DEFINE_RUN_ONCE_STATIC(ossl_init_async)
224 #ifdef OPENSSL_INIT_DEBUG
225 fprintf(stderr, "OPENSSL_INIT: ossl_init_async: async_init()\n");
233 #ifndef OPENSSL_NO_ENGINE
234 static CRYPTO_ONCE engine_openssl = CRYPTO_ONCE_STATIC_INIT;
235 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_openssl)
237 # ifdef OPENSSL_INIT_DEBUG
238 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_openssl: "
239 "engine_load_openssl_int()\n");
241 engine_load_openssl_int();
244 # ifndef OPENSSL_NO_DEVCRYPTOENG
245 static CRYPTO_ONCE engine_devcrypto = CRYPTO_ONCE_STATIC_INIT;
246 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_devcrypto)
248 # ifdef OPENSSL_INIT_DEBUG
249 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_devcrypto: "
250 "engine_load_devcrypto_int()\n");
252 engine_load_devcrypto_int();
257 # ifndef OPENSSL_NO_RDRAND
258 static CRYPTO_ONCE engine_rdrand = CRYPTO_ONCE_STATIC_INIT;
259 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_rdrand)
261 # ifdef OPENSSL_INIT_DEBUG
262 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_rdrand: "
263 "engine_load_rdrand_int()\n");
265 engine_load_rdrand_int();
269 static CRYPTO_ONCE engine_dynamic = CRYPTO_ONCE_STATIC_INIT;
270 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_dynamic)
272 # ifdef OPENSSL_INIT_DEBUG
273 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_dynamic: "
274 "engine_load_dynamic_int()\n");
276 engine_load_dynamic_int();
279 # ifndef OPENSSL_NO_STATIC_ENGINE
280 # if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_PADLOCK)
281 static CRYPTO_ONCE engine_padlock = CRYPTO_ONCE_STATIC_INIT;
282 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_padlock)
284 # ifdef OPENSSL_INIT_DEBUG
285 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_padlock: "
286 "engine_load_padlock_int()\n");
288 engine_load_padlock_int();
292 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
293 static CRYPTO_ONCE engine_capi = CRYPTO_ONCE_STATIC_INIT;
294 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_capi)
296 # ifdef OPENSSL_INIT_DEBUG
297 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_capi: "
298 "engine_load_capi_int()\n");
300 engine_load_capi_int();
304 # if !defined(OPENSSL_NO_AFALGENG)
305 static CRYPTO_ONCE engine_afalg = CRYPTO_ONCE_STATIC_INIT;
306 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_afalg)
308 # ifdef OPENSSL_INIT_DEBUG
309 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_afalg: "
310 "engine_load_afalg_int()\n");
312 engine_load_afalg_int();
319 #ifndef OPENSSL_NO_COMP
320 static CRYPTO_ONCE zlib = CRYPTO_ONCE_STATIC_INIT;
322 static int zlib_inited = 0;
323 DEFINE_RUN_ONCE_STATIC(ossl_init_zlib)
325 /* Do nothing - we need to know about this for the later cleanup */
331 static void ossl_init_thread_stop(struct thread_local_inits_st *locals)
333 /* Can't do much about this */
338 #ifdef OPENSSL_INIT_DEBUG
339 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
340 "ASYNC_cleanup_thread()\n");
342 ASYNC_cleanup_thread();
345 if (locals->err_state) {
346 #ifdef OPENSSL_INIT_DEBUG
347 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
348 "err_delete_thread_state()\n");
350 err_delete_thread_state();
353 OPENSSL_free(locals);
356 void OPENSSL_thread_stop(void)
358 ossl_init_thread_stop(
359 (struct thread_local_inits_st *)ossl_init_get_thread_local(0));
362 int ossl_init_thread_start(uint64_t opts)
364 struct thread_local_inits_st *locals;
366 if (!OPENSSL_init_crypto(0, NULL))
369 locals = ossl_init_get_thread_local(1);
374 if (opts & OPENSSL_INIT_THREAD_ASYNC) {
375 #ifdef OPENSSL_INIT_DEBUG
376 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_start: "
377 "marking thread for async\n");
382 if (opts & OPENSSL_INIT_THREAD_ERR_STATE) {
383 #ifdef OPENSSL_INIT_DEBUG
384 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_start: "
385 "marking thread for err_state\n");
387 locals->err_state = 1;
393 void OPENSSL_cleanup(void)
395 OPENSSL_INIT_STOP *currhandler, *lasthandler;
397 /* If we've not been inited then no need to deinit */
401 /* Might be explicitly called and also by atexit */
407 * Thread stop may not get automatically called by the thread library for
408 * the very last thread in some situations, so call it directly.
410 ossl_init_thread_stop(ossl_init_get_thread_local(0));
412 currhandler = stop_handlers;
413 while (currhandler != NULL) {
414 currhandler->handler();
415 lasthandler = currhandler;
416 currhandler = currhandler->next;
417 OPENSSL_free(lasthandler);
419 stop_handlers = NULL;
421 CRYPTO_THREAD_lock_free(init_lock);
424 * We assume we are single-threaded for this function, i.e. no race
425 * conditions for the various "*_inited" vars below.
428 #ifndef OPENSSL_NO_COMP
430 #ifdef OPENSSL_INIT_DEBUG
431 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
432 "comp_zlib_cleanup_int()\n");
434 comp_zlib_cleanup_int();
439 # ifdef OPENSSL_INIT_DEBUG
440 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
446 if (load_crypto_strings_inited) {
447 #ifdef OPENSSL_INIT_DEBUG
448 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
449 "err_free_strings_int()\n");
451 err_free_strings_int();
454 CRYPTO_THREAD_cleanup_local(&threadstopkey);
456 #ifdef OPENSSL_INIT_DEBUG
457 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
458 "rand_cleanup_int()\n");
459 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
460 "conf_modules_free_int()\n");
461 #ifndef OPENSSL_NO_ENGINE
462 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
463 "engine_cleanup_int()\n");
465 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
466 "crypto_cleanup_all_ex_data_int()\n");
467 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
468 "bio_sock_cleanup_int()\n");
469 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
471 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
472 "evp_cleanup_int()\n");
473 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
474 "obj_cleanup_int()\n");
475 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
479 * Note that cleanup order is important:
480 * - rand_cleanup_int could call an ENGINE's RAND cleanup function so
481 * must be called before engine_cleanup_int()
482 * - ENGINEs use CRYPTO_EX_DATA and therefore, must be cleaned up
483 * before the ex data handlers are wiped in CRYPTO_cleanup_all_ex_data().
484 * - conf_modules_free_int() can end up in ENGINE code so must be called
485 * before engine_cleanup_int()
486 * - ENGINEs and additional EVP algorithms might use added OIDs names so
487 * obj_cleanup_int() must be called last
490 conf_modules_free_int();
491 #ifndef OPENSSL_NO_ENGINE
492 engine_cleanup_int();
494 crypto_cleanup_all_ex_data_int();
504 * If this function is called with a non NULL settings value then it must be
505 * called prior to any threads making calls to any OpenSSL functions,
506 * i.e. passing a non-null settings value is assumed to be single-threaded.
508 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings)
510 static int stoperrset = 0;
515 * We only ever set this once to avoid getting into an infinite
516 * loop where the error system keeps trying to init and fails so
520 CRYPTOerr(CRYPTO_F_OPENSSL_INIT_CRYPTO, ERR_R_INIT_FAIL);
525 if (!base_inited && !RUN_ONCE(&base, ossl_init_base))
528 if ((opts & OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS)
529 && !RUN_ONCE(&load_crypto_strings,
530 ossl_init_no_load_crypto_strings))
533 if ((opts & OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
534 && !RUN_ONCE(&load_crypto_strings, ossl_init_load_crypto_strings))
537 if ((opts & OPENSSL_INIT_NO_ADD_ALL_CIPHERS)
538 && !RUN_ONCE(&add_all_ciphers, ossl_init_no_add_algs))
541 if ((opts & OPENSSL_INIT_ADD_ALL_CIPHERS)
542 && !RUN_ONCE(&add_all_ciphers, ossl_init_add_all_ciphers))
545 if ((opts & OPENSSL_INIT_NO_ADD_ALL_DIGESTS)
546 && !RUN_ONCE(&add_all_digests, ossl_init_no_add_algs))
549 if ((opts & OPENSSL_INIT_ADD_ALL_DIGESTS)
550 && !RUN_ONCE(&add_all_digests, ossl_init_add_all_digests))
553 if ((opts & OPENSSL_INIT_NO_LOAD_CONFIG)
554 && !RUN_ONCE(&config, ossl_init_no_config))
557 if (opts & OPENSSL_INIT_LOAD_CONFIG) {
559 CRYPTO_THREAD_write_lock(init_lock);
560 appname = (settings == NULL) ? NULL : settings->appname;
561 ret = RUN_ONCE(&config, ossl_init_config);
562 CRYPTO_THREAD_unlock(init_lock);
567 if ((opts & OPENSSL_INIT_ASYNC)
568 && !RUN_ONCE(&async, ossl_init_async))
571 #ifndef OPENSSL_NO_ENGINE
572 if ((opts & OPENSSL_INIT_ENGINE_OPENSSL)
573 && !RUN_ONCE(&engine_openssl, ossl_init_engine_openssl))
575 # if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_DEVCRYPTOENG)
576 if ((opts & OPENSSL_INIT_ENGINE_CRYPTODEV)
577 && !RUN_ONCE(&engine_devcrypto, ossl_init_engine_devcrypto))
580 # ifndef OPENSSL_NO_RDRAND
581 if ((opts & OPENSSL_INIT_ENGINE_RDRAND)
582 && !RUN_ONCE(&engine_rdrand, ossl_init_engine_rdrand))
585 if ((opts & OPENSSL_INIT_ENGINE_DYNAMIC)
586 && !RUN_ONCE(&engine_dynamic, ossl_init_engine_dynamic))
588 # ifndef OPENSSL_NO_STATIC_ENGINE
589 # if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_PADLOCK)
590 if ((opts & OPENSSL_INIT_ENGINE_PADLOCK)
591 && !RUN_ONCE(&engine_padlock, ossl_init_engine_padlock))
594 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
595 if ((opts & OPENSSL_INIT_ENGINE_CAPI)
596 && !RUN_ONCE(&engine_capi, ossl_init_engine_capi))
599 # if !defined(OPENSSL_NO_AFALGENG)
600 if ((opts & OPENSSL_INIT_ENGINE_AFALG)
601 && !RUN_ONCE(&engine_afalg, ossl_init_engine_afalg))
605 if (opts & (OPENSSL_INIT_ENGINE_ALL_BUILTIN
606 | OPENSSL_INIT_ENGINE_OPENSSL
607 | OPENSSL_INIT_ENGINE_AFALG)) {
608 ENGINE_register_all_complete();
612 #ifndef OPENSSL_NO_COMP
613 if ((opts & OPENSSL_INIT_ZLIB)
614 && !RUN_ONCE(&zlib, ossl_init_zlib))
621 int OPENSSL_atexit(void (*handler)(void))
623 OPENSSL_INIT_STOP *newhand;
625 #if !defined(OPENSSL_NO_DSO) && !defined(OPENSSL_USE_NODELETE)
632 handlersym.func = handler;
635 HMODULE handle = NULL;
639 * We don't use the DSO route for WIN32 because there is a better
642 ret = GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
643 | GET_MODULE_HANDLE_EX_FLAG_PIN,
644 handlersym.sym, &handle);
651 * Deliberately leak a reference to the handler. This will force the
652 * library/code containing the handler to remain loaded until we run the
653 * atexit handler. If -znodelete has been used then this is
660 dso = DSO_dsobyaddr(handlersym.sym, DSO_FLAG_NO_UNLOAD_ON_FREE);
668 newhand = OPENSSL_malloc(sizeof(*newhand));
672 newhand->handler = handler;
673 newhand->next = stop_handlers;
674 stop_handlers = newhand;