2 * Written by Matt Caswell for the OpenSSL project.
4 /* ====================================================================
5 * Copyright (c) 2016 The OpenSSL Project. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. All advertising materials mentioning features or use of this
20 * software must display the following acknowledgment:
21 * "This product includes software developed by the OpenSSL Project
22 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25 * endorse or promote products derived from this software without
26 * prior written permission. For written permission, please contact
27 * openssl-core@openssl.org.
29 * 5. Products derived from this software may not be called "OpenSSL"
30 * nor may "OpenSSL" appear in their names without prior written
31 * permission of the OpenSSL Project.
33 * 6. Redistributions of any form whatsoever must retain the following
35 * "This product includes software developed by the OpenSSL Project
36 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49 * OF THE POSSIBILITY OF SUCH DAMAGE.
50 * ====================================================================
52 * This product includes cryptographic software written by Eric Young
53 * (eay@cryptsoft.com). This product includes software written by Tim
54 * Hudson (tjh@cryptsoft.com).
58 #include <internal/threads.h>
59 #include <internal/cryptlib_int.h>
60 #include <openssl/err.h>
61 #include <internal/rand.h>
62 #include <internal/bio.h>
63 #include <openssl/evp.h>
64 #include <internal/evp_int.h>
65 #include <internal/conf.h>
66 #include <internal/async.h>
67 #include <internal/engine.h>
68 #include <internal/comp.h>
69 #include <internal/err.h>
73 static int stopped = 0;
75 static void ossl_init_thread_stop(struct thread_local_inits_st *locals);
77 static CRYPTO_THREAD_LOCAL threadstopkey;
79 static void ossl_init_thread_stop_wrap(void *local)
81 ossl_init_thread_stop((struct thread_local_inits_st *)local);
84 static struct thread_local_inits_st *ossl_init_get_thread_local(int alloc)
86 struct thread_local_inits_st *local =
87 CRYPTO_THREAD_get_local(&threadstopkey);
89 if (local == NULL && alloc) {
90 local = OPENSSL_zalloc(sizeof *local);
91 CRYPTO_THREAD_set_local(&threadstopkey, local);
94 CRYPTO_THREAD_set_local(&threadstopkey, NULL);
100 typedef struct ossl_init_stop_st OPENSSL_INIT_STOP;
101 struct ossl_init_stop_st {
102 void (*handler)(void);
103 OPENSSL_INIT_STOP *next;
106 static OPENSSL_INIT_STOP *stop_handlers = NULL;
107 static CRYPTO_RWLOCK *init_lock = NULL;
109 static CRYPTO_ONCE base = CRYPTO_ONCE_STATIC_INIT;
110 static int base_inited = 0;
111 static void ossl_init_base(void)
113 #ifdef OPENSSL_INIT_DEBUG
114 fprintf(stderr, "OPENSSL_INIT: ossl_init_base: Setting up stop handlers\n");
117 * We use a dummy thread local key here. We use the destructor to detect
118 * when the thread is going to stop (where that feature is available)
120 CRYPTO_THREAD_init_local(&threadstopkey, ossl_init_thread_stop_wrap);
121 #ifndef OPENSSL_SYS_UEFI
122 atexit(OPENSSL_cleanup);
124 init_lock = CRYPTO_THREAD_lock_new();
125 OPENSSL_cpuid_setup();
129 static CRYPTO_ONCE load_crypto_strings = CRYPTO_ONCE_STATIC_INIT;
130 static int load_crypto_strings_inited = 0;
131 static void ossl_init_no_load_crypto_strings(void)
133 /* Do nothing in this case */
137 static void ossl_init_load_crypto_strings(void)
140 * OPENSSL_NO_AUTOERRINIT is provided here to prevent at compile time
141 * pulling in all the error strings during static linking
143 #if !defined(OPENSSL_NO_ERR) && !defined(OPENSSL_NO_AUTOERRINIT)
144 # ifdef OPENSSL_INIT_DEBUG
145 fprintf(stderr, "OPENSSL_INIT: ossl_init_load_crypto_strings: "
146 "err_load_crypto_strings_intern()\n");
148 err_load_crypto_strings_intern();
150 load_crypto_strings_inited = 1;
153 static CRYPTO_ONCE add_all_ciphers = CRYPTO_ONCE_STATIC_INIT;
154 static void ossl_init_add_all_ciphers(void)
157 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
158 * pulling in all the ciphers during static linking
160 #ifndef OPENSSL_NO_AUTOALGINIT
161 # ifdef OPENSSL_INIT_DEBUG
162 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_ciphers: "
163 "openssl_add_all_ciphers_internal()\n");
165 openssl_add_all_ciphers_internal();
166 # ifndef OPENSSL_NO_ENGINE
167 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
168 ENGINE_setup_bsd_cryptodev();
174 static CRYPTO_ONCE add_all_digests = CRYPTO_ONCE_STATIC_INIT;
175 static void ossl_init_add_all_digests(void)
178 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
179 * pulling in all the ciphers during static linking
181 #ifndef OPENSSL_NO_AUTOALGINIT
182 # ifdef OPENSSL_INIT_DEBUG
183 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_digests: "
184 "openssl_add_all_digests_internal()\n");
186 openssl_add_all_digests_internal();
187 # ifndef OPENSSL_NO_ENGINE
188 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
189 ENGINE_setup_bsd_cryptodev();
195 static void ossl_init_no_add_algs(void)
201 static CRYPTO_ONCE config = CRYPTO_ONCE_STATIC_INIT;
202 static int config_inited = 0;
203 static const char *config_filename;
204 static void ossl_init_config(void)
206 #ifdef OPENSSL_INIT_DEBUG
208 "OPENSSL_INIT: ossl_init_config: openssl_config_internal(%s)\n",
209 config_filename==NULL?"NULL":config_filename);
211 openssl_config_internal(config_filename);
214 static void ossl_init_no_config(void)
216 #ifdef OPENSSL_INIT_DEBUG
218 "OPENSSL_INIT: ossl_init_config: openssl_no_config_internal()\n");
220 openssl_no_config_internal();
224 static CRYPTO_ONCE async = CRYPTO_ONCE_STATIC_INIT;
225 static int async_inited = 0;
226 static void ossl_init_async(void)
228 #ifdef OPENSSL_INIT_DEBUG
229 fprintf(stderr, "OPENSSL_INIT: ossl_init_async: async_init()\n");
235 #ifndef OPENSSL_NO_ENGINE
236 static CRYPTO_ONCE engine_openssl = CRYPTO_ONCE_STATIC_INIT;
237 static void ossl_init_engine_openssl(void)
239 # ifdef OPENSSL_INIT_DEBUG
240 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_openssl: "
241 "engine_load_openssl_internal()\n");
243 engine_load_openssl_internal();
245 # if !defined(OPENSSL_NO_HW) && \
246 (defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV))
247 static CRYPTO_ONCE engine_cryptodev = CRYPTO_ONCE_STATIC_INIT;
248 static void ossl_init_engine_cryptodev(void)
250 # ifdef OPENSSL_INIT_DEBUG
251 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_cryptodev: "
252 "engine_load_cryptodev_internal()\n");
254 engine_load_cryptodev_internal();
258 # ifndef OPENSSL_NO_RDRAND
259 static CRYPTO_ONCE engine_rdrand = CRYPTO_ONCE_STATIC_INIT;
260 static void ossl_init_engine_rdrand(void)
262 # ifdef OPENSSL_INIT_DEBUG
263 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_rdrand: "
264 "engine_load_rdrand_internal()\n");
266 engine_load_rdrand_internal();
269 static CRYPTO_ONCE engine_dynamic = CRYPTO_ONCE_STATIC_INIT;
270 static void ossl_init_engine_dynamic(void)
272 # ifdef OPENSSL_INIT_DEBUG
273 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_dynamic: "
274 "engine_load_dynamic_internal()\n");
276 engine_load_dynamic_internal();
278 # ifndef OPENSSL_NO_STATIC_ENGINE
279 # if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_PADLOCK)
280 static CRYPTO_ONCE engine_padlock = CRYPTO_ONCE_STATIC_INIT;
281 static void ossl_init_engine_padlock(void)
283 # ifdef OPENSSL_INIT_DEBUG
284 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_padlock: "
285 "engine_load_padlock_internal()\n");
287 engine_load_padlock_internal();
290 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
291 static CRYPTO_ONCE engine_capi = CRYPTO_ONCE_STATIC_INIT;
292 static void ossl_init_engine_capi(void)
294 # ifdef OPENSSL_INIT_DEBUG
295 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_capi: "
296 "engine_load_capi_internal()\n");
298 engine_load_capi_internal();
301 static CRYPTO_ONCE engine_dasync = CRYPTO_ONCE_STATIC_INIT;
302 static void ossl_init_engine_dasync(void)
304 # ifdef OPENSSL_INIT_DEBUG
305 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_dasync: "
306 "engine_load_dasync_internal()\n");
308 engine_load_dasync_internal();
310 # if !defined(OPENSSL_NO_AFALGENG)
311 static CRYPTO_ONCE engine_afalg = CRYPTO_ONCE_STATIC_INIT;
312 static void ossl_init_engine_afalg(void)
314 # ifdef OPENSSL_INIT_DEBUG
315 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_afalg: "
316 "engine_load_afalg_internal()\n");
318 engine_load_afalg_internal();
324 #ifndef OPENSSL_NO_COMP
325 static CRYPTO_ONCE zlib = CRYPTO_ONCE_STATIC_INIT;
327 static int zlib_inited = 0;
328 static void ossl_init_zlib(void)
330 /* Do nothing - we need to know about this for the later cleanup */
335 static void ossl_init_thread_stop(struct thread_local_inits_st *locals)
337 /* Can't do much about this */
342 #ifdef OPENSSL_INIT_DEBUG
343 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
344 "ASYNC_cleanup_thread()\n");
346 ASYNC_cleanup_thread();
349 if (locals->err_state) {
350 #ifdef OPENSSL_INIT_DEBUG
351 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
352 "ERR_remove_thread_state()\n");
354 ERR_remove_thread_state();
357 OPENSSL_free(locals);
360 void OPENSSL_thread_stop(void)
362 ossl_init_thread_stop(
363 (struct thread_local_inits_st *)ossl_init_get_thread_local(0));
366 int ossl_init_thread_start(uint64_t opts)
368 struct thread_local_inits_st *locals = ossl_init_get_thread_local(1);
373 if (opts & OPENSSL_INIT_THREAD_ASYNC) {
374 #ifdef OPENSSL_INIT_DEBUG
375 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_start: "
376 "marking thread for async\n");
381 if (opts & OPENSSL_INIT_THREAD_ERR_STATE) {
382 #ifdef OPENSSL_INIT_DEBUG
383 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_start: "
384 "marking thread for err_state\n");
386 locals->err_state = 1;
392 void OPENSSL_cleanup(void)
394 OPENSSL_INIT_STOP *currhandler, *lasthandler;
396 /* If we've not been inited then no need to deinit */
400 /* Might be explicitly called and also by atexit */
406 * Thread stop may not get automatically called by the thread library for
407 * the very last thread in some situations, so call it directly.
409 ossl_init_thread_stop(ossl_init_get_thread_local(0));
411 currhandler = stop_handlers;
412 while (currhandler != NULL) {
413 currhandler->handler();
414 lasthandler = currhandler;
415 currhandler = currhandler->next;
416 OPENSSL_free(lasthandler);
418 stop_handlers = NULL;
420 CRYPTO_THREAD_lock_free(init_lock);
423 * We assume we are single-threaded for this function, i.e. no race
424 * conditions for the various "*_inited" vars below.
427 #ifndef OPENSSL_NO_COMP
429 #ifdef OPENSSL_INIT_DEBUG
430 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
431 "comp_zlib_cleanup_internal()\n");
433 comp_zlib_cleanup_internal();
438 # ifdef OPENSSL_INIT_DEBUG
439 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
445 if (load_crypto_strings_inited) {
446 #ifdef OPENSSL_INIT_DEBUG
447 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
448 "err_free_strings_intern()\n");
450 err_free_strings_intern();
453 CRYPTO_THREAD_cleanup_local(&threadstopkey);
455 #ifdef OPENSSL_INIT_DEBUG
456 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
457 "rand_cleanup_intern()\n");
458 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
459 "CONF_modules_free()\n");
460 #ifndef OPENSSL_NO_ENGINE
461 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
462 "ENGINE_cleanup()\n");
464 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
465 "crypto_cleanup_all_ex_data_intern()\n");
466 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
467 "bio_sock_cleanup_intern()\n");
468 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
469 "evp_cleanup_intern()\n");
470 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
474 * Note that cleanup order is important:
475 * - rand_cleanup_intern could call an ENINGE's RAND cleanup function so
476 * must be called before ENGINE_cleanup()
477 * - ENGINEs use CRYPTO_EX_DATA and therefore, must be cleaned up
478 * before the ex data handlers are wiped in CRYPTO_cleanup_all_ex_data().
479 * - CONF_modules_free() can end up in ENGINE code so must be called before
482 rand_cleanup_intern();
484 #ifndef OPENSSL_NO_ENGINE
487 crypto_cleanup_all_ex_data_intern();
488 #ifndef OPENSSL_NO_SOCK
489 bio_sock_cleanup_intern();
491 evp_cleanup_intern();
497 * If this function is called with a non NULL settings value then it must be
498 * called prior to any threads making calls to any OpenSSL functions,
499 * i.e. passing a non-null settings value is assumed to be single-threaded.
501 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings)
503 static int stoperrset = 0;
508 * We only ever set this once to avoid getting into an infinite
509 * loop where the error system keeps trying to init and fails so
513 CRYPTOerr(CRYPTO_F_OPENSSL_INIT_CRYPTO, ERR_R_INIT_FAIL);
518 if (!CRYPTO_THREAD_run_once(&base, ossl_init_base))
521 if ((opts & OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS)
522 && !CRYPTO_THREAD_run_once(&load_crypto_strings,
523 ossl_init_no_load_crypto_strings))
526 if ((opts & OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
527 && !CRYPTO_THREAD_run_once(&load_crypto_strings,
528 ossl_init_load_crypto_strings))
531 if ((opts & OPENSSL_INIT_NO_ADD_ALL_CIPHERS)
532 && !CRYPTO_THREAD_run_once(&add_all_ciphers, ossl_init_no_add_algs))
535 if ((opts & OPENSSL_INIT_ADD_ALL_CIPHERS)
536 && !CRYPTO_THREAD_run_once(&add_all_ciphers,
537 ossl_init_add_all_ciphers))
540 if ((opts & OPENSSL_INIT_NO_ADD_ALL_DIGESTS)
541 && !CRYPTO_THREAD_run_once(&add_all_digests, ossl_init_no_add_algs))
544 if ((opts & OPENSSL_INIT_ADD_ALL_DIGESTS)
545 && !CRYPTO_THREAD_run_once(&add_all_digests,
546 ossl_init_add_all_digests))
549 if ((opts & OPENSSL_INIT_NO_LOAD_CONFIG)
550 && !CRYPTO_THREAD_run_once(&config, ossl_init_no_config))
553 if (opts & OPENSSL_INIT_LOAD_CONFIG) {
555 CRYPTO_THREAD_write_lock(init_lock);
556 config_filename = (settings == NULL) ? NULL : settings->config_name;
557 ret = CRYPTO_THREAD_run_once(&config, ossl_init_config);
558 CRYPTO_THREAD_unlock(init_lock);
563 if ((opts & OPENSSL_INIT_ASYNC)
564 && !CRYPTO_THREAD_run_once(&async, ossl_init_async))
567 #ifndef OPENSSL_NO_ENGINE
568 if ((opts & OPENSSL_INIT_ENGINE_OPENSSL)
569 && !CRYPTO_THREAD_run_once(&engine_openssl,
570 ossl_init_engine_openssl))
572 # if !defined(OPENSSL_NO_HW) && \
573 (defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV))
574 if ((opts & OPENSSL_INIT_ENGINE_CRYPTODEV)
575 && !CRYPTO_THREAD_run_once(&engine_cryptodev,
576 ossl_init_engine_cryptodev))
579 # ifndef OPENSSL_NO_RDRAND
580 if ((opts & OPENSSL_INIT_ENGINE_RDRAND)
581 && !CRYPTO_THREAD_run_once(&engine_rdrand, ossl_init_engine_rdrand))
584 if ((opts & OPENSSL_INIT_ENGINE_DYNAMIC)
585 && !CRYPTO_THREAD_run_once(&engine_dynamic,
586 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 && !CRYPTO_THREAD_run_once(&engine_padlock,
592 ossl_init_engine_padlock))
595 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
596 if ((opts & OPENSSL_INIT_ENGINE_CAPI)
597 && !CRYPTO_THREAD_run_once(&engine_capi, ossl_init_engine_capi))
600 if ((opts & OPENSSL_INIT_ENGINE_DASYNC)
601 && !CRYPTO_THREAD_run_once(&engine_dasync, ossl_init_engine_dasync))
603 # if !defined(OPENSSL_NO_AFALGENG)
604 if ((opts & OPENSSL_INIT_ENGINE_AFALG)
605 && !CRYPTO_THREAD_run_once(&engine_afalg, ossl_init_engine_afalg))
609 if (opts & (OPENSSL_INIT_ENGINE_ALL_BUILTIN
610 | OPENSSL_INIT_ENGINE_DASYNC | OPENSSL_INIT_ENGINE_OPENSSL
611 | OPENSSL_INIT_ENGINE_AFALG)) {
612 ENGINE_register_all_complete();
616 #ifndef OPENSSL_NO_COMP
617 if ((opts & OPENSSL_INIT_ZLIB)
618 && !CRYPTO_THREAD_run_once(&zlib, ossl_init_zlib))
625 int OPENSSL_atexit(void (*handler)(void))
627 OPENSSL_INIT_STOP *newhand;
629 newhand = OPENSSL_malloc(sizeof(*newhand));
633 newhand->handler = handler;
634 newhand->next = stop_handlers;
635 stop_handlers = newhand;