]>
Commit | Line | Data |
---|---|---|
0f113f3e | 1 | /* |
6738bf14 | 2 | * Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved. |
14cfde9c | 3 | * |
3c120f91 | 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
b1322259 RS |
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 | |
14cfde9c UM |
8 | */ |
9 | ||
677963e5 | 10 | #include "e_os.h" |
07016a8a | 11 | #include "eng_int.h" |
60a938c6 | 12 | #include <openssl/rand.h> |
2f545ae4 | 13 | #include "internal/refcount.h" |
14cfde9c | 14 | |
40e068d5 MC |
15 | CRYPTO_RWLOCK *global_engine_lock; |
16 | ||
17 | CRYPTO_ONCE engine_lock_init = CRYPTO_ONCE_STATIC_INIT; | |
18 | ||
b6d1e52d | 19 | /* The "new"/"free" stuff first */ |
14cfde9c | 20 | |
c2e4e5d2 | 21 | DEFINE_RUN_ONCE(do_engine_lock_init) |
40e068d5 | 22 | { |
eb2b9892 BE |
23 | if (!OPENSSL_init_crypto(0, NULL)) |
24 | return 0; | |
63ab5ea1 | 25 | global_engine_lock = CRYPTO_THREAD_lock_new(); |
c2e4e5d2 | 26 | return global_engine_lock != NULL; |
40e068d5 MC |
27 | } |
28 | ||
b6d1e52d | 29 | ENGINE *ENGINE_new(void) |
0f113f3e MC |
30 | { |
31 | ENGINE *ret; | |
32 | ||
c2e4e5d2 RL |
33 | if (!RUN_ONCE(&engine_lock_init, do_engine_lock_init) |
34 | || (ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) { | |
0f113f3e MC |
35 | ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE); |
36 | return NULL; | |
37 | } | |
0f113f3e | 38 | ret->struct_ref = 1; |
43d6702d | 39 | engine_ref_debug(ret, 0, 1); |
25a807bc F |
40 | if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data)) { |
41 | OPENSSL_free(ret); | |
42 | return NULL; | |
43 | } | |
0f113f3e MC |
44 | return ret; |
45 | } | |
46 | ||
47 | /* | |
48 | * Placed here (close proximity to ENGINE_new) so that modifications to the | |
e4a6cf42 | 49 | * elements of the ENGINE structure are more likely to be caught and changed |
0f113f3e MC |
50 | * here. |
51 | */ | |
e4a6cf42 | 52 | void engine_set_all_null(ENGINE *e) |
0f113f3e MC |
53 | { |
54 | e->id = NULL; | |
55 | e->name = NULL; | |
56 | e->rsa_meth = NULL; | |
57 | e->dsa_meth = NULL; | |
58 | e->dh_meth = NULL; | |
59 | e->rand_meth = NULL; | |
0f113f3e MC |
60 | e->ciphers = NULL; |
61 | e->digests = NULL; | |
62 | e->destroy = NULL; | |
63 | e->init = NULL; | |
64 | e->finish = NULL; | |
65 | e->ctrl = NULL; | |
66 | e->load_privkey = NULL; | |
67 | e->load_pubkey = NULL; | |
68 | e->cmd_defns = NULL; | |
69 | e->flags = 0; | |
70 | } | |
e4a6cf42 | 71 | |
0a3dce82 | 72 | int engine_free_util(ENGINE *e, int not_locked) |
0f113f3e MC |
73 | { |
74 | int i; | |
75 | ||
efa7dd64 RS |
76 | if (e == NULL) |
77 | return 1; | |
0a3dce82 | 78 | if (not_locked) |
e519d6b5 | 79 | CRYPTO_DOWN_REF(&e->struct_ref, &i, global_engine_lock); |
0f113f3e MC |
80 | else |
81 | i = --e->struct_ref; | |
92b1b9a8 | 82 | engine_ref_debug(e, 0, -1); |
efa7dd64 | 83 | if (i > 0) |
0f113f3e | 84 | return 1; |
f3f1cf84 | 85 | REF_ASSERT_ISNT(i < 0); |
0f113f3e MC |
86 | /* Free up any dynamically allocated public key methods */ |
87 | engine_pkey_meths_free(e); | |
88 | engine_pkey_asn1_meths_free(e); | |
89 | /* | |
90 | * Give the ENGINE a chance to do any structural cleanup corresponding to | |
91 | * allocation it did in its constructor (eg. unload error strings) | |
92 | */ | |
93 | if (e->destroy) | |
94 | e->destroy(e); | |
95 | CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data); | |
96 | OPENSSL_free(e); | |
97 | return 1; | |
98 | } | |
14cfde9c | 99 | |
b6d1e52d | 100 | int ENGINE_free(ENGINE *e) |
0f113f3e MC |
101 | { |
102 | return engine_free_util(e, 1); | |
103 | } | |
14cfde9c | 104 | |
b6d1e52d | 105 | /* Cleanup stuff */ |
14cfde9c | 106 | |
0f113f3e | 107 | /* |
b3599dbb | 108 | * engine_cleanup_int() is coded such that anything that does work that will |
6d4fb1d5 | 109 | * need cleanup can register a "cleanup" callback here. That way we don't get |
0f113f3e MC |
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. | |
112 | */ | |
5c32657c | 113 | static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL; |
b6d1e52d | 114 | static int int_cleanup_check(int create) |
0f113f3e MC |
115 | { |
116 | if (cleanup_stack) | |
117 | return 1; | |
118 | if (!create) | |
119 | return 0; | |
120 | cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null(); | |
121 | return (cleanup_stack ? 1 : 0); | |
122 | } | |
123 | ||
5c32657c | 124 | static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb) |
0f113f3e | 125 | { |
cdb10bae | 126 | ENGINE_CLEANUP_ITEM *item; |
df443918 | 127 | |
cdb10bae RS |
128 | if ((item = OPENSSL_malloc(sizeof(*item))) == NULL) { |
129 | ENGINEerr(ENGINE_F_INT_CLEANUP_ITEM, ERR_R_MALLOC_FAILURE); | |
0f113f3e | 130 | return NULL; |
cdb10bae | 131 | } |
0f113f3e MC |
132 | item->cb = cb; |
133 | return item; | |
134 | } | |
135 | ||
b6d1e52d | 136 | void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb) |
0f113f3e MC |
137 | { |
138 | ENGINE_CLEANUP_ITEM *item; | |
cdb10bae | 139 | |
0f113f3e MC |
140 | if (!int_cleanup_check(1)) |
141 | return; | |
142 | item = int_cleanup_item(cb); | |
143 | if (item) | |
144 | sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0); | |
145 | } | |
146 | ||
b6d1e52d | 147 | void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb) |
0f113f3e MC |
148 | { |
149 | ENGINE_CLEANUP_ITEM *item; | |
150 | if (!int_cleanup_check(1)) | |
151 | return; | |
152 | item = int_cleanup_item(cb); | |
aebd0e5c PK |
153 | if (item != NULL) { |
154 | if (sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item) <= 0) | |
155 | OPENSSL_free(item); | |
156 | } | |
0f113f3e MC |
157 | } |
158 | ||
b6d1e52d | 159 | /* The API function that performs all cleanup */ |
1cf9d58c | 160 | static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item) |
0f113f3e MC |
161 | { |
162 | (*(item->cb)) (); | |
163 | OPENSSL_free(item); | |
164 | } | |
165 | ||
b3599dbb | 166 | void engine_cleanup_int(void) |
0f113f3e MC |
167 | { |
168 | if (int_cleanup_check(0)) { | |
169 | sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack, | |
170 | engine_cleanup_cb_free); | |
171 | cleanup_stack = NULL; | |
172 | } | |
40e068d5 | 173 | CRYPTO_THREAD_lock_free(global_engine_lock); |
0f113f3e | 174 | } |
14cfde9c | 175 | |
b6d1e52d GT |
176 | /* Now the "ex_data" support */ |
177 | ||
b6d1e52d | 178 | int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg) |
0f113f3e | 179 | { |
26a7d938 | 180 | return CRYPTO_set_ex_data(&e->ex_data, idx, arg); |
0f113f3e | 181 | } |
14cfde9c | 182 | |
b6d1e52d | 183 | void *ENGINE_get_ex_data(const ENGINE *e, int idx) |
0f113f3e | 184 | { |
26a7d938 | 185 | return CRYPTO_get_ex_data(&e->ex_data, idx); |
0f113f3e | 186 | } |
14cfde9c | 187 | |
0f113f3e MC |
188 | /* |
189 | * Functions to get/set an ENGINE's elements - mainly to avoid exposing the | |
190 | * ENGINE structure itself. | |
191 | */ | |
14cfde9c | 192 | |
b6d1e52d | 193 | int ENGINE_set_id(ENGINE *e, const char *id) |
0f113f3e MC |
194 | { |
195 | if (id == NULL) { | |
196 | ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER); | |
197 | return 0; | |
198 | } | |
199 | e->id = id; | |
200 | return 1; | |
201 | } | |
14cfde9c | 202 | |
b6d1e52d | 203 | int ENGINE_set_name(ENGINE *e, const char *name) |
0f113f3e MC |
204 | { |
205 | if (name == NULL) { | |
206 | ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER); | |
207 | return 0; | |
208 | } | |
209 | e->name = name; | |
210 | return 1; | |
211 | } | |
14cfde9c | 212 | |
b6d1e52d | 213 | int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f) |
0f113f3e MC |
214 | { |
215 | e->destroy = destroy_f; | |
216 | return 1; | |
217 | } | |
14cfde9c | 218 | |
b6d1e52d | 219 | int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f) |
0f113f3e MC |
220 | { |
221 | e->init = init_f; | |
222 | return 1; | |
223 | } | |
14cfde9c | 224 | |
b6d1e52d | 225 | int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f) |
0f113f3e MC |
226 | { |
227 | e->finish = finish_f; | |
228 | return 1; | |
229 | } | |
14cfde9c | 230 | |
b6d1e52d | 231 | int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f) |
0f113f3e MC |
232 | { |
233 | e->ctrl = ctrl_f; | |
234 | return 1; | |
235 | } | |
14cfde9c | 236 | |
b6d1e52d | 237 | int ENGINE_set_flags(ENGINE *e, int flags) |
0f113f3e MC |
238 | { |
239 | e->flags = flags; | |
240 | return 1; | |
241 | } | |
14cfde9c | 242 | |
b6d1e52d | 243 | int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns) |
0f113f3e MC |
244 | { |
245 | e->cmd_defns = defns; | |
246 | return 1; | |
247 | } | |
14cfde9c | 248 | |
b6d1e52d | 249 | const char *ENGINE_get_id(const ENGINE *e) |
0f113f3e MC |
250 | { |
251 | return e->id; | |
252 | } | |
14cfde9c | 253 | |
b6d1e52d | 254 | const char *ENGINE_get_name(const ENGINE *e) |
0f113f3e MC |
255 | { |
256 | return e->name; | |
257 | } | |
14cfde9c | 258 | |
b6d1e52d | 259 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e) |
0f113f3e MC |
260 | { |
261 | return e->destroy; | |
262 | } | |
14cfde9c | 263 | |
b6d1e52d | 264 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e) |
0f113f3e MC |
265 | { |
266 | return e->init; | |
267 | } | |
14cfde9c | 268 | |
b6d1e52d | 269 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e) |
0f113f3e MC |
270 | { |
271 | return e->finish; | |
272 | } | |
14cfde9c | 273 | |
b6d1e52d | 274 | ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e) |
0f113f3e MC |
275 | { |
276 | return e->ctrl; | |
277 | } | |
14cfde9c | 278 | |
b6d1e52d | 279 | int ENGINE_get_flags(const ENGINE *e) |
0f113f3e MC |
280 | { |
281 | return e->flags; | |
282 | } | |
14cfde9c | 283 | |
b6d1e52d | 284 | const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e) |
0f113f3e MC |
285 | { |
286 | return e->cmd_defns; | |
287 | } | |
0587ec26 | 288 | |
0f113f3e MC |
289 | /* |
290 | * eng_lib.o is pretty much linked into anything that touches ENGINE already, | |
291 | * so put the "static_state" hack here. | |
292 | */ | |
0587ec26 GT |
293 | |
294 | static int internal_static_hack = 0; | |
295 | ||
296 | void *ENGINE_get_static_state(void) | |
0f113f3e MC |
297 | { |
298 | return &internal_static_hack; | |
299 | } |