1 /* ====================================================================
2 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
16 * 3. All advertising materials mentioning features or use of this
17 * software must display the following acknowledgment:
18 * "This product includes software developed by the OpenSSL Project
19 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
21 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22 * endorse or promote products derived from this software without
23 * prior written permission. For written permission, please contact
24 * licensing@OpenSSL.org.
26 * 5. Products derived from this software may not be called "OpenSSL"
27 * nor may "OpenSSL" appear in their names without prior written
28 * permission of the OpenSSL Project.
30 * 6. Redistributions of any form whatsoever must retain the following
32 * "This product includes software developed by the OpenSSL Project
33 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
35 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46 * OF THE POSSIBILITY OF SUCH DAMAGE.
47 * ====================================================================
49 * This product includes cryptographic software written by Eric Young
50 * (eay@cryptsoft.com). This product includes software written by Tim
51 * Hudson (tjh@cryptsoft.com).
56 #include <openssl/evp.h>
57 #include <openssl/lhash.h>
60 /* This is the type of item in the 'implementation' table. Each 'nid' hashes to
61 * a (potentially NULL) ENGINE_PILE structure which contains a stack of ENGINE*
62 * pointers. These pointers aren't references, because they're inserted and
63 * removed during ENGINE creation and ENGINE destruction. They point to ENGINEs
64 * that *exist* (ie. have a structural reference count greater than zero) rather
65 * than ENGINEs that are *functional*. Each pointer in those stacks are to
66 * ENGINEs that implements the algorithm corresponding to each 'nid'. */
68 /* The type of the items in the table */
69 typedef struct st_engine_pile
71 /* The 'nid' of the algorithm/mode this ENGINE_PILE structure represents
74 /* A stack of ENGINE pointers for ENGINEs that support this
75 * algorithm/mode. In the event that 'funct' is NULL, the first entry in
76 * this stack that initialises will be set as 'funct' and assumed as the
77 * default for operations of this type. */
79 /* The default ENGINE to perform this algorithm/mode. */
81 /* This value optimises engine_table_select(). If it is called it sets
82 * this value to 1. Any changes to this ENGINE_PILE resets it to zero.
83 * As such, no ENGINE_init() thrashing is done unless ENGINEs
84 * continually register (and/or unregister). */
88 /* The type of the hash table of ENGINE_PILE structures such that each are
89 * unique and keyed by the 'nid' value. */
90 struct st_engine_table
95 /* This value stores global options controlling behaviour of (mostly) the
96 * engine_table_select() function. It's a bitmask of flag values of the form
97 * ENGINE_TABLE_FLAG_*** (as defined in engine.h) and is controlled by the
98 * ENGINE_[get|set]_table_flags() function. */
99 static unsigned int table_flags = 0;
101 /* API function manipulating 'table_flags' */
102 unsigned int ENGINE_get_table_flags(void)
106 void ENGINE_set_table_flags(unsigned int flags)
111 /* Internal functions for the "piles" hash table */
112 static unsigned long engine_pile_hash(const ENGINE_PILE *c)
116 static int engine_pile_cmp(const ENGINE_PILE *a, const ENGINE_PILE *b)
118 return a->nid - b->nid;
120 static IMPLEMENT_LHASH_HASH_FN(engine_pile_hash, const ENGINE_PILE *)
121 static IMPLEMENT_LHASH_COMP_FN(engine_pile_cmp, const ENGINE_PILE *)
122 static int int_table_check(ENGINE_TABLE **t, int create)
129 if((lh = lh_new(LHASH_HASH_FN(engine_pile_hash),
130 LHASH_COMP_FN(engine_pile_cmp))) == NULL)
132 *t = (ENGINE_TABLE *)lh;
136 /* Privately exposed (via eng_int.h) functions for adding and/or removing
137 * ENGINEs from the implementation table */
138 int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
139 ENGINE *e, const int *nids, int num_nids, int setdefault)
141 int ret = 0, added = 0;
142 ENGINE_PILE tmplate, *fnd;
143 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
146 if(!int_table_check(table, 1))
149 /* The cleanup callback needs to be added */
150 engine_cleanup_add_first(cleanup);
154 fnd = lh_retrieve(&(*table)->piles, &tmplate);
157 fnd = OPENSSL_malloc(sizeof(ENGINE_PILE));
162 fnd->sk = sk_ENGINE_new_null();
169 lh_insert(&(*table)->piles, fnd);
171 /* A registration shouldn't add duplciate entries */
172 sk_ENGINE_delete_ptr(fnd->sk, e);
173 /* if 'setdefault', this ENGINE goes to the head of the list */
174 if(!sk_ENGINE_push(fnd->sk, e))
176 /* "touch" this ENGINE_PILE */
180 if(!engine_unlocked_init(e))
182 ENGINEerr(ENGINE_F_ENGINE_TABLE_REGISTER,
183 ENGINE_R_INIT_FAILED);
187 engine_unlocked_finish(fnd->funct, 0);
194 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
197 static void int_unregister_cb(ENGINE_PILE *pile, ENGINE *e)
200 /* Iterate the 'c->sk' stack removing any occurance of 'e' */
201 while((n = sk_ENGINE_find(pile->sk, e)) >= 0)
203 sk_ENGINE_delete(pile->sk, n);
204 /* "touch" this ENGINE_CIPHER */
209 engine_unlocked_finish(e, 0);
213 static IMPLEMENT_LHASH_DOALL_ARG_FN(int_unregister_cb,ENGINE_PILE *,ENGINE *)
214 void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e)
216 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
217 if(int_table_check(table, 0))
218 lh_doall_arg(&(*table)->piles,
219 LHASH_DOALL_ARG_FN(int_unregister_cb), e);
220 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
223 static void int_cleanup_cb(ENGINE_PILE *p)
225 sk_ENGINE_free(p->sk);
227 engine_unlocked_finish(p->funct, 0);
230 static IMPLEMENT_LHASH_DOALL_FN(int_cleanup_cb,ENGINE_PILE *)
231 void engine_table_cleanup(ENGINE_TABLE **table)
233 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
236 lh_doall(&(*table)->piles, LHASH_DOALL_FN(int_cleanup_cb));
237 lh_free(&(*table)->piles);
240 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
243 /* Exposed API function to get a functional reference from the implementation
244 * table (ie. try to get a functional reference from the tabled structural
245 * references) for a given cipher 'nid' */
246 #ifndef ENGINE_TABLE_DEBUG
247 ENGINE *engine_table_select(ENGINE_TABLE **table, int nid)
249 ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f, int l)
253 ENGINE_PILE tmplate, *fnd=NULL;
254 int initres, loop = 0;
256 /* If 'engine_ciphers' is NULL, then it's absolutely *sure* that no
257 * ENGINEs have registered any implementations! */
260 #ifdef ENGINE_TABLE_DEBUG
261 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, no "
262 "registered for anything!\n", f, l, nid);
266 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
267 /* Check again inside the lock otherwise we could race against cleanup
268 * operations. But don't worry about a fprintf(stderr). */
269 if(!int_table_check(table, 0))
272 fnd = lh_retrieve(&(*table)->piles, &tmplate);
275 if(fnd->funct && engine_unlocked_init(fnd->funct))
277 #ifdef ENGINE_TABLE_DEBUG
278 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
279 "ENGINE '%s' cached\n", f, l, nid, fnd->funct->id);
290 ret = sk_ENGINE_value(fnd->sk, loop++);
293 #ifdef ENGINE_TABLE_DEBUG
294 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, no "
295 "registered implementations would initialise\n",
301 /* Don't need to get a reference if we hold the lock. If the locking has
302 * to change in future, that would be different ... */
303 ret->struct_ref++; engine_ref_debug(ret, 0, 1)
305 /* Try and initialise the ENGINE if it's already functional *or* if the
306 * ENGINE_TABLE_FLAG_NOINIT flag is not set. */
307 if((ret->funct_ref > 0) || !(table_flags & ENGINE_TABLE_FLAG_NOINIT))
308 initres = engine_unlocked_init(ret);
312 /* Release the structural reference */
313 ret->struct_ref--; engine_ref_debug(ret, 0, -1);
317 /* If we didn't have a default (functional reference) for this
318 * 'nid' (or we had one but for whatever reason we're now
319 * initialising a different one), use this opportunity to set
321 if((fnd->funct != ret) && engine_unlocked_init(ret))
323 /* If there was a previous default we release it. */
325 engine_unlocked_finish(fnd->funct, 0);
326 /* We got an extra functional reference for the
327 * per-'nid' default */
329 #ifdef ENGINE_TABLE_DEBUG
330 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, "
331 "setting default to '%s'\n", f, l, nid, ret->id);
334 #ifdef ENGINE_TABLE_DEBUG
335 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
336 "newly initialised '%s'\n", f, l, nid, ret->id);
342 /* Whatever happened - we should "untouch" our uptodate file seeing as
343 * we have tried our best to find a functional reference for 'nid'. If
344 * it failed, it is unlikely to succeed again until some future
345 * registrations (or unregistrations) have taken place that affect that
349 #ifdef ENGINE_TABLE_DEBUG
351 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
352 "ENGINE '%s'\n", f, l, nid, ret->id);
354 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
355 "'no matching ENGINE'\n", f, l, nid);
357 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
358 /* Whatever happened, any failed init()s are not failures in this
359 * context, so clear our error state. */