eng_lib.c 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  1. /* crypto/engine/eng_lib.c */
  2. /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
  3. * project 2000.
  4. */
  5. /* ====================================================================
  6. * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. *
  12. * 1. Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. *
  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
  18. * distribution.
  19. *
  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/)"
  24. *
  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.
  29. *
  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.
  33. *
  34. * 6. Redistributions of any form whatsoever must retain the following
  35. * acknowledgment:
  36. * "This product includes software developed by the OpenSSL Project
  37. * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38. *
  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. * ====================================================================
  52. *
  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).
  56. *
  57. */
  58. #include "eng_int.h"
  59. #include <openssl/rand.h>
  60. /* The "new"/"free" stuff first */
  61. ENGINE *ENGINE_new(void)
  62. {
  63. ENGINE *ret;
  64. ret = (ENGINE *)OPENSSL_malloc(sizeof(ENGINE));
  65. if(ret == NULL)
  66. {
  67. ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
  68. return NULL;
  69. }
  70. memset(ret, 0, sizeof(ENGINE));
  71. ret->struct_ref = 1;
  72. engine_ref_debug(ret, 0, 1)
  73. CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);
  74. return ret;
  75. }
  76. /* Placed here (close proximity to ENGINE_new) so that modifications to the
  77. * elements of the ENGINE structure are more likely to be caught and changed
  78. * here. */
  79. void engine_set_all_null(ENGINE *e)
  80. {
  81. e->id = NULL;
  82. e->name = NULL;
  83. e->rsa_meth = NULL;
  84. e->dsa_meth = NULL;
  85. e->dh_meth = NULL;
  86. e->rand_meth = NULL;
  87. e->store_meth = NULL;
  88. e->ciphers = NULL;
  89. e->digests = NULL;
  90. e->destroy = NULL;
  91. e->init = NULL;
  92. e->finish = NULL;
  93. e->ctrl = NULL;
  94. e->load_privkey = NULL;
  95. e->load_pubkey = NULL;
  96. e->cmd_defns = NULL;
  97. e->flags = 0;
  98. }
  99. int engine_free_util(ENGINE *e, int locked)
  100. {
  101. int i;
  102. if(e == NULL)
  103. {
  104. ENGINEerr(ENGINE_F_ENGINE_FREE,
  105. ERR_R_PASSED_NULL_PARAMETER);
  106. return 0;
  107. }
  108. if(locked)
  109. i = CRYPTO_add(&e->struct_ref,-1,CRYPTO_LOCK_ENGINE);
  110. else
  111. i = --e->struct_ref;
  112. engine_ref_debug(e, 0, -1)
  113. if (i > 0) return 1;
  114. #ifdef REF_CHECK
  115. if (i < 0)
  116. {
  117. fprintf(stderr,"ENGINE_free, bad structural reference count\n");
  118. abort();
  119. }
  120. #endif
  121. /* Give the ENGINE a chance to do any structural cleanup corresponding
  122. * to allocation it did in its constructor (eg. unload error strings) */
  123. if(e->destroy)
  124. e->destroy(e);
  125. CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
  126. OPENSSL_free(e);
  127. return 1;
  128. }
  129. int ENGINE_free(ENGINE *e)
  130. {
  131. return engine_free_util(e, 1);
  132. }
  133. /* Cleanup stuff */
  134. /* ENGINE_cleanup() is coded such that anything that does work that will need
  135. * cleanup can register a "cleanup" callback here. That way we don't get linker
  136. * bloat by referring to all *possible* cleanups, but any linker bloat into code
  137. * "X" will cause X's cleanup function to end up here. */
  138. static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
  139. static int int_cleanup_check(int create)
  140. {
  141. if(cleanup_stack) return 1;
  142. if(!create) return 0;
  143. cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
  144. return (cleanup_stack ? 1 : 0);
  145. }
  146. static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
  147. {
  148. ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(
  149. ENGINE_CLEANUP_ITEM));
  150. if(!item) return NULL;
  151. item->cb = cb;
  152. return item;
  153. }
  154. void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
  155. {
  156. ENGINE_CLEANUP_ITEM *item;
  157. if(!int_cleanup_check(1)) return;
  158. item = int_cleanup_item(cb);
  159. if(item)
  160. sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
  161. }
  162. void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
  163. {
  164. ENGINE_CLEANUP_ITEM *item;
  165. if(!int_cleanup_check(1)) return;
  166. item = int_cleanup_item(cb);
  167. if(item)
  168. sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
  169. }
  170. /* The API function that performs all cleanup */
  171. static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
  172. {
  173. (*(item->cb))();
  174. OPENSSL_free(item);
  175. }
  176. void ENGINE_cleanup(void)
  177. {
  178. if(int_cleanup_check(0))
  179. {
  180. sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
  181. engine_cleanup_cb_free);
  182. cleanup_stack = NULL;
  183. }
  184. /* FIXME: This should be handled (somehow) through RAND, eg. by it
  185. * registering a cleanup callback. */
  186. RAND_set_rand_method(NULL);
  187. }
  188. /* Now the "ex_data" support */
  189. int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
  190. CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
  191. {
  192. return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, argl, argp,
  193. new_func, dup_func, free_func);
  194. }
  195. int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
  196. {
  197. return(CRYPTO_set_ex_data(&e->ex_data, idx, arg));
  198. }
  199. void *ENGINE_get_ex_data(const ENGINE *e, int idx)
  200. {
  201. return(CRYPTO_get_ex_data(&e->ex_data, idx));
  202. }
  203. /* Functions to get/set an ENGINE's elements - mainly to avoid exposing the
  204. * ENGINE structure itself. */
  205. int ENGINE_set_id(ENGINE *e, const char *id)
  206. {
  207. if(id == NULL)
  208. {
  209. ENGINEerr(ENGINE_F_ENGINE_SET_ID,
  210. ERR_R_PASSED_NULL_PARAMETER);
  211. return 0;
  212. }
  213. e->id = id;
  214. return 1;
  215. }
  216. int ENGINE_set_name(ENGINE *e, const char *name)
  217. {
  218. if(name == NULL)
  219. {
  220. ENGINEerr(ENGINE_F_ENGINE_SET_NAME,
  221. ERR_R_PASSED_NULL_PARAMETER);
  222. return 0;
  223. }
  224. e->name = name;
  225. return 1;
  226. }
  227. int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
  228. {
  229. e->destroy = destroy_f;
  230. return 1;
  231. }
  232. int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
  233. {
  234. e->init = init_f;
  235. return 1;
  236. }
  237. int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
  238. {
  239. e->finish = finish_f;
  240. return 1;
  241. }
  242. int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
  243. {
  244. e->ctrl = ctrl_f;
  245. return 1;
  246. }
  247. int ENGINE_set_flags(ENGINE *e, int flags)
  248. {
  249. e->flags = flags;
  250. return 1;
  251. }
  252. int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
  253. {
  254. e->cmd_defns = defns;
  255. return 1;
  256. }
  257. const char *ENGINE_get_id(const ENGINE *e)
  258. {
  259. return e->id;
  260. }
  261. const char *ENGINE_get_name(const ENGINE *e)
  262. {
  263. return e->name;
  264. }
  265. ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
  266. {
  267. return e->destroy;
  268. }
  269. ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
  270. {
  271. return e->init;
  272. }
  273. ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
  274. {
  275. return e->finish;
  276. }
  277. ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
  278. {
  279. return e->ctrl;
  280. }
  281. int ENGINE_get_flags(const ENGINE *e)
  282. {
  283. return e->flags;
  284. }
  285. const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
  286. {
  287. return e->cmd_defns;
  288. }
  289. /* eng_lib.o is pretty much linked into anything that touches ENGINE already, so
  290. * put the "static_state" hack here. */
  291. static int internal_static_hack = 0;
  292. void *ENGINE_get_static_state(void)
  293. {
  294. return &internal_static_hack;
  295. }