• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2001-2021 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 "e_os.h"
11 #include "eng_local.h"
12 #include <openssl/rand.h>
13 #include "internal/refcount.h"
14 
15 CRYPTO_RWLOCK *global_engine_lock;
16 
17 CRYPTO_ONCE engine_lock_init = CRYPTO_ONCE_STATIC_INIT;
18 
19 /* The "new"/"free" stuff first */
20 
DEFINE_RUN_ONCE(do_engine_lock_init)21 DEFINE_RUN_ONCE(do_engine_lock_init)
22 {
23     if (!OPENSSL_init_crypto(0, NULL))
24         return 0;
25     global_engine_lock = CRYPTO_THREAD_lock_new();
26     return global_engine_lock != NULL;
27 }
28 
ENGINE_new(void)29 ENGINE *ENGINE_new(void)
30 {
31     ENGINE *ret;
32 
33     if (!RUN_ONCE(&engine_lock_init, do_engine_lock_init)
34         || (ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
35         ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
36         return NULL;
37     }
38     ret->struct_ref = 1;
39     engine_ref_debug(ret, 0, 1);
40     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data)) {
41         OPENSSL_free(ret);
42         return NULL;
43     }
44     return ret;
45 }
46 
47 /*
48  * Placed here (close proximity to ENGINE_new) so that modifications to the
49  * elements of the ENGINE structure are more likely to be caught and changed
50  * here.
51  */
engine_set_all_null(ENGINE * e)52 void engine_set_all_null(ENGINE *e)
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;
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     e->dynamic_id = NULL;
71 }
72 
engine_free_util(ENGINE * e,int not_locked)73 int engine_free_util(ENGINE *e, int not_locked)
74 {
75     int i;
76 
77     if (e == NULL)
78         return 1;
79     if (not_locked)
80         CRYPTO_DOWN_REF(&e->struct_ref, &i, global_engine_lock);
81     else
82         i = --e->struct_ref;
83     engine_ref_debug(e, 0, -1);
84     if (i > 0)
85         return 1;
86     REF_ASSERT_ISNT(i < 0);
87     /* Free up any dynamically allocated public key methods */
88     engine_pkey_meths_free(e);
89     engine_pkey_asn1_meths_free(e);
90     /*
91      * Give the ENGINE a chance to do any structural cleanup corresponding to
92      * allocation it did in its constructor (eg. unload error strings)
93      */
94     if (e->destroy)
95         e->destroy(e);
96     engine_remove_dynamic_id(e, not_locked);
97     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
98     OPENSSL_free(e);
99     return 1;
100 }
101 
ENGINE_free(ENGINE * e)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;
int_cleanup_check(int create)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 
int_cleanup_item(ENGINE_CLEANUP_CB * cb)126 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
127 {
128     ENGINE_CLEANUP_ITEM *item;
129 
130     if ((item = OPENSSL_malloc(sizeof(*item))) == NULL) {
131         ENGINEerr(ENGINE_F_INT_CLEANUP_ITEM, ERR_R_MALLOC_FAILURE);
132         return NULL;
133     }
134     item->cb = cb;
135     return item;
136 }
137 
engine_cleanup_add_first(ENGINE_CLEANUP_CB * cb)138 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
139 {
140     ENGINE_CLEANUP_ITEM *item;
141 
142     if (!int_cleanup_check(1))
143         return;
144     item = int_cleanup_item(cb);
145     if (item)
146         sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
147 }
148 
engine_cleanup_add_last(ENGINE_CLEANUP_CB * cb)149 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
150 {
151     ENGINE_CLEANUP_ITEM *item;
152     if (!int_cleanup_check(1))
153         return;
154     item = int_cleanup_item(cb);
155     if (item != NULL) {
156         if (sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item) <= 0)
157             OPENSSL_free(item);
158     }
159 }
160 
161 /* The API function that performs all cleanup */
engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM * item)162 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
163 {
164     (*(item->cb)) ();
165     OPENSSL_free(item);
166 }
167 
engine_cleanup_int(void)168 void engine_cleanup_int(void)
169 {
170     if (int_cleanup_check(0)) {
171         sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
172                                         engine_cleanup_cb_free);
173         cleanup_stack = NULL;
174     }
175     CRYPTO_THREAD_lock_free(global_engine_lock);
176     global_engine_lock = NULL;
177 }
178 
179 /* Now the "ex_data" support */
180 
ENGINE_set_ex_data(ENGINE * e,int idx,void * arg)181 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
182 {
183     return CRYPTO_set_ex_data(&e->ex_data, idx, arg);
184 }
185 
ENGINE_get_ex_data(const ENGINE * e,int idx)186 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
187 {
188     return CRYPTO_get_ex_data(&e->ex_data, idx);
189 }
190 
191 /*
192  * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
193  * ENGINE structure itself.
194  */
195 
ENGINE_set_id(ENGINE * e,const char * id)196 int ENGINE_set_id(ENGINE *e, const char *id)
197 {
198     if (id == NULL) {
199         ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER);
200         return 0;
201     }
202     e->id = id;
203     return 1;
204 }
205 
ENGINE_set_name(ENGINE * e,const char * name)206 int ENGINE_set_name(ENGINE *e, const char *name)
207 {
208     if (name == NULL) {
209         ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER);
210         return 0;
211     }
212     e->name = name;
213     return 1;
214 }
215 
ENGINE_set_destroy_function(ENGINE * e,ENGINE_GEN_INT_FUNC_PTR destroy_f)216 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
217 {
218     e->destroy = destroy_f;
219     return 1;
220 }
221 
ENGINE_set_init_function(ENGINE * e,ENGINE_GEN_INT_FUNC_PTR init_f)222 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
223 {
224     e->init = init_f;
225     return 1;
226 }
227 
ENGINE_set_finish_function(ENGINE * e,ENGINE_GEN_INT_FUNC_PTR finish_f)228 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
229 {
230     e->finish = finish_f;
231     return 1;
232 }
233 
ENGINE_set_ctrl_function(ENGINE * e,ENGINE_CTRL_FUNC_PTR ctrl_f)234 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
235 {
236     e->ctrl = ctrl_f;
237     return 1;
238 }
239 
ENGINE_set_flags(ENGINE * e,int flags)240 int ENGINE_set_flags(ENGINE *e, int flags)
241 {
242     e->flags = flags;
243     return 1;
244 }
245 
ENGINE_set_cmd_defns(ENGINE * e,const ENGINE_CMD_DEFN * defns)246 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
247 {
248     e->cmd_defns = defns;
249     return 1;
250 }
251 
ENGINE_get_id(const ENGINE * e)252 const char *ENGINE_get_id(const ENGINE *e)
253 {
254     return e->id;
255 }
256 
ENGINE_get_name(const ENGINE * e)257 const char *ENGINE_get_name(const ENGINE *e)
258 {
259     return e->name;
260 }
261 
ENGINE_get_destroy_function(const ENGINE * e)262 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
263 {
264     return e->destroy;
265 }
266 
ENGINE_get_init_function(const ENGINE * e)267 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
268 {
269     return e->init;
270 }
271 
ENGINE_get_finish_function(const ENGINE * e)272 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
273 {
274     return e->finish;
275 }
276 
ENGINE_get_ctrl_function(const ENGINE * e)277 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
278 {
279     return e->ctrl;
280 }
281 
ENGINE_get_flags(const ENGINE * e)282 int ENGINE_get_flags(const ENGINE *e)
283 {
284     return e->flags;
285 }
286 
ENGINE_get_cmd_defns(const ENGINE * e)287 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
288 {
289     return e->cmd_defns;
290 }
291 
292 /*
293  * eng_lib.o is pretty much linked into anything that touches ENGINE already,
294  * so put the "static_state" hack here.
295  */
296 
297 static int internal_static_hack = 0;
298 
ENGINE_get_static_state(void)299 void *ENGINE_get_static_state(void)
300 {
301     return &internal_static_hack;
302 }
303