Line data Source code
1 : /* crypto/engine/eng_lib.c */
2 : /*
3 : * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
4 : * 2000.
5 : */
6 : /* ====================================================================
7 : * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
8 : *
9 : * Redistribution and use in source and binary forms, with or without
10 : * modification, are permitted provided that the following conditions
11 : * are met:
12 : *
13 : * 1. Redistributions of source code must retain the above copyright
14 : * notice, this list of conditions and the following disclaimer.
15 : *
16 : * 2. Redistributions in binary form must reproduce the above copyright
17 : * notice, this list of conditions and the following disclaimer in
18 : * the documentation and/or other materials provided with the
19 : * distribution.
20 : *
21 : * 3. All advertising materials mentioning features or use of this
22 : * software must display the following acknowledgment:
23 : * "This product includes software developed by the OpenSSL Project
24 : * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 : *
26 : * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 : * endorse or promote products derived from this software without
28 : * prior written permission. For written permission, please contact
29 : * licensing@OpenSSL.org.
30 : *
31 : * 5. Products derived from this software may not be called "OpenSSL"
32 : * nor may "OpenSSL" appear in their names without prior written
33 : * permission of the OpenSSL Project.
34 : *
35 : * 6. Redistributions of any form whatsoever must retain the following
36 : * acknowledgment:
37 : * "This product includes software developed by the OpenSSL Project
38 : * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 : *
40 : * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 : * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 : * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 : * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 : * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 : * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 : * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 : * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 : * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 : * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 : * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 : * OF THE POSSIBILITY OF SUCH DAMAGE.
52 : * ====================================================================
53 : *
54 : * This product includes cryptographic software written by Eric Young
55 : * (eay@cryptsoft.com). This product includes software written by Tim
56 : * Hudson (tjh@cryptsoft.com).
57 : *
58 : */
59 :
60 : #include "eng_int.h"
61 : #include <openssl/rand.h>
62 :
63 : /* The "new"/"free" stuff first */
64 :
65 0 : ENGINE *ENGINE_new(void)
66 : {
67 : ENGINE *ret;
68 :
69 0 : ret = (ENGINE *)OPENSSL_malloc(sizeof(ENGINE));
70 0 : if (ret == NULL) {
71 0 : ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
72 0 : return NULL;
73 : }
74 : memset(ret, 0, sizeof(ENGINE));
75 0 : ret->struct_ref = 1;
76 : engine_ref_debug(ret, 0, 1)
77 0 : CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);
78 0 : return ret;
79 : }
80 :
81 : /*
82 : * Placed here (close proximity to ENGINE_new) so that modifications to the
83 : * elements of the ENGINE structure are more likely to be caught and changed
84 : * here.
85 : */
86 0 : void engine_set_all_null(ENGINE *e)
87 : {
88 0 : e->id = NULL;
89 0 : e->name = NULL;
90 0 : e->rsa_meth = NULL;
91 0 : e->dsa_meth = NULL;
92 0 : e->dh_meth = NULL;
93 0 : e->rand_meth = NULL;
94 0 : e->store_meth = NULL;
95 0 : e->ciphers = NULL;
96 0 : e->digests = NULL;
97 0 : e->destroy = NULL;
98 0 : e->init = NULL;
99 0 : e->finish = NULL;
100 0 : e->ctrl = NULL;
101 0 : e->load_privkey = NULL;
102 0 : e->load_pubkey = NULL;
103 0 : e->cmd_defns = NULL;
104 0 : e->flags = 0;
105 0 : }
106 :
107 0 : int engine_free_util(ENGINE *e, int locked)
108 : {
109 : int i;
110 :
111 0 : if (e == NULL) {
112 0 : ENGINEerr(ENGINE_F_ENGINE_FREE_UTIL, ERR_R_PASSED_NULL_PARAMETER);
113 0 : return 0;
114 : }
115 0 : if (locked)
116 0 : i = CRYPTO_add(&e->struct_ref, -1, CRYPTO_LOCK_ENGINE);
117 : else
118 0 : i = --e->struct_ref;
119 : engine_ref_debug(e, 0, -1)
120 0 : if (i > 0)
121 : return 1;
122 : #ifdef REF_CHECK
123 : if (i < 0) {
124 : fprintf(stderr, "ENGINE_free, bad structural reference count\n");
125 : abort();
126 : }
127 : #endif
128 : /* Free up any dynamically allocated public key methods */
129 0 : engine_pkey_meths_free(e);
130 0 : engine_pkey_asn1_meths_free(e);
131 : /*
132 : * Give the ENGINE a chance to do any structural cleanup corresponding to
133 : * allocation it did in its constructor (eg. unload error strings)
134 : */
135 0 : if (e->destroy)
136 0 : e->destroy(e);
137 0 : CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
138 0 : OPENSSL_free(e);
139 0 : return 1;
140 : }
141 :
142 0 : int ENGINE_free(ENGINE *e)
143 : {
144 0 : return engine_free_util(e, 1);
145 : }
146 :
147 : /* Cleanup stuff */
148 :
149 : /*
150 : * ENGINE_cleanup() is coded such that anything that does work that will need
151 : * cleanup can register a "cleanup" callback here. That way we don't get
152 : * linker bloat by referring to all *possible* cleanups, but any linker bloat
153 : * into code "X" will cause X's cleanup function to end up here.
154 : */
155 : static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
156 0 : static int int_cleanup_check(int create)
157 : {
158 0 : if (cleanup_stack)
159 : return 1;
160 0 : if (!create)
161 : return 0;
162 0 : cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
163 0 : return (cleanup_stack ? 1 : 0);
164 : }
165 :
166 : static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
167 : {
168 0 : ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(ENGINE_CLEANUP_ITEM));
169 0 : if (!item)
170 : return NULL;
171 0 : item->cb = cb;
172 : return item;
173 : }
174 :
175 0 : void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
176 : {
177 : ENGINE_CLEANUP_ITEM *item;
178 0 : if (!int_cleanup_check(1))
179 0 : return;
180 : item = int_cleanup_item(cb);
181 0 : if (item)
182 0 : sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
183 : }
184 :
185 0 : void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
186 : {
187 : ENGINE_CLEANUP_ITEM *item;
188 0 : if (!int_cleanup_check(1))
189 0 : return;
190 : item = int_cleanup_item(cb);
191 0 : if (item)
192 0 : sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
193 : }
194 :
195 : /* The API function that performs all cleanup */
196 0 : static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
197 : {
198 0 : (*(item->cb)) ();
199 0 : OPENSSL_free(item);
200 0 : }
201 :
202 0 : void ENGINE_cleanup(void)
203 : {
204 0 : if (int_cleanup_check(0)) {
205 0 : sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
206 : engine_cleanup_cb_free);
207 0 : cleanup_stack = NULL;
208 : }
209 : /*
210 : * FIXME: This should be handled (somehow) through RAND, eg. by it
211 : * registering a cleanup callback.
212 : */
213 0 : RAND_set_rand_method(NULL);
214 0 : }
215 :
216 : /* Now the "ex_data" support */
217 :
218 0 : int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
219 : CRYPTO_EX_dup *dup_func,
220 : CRYPTO_EX_free *free_func)
221 : {
222 0 : return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp,
223 : new_func, dup_func, free_func);
224 : }
225 :
226 0 : int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
227 : {
228 0 : return (CRYPTO_set_ex_data(&e->ex_data, idx, arg));
229 : }
230 :
231 0 : void *ENGINE_get_ex_data(const ENGINE *e, int idx)
232 : {
233 0 : return (CRYPTO_get_ex_data(&e->ex_data, idx));
234 : }
235 :
236 : /*
237 : * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
238 : * ENGINE structure itself.
239 : */
240 :
241 0 : int ENGINE_set_id(ENGINE *e, const char *id)
242 : {
243 0 : if (id == NULL) {
244 0 : ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER);
245 0 : return 0;
246 : }
247 0 : e->id = id;
248 0 : return 1;
249 : }
250 :
251 0 : int ENGINE_set_name(ENGINE *e, const char *name)
252 : {
253 0 : if (name == NULL) {
254 0 : ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER);
255 0 : return 0;
256 : }
257 0 : e->name = name;
258 0 : return 1;
259 : }
260 :
261 0 : int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
262 : {
263 0 : e->destroy = destroy_f;
264 0 : return 1;
265 : }
266 :
267 0 : int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
268 : {
269 0 : e->init = init_f;
270 0 : return 1;
271 : }
272 :
273 0 : int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
274 : {
275 0 : e->finish = finish_f;
276 0 : return 1;
277 : }
278 :
279 0 : int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
280 : {
281 0 : e->ctrl = ctrl_f;
282 0 : return 1;
283 : }
284 :
285 0 : int ENGINE_set_flags(ENGINE *e, int flags)
286 : {
287 0 : e->flags = flags;
288 0 : return 1;
289 : }
290 :
291 0 : int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
292 : {
293 0 : e->cmd_defns = defns;
294 0 : return 1;
295 : }
296 :
297 0 : const char *ENGINE_get_id(const ENGINE *e)
298 : {
299 0 : return e->id;
300 : }
301 :
302 0 : const char *ENGINE_get_name(const ENGINE *e)
303 : {
304 0 : return e->name;
305 : }
306 :
307 0 : ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
308 : {
309 0 : return e->destroy;
310 : }
311 :
312 0 : ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
313 : {
314 0 : return e->init;
315 : }
316 :
317 0 : ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
318 : {
319 0 : return e->finish;
320 : }
321 :
322 0 : ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
323 : {
324 0 : return e->ctrl;
325 : }
326 :
327 0 : int ENGINE_get_flags(const ENGINE *e)
328 : {
329 0 : return e->flags;
330 : }
331 :
332 0 : const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
333 : {
334 0 : return e->cmd_defns;
335 : }
336 :
337 : /*
338 : * eng_lib.o is pretty much linked into anything that touches ENGINE already,
339 : * so put the "static_state" hack here.
340 : */
341 :
342 : static int internal_static_hack = 0;
343 :
344 0 : void *ENGINE_get_static_state(void)
345 : {
346 0 : return &internal_static_hack;
347 : }
|
