2 * Copyright 2016-2018 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
11 #include "crypto/cryptlib.h"
12 #include <openssl/err.h>
13 #include "crypto/rand.h"
14 #include "internal/bio.h"
15 #include <openssl/evp.h>
16 #include "crypto/evp.h"
17 #include "internal/conf.h"
18 #include "crypto/async.h"
19 #include "crypto/engine.h"
20 #include "internal/comp.h"
21 #include "internal/err.h"
22 #include "crypto/err.h"
23 #include "crypto/objects.h"
26 #include "internal/thread_once.h"
27 #include "crypto/dso_conf.h"
28 #include "internal/dso.h"
29 #include "crypto/store.h"
30 #include <openssl/cmp_util.h> /* for OSSL_CMP_log_close() */
31 #include <openssl/trace.h>
33 static int stopped = 0;
35 typedef struct ossl_init_stop_st OPENSSL_INIT_STOP;
36 struct ossl_init_stop_st {
37 void (*handler)(void);
38 OPENSSL_INIT_STOP *next;
41 static OPENSSL_INIT_STOP *stop_handlers = NULL;
42 static CRYPTO_RWLOCK *init_lock = NULL;
44 static CRYPTO_ONCE base = CRYPTO_ONCE_STATIC_INIT;
45 static int base_inited = 0;
46 DEFINE_RUN_ONCE_STATIC(ossl_init_base)
48 /* no need to init trace */
50 OSSL_TRACE(INIT, "ossl_init_base: setting up stop handlers\n");
51 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
52 ossl_malloc_setup_failures();
55 if ((init_lock = CRYPTO_THREAD_lock_new()) == NULL)
57 OPENSSL_cpuid_setup();
59 if (!ossl_init_thread())
66 OSSL_TRACE(INIT, "ossl_init_base failed!\n");
67 CRYPTO_THREAD_lock_free(init_lock);
73 static CRYPTO_ONCE register_atexit = CRYPTO_ONCE_STATIC_INIT;
74 #if !defined(OPENSSL_SYS_UEFI) && defined(_WIN32)
75 static int win32atexit(void)
82 DEFINE_RUN_ONCE_STATIC(ossl_init_register_atexit)
84 #ifdef OPENSSL_INIT_DEBUG
85 fprintf(stderr, "OPENSSL_INIT: ossl_init_register_atexit()\n");
87 #ifndef OPENSSL_SYS_UEFI
89 /* We use _onexit() in preference because it gets called on DLL unload */
90 if (_onexit(win32atexit) == NULL)
93 if (atexit(OPENSSL_cleanup) != 0)
101 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_register_atexit,
102 ossl_init_register_atexit)
104 #ifdef OPENSSL_INIT_DEBUG
105 fprintf(stderr, "OPENSSL_INIT: ossl_init_no_register_atexit ok!\n");
107 /* Do nothing in this case */
111 static CRYPTO_ONCE load_crypto_nodelete = CRYPTO_ONCE_STATIC_INIT;
112 DEFINE_RUN_ONCE_STATIC(ossl_init_load_crypto_nodelete)
114 OSSL_TRACE(INIT, "ossl_init_load_crypto_nodelete()\n");
116 #if !defined(OPENSSL_USE_NODELETE) \
117 && !defined(OPENSSL_NO_PINSHARED)
118 # if defined(DSO_WIN32) && !defined(_WIN32_WCE)
120 HMODULE handle = NULL;
123 /* We don't use the DSO route for WIN32 because there is a better way */
124 ret = GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
125 | GET_MODULE_HANDLE_EX_FLAG_PIN,
126 (void *)&base_inited, &handle);
129 "ossl_init_load_crypto_nodelete: "
130 "obtained DSO reference? %s\n",
131 (ret == TRUE ? "No!" : "Yes."));
132 return (ret == TRUE) ? 1 : 0;
134 # elif !defined(DSO_NONE)
136 * Deliberately leak a reference to ourselves. This will force the library
137 * to remain loaded until the atexit() handler is run at process exit.
143 if (!err_shelve_state(&err))
146 dso = DSO_dsobyaddr(&base_inited, DSO_FLAG_NO_UNLOAD_ON_FREE);
148 * In case of No!, it is uncertain our exit()-handlers can still be
149 * called. After dlclose() the whole library might have been unloaded
152 OSSL_TRACE1(INIT, "obtained DSO reference? %s\n",
153 (dso == NULL ? "No!" : "Yes."));
155 err_unshelve_state(err);
163 static CRYPTO_ONCE load_crypto_strings = CRYPTO_ONCE_STATIC_INIT;
164 static int load_crypto_strings_inited = 0;
165 DEFINE_RUN_ONCE_STATIC(ossl_init_load_crypto_strings)
169 * OPENSSL_NO_AUTOERRINIT is provided here to prevent at compile time
170 * pulling in all the error strings during static linking
172 #if !defined(OPENSSL_NO_ERR) && !defined(OPENSSL_NO_AUTOERRINIT)
173 OSSL_TRACE(INIT, "err_load_crypto_strings_int()\n");
174 ret = err_load_crypto_strings_int();
175 load_crypto_strings_inited = 1;
180 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_load_crypto_strings,
181 ossl_init_load_crypto_strings)
183 /* Do nothing in this case */
187 static CRYPTO_ONCE add_all_ciphers = CRYPTO_ONCE_STATIC_INIT;
188 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_ciphers)
191 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
192 * pulling in all the ciphers during static linking
194 #ifndef OPENSSL_NO_AUTOALGINIT
195 OSSL_TRACE(INIT, "openssl_add_all_ciphers_int()\n");
196 openssl_add_all_ciphers_int();
201 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_add_all_ciphers,
202 ossl_init_add_all_ciphers)
208 static CRYPTO_ONCE add_all_digests = CRYPTO_ONCE_STATIC_INIT;
209 DEFINE_RUN_ONCE_STATIC(ossl_init_add_all_digests)
212 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
213 * pulling in all the ciphers during static linking
215 #ifndef OPENSSL_NO_AUTOALGINIT
216 OSSL_TRACE(INIT, "openssl_add_all_digests()\n");
217 openssl_add_all_digests_int();
222 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_add_all_digests,
223 ossl_init_add_all_digests)
229 static CRYPTO_ONCE config = CRYPTO_ONCE_STATIC_INIT;
230 static int config_inited = 0;
231 static const OPENSSL_INIT_SETTINGS *conf_settings = NULL;
232 DEFINE_RUN_ONCE_STATIC(ossl_init_config)
234 int ret = openssl_config_int(conf_settings);
238 DEFINE_RUN_ONCE_STATIC_ALT(ossl_init_no_config, ossl_init_config)
240 OSSL_TRACE(INIT, "openssl_no_config_int()\n");
241 openssl_no_config_int();
246 static CRYPTO_ONCE async = CRYPTO_ONCE_STATIC_INIT;
247 static int async_inited = 0;
248 DEFINE_RUN_ONCE_STATIC(ossl_init_async)
250 OSSL_TRACE(INIT, "async_init()\n");
257 #ifndef OPENSSL_NO_ENGINE
258 static CRYPTO_ONCE engine_openssl = CRYPTO_ONCE_STATIC_INIT;
259 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_openssl)
261 OSSL_TRACE(INIT, "engine_load_openssl_int()\n");
262 engine_load_openssl_int();
265 # ifndef OPENSSL_NO_RDRAND
266 static CRYPTO_ONCE engine_rdrand = CRYPTO_ONCE_STATIC_INIT;
267 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_rdrand)
269 OSSL_TRACE(INIT, "engine_load_rdrand_int()\n");
270 engine_load_rdrand_int();
274 static CRYPTO_ONCE engine_dynamic = CRYPTO_ONCE_STATIC_INIT;
275 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_dynamic)
277 OSSL_TRACE(INIT, "engine_load_dynamic_int()\n");
278 engine_load_dynamic_int();
281 # ifndef OPENSSL_NO_STATIC_ENGINE
282 # ifndef OPENSSL_NO_DEVCRYPTOENG
283 static CRYPTO_ONCE engine_devcrypto = CRYPTO_ONCE_STATIC_INIT;
284 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_devcrypto)
286 OSSL_TRACE(INIT, "engine_load_devcrypto_int()\n");
287 engine_load_devcrypto_int();
291 # if !defined(OPENSSL_NO_PADLOCKENG)
292 static CRYPTO_ONCE engine_padlock = CRYPTO_ONCE_STATIC_INIT;
293 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_padlock)
295 OSSL_TRACE(INIT, "engine_load_padlock_int()\n");
296 engine_load_padlock_int();
300 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
301 static CRYPTO_ONCE engine_capi = CRYPTO_ONCE_STATIC_INIT;
302 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_capi)
304 OSSL_TRACE(INIT, "engine_load_capi_int()\n");
305 engine_load_capi_int();
309 # if !defined(OPENSSL_NO_AFALGENG)
310 static CRYPTO_ONCE engine_afalg = CRYPTO_ONCE_STATIC_INIT;
311 DEFINE_RUN_ONCE_STATIC(ossl_init_engine_afalg)
313 OSSL_TRACE(INIT, "engine_load_afalg_int()\n");
314 engine_load_afalg_int();
321 #ifndef OPENSSL_NO_COMP
322 static CRYPTO_ONCE zlib = CRYPTO_ONCE_STATIC_INIT;
324 static int zlib_inited = 0;
325 DEFINE_RUN_ONCE_STATIC(ossl_init_zlib)
327 /* Do nothing - we need to know about this for the later cleanup */
333 void OPENSSL_cleanup(void)
335 OPENSSL_INIT_STOP *currhandler, *lasthandler;
338 * TODO(3.0): This function needs looking at with a view to moving most/all
339 * of this into onfree handlers in OPENSSL_CTX.
342 /* If we've not been inited then no need to deinit */
346 /* Might be explicitly called and also by atexit */
352 * Thread stop may not get automatically called by the thread library for
353 * the very last thread in some situations, so call it directly.
355 OPENSSL_thread_stop();
357 currhandler = stop_handlers;
358 while (currhandler != NULL) {
359 currhandler->handler();
360 lasthandler = currhandler;
361 currhandler = currhandler->next;
362 OPENSSL_free(lasthandler);
364 stop_handlers = NULL;
366 CRYPTO_THREAD_lock_free(init_lock);
370 * We assume we are single-threaded for this function, i.e. no race
371 * conditions for the various "*_inited" vars below.
374 #ifndef OPENSSL_NO_COMP
376 OSSL_TRACE(INIT, "OPENSSL_cleanup: comp_zlib_cleanup_int()\n");
377 comp_zlib_cleanup_int();
382 OSSL_TRACE(INIT, "OPENSSL_cleanup: async_deinit()\n");
386 if (load_crypto_strings_inited) {
387 OSSL_TRACE(INIT, "OPENSSL_cleanup: err_free_strings_int()\n");
388 err_free_strings_int();
392 * Note that cleanup order is important:
393 * - rand_cleanup_int could call an ENGINE's RAND cleanup function so
394 * must be called before engine_cleanup_int()
395 * - ENGINEs use CRYPTO_EX_DATA and therefore, must be cleaned up
396 * before the ex data handlers are wiped during default openssl_ctx deinit.
397 * - conf_modules_free_int() can end up in ENGINE code so must be called
398 * before engine_cleanup_int()
399 * - ENGINEs and additional EVP algorithms might use added OIDs names so
400 * obj_cleanup_int() must be called last
402 OSSL_TRACE(INIT, "OPENSSL_cleanup: rand_cleanup_int()\n");
405 OSSL_TRACE(INIT, "OPENSSL_cleanup: conf_modules_free_int()\n");
406 conf_modules_free_int();
408 #ifndef OPENSSL_NO_ENGINE
409 OSSL_TRACE(INIT, "OPENSSL_cleanup: engine_cleanup_int()\n");
410 engine_cleanup_int();
412 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_store_cleanup_int()\n");
413 ossl_store_cleanup_int();
415 OSSL_TRACE(INIT, "OPENSSL_cleanup: openssl_ctx_default_deinit()\n");
416 openssl_ctx_default_deinit();
418 ossl_cleanup_thread();
420 OSSL_TRACE(INIT, "OPENSSL_cleanup: bio_cleanup()\n");
423 OSSL_TRACE(INIT, "OPENSSL_cleanup: evp_cleanup_int()\n");
426 OSSL_TRACE(INIT, "OPENSSL_cleanup: obj_cleanup_int()\n");
429 OSSL_TRACE(INIT, "OPENSSL_cleanup: err_int()\n");
432 OSSL_TRACE(INIT, "OPENSSL_cleanup: CRYPTO_secure_malloc_done()\n");
433 CRYPTO_secure_malloc_done();
435 #ifndef OPENSSL_NO_CMP
436 OSSL_TRACE(INIT, "OPENSSL_cleanup: OSSL_CMP_log_close()\n");
437 OSSL_CMP_log_close();
440 OSSL_TRACE(INIT, "OPENSSL_cleanup: ossl_trace_cleanup()\n");
441 ossl_trace_cleanup();
447 * If this function is called with a non NULL settings value then it must be
448 * called prior to any threads making calls to any OpenSSL functions,
449 * i.e. passing a non-null settings value is assumed to be single-threaded.
451 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings)
454 * TODO(3.0): This function needs looking at with a view to moving most/all
455 * of this into OPENSSL_CTX.
459 if (!(opts & OPENSSL_INIT_BASE_ONLY))
460 CRYPTOerr(CRYPTO_F_OPENSSL_INIT_CRYPTO, ERR_R_INIT_FAIL);
465 * When the caller specifies OPENSSL_INIT_BASE_ONLY, that should be the
466 * *only* option specified. With that option we return immediately after
467 * doing the requested limited initialization. Note that
468 * err_shelve_state() called by us via ossl_init_load_crypto_nodelete()
469 * re-enters OPENSSL_init_crypto() with OPENSSL_INIT_BASE_ONLY, but with
470 * base already initialized this is a harmless NOOP.
472 * If we remain the only caller of err_shelve_state() the recursion should
473 * perhaps be removed, but if in doubt, it can be left in place.
475 if (!RUN_ONCE(&base, ossl_init_base))
478 if (opts & OPENSSL_INIT_BASE_ONLY)
482 * Now we don't always set up exit handlers, the INIT_BASE_ONLY calls
483 * should not have the side-effect of setting up exit handlers, and
484 * therefore, this code block is below the INIT_BASE_ONLY-conditioned early
487 if ((opts & OPENSSL_INIT_NO_ATEXIT) != 0) {
488 if (!RUN_ONCE_ALT(®ister_atexit, ossl_init_no_register_atexit,
489 ossl_init_register_atexit))
491 } else if (!RUN_ONCE(®ister_atexit, ossl_init_register_atexit)) {
495 if (!RUN_ONCE(&load_crypto_nodelete, ossl_init_load_crypto_nodelete))
498 if ((opts & OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS)
499 && !RUN_ONCE_ALT(&load_crypto_strings,
500 ossl_init_no_load_crypto_strings,
501 ossl_init_load_crypto_strings))
504 if ((opts & OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
505 && !RUN_ONCE(&load_crypto_strings, ossl_init_load_crypto_strings))
508 if ((opts & OPENSSL_INIT_NO_ADD_ALL_CIPHERS)
509 && !RUN_ONCE_ALT(&add_all_ciphers, ossl_init_no_add_all_ciphers,
510 ossl_init_add_all_ciphers))
513 if ((opts & OPENSSL_INIT_ADD_ALL_CIPHERS)
514 && !RUN_ONCE(&add_all_ciphers, ossl_init_add_all_ciphers))
517 if ((opts & OPENSSL_INIT_NO_ADD_ALL_DIGESTS)
518 && !RUN_ONCE_ALT(&add_all_digests, ossl_init_no_add_all_digests,
519 ossl_init_add_all_digests))
522 if ((opts & OPENSSL_INIT_ADD_ALL_DIGESTS)
523 && !RUN_ONCE(&add_all_digests, ossl_init_add_all_digests))
526 if ((opts & OPENSSL_INIT_ATFORK)
527 && !openssl_init_fork_handlers())
530 if ((opts & OPENSSL_INIT_NO_LOAD_CONFIG)
531 && !RUN_ONCE_ALT(&config, ossl_init_no_config, ossl_init_config))
534 if (opts & OPENSSL_INIT_LOAD_CONFIG) {
536 CRYPTO_THREAD_write_lock(init_lock);
537 conf_settings = settings;
538 ret = RUN_ONCE(&config, ossl_init_config);
539 conf_settings = NULL;
540 CRYPTO_THREAD_unlock(init_lock);
545 if ((opts & OPENSSL_INIT_ASYNC)
546 && !RUN_ONCE(&async, ossl_init_async))
549 #ifndef OPENSSL_NO_ENGINE
550 if ((opts & OPENSSL_INIT_ENGINE_OPENSSL)
551 && !RUN_ONCE(&engine_openssl, ossl_init_engine_openssl))
553 # ifndef OPENSSL_NO_RDRAND
554 if ((opts & OPENSSL_INIT_ENGINE_RDRAND)
555 && !RUN_ONCE(&engine_rdrand, ossl_init_engine_rdrand))
558 if ((opts & OPENSSL_INIT_ENGINE_DYNAMIC)
559 && !RUN_ONCE(&engine_dynamic, ossl_init_engine_dynamic))
561 # ifndef OPENSSL_NO_STATIC_ENGINE
562 # ifndef OPENSSL_NO_DEVCRYPTOENG
563 if ((opts & OPENSSL_INIT_ENGINE_CRYPTODEV)
564 && !RUN_ONCE(&engine_devcrypto, ossl_init_engine_devcrypto))
567 # if !defined(OPENSSL_NO_PADLOCKENG)
568 if ((opts & OPENSSL_INIT_ENGINE_PADLOCK)
569 && !RUN_ONCE(&engine_padlock, ossl_init_engine_padlock))
572 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
573 if ((opts & OPENSSL_INIT_ENGINE_CAPI)
574 && !RUN_ONCE(&engine_capi, ossl_init_engine_capi))
577 # if !defined(OPENSSL_NO_AFALGENG)
578 if ((opts & OPENSSL_INIT_ENGINE_AFALG)
579 && !RUN_ONCE(&engine_afalg, ossl_init_engine_afalg))
583 if (opts & (OPENSSL_INIT_ENGINE_ALL_BUILTIN
584 | OPENSSL_INIT_ENGINE_OPENSSL
585 | OPENSSL_INIT_ENGINE_AFALG)) {
586 ENGINE_register_all_complete();
590 #ifndef OPENSSL_NO_COMP
591 if ((opts & OPENSSL_INIT_ZLIB)
592 && !RUN_ONCE(&zlib, ossl_init_zlib))
599 int OPENSSL_atexit(void (*handler)(void))
601 OPENSSL_INIT_STOP *newhand;
603 #if !defined(OPENSSL_USE_NODELETE)\
604 && !defined(OPENSSL_NO_PINSHARED)
611 handlersym.func = handler;
612 # if defined(DSO_WIN32) && !defined(_WIN32_WCE)
614 HMODULE handle = NULL;
618 * We don't use the DSO route for WIN32 because there is a better
621 ret = GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
622 | GET_MODULE_HANDLE_EX_FLAG_PIN,
623 handlersym.sym, &handle);
628 # elif !defined(DSO_NONE)
630 * Deliberately leak a reference to the handler. This will force the
631 * library/code containing the handler to remain loaded until we run the
632 * atexit handler. If -znodelete has been used then this is
639 dso = DSO_dsobyaddr(handlersym.sym, DSO_FLAG_NO_UNLOAD_ON_FREE);
640 /* See same code above in ossl_init_base() for an explanation. */
642 "atexit: obtained DSO reference? %s\n",
643 (dso == NULL ? "No!" : "Yes."));
651 if ((newhand = OPENSSL_malloc(sizeof(*newhand))) == NULL) {
652 CRYPTOerr(CRYPTO_F_OPENSSL_ATEXIT, ERR_R_MALLOC_FAILURE);
656 newhand->handler = handler;
657 newhand->next = stop_handlers;
658 stop_handlers = newhand;
663 #ifdef OPENSSL_SYS_UNIX
665 * The following three functions are for OpenSSL developers. This is
666 * where we set/reset state across fork (called via pthread_atfork when
667 * it exists, or manually by the application when it doesn't).
669 * WARNING! If you put code in either OPENSSL_fork_parent or
670 * OPENSSL_fork_child, you MUST MAKE SURE that they are async-signal-
671 * safe. See this link, for example:
672 * http://man7.org/linux/man-pages/man7/signal-safety.7.html
675 void OPENSSL_fork_prepare(void)
679 void OPENSSL_fork_parent(void)
683 void OPENSSL_fork_child(void)
685 /* TODO(3.0): Inform all providers about a fork event */