2 * Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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 <openssl/rand.h>
13 CRYPTO_RWLOCK *global_engine_lock;
15 CRYPTO_ONCE engine_lock_init = CRYPTO_ONCE_STATIC_INIT;
17 /* The "new"/"free" stuff first */
19 DEFINE_RUN_ONCE(do_engine_lock_init)
21 if (!OPENSSL_init_crypto(0, NULL))
23 global_engine_lock = CRYPTO_THREAD_lock_new();
24 return global_engine_lock != NULL;
27 ENGINE *ENGINE_new(void)
31 if (!RUN_ONCE(&engine_lock_init, do_engine_lock_init)
32 || (ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
33 ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
37 engine_ref_debug(ret, 0, 1);
38 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data)) {
46 * Placed here (close proximity to ENGINE_new) so that modifications to the
47 * elements of the ENGINE structure are more likely to be caught and changed
50 void engine_set_all_null(ENGINE *e)
64 e->load_privkey = NULL;
65 e->load_pubkey = NULL;
70 int engine_free_util(ENGINE *e, int locked)
77 CRYPTO_atomic_add(&e->struct_ref, -1, &i, global_engine_lock);
80 engine_ref_debug(e, 0, -1)
83 REF_ASSERT_ISNT(i < 0);
84 /* Free up any dynamically allocated public key methods */
85 engine_pkey_meths_free(e);
86 engine_pkey_asn1_meths_free(e);
88 * Give the ENGINE a chance to do any structural cleanup corresponding to
89 * allocation it did in its constructor (eg. unload error strings)
93 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
98 int ENGINE_free(ENGINE *e)
100 return engine_free_util(e, 1);
106 * engine_cleanup_int() is coded such that anything that does work that will
107 * need cleanup can register a "cleanup" callback here. That way we don't get
108 * linker bloat by referring to all *possible* cleanups, but any linker bloat
109 * into code "X" will cause X's cleanup function to end up here.
111 static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
112 static int int_cleanup_check(int create)
118 cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
119 return (cleanup_stack ? 1 : 0);
122 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
124 ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(*item));
131 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
133 ENGINE_CLEANUP_ITEM *item;
134 if (!int_cleanup_check(1))
136 item = int_cleanup_item(cb);
138 sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
141 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
143 ENGINE_CLEANUP_ITEM *item;
144 if (!int_cleanup_check(1))
146 item = int_cleanup_item(cb);
148 if (sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item) <= 0)
153 /* The API function that performs all cleanup */
154 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
160 void engine_cleanup_int(void)
162 if (int_cleanup_check(0)) {
163 sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
164 engine_cleanup_cb_free);
165 cleanup_stack = NULL;
167 CRYPTO_THREAD_lock_free(global_engine_lock);
170 /* Now the "ex_data" support */
172 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
174 return (CRYPTO_set_ex_data(&e->ex_data, idx, arg));
177 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
179 return (CRYPTO_get_ex_data(&e->ex_data, idx));
183 * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
184 * ENGINE structure itself.
187 int ENGINE_set_id(ENGINE *e, const char *id)
190 ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER);
197 int ENGINE_set_name(ENGINE *e, const char *name)
200 ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER);
207 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
209 e->destroy = destroy_f;
213 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
219 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
221 e->finish = finish_f;
225 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
231 int ENGINE_set_flags(ENGINE *e, int flags)
237 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
239 e->cmd_defns = defns;
243 const char *ENGINE_get_id(const ENGINE *e)
248 const char *ENGINE_get_name(const ENGINE *e)
253 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
258 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
263 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
268 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
273 int ENGINE_get_flags(const ENGINE *e)
278 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
284 * eng_lib.o is pretty much linked into anything that touches ENGINE already,
285 * so put the "static_state" hack here.
288 static int internal_static_hack = 0;
290 void *ENGINE_get_static_state(void)
292 return &internal_static_hack;