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).
55 #include "internal/cryptlib.h"
56 #include <openssl/evp.h>
57 #include <openssl/lhash.h>
60 /* The type of the items in the table */
61 struct st_engine_pile {
62 /* The 'nid' of this algorithm/mode */
64 /* ENGINEs that implement this algorithm/mode. */
66 /* The default ENGINE to perform this algorithm/mode. */
69 * Zero if 'sk' is newer than the cached 'funct', non-zero otherwise
74 /* The type exposed in eng_int.h */
75 struct st_engine_table {
76 LHASH_OF(ENGINE_PILE) piles;
79 typedef struct st_engine_pile_doall {
80 engine_table_doall_cb *cb;
84 /* Global flags (ENGINE_TABLE_FLAG_***). */
85 static unsigned int table_flags = 0;
87 /* API function manipulating 'table_flags' */
88 unsigned int ENGINE_get_table_flags(void)
93 void ENGINE_set_table_flags(unsigned int flags)
98 /* Internal functions for the "piles" hash table */
99 static unsigned long engine_pile_hash(const ENGINE_PILE *c)
104 static int engine_pile_cmp(const ENGINE_PILE *a, const ENGINE_PILE *b)
106 return a->nid - b->nid;
109 static IMPLEMENT_LHASH_HASH_FN(engine_pile, ENGINE_PILE)
110 static IMPLEMENT_LHASH_COMP_FN(engine_pile, ENGINE_PILE)
112 static int int_table_check(ENGINE_TABLE **t, int create)
114 LHASH_OF(ENGINE_PILE) *lh;
120 if ((lh = lh_ENGINE_PILE_new()) == NULL)
122 *t = (ENGINE_TABLE *)lh;
127 * Privately exposed (via eng_int.h) functions for adding and/or removing
128 * ENGINEs from the implementation table
130 int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
131 ENGINE *e, const int *nids, int num_nids,
134 int ret = 0, added = 0;
135 ENGINE_PILE tmplate, *fnd;
136 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
139 if (!int_table_check(table, 1))
142 /* The cleanup callback needs to be added */
143 engine_cleanup_add_first(cleanup);
146 fnd = lh_ENGINE_PILE_retrieve(&(*table)->piles, &tmplate);
148 fnd = OPENSSL_malloc(sizeof(*fnd));
153 fnd->sk = sk_ENGINE_new_null();
159 (void)lh_ENGINE_PILE_insert(&(*table)->piles, fnd);
161 /* A registration shouldn't add duplciate entries */
162 (void)sk_ENGINE_delete_ptr(fnd->sk, e);
164 * if 'setdefault', this ENGINE goes to the head of the list
166 if (!sk_ENGINE_push(fnd->sk, e))
168 /* "touch" this ENGINE_PILE */
171 if (!engine_unlocked_init(e)) {
172 ENGINEerr(ENGINE_F_ENGINE_TABLE_REGISTER,
173 ENGINE_R_INIT_FAILED);
177 engine_unlocked_finish(fnd->funct, 0);
185 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
189 static void int_unregister_cb_doall_arg(ENGINE_PILE *pile, ENGINE *e)
192 /* Iterate the 'c->sk' stack removing any occurrence of 'e' */
193 while ((n = sk_ENGINE_find(pile->sk, e)) >= 0) {
194 (void)sk_ENGINE_delete(pile->sk, n);
197 if (pile->funct == e) {
198 engine_unlocked_finish(e, 0);
203 static IMPLEMENT_LHASH_DOALL_ARG_FN(int_unregister_cb, ENGINE_PILE, ENGINE)
205 void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e)
207 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
208 if (int_table_check(table, 0))
209 lh_ENGINE_PILE_doall_arg(&(*table)->piles,
210 LHASH_DOALL_ARG_FN(int_unregister_cb),
212 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
215 static void int_cleanup_cb_doall(ENGINE_PILE *p)
219 sk_ENGINE_free(p->sk);
221 engine_unlocked_finish(p->funct, 0);
225 static IMPLEMENT_LHASH_DOALL_FN(int_cleanup_cb, ENGINE_PILE)
227 void engine_table_cleanup(ENGINE_TABLE **table)
229 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
231 lh_ENGINE_PILE_doall(&(*table)->piles,
232 LHASH_DOALL_FN(int_cleanup_cb));
233 lh_ENGINE_PILE_free(&(*table)->piles);
236 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
239 /* return a functional reference for a given 'nid' */
240 #ifndef ENGINE_TABLE_DEBUG
241 ENGINE *engine_table_select(ENGINE_TABLE **table, int nid)
243 ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f,
248 ENGINE_PILE tmplate, *fnd = NULL;
249 int initres, loop = 0;
252 #ifdef ENGINE_TABLE_DEBUG
253 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, nothing "
254 "registered!\n", f, l, nid);
259 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
261 * Check again inside the lock otherwise we could race against cleanup
262 * operations. But don't worry about a fprintf(stderr).
264 if (!int_table_check(table, 0))
267 fnd = lh_ENGINE_PILE_retrieve(&(*table)->piles, &tmplate);
270 if (fnd->funct && engine_unlocked_init(fnd->funct)) {
271 #ifdef ENGINE_TABLE_DEBUG
272 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
273 "ENGINE '%s' cached\n", f, l, nid, fnd->funct->id);
283 ret = sk_ENGINE_value(fnd->sk, loop++);
285 #ifdef ENGINE_TABLE_DEBUG
286 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, no "
287 "registered implementations would initialise\n", f, l, nid);
291 /* Try to initialise the ENGINE? */
292 if ((ret->funct_ref > 0) || !(table_flags & ENGINE_TABLE_FLAG_NOINIT))
293 initres = engine_unlocked_init(ret);
298 if ((fnd->funct != ret) && engine_unlocked_init(ret)) {
299 /* If there was a previous default we release it. */
301 engine_unlocked_finish(fnd->funct, 0);
303 #ifdef ENGINE_TABLE_DEBUG
304 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, "
305 "setting default to '%s'\n", f, l, nid, ret->id);
308 #ifdef ENGINE_TABLE_DEBUG
309 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
310 "newly initialised '%s'\n", f, l, nid, ret->id);
317 * If it failed, it is unlikely to succeed again until some future
318 * registrations have taken place. In all cases, we cache.
322 #ifdef ENGINE_TABLE_DEBUG
324 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
325 "ENGINE '%s'\n", f, l, nid, ret->id);
327 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
328 "'no matching ENGINE'\n", f, l, nid);
330 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
332 * Whatever happened, any failed init()s are not failures in this
333 * context, so clear our error state.
339 /* Table enumeration */
341 static void int_cb_doall_arg(ENGINE_PILE *pile, ENGINE_PILE_DOALL *dall)
343 dall->cb(pile->nid, pile->sk, pile->funct, dall->arg);
346 static IMPLEMENT_LHASH_DOALL_ARG_FN(int_cb, ENGINE_PILE, ENGINE_PILE_DOALL)
348 void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb,
351 ENGINE_PILE_DOALL dall;
355 lh_ENGINE_PILE_doall_arg(&table->piles,
356 LHASH_DOALL_ARG_FN(int_cb),
357 ENGINE_PILE_DOALL, &dall);