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 #ifndef OPENSSL_SYS_UEFI
274 atexit(OPENSSL_cleanup);
276 OPENSSL_cpuid_setup();
280 static OPENSSL_INIT_ONCE load_crypto_strings = OPENSSL_INIT_ONCE_STATIC_INIT;
281 static int load_crypto_strings_inited = 0;
282 static void ossl_init_no_load_crypto_strings(void)
284 /* Do nothing in this case */
288 static void ossl_init_load_crypto_strings(void)
291 * OPENSSL_NO_AUTOERRINIT is provided here to prevent at compile time
292 * pulling in all the error strings during static linking
294 #if !defined(OPENSSL_NO_ERR) && !defined(OPENSSL_NO_AUTOERRINIT)
295 # ifdef OPENSSL_INIT_DEBUG
296 fprintf(stderr, "OPENSSL_INIT: ossl_init_load_crypto_strings: "
297 "err_load_crypto_strings_intern()\n");
299 err_load_crypto_strings_intern();
301 load_crypto_strings_inited = 1;
304 static OPENSSL_INIT_ONCE add_all_ciphers = OPENSSL_INIT_ONCE_STATIC_INIT;
305 static void ossl_init_add_all_ciphers(void)
308 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
309 * pulling in all the ciphers during static linking
311 #ifndef OPENSSL_NO_AUTOALGINIT
312 # ifdef OPENSSL_INIT_DEBUG
313 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_ciphers: "
314 "openssl_add_all_ciphers_internal()\n");
316 openssl_add_all_ciphers_internal();
317 # ifndef OPENSSL_NO_ENGINE
318 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
319 ENGINE_setup_bsd_cryptodev();
325 static OPENSSL_INIT_ONCE add_all_digests = OPENSSL_INIT_ONCE_STATIC_INIT;
326 static void ossl_init_add_all_digests(void)
329 * OPENSSL_NO_AUTOALGINIT is provided here to prevent at compile time
330 * pulling in all the ciphers during static linking
332 #ifndef OPENSSL_NO_AUTOALGINIT
333 # ifdef OPENSSL_INIT_DEBUG
334 fprintf(stderr, "OPENSSL_INIT: ossl_init_add_all_digests: "
335 "openssl_add_all_digests_internal()\n");
337 openssl_add_all_digests_internal();
338 # ifndef OPENSSL_NO_ENGINE
339 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
340 ENGINE_setup_bsd_cryptodev();
346 static void ossl_init_no_add_algs(void)
352 static OPENSSL_INIT_ONCE config = OPENSSL_INIT_ONCE_STATIC_INIT;
353 static int config_inited = 0;
354 static const char *config_filename;
355 static void ossl_init_config(void)
357 #ifdef OPENSSL_INIT_DEBUG
359 "OPENSSL_INIT: ossl_init_config: openssl_config_internal(%s)\n",
360 config_filename==NULL?"NULL":config_filename);
362 openssl_config_internal(config_filename);
365 static void ossl_init_no_config(void)
367 #ifdef OPENSSL_INIT_DEBUG
369 "OPENSSL_INIT: ossl_init_config: openssl_no_config_internal()\n");
371 openssl_no_config_internal();
375 static OPENSSL_INIT_ONCE async = OPENSSL_INIT_ONCE_STATIC_INIT;
376 static int async_inited = 0;
377 static void ossl_init_async(void)
379 #ifdef OPENSSL_INIT_DEBUG
380 fprintf(stderr, "OPENSSL_INIT: ossl_init_async: async_init()\n");
386 #ifndef OPENSSL_NO_ENGINE
387 static int engine_inited = 0;
388 static OPENSSL_INIT_ONCE engine_openssl = OPENSSL_INIT_ONCE_STATIC_INIT;
389 static void ossl_init_engine_openssl(void)
391 # ifdef OPENSSL_INIT_DEBUG
392 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_openssl: "
393 "engine_load_openssl_internal()\n");
395 engine_load_openssl_internal();
398 # if !defined(OPENSSL_NO_HW) && \
399 (defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV))
400 static OPENSSL_INIT_ONCE engine_cryptodev = OPENSSL_INIT_ONCE_STATIC_INIT;
401 static void ossl_init_engine_cryptodev(void)
403 # ifdef OPENSSL_INIT_DEBUG
404 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_cryptodev: "
405 "engine_load_cryptodev_internal()\n");
407 engine_load_cryptodev_internal();
412 # ifndef OPENSSL_NO_RDRAND
413 static OPENSSL_INIT_ONCE engine_rdrand = OPENSSL_INIT_ONCE_STATIC_INIT;
414 static void ossl_init_engine_rdrand(void)
416 # ifdef OPENSSL_INIT_DEBUG
417 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_rdrand: "
418 "engine_load_rdrand_internal()\n");
420 engine_load_rdrand_internal();
424 static OPENSSL_INIT_ONCE engine_dynamic = OPENSSL_INIT_ONCE_STATIC_INIT;
425 static void ossl_init_engine_dynamic(void)
427 # ifdef OPENSSL_INIT_DEBUG
428 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_dynamic: "
429 "engine_load_dynamic_internal()\n");
431 engine_load_dynamic_internal();
434 # ifndef OPENSSL_NO_STATIC_ENGINE
435 # if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_PADLOCK)
436 static OPENSSL_INIT_ONCE engine_padlock = OPENSSL_INIT_ONCE_STATIC_INIT;
437 static void ossl_init_engine_padlock(void)
439 # ifdef OPENSSL_INIT_DEBUG
440 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_padlock: "
441 "engine_load_padlock_internal()\n");
443 engine_load_padlock_internal();
447 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
448 static OPENSSL_INIT_ONCE engine_capi = OPENSSL_INIT_ONCE_STATIC_INIT;
449 static void ossl_init_engine_capi(void)
451 # ifdef OPENSSL_INIT_DEBUG
452 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_capi: "
453 "engine_load_capi_internal()\n");
455 engine_load_capi_internal();
459 static OPENSSL_INIT_ONCE engine_dasync = OPENSSL_INIT_ONCE_STATIC_INIT;
460 static void ossl_init_engine_dasync(void)
462 # ifdef OPENSSL_INIT_DEBUG
463 fprintf(stderr, "OPENSSL_INIT: ossl_init_engine_dasync: "
464 "engine_load_dasync_internal()\n");
466 engine_load_dasync_internal();
472 static OPENSSL_INIT_ONCE zlib = OPENSSL_INIT_ONCE_STATIC_INIT;
473 static int zlib_inited = 0;
474 static void ossl_init_zlib(void)
476 /* Do nothing - we need to know about this for the later cleanup */
480 static void ossl_init_thread_stop(struct thread_local_inits_st *locals)
482 /* Can't do much about this */
487 #ifdef OPENSSL_INIT_DEBUG
488 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
489 "ASYNC_cleanup_thread()\n");
491 ASYNC_cleanup_thread();
494 if (locals->err_state) {
495 #ifdef OPENSSL_INIT_DEBUG
496 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_stop: "
497 "ERR_remove_thread_state(NULL)\n");
499 ERR_remove_thread_state(NULL);
502 OPENSSL_free(locals);
503 ossl_init_thread_stop_cleanup();
506 void OPENSSL_thread_stop(void)
508 ossl_init_thread_stop(
509 (struct thread_local_inits_st *)ossl_init_get_thread_local(0));
512 int ossl_init_thread_start(uint64_t opts)
514 struct thread_local_inits_st *locals = ossl_init_get_thread_local(1);
519 if (opts & OPENSSL_INIT_THREAD_ASYNC) {
520 #ifdef OPENSSL_INIT_DEBUG
521 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_start: "
522 "marking thread for async\n");
527 if (opts & OPENSSL_INIT_THREAD_ERR_STATE) {
528 #ifdef OPENSSL_INIT_DEBUG
529 fprintf(stderr, "OPENSSL_INIT: ossl_init_thread_start: "
530 "marking thread for err_state\n");
532 locals->err_state = 1;
538 void OPENSSL_cleanup(void)
540 OPENSSL_INIT_STOP *currhandler, *lasthandler;
542 /* If we've not been inited then no need to deinit */
546 /* Might be explicitly called and also by atexit */
552 * Thread stop may not get automatically called by the thread library for
553 * the very last thread in some situations, so call it directly.
555 ossl_init_thread_stop(ossl_init_get_thread_local(0));
557 currhandler = stop_handlers;
558 while (currhandler != NULL) {
559 currhandler->handler();
560 lasthandler = currhandler;
561 currhandler = currhandler->next;
562 OPENSSL_free(lasthandler);
564 stop_handlers = NULL;
566 * We assume we are single-threaded for this function, i.e. no race
567 * conditions for the various "*_inited" vars below.
571 #ifdef OPENSSL_INIT_DEBUG
572 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
573 "COMP_zlib_cleanup()\n");
578 #ifndef OPENSSL_NO_ENGINE
580 # ifdef OPENSSL_INIT_DEBUG
581 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
582 "ENGINE_cleanup()\n");
588 if (load_crypto_strings_inited) {
589 #ifdef OPENSSL_INIT_DEBUG
590 fprintf(stderr, "OPENSSL_INIT: OPENSSL_cleanup: "
591 "ERR_free_strings()\n");
596 #ifdef OPENSSL_INIT_DEBUG
597 fprintf(stderr, "OPENSSL_INIT: OPENSSL_INIT_library_stop: "
598 "CRYPTO_cleanup_all_ex_data()\n");
599 fprintf(stderr, "OPENSSL_INIT: OPENSSL_INIT_library_stop: "
601 fprintf(stderr, "OPENSSL_INIT: OPENSSL_INIT_library_stop: "
602 "CONF_modules_free()\n");
603 fprintf(stderr, "OPENSSL_INIT: OPENSSL_INIT_library_stop: "
606 CRYPTO_cleanup_all_ex_data();
614 * If this function is called with a non NULL settings value then it must be
615 * called prior to any threads making calls to any OpenSSL functions,
616 * i.e. passing a non-null settings value is assumed to be single-threaded.
618 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings)
620 static int stoperrset = 0;
625 * We only ever set this once to avoid getting into an infinite
626 * loop where the error system keeps trying to init and fails so
630 CRYPTOerr(CRYPTO_F_OPENSSL_INIT_CRYPTO, ERR_R_INIT_FAIL);
635 ossl_init_once_run(&base, ossl_init_base);
637 if (opts & OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS)
638 ossl_init_once_run(&load_crypto_strings,
639 ossl_init_no_load_crypto_strings);
641 if (opts & OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
642 ossl_init_once_run(&load_crypto_strings, ossl_init_load_crypto_strings);
644 if (opts & OPENSSL_INIT_NO_ADD_ALL_CIPHERS)
645 ossl_init_once_run(&add_all_ciphers, ossl_init_no_add_algs);
647 if (opts & OPENSSL_INIT_ADD_ALL_CIPHERS)
648 ossl_init_once_run(&add_all_ciphers, ossl_init_add_all_ciphers);
650 if (opts & OPENSSL_INIT_NO_ADD_ALL_DIGESTS)
651 ossl_init_once_run(&add_all_digests, ossl_init_no_add_algs);
653 if (opts & OPENSSL_INIT_ADD_ALL_DIGESTS)
654 ossl_init_once_run(&add_all_digests, ossl_init_add_all_digests);
656 if (opts & OPENSSL_INIT_NO_LOAD_CONFIG) {
657 ossl_init_once_run(&config, ossl_init_no_config);
660 if (opts & OPENSSL_INIT_LOAD_CONFIG) {
661 CRYPTO_w_lock(CRYPTO_LOCK_INIT);
662 config_filename = (settings == NULL) ? NULL : settings->config_name;
663 ossl_init_once_run(&config, ossl_init_config);
664 CRYPTO_w_unlock(CRYPTO_LOCK_INIT);
667 if (opts & OPENSSL_INIT_ASYNC) {
668 ossl_init_once_run(&async, ossl_init_async);
671 #ifndef OPENSSL_NO_ENGINE
672 if (opts & OPENSSL_INIT_ENGINE_OPENSSL) {
673 ossl_init_once_run(&engine_openssl, ossl_init_engine_openssl);
675 # if !defined(OPENSSL_NO_HW) && \
676 (defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV))
677 if (opts & OPENSSL_INIT_ENGINE_CRYPTODEV) {
678 ossl_init_once_run(&engine_cryptodev, ossl_init_engine_cryptodev);
681 # ifndef OPENSSL_NO_RDRAND
682 if (opts & OPENSSL_INIT_ENGINE_RDRAND) {
683 ossl_init_once_run(&engine_rdrand, ossl_init_engine_rdrand);
686 if (opts & OPENSSL_INIT_ENGINE_DYNAMIC) {
687 ossl_init_once_run(&engine_dynamic, ossl_init_engine_dynamic);
689 # ifndef OPENSSL_NO_STATIC_ENGINE
690 # if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_PADLOCK)
691 if (opts & OPENSSL_INIT_ENGINE_PADLOCK) {
692 ossl_init_once_run(&engine_padlock, ossl_init_engine_padlock);
695 # if defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_NO_CAPIENG)
696 if (opts & OPENSSL_INIT_ENGINE_CAPI) {
697 ossl_init_once_run(&engine_capi, ossl_init_engine_capi);
700 if (opts & OPENSSL_INIT_ENGINE_DASYNC) {
701 ossl_init_once_run(&engine_dasync, ossl_init_engine_dasync);
704 if (opts & (OPENSSL_INIT_ENGINE_ALL_BUILTIN
705 | OPENSSL_INIT_ENGINE_DASYNC | OPENSSL_INIT_ENGINE_OPENSSL)) {
706 ENGINE_register_all_complete();
710 if (opts & OPENSSL_INIT_ZLIB) {
711 ossl_init_once_run(&zlib, ossl_init_zlib);
717 int OPENSSL_atexit(void (*handler)(void))
719 OPENSSL_INIT_STOP *newhand;
721 newhand = OPENSSL_malloc(sizeof(*newhand));
725 newhand->handler = handler;
726 newhand->next = stop_handlers;
727 stop_handlers = newhand;