eng_int.h 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. /* crypto/engine/eng_int.h */
  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. /* ====================================================================
  59. * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  60. * ECDH support in OpenSSL originally developed by
  61. * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
  62. */
  63. #ifndef HEADER_ENGINE_INT_H
  64. #define HEADER_ENGINE_INT_H
  65. #include "cryptlib.h"
  66. /* Take public definitions from engine.h */
  67. #include <openssl/engine.h>
  68. #ifdef __cplusplus
  69. extern "C" {
  70. #endif
  71. /* If we compile with this symbol defined, then both reference counts in the
  72. * ENGINE structure will be monitored with a line of output on stderr for each
  73. * change. This prints the engine's pointer address (truncated to unsigned int),
  74. * "struct" or "funct" to indicate the reference type, the before and after
  75. * reference count, and the file:line-number pair. The "engine_ref_debug"
  76. * statements must come *after* the change. */
  77. #ifdef ENGINE_REF_COUNT_DEBUG
  78. #define engine_ref_debug(e, isfunct, diff) \
  79. fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \
  80. (unsigned int)(e), (isfunct ? "funct" : "struct"), \
  81. ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \
  82. ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \
  83. (__FILE__), (__LINE__));
  84. #else
  85. #define engine_ref_debug(e, isfunct, diff)
  86. #endif
  87. /* Any code that will need cleanup operations should use these functions to
  88. * register callbacks. ENGINE_cleanup() will call all registered callbacks in
  89. * order. NB: both the "add" functions assume CRYPTO_LOCK_ENGINE to already be
  90. * held (in "write" mode). */
  91. typedef void (ENGINE_CLEANUP_CB)(void);
  92. typedef struct st_engine_cleanup_item
  93. {
  94. ENGINE_CLEANUP_CB *cb;
  95. } ENGINE_CLEANUP_ITEM;
  96. DECLARE_STACK_OF(ENGINE_CLEANUP_ITEM)
  97. void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb);
  98. void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb);
  99. /* We need stacks of ENGINEs for use in eng_table.c */
  100. DECLARE_STACK_OF(ENGINE)
  101. /* If this symbol is defined then engine_table_select(), the function that is
  102. * used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults and
  103. * functional references (etc), will display debugging summaries to stderr. */
  104. /* #define ENGINE_TABLE_DEBUG */
  105. /* This represents an implementation table. Dependent code should instantiate it
  106. * as a (ENGINE_TABLE *) pointer value set initially to NULL. */
  107. typedef struct st_engine_table ENGINE_TABLE;
  108. int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
  109. ENGINE *e, const int *nids, int num_nids, int setdefault);
  110. void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e);
  111. void engine_table_cleanup(ENGINE_TABLE **table);
  112. #ifndef ENGINE_TABLE_DEBUG
  113. ENGINE *engine_table_select(ENGINE_TABLE **table, int nid);
  114. #else
  115. ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f, int l);
  116. #define engine_table_select(t,n) engine_table_select_tmp(t,n,__FILE__,__LINE__)
  117. #endif
  118. /* Internal versions of API functions that have control over locking. These are
  119. * used between C files when functionality needs to be shared but the caller may
  120. * already be controlling of the CRYPTO_LOCK_ENGINE lock. */
  121. int engine_unlocked_init(ENGINE *e);
  122. int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers);
  123. int engine_free_util(ENGINE *e, int locked);
  124. /* This function will reset all "set"able values in an ENGINE to NULL. This
  125. * won't touch reference counts or ex_data, but is equivalent to calling all the
  126. * ENGINE_set_***() functions with a NULL value. */
  127. void engine_set_all_null(ENGINE *e);
  128. /* NB: Bitwise OR-able values for the "flags" variable in ENGINE are now exposed
  129. * in engine.h. */
  130. /* This is a structure for storing implementations of various crypto
  131. * algorithms and functions. */
  132. struct engine_st
  133. {
  134. const char *id;
  135. const char *name;
  136. const RSA_METHOD *rsa_meth;
  137. const DSA_METHOD *dsa_meth;
  138. const DH_METHOD *dh_meth;
  139. const ECDH_METHOD *ecdh_meth;
  140. const ECDSA_METHOD *ecdsa_meth;
  141. const RAND_METHOD *rand_meth;
  142. const STORE_METHOD *store_meth;
  143. /* Cipher handling is via this callback */
  144. ENGINE_CIPHERS_PTR ciphers;
  145. /* Digest handling is via this callback */
  146. ENGINE_DIGESTS_PTR digests;
  147. ENGINE_GEN_INT_FUNC_PTR destroy;
  148. ENGINE_GEN_INT_FUNC_PTR init;
  149. ENGINE_GEN_INT_FUNC_PTR finish;
  150. ENGINE_CTRL_FUNC_PTR ctrl;
  151. ENGINE_LOAD_KEY_PTR load_privkey;
  152. ENGINE_LOAD_KEY_PTR load_pubkey;
  153. const ENGINE_CMD_DEFN *cmd_defns;
  154. int flags;
  155. /* reference count on the structure itself */
  156. int struct_ref;
  157. /* reference count on usability of the engine type. NB: This
  158. * controls the loading and initialisation of any functionlity
  159. * required by this engine, whereas the previous count is
  160. * simply to cope with (de)allocation of this structure. Hence,
  161. * running_ref <= struct_ref at all times. */
  162. int funct_ref;
  163. /* A place to store per-ENGINE data */
  164. CRYPTO_EX_DATA ex_data;
  165. /* Used to maintain the linked-list of engines. */
  166. struct engine_st *prev;
  167. struct engine_st *next;
  168. };
  169. #ifdef __cplusplus
  170. }
  171. #endif
  172. #endif /* HEADER_ENGINE_INT_H */