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>
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;
80 static int ENGINE_free_util(ENGINE *e, int locked);
82 /* These static functions starting with a lower case "engine_" always
83 * take place when CRYPTO_LOCK_ENGINE has been locked up. */
84 static int engine_list_add(ENGINE *e)
87 ENGINE *iterator = NULL;
91 ENGINEerr(ENGINE_F_ENGINE_LIST_ADD,
92 ERR_R_PASSED_NULL_PARAMETER);
95 iterator = engine_list_head;
96 while(iterator && !conflict)
98 conflict = (strcmp(iterator->id, e->id) == 0);
99 iterator = iterator->next;
103 ENGINEerr(ENGINE_F_ENGINE_LIST_ADD,
104 ENGINE_R_CONFLICTING_ENGINE_ID);
107 if(engine_list_head == NULL)
109 /* We are adding to an empty list. */
112 ENGINEerr(ENGINE_F_ENGINE_LIST_ADD,
113 ENGINE_R_INTERNAL_LIST_ERROR);
116 engine_list_head = e;
121 /* We are adding to the tail of an existing list. */
122 if((engine_list_tail == NULL) ||
123 (engine_list_tail->next != NULL))
125 ENGINEerr(ENGINE_F_ENGINE_LIST_ADD,
126 ENGINE_R_INTERNAL_LIST_ERROR);
129 engine_list_tail->next = e;
130 e->prev = engine_list_tail;
132 /* Having the engine in the list assumes a structural
135 engine_ref_debug(e, 0, 1)
136 /* However it came to be, e is the last item in the list. */
137 engine_list_tail = e;
142 static int engine_list_remove(ENGINE *e)
148 ENGINEerr(ENGINE_F_ENGINE_LIST_REMOVE,
149 ERR_R_PASSED_NULL_PARAMETER);
152 /* We need to check that e is in our linked list! */
153 iterator = engine_list_head;
154 while(iterator && (iterator != e))
155 iterator = iterator->next;
158 ENGINEerr(ENGINE_F_ENGINE_LIST_REMOVE,
159 ENGINE_R_ENGINE_IS_NOT_IN_LIST);
162 /* un-link e from the chain. */
164 e->next->prev = e->prev;
166 e->prev->next = e->next;
167 /* Correct our head/tail if necessary. */
168 if(engine_list_head == e)
169 engine_list_head = e->next;
170 if(engine_list_tail == e)
171 engine_list_tail = e->prev;
172 ENGINE_free_util(e, 0);
176 /* This check always takes place with CRYPTO_LOCK_ENGINE locked up
177 * so we're synchronised, but we can't call anything that tries to
178 * lock it again! :-) NB: For convenience (and code-clarity) we
179 * don't output errors for failures of the engine_list_add function
180 * as it will generate errors itself. */
181 static int engine_internal_check(void)
184 ENGINE *def_engine1, *def_engine2;
187 /* This is our first time up, we need to populate the list
188 * with our statically compiled-in engines. */
189 def_engine1 = ENGINE_openssl();
190 def_engine2 = ENGINE_dynamic();
191 if(!engine_list_add(def_engine1) ||
192 !engine_list_add(def_engine2))
195 engine_list_flag = 1;
196 ENGINE_free_util(def_engine1, 0);
197 ENGINE_free_util(def_engine2, 0);
201 /* Get the first/last "ENGINE" type available. */
202 ENGINE *ENGINE_get_first(void)
206 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
207 if(engine_internal_check())
209 ret = engine_list_head;
213 engine_ref_debug(ret, 0, 1)
216 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
219 ENGINE *ENGINE_get_last(void)
223 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
224 if(engine_internal_check())
226 ret = engine_list_tail;
230 engine_ref_debug(ret, 0, 1)
233 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
237 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
238 ENGINE *ENGINE_get_next(ENGINE *e)
243 ENGINEerr(ENGINE_F_ENGINE_GET_NEXT,
244 ERR_R_PASSED_NULL_PARAMETER);
247 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
251 /* Return a valid structural refernce to the next ENGINE */
253 engine_ref_debug(ret, 0, 1)
255 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
256 /* Release the structural reference to the previous ENGINE */
260 ENGINE *ENGINE_get_prev(ENGINE *e)
265 ENGINEerr(ENGINE_F_ENGINE_GET_PREV,
266 ERR_R_PASSED_NULL_PARAMETER);
269 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
273 /* Return a valid structural reference to the next ENGINE */
275 engine_ref_debug(ret, 0, 1)
277 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
278 /* Release the structural reference to the previous ENGINE */
283 /* Add another "ENGINE" type into the list. */
284 int ENGINE_add(ENGINE *e)
289 ENGINEerr(ENGINE_F_ENGINE_ADD,
290 ERR_R_PASSED_NULL_PARAMETER);
293 if((e->id == NULL) || (e->name == NULL))
295 ENGINEerr(ENGINE_F_ENGINE_ADD,
296 ENGINE_R_ID_OR_NAME_MISSING);
298 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
299 if(!engine_internal_check() || !engine_list_add(e))
301 ENGINEerr(ENGINE_F_ENGINE_ADD,
302 ENGINE_R_INTERNAL_LIST_ERROR);
305 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
309 /* Remove an existing "ENGINE" type from the array. */
310 int ENGINE_remove(ENGINE *e)
315 ENGINEerr(ENGINE_F_ENGINE_REMOVE,
316 ERR_R_PASSED_NULL_PARAMETER);
319 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
320 if(!engine_internal_check() || !engine_list_remove(e))
322 ENGINEerr(ENGINE_F_ENGINE_REMOVE,
323 ENGINE_R_INTERNAL_LIST_ERROR);
326 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
330 ENGINE *ENGINE_by_id(const char *id)
332 ENGINE *iterator = NULL, *cp = NULL;
335 ENGINEerr(ENGINE_F_ENGINE_BY_ID,
336 ERR_R_PASSED_NULL_PARAMETER);
339 CRYPTO_r_lock(CRYPTO_LOCK_ENGINE);
340 if(!engine_internal_check())
341 ENGINEerr(ENGINE_F_ENGINE_BY_ID,
342 ENGINE_R_INTERNAL_LIST_ERROR);
345 iterator = engine_list_head;
346 while(iterator && (strcmp(id, iterator->id) != 0))
347 iterator = iterator->next;
350 /* We need to return a structural reference. If this is
351 * a "dynamic" ENGINE type, make a duplicate - otherwise
352 * increment the existing ENGINE's reference count. */
353 if(iterator->flags & ENGINE_FLAGS_BY_ID_COPY)
360 ENGINE_cpy(cp, iterator);
366 iterator->struct_ref++;
367 engine_ref_debug(iterator, 0, 1)
371 CRYPTO_r_unlock(CRYPTO_LOCK_ENGINE);
373 ENGINEerr(ENGINE_F_ENGINE_BY_ID,
374 ENGINE_R_NO_SUCH_ENGINE);
378 ENGINE *ENGINE_new(void)
382 ret = (ENGINE *)OPENSSL_malloc(sizeof(ENGINE));
385 ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
388 memset(ret, 0, sizeof(ENGINE));
390 engine_ref_debug(ret, 0, 1)
391 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);
395 static int ENGINE_free_util(ENGINE *e, int locked)
401 ENGINEerr(ENGINE_F_ENGINE_FREE,
402 ERR_R_PASSED_NULL_PARAMETER);
406 i = CRYPTO_add(&e->struct_ref,-1,CRYPTO_LOCK_ENGINE);
409 engine_ref_debug(e, 0, -1)
414 fprintf(stderr,"ENGINE_free, bad structural reference count\n");
418 /* Give the ENGINE a chance to do any structural cleanup corresponding
419 * to allocation it did in its constructor (eg. unload error strings) */
422 sk_ENGINE_EVP_CIPHER_pop_free(e->ciphers,ENGINE_free_engine_cipher);
423 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
428 int ENGINE_free(ENGINE *e)
430 return ENGINE_free_util(e, 1);
433 int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
434 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
436 return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp,
437 new_func, dup_func, free_func);
440 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
442 return(CRYPTO_set_ex_data(&e->ex_data, idx, arg));
445 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
447 return(CRYPTO_get_ex_data(&e->ex_data, idx));
450 void ENGINE_cleanup(void)
452 ENGINE *iterator = engine_list_head;
454 while(iterator != NULL)
456 ENGINE_remove(iterator);
457 iterator = engine_list_head;
459 engine_list_flag = 0;
460 /* Also unset any "default" ENGINEs that may have been set up (a default
461 * constitutes a functional reference on an ENGINE and there's one for
462 * each algorithm). */
463 ENGINE_clear_defaults();
467 int ENGINE_set_id(ENGINE *e, const char *id)
471 ENGINEerr(ENGINE_F_ENGINE_SET_ID,
472 ERR_R_PASSED_NULL_PARAMETER);
479 int ENGINE_set_name(ENGINE *e, const char *name)
483 ENGINEerr(ENGINE_F_ENGINE_SET_NAME,
484 ERR_R_PASSED_NULL_PARAMETER);
491 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth)
493 #ifndef OPENSSL_NO_RSA
494 e->rsa_meth = rsa_meth;
501 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth)
503 #ifndef OPENSSL_NO_DSA
504 e->dsa_meth = dsa_meth;
511 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth)
513 #ifndef OPENSSL_NO_DH
514 e->dh_meth = dh_meth;
521 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth)
523 e->rand_meth = rand_meth;
527 int ENGINE_set_BN_mod_exp(ENGINE *e, BN_MOD_EXP bn_mod_exp)
529 e->bn_mod_exp = bn_mod_exp;
533 int ENGINE_set_BN_mod_exp_crt(ENGINE *e, BN_MOD_EXP_CRT bn_mod_exp_crt)
535 e->bn_mod_exp_crt = bn_mod_exp_crt;
539 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
541 e->destroy = destroy_f;
545 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
551 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
553 e->finish = finish_f;
557 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
563 int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f)
565 e->load_privkey = loadpriv_f;
569 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f)
571 e->load_pubkey = loadpub_f;
575 int ENGINE_set_flags(ENGINE *e, int flags)
581 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
583 e->cmd_defns = defns;
587 int ENGINE_cpy(ENGINE *dest, const ENGINE *src)
589 if(ENGINE_set_id(dest, ENGINE_get_id(src)) &&
590 ENGINE_set_name(dest, ENGINE_get_name(src)) &&
591 #ifndef OPENSSL_NO_RSA
592 ENGINE_set_RSA(dest, ENGINE_get_RSA(src)) &&
594 #ifndef OPENSSL_NO_DSA
595 ENGINE_set_DSA(dest, ENGINE_get_DSA(src)) &&
597 #ifndef OPENSSL_NO_DH
598 ENGINE_set_DH(dest, ENGINE_get_DH(src)) &&
600 ENGINE_set_RAND(dest, ENGINE_get_RAND(src)) &&
601 ENGINE_set_BN_mod_exp(dest,
602 ENGINE_get_BN_mod_exp(src)) &&
603 ENGINE_set_BN_mod_exp_crt(dest,
604 ENGINE_get_BN_mod_exp_crt(src)) &&
605 ENGINE_set_init_function(dest,
606 ENGINE_get_init_function(src)) &&
607 ENGINE_set_finish_function(dest,
608 ENGINE_get_finish_function(src)) &&
609 ENGINE_set_ctrl_function(dest,
610 ENGINE_get_ctrl_function(src)) &&
611 ENGINE_set_load_privkey_function(dest,
612 ENGINE_get_load_privkey_function(src)) &&
613 ENGINE_set_load_pubkey_function(dest,
614 ENGINE_get_load_pubkey_function(src)) &&
615 ENGINE_set_flags(dest, ENGINE_get_flags(src)) &&
616 ENGINE_set_cmd_defns(dest, ENGINE_get_cmd_defns(src)))
621 const char *ENGINE_get_id(const ENGINE *e)
626 const char *ENGINE_get_name(const ENGINE *e)
631 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e)
636 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e)
641 const DH_METHOD *ENGINE_get_DH(const ENGINE *e)
646 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e)
651 BN_MOD_EXP ENGINE_get_BN_mod_exp(const ENGINE *e)
653 return e->bn_mod_exp;
656 BN_MOD_EXP_CRT ENGINE_get_BN_mod_exp_crt(const ENGINE *e)
658 return e->bn_mod_exp_crt;
661 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
666 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
671 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
676 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
681 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e)
683 return e->load_privkey;
686 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e)
688 return e->load_pubkey;
691 int ENGINE_get_flags(const ENGINE *e)
696 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)