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 typedef 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 DECLARE_LHASH_OF(ENGINE_PILE);
76 /* The type exposed in eng_int.h */
77 struct st_engine_table {
78 LHASH_OF(ENGINE_PILE) piles;
81 typedef struct st_engine_pile_doall {
82 engine_table_doall_cb *cb;
86 /* Global flags (ENGINE_TABLE_FLAG_***). */
87 static unsigned int table_flags = 0;
89 /* API function manipulating 'table_flags' */
90 unsigned int ENGINE_get_table_flags(void)
95 void ENGINE_set_table_flags(unsigned int flags)
100 /* Internal functions for the "piles" hash table */
101 static unsigned long engine_pile_hash(const ENGINE_PILE *c)
106 static int engine_pile_cmp(const ENGINE_PILE *a, const ENGINE_PILE *b)
108 return a->nid - b->nid;
111 static IMPLEMENT_LHASH_HASH_FN(engine_pile, ENGINE_PILE)
112 static IMPLEMENT_LHASH_COMP_FN(engine_pile, ENGINE_PILE)
114 static int int_table_check(ENGINE_TABLE **t, int create)
116 LHASH_OF(ENGINE_PILE) *lh;
122 if ((lh = lh_ENGINE_PILE_new()) == NULL)
124 *t = (ENGINE_TABLE *)lh;
129 * Privately exposed (via eng_int.h) functions for adding and/or removing
130 * ENGINEs from the implementation table
132 int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
133 ENGINE *e, const int *nids, int num_nids,
136 int ret = 0, added = 0;
137 ENGINE_PILE tmplate, *fnd;
138 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
141 if (!int_table_check(table, 1))
144 /* The cleanup callback needs to be added */
145 engine_cleanup_add_first(cleanup);
148 fnd = lh_ENGINE_PILE_retrieve(&(*table)->piles, &tmplate);
150 fnd = OPENSSL_malloc(sizeof(*fnd));
155 fnd->sk = sk_ENGINE_new_null();
161 (void)lh_ENGINE_PILE_insert(&(*table)->piles, fnd);
163 /* A registration shouldn't add duplciate entries */
164 (void)sk_ENGINE_delete_ptr(fnd->sk, e);
166 * if 'setdefault', this ENGINE goes to the head of the list
168 if (!sk_ENGINE_push(fnd->sk, e))
170 /* "touch" this ENGINE_PILE */
173 if (!engine_unlocked_init(e)) {
174 ENGINEerr(ENGINE_F_ENGINE_TABLE_REGISTER,
175 ENGINE_R_INIT_FAILED);
179 engine_unlocked_finish(fnd->funct, 0);
187 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
191 static void int_unregister_cb_doall_arg(ENGINE_PILE *pile, ENGINE *e)
194 /* Iterate the 'c->sk' stack removing any occurrence of 'e' */
195 while ((n = sk_ENGINE_find(pile->sk, e)) >= 0) {
196 (void)sk_ENGINE_delete(pile->sk, n);
199 if (pile->funct == e) {
200 engine_unlocked_finish(e, 0);
205 static IMPLEMENT_LHASH_DOALL_ARG_FN(int_unregister_cb, ENGINE_PILE, ENGINE)
207 void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e)
209 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
210 if (int_table_check(table, 0))
211 lh_ENGINE_PILE_doall_arg(&(*table)->piles,
212 LHASH_DOALL_ARG_FN(int_unregister_cb),
214 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
217 static void int_cleanup_cb_doall(ENGINE_PILE *p)
221 sk_ENGINE_free(p->sk);
223 engine_unlocked_finish(p->funct, 0);
227 static IMPLEMENT_LHASH_DOALL_FN(int_cleanup_cb, ENGINE_PILE)
229 void engine_table_cleanup(ENGINE_TABLE **table)
231 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
233 lh_ENGINE_PILE_doall(&(*table)->piles,
234 LHASH_DOALL_FN(int_cleanup_cb));
235 lh_ENGINE_PILE_free(&(*table)->piles);
238 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
241 /* return a functional reference for a given 'nid' */
242 #ifndef ENGINE_TABLE_DEBUG
243 ENGINE *engine_table_select(ENGINE_TABLE **table, int nid)
245 ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f,
250 ENGINE_PILE tmplate, *fnd = NULL;
251 int initres, loop = 0;
254 #ifdef ENGINE_TABLE_DEBUG
255 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, nothing "
256 "registered!\n", f, l, nid);
261 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
263 * Check again inside the lock otherwise we could race against cleanup
264 * operations. But don't worry about a fprintf(stderr).
266 if (!int_table_check(table, 0))
269 fnd = lh_ENGINE_PILE_retrieve(&(*table)->piles, &tmplate);
272 if (fnd->funct && engine_unlocked_init(fnd->funct)) {
273 #ifdef ENGINE_TABLE_DEBUG
274 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
275 "ENGINE '%s' cached\n", f, l, nid, fnd->funct->id);
285 ret = sk_ENGINE_value(fnd->sk, loop++);
287 #ifdef ENGINE_TABLE_DEBUG
288 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, no "
289 "registered implementations would initialise\n", f, l, nid);
293 /* Try to initialise the ENGINE? */
294 if ((ret->funct_ref > 0) || !(table_flags & ENGINE_TABLE_FLAG_NOINIT))
295 initres = engine_unlocked_init(ret);
300 if ((fnd->funct != ret) && engine_unlocked_init(ret)) {
301 /* If there was a previous default we release it. */
303 engine_unlocked_finish(fnd->funct, 0);
305 #ifdef ENGINE_TABLE_DEBUG
306 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, "
307 "setting default to '%s'\n", f, l, nid, ret->id);
310 #ifdef ENGINE_TABLE_DEBUG
311 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
312 "newly initialised '%s'\n", f, l, nid, ret->id);
319 * If it failed, it is unlikely to succeed again until some future
320 * registrations have taken place. In all cases, we cache.
324 #ifdef ENGINE_TABLE_DEBUG
326 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
327 "ENGINE '%s'\n", f, l, nid, ret->id);
329 fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
330 "'no matching ENGINE'\n", f, l, nid);
332 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
334 * Whatever happened, any failed init()s are not failures in this
335 * context, so clear our error state.
341 /* Table enumeration */
343 static void int_cb_doall_arg(ENGINE_PILE *pile, ENGINE_PILE_DOALL *dall)
345 dall->cb(pile->nid, pile->sk, pile->funct, dall->arg);
348 static IMPLEMENT_LHASH_DOALL_ARG_FN(int_cb, ENGINE_PILE, ENGINE_PILE_DOALL)
350 void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb,
353 ENGINE_PILE_DOALL dall;
357 lh_ENGINE_PILE_doall_arg(&table->piles,
358 LHASH_DOALL_ARG_FN(int_cb),
359 ENGINE_PILE_DOALL, &dall);