]>
Commit | Line | Data |
---|---|---|
2b671586 | 1 | /* crypto/engine/eng_lib.c */ |
14cfde9c UM |
2 | /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL |
3 | * project 2000. | |
4 | */ | |
5 | /* ==================================================================== | |
2b671586 | 6 | * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved. |
14cfde9c UM |
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 | ||
14cfde9c | 59 | #include "eng_int.h" |
60a938c6 | 60 | #include <openssl/rand.h> |
14cfde9c | 61 | |
b6d1e52d | 62 | /* The "new"/"free" stuff first */ |
14cfde9c | 63 | |
b6d1e52d | 64 | ENGINE *ENGINE_new(void) |
14cfde9c | 65 | { |
b6d1e52d | 66 | ENGINE *ret; |
14cfde9c | 67 | |
b6d1e52d GT |
68 | ret = (ENGINE *)OPENSSL_malloc(sizeof(ENGINE)); |
69 | if(ret == NULL) | |
14cfde9c | 70 | { |
b6d1e52d GT |
71 | ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE); |
72 | return NULL; | |
14cfde9c | 73 | } |
b6d1e52d GT |
74 | memset(ret, 0, sizeof(ENGINE)); |
75 | ret->struct_ref = 1; | |
76 | engine_ref_debug(ret, 0, 1) | |
77 | CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data); | |
78 | return ret; | |
14cfde9c UM |
79 | } |
80 | ||
e4a6cf42 GT |
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 | void engine_set_all_null(ENGINE *e) | |
85 | { | |
86 | e->id = NULL; | |
87 | e->name = NULL; | |
88 | e->rsa_meth = NULL; | |
89 | e->dsa_meth = NULL; | |
90 | e->dh_meth = NULL; | |
91 | e->rand_meth = NULL; | |
3bbb0212 | 92 | e->store_meth = NULL; |
e4a6cf42 GT |
93 | e->ciphers = NULL; |
94 | e->digests = NULL; | |
95 | e->destroy = NULL; | |
96 | e->init = NULL; | |
97 | e->finish = NULL; | |
98 | e->ctrl = NULL; | |
99 | e->load_privkey = NULL; | |
100 | e->load_pubkey = NULL; | |
101 | e->cmd_defns = NULL; | |
102 | e->flags = 0; | |
103 | } | |
104 | ||
b6d1e52d | 105 | int engine_free_util(ENGINE *e, int locked) |
14cfde9c | 106 | { |
b6d1e52d | 107 | int i; |
14cfde9c UM |
108 | |
109 | if(e == NULL) | |
110 | { | |
b6d1e52d GT |
111 | ENGINEerr(ENGINE_F_ENGINE_FREE, |
112 | ERR_R_PASSED_NULL_PARAMETER); | |
14cfde9c UM |
113 | return 0; |
114 | } | |
b6d1e52d GT |
115 | if(locked) |
116 | i = CRYPTO_add(&e->struct_ref,-1,CRYPTO_LOCK_ENGINE); | |
14cfde9c | 117 | else |
b6d1e52d GT |
118 | i = --e->struct_ref; |
119 | engine_ref_debug(e, 0, -1) | |
120 | if (i > 0) return 1; | |
14cfde9c | 121 | #ifdef REF_CHECK |
b6d1e52d | 122 | if (i < 0) |
14cfde9c | 123 | { |
b6d1e52d | 124 | fprintf(stderr,"ENGINE_free, bad structural reference count\n"); |
14cfde9c UM |
125 | abort(); |
126 | } | |
127 | #endif | |
b6d1e52d GT |
128 | /* Give the ENGINE a chance to do any structural cleanup corresponding |
129 | * to allocation it did in its constructor (eg. unload error strings) */ | |
130 | if(e->destroy) | |
131 | e->destroy(e); | |
132 | CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data); | |
133 | OPENSSL_free(e); | |
134 | return 1; | |
14cfde9c UM |
135 | } |
136 | ||
b6d1e52d | 137 | int ENGINE_free(ENGINE *e) |
14cfde9c | 138 | { |
b6d1e52d | 139 | return engine_free_util(e, 1); |
14cfde9c UM |
140 | } |
141 | ||
b6d1e52d | 142 | /* Cleanup stuff */ |
14cfde9c | 143 | |
b6d1e52d GT |
144 | /* ENGINE_cleanup() is coded such that anything that does work that will need |
145 | * cleanup can register a "cleanup" callback here. That way we don't get linker | |
146 | * bloat by referring to all *possible* cleanups, but any linker bloat into code | |
147 | * "X" will cause X's cleanup function to end up here. */ | |
5c32657c | 148 | static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL; |
b6d1e52d | 149 | static int int_cleanup_check(int create) |
14cfde9c | 150 | { |
b6d1e52d GT |
151 | if(cleanup_stack) return 1; |
152 | if(!create) return 0; | |
5c32657c | 153 | cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null(); |
b6d1e52d | 154 | return (cleanup_stack ? 1 : 0); |
14cfde9c | 155 | } |
5c32657c GT |
156 | static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb) |
157 | { | |
158 | ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof( | |
159 | ENGINE_CLEANUP_ITEM)); | |
160 | if(!item) return NULL; | |
161 | item->cb = cb; | |
162 | return item; | |
163 | } | |
b6d1e52d | 164 | void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb) |
14cfde9c | 165 | { |
5c32657c | 166 | ENGINE_CLEANUP_ITEM *item; |
b6d1e52d | 167 | if(!int_cleanup_check(1)) return; |
5c32657c GT |
168 | item = int_cleanup_item(cb); |
169 | if(item) | |
170 | sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0); | |
14cfde9c | 171 | } |
b6d1e52d | 172 | void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb) |
14cfde9c | 173 | { |
5c32657c | 174 | ENGINE_CLEANUP_ITEM *item; |
b6d1e52d | 175 | if(!int_cleanup_check(1)) return; |
5c32657c GT |
176 | item = int_cleanup_item(cb); |
177 | if(item) | |
178 | sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item); | |
14cfde9c | 179 | } |
b6d1e52d | 180 | /* The API function that performs all cleanup */ |
1cf9d58c RL |
181 | static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item) |
182 | { | |
183 | (*(item->cb))(); | |
b485e5b7 | 184 | OPENSSL_free(item); |
1cf9d58c | 185 | } |
b6d1e52d | 186 | void ENGINE_cleanup(void) |
14cfde9c | 187 | { |
b6d1e52d | 188 | if(int_cleanup_check(0)) |
14cfde9c | 189 | { |
1cf9d58c RL |
190 | sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack, |
191 | engine_cleanup_cb_free); | |
b6d1e52d | 192 | cleanup_stack = NULL; |
14cfde9c | 193 | } |
b6d1e52d GT |
194 | /* FIXME: This should be handled (somehow) through RAND, eg. by it |
195 | * registering a cleanup callback. */ | |
196 | RAND_set_rand_method(NULL); | |
14cfde9c UM |
197 | } |
198 | ||
b6d1e52d GT |
199 | /* Now the "ex_data" support */ |
200 | ||
201 | int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, | |
202 | CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func) | |
14cfde9c | 203 | { |
b6d1e52d GT |
204 | return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp, |
205 | new_func, dup_func, free_func); | |
14cfde9c UM |
206 | } |
207 | ||
b6d1e52d | 208 | int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg) |
14cfde9c | 209 | { |
b6d1e52d | 210 | return(CRYPTO_set_ex_data(&e->ex_data, idx, arg)); |
14cfde9c UM |
211 | } |
212 | ||
b6d1e52d GT |
213 | void *ENGINE_get_ex_data(const ENGINE *e, int idx) |
214 | { | |
215 | return(CRYPTO_get_ex_data(&e->ex_data, idx)); | |
216 | } | |
14cfde9c | 217 | |
b6d1e52d GT |
218 | /* Functions to get/set an ENGINE's elements - mainly to avoid exposing the |
219 | * ENGINE structure itself. */ | |
14cfde9c | 220 | |
b6d1e52d | 221 | int ENGINE_set_id(ENGINE *e, const char *id) |
14cfde9c | 222 | { |
b6d1e52d | 223 | if(id == NULL) |
14cfde9c | 224 | { |
b6d1e52d | 225 | ENGINEerr(ENGINE_F_ENGINE_SET_ID, |
14cfde9c UM |
226 | ERR_R_PASSED_NULL_PARAMETER); |
227 | return 0; | |
228 | } | |
b6d1e52d GT |
229 | e->id = id; |
230 | return 1; | |
14cfde9c UM |
231 | } |
232 | ||
b6d1e52d | 233 | int ENGINE_set_name(ENGINE *e, const char *name) |
14cfde9c | 234 | { |
b6d1e52d | 235 | if(name == NULL) |
14cfde9c | 236 | { |
b6d1e52d GT |
237 | ENGINEerr(ENGINE_F_ENGINE_SET_NAME, |
238 | ERR_R_PASSED_NULL_PARAMETER); | |
239 | return 0; | |
14cfde9c | 240 | } |
b6d1e52d GT |
241 | e->name = name; |
242 | return 1; | |
14cfde9c | 243 | } |
14cfde9c | 244 | |
b6d1e52d | 245 | int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f) |
14cfde9c | 246 | { |
b6d1e52d GT |
247 | e->destroy = destroy_f; |
248 | return 1; | |
14cfde9c | 249 | } |
14cfde9c | 250 | |
b6d1e52d | 251 | int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f) |
14cfde9c | 252 | { |
b6d1e52d GT |
253 | e->init = init_f; |
254 | return 1; | |
14cfde9c | 255 | } |
14cfde9c | 256 | |
b6d1e52d | 257 | int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f) |
14cfde9c | 258 | { |
b6d1e52d GT |
259 | e->finish = finish_f; |
260 | return 1; | |
14cfde9c UM |
261 | } |
262 | ||
b6d1e52d | 263 | int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f) |
14cfde9c | 264 | { |
b6d1e52d GT |
265 | e->ctrl = ctrl_f; |
266 | return 1; | |
14cfde9c UM |
267 | } |
268 | ||
b6d1e52d | 269 | int ENGINE_set_flags(ENGINE *e, int flags) |
14cfde9c | 270 | { |
b6d1e52d GT |
271 | e->flags = flags; |
272 | return 1; | |
14cfde9c UM |
273 | } |
274 | ||
b6d1e52d | 275 | int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns) |
14cfde9c | 276 | { |
b6d1e52d | 277 | e->cmd_defns = defns; |
14cfde9c UM |
278 | return 1; |
279 | } | |
280 | ||
b6d1e52d | 281 | const char *ENGINE_get_id(const ENGINE *e) |
14cfde9c | 282 | { |
b6d1e52d | 283 | return e->id; |
14cfde9c | 284 | } |
14cfde9c | 285 | |
b6d1e52d | 286 | const char *ENGINE_get_name(const ENGINE *e) |
14cfde9c | 287 | { |
b6d1e52d | 288 | return e->name; |
14cfde9c | 289 | } |
14cfde9c | 290 | |
b6d1e52d | 291 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e) |
14cfde9c | 292 | { |
b6d1e52d | 293 | return e->destroy; |
14cfde9c | 294 | } |
14cfde9c | 295 | |
b6d1e52d | 296 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e) |
14cfde9c | 297 | { |
b6d1e52d | 298 | return e->init; |
14cfde9c UM |
299 | } |
300 | ||
b6d1e52d | 301 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e) |
14cfde9c | 302 | { |
b6d1e52d | 303 | return e->finish; |
14cfde9c UM |
304 | } |
305 | ||
b6d1e52d | 306 | ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e) |
14cfde9c | 307 | { |
b6d1e52d | 308 | return e->ctrl; |
14cfde9c UM |
309 | } |
310 | ||
b6d1e52d | 311 | int ENGINE_get_flags(const ENGINE *e) |
14cfde9c | 312 | { |
b6d1e52d | 313 | return e->flags; |
14cfde9c UM |
314 | } |
315 | ||
b6d1e52d | 316 | const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e) |
14cfde9c | 317 | { |
b6d1e52d | 318 | return e->cmd_defns; |
14cfde9c | 319 | } |
0587ec26 GT |
320 | |
321 | /* eng_lib.o is pretty much linked into anything that touches ENGINE already, so | |
322 | * put the "static_state" hack here. */ | |
323 | ||
324 | static int internal_static_hack = 0; | |
325 | ||
326 | void *ENGINE_get_static_state(void) | |
327 | { | |
328 | return &internal_static_hack; | |
329 | } |