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 int int_table_check(ENGINE_TABLE
**t
, int create
)
111 LHASH_OF(ENGINE_PILE
) *lh
;
117 if ((lh
= lh_ENGINE_PILE_new(engine_pile_hash
, engine_pile_cmp
)) == NULL
)
119 *t
= (ENGINE_TABLE
*)lh
;
124 * Privately exposed (via eng_int.h) functions for adding and/or removing
125 * ENGINEs from the implementation table
127 int engine_table_register(ENGINE_TABLE
**table
, ENGINE_CLEANUP_CB
*cleanup
,
128 ENGINE
*e
, const int *nids
, int num_nids
,
131 int ret
= 0, added
= 0;
132 ENGINE_PILE tmplate
, *fnd
;
133 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE
);
136 if (!int_table_check(table
, 1))
139 /* The cleanup callback needs to be added */
140 engine_cleanup_add_first(cleanup
);
143 fnd
= lh_ENGINE_PILE_retrieve(&(*table
)->piles
, &tmplate
);
145 fnd
= OPENSSL_malloc(sizeof(*fnd
));
150 fnd
->sk
= sk_ENGINE_new_null();
156 (void)lh_ENGINE_PILE_insert(&(*table
)->piles
, fnd
);
158 /* A registration shouldn't add duplicate entries */
159 (void)sk_ENGINE_delete_ptr(fnd
->sk
, e
);
161 * if 'setdefault', this ENGINE goes to the head of the list
163 if (!sk_ENGINE_push(fnd
->sk
, e
))
165 /* "touch" this ENGINE_PILE */
168 if (!engine_unlocked_init(e
)) {
169 ENGINEerr(ENGINE_F_ENGINE_TABLE_REGISTER
,
170 ENGINE_R_INIT_FAILED
);
174 engine_unlocked_finish(fnd
->funct
, 0);
182 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE
);
186 static void int_unregister_cb(ENGINE_PILE
*pile
, ENGINE
*e
)
189 /* Iterate the 'c->sk' stack removing any occurrence of 'e' */
190 while ((n
= sk_ENGINE_find(pile
->sk
, e
)) >= 0) {
191 (void)sk_ENGINE_delete(pile
->sk
, n
);
194 if (pile
->funct
== e
) {
195 engine_unlocked_finish(e
, 0);
200 IMPLEMENT_LHASH_DOALL_ARG(ENGINE_PILE
, ENGINE
);
202 void engine_table_unregister(ENGINE_TABLE
**table
, ENGINE
*e
)
204 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE
);
205 if (int_table_check(table
, 0))
206 lh_ENGINE_PILE_doall_ENGINE(&(*table
)->piles
, int_unregister_cb
, e
);
207 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE
);
210 static void int_cleanup_cb_doall(ENGINE_PILE
*p
)
214 sk_ENGINE_free(p
->sk
);
216 engine_unlocked_finish(p
->funct
, 0);
220 void engine_table_cleanup(ENGINE_TABLE
**table
)
222 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE
);
224 lh_ENGINE_PILE_doall(&(*table
)->piles
, int_cleanup_cb_doall
);
225 lh_ENGINE_PILE_free(&(*table
)->piles
);
228 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE
);
231 /* return a functional reference for a given 'nid' */
232 #ifndef ENGINE_TABLE_DEBUG
233 ENGINE
*engine_table_select(ENGINE_TABLE
**table
, int nid
)
235 ENGINE
*engine_table_select_tmp(ENGINE_TABLE
**table
, int nid
, const char *f
,
240 ENGINE_PILE tmplate
, *fnd
= NULL
;
241 int initres
, loop
= 0;
244 #ifdef ENGINE_TABLE_DEBUG
245 fprintf(stderr
, "engine_table_dbg: %s:%d, nid=%d, nothing "
246 "registered!\n", f
, l
, nid
);
251 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE
);
253 * Check again inside the lock otherwise we could race against cleanup
254 * operations. But don't worry about a fprintf(stderr).
256 if (!int_table_check(table
, 0))
259 fnd
= lh_ENGINE_PILE_retrieve(&(*table
)->piles
, &tmplate
);
262 if (fnd
->funct
&& engine_unlocked_init(fnd
->funct
)) {
263 #ifdef ENGINE_TABLE_DEBUG
264 fprintf(stderr
, "engine_table_dbg: %s:%d, nid=%d, using "
265 "ENGINE '%s' cached\n", f
, l
, nid
, fnd
->funct
->id
);
275 ret
= sk_ENGINE_value(fnd
->sk
, loop
++);
277 #ifdef ENGINE_TABLE_DEBUG
278 fprintf(stderr
, "engine_table_dbg: %s:%d, nid=%d, no "
279 "registered implementations would initialise\n", f
, l
, nid
);
283 /* Try to initialise the ENGINE? */
284 if ((ret
->funct_ref
> 0) || !(table_flags
& ENGINE_TABLE_FLAG_NOINIT
))
285 initres
= engine_unlocked_init(ret
);
290 if ((fnd
->funct
!= ret
) && engine_unlocked_init(ret
)) {
291 /* If there was a previous default we release it. */
293 engine_unlocked_finish(fnd
->funct
, 0);
295 #ifdef ENGINE_TABLE_DEBUG
296 fprintf(stderr
, "engine_table_dbg: %s:%d, nid=%d, "
297 "setting default to '%s'\n", f
, l
, nid
, ret
->id
);
300 #ifdef ENGINE_TABLE_DEBUG
301 fprintf(stderr
, "engine_table_dbg: %s:%d, nid=%d, using "
302 "newly initialised '%s'\n", f
, l
, nid
, ret
->id
);
309 * If it failed, it is unlikely to succeed again until some future
310 * registrations have taken place. In all cases, we cache.
314 #ifdef ENGINE_TABLE_DEBUG
316 fprintf(stderr
, "engine_table_dbg: %s:%d, nid=%d, caching "
317 "ENGINE '%s'\n", f
, l
, nid
, ret
->id
);
319 fprintf(stderr
, "engine_table_dbg: %s:%d, nid=%d, caching "
320 "'no matching ENGINE'\n", f
, l
, nid
);
322 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE
);
324 * Whatever happened, any failed init()s are not failures in this
325 * context, so clear our error state.
331 /* Table enumeration */
333 static void int_dall(const ENGINE_PILE
*pile
, ENGINE_PILE_DOALL
*dall
)
335 dall
->cb(pile
->nid
, pile
->sk
, pile
->funct
, dall
->arg
);
338 IMPLEMENT_LHASH_DOALL_ARG_CONST(ENGINE_PILE
, ENGINE_PILE_DOALL
);
340 void engine_table_doall(ENGINE_TABLE
*table
, engine_table_doall_cb
*cb
,
343 ENGINE_PILE_DOALL dall
;
347 lh_ENGINE_PILE_doall_ENGINE_PILE_DOALL(&table
->piles
, int_dall
, &dall
);