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