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