2 * Copyright 2016-2020 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
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>
36 static int stopped = 0;
38 typedef struct ossl_init_stop_st OPENSSL_INIT_STOP;
39 struct ossl_init_stop_st {
40 void (*handler)(void);
41 OPENSSL_INIT_STOP *next;
44 static OPENSSL_INIT_STOP *stop_handlers = NULL;
45 static CRYPTO_RWLOCK *init_lock = NULL;
47 static CRYPTO_ONCE base = CRYPTO_ONCE_STATIC_INIT;
48 static int base_inited = 0;
49 DEFINE_RUN_ONCE_STATIC(ossl_init_base)
51 /* no need to init trace */
53 OSSL_TRACE(INIT, "ossl_init_base: setting up stop handlers\n");
54 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
55 ossl_malloc_setup_failures();
58 if ((init_lock = CRYPTO_THREAD_lock_new()) == NULL)
60 OPENSSL_cpuid_setup();
62 if (!ossl_init_thread())
69 OSSL_TRACE(INIT, "ossl_init_base failed!\n");
70 CRYPTO_THREAD_lock_free(init_lock);
76 static CRYPTO_ONCE register_atexit = CRYPTO_ONCE_STATIC_INIT;
77 #if !defined(OPENSSL_SYS_UEFI) && defined(_WIN32)
78 static int win32atexit(void)
85 DEFINE_RUN_ONCE_STATIC(ossl_init_register_atexit)
87 #ifdef OPENSSL_INIT_DEBUG
88 fprintf(stderr, "OPENSSL_INIT: ossl_init_register_atexit()\n");
90 #ifndef OPENSSL_SYS_UEFI
92 /* We use _onexit() in preference because it gets called on DLL unload */
93 if (_onexit(win32atexit) == NULL)
96 if (atexit(OPENSSL_cleanup) != 0)
104 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_register_atexit,
105 ossl_init_register_atexit)
107 #ifdef OPENSSL_INIT_DEBUG
108 fprintf(stderr, "OPENSSL_INIT: ossl_init_no_register_atexit ok!\n");
110 /* Do nothing in this case */
114 static CRYPTO_ONCE load_crypto_nodelete = CRYPTO_ONCE_STATIC_INIT;
115 DEFINE_RUN_ONCE_STATIC(ossl_init_load_crypto_nodelete)
117 OSSL_TRACE(INIT, "ossl_init_load_crypto_nodelete()\n");
119 #if !defined(OPENSSL_USE_NODELETE) \
120 && !defined(OPENSSL_NO_PINSHARED)
121 # if defined(DSO_WIN32) && !defined(_WIN32_WCE)
123 HMODULE handle = NULL;
126 /* We don't use the DSO route for WIN32 because there is a better way */
127 ret = GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
128 | GET_MODULE_HANDLE_EX_FLAG_PIN,
129 (void *)&base_inited, &handle);
132 "ossl_init_load_crypto_nodelete: "
133 "obtained DSO reference? %s\n",
134 (ret == TRUE ? "No!" : "Yes."));
135 return (ret == TRUE) ? 1 : 0;
137 # elif !defined(DSO_NONE)
139 * Deliberately leak a reference to ourselves. This will force the library
140 * to remain loaded until the atexit() handler is run at process exit.
146 if (!err_shelve_state(&err))
149 dso = DSO_dsobyaddr(&base_inited, DSO_FLAG_NO_UNLOAD_ON_FREE);
151 * In case of No!, it is uncertain our exit()-handlers can still be
152 * called. After dlclose() the whole library might have been unloaded
155 OSSL_TRACE1(INIT, "obtained DSO reference? %s\n",
156 (dso == NULL ? "No!" : "Yes."));
158 err_unshelve_state(err);
166 static CRYPTO_ONCE load_crypto_strings = CRYPTO_ONCE_STATIC_INIT;
167 static int load_crypto_strings_inited = 0;
168 DEFINE_RUN_ONCE_STATIC(ossl_init_load_crypto_strings)
172 * OPENSSL_NO_AUTOERRINIT is provided here to prevent at compile time
173 * pulling in all the error strings during static linking
175 #if !defined(OPENSSL_NO_ERR) && !defined(OPENSSL_NO_AUTOERRINIT)
176 OSSL_TRACE(INIT, "err_load_crypto_strings_int()\n");
177 ret = err_load_crypto_strings_int();
178 load_crypto_strings_inited = 1;
183 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_load_crypto_strings,
184 ossl_init_load_crypto_strings)
186 /* Do nothing in this case */
190 static CRYPTO_ONCE add_all_ciphers = CRYPTO_ONCE_STATIC_INIT;
191 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_ciphers)
194 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
195 * pulling in all the ciphers during static linking
197 #ifndef OPENSSL_NO_AUTOALGINIT
198 OSSL_TRACE(INIT, "openssl_add_all_ciphers_int()\n");
199 openssl_add_all_ciphers_int();
204 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_add_all_ciphers,
205 ossl_init_add_all_ciphers)
211 static CRYPTO_ONCE add_all_digests = CRYPTO_ONCE_STATIC_INIT;
212 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_digests)
215 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
216 * pulling in all the ciphers during static linking
218 #ifndef OPENSSL_NO_AUTOALGINIT
219 OSSL_TRACE(INIT, "openssl_add_all_digests()\n");
220 openssl_add_all_digests_int();
225 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_add_all_digests,
226 ossl_init_add_all_digests)
232 static CRYPTO_ONCE config = CRYPTO_ONCE_STATIC_INIT;
233 static int config_inited = 0;
234 static const OPENSSL_INIT_SETTINGS *conf_settings = NULL;
235 DEFINE_RUN_ONCE_STATIC(ossl_init_config)
237 int ret = openssl_config_int(conf_settings);
241 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_config, ossl_init_config)
243 OSSL_TRACE(INIT, "openssl_no_config_int()\n");
244 openssl_no_config_int();
249 static CRYPTO_ONCE async = CRYPTO_ONCE_STATIC_INIT;
250 static int async_inited = 0;
251 DEFINE_RUN_ONCE_STATIC(ossl_init_async)
253 OSSL_TRACE(INIT, "async_init()\n");
260 #ifndef OPENSSL_NO_ENGINE
261 static CRYPTO_ONCE engine_openssl = CRYPTO_ONCE_STATIC_INIT;
262 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_openssl)
264 OSSL_TRACE(INIT, "engine_load_openssl_int()\n");
265 engine_load_openssl_int();
268 # ifndef OPENSSL_NO_RDRAND
269 static CRYPTO_ONCE engine_rdrand = CRYPTO_ONCE_STATIC_INIT;
270 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_rdrand)
272 OSSL_TRACE(INIT, "engine_load_rdrand_int()\n");
273 engine_load_rdrand_int();
277 static CRYPTO_ONCE engine_dynamic = CRYPTO_ONCE_STATIC_INIT;
278 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_dynamic)
280 OSSL_TRACE(INIT, "engine_load_dynamic_int()\n");
281 engine_load_dynamic_int();
284 # ifndef OPENSSL_NO_STATIC_ENGINE
285 # ifndef OPENSSL_NO_DEVCRYPTOENG
286 static CRYPTO_ONCE engine_devcrypto = CRYPTO_ONCE_STATIC_INIT;
287 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_devcrypto)
289 OSSL_TRACE(INIT, "engine_load_devcrypto_int()\n");
290 engine_load_devcrypto_int();
294 # if !defined(OPENSSL_NO_PADLOCKENG)
295 static CRYPTO_ONCE engine_padlock = CRYPTO_ONCE_STATIC_INIT;
296 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_padlock)
298 OSSL_TRACE(INIT, "engine_load_padlock_int()\n");
299 engine_load_padlock_int();
303 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
304 static CRYPTO_ONCE engine_capi = CRYPTO_ONCE_STATIC_INIT;
305 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_capi)
307 OSSL_TRACE(INIT, "engine_load_capi_int()\n");
308 engine_load_capi_int();
312 # if !defined(OPENSSL_NO_AFALGENG)
313 static CRYPTO_ONCE engine_afalg = CRYPTO_ONCE_STATIC_INIT;
314 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_afalg)
316 OSSL_TRACE(INIT, "engine_load_afalg_int()\n");
317 engine_load_afalg_int();
324 #ifndef OPENSSL_NO_COMP
325 static CRYPTO_ONCE zlib = CRYPTO_ONCE_STATIC_INIT;
327 static int zlib_inited = 0;
328 DEFINE_RUN_ONCE_STATIC(ossl_init_zlib)
330 /* Do nothing - we need to know about this for the later cleanup */
336 void OPENSSL_cleanup(void)
338 OPENSSL_INIT_STOP *currhandler, *lasthandler;
341 * TODO(3.0): This function needs looking at with a view to moving most/all
342 * of this into onfree handlers in OPENSSL_CTX.
345 /* If we've not been inited then no need to deinit */
349 /* Might be explicitly called and also by atexit */
355 * Thread stop may not get automatically called by the thread library for
356 * the very last thread in some situations, so call it directly.
358 OPENSSL_thread_stop();
360 currhandler = stop_handlers;
361 while (currhandler != NULL) {
362 currhandler->handler();
363 lasthandler = currhandler;
364 currhandler = currhandler->next;
365 OPENSSL_free(lasthandler);
367 stop_handlers = NULL;
369 CRYPTO_THREAD_lock_free(init_lock);
373 * We assume we are single-threaded for this function, i.e. no race
374 * conditions for the various "*_inited" vars below.
377 #ifndef OPENSSL_NO_COMP
379 OSSL_TRACE(INIT, "OPENSSL_cleanup: comp_zlib_cleanup_int()\n");
380 comp_zlib_cleanup_int();
385 OSSL_TRACE(INIT, "OPENSSL_cleanup: async_deinit()\n");
389 if (load_crypto_strings_inited) {
390 OSSL_TRACE(INIT, "OPENSSL_cleanup: err_free_strings_int()\n");
391 err_free_strings_int();
395 * Note that cleanup order is important:
396 * - rand_cleanup_int could call an ENGINE's RAND cleanup function so
397 * must be called before engine_cleanup_int()
398 * - ENGINEs use CRYPTO_EX_DATA and therefore, must be cleaned up
399 * before the ex data handlers are wiped during default openssl_ctx deinit.
400 * - conf_modules_free_int() can end up in ENGINE code so must be called
401 * before engine_cleanup_int()
402 * - ENGINEs and additional EVP algorithms might use added OIDs names so
403 * obj_cleanup_int() must be called last
405 OSSL_TRACE(INIT, "OPENSSL_cleanup: rand_cleanup_int()\n");
408 OSSL_TRACE(INIT, "OPENSSL_cleanup: conf_modules_free_int()\n");
409 conf_modules_free_int();
411 #ifndef OPENSSL_NO_ENGINE
412 OSSL_TRACE(INIT, "OPENSSL_cleanup: engine_cleanup_int()\n");
413 engine_cleanup_int();
416 #ifndef OPENSSL_NO_DEPRECATED_3_0
417 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_store_cleanup_int()\n");
418 ossl_store_cleanup_int();
421 OSSL_TRACE(INIT, "OPENSSL_cleanup: openssl_ctx_default_deinit()\n");
422 openssl_ctx_default_deinit();
424 ossl_cleanup_thread();
426 OSSL_TRACE(INIT, "OPENSSL_cleanup: bio_cleanup()\n");
429 OSSL_TRACE(INIT, "OPENSSL_cleanup: evp_cleanup_int()\n");
432 OSSL_TRACE(INIT, "OPENSSL_cleanup: obj_cleanup_int()\n");
435 OSSL_TRACE(INIT, "OPENSSL_cleanup: err_int()\n");
438 OSSL_TRACE(INIT, "OPENSSL_cleanup: CRYPTO_secure_malloc_done()\n");
439 CRYPTO_secure_malloc_done();
441 #ifndef OPENSSL_NO_CMP
442 OSSL_TRACE(INIT, "OPENSSL_cleanup: OSSL_CMP_log_close()\n");
443 OSSL_CMP_log_close();
446 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_trace_cleanup()\n");
447 ossl_trace_cleanup();
453 * If this function is called with a non NULL settings value then it must be
454 * called prior to any threads making calls to any OpenSSL functions,
455 * i.e. passing a non-null settings value is assumed to be single-threaded.
457 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings)
460 * TODO(3.0): This function needs looking at with a view to moving most/all
461 * of this into OPENSSL_CTX.
465 if (!(opts & OPENSSL_INIT_BASE_ONLY))
466 CRYPTOerr(CRYPTO_F_OPENSSL_INIT_CRYPTO, ERR_R_INIT_FAIL);
471 * When the caller specifies OPENSSL_INIT_BASE_ONLY, that should be the
472 * *only* option specified. With that option we return immediately after
473 * doing the requested limited initialization. Note that
474 * err_shelve_state() called by us via ossl_init_load_crypto_nodelete()
475 * re-enters OPENSSL_init_crypto() with OPENSSL_INIT_BASE_ONLY, but with
476 * base already initialized this is a harmless NOOP.
478 * If we remain the only caller of err_shelve_state() the recursion should
479 * perhaps be removed, but if in doubt, it can be left in place.
481 if (!RUN_ONCE(&base, ossl_init_base))
484 if (opts & OPENSSL_INIT_BASE_ONLY)
488 * Now we don't always set up exit handlers, the INIT_BASE_ONLY calls
489 * should not have the side-effect of setting up exit handlers, and
490 * therefore, this code block is below the INIT_BASE_ONLY-conditioned early
493 if ((opts & OPENSSL_INIT_NO_ATEXIT) != 0) {
494 if (!RUN_ONCE_ALT(®ister_atexit, ossl_init_no_register_atexit,
495 ossl_init_register_atexit))
497 } else if (!RUN_ONCE(®ister_atexit, ossl_init_register_atexit)) {
501 if (!RUN_ONCE(&load_crypto_nodelete, ossl_init_load_crypto_nodelete))
504 if ((opts & OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS)
505 && !RUN_ONCE_ALT(&load_crypto_strings,
506 ossl_init_no_load_crypto_strings,
507 ossl_init_load_crypto_strings))
510 if ((opts & OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
511 && !RUN_ONCE(&load_crypto_strings, ossl_init_load_crypto_strings))
514 if ((opts & OPENSSL_INIT_NO_ADD_ALL_CIPHERS)
515 && !RUN_ONCE_ALT(&add_all_ciphers, ossl_init_no_add_all_ciphers,
516 ossl_init_add_all_ciphers))
519 if ((opts & OPENSSL_INIT_ADD_ALL_CIPHERS)
520 && !RUN_ONCE(&add_all_ciphers, ossl_init_add_all_ciphers))
523 if ((opts & OPENSSL_INIT_NO_ADD_ALL_DIGESTS)
524 && !RUN_ONCE_ALT(&add_all_digests, ossl_init_no_add_all_digests,
525 ossl_init_add_all_digests))
528 if ((opts & OPENSSL_INIT_ADD_ALL_DIGESTS)
529 && !RUN_ONCE(&add_all_digests, ossl_init_add_all_digests))
532 if ((opts & OPENSSL_INIT_ATFORK)
533 && !openssl_init_fork_handlers())
536 if ((opts & OPENSSL_INIT_NO_LOAD_CONFIG)
537 && !RUN_ONCE_ALT(&config, ossl_init_no_config, ossl_init_config))
540 if (opts & OPENSSL_INIT_LOAD_CONFIG) {
542 CRYPTO_THREAD_write_lock(init_lock);
543 conf_settings = settings;
544 ret = RUN_ONCE(&config, ossl_init_config);
545 conf_settings = NULL;
546 CRYPTO_THREAD_unlock(init_lock);
551 if ((opts & OPENSSL_INIT_ASYNC)
552 && !RUN_ONCE(&async, ossl_init_async))
555 #ifndef OPENSSL_NO_ENGINE
556 if ((opts & OPENSSL_INIT_ENGINE_OPENSSL)
557 && !RUN_ONCE(&engine_openssl, ossl_init_engine_openssl))
559 # ifndef OPENSSL_NO_RDRAND
560 if ((opts & OPENSSL_INIT_ENGINE_RDRAND)
561 && !RUN_ONCE(&engine_rdrand, ossl_init_engine_rdrand))
564 if ((opts & OPENSSL_INIT_ENGINE_DYNAMIC)
565 && !RUN_ONCE(&engine_dynamic, ossl_init_engine_dynamic))
567 # ifndef OPENSSL_NO_STATIC_ENGINE
568 # ifndef OPENSSL_NO_DEVCRYPTOENG
569 if ((opts & OPENSSL_INIT_ENGINE_CRYPTODEV)
570 && !RUN_ONCE(&engine_devcrypto, ossl_init_engine_devcrypto))
573 # if !defined(OPENSSL_NO_PADLOCKENG)
574 if ((opts & OPENSSL_INIT_ENGINE_PADLOCK)
575 && !RUN_ONCE(&engine_padlock, ossl_init_engine_padlock))
578 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
579 if ((opts & OPENSSL_INIT_ENGINE_CAPI)
580 && !RUN_ONCE(&engine_capi, ossl_init_engine_capi))
583 # if !defined(OPENSSL_NO_AFALGENG)
584 if ((opts & OPENSSL_INIT_ENGINE_AFALG)
585 && !RUN_ONCE(&engine_afalg, ossl_init_engine_afalg))
589 if (opts & (OPENSSL_INIT_ENGINE_ALL_BUILTIN
590 | OPENSSL_INIT_ENGINE_OPENSSL
591 | OPENSSL_INIT_ENGINE_AFALG)) {
592 ENGINE_register_all_complete();
596 #ifndef OPENSSL_NO_COMP
597 if ((opts & OPENSSL_INIT_ZLIB)
598 && !RUN_ONCE(&zlib, ossl_init_zlib))
605 int OPENSSL_atexit(void (*handler)(void))
607 OPENSSL_INIT_STOP *newhand;
609 #if !defined(OPENSSL_USE_NODELETE)\
610 && !defined(OPENSSL_NO_PINSHARED)
617 handlersym.func = handler;
618 # if defined(DSO_WIN32) && !defined(_WIN32_WCE)
620 HMODULE handle = NULL;
624 * We don't use the DSO route for WIN32 because there is a better
627 ret = GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
628 | GET_MODULE_HANDLE_EX_FLAG_PIN,
629 handlersym.sym, &handle);
634 # elif !defined(DSO_NONE)
636 * Deliberately leak a reference to the handler. This will force the
637 * library/code containing the handler to remain loaded until we run the
638 * atexit handler. If -znodelete has been used then this is
645 dso = DSO_dsobyaddr(handlersym.sym, DSO_FLAG_NO_UNLOAD_ON_FREE);
646 /* See same code above in ossl_init_base() for an explanation. */
648 "atexit: obtained DSO reference? %s\n",
649 (dso == NULL ? "No!" : "Yes."));
657 if ((newhand = OPENSSL_malloc(sizeof(*newhand))) == NULL) {
658 CRYPTOerr(CRYPTO_F_OPENSSL_ATEXIT, ERR_R_MALLOC_FAILURE);
662 newhand->handler = handler;
663 newhand->next = stop_handlers;
664 stop_handlers = newhand;
669 #ifdef OPENSSL_SYS_UNIX
671 * The following three functions are for OpenSSL developers. This is
672 * where we set/reset state across fork (called via pthread_atfork when
673 * it exists, or manually by the application when it doesn't).
675 * WARNING! If you put code in either OPENSSL_fork_parent or
676 * OPENSSL_fork_child, you MUST MAKE SURE that they are async-signal-
677 * safe. See this link, for example:
678 * http://man7.org/linux/man-pages/man7/signal-safety.7.html
681 void OPENSSL_fork_prepare(void)
685 void OPENSSL_fork_parent(void)
689 void OPENSSL_fork_child(void)
691 /* TODO(3.0): Inform all providers about a fork event */