2 * Copyright 2001-2016 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>
12 #include "internal/refcount.h"
14 CRYPTO_RWLOCK
*global_engine_lock
;
16 CRYPTO_ONCE engine_lock_init
= CRYPTO_ONCE_STATIC_INIT
;
18 /* The "new"/"free" stuff first */
20 DEFINE_RUN_ONCE(do_engine_lock_init
)
22 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 not_locked
)
77 CRYPTO_DOWN_REF(&e
->struct_ref
, &i
, global_engine_lock
);
80 CRYPTO_atomic_add(&e
->struct_ref
, -1, &i
, global_engine_lock
);
84 engine_ref_debug(e
, 0, -1)
87 REF_ASSERT_ISNT(i
< 0);
88 /* Free up any dynamically allocated public key methods */
89 engine_pkey_meths_free(e
);
90 engine_pkey_asn1_meths_free(e
);
92 * Give the ENGINE a chance to do any structural cleanup corresponding to
93 * allocation it did in its constructor (eg. unload error strings)
97 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE
, e
, &e
->ex_data
);
102 int ENGINE_free(ENGINE
*e
)
104 return engine_free_util(e
, 1);
110 * engine_cleanup_int() is coded such that anything that does work that will
111 * need cleanup can register a "cleanup" callback here. That way we don't get
112 * linker bloat by referring to all *possible* cleanups, but any linker bloat
113 * into code "X" will cause X's cleanup function to end up here.
115 static STACK_OF(ENGINE_CLEANUP_ITEM
) *cleanup_stack
= NULL
;
116 static int int_cleanup_check(int create
)
122 cleanup_stack
= sk_ENGINE_CLEANUP_ITEM_new_null();
123 return (cleanup_stack
? 1 : 0);
126 static ENGINE_CLEANUP_ITEM
*int_cleanup_item(ENGINE_CLEANUP_CB
*cb
)
128 ENGINE_CLEANUP_ITEM
*item
= OPENSSL_malloc(sizeof(*item
));
135 void engine_cleanup_add_first(ENGINE_CLEANUP_CB
*cb
)
137 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 sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack
, item
);
155 /* The API function that performs all cleanup */
156 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM
*item
)
162 void engine_cleanup_int(void)
164 if (int_cleanup_check(0)) {
165 sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack
,
166 engine_cleanup_cb_free
);
167 cleanup_stack
= NULL
;
169 CRYPTO_THREAD_lock_free(global_engine_lock
);
172 /* Now the "ex_data" support */
174 int ENGINE_set_ex_data(ENGINE
*e
, int idx
, void *arg
)
176 return (CRYPTO_set_ex_data(&e
->ex_data
, idx
, arg
));
179 void *ENGINE_get_ex_data(const ENGINE
*e
, int idx
)
181 return (CRYPTO_get_ex_data(&e
->ex_data
, idx
));
185 * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
186 * ENGINE structure itself.
189 int ENGINE_set_id(ENGINE
*e
, const char *id
)
192 ENGINEerr(ENGINE_F_ENGINE_SET_ID
, ERR_R_PASSED_NULL_PARAMETER
);
199 int ENGINE_set_name(ENGINE
*e
, const char *name
)
202 ENGINEerr(ENGINE_F_ENGINE_SET_NAME
, ERR_R_PASSED_NULL_PARAMETER
);
209 int ENGINE_set_destroy_function(ENGINE
*e
, ENGINE_GEN_INT_FUNC_PTR destroy_f
)
211 e
->destroy
= destroy_f
;
215 int ENGINE_set_init_function(ENGINE
*e
, ENGINE_GEN_INT_FUNC_PTR init_f
)
221 int ENGINE_set_finish_function(ENGINE
*e
, ENGINE_GEN_INT_FUNC_PTR finish_f
)
223 e
->finish
= finish_f
;
227 int ENGINE_set_ctrl_function(ENGINE
*e
, ENGINE_CTRL_FUNC_PTR ctrl_f
)
233 int ENGINE_set_flags(ENGINE
*e
, int flags
)
239 int ENGINE_set_cmd_defns(ENGINE
*e
, const ENGINE_CMD_DEFN
*defns
)
241 e
->cmd_defns
= defns
;
245 const char *ENGINE_get_id(const ENGINE
*e
)
250 const char *ENGINE_get_name(const ENGINE
*e
)
255 ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_destroy_function(const ENGINE
*e
)
260 ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_init_function(const ENGINE
*e
)
265 ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_finish_function(const ENGINE
*e
)
270 ENGINE_CTRL_FUNC_PTR
ENGINE_get_ctrl_function(const ENGINE
*e
)
275 int ENGINE_get_flags(const ENGINE
*e
)
280 const ENGINE_CMD_DEFN
*ENGINE_get_cmd_defns(const ENGINE
*e
)
286 * eng_lib.o is pretty much linked into anything that touches ENGINE already,
287 * so put the "static_state" hack here.
290 static int internal_static_hack
= 0;
292 void *ENGINE_get_static_state(void)
294 return &internal_static_hack
;