eng_int.h 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. /* crypto/engine/eng_int.h */
  2. /*
  3. * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
  4. * 2000.
  5. */
  6. /* ====================================================================
  7. * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
  8. *
  9. * Redistribution and use in source and binary forms, with or without
  10. * modification, are permitted provided that the following conditions
  11. * are met:
  12. *
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions and the following disclaimer.
  15. *
  16. * 2. Redistributions in binary form must reproduce the above copyright
  17. * notice, this list of conditions and the following disclaimer in
  18. * the documentation and/or other materials provided with the
  19. * distribution.
  20. *
  21. * 3. All advertising materials mentioning features or use of this
  22. * software must display the following acknowledgment:
  23. * "This product includes software developed by the OpenSSL Project
  24. * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25. *
  26. * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27. * endorse or promote products derived from this software without
  28. * prior written permission. For written permission, please contact
  29. * licensing@OpenSSL.org.
  30. *
  31. * 5. Products derived from this software may not be called "OpenSSL"
  32. * nor may "OpenSSL" appear in their names without prior written
  33. * permission of the OpenSSL Project.
  34. *
  35. * 6. Redistributions of any form whatsoever must retain the following
  36. * acknowledgment:
  37. * "This product includes software developed by the OpenSSL Project
  38. * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39. *
  40. * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41. * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51. * OF THE POSSIBILITY OF SUCH DAMAGE.
  52. * ====================================================================
  53. *
  54. * This product includes cryptographic software written by Eric Young
  55. * (eay@cryptsoft.com). This product includes software written by Tim
  56. * Hudson (tjh@cryptsoft.com).
  57. *
  58. */
  59. /* ====================================================================
  60. * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  61. * ECDH support in OpenSSL originally developed by
  62. * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
  63. */
  64. #ifndef HEADER_ENGINE_INT_H
  65. # define HEADER_ENGINE_INT_H
  66. # include "cryptlib.h"
  67. /* Take public definitions from engine.h */
  68. # include <openssl/engine.h>
  69. #ifdef __cplusplus
  70. extern "C" {
  71. #endif
  72. /*
  73. * If we compile with this symbol defined, then both reference counts in the
  74. * ENGINE structure will be monitored with a line of output on stderr for
  75. * each change. This prints the engine's pointer address (truncated to
  76. * unsigned int), "struct" or "funct" to indicate the reference type, the
  77. * before and after reference count, and the file:line-number pair. The
  78. * "engine_ref_debug" statements must come *after* the change.
  79. */
  80. # ifdef ENGINE_REF_COUNT_DEBUG
  81. # define engine_ref_debug(e, isfunct, diff) \
  82. fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \
  83. (unsigned int)(e), (isfunct ? "funct" : "struct"), \
  84. ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \
  85. ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \
  86. (__FILE__), (__LINE__));
  87. # else
  88. # define engine_ref_debug(e, isfunct, diff)
  89. # endif
  90. /*
  91. * Any code that will need cleanup operations should use these functions to
  92. * register callbacks. ENGINE_cleanup() will call all registered callbacks in
  93. * order. NB: both the "add" functions assume CRYPTO_LOCK_ENGINE to already be
  94. * held (in "write" mode).
  95. */
  96. typedef void (ENGINE_CLEANUP_CB) (void);
  97. typedef struct st_engine_cleanup_item {
  98. ENGINE_CLEANUP_CB *cb;
  99. } ENGINE_CLEANUP_ITEM;
  100. DECLARE_STACK_OF(ENGINE_CLEANUP_ITEM)
  101. void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb);
  102. void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb);
  103. /* We need stacks of ENGINEs for use in eng_table.c */
  104. DECLARE_STACK_OF(ENGINE)
  105. /*
  106. * If this symbol is defined then engine_table_select(), the function that is
  107. * used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults
  108. * and functional references (etc), will display debugging summaries to
  109. * stderr.
  110. */
  111. /* #define ENGINE_TABLE_DEBUG */
  112. /*
  113. * This represents an implementation table. Dependent code should instantiate
  114. * it as a (ENGINE_TABLE *) pointer value set initially to NULL.
  115. */
  116. typedef struct st_engine_table ENGINE_TABLE;
  117. int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
  118. ENGINE *e, const int *nids, int num_nids,
  119. int setdefault);
  120. void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e);
  121. void engine_table_cleanup(ENGINE_TABLE **table);
  122. # ifndef ENGINE_TABLE_DEBUG
  123. ENGINE *engine_table_select(ENGINE_TABLE **table, int nid);
  124. # else
  125. ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f,
  126. int l);
  127. # define engine_table_select(t,n) engine_table_select_tmp(t,n,__FILE__,__LINE__)
  128. # endif
  129. /*
  130. * Internal versions of API functions that have control over locking. These
  131. * are used between C files when functionality needs to be shared but the
  132. * caller may already be controlling of the CRYPTO_LOCK_ENGINE lock.
  133. */
  134. int engine_unlocked_init(ENGINE *e);
  135. int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers);
  136. int engine_free_util(ENGINE *e, int locked);
  137. /*
  138. * This function will reset all "set"able values in an ENGINE to NULL. This
  139. * won't touch reference counts or ex_data, but is equivalent to calling all
  140. * the ENGINE_set_***() functions with a NULL value.
  141. */
  142. void engine_set_all_null(ENGINE *e);
  143. /*
  144. * NB: Bitwise OR-able values for the "flags" variable in ENGINE are now
  145. * exposed in engine.h.
  146. */
  147. /*
  148. * This is a structure for storing implementations of various crypto
  149. * algorithms and functions.
  150. */
  151. struct engine_st {
  152. const char *id;
  153. const char *name;
  154. const RSA_METHOD *rsa_meth;
  155. const DSA_METHOD *dsa_meth;
  156. const DH_METHOD *dh_meth;
  157. const ECDH_METHOD *ecdh_meth;
  158. const ECDSA_METHOD *ecdsa_meth;
  159. const RAND_METHOD *rand_meth;
  160. const STORE_METHOD *store_meth;
  161. /* Cipher handling is via this callback */
  162. ENGINE_CIPHERS_PTR ciphers;
  163. /* Digest handling is via this callback */
  164. ENGINE_DIGESTS_PTR digests;
  165. ENGINE_GEN_INT_FUNC_PTR destroy;
  166. ENGINE_GEN_INT_FUNC_PTR init;
  167. ENGINE_GEN_INT_FUNC_PTR finish;
  168. ENGINE_CTRL_FUNC_PTR ctrl;
  169. ENGINE_LOAD_KEY_PTR load_privkey;
  170. ENGINE_LOAD_KEY_PTR load_pubkey;
  171. ENGINE_SSL_CLIENT_CERT_PTR load_ssl_client_cert;
  172. const ENGINE_CMD_DEFN *cmd_defns;
  173. int flags;
  174. /* reference count on the structure itself */
  175. int struct_ref;
  176. /*
  177. * reference count on usability of the engine type. NB: This controls the
  178. * loading and initialisation of any functionlity required by this
  179. * engine, whereas the previous count is simply to cope with
  180. * (de)allocation of this structure. Hence, running_ref <= struct_ref at
  181. * all times.
  182. */
  183. int funct_ref;
  184. /* A place to store per-ENGINE data */
  185. CRYPTO_EX_DATA ex_data;
  186. /* Used to maintain the linked-list of engines. */
  187. struct engine_st *prev;
  188. struct engine_st *next;
  189. };
  190. #ifdef __cplusplus
  191. }
  192. #endif
  193. #endif /* HEADER_ENGINE_INT_H */