Fix name of "locked" variable
[openssl.git] / crypto / engine / eng_lib.c
1 /*
2  * Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #include "eng_int.h"
11 #include <openssl/rand.h>
12 #include "internal/refcount.h"
13
14 CRYPTO_RWLOCK *global_engine_lock;
15
16 CRYPTO_ONCE engine_lock_init = CRYPTO_ONCE_STATIC_INIT;
17
18 /* The "new"/"free" stuff first */
19
20 DEFINE_RUN_ONCE(do_engine_lock_init)
21 {
22     OPENSSL_init_crypto(0, NULL);
23     global_engine_lock = CRYPTO_THREAD_lock_new();
24     return global_engine_lock != NULL;
25 }
26
27 ENGINE *ENGINE_new(void)
28 {
29     ENGINE *ret;
30
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);
34         return NULL;
35     }
36     ret->struct_ref = 1;
37     engine_ref_debug(ret, 0, 1);
38     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data)) {
39         OPENSSL_free(ret);
40         return NULL;
41     }
42     return ret;
43 }
44
45 /*
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
48  * here.
49  */
50 void engine_set_all_null(ENGINE *e)
51 {
52     e->id = NULL;
53     e->name = NULL;
54     e->rsa_meth = NULL;
55     e->dsa_meth = NULL;
56     e->dh_meth = NULL;
57     e->rand_meth = NULL;
58     e->ciphers = NULL;
59     e->digests = NULL;
60     e->destroy = NULL;
61     e->init = NULL;
62     e->finish = NULL;
63     e->ctrl = NULL;
64     e->load_privkey = NULL;
65     e->load_pubkey = NULL;
66     e->cmd_defns = NULL;
67     e->flags = 0;
68 }
69
70 int engine_free_util(ENGINE *e, int not_locked)
71 {
72     int i;
73
74     if (e == NULL)
75         return 1;
76 #ifdef HAVE_ATOMICS
77     CRYPTO_DOWN_REF(&e->struct_ref, &i, global_engine_lock);
78 #else
79     if (not_locked)
80         CRYPTO_atomic_add(&e->struct_ref, -1, &i, global_engine_lock);
81     else
82         i = --e->struct_ref;
83 #endif
84     engine_ref_debug(e, 0, -1)
85     if (i > 0)
86         return 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);
91     /*
92      * Give the ENGINE a chance to do any structural cleanup corresponding to
93      * allocation it did in its constructor (eg. unload error strings)
94      */
95     if (e->destroy)
96         e->destroy(e);
97     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
98     OPENSSL_free(e);
99     return 1;
100 }
101
102 int ENGINE_free(ENGINE *e)
103 {
104     return engine_free_util(e, 1);
105 }
106
107 /* Cleanup stuff */
108
109 /*
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.
114  */
115 static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
116 static int int_cleanup_check(int create)
117 {
118     if (cleanup_stack)
119         return 1;
120     if (!create)
121         return 0;
122     cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
123     return (cleanup_stack ? 1 : 0);
124 }
125
126 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
127 {
128     ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(*item));
129     if (item == NULL)
130         return NULL;
131     item->cb = cb;
132     return item;
133 }
134
135 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
136 {
137     ENGINE_CLEANUP_ITEM *item;
138     if (!int_cleanup_check(1))
139         return;
140     item = int_cleanup_item(cb);
141     if (item)
142         sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
143 }
144
145 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
146 {
147     ENGINE_CLEANUP_ITEM *item;
148     if (!int_cleanup_check(1))
149         return;
150     item = int_cleanup_item(cb);
151     if (item)
152         sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
153 }
154
155 /* The API function that performs all cleanup */
156 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
157 {
158     (*(item->cb)) ();
159     OPENSSL_free(item);
160 }
161
162 void engine_cleanup_int(void)
163 {
164     if (int_cleanup_check(0)) {
165         sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
166                                         engine_cleanup_cb_free);
167         cleanup_stack = NULL;
168     }
169     /*
170      * FIXME: This should be handled (somehow) through RAND, eg. by it
171      * registering a cleanup callback.
172      */
173     RAND_set_rand_method(NULL);
174     CRYPTO_THREAD_lock_free(global_engine_lock);
175 }
176
177 /* Now the "ex_data" support */
178
179 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
180 {
181     return (CRYPTO_set_ex_data(&e->ex_data, idx, arg));
182 }
183
184 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
185 {
186     return (CRYPTO_get_ex_data(&e->ex_data, idx));
187 }
188
189 /*
190  * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
191  * ENGINE structure itself.
192  */
193
194 int ENGINE_set_id(ENGINE *e, const char *id)
195 {
196     if (id == NULL) {
197         ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER);
198         return 0;
199     }
200     e->id = id;
201     return 1;
202 }
203
204 int ENGINE_set_name(ENGINE *e, const char *name)
205 {
206     if (name == NULL) {
207         ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER);
208         return 0;
209     }
210     e->name = name;
211     return 1;
212 }
213
214 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
215 {
216     e->destroy = destroy_f;
217     return 1;
218 }
219
220 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
221 {
222     e->init = init_f;
223     return 1;
224 }
225
226 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
227 {
228     e->finish = finish_f;
229     return 1;
230 }
231
232 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
233 {
234     e->ctrl = ctrl_f;
235     return 1;
236 }
237
238 int ENGINE_set_flags(ENGINE *e, int flags)
239 {
240     e->flags = flags;
241     return 1;
242 }
243
244 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
245 {
246     e->cmd_defns = defns;
247     return 1;
248 }
249
250 const char *ENGINE_get_id(const ENGINE *e)
251 {
252     return e->id;
253 }
254
255 const char *ENGINE_get_name(const ENGINE *e)
256 {
257     return e->name;
258 }
259
260 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
261 {
262     return e->destroy;
263 }
264
265 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
266 {
267     return e->init;
268 }
269
270 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
271 {
272     return e->finish;
273 }
274
275 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
276 {
277     return e->ctrl;
278 }
279
280 int ENGINE_get_flags(const ENGINE *e)
281 {
282     return e->flags;
283 }
284
285 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
286 {
287     return e->cmd_defns;
288 }
289
290 /*
291  * eng_lib.o is pretty much linked into anything that touches ENGINE already,
292  * so put the "static_state" hack here.
293  */
294
295 static int internal_static_hack = 0;
296
297 void *ENGINE_get_static_state(void)
298 {
299     return &internal_static_hack;
300 }