2 * Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #include "internal/cryptlib.h"
11 #include <openssl/evp.h>
12 #include <openssl/lhash.h>
13 #include <openssl/trace.h>
16 /* The type of the items in the table */
17 struct st_engine_pile
{
18 /* The 'nid' of this algorithm/mode */
20 /* ENGINEs that implement this algorithm/mode. */
22 /* The default ENGINE to perform this algorithm/mode. */
25 * Zero if 'sk' is newer than the cached 'funct', non-zero otherwise
30 /* The type exposed in eng_int.h */
31 struct st_engine_table
{
32 LHASH_OF(ENGINE_PILE
) piles
;
35 typedef struct st_engine_pile_doall
{
36 engine_table_doall_cb
*cb
;
40 /* Global flags (ENGINE_TABLE_FLAG_***). */
41 static unsigned int table_flags
= 0;
43 /* API function manipulating 'table_flags' */
44 unsigned int ENGINE_get_table_flags(void)
49 void ENGINE_set_table_flags(unsigned int flags
)
54 /* Internal functions for the "piles" hash table */
55 static unsigned long engine_pile_hash(const ENGINE_PILE
*c
)
60 static int engine_pile_cmp(const ENGINE_PILE
*a
, const ENGINE_PILE
*b
)
62 return a
->nid
- b
->nid
;
65 static int int_table_check(ENGINE_TABLE
**t
, int create
)
67 LHASH_OF(ENGINE_PILE
) *lh
;
73 if ((lh
= lh_ENGINE_PILE_new(engine_pile_hash
, engine_pile_cmp
)) == NULL
)
75 *t
= (ENGINE_TABLE
*)lh
;
80 * Privately exposed (via eng_int.h) functions for adding and/or removing
81 * ENGINEs from the implementation table
83 int engine_table_register(ENGINE_TABLE
**table
, ENGINE_CLEANUP_CB
*cleanup
,
84 ENGINE
*e
, const int *nids
, int num_nids
,
87 int ret
= 0, added
= 0;
88 ENGINE_PILE tmplate
, *fnd
;
89 CRYPTO_THREAD_write_lock(global_engine_lock
);
92 if (!int_table_check(table
, 1))
95 /* The cleanup callback needs to be added */
96 engine_cleanup_add_first(cleanup
);
99 fnd
= lh_ENGINE_PILE_retrieve(&(*table
)->piles
, &tmplate
);
101 fnd
= OPENSSL_malloc(sizeof(*fnd
));
106 fnd
->sk
= sk_ENGINE_new_null();
112 (void)lh_ENGINE_PILE_insert(&(*table
)->piles
, fnd
);
113 if (lh_ENGINE_PILE_retrieve(&(*table
)->piles
, &tmplate
) != fnd
) {
114 sk_ENGINE_free(fnd
->sk
);
119 /* A registration shouldn't add duplicate entries */
120 (void)sk_ENGINE_delete_ptr(fnd
->sk
, e
);
122 * if 'setdefault', this ENGINE goes to the head of the list
124 if (!sk_ENGINE_push(fnd
->sk
, e
))
126 /* "touch" this ENGINE_PILE */
129 if (!engine_unlocked_init(e
)) {
130 ENGINEerr(ENGINE_F_ENGINE_TABLE_REGISTER
,
131 ENGINE_R_INIT_FAILED
);
135 engine_unlocked_finish(fnd
->funct
, 0);
143 CRYPTO_THREAD_unlock(global_engine_lock
);
147 static void int_unregister_cb(ENGINE_PILE
*pile
, ENGINE
*e
)
150 /* Iterate the 'c->sk' stack removing any occurrence of 'e' */
151 while ((n
= sk_ENGINE_find(pile
->sk
, e
)) >= 0) {
152 (void)sk_ENGINE_delete(pile
->sk
, n
);
155 if (pile
->funct
== e
) {
156 engine_unlocked_finish(e
, 0);
161 IMPLEMENT_LHASH_DOALL_ARG(ENGINE_PILE
, ENGINE
);
163 void engine_table_unregister(ENGINE_TABLE
**table
, ENGINE
*e
)
165 CRYPTO_THREAD_write_lock(global_engine_lock
);
166 if (int_table_check(table
, 0))
167 lh_ENGINE_PILE_doall_ENGINE(&(*table
)->piles
, int_unregister_cb
, e
);
168 CRYPTO_THREAD_unlock(global_engine_lock
);
171 static void int_cleanup_cb_doall(ENGINE_PILE
*p
)
175 sk_ENGINE_free(p
->sk
);
177 engine_unlocked_finish(p
->funct
, 0);
181 void engine_table_cleanup(ENGINE_TABLE
**table
)
183 CRYPTO_THREAD_write_lock(global_engine_lock
);
185 lh_ENGINE_PILE_doall(&(*table
)->piles
, int_cleanup_cb_doall
);
186 lh_ENGINE_PILE_free(&(*table
)->piles
);
189 CRYPTO_THREAD_unlock(global_engine_lock
);
192 /* return a functional reference for a given 'nid' */
193 ENGINE
*engine_table_select_int(ENGINE_TABLE
**table
, int nid
, const char *f
,
197 ENGINE_PILE tmplate
, *fnd
= NULL
;
198 int initres
, loop
= 0;
201 OSSL_TRACE3(ENGINE_TABLE
,
202 "%s:%d, nid=%d, nothing registered!\n",
207 CRYPTO_THREAD_write_lock(global_engine_lock
);
209 * Check again inside the lock otherwise we could race against cleanup
210 * operations. But don't worry about a debug printout
212 if (!int_table_check(table
, 0))
215 fnd
= lh_ENGINE_PILE_retrieve(&(*table
)->piles
, &tmplate
);
218 if (fnd
->funct
&& engine_unlocked_init(fnd
->funct
)) {
219 OSSL_TRACE4(ENGINE_TABLE
,
220 "%s:%d, nid=%d, using ENGINE '%s' cached\n",
221 f
, l
, nid
, fnd
->funct
->id
);
230 ret
= sk_ENGINE_value(fnd
->sk
, loop
++);
232 OSSL_TRACE3(ENGINE_TABLE
,
234 "no registered implementations would initialise\n",
238 /* Try to initialise the ENGINE? */
239 if ((ret
->funct_ref
> 0) || !(table_flags
& ENGINE_TABLE_FLAG_NOINIT
))
240 initres
= engine_unlocked_init(ret
);
245 if ((fnd
->funct
!= ret
) && engine_unlocked_init(ret
)) {
246 /* If there was a previous default we release it. */
248 engine_unlocked_finish(fnd
->funct
, 0);
250 OSSL_TRACE4(ENGINE_TABLE
,
251 "%s:%d, nid=%d, setting default to '%s'\n",
254 OSSL_TRACE4(ENGINE_TABLE
,
255 "%s:%d, nid=%d, using newly initialised '%s'\n",
262 * If it failed, it is unlikely to succeed again until some future
263 * registrations have taken place. In all cases, we cache.
268 OSSL_TRACE4(ENGINE_TABLE
,
269 "%s:%d, nid=%d, caching ENGINE '%s'\n",
272 OSSL_TRACE3(ENGINE_TABLE
,
273 "%s:%d, nid=%d, caching 'no matching ENGINE'\n",
275 CRYPTO_THREAD_unlock(global_engine_lock
);
277 * Whatever happened, any failed init()s are not failures in this
278 * context, so clear our error state.
284 /* Table enumeration */
286 static void int_dall(const ENGINE_PILE
*pile
, ENGINE_PILE_DOALL
*dall
)
288 dall
->cb(pile
->nid
, pile
->sk
, pile
->funct
, dall
->arg
);
291 IMPLEMENT_LHASH_DOALL_ARG_CONST(ENGINE_PILE
, ENGINE_PILE_DOALL
);
293 void engine_table_doall(ENGINE_TABLE
*table
, engine_table_doall_cb
*cb
,
296 ENGINE_PILE_DOALL dall
;
300 lh_ENGINE_PILE_doall_ENGINE_PILE_DOALL(&table
->piles
, int_dall
, &dall
);