]>
Commit | Line | Data |
---|---|---|
0f113f3e MC |
1 | /* |
2 | * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project | |
3 | * 2000. | |
5270e702 RL |
4 | */ |
5 | /* ==================================================================== | |
2b671586 | 6 | * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved. |
5270e702 RL |
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 | |
0f113f3e | 13 | * notice, this list of conditions and the following disclaimer. |
5270e702 RL |
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 | */ | |
e172d60d BM |
58 | /* ==================================================================== |
59 | * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. | |
0f113f3e | 60 | * ECDH support in OpenSSL originally developed by |
e172d60d BM |
61 | * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project. |
62 | */ | |
5270e702 RL |
63 | |
64 | #ifndef HEADER_ENGINE_INT_H | |
0f113f3e | 65 | # define HEADER_ENGINE_INT_H |
5270e702 | 66 | |
b39fc560 | 67 | # include "internal/cryptlib.h" |
11c0f120 | 68 | /* Take public definitions from engine.h */ |
0f113f3e | 69 | # include <openssl/engine.h> |
11c0f120 | 70 | |
5270e702 RL |
71 | #ifdef __cplusplus |
72 | extern "C" { | |
73 | #endif | |
74 | ||
0f113f3e MC |
75 | /* |
76 | * If we compile with this symbol defined, then both reference counts in the | |
77 | * ENGINE structure will be monitored with a line of output on stderr for | |
78 | * each change. This prints the engine's pointer address (truncated to | |
79 | * unsigned int), "struct" or "funct" to indicate the reference type, the | |
80 | * before and after reference count, and the file:line-number pair. The | |
81 | * "engine_ref_debug" statements must come *after* the change. | |
82 | */ | |
83 | # ifdef ENGINE_REF_COUNT_DEBUG | |
b41f836e | 84 | |
0f113f3e MC |
85 | # define engine_ref_debug(e, isfunct, diff) \ |
86 | fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \ | |
87 | (unsigned int)(e), (isfunct ? "funct" : "struct"), \ | |
88 | ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \ | |
89 | ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \ | |
90 | (__FILE__), (__LINE__)); | |
b41f836e | 91 | |
0f113f3e | 92 | # else |
b41f836e | 93 | |
0f113f3e | 94 | # define engine_ref_debug(e, isfunct, diff) |
b41f836e | 95 | |
0f113f3e | 96 | # endif |
b41f836e | 97 | |
0f113f3e MC |
98 | /* |
99 | * Any code that will need cleanup operations should use these functions to | |
b6d1e52d GT |
100 | * register callbacks. ENGINE_cleanup() will call all registered callbacks in |
101 | * order. NB: both the "add" functions assume CRYPTO_LOCK_ENGINE to already be | |
0f113f3e MC |
102 | * held (in "write" mode). |
103 | */ | |
104 | typedef void (ENGINE_CLEANUP_CB) (void); | |
105 | typedef struct st_engine_cleanup_item { | |
106 | ENGINE_CLEANUP_CB *cb; | |
107 | } ENGINE_CLEANUP_ITEM; | |
85885715 | 108 | DEFINE_STACK_OF(ENGINE_CLEANUP_ITEM) |
b6d1e52d GT |
109 | void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb); |
110 | void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb); | |
111 | ||
112 | /* We need stacks of ENGINEs for use in eng_table.c */ | |
85885715 | 113 | DEFINE_STACK_OF(ENGINE) |
b6d1e52d | 114 | |
0f113f3e MC |
115 | /* |
116 | * If this symbol is defined then engine_table_select(), the function that is | |
117 | * used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults | |
118 | * and functional references (etc), will display debugging summaries to | |
119 | * stderr. | |
120 | */ | |
b6d1e52d GT |
121 | /* #define ENGINE_TABLE_DEBUG */ |
122 | ||
0f113f3e MC |
123 | /* |
124 | * This represents an implementation table. Dependent code should instantiate | |
125 | * it as a (ENGINE_TABLE *) pointer value set initially to NULL. | |
126 | */ | |
b6d1e52d GT |
127 | typedef struct st_engine_table ENGINE_TABLE; |
128 | int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup, | |
0f113f3e MC |
129 | ENGINE *e, const int *nids, int num_nids, |
130 | int setdefault); | |
b6d1e52d GT |
131 | void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e); |
132 | void engine_table_cleanup(ENGINE_TABLE **table); | |
0f113f3e | 133 | # ifndef ENGINE_TABLE_DEBUG |
b6d1e52d | 134 | ENGINE *engine_table_select(ENGINE_TABLE **table, int nid); |
0f113f3e MC |
135 | # else |
136 | ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f, | |
137 | int l); | |
138 | # define engine_table_select(t,n) engine_table_select_tmp(t,n,__FILE__,__LINE__) | |
139 | # endif | |
140 | typedef void (engine_table_doall_cb) (int nid, STACK_OF(ENGINE) *sk, | |
141 | ENGINE *def, void *arg); | |
142 | void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb, | |
143 | void *arg); | |
144 | ||
145 | /* | |
146 | * Internal versions of API functions that have control over locking. These | |
147 | * are used between C files when functionality needs to be shared but the | |
148 | * caller may already be controlling of the CRYPTO_LOCK_ENGINE lock. | |
149 | */ | |
b6d1e52d GT |
150 | int engine_unlocked_init(ENGINE *e); |
151 | int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers); | |
152 | int engine_free_util(ENGINE *e, int locked); | |
354c3ace | 153 | |
0f113f3e MC |
154 | /* |
155 | * This function will reset all "set"able values in an ENGINE to NULL. This | |
156 | * won't touch reference counts or ex_data, but is equivalent to calling all | |
157 | * the ENGINE_set_***() functions with a NULL value. | |
158 | */ | |
e4a6cf42 GT |
159 | void engine_set_all_null(ENGINE *e); |
160 | ||
0f113f3e MC |
161 | /* |
162 | * NB: Bitwise OR-able values for the "flags" variable in ENGINE are now | |
163 | * exposed in engine.h. | |
164 | */ | |
5270e702 | 165 | |
7e5b0681 DSH |
166 | /* Free up dynamically allocated public key methods associated with ENGINE */ |
167 | ||
168 | void engine_pkey_meths_free(ENGINE *e); | |
01b8b3c7 | 169 | void engine_pkey_asn1_meths_free(ENGINE *e); |
7e5b0681 | 170 | |
0f113f3e MC |
171 | /* |
172 | * This is a structure for storing implementations of various crypto | |
173 | * algorithms and functions. | |
174 | */ | |
175 | struct engine_st { | |
176 | const char *id; | |
177 | const char *name; | |
178 | const RSA_METHOD *rsa_meth; | |
179 | const DSA_METHOD *dsa_meth; | |
180 | const DH_METHOD *dh_meth; | |
7d711cbc | 181 | const EC_KEY_METHOD *ec_meth; |
0f113f3e MC |
182 | const RAND_METHOD *rand_meth; |
183 | const STORE_METHOD *store_meth; | |
184 | /* Cipher handling is via this callback */ | |
185 | ENGINE_CIPHERS_PTR ciphers; | |
186 | /* Digest handling is via this callback */ | |
187 | ENGINE_DIGESTS_PTR digests; | |
188 | /* Public key handling via this callback */ | |
189 | ENGINE_PKEY_METHS_PTR pkey_meths; | |
190 | /* ASN1 public key handling via this callback */ | |
191 | ENGINE_PKEY_ASN1_METHS_PTR pkey_asn1_meths; | |
192 | ENGINE_GEN_INT_FUNC_PTR destroy; | |
193 | ENGINE_GEN_INT_FUNC_PTR init; | |
194 | ENGINE_GEN_INT_FUNC_PTR finish; | |
195 | ENGINE_CTRL_FUNC_PTR ctrl; | |
196 | ENGINE_LOAD_KEY_PTR load_privkey; | |
197 | ENGINE_LOAD_KEY_PTR load_pubkey; | |
198 | ENGINE_SSL_CLIENT_CERT_PTR load_ssl_client_cert; | |
199 | const ENGINE_CMD_DEFN *cmd_defns; | |
200 | int flags; | |
201 | /* reference count on the structure itself */ | |
202 | int struct_ref; | |
203 | /* | |
204 | * reference count on usability of the engine type. NB: This controls the | |
205 | * loading and initialisation of any functionlity required by this | |
206 | * engine, whereas the previous count is simply to cope with | |
207 | * (de)allocation of this structure. Hence, running_ref <= struct_ref at | |
208 | * all times. | |
209 | */ | |
210 | int funct_ref; | |
211 | /* A place to store per-ENGINE data */ | |
212 | CRYPTO_EX_DATA ex_data; | |
213 | /* Used to maintain the linked-list of engines. */ | |
214 | struct engine_st *prev; | |
215 | struct engine_st *next; | |
216 | }; | |
5270e702 | 217 | |
e6b5c341 DSH |
218 | typedef struct st_engine_pile ENGINE_PILE; |
219 | ||
89d6aa10 | 220 | DEFINE_LHASH_OF(ENGINE_PILE); |
e6b5c341 | 221 | |
5270e702 RL |
222 | #ifdef __cplusplus |
223 | } | |
224 | #endif | |
225 | ||
0f113f3e | 226 | #endif /* HEADER_ENGINE_INT_H */ |