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/cryptlib_int.h>
59 #include <openssl/err.h>
60 #include <openssl/rand.h>
61 #include <openssl/evp.h>
62 #include <internal/evp_int.h>
63 #include <internal/conf.h>
64 #include <internal/async.h>
65 #include <internal/engine.h>
66 #include <openssl/comp.h>
67 #include <internal/err.h>
71 static int stopped = 0;
73 static void ossl_init_thread_stop(struct thread_local_inits_st *locals);
75 /* Implement "once" functionality */
76 #if !defined(OPENSSL_THREADS)
77 typedef int OPENSSL_INIT_ONCE;
78 # define OPENSSL_INIT_ONCE_STATIC_INIT 0
80 static void ossl_init_once_run(OPENSSL_INIT_ONCE *once, void (*init)(void))
82 if (*once == OPENSSL_INIT_ONCE_STATIC_INIT) {
88 static int ossl_init_setup_thread_stop(void)
91 * There are no threads to stop. Do nothing.
96 static void ossl_init_thread_stop_cleanup(void)
100 static struct thread_local_inits_st *local = NULL;
101 static struct thread_local_inits_st *ossl_init_get_thread_local(int alloc)
103 struct thread_local_inits_st *tmp;
107 if (local == NULL && alloc)
108 tmp = local = OPENSSL_zalloc(sizeof(*local));
116 #elif defined(OPENSSL_SYS_WINDOWS)
118 # include <windows.h>
120 # if _WIN32_WINNT < 0x0600
123 * Versions before 0x0600 (Windows Vista, Windows Server 2008 or later) do not
124 * have InitOnceExecuteOnce, so we fall back to using a spinlock instead.
126 typedef LONG OPENSSL_INIT_ONCE;
127 # define OPENSSL_INIT_ONCE_STATIC_INIT 0
129 # define ONCE_UNINITED 0
130 # define ONCE_ININIT 1
133 static void ossl_init_once_run(OPENSSL_INIT_ONCE *once, void (*init)(void))
135 LONG volatile *lock = (LONG *)once;
138 if (*lock == ONCE_DONE)
142 result = InterlockedCompareExchange(lock, ONCE_ININIT, ONCE_UNINITED);
143 if (result == ONCE_UNINITED) {
148 } while (result == ONCE_ININIT);
153 typedef INIT_ONCE OPENSSL_INIT_ONCE;
154 # define OPENSSL_INIT_ONCE_STATIC_INIT INIT_ONCE_STATIC_INIT
156 static BOOL CALLBACK once_cb(PINIT_ONCE once, PVOID initfp, PVOID *unused)
158 void (*init)(void) = initfp;
165 static void ossl_init_once_run(OPENSSL_INIT_ONCE *once, void (*init)(void))
167 InitOnceExecuteOnce((INIT_ONCE *)once, once_cb, init, NULL);
171 static DWORD threadstopkey = TLS_OUT_OF_INDEXES;
173 static int ossl_init_setup_thread_stop(void)
176 * We use a dummy thread local key here. We use the destructor to detect
177 * when the thread is going to stop
179 threadstopkey = TlsAlloc();
180 if (threadstopkey == TLS_OUT_OF_INDEXES)
186 static void ossl_init_thread_stop_cleanup(void)
188 if (threadstopkey != TLS_OUT_OF_INDEXES) {
189 TlsFree(threadstopkey);
193 static struct thread_local_inits_st *ossl_init_get_thread_local(int alloc)
195 struct thread_local_inits_st *local = TlsGetValue(threadstopkey);
197 if (local == NULL && alloc) {
198 local = OPENSSL_zalloc(sizeof *local);
199 TlsSetValue(threadstopkey, local);
202 TlsSetValue(threadstopkey, NULL);
209 # include <pthread.h>
211 static pthread_key_t threadstopkey;
213 typedef pthread_once_t OPENSSL_INIT_ONCE;
214 # define OPENSSL_INIT_ONCE_STATIC_INIT PTHREAD_ONCE_INIT
216 static void ossl_init_once_run(OPENSSL_INIT_ONCE *once, void (*init)(void))
218 pthread_once(once, init);
221 static void ossl_init_thread_stop_wrap(void *local)
223 ossl_init_thread_stop((struct thread_local_inits_st *)local);
226 static int ossl_init_setup_thread_stop(void)
229 * We use a dummy thread local key here. We use the destructor to detect
230 * when the thread is going to stop
232 return (pthread_key_create(&threadstopkey,
233 ossl_init_thread_stop_wrap) == 0);
236 static void ossl_init_thread_stop_cleanup(void)
240 static struct thread_local_inits_st *ossl_init_get_thread_local(int alloc)
242 struct thread_local_inits_st *local = pthread_getspecific(threadstopkey);
244 if (local == NULL && alloc) {
245 local = OPENSSL_zalloc(sizeof *local);
246 pthread_setspecific(threadstopkey, local);
249 pthread_setspecific(threadstopkey, NULL);
257 typedef struct ossl_init_stop_st OPENSSL_INIT_STOP;
258 struct ossl_init_stop_st {
259 void (*handler)(void);
260 OPENSSL_INIT_STOP *next;
263 static OPENSSL_INIT_STOP *stop_handlers = NULL;
265 static OPENSSL_INIT_ONCE base = OPENSSL_INIT_ONCE_STATIC_INIT;
266 static int base_inited = 0;
267 static void ossl_init_base(void)
269 #ifdef OPENSSL_INIT_DEBUG
270 fprintf(stderr, "OPENSSL_INIT: ossl_init_base: Setting up stop handlers\n");
272 ossl_init_setup_thread_stop();
273 atexit(OPENSSL_cleanup);
274 OPENSSL_cpuid_setup();
278 static OPENSSL_INIT_ONCE load_crypto_strings = OPENSSL_INIT_ONCE_STATIC_INIT;
279 static int load_crypto_strings_inited = 0;
280 static void ossl_init_no_load_crypto_strings(void)
282 /* Do nothing in this case */
286 static void ossl_init_load_crypto_strings(void)
289 * OPENSSL_NO_AUTOERRINIT is provided here to prevent at compile time
290 * pulling in all the error strings during static linking
292 #if !defined(OPENSSL_NO_ERR) && !defined(OPENSSL_NO_AUTOERRINIT)
293 # ifdef OPENSSL_INIT_DEBUG
294 fprintf(stderr, "OPENSSL_INIT: ossl_init_load_crypto_strings: "
295 "err_load_crypto_strings_intern()\n");
297 err_load_crypto_strings_intern();
299 load_crypto_strings_inited = 1;
302 static OPENSSL_INIT_ONCE add_all_ciphers = OPENSSL_INIT_ONCE_STATIC_INIT;
303 static void ossl_init_add_all_ciphers(void)
306 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
307 * pulling in all the ciphers during static linking
309 #ifndef OPENSSL_NO_AUTOALGINIT
310 # ifdef OPENSSL_INIT_DEBUG
311 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_ciphers: "
312 "openssl_add_all_ciphers_internal()\n");
314 openssl_add_all_ciphers_internal();
315 # ifndef OPENSSL_NO_ENGINE
316 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
317 ENGINE_setup_bsd_cryptodev();
323 static OPENSSL_INIT_ONCE add_all_digests = OPENSSL_INIT_ONCE_STATIC_INIT;
324 static void ossl_init_add_all_digests(void)
327 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
328 * pulling in all the ciphers during static linking
330 #ifndef OPENSSL_NO_AUTOALGINIT
331 # ifdef OPENSSL_INIT_DEBUG
332 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_digests: "
333 "openssl_add_all_digests_internal()\n");
335 openssl_add_all_digests_internal();
336 # ifndef OPENSSL_NO_ENGINE
337 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
338 ENGINE_setup_bsd_cryptodev();
344 static void ossl_init_no_add_algs(void)
350 static OPENSSL_INIT_ONCE config = OPENSSL_INIT_ONCE_STATIC_INIT;
351 static int config_inited = 0;
352 static const char *config_filename;
353 static void ossl_init_config(void)
355 #ifdef OPENSSL_INIT_DEBUG
357 "OPENSSL_INIT: ossl_init_config: openssl_config_internal(%s)\n",
358 config_filename==NULL?"NULL":config_filename);
360 openssl_config_internal(config_filename);
363 static void ossl_init_no_config(void)
365 #ifdef OPENSSL_INIT_DEBUG
367 "OPENSSL_INIT: ossl_init_config: openssl_no_config_internal()\n");
369 openssl_no_config_internal();
373 static OPENSSL_INIT_ONCE async = OPENSSL_INIT_ONCE_STATIC_INIT;
374 static int async_inited = 0;
375 static void ossl_init_async(void)
377 #ifdef OPENSSL_INIT_DEBUG
378 fprintf(stderr, "OPENSSL_INIT: ossl_init_async: async_init()\n");
384 #ifndef OPENSSL_NO_ENGINE
385 static int engine_inited = 0;
386 static OPENSSL_INIT_ONCE engine_openssl = OPENSSL_INIT_ONCE_STATIC_INIT;
387 static void ossl_init_engine_openssl(void)
389 # ifdef OPENSSL_INIT_DEBUG
390 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_openssl: "
391 "engine_load_openssl_internal()\n");
393 engine_load_openssl_internal();
396 # if !defined(OPENSSL_NO_HW) && \
397 (defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV))
398 static OPENSSL_INIT_ONCE engine_cryptodev = OPENSSL_INIT_ONCE_STATIC_INIT;
399 static void ossl_init_engine_cryptodev(void)
401 # ifdef OPENSSL_INIT_DEBUG
402 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_cryptodev: "
403 "engine_load_cryptodev_internal()\n");
405 engine_load_cryptodev_internal();
410 # ifndef OPENSSL_NO_RDRAND
411 static OPENSSL_INIT_ONCE engine_rdrand = OPENSSL_INIT_ONCE_STATIC_INIT;
412 static void ossl_init_engine_rdrand(void)
414 # ifdef OPENSSL_INIT_DEBUG
415 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_rdrand: "
416 "engine_load_rdrand_internal()\n");
418 engine_load_rdrand_internal();
422 static OPENSSL_INIT_ONCE engine_dynamic = OPENSSL_INIT_ONCE_STATIC_INIT;
423 static void ossl_init_engine_dynamic(void)
425 # ifdef OPENSSL_INIT_DEBUG
426 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_dynamic: "
427 "engine_load_dynamic_internal()\n");
429 engine_load_dynamic_internal();
432 # ifndef OPENSSL_NO_STATIC_ENGINE
433 # if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_PADLOCK)
434 static OPENSSL_INIT_ONCE engine_padlock = OPENSSL_INIT_ONCE_STATIC_INIT;
435 static void ossl_init_engine_padlock(void)
437 # ifdef OPENSSL_INIT_DEBUG
438 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_padlock: "
439 "engine_load_padlock_internal()\n");
441 engine_load_padlock_internal();
445 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
446 static OPENSSL_INIT_ONCE engine_capi = OPENSSL_INIT_ONCE_STATIC_INIT;
447 static void ossl_init_engine_capi(void)
449 # ifdef OPENSSL_INIT_DEBUG
450 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_capi: "
451 "engine_load_capi_internal()\n");
453 engine_load_capi_internal();
457 static OPENSSL_INIT_ONCE engine_dasync = OPENSSL_INIT_ONCE_STATIC_INIT;
458 static void ossl_init_engine_dasync(void)
460 # ifdef OPENSSL_INIT_DEBUG
461 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_dasync: "
462 "engine_load_dasync_internal()\n");
464 engine_load_dasync_internal();
470 static OPENSSL_INIT_ONCE zlib = OPENSSL_INIT_ONCE_STATIC_INIT;
471 static int zlib_inited = 0;
472 static void ossl_init_zlib(void)
474 /* Do nothing - we need to know about this for the later cleanup */
478 static void ossl_init_thread_stop(struct thread_local_inits_st *locals)
480 /* Can't do much about this */
485 #ifdef OPENSSL_INIT_DEBUG
486 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
487 "ASYNC_cleanup_thread()\n");
489 ASYNC_cleanup_thread();
492 if (locals->err_state) {
493 #ifdef OPENSSL_INIT_DEBUG
494 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
495 "ERR_remove_thread_state(NULL)\n");
497 ERR_remove_thread_state(NULL);
500 OPENSSL_free(locals);
501 ossl_init_thread_stop_cleanup();
504 void OPENSSL_thread_stop(void)
506 ossl_init_thread_stop(
507 (struct thread_local_inits_st *)ossl_init_get_thread_local(0));
510 int ossl_init_thread_start(uint64_t opts)
512 struct thread_local_inits_st *locals = ossl_init_get_thread_local(1);
517 if (opts & OPENSSL_INIT_THREAD_ASYNC) {
518 #ifdef OPENSSL_INIT_DEBUG
519 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_start: "
520 "marking thread for async\n");
525 if (opts & OPENSSL_INIT_THREAD_ERR_STATE) {
526 #ifdef OPENSSL_INIT_DEBUG
527 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_start: "
528 "marking thread for err_state\n");
530 locals->err_state = 1;
536 void OPENSSL_cleanup(void)
538 OPENSSL_INIT_STOP *currhandler, *lasthandler;
540 /* If we've not been inited then no need to deinit */
544 /* Might be explicitly called and also by atexit */
550 * Thread stop may not get automatically called by the thread library for
551 * the very last thread in some situations, so call it directly.
553 ossl_init_thread_stop(ossl_init_get_thread_local(0));
555 currhandler = stop_handlers;
556 while (currhandler != NULL) {
557 currhandler->handler();
558 lasthandler = currhandler;
559 currhandler = currhandler->next;
560 OPENSSL_free(lasthandler);
562 stop_handlers = NULL;
564 * We assume we are single-threaded for this function, i.e. no race
565 * conditions for the various "*_inited" vars below.
569 #ifdef OPENSSL_INIT_DEBUG
570 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
571 "COMP_zlib_cleanup()\n");
576 #ifndef OPENSSL_NO_ENGINE
578 # ifdef OPENSSL_INIT_DEBUG
579 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
580 "ENGINE_cleanup()\n");
586 if (load_crypto_strings_inited) {
587 #ifdef OPENSSL_INIT_DEBUG
588 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
589 "ERR_free_strings()\n");
594 #ifdef OPENSSL_INIT_DEBUG
595 fprintf(stderr, "OPENSSL_INIT: OPENSSL_INIT_library_stop: "
596 "CRYPTO_cleanup_all_ex_data()\n");
597 fprintf(stderr, "OPENSSL_INIT: OPENSSL_INIT_library_stop: "
599 fprintf(stderr, "OPENSSL_INIT: OPENSSL_INIT_library_stop: "
600 "CONF_modules_free()\n");
601 fprintf(stderr, "OPENSSL_INIT: OPENSSL_INIT_library_stop: "
604 CRYPTO_cleanup_all_ex_data();
612 * If this function is called with a non NULL settings value then it must be
613 * called prior to any threads making calls to any OpenSSL functions,
614 * i.e. passing a non-null settings value is assumed to be single-threaded.
616 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings)
618 static int stoperrset = 0;
623 * We only ever set this once to avoid getting into an infinite
624 * loop where the error system keeps trying to init and fails so
628 CRYPTOerr(CRYPTO_F_OPENSSL_INIT_CRYPTO, ERR_R_INIT_FAIL);
633 ossl_init_once_run(&base, ossl_init_base);
635 if (opts & OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS)
636 ossl_init_once_run(&load_crypto_strings,
637 ossl_init_no_load_crypto_strings);
639 if (opts & OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
640 ossl_init_once_run(&load_crypto_strings, ossl_init_load_crypto_strings);
642 if (opts & OPENSSL_INIT_NO_ADD_ALL_CIPHERS)
643 ossl_init_once_run(&add_all_ciphers, ossl_init_no_add_algs);
645 if (opts & OPENSSL_INIT_ADD_ALL_CIPHERS)
646 ossl_init_once_run(&add_all_ciphers, ossl_init_add_all_ciphers);
648 if (opts & OPENSSL_INIT_NO_ADD_ALL_DIGESTS)
649 ossl_init_once_run(&add_all_digests, ossl_init_no_add_algs);
651 if (opts & OPENSSL_INIT_ADD_ALL_DIGESTS)
652 ossl_init_once_run(&add_all_digests, ossl_init_add_all_digests);
654 if (opts & OPENSSL_INIT_NO_LOAD_CONFIG) {
655 ossl_init_once_run(&config, ossl_init_no_config);
658 if (opts & OPENSSL_INIT_LOAD_CONFIG) {
659 CRYPTO_w_lock(CRYPTO_LOCK_INIT);
660 config_filename = (settings == NULL) ? NULL : settings->config_name;
661 ossl_init_once_run(&config, ossl_init_config);
662 CRYPTO_w_unlock(CRYPTO_LOCK_INIT);
665 if (opts & OPENSSL_INIT_ASYNC) {
666 ossl_init_once_run(&async, ossl_init_async);
669 #ifndef OPENSSL_NO_ENGINE
670 if (opts & OPENSSL_INIT_ENGINE_OPENSSL) {
671 ossl_init_once_run(&engine_openssl, ossl_init_engine_openssl);
673 # if !defined(OPENSSL_NO_HW) && \
674 (defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV))
675 if (opts & OPENSSL_INIT_ENGINE_CRYPTODEV) {
676 ossl_init_once_run(&engine_cryptodev, ossl_init_engine_cryptodev);
679 # ifndef OPENSSL_NO_RDRAND
680 if (opts & OPENSSL_INIT_ENGINE_RDRAND) {
681 ossl_init_once_run(&engine_rdrand, ossl_init_engine_rdrand);
684 if (opts & OPENSSL_INIT_ENGINE_DYNAMIC) {
685 ossl_init_once_run(&engine_dynamic, ossl_init_engine_dynamic);
687 # ifndef OPENSSL_NO_STATIC_ENGINE
688 # if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_PADLOCK)
689 if (opts & OPENSSL_INIT_ENGINE_PADLOCK) {
690 ossl_init_once_run(&engine_padlock, ossl_init_engine_padlock);
693 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
694 if (opts & OPENSSL_INIT_ENGINE_CAPI) {
695 ossl_init_once_run(&engine_capi, ossl_init_engine_capi);
698 if (opts & OPENSSL_INIT_ENGINE_DASYNC) {
699 ossl_init_once_run(&engine_dasync, ossl_init_engine_dasync);
702 if (opts & (OPENSSL_INIT_ENGINE_ALL_BUILTIN
703 | OPENSSL_INIT_ENGINE_DASYNC | OPENSSL_INIT_ENGINE_OPENSSL)) {
704 ENGINE_register_all_complete();
708 if (opts & OPENSSL_INIT_ZLIB) {
709 ossl_init_once_run(&zlib, ossl_init_zlib);
715 int OPENSSL_atexit(void (*handler)(void))
717 OPENSSL_INIT_STOP *newhand;
719 newhand = OPENSSL_malloc(sizeof(*newhand));
723 newhand->handler = handler;
724 newhand->next = stop_handlers;
725 stop_handlers = newhand;