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
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 OPENSSL_init_crypto(0, NULL
);
24 global_engine_lock
= CRYPTO_THREAD_lock_new();
25 return global_engine_lock
!= NULL
;
28 ENGINE
*ENGINE_new(void)
32 if (!RUN_ONCE(&engine_lock_init
, do_engine_lock_init
)
33 || (ret
= OPENSSL_zalloc(sizeof(*ret
))) == NULL
) {
34 ENGINEerr(ENGINE_F_ENGINE_NEW
, ERR_R_MALLOC_FAILURE
);
38 engine_ref_debug(ret
, 0, 1);
39 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE
, ret
, &ret
->ex_data
)) {
47 * Placed here (close proximity to ENGINE_new) so that modifications to the
48 * elements of the ENGINE structure are more likely to be caught and changed
51 void engine_set_all_null(ENGINE
*e
)
65 e
->load_privkey
= NULL
;
66 e
->load_pubkey
= NULL
;
71 int engine_free_util(ENGINE
*e
, int not_locked
)
78 CRYPTO_DOWN_REF(&e
->struct_ref
, &i
, global_engine_lock
);
81 CRYPTO_atomic_add(&e
->struct_ref
, -1, &i
, global_engine_lock
);
85 engine_ref_debug(e
, 0, -1);
88 REF_ASSERT_ISNT(i
< 0);
89 /* Free up any dynamically allocated public key methods */
90 engine_pkey_meths_free(e
);
91 engine_pkey_asn1_meths_free(e
);
93 * Give the ENGINE a chance to do any structural cleanup corresponding to
94 * allocation it did in its constructor (eg. unload error strings)
98 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE
, e
, &e
->ex_data
);
103 int ENGINE_free(ENGINE
*e
)
105 return engine_free_util(e
, 1);
111 * engine_cleanup_int() is coded such that anything that does work that will
112 * need cleanup can register a "cleanup" callback here. That way we don't get
113 * linker bloat by referring to all *possible* cleanups, but any linker bloat
114 * into code "X" will cause X's cleanup function to end up here.
116 static STACK_OF(ENGINE_CLEANUP_ITEM
) *cleanup_stack
= NULL
;
117 static int int_cleanup_check(int create
)
123 cleanup_stack
= sk_ENGINE_CLEANUP_ITEM_new_null();
124 return (cleanup_stack
? 1 : 0);
127 static ENGINE_CLEANUP_ITEM
*int_cleanup_item(ENGINE_CLEANUP_CB
*cb
)
129 ENGINE_CLEANUP_ITEM
*item
= OPENSSL_malloc(sizeof(*item
));
136 void engine_cleanup_add_first(ENGINE_CLEANUP_CB
*cb
)
138 ENGINE_CLEANUP_ITEM
*item
;
139 if (!int_cleanup_check(1))
141 item
= int_cleanup_item(cb
);
143 sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack
, item
, 0);
146 void engine_cleanup_add_last(ENGINE_CLEANUP_CB
*cb
)
148 ENGINE_CLEANUP_ITEM
*item
;
149 if (!int_cleanup_check(1))
151 item
= int_cleanup_item(cb
);
153 sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack
, item
);
156 /* The API function that performs all cleanup */
157 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM
*item
)
163 void engine_cleanup_int(void)
165 if (int_cleanup_check(0)) {
166 sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack
,
167 engine_cleanup_cb_free
);
168 cleanup_stack
= NULL
;
170 CRYPTO_THREAD_lock_free(global_engine_lock
);
173 /* Now the "ex_data" support */
175 int ENGINE_set_ex_data(ENGINE
*e
, int idx
, void *arg
)
177 return CRYPTO_set_ex_data(&e
->ex_data
, idx
, arg
);
180 void *ENGINE_get_ex_data(const ENGINE
*e
, int idx
)
182 return CRYPTO_get_ex_data(&e
->ex_data
, idx
);
186 * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
187 * ENGINE structure itself.
190 int ENGINE_set_id(ENGINE
*e
, const char *id
)
193 ENGINEerr(ENGINE_F_ENGINE_SET_ID
, ERR_R_PASSED_NULL_PARAMETER
);
200 int ENGINE_set_name(ENGINE
*e
, const char *name
)
203 ENGINEerr(ENGINE_F_ENGINE_SET_NAME
, ERR_R_PASSED_NULL_PARAMETER
);
210 int ENGINE_set_destroy_function(ENGINE
*e
, ENGINE_GEN_INT_FUNC_PTR destroy_f
)
212 e
->destroy
= destroy_f
;
216 int ENGINE_set_init_function(ENGINE
*e
, ENGINE_GEN_INT_FUNC_PTR init_f
)
222 int ENGINE_set_finish_function(ENGINE
*e
, ENGINE_GEN_INT_FUNC_PTR finish_f
)
224 e
->finish
= finish_f
;
228 int ENGINE_set_ctrl_function(ENGINE
*e
, ENGINE_CTRL_FUNC_PTR ctrl_f
)
234 int ENGINE_set_flags(ENGINE
*e
, int flags
)
240 int ENGINE_set_cmd_defns(ENGINE
*e
, const ENGINE_CMD_DEFN
*defns
)
242 e
->cmd_defns
= defns
;
246 const char *ENGINE_get_id(const ENGINE
*e
)
251 const char *ENGINE_get_name(const ENGINE
*e
)
256 ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_destroy_function(const ENGINE
*e
)
261 ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_init_function(const ENGINE
*e
)
266 ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_finish_function(const ENGINE
*e
)
271 ENGINE_CTRL_FUNC_PTR
ENGINE_get_ctrl_function(const ENGINE
*e
)
276 int ENGINE_get_flags(const ENGINE
*e
)
281 const ENGINE_CMD_DEFN
*ENGINE_get_cmd_defns(const ENGINE
*e
)
287 * eng_lib.o is pretty much linked into anything that touches ENGINE already,
288 * so put the "static_state" hack here.
291 static int internal_static_hack
= 0;
293 void *ENGINE_get_static_state(void)
295 return &internal_static_hack
;