Branch data Line data Source code
1 : : /* ====================================================================
2 : : * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
3 : : *
4 : : * Redistribution and use in source and binary forms, with or without
5 : : * modification, are permitted provided that the following conditions
6 : : * are met:
7 : : *
8 : : * 1. Redistributions of source code must retain the above copyright
9 : : * notice, this list of conditions and the following disclaimer.
10 : : *
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
14 : : * distribution.
15 : : *
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/)"
20 : : *
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.
25 : : *
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.
29 : : *
30 : : * 6. Redistributions of any form whatsoever must retain the following
31 : : * acknowledgment:
32 : : * "This product includes software developed by the OpenSSL Project
33 : : * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
34 : : *
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 : : * ====================================================================
48 : : *
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).
52 : : *
53 : : */
54 : :
55 : : #include "cryptlib.h"
56 : : #include <openssl/evp.h>
57 : : #include <openssl/lhash.h>
58 : : #include "eng_int.h"
59 : :
60 : : /* The type of the items in the table */
61 : : typedef struct st_engine_pile
62 : : {
63 : : /* The 'nid' of this algorithm/mode */
64 : : int nid;
65 : : /* ENGINEs that implement this algorithm/mode. */
66 : : STACK_OF(ENGINE) *sk;
67 : : /* The default ENGINE to perform this algorithm/mode. */
68 : : ENGINE *funct;
69 : : /* Zero if 'sk' is newer than the cached 'funct', non-zero otherwise */
70 : : int uptodate;
71 : : } ENGINE_PILE;
72 : :
73 : : DECLARE_LHASH_OF(ENGINE_PILE);
74 : :
75 : : /* The type exposed in eng_int.h */
76 : : struct st_engine_table
77 : : {
78 : : LHASH_OF(ENGINE_PILE) piles;
79 : : }; /* ENGINE_TABLE */
80 : :
81 : :
82 : : typedef struct st_engine_pile_doall
83 : : {
84 : : engine_table_doall_cb *cb;
85 : : void *arg;
86 : : } ENGINE_PILE_DOALL;
87 : :
88 : :
89 : : /* Global flags (ENGINE_TABLE_FLAG_***). */
90 : : static unsigned int table_flags = 0;
91 : :
92 : : /* API function manipulating 'table_flags' */
93 : 0 : unsigned int ENGINE_get_table_flags(void)
94 : : {
95 : 0 : return table_flags;
96 : : }
97 : :
98 : 0 : void ENGINE_set_table_flags(unsigned int flags)
99 : : {
100 : 0 : table_flags = flags;
101 : 0 : }
102 : :
103 : : /* Internal functions for the "piles" hash table */
104 : 164024 : static unsigned long engine_pile_hash(const ENGINE_PILE *c)
105 : : {
106 : 82012 : return c->nid;
107 : : }
108 : :
109 : 42402 : static int engine_pile_cmp(const ENGINE_PILE *a, const ENGINE_PILE *b)
110 : : {
111 : 21201 : return a->nid - b->nid;
112 : : }
113 : 164024 : static IMPLEMENT_LHASH_HASH_FN(engine_pile, ENGINE_PILE)
114 : 42402 : static IMPLEMENT_LHASH_COMP_FN(engine_pile, ENGINE_PILE)
115 : :
116 : 68168 : static int int_table_check(ENGINE_TABLE **t, int create)
117 : : {
118 : : LHASH_OF(ENGINE_PILE) *lh;
119 : :
120 [ + + ]: 68168 : if(*t) return 1;
121 [ + - ]: 5097 : if(!create) return 0;
122 [ + - ]: 5097 : if((lh = lh_ENGINE_PILE_new()) == NULL)
123 : : return 0;
124 : 5097 : *t = (ENGINE_TABLE *)lh;
125 : 5097 : return 1;
126 : : }
127 : :
128 : : /* Privately exposed (via eng_int.h) functions for adding and/or removing
129 : : * ENGINEs from the implementation table */
130 : 22575 : int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
131 : : ENGINE *e, const int *nids, int num_nids, int setdefault)
132 : : {
133 : 22575 : int ret = 0, added = 0;
134 : : ENGINE_PILE tmplate, *fnd;
135 : 22575 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
136 [ + + ]: 22575 : if(!(*table))
137 : 5097 : added = 1;
138 [ + - ]: 22575 : if(!int_table_check(table, 1))
139 : : goto end;
140 [ + + ]: 22575 : if(added)
141 : : /* The cleanup callback needs to be added */
142 : 22575 : engine_cleanup_add_first(cleanup);
143 [ + + ]: 50983 : while(num_nids--)
144 : : {
145 : 28408 : tmplate.nid = *nids;
146 : 28408 : fnd = lh_ENGINE_PILE_retrieve(&(*table)->piles, &tmplate);
147 [ + + ]: 28408 : if(!fnd)
148 : : {
149 : 8011 : fnd = OPENSSL_malloc(sizeof(ENGINE_PILE));
150 [ + - ]: 8011 : if(!fnd) goto end;
151 : 8011 : fnd->uptodate = 1;
152 : 8011 : fnd->nid = *nids;
153 : 8011 : fnd->sk = sk_ENGINE_new_null();
154 [ - + ]: 8011 : if(!fnd->sk)
155 : : {
156 : 0 : OPENSSL_free(fnd);
157 : 0 : goto end;
158 : : }
159 : 8011 : fnd->funct = NULL;
160 : 8011 : (void)lh_ENGINE_PILE_insert(&(*table)->piles, fnd);
161 : : }
162 : : /* A registration shouldn't add duplciate entries */
163 : 28408 : (void)sk_ENGINE_delete_ptr(fnd->sk, e);
164 : : /* if 'setdefault', this ENGINE goes to the head of the list */
165 [ + - ]: 28408 : if(!sk_ENGINE_push(fnd->sk, e))
166 : : goto end;
167 : : /* "touch" this ENGINE_PILE */
168 : 28408 : fnd->uptodate = 0;
169 [ + + ]: 28408 : if(setdefault)
170 : : {
171 [ - + ]: 10 : if(!engine_unlocked_init(e))
172 : : {
173 : 0 : ENGINEerr(ENGINE_F_ENGINE_TABLE_REGISTER,
174 : : ENGINE_R_INIT_FAILED);
175 : 0 : goto end;
176 : : }
177 [ - + ]: 10 : if(fnd->funct)
178 : 0 : engine_unlocked_finish(fnd->funct, 0);
179 : 10 : fnd->funct = e;
180 : 10 : fnd->uptodate = 1;
181 : : }
182 : 28408 : nids++;
183 : : }
184 : : ret = 1;
185 : : end:
186 : 22575 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
187 : 22575 : return ret;
188 : : }
189 : 0 : static void int_unregister_cb_doall_arg(ENGINE_PILE *pile, ENGINE *e)
190 : : {
191 : : int n;
192 : : /* Iterate the 'c->sk' stack removing any occurrence of 'e' */
193 [ # # ]: 0 : while((n = sk_ENGINE_find(pile->sk, e)) >= 0)
194 : : {
195 : 0 : (void)sk_ENGINE_delete(pile->sk, n);
196 : 0 : pile->uptodate = 0;
197 : : }
198 [ # # ]: 0 : if(pile->funct == e)
199 : : {
200 : 0 : engine_unlocked_finish(e, 0);
201 : 0 : pile->funct = NULL;
202 : : }
203 : 0 : }
204 : 0 : static IMPLEMENT_LHASH_DOALL_ARG_FN(int_unregister_cb, ENGINE_PILE, ENGINE)
205 : :
206 : 0 : void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e)
207 : : {
208 : 0 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
209 [ # # ]: 0 : if(int_table_check(table, 0))
210 : 0 : lh_ENGINE_PILE_doall_arg(&(*table)->piles,
211 : : LHASH_DOALL_ARG_FN(int_unregister_cb),
212 : : ENGINE, e);
213 : 0 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
214 : 0 : }
215 : :
216 : 7997 : static void int_cleanup_cb_doall(ENGINE_PILE *p)
217 : : {
218 : 7997 : sk_ENGINE_free(p->sk);
219 [ - + ]: 7997 : if(p->funct)
220 : 0 : engine_unlocked_finish(p->funct, 0);
221 : 7997 : OPENSSL_free(p);
222 : 7997 : }
223 : 15994 : static IMPLEMENT_LHASH_DOALL_FN(int_cleanup_cb, ENGINE_PILE)
224 : :
225 : 5089 : void engine_table_cleanup(ENGINE_TABLE **table)
226 : : {
227 : 5089 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
228 [ + - ]: 5089 : if(*table)
229 : : {
230 : 5089 : lh_ENGINE_PILE_doall(&(*table)->piles,
231 : : LHASH_DOALL_FN(int_cleanup_cb));
232 : 5089 : lh_ENGINE_PILE_free(&(*table)->piles);
233 : 5089 : *table = NULL;
234 : : }
235 : 5089 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
236 : 5089 : }
237 : :
238 : : /* return a functional reference for a given 'nid' */
239 : : #ifndef ENGINE_TABLE_DEBUG
240 : 1258548 : ENGINE *engine_table_select(ENGINE_TABLE **table, int nid)
241 : : #else
242 : : ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f, int l)
243 : : #endif
244 : : {
245 : 1258548 : ENGINE *ret = NULL;
246 : 1258548 : ENGINE_PILE tmplate, *fnd=NULL;
247 : 1258548 : int initres, loop = 0;
248 : :
249 [ + + ]: 1258548 : if(!(*table))
250 : : {
251 : : #ifdef ENGINE_TABLE_DEBUG
252 : : fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, nothing "
253 : : "registered!\n", f, l, nid);
254 : : #endif
255 : : return NULL;
256 : : }
257 : 45593 : ERR_set_mark();
258 : 45593 : CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
259 : : /* Check again inside the lock otherwise we could race against cleanup
260 : : * operations. But don't worry about a fprintf(stderr). */
261 [ + - ]: 45593 : if(!int_table_check(table, 0)) goto end;
262 : 45593 : tmplate.nid = nid;
263 : 45593 : fnd = lh_ENGINE_PILE_retrieve(&(*table)->piles, &tmplate);
264 [ + + ]: 45593 : if(!fnd) goto end;
265 [ + + ][ + - ]: 804 : if(fnd->funct && engine_unlocked_init(fnd->funct))
266 : : {
267 : : #ifdef ENGINE_TABLE_DEBUG
268 : : fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
269 : : "ENGINE '%s' cached\n", f, l, nid, fnd->funct->id);
270 : : #endif
271 : 14 : ret = fnd->funct;
272 : 14 : goto end;
273 : : }
274 [ + + ]: 790 : if(fnd->uptodate)
275 : : {
276 : 257 : ret = fnd->funct;
277 : 790 : goto end;
278 : : }
279 : : trynext:
280 : 3687 : ret = sk_ENGINE_value(fnd->sk, loop++);
281 [ + + ]: 3687 : if(!ret)
282 : : {
283 : : #ifdef ENGINE_TABLE_DEBUG
284 : : fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, no "
285 : : "registered implementations would initialise\n",
286 : : f, l, nid);
287 : : #endif
288 : : goto end;
289 : : }
290 : : /* Try to initialise the ENGINE? */
291 [ + - ][ + - ]: 3154 : if((ret->funct_ref > 0) || !(table_flags & ENGINE_TABLE_FLAG_NOINIT))
292 : 3154 : initres = engine_unlocked_init(ret);
293 : : else
294 : : initres = 0;
295 [ + - ]: 3154 : if(initres)
296 : : {
297 : : /* Update 'funct' */
298 [ # # ][ # # ]: 0 : if((fnd->funct != ret) && engine_unlocked_init(ret))
299 : : {
300 : : /* If there was a previous default we release it. */
301 [ # # ]: 0 : if(fnd->funct)
302 : 0 : engine_unlocked_finish(fnd->funct, 0);
303 : 0 : fnd->funct = ret;
304 : : #ifdef ENGINE_TABLE_DEBUG
305 : : fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, "
306 : : "setting default to '%s'\n", f, l, nid, ret->id);
307 : : #endif
308 : : }
309 : : #ifdef ENGINE_TABLE_DEBUG
310 : : fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, using "
311 : : "newly initialised '%s'\n", f, l, nid, ret->id);
312 : : #endif
313 : : goto end;
314 : : }
315 : : goto trynext;
316 : : end:
317 : : /* If it failed, it is unlikely to succeed again until some future
318 : : * registrations have taken place. In all cases, we cache. */
319 [ + + ]: 45593 : if(fnd) fnd->uptodate = 1;
320 : : #ifdef ENGINE_TABLE_DEBUG
321 : : if(ret)
322 : : fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
323 : : "ENGINE '%s'\n", f, l, nid, ret->id);
324 : : else
325 : : fprintf(stderr, "engine_table_dbg: %s:%d, nid=%d, caching "
326 : : "'no matching ENGINE'\n", f, l, nid);
327 : : #endif
328 : 45593 : CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
329 : : /* Whatever happened, any failed init()s are not failures in this
330 : : * context, so clear our error state. */
331 : 45593 : ERR_pop_to_mark();
332 : 45593 : return ret;
333 : : }
334 : :
335 : : /* Table enumeration */
336 : :
337 : 0 : static void int_cb_doall_arg(ENGINE_PILE *pile, ENGINE_PILE_DOALL *dall)
338 : : {
339 : 0 : dall->cb(pile->nid, pile->sk, pile->funct, dall->arg);
340 : 0 : }
341 : 0 : static IMPLEMENT_LHASH_DOALL_ARG_FN(int_cb, ENGINE_PILE,ENGINE_PILE_DOALL)
342 : :
343 : 5825 : void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb,
344 : : void *arg)
345 : : {
346 : : ENGINE_PILE_DOALL dall;
347 : 5825 : dall.cb = cb;
348 : 5825 : dall.arg = arg;
349 [ - + ]: 5825 : if (table)
350 : 0 : lh_ENGINE_PILE_doall_arg(&table->piles,
351 : : LHASH_DOALL_ARG_FN(int_cb),
352 : : ENGINE_PILE_DOALL, &dall);
353 : 5825 : }
|
