1 /* crypto/engine/eng_lib.c */
3 * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
61 #include <openssl/rand.h>
63 /* The "new"/"free" stuff first */
65 ENGINE
*ENGINE_new(void)
69 ret
= OPENSSL_malloc(sizeof(ENGINE
));
71 ENGINEerr(ENGINE_F_ENGINE_NEW
, ERR_R_MALLOC_FAILURE
);
74 memset(ret
, 0, sizeof(ENGINE
));
76 engine_ref_debug(ret
, 0, 1)
77 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE
, ret
, &ret
->ex_data
);
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
86 void engine_set_all_null(ENGINE
*e
)
101 e
->load_privkey
= NULL
;
102 e
->load_pubkey
= NULL
;
107 int engine_free_util(ENGINE
*e
, int locked
)
114 i
= CRYPTO_add(&e
->struct_ref
, -1, CRYPTO_LOCK_ENGINE
);
117 engine_ref_debug(e
, 0, -1)
122 fprintf(stderr
, "ENGINE_free, bad structural reference count\n");
126 /* Free up any dynamically allocated public key methods */
127 engine_pkey_meths_free(e
);
128 engine_pkey_asn1_meths_free(e
);
130 * Give the ENGINE a chance to do any structural cleanup corresponding to
131 * allocation it did in its constructor (eg. unload error strings)
135 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE
, e
, &e
->ex_data
);
140 int ENGINE_free(ENGINE
*e
)
142 return engine_free_util(e
, 1);
148 * ENGINE_cleanup() is coded such that anything that does work that will need
149 * cleanup can register a "cleanup" callback here. That way we don't get
150 * linker bloat by referring to all *possible* cleanups, but any linker bloat
151 * into code "X" will cause X's cleanup function to end up here.
153 static STACK_OF(ENGINE_CLEANUP_ITEM
) *cleanup_stack
= NULL
;
154 static int int_cleanup_check(int create
)
160 cleanup_stack
= sk_ENGINE_CLEANUP_ITEM_new_null();
161 return (cleanup_stack
? 1 : 0);
164 static ENGINE_CLEANUP_ITEM
*int_cleanup_item(ENGINE_CLEANUP_CB
*cb
)
166 ENGINE_CLEANUP_ITEM
*item
= OPENSSL_malloc(sizeof(ENGINE_CLEANUP_ITEM
));
173 void engine_cleanup_add_first(ENGINE_CLEANUP_CB
*cb
)
175 ENGINE_CLEANUP_ITEM
*item
;
176 if (!int_cleanup_check(1))
178 item
= int_cleanup_item(cb
);
180 sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack
, item
, 0);
183 void engine_cleanup_add_last(ENGINE_CLEANUP_CB
*cb
)
185 ENGINE_CLEANUP_ITEM
*item
;
186 if (!int_cleanup_check(1))
188 item
= int_cleanup_item(cb
);
190 sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack
, item
);
193 /* The API function that performs all cleanup */
194 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM
*item
)
200 void ENGINE_cleanup(void)
202 if (int_cleanup_check(0)) {
203 sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack
,
204 engine_cleanup_cb_free
);
205 cleanup_stack
= NULL
;
208 * FIXME: This should be handled (somehow) through RAND, eg. by it
209 * registering a cleanup callback.
211 RAND_set_rand_method(NULL
);
214 /* Now the "ex_data" support */
216 int ENGINE_get_ex_new_index(long argl
, void *argp
, CRYPTO_EX_new
*new_func
,
217 CRYPTO_EX_dup
*dup_func
,
218 CRYPTO_EX_free
*free_func
)
220 return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE
, argl
, argp
,
221 new_func
, dup_func
, free_func
);
224 int ENGINE_set_ex_data(ENGINE
*e
, int idx
, void *arg
)
226 return (CRYPTO_set_ex_data(&e
->ex_data
, idx
, arg
));
229 void *ENGINE_get_ex_data(const ENGINE
*e
, int idx
)
231 return (CRYPTO_get_ex_data(&e
->ex_data
, idx
));
235 * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
236 * ENGINE structure itself.
239 int ENGINE_set_id(ENGINE
*e
, const char *id
)
242 ENGINEerr(ENGINE_F_ENGINE_SET_ID
, ERR_R_PASSED_NULL_PARAMETER
);
249 int ENGINE_set_name(ENGINE
*e
, const char *name
)
252 ENGINEerr(ENGINE_F_ENGINE_SET_NAME
, ERR_R_PASSED_NULL_PARAMETER
);
259 int ENGINE_set_destroy_function(ENGINE
*e
, ENGINE_GEN_INT_FUNC_PTR destroy_f
)
261 e
->destroy
= destroy_f
;
265 int ENGINE_set_init_function(ENGINE
*e
, ENGINE_GEN_INT_FUNC_PTR init_f
)
271 int ENGINE_set_finish_function(ENGINE
*e
, ENGINE_GEN_INT_FUNC_PTR finish_f
)
273 e
->finish
= finish_f
;
277 int ENGINE_set_ctrl_function(ENGINE
*e
, ENGINE_CTRL_FUNC_PTR ctrl_f
)
283 int ENGINE_set_flags(ENGINE
*e
, int flags
)
289 int ENGINE_set_cmd_defns(ENGINE
*e
, const ENGINE_CMD_DEFN
*defns
)
291 e
->cmd_defns
= defns
;
295 const char *ENGINE_get_id(const ENGINE
*e
)
300 const char *ENGINE_get_name(const ENGINE
*e
)
305 ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_destroy_function(const ENGINE
*e
)
310 ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_init_function(const ENGINE
*e
)
315 ENGINE_GEN_INT_FUNC_PTR
ENGINE_get_finish_function(const ENGINE
*e
)
320 ENGINE_CTRL_FUNC_PTR
ENGINE_get_ctrl_function(const ENGINE
*e
)
325 int ENGINE_get_flags(const ENGINE
*e
)
330 const ENGINE_CMD_DEFN
*ENGINE_get_cmd_defns(const ENGINE
*e
)
336 * eng_lib.o is pretty much linked into anything that touches ENGINE already,
337 * so put the "static_state" hack here.
340 static int internal_static_hack
= 0;
342 void *ENGINE_get_static_state(void)
344 return &internal_static_hack
;