]>
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 | ||
59 | #include <openssl/crypto.h> | |
60 | #include "cryptlib.h" | |
61 | #include "eng_int.h" | |
b6d1e52d | 62 | #include <openssl/rand.h> /* FIXME: This shouldn't be needed */ |
14cfde9c UM |
63 | #include <openssl/engine.h> |
64 | ||
b6d1e52d | 65 | /* The "new"/"free" stuff first */ |
14cfde9c | 66 | |
b6d1e52d | 67 | ENGINE *ENGINE_new(void) |
14cfde9c | 68 | { |
b6d1e52d | 69 | ENGINE *ret; |
14cfde9c | 70 | |
b6d1e52d GT |
71 | ret = (ENGINE *)OPENSSL_malloc(sizeof(ENGINE)); |
72 | if(ret == NULL) | |
14cfde9c | 73 | { |
b6d1e52d GT |
74 | ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE); |
75 | return NULL; | |
14cfde9c | 76 | } |
b6d1e52d GT |
77 | memset(ret, 0, sizeof(ENGINE)); |
78 | ret->struct_ref = 1; | |
79 | engine_ref_debug(ret, 0, 1) | |
80 | CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data); | |
81 | return ret; | |
14cfde9c UM |
82 | } |
83 | ||
b6d1e52d | 84 | int engine_free_util(ENGINE *e, int locked) |
14cfde9c | 85 | { |
b6d1e52d | 86 | int i; |
14cfde9c UM |
87 | |
88 | if(e == NULL) | |
89 | { | |
b6d1e52d GT |
90 | ENGINEerr(ENGINE_F_ENGINE_FREE, |
91 | ERR_R_PASSED_NULL_PARAMETER); | |
14cfde9c UM |
92 | return 0; |
93 | } | |
b6d1e52d GT |
94 | if(locked) |
95 | i = CRYPTO_add(&e->struct_ref,-1,CRYPTO_LOCK_ENGINE); | |
14cfde9c | 96 | else |
b6d1e52d GT |
97 | i = --e->struct_ref; |
98 | engine_ref_debug(e, 0, -1) | |
99 | if (i > 0) return 1; | |
14cfde9c | 100 | #ifdef REF_CHECK |
b6d1e52d | 101 | if (i < 0) |
14cfde9c | 102 | { |
b6d1e52d | 103 | fprintf(stderr,"ENGINE_free, bad structural reference count\n"); |
14cfde9c UM |
104 | abort(); |
105 | } | |
106 | #endif | |
b6d1e52d GT |
107 | /* Give the ENGINE a chance to do any structural cleanup corresponding |
108 | * to allocation it did in its constructor (eg. unload error strings) */ | |
109 | if(e->destroy) | |
110 | e->destroy(e); | |
111 | CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data); | |
112 | OPENSSL_free(e); | |
113 | return 1; | |
14cfde9c UM |
114 | } |
115 | ||
b6d1e52d | 116 | int ENGINE_free(ENGINE *e) |
14cfde9c | 117 | { |
b6d1e52d | 118 | return engine_free_util(e, 1); |
14cfde9c UM |
119 | } |
120 | ||
b6d1e52d | 121 | /* Cleanup stuff */ |
14cfde9c | 122 | |
b6d1e52d GT |
123 | /* ENGINE_cleanup() is coded such that anything that does work that will need |
124 | * cleanup can register a "cleanup" callback here. That way we don't get linker | |
125 | * bloat by referring to all *possible* cleanups, but any linker bloat into code | |
126 | * "X" will cause X's cleanup function to end up here. */ | |
127 | static STACK_OF(ENGINE_CLEANUP_CB) *cleanup_stack = NULL; | |
128 | static int int_cleanup_check(int create) | |
14cfde9c | 129 | { |
b6d1e52d GT |
130 | if(cleanup_stack) return 1; |
131 | if(!create) return 0; | |
132 | cleanup_stack = sk_ENGINE_CLEANUP_CB_new_null(); | |
133 | return (cleanup_stack ? 1 : 0); | |
14cfde9c | 134 | } |
b6d1e52d | 135 | void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb) |
14cfde9c | 136 | { |
b6d1e52d GT |
137 | if(!int_cleanup_check(1)) return; |
138 | sk_ENGINE_CLEANUP_CB_insert(cleanup_stack, cb, 0); | |
14cfde9c | 139 | } |
b6d1e52d | 140 | void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb) |
14cfde9c | 141 | { |
b6d1e52d GT |
142 | if(!int_cleanup_check(1)) return; |
143 | sk_ENGINE_CLEANUP_CB_push(cleanup_stack, cb); | |
14cfde9c | 144 | } |
b6d1e52d GT |
145 | /* The API function that performs all cleanup */ |
146 | void ENGINE_cleanup(void) | |
14cfde9c | 147 | { |
b6d1e52d | 148 | if(int_cleanup_check(0)) |
14cfde9c | 149 | { |
b6d1e52d GT |
150 | int loop = 0, num = sk_ENGINE_CLEANUP_CB_num(cleanup_stack); |
151 | while(loop < num) | |
14cfde9c | 152 | { |
b6d1e52d GT |
153 | ENGINE_CLEANUP_CB *cb = sk_ENGINE_CLEANUP_CB_value( |
154 | cleanup_stack, loop++); | |
155 | (*cb)(); | |
14cfde9c | 156 | } |
b6d1e52d GT |
157 | sk_ENGINE_CLEANUP_CB_free(cleanup_stack); |
158 | cleanup_stack = NULL; | |
14cfde9c | 159 | } |
b6d1e52d GT |
160 | /* FIXME: This should be handled (somehow) through RAND, eg. by it |
161 | * registering a cleanup callback. */ | |
162 | RAND_set_rand_method(NULL); | |
14cfde9c UM |
163 | } |
164 | ||
b6d1e52d GT |
165 | /* Now the "ex_data" support */ |
166 | ||
167 | int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, | |
168 | CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func) | |
14cfde9c | 169 | { |
b6d1e52d GT |
170 | return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp, |
171 | new_func, dup_func, free_func); | |
14cfde9c UM |
172 | } |
173 | ||
b6d1e52d | 174 | int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg) |
14cfde9c | 175 | { |
b6d1e52d | 176 | return(CRYPTO_set_ex_data(&e->ex_data, idx, arg)); |
14cfde9c UM |
177 | } |
178 | ||
b6d1e52d GT |
179 | void *ENGINE_get_ex_data(const ENGINE *e, int idx) |
180 | { | |
181 | return(CRYPTO_get_ex_data(&e->ex_data, idx)); | |
182 | } | |
14cfde9c | 183 | |
b6d1e52d GT |
184 | /* Functions to get/set an ENGINE's elements - mainly to avoid exposing the |
185 | * ENGINE structure itself. */ | |
14cfde9c | 186 | |
b6d1e52d | 187 | int ENGINE_set_id(ENGINE *e, const char *id) |
14cfde9c | 188 | { |
b6d1e52d | 189 | if(id == NULL) |
14cfde9c | 190 | { |
b6d1e52d | 191 | ENGINEerr(ENGINE_F_ENGINE_SET_ID, |
14cfde9c UM |
192 | ERR_R_PASSED_NULL_PARAMETER); |
193 | return 0; | |
194 | } | |
b6d1e52d GT |
195 | e->id = id; |
196 | return 1; | |
14cfde9c UM |
197 | } |
198 | ||
b6d1e52d | 199 | int ENGINE_set_name(ENGINE *e, const char *name) |
14cfde9c | 200 | { |
b6d1e52d | 201 | if(name == NULL) |
14cfde9c | 202 | { |
b6d1e52d GT |
203 | ENGINEerr(ENGINE_F_ENGINE_SET_NAME, |
204 | ERR_R_PASSED_NULL_PARAMETER); | |
205 | return 0; | |
14cfde9c | 206 | } |
b6d1e52d GT |
207 | e->name = name; |
208 | return 1; | |
14cfde9c | 209 | } |
14cfde9c | 210 | |
b6d1e52d | 211 | int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f) |
14cfde9c | 212 | { |
b6d1e52d GT |
213 | e->destroy = destroy_f; |
214 | return 1; | |
14cfde9c | 215 | } |
14cfde9c | 216 | |
b6d1e52d | 217 | int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f) |
14cfde9c | 218 | { |
b6d1e52d GT |
219 | e->init = init_f; |
220 | return 1; | |
14cfde9c | 221 | } |
14cfde9c | 222 | |
b6d1e52d | 223 | int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f) |
14cfde9c | 224 | { |
b6d1e52d GT |
225 | e->finish = finish_f; |
226 | return 1; | |
14cfde9c UM |
227 | } |
228 | ||
b6d1e52d | 229 | int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f) |
14cfde9c | 230 | { |
b6d1e52d GT |
231 | e->ctrl = ctrl_f; |
232 | return 1; | |
14cfde9c UM |
233 | } |
234 | ||
b6d1e52d | 235 | int ENGINE_set_flags(ENGINE *e, int flags) |
14cfde9c | 236 | { |
b6d1e52d GT |
237 | e->flags = flags; |
238 | return 1; | |
14cfde9c UM |
239 | } |
240 | ||
b6d1e52d | 241 | int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns) |
14cfde9c | 242 | { |
b6d1e52d | 243 | e->cmd_defns = defns; |
14cfde9c UM |
244 | return 1; |
245 | } | |
246 | ||
b6d1e52d | 247 | const char *ENGINE_get_id(const ENGINE *e) |
14cfde9c | 248 | { |
b6d1e52d | 249 | return e->id; |
14cfde9c | 250 | } |
14cfde9c | 251 | |
b6d1e52d | 252 | const char *ENGINE_get_name(const ENGINE *e) |
14cfde9c | 253 | { |
b6d1e52d | 254 | return e->name; |
14cfde9c | 255 | } |
14cfde9c | 256 | |
b6d1e52d | 257 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e) |
14cfde9c | 258 | { |
b6d1e52d | 259 | return e->destroy; |
14cfde9c | 260 | } |
14cfde9c | 261 | |
b6d1e52d | 262 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e) |
14cfde9c | 263 | { |
b6d1e52d | 264 | return e->init; |
14cfde9c UM |
265 | } |
266 | ||
b6d1e52d | 267 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e) |
14cfde9c | 268 | { |
b6d1e52d | 269 | return e->finish; |
14cfde9c UM |
270 | } |
271 | ||
b6d1e52d | 272 | ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e) |
14cfde9c | 273 | { |
b6d1e52d | 274 | return e->ctrl; |
14cfde9c UM |
275 | } |
276 | ||
b6d1e52d | 277 | int ENGINE_get_flags(const ENGINE *e) |
14cfde9c | 278 | { |
b6d1e52d | 279 | return e->flags; |
14cfde9c UM |
280 | } |
281 | ||
b6d1e52d | 282 | const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e) |
14cfde9c | 283 | { |
b6d1e52d | 284 | return e->cmd_defns; |
14cfde9c | 285 | } |