2 * Copyright 2001-2020 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 "eng_local.h"
12 #include <openssl/rand.h>
13 #include "internal/refcount.h"
15 CRYPTO_RWLOCK *global_engine_lock;
17 CRYPTO_ONCE engine_lock_init = CRYPTO_ONCE_STATIC_INIT;
19 /* The "new"/"free" stuff first */
21 DEFINE_RUN_ONCE(do_engine_lock_init)
23 if (!OPENSSL_init_crypto(0, NULL))
25 global_engine_lock = CRYPTO_THREAD_lock_new();
26 return global_engine_lock != NULL;
29 ENGINE *ENGINE_new(void)
33 if (!RUN_ONCE(&engine_lock_init, do_engine_lock_init)
34 || (ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
35 ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
39 engine_ref_debug(ret, 0, 1);
40 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data)) {
48 * Placed here (close proximity to ENGINE_new) so that modifications to the
49 * elements of the ENGINE structure are more likely to be caught and changed
52 void engine_set_all_null(ENGINE *e)
66 e->load_privkey = NULL;
67 e->load_pubkey = NULL;
72 int engine_free_util(ENGINE *e, int not_locked)
79 CRYPTO_DOWN_REF(&e->struct_ref, &i, global_engine_lock);
82 engine_ref_debug(e, 0, -1);
85 REF_ASSERT_ISNT(i < 0);
86 /* Free up any dynamically allocated public key methods */
87 engine_pkey_meths_free(e);
88 engine_pkey_asn1_meths_free(e);
90 * Give the ENGINE a chance to do any structural cleanup corresponding to
91 * allocation it did in its constructor (eg. unload error strings)
95 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
100 int ENGINE_free(ENGINE *e)
102 return engine_free_util(e, 1);
108 * engine_cleanup_int() is coded such that anything that does work that will
109 * need cleanup can register a "cleanup" callback here. That way we don't get
110 * linker bloat by referring to all *possible* cleanups, but any linker bloat
111 * into code "X" will cause X's cleanup function to end up here.
113 static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
114 static int int_cleanup_check(int create)
120 cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
121 return (cleanup_stack ? 1 : 0);
124 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
126 ENGINE_CLEANUP_ITEM *item;
128 if ((item = OPENSSL_malloc(sizeof(*item))) == NULL) {
129 ENGINEerr(ENGINE_F_INT_CLEANUP_ITEM, ERR_R_MALLOC_FAILURE);
136 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
138 ENGINE_CLEANUP_ITEM *item;
140 if (!int_cleanup_check(1))
142 item = int_cleanup_item(cb);
144 sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
147 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
149 ENGINE_CLEANUP_ITEM *item;
150 if (!int_cleanup_check(1))
152 item = int_cleanup_item(cb);
154 if (sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item) <= 0)
159 /* The API function that performs all cleanup */
160 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
166 void engine_cleanup_int(void)
168 if (int_cleanup_check(0)) {
169 sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
170 engine_cleanup_cb_free);
171 cleanup_stack = NULL;
173 CRYPTO_THREAD_lock_free(global_engine_lock);
174 global_engine_lock = NULL;
177 /* Now the "ex_data" support */
179 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
181 return CRYPTO_set_ex_data(&e->ex_data, idx, arg);
184 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
186 return CRYPTO_get_ex_data(&e->ex_data, idx);
190 * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
191 * ENGINE structure itself.
194 int ENGINE_set_id(ENGINE *e, const char *id)
197 ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER);
204 int ENGINE_set_name(ENGINE *e, const char *name)
207 ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER);
214 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
216 e->destroy = destroy_f;
220 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
226 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
228 e->finish = finish_f;
232 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
238 int ENGINE_set_flags(ENGINE *e, int flags)
244 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
246 e->cmd_defns = defns;
250 const char *ENGINE_get_id(const ENGINE *e)
255 const char *ENGINE_get_name(const ENGINE *e)
260 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
265 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
270 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
275 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
280 int ENGINE_get_flags(const ENGINE *e)
285 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
291 * eng_lib.o is pretty much linked into anything that touches ENGINE already,
292 * so put the "static_state" hack here.
295 static int internal_static_hack = 0;
297 void *ENGINE_get_static_state(void)
299 return &internal_static_hack;