2 * Copyright 2001-2021 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 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 ERR_raise(ERR_LIB_ENGINE, ERR_R_MALLOC_FAILURE);
37 ENGINE_REF_PRINT(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 not_locked)
77 CRYPTO_DOWN_REF(&e->struct_ref, &i, global_engine_lock);
80 ENGINE_REF_PRINT(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;
126 if ((item = OPENSSL_malloc(sizeof(*item))) == NULL) {
127 ERR_raise(ERR_LIB_ENGINE, ERR_R_MALLOC_FAILURE);
134 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
136 ENGINE_CLEANUP_ITEM *item;
138 if (!int_cleanup_check(1))
140 item = int_cleanup_item(cb);
142 sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
145 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
147 ENGINE_CLEANUP_ITEM *item;
148 if (!int_cleanup_check(1))
150 item = int_cleanup_item(cb);
152 if (sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item) <= 0)
157 /* The API function that performs all cleanup */
158 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
164 void engine_cleanup_int(void)
166 if (int_cleanup_check(0)) {
167 sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
168 engine_cleanup_cb_free);
169 cleanup_stack = NULL;
171 CRYPTO_THREAD_lock_free(global_engine_lock);
172 global_engine_lock = NULL;
175 /* Now the "ex_data" support */
177 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
179 return CRYPTO_set_ex_data(&e->ex_data, idx, arg);
182 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
184 return CRYPTO_get_ex_data(&e->ex_data, idx);
188 * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
189 * ENGINE structure itself.
192 int ENGINE_set_id(ENGINE *e, const char *id)
195 ERR_raise(ERR_LIB_ENGINE, ERR_R_PASSED_NULL_PARAMETER);
202 int ENGINE_set_name(ENGINE *e, const char *name)
205 ERR_raise(ERR_LIB_ENGINE, ERR_R_PASSED_NULL_PARAMETER);
212 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
214 e->destroy = destroy_f;
218 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
224 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
226 e->finish = finish_f;
230 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
236 int ENGINE_set_flags(ENGINE *e, int flags)
242 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
244 e->cmd_defns = defns;
248 const char *ENGINE_get_id(const ENGINE *e)
253 const char *ENGINE_get_name(const ENGINE *e)
258 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
263 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
268 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
273 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
278 int ENGINE_get_flags(const ENGINE *e)
283 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
289 * eng_lib.o is pretty much linked into anything that touches ENGINE already,
290 * so put the "static_state" hack here.
293 static int internal_static_hack = 0;
295 void *ENGINE_get_static_state(void)
297 return &internal_static_hack;