1 /* crypto/engine/engine_list.c */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
59 #include <openssl/crypto.h>
61 #include "engine_int.h"
62 #include <openssl/engine.h>
64 /* The linked-list of pointers to engine types. engine_list_head
65 * incorporates an implicit structural reference but engine_list_tail
66 * does not - the latter is a computational niceity and only points
67 * to something that is already pointed to by its predecessor in the
68 * list (or engine_list_head itself). In the same way, the use of the
69 * "prev" pointer in each ENGINE is to save excessive list iteration,
70 * it doesn't correspond to an extra structural reference. Hence,
71 * engine_list_head, and each non-null "next" pointer account for
72 * the list itself assuming exactly 1 structural reference on each
74 static ENGINE *engine_list_head = NULL;
75 static ENGINE *engine_list_tail = NULL;
76 /* A boolean switch, used to ensure we only initialise once. This
77 * is needed because the engine list may genuinely become empty during
78 * use (so we can't use engine_list_head as an indicator for example. */
79 static int engine_list_flag = 0;
81 /* These static functions starting with a lower case "engine_" always
82 * take place when CRYPTO_LOCK_ENGINE has been locked up. */
83 static int engine_list_add(ENGINE *e)
86 ENGINE *iterator = NULL;
90 ENGINEerr(ENGINE_F_ENGINE_LIST_ADD,
91 ERR_R_PASSED_NULL_PARAMETER);
94 iterator = engine_list_head;
95 while(iterator && !conflict)
97 conflict = (strcmp(iterator->id, e->id) == 0);
98 iterator = iterator->next;
102 ENGINEerr(ENGINE_F_ENGINE_LIST_ADD,
103 ENGINE_R_CONFLICTING_ENGINE_ID);
106 if(engine_list_head == NULL)
108 /* We are adding to an empty list. */
111 ENGINEerr(ENGINE_F_ENGINE_LIST_ADD,
112 ENGINE_R_INTERNAL_LIST_ERROR);
115 engine_list_head = e;
120 /* We are adding to the tail of an existing list. */
121 if((engine_list_tail == NULL) ||
122 (engine_list_tail->next != NULL))
124 ENGINEerr(ENGINE_F_ENGINE_LIST_ADD,
125 ENGINE_R_INTERNAL_LIST_ERROR);
128 engine_list_tail->next = e;
129 e->prev = engine_list_tail;
131 /* Having the engine in the list assumes a structural
134 /* However it came to be, e is the last item in the list. */
135 engine_list_tail = e;
140 static int engine_list_remove(ENGINE *e)
146 ENGINEerr(ENGINE_F_ENGINE_LIST_REMOVE,
147 ERR_R_PASSED_NULL_PARAMETER);
150 /* We need to check that e is in our linked list! */
151 iterator = engine_list_head;
152 while(iterator && (iterator != e))
153 iterator = iterator->next;
156 ENGINEerr(ENGINE_F_ENGINE_LIST_REMOVE,
157 ENGINE_R_ENGINE_IS_NOT_IN_LIST);
160 /* un-link e from the chain. */
162 e->next->prev = e->prev;
164 e->prev->next = e->next;
165 /* Correct our head/tail if necessary. */
166 if(engine_list_head == e)
167 engine_list_head = e->next;
168 if(engine_list_tail == e)
169 engine_list_tail = e->prev;
170 /* remove our structural reference. */
175 /* This check always takes place with CRYPTO_LOCK_ENGINE locked up
176 * so we're synchronised, but we can't call anything that tries to
177 * lock it again! :-) NB: For convenience (and code-clarity) we
178 * don't output errors for failures of the engine_list_add function
179 * as it will generate errors itself. */
180 static int engine_internal_check(void)
184 /* This is our first time up, we need to populate the list
185 * with our statically compiled-in engines. */
186 if(!engine_list_add(ENGINE_openssl()))
188 engine_list_flag = 1;
192 /* Get the first/last "ENGINE" type available. */
193 ENGINE *ENGINE_get_first(void)
197 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
198 if(engine_internal_check())
200 ret = engine_list_head;
204 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
207 ENGINE *ENGINE_get_last(void)
211 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
212 if(engine_internal_check())
214 ret = engine_list_tail;
218 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
222 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
223 ENGINE *ENGINE_get_next(ENGINE *e)
228 ENGINEerr(ENGINE_F_ENGINE_GET_NEXT,
229 ERR_R_PASSED_NULL_PARAMETER);
232 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
237 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
240 ENGINE *ENGINE_get_prev(ENGINE *e)
245 ENGINEerr(ENGINE_F_ENGINE_GET_PREV,
246 ERR_R_PASSED_NULL_PARAMETER);
249 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
254 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
258 /* Add another "ENGINE" type into the list. */
259 int ENGINE_add(ENGINE *e)
264 ENGINEerr(ENGINE_F_ENGINE_ADD,
265 ERR_R_PASSED_NULL_PARAMETER);
268 if((e->id == NULL) || (e->name == NULL))
270 ENGINEerr(ENGINE_F_ENGINE_ADD,
271 ENGINE_R_ID_OR_NAME_MISSING);
273 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
274 if(!engine_internal_check() || !engine_list_add(e))
276 ENGINEerr(ENGINE_F_ENGINE_ADD,
277 ENGINE_R_INTERNAL_LIST_ERROR);
280 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
284 /* Remove an existing "ENGINE" type from the array. */
285 int ENGINE_remove(ENGINE *e)
290 ENGINEerr(ENGINE_F_ENGINE_REMOVE,
291 ERR_R_PASSED_NULL_PARAMETER);
294 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
295 if(!engine_internal_check() || !engine_list_remove(e))
297 ENGINEerr(ENGINE_F_ENGINE_REMOVE,
298 ENGINE_R_INTERNAL_LIST_ERROR);
301 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
305 ENGINE *ENGINE_by_id(const char *id)
307 ENGINE *iterator = NULL;
310 ENGINEerr(ENGINE_F_ENGINE_BY_ID,
311 ERR_R_PASSED_NULL_PARAMETER);
314 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
315 if(!engine_internal_check())
316 ENGINEerr(ENGINE_F_ENGINE_BY_ID,
317 ENGINE_R_INTERNAL_LIST_ERROR);
320 iterator = engine_list_head;
321 while(iterator && (strcmp(id, iterator->id) != 0))
322 iterator = iterator->next;
324 /* We need to return a structural reference */
325 iterator->struct_ref++;
327 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
329 ENGINEerr(ENGINE_F_ENGINE_BY_ID,
330 ENGINE_R_NO_SUCH_ENGINE);
334 /* As per the comments in engine.h, it is generally better all round
335 * if the ENGINE structure is allocated within this framework. */
337 int ENGINE_get_struct_size(void)
339 return sizeof(ENGINE);
342 ENGINE *ENGINE_new(ENGINE *e)
348 ret = (ENGINE *)(OPENSSL_malloc(sizeof(ENGINE));
351 ENGINEerr(ENGINE_F_ENGINE_NEW,
352 ERR_R_MALLOC_FAILURE);
358 memset(ret, 0, sizeof(ENGINE));
360 ret->flags = ENGINE_FLAGS_MALLOCED;
365 ENGINE *ENGINE_new(void)
369 ret = (ENGINE *)OPENSSL_malloc(sizeof(ENGINE));
372 ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
375 memset(ret, 0, sizeof(ENGINE));
376 ret->flags = ENGINE_FLAGS_MALLOCED;
382 int ENGINE_free(ENGINE *e)
388 ENGINEerr(ENGINE_F_ENGINE_FREE,
389 ERR_R_PASSED_NULL_PARAMETER);
392 i = CRYPTO_add(&e->struct_ref,-1,CRYPTO_LOCK_ENGINE);
394 REF_PRINT("ENGINE",e);
400 fprintf(stderr,"ENGINE_free, bad reference count\n");
404 if(e->flags & ENGINE_FLAGS_MALLOCED)
409 int ENGINE_set_id(ENGINE *e, const char *id)
411 if((e == NULL) || (id == NULL))
413 ENGINEerr(ENGINE_F_ENGINE_SET_ID,
414 ERR_R_PASSED_NULL_PARAMETER);
421 int ENGINE_set_name(ENGINE *e, const char *name)
423 if((e == NULL) || (name == NULL))
425 ENGINEerr(ENGINE_F_ENGINE_SET_NAME,
426 ERR_R_PASSED_NULL_PARAMETER);
433 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth)
435 if((e == NULL) || (rsa_meth == NULL))
437 ENGINEerr(ENGINE_F_ENGINE_SET_RSA,
438 ERR_R_PASSED_NULL_PARAMETER);
441 e->rsa_meth = rsa_meth;
445 int ENGINE_set_DSA(ENGINE *e, DSA_METHOD *dsa_meth)
447 if((e == NULL) || (dsa_meth == NULL))
449 ENGINEerr(ENGINE_F_ENGINE_SET_DSA,
450 ERR_R_PASSED_NULL_PARAMETER);
453 e->dsa_meth = dsa_meth;
457 int ENGINE_set_DH(ENGINE *e, DH_METHOD *dh_meth)
459 if((e == NULL) || (dh_meth == NULL))
461 ENGINEerr(ENGINE_F_ENGINE_SET_DH,
462 ERR_R_PASSED_NULL_PARAMETER);
465 e->dh_meth = dh_meth;
469 int ENGINE_set_RAND(ENGINE *e, RAND_METHOD *rand_meth)
471 if((e == NULL) || (rand_meth == NULL))
473 ENGINEerr(ENGINE_F_ENGINE_SET_RAND,
474 ERR_R_PASSED_NULL_PARAMETER);
477 e->rand_meth = rand_meth;
481 int ENGINE_set_BN_mod_exp(ENGINE *e, BN_MOD_EXP bn_mod_exp)
483 if((e == NULL) || (bn_mod_exp == NULL))
485 ENGINEerr(ENGINE_F_ENGINE_SET_BN_MOD_EXP,
486 ERR_R_PASSED_NULL_PARAMETER);
489 e->bn_mod_exp = bn_mod_exp;
493 int ENGINE_set_BN_mod_exp_crt(ENGINE *e, BN_MOD_EXP_CRT bn_mod_exp_crt)
495 if((e == NULL) || (bn_mod_exp_crt == NULL))
497 ENGINEerr(ENGINE_F_ENGINE_SET_BN_MOD_EXP_CRT,
498 ERR_R_PASSED_NULL_PARAMETER);
501 e->bn_mod_exp_crt = bn_mod_exp_crt;
505 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
507 if((e == NULL) || (init_f == NULL))
509 ENGINEerr(ENGINE_F_ENGINE_SET_INIT_FUNCTION,
510 ERR_R_PASSED_NULL_PARAMETER);
517 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
519 if((e == NULL) || (finish_f == NULL))
521 ENGINEerr(ENGINE_F_ENGINE_SET_FINISH_FUNCTION,
522 ERR_R_PASSED_NULL_PARAMETER);
525 e->finish = finish_f;
529 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
531 if((e == NULL) || (ctrl_f == NULL))
533 ENGINEerr(ENGINE_F_ENGINE_SET_CTRL_FUNCTION,
534 ERR_R_PASSED_NULL_PARAMETER);
541 const char *ENGINE_get_id(ENGINE *e)
545 ENGINEerr(ENGINE_F_ENGINE_GET_ID,
546 ERR_R_PASSED_NULL_PARAMETER);
552 const char *ENGINE_get_name(ENGINE *e)
556 ENGINEerr(ENGINE_F_ENGINE_GET_NAME,
557 ERR_R_PASSED_NULL_PARAMETER);
563 const RSA_METHOD *ENGINE_get_RSA(ENGINE *e)
567 ENGINEerr(ENGINE_F_ENGINE_GET_RSA,
568 ERR_R_PASSED_NULL_PARAMETER);
574 DSA_METHOD *ENGINE_get_DSA(ENGINE *e)
578 ENGINEerr(ENGINE_F_ENGINE_GET_DSA,
579 ERR_R_PASSED_NULL_PARAMETER);
585 DH_METHOD *ENGINE_get_DH(ENGINE *e)
589 ENGINEerr(ENGINE_F_ENGINE_GET_DH,
590 ERR_R_PASSED_NULL_PARAMETER);
596 RAND_METHOD *ENGINE_get_RAND(ENGINE *e)
600 ENGINEerr(ENGINE_F_ENGINE_GET_RAND,
601 ERR_R_PASSED_NULL_PARAMETER);
607 BN_MOD_EXP ENGINE_get_BN_mod_exp(ENGINE *e)
611 ENGINEerr(ENGINE_F_ENGINE_GET_BN_MOD_EXP,
612 ERR_R_PASSED_NULL_PARAMETER);
615 return e->bn_mod_exp;
618 BN_MOD_EXP_CRT ENGINE_get_BN_mod_exp_crt(ENGINE *e)
622 ENGINEerr(ENGINE_F_ENGINE_GET_BN_MOD_EXP_CRT,
623 ERR_R_PASSED_NULL_PARAMETER);
626 return e->bn_mod_exp_crt;
629 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(ENGINE *e)
633 ENGINEerr(ENGINE_F_ENGINE_GET_INIT_FUNCTION,
634 ERR_R_PASSED_NULL_PARAMETER);
640 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(ENGINE *e)
644 ENGINEerr(ENGINE_F_ENGINE_GET_FINISH_FUNCTION,
645 ERR_R_PASSED_NULL_PARAMETER);
651 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(ENGINE *e)
655 ENGINEerr(ENGINE_F_ENGINE_GET_CTRL_FUNCTION,
656 ERR_R_PASSED_NULL_PARAMETER);