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>
70 #include <internal/objects.h>
74 static int stopped = 0;
76 static void ossl_init_thread_stop(struct thread_local_inits_st *locals);
78 static CRYPTO_THREAD_LOCAL threadstopkey;
80 static void ossl_init_thread_stop_wrap(void *local)
82 ossl_init_thread_stop((struct thread_local_inits_st *)local);
85 static struct thread_local_inits_st *ossl_init_get_thread_local(int alloc)
87 struct thread_local_inits_st *local =
88 CRYPTO_THREAD_get_local(&threadstopkey);
90 if (local == NULL && alloc) {
91 local = OPENSSL_zalloc(sizeof *local);
92 CRYPTO_THREAD_set_local(&threadstopkey, local);
95 CRYPTO_THREAD_set_local(&threadstopkey, NULL);
101 typedef struct ossl_init_stop_st OPENSSL_INIT_STOP;
102 struct ossl_init_stop_st {
103 void (*handler)(void);
104 OPENSSL_INIT_STOP *next;
107 static OPENSSL_INIT_STOP *stop_handlers = NULL;
108 static CRYPTO_RWLOCK *init_lock = NULL;
110 static CRYPTO_ONCE base = CRYPTO_ONCE_STATIC_INIT;
111 static int base_inited = 0;
112 static void ossl_init_base(void)
114 #ifdef OPENSSL_INIT_DEBUG
115 fprintf(stderr, "OPENSSL_INIT: ossl_init_base: Setting up stop handlers\n");
118 * We use a dummy thread local key here. We use the destructor to detect
119 * when the thread is going to stop (where that feature is available)
121 CRYPTO_THREAD_init_local(&threadstopkey, ossl_init_thread_stop_wrap);
122 #ifndef OPENSSL_SYS_UEFI
123 atexit(OPENSSL_cleanup);
125 init_lock = CRYPTO_THREAD_lock_new();
126 OPENSSL_cpuid_setup();
130 static CRYPTO_ONCE load_crypto_strings = CRYPTO_ONCE_STATIC_INIT;
131 static int load_crypto_strings_inited = 0;
132 static void ossl_init_no_load_crypto_strings(void)
134 /* Do nothing in this case */
138 static void ossl_init_load_crypto_strings(void)
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 err_load_crypto_strings_int();
151 load_crypto_strings_inited = 1;
154 static CRYPTO_ONCE add_all_ciphers = CRYPTO_ONCE_STATIC_INIT;
155 static void ossl_init_add_all_ciphers(void)
158 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
159 * pulling in all the ciphers during static linking
161 #ifndef OPENSSL_NO_AUTOALGINIT
162 # ifdef OPENSSL_INIT_DEBUG
163 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_ciphers: "
164 "openssl_add_all_ciphers_int()\n");
166 openssl_add_all_ciphers_int();
167 # ifndef OPENSSL_NO_ENGINE
168 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
169 ENGINE_setup_bsd_cryptodev();
175 static CRYPTO_ONCE add_all_digests = CRYPTO_ONCE_STATIC_INIT;
176 static void ossl_init_add_all_digests(void)
179 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
180 * pulling in all the ciphers during static linking
182 #ifndef OPENSSL_NO_AUTOALGINIT
183 # ifdef OPENSSL_INIT_DEBUG
184 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_digests: "
185 "openssl_add_all_digests()\n");
187 openssl_add_all_digests_int();
188 # ifndef OPENSSL_NO_ENGINE
189 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
190 ENGINE_setup_bsd_cryptodev();
196 static void ossl_init_no_add_algs(void)
202 static CRYPTO_ONCE config = CRYPTO_ONCE_STATIC_INIT;
203 static int config_inited = 0;
204 static const char *config_filename;
205 static void ossl_init_config(void)
207 #ifdef OPENSSL_INIT_DEBUG
209 "OPENSSL_INIT: ossl_init_config: openssl_config(%s)\n",
210 config_filename==NULL?"NULL":config_filename);
212 openssl_config_int(config_filename);
215 static void ossl_init_no_config(void)
217 #ifdef OPENSSL_INIT_DEBUG
219 "OPENSSL_INIT: ossl_init_config: openssl_no_config_int()\n");
221 openssl_no_config_int();
225 static CRYPTO_ONCE async = CRYPTO_ONCE_STATIC_INIT;
226 static int async_inited = 0;
227 static void ossl_init_async(void)
229 #ifdef OPENSSL_INIT_DEBUG
230 fprintf(stderr, "OPENSSL_INIT: ossl_init_async: async_init()\n");
236 #ifndef OPENSSL_NO_ENGINE
237 static CRYPTO_ONCE engine_openssl = CRYPTO_ONCE_STATIC_INIT;
238 static void ossl_init_engine_openssl(void)
240 # ifdef OPENSSL_INIT_DEBUG
241 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_openssl: "
242 "engine_load_openssl_int()\n");
244 engine_load_openssl_int();
246 # if !defined(OPENSSL_NO_HW) && \
247 (defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV))
248 static CRYPTO_ONCE engine_cryptodev = CRYPTO_ONCE_STATIC_INIT;
249 static void ossl_init_engine_cryptodev(void)
251 # ifdef OPENSSL_INIT_DEBUG
252 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_cryptodev: "
253 "engine_load_cryptodev_int()\n");
255 engine_load_cryptodev_int();
259 # ifndef OPENSSL_NO_RDRAND
260 static CRYPTO_ONCE engine_rdrand = CRYPTO_ONCE_STATIC_INIT;
261 static void ossl_init_engine_rdrand(void)
263 # ifdef OPENSSL_INIT_DEBUG
264 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_rdrand: "
265 "engine_load_rdrand_int()\n");
267 engine_load_rdrand_int();
270 static CRYPTO_ONCE engine_dynamic = CRYPTO_ONCE_STATIC_INIT;
271 static void ossl_init_engine_dynamic(void)
273 # ifdef OPENSSL_INIT_DEBUG
274 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_dynamic: "
275 "engine_load_dynamic_int()\n");
277 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 static void ossl_init_engine_padlock(void)
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();
291 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
292 static CRYPTO_ONCE engine_capi = CRYPTO_ONCE_STATIC_INIT;
293 static void ossl_init_engine_capi(void)
295 # ifdef OPENSSL_INIT_DEBUG
296 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_capi: "
297 "engine_load_capi_int()\n");
299 engine_load_capi_int();
302 static CRYPTO_ONCE engine_dasync = CRYPTO_ONCE_STATIC_INIT;
303 static void ossl_init_engine_dasync(void)
305 # ifdef OPENSSL_INIT_DEBUG
306 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_dasync: "
307 "engine_load_dasync_int()\n");
309 engine_load_dasync_int();
311 # if !defined(OPENSSL_NO_AFALGENG)
312 static CRYPTO_ONCE engine_afalg = CRYPTO_ONCE_STATIC_INIT;
313 static void ossl_init_engine_afalg(void)
315 # ifdef OPENSSL_INIT_DEBUG
316 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_afalg: "
317 "engine_load_afalg_int()\n");
319 engine_load_afalg_int();
325 #ifndef OPENSSL_NO_COMP
326 static CRYPTO_ONCE zlib = CRYPTO_ONCE_STATIC_INIT;
328 static int zlib_inited = 0;
329 static void ossl_init_zlib(void)
331 /* Do nothing - we need to know about this for the later cleanup */
336 static void ossl_init_thread_stop(struct thread_local_inits_st *locals)
338 /* Can't do much about this */
343 #ifdef OPENSSL_INIT_DEBUG
344 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
345 "ASYNC_cleanup_thread()\n");
347 ASYNC_cleanup_thread();
350 if (locals->err_state) {
351 #ifdef OPENSSL_INIT_DEBUG
352 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
353 "ERR_remove_thread_state()\n");
355 ERR_remove_thread_state();
358 OPENSSL_free(locals);
361 void OPENSSL_thread_stop(void)
363 ossl_init_thread_stop(
364 (struct thread_local_inits_st *)ossl_init_get_thread_local(0));
367 int ossl_init_thread_start(uint64_t opts)
369 struct thread_local_inits_st *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: "
470 "evp_cleanup_int()\n");
471 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
472 "obj_cleanup_int()\n");
475 * Note that cleanup order is important:
476 * - rand_cleanup_int could call an ENINGE's RAND cleanup function so
477 * must be called before engine_cleanup_int()
478 * - ENGINEs use CRYPTO_EX_DATA and therefore, must be cleaned up
479 * before the ex data handlers are wiped in CRYPTO_cleanup_all_ex_data().
480 * - conf_modules_free_int() can end up in ENGINE code so must be called
481 * before engine_cleanup_int()
484 conf_modules_free_int();
485 #ifndef OPENSSL_NO_ENGINE
486 engine_cleanup_int();
488 crypto_cleanup_all_ex_data_int();
489 #ifndef OPENSSL_NO_SOCK
490 bio_sock_cleanup_int();
498 * If this function is called with a non NULL settings value then it must be
499 * called prior to any threads making calls to any OpenSSL functions,
500 * i.e. passing a non-null settings value is assumed to be single-threaded.
502 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings)
504 static int stoperrset = 0;
509 * We only ever set this once to avoid getting into an infinite
510 * loop where the error system keeps trying to init and fails so
514 CRYPTOerr(CRYPTO_F_OPENSSL_INIT_CRYPTO, ERR_R_INIT_FAIL);
519 if (!CRYPTO_THREAD_run_once(&base, ossl_init_base))
522 if ((opts & OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS)
523 && !CRYPTO_THREAD_run_once(&load_crypto_strings,
524 ossl_init_no_load_crypto_strings))
527 if ((opts & OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
528 && !CRYPTO_THREAD_run_once(&load_crypto_strings,
529 ossl_init_load_crypto_strings))
532 if ((opts & OPENSSL_INIT_NO_ADD_ALL_CIPHERS)
533 && !CRYPTO_THREAD_run_once(&add_all_ciphers, ossl_init_no_add_algs))
536 if ((opts & OPENSSL_INIT_ADD_ALL_CIPHERS)
537 && !CRYPTO_THREAD_run_once(&add_all_ciphers,
538 ossl_init_add_all_ciphers))
541 if ((opts & OPENSSL_INIT_NO_ADD_ALL_DIGESTS)
542 && !CRYPTO_THREAD_run_once(&add_all_digests, ossl_init_no_add_algs))
545 if ((opts & OPENSSL_INIT_ADD_ALL_DIGESTS)
546 && !CRYPTO_THREAD_run_once(&add_all_digests,
547 ossl_init_add_all_digests))
550 if ((opts & OPENSSL_INIT_NO_LOAD_CONFIG)
551 && !CRYPTO_THREAD_run_once(&config, ossl_init_no_config))
554 if (opts & OPENSSL_INIT_LOAD_CONFIG) {
556 CRYPTO_THREAD_write_lock(init_lock);
557 config_filename = (settings == NULL) ? NULL : settings->config_name;
558 ret = CRYPTO_THREAD_run_once(&config, ossl_init_config);
559 CRYPTO_THREAD_unlock(init_lock);
564 if ((opts & OPENSSL_INIT_ASYNC)
565 && !CRYPTO_THREAD_run_once(&async, ossl_init_async))
568 #ifndef OPENSSL_NO_ENGINE
569 if ((opts & OPENSSL_INIT_ENGINE_OPENSSL)
570 && !CRYPTO_THREAD_run_once(&engine_openssl,
571 ossl_init_engine_openssl))
573 # if !defined(OPENSSL_NO_HW) && \
574 (defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV))
575 if ((opts & OPENSSL_INIT_ENGINE_CRYPTODEV)
576 && !CRYPTO_THREAD_run_once(&engine_cryptodev,
577 ossl_init_engine_cryptodev))
580 # ifndef OPENSSL_NO_RDRAND
581 if ((opts & OPENSSL_INIT_ENGINE_RDRAND)
582 && !CRYPTO_THREAD_run_once(&engine_rdrand, ossl_init_engine_rdrand))
585 if ((opts & OPENSSL_INIT_ENGINE_DYNAMIC)
586 && !CRYPTO_THREAD_run_once(&engine_dynamic,
587 ossl_init_engine_dynamic))
589 # ifndef OPENSSL_NO_STATIC_ENGINE
590 # if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_PADLOCK)
591 if ((opts & OPENSSL_INIT_ENGINE_PADLOCK)
592 && !CRYPTO_THREAD_run_once(&engine_padlock,
593 ossl_init_engine_padlock))
596 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
597 if ((opts & OPENSSL_INIT_ENGINE_CAPI)
598 && !CRYPTO_THREAD_run_once(&engine_capi, ossl_init_engine_capi))
601 if ((opts & OPENSSL_INIT_ENGINE_DASYNC)
602 && !CRYPTO_THREAD_run_once(&engine_dasync, ossl_init_engine_dasync))
604 # if !defined(OPENSSL_NO_AFALGENG)
605 if ((opts & OPENSSL_INIT_ENGINE_AFALG)
606 && !CRYPTO_THREAD_run_once(&engine_afalg, ossl_init_engine_afalg))
610 if (opts & (OPENSSL_INIT_ENGINE_ALL_BUILTIN
611 | OPENSSL_INIT_ENGINE_DASYNC | OPENSSL_INIT_ENGINE_OPENSSL
612 | OPENSSL_INIT_ENGINE_AFALG)) {
613 ENGINE_register_all_complete();
617 #ifndef OPENSSL_NO_COMP
618 if ((opts & OPENSSL_INIT_ZLIB)
619 && !CRYPTO_THREAD_run_once(&zlib, ossl_init_zlib))
626 int OPENSSL_atexit(void (*handler)(void))
628 OPENSSL_INIT_STOP *newhand;
630 newhand = OPENSSL_malloc(sizeof(*newhand));
634 newhand->handler = handler;
635 newhand->next = stop_handlers;
636 stop_handlers = newhand;