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