]>
Commit | Line | Data |
---|---|---|
5270e702 RL |
1 | /* openssl/engine.h */ |
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_H | |
60 | #define HEADER_ENGINE_H | |
61 | ||
d66ace9d | 62 | #include <openssl/types.h> |
5270e702 | 63 | #include <openssl/bn.h> |
9e78e6c3 | 64 | #ifndef OPENSSL_NO_RSA |
5270e702 | 65 | #include <openssl/rsa.h> |
9e78e6c3 RL |
66 | #endif |
67 | #ifndef OPENSSL_NO_DSA | |
5270e702 | 68 | #include <openssl/dsa.h> |
9e78e6c3 RL |
69 | #endif |
70 | #ifndef OPENSSL_NO_DH | |
5270e702 | 71 | #include <openssl/dh.h> |
9e78e6c3 | 72 | #endif |
5270e702 | 73 | #include <openssl/rand.h> |
839590f5 | 74 | #include <openssl/ui.h> |
5270e702 | 75 | #include <openssl/symhacks.h> |
9391f977 | 76 | #include <openssl/err.h> |
5270e702 RL |
77 | |
78 | #ifdef __cplusplus | |
79 | extern "C" { | |
80 | #endif | |
81 | ||
9e78e6c3 RL |
82 | /* Fixups for missing algorithms */ |
83 | #ifdef OPENSSL_NO_RSA | |
84 | typedef void RSA_METHOD; | |
85 | #endif | |
86 | #ifdef OPENSSL_NO_DSA | |
87 | typedef void DSA_METHOD; | |
88 | #endif | |
89 | #ifdef OPENSSL_NO_DH | |
90 | typedef void DH_METHOD; | |
91 | #endif | |
92 | ||
5270e702 RL |
93 | /* These flags are used to control combinations of algorithm (methods) |
94 | * by bitwise "OR"ing. */ | |
95 | #define ENGINE_METHOD_RSA (unsigned int)0x0001 | |
96 | #define ENGINE_METHOD_DSA (unsigned int)0x0002 | |
97 | #define ENGINE_METHOD_DH (unsigned int)0x0004 | |
98 | #define ENGINE_METHOD_RAND (unsigned int)0x0008 | |
99 | #define ENGINE_METHOD_BN_MOD_EXP (unsigned int)0x0010 | |
100 | #define ENGINE_METHOD_BN_MOD_EXP_CRT (unsigned int)0x0020 | |
101 | /* Obvious all-or-nothing cases. */ | |
102 | #define ENGINE_METHOD_ALL (unsigned int)0xFFFF | |
103 | #define ENGINE_METHOD_NONE (unsigned int)0x0000 | |
104 | ||
b6d1e52d GT |
105 | /* This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used |
106 | * internally to control registration of ENGINE implementations, and can be set | |
107 | * by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to | |
108 | * initialise registered ENGINEs if they are not already initialised. */ | |
109 | #define ENGINE_TABLE_FLAG_NOINIT (unsigned int)0x0001 | |
110 | ||
dcd87618 GT |
111 | /* ENGINE flags that can be set by ENGINE_set_flags(). */ |
112 | /* #define ENGINE_FLAGS_MALLOCED 0x0001 */ /* Not used */ | |
113 | ||
40fcda29 GT |
114 | /* This flag is for ENGINEs that wish to handle the various 'CMD'-related |
115 | * control commands on their own. Without this flag, ENGINE_ctrl() handles these | |
116 | * control commands on behalf of the ENGINE using their "cmd_defns" data. */ | |
117 | #define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002 | |
118 | ||
0ce5f3e4 GT |
119 | /* This flag is for ENGINEs who return new duplicate structures when found via |
120 | * "ENGINE_by_id()". When an ENGINE must store state (eg. if ENGINE_ctrl() | |
121 | * commands are called in sequence as part of some stateful process like | |
122 | * key-generation setup and execution), it can set this flag - then each attempt | |
123 | * to obtain the ENGINE will result in it being copied into a new structure. | |
124 | * Normally, ENGINEs don't declare this flag so ENGINE_by_id() just increments | |
125 | * the existing ENGINE's structural reference count. */ | |
126 | #define ENGINE_FLAGS_BY_ID_COPY (int)0x0004 | |
127 | ||
40fcda29 GT |
128 | /* ENGINEs can support their own command types, and these flags are used in |
129 | * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input each | |
130 | * command expects. Currently only numeric and string input is supported. If a | |
131 | * control command supports none of the _NUMERIC, _STRING, or _NO_INPUT options, | |
132 | * then it is regarded as an "internal" control command - and not for use in | |
133 | * config setting situations. As such, they're not available to the | |
134 | * ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() access. Changes to | |
135 | * this list of 'command types' should be reflected carefully in | |
136 | * ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). */ | |
137 | ||
138 | /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */ | |
139 | #define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001 | |
140 | /* accepts string input (cast from 'void*' to 'const char *', 4th parameter to | |
141 | * ENGINE_ctrl) */ | |
142 | #define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002 | |
143 | /* Indicates that the control command takes *no* input. Ie. the control command | |
144 | * is unparameterised. */ | |
145 | #define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004 | |
839590f5 RL |
146 | /* Indicates that the control command is internal. This control command won't |
147 | * be shown in any output, and is only usable through the ENGINE_ctrl_cmd() | |
148 | * function. */ | |
149 | #define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008 | |
40fcda29 GT |
150 | |
151 | /* NB: These 3 control commands are deprecated and should not be used. ENGINEs | |
152 | * relying on these commands should compile conditional support for | |
153 | * compatibility (eg. if these symbols are defined) but should also migrate the | |
154 | * same functionality to their own ENGINE-specific control functions that can be | |
155 | * "discovered" by calling applications. The fact these control commands | |
156 | * wouldn't be "executable" (ie. usable by text-based config) doesn't change the | |
157 | * fact that application code can find and use them without requiring per-ENGINE | |
158 | * hacking. */ | |
159 | ||
5270e702 RL |
160 | /* These flags are used to tell the ctrl function what should be done. |
161 | * All command numbers are shared between all engines, even if some don't | |
162 | * make sense to some engines. In such a case, they do nothing but return | |
163 | * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */ | |
164 | #define ENGINE_CTRL_SET_LOGSTREAM 1 | |
165 | #define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2 | |
ef02b10a GT |
166 | #define ENGINE_CTRL_HUP 3 /* Close and reinitialise any |
167 | handles/connections etc. */ | |
839590f5 RL |
168 | #define ENGINE_CTRL_SET_USER_INTERFACE 4 /* Alternative to callback */ |
169 | #define ENGINE_CTRL_SET_CALLBACK_DATA 5 /* User-specific data, used | |
170 | when calling the password | |
171 | callback and the user | |
172 | interface */ | |
ef02b10a | 173 | |
40fcda29 GT |
174 | /* These control commands allow an application to deal with an arbitrary engine |
175 | * in a dynamic way. Warn: Negative return values indicate errors FOR THESE | |
176 | * COMMANDS because zero is used to indicate 'end-of-list'. Other commands, | |
177 | * including ENGINE-specific command types, return zero for an error. | |
178 | * | |
179 | * An ENGINE can choose to implement these ctrl functions, and can internally | |
180 | * manage things however it chooses - it does so by setting the | |
181 | * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise the | |
182 | * ENGINE_ctrl() code handles this on the ENGINE's behalf using the cmd_defns | |
183 | * data (set using ENGINE_set_cmd_defns()). This means an ENGINE's ctrl() | |
184 | * handler need only implement its own commands - the above "meta" commands will | |
185 | * be taken care of. */ | |
186 | ||
187 | /* Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", then | |
188 | * all the remaining control commands will return failure, so it is worth | |
189 | * checking this first if the caller is trying to "discover" the engine's | |
190 | * capabilities and doesn't want errors generated unnecessarily. */ | |
191 | #define ENGINE_CTRL_HAS_CTRL_FUNCTION 10 | |
192 | /* Returns a positive command number for the first command supported by the | |
193 | * engine. Returns zero if no ctrl commands are supported. */ | |
194 | #define ENGINE_CTRL_GET_FIRST_CMD_TYPE 11 | |
195 | /* The 'long' argument specifies a command implemented by the engine, and the | |
196 | * return value is the next command supported, or zero if there are no more. */ | |
197 | #define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12 | |
198 | /* The 'void*' argument is a command name (cast from 'const char *'), and the | |
199 | * return value is the command that corresponds to it. */ | |
200 | #define ENGINE_CTRL_GET_CMD_FROM_NAME 13 | |
201 | /* The next two allow a command to be converted into its corresponding string | |
202 | * form. In each case, the 'long' argument supplies the command. In the NAME_LEN | |
203 | * case, the return value is the length of the command name (not counting a | |
204 | * trailing EOL). In the NAME case, the 'void*' argument must be a string buffer | |
205 | * large enough, and it will be populated with the name of the command (WITH a | |
206 | * trailing EOL). */ | |
207 | #define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14 | |
208 | #define ENGINE_CTRL_GET_NAME_FROM_CMD 15 | |
209 | /* The next two are similar but give a "short description" of a command. */ | |
210 | #define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16 | |
211 | #define ENGINE_CTRL_GET_DESC_FROM_CMD 17 | |
212 | /* With this command, the return value is the OR'd combination of | |
213 | * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given | |
214 | * engine-specific ctrl command expects. */ | |
215 | #define ENGINE_CTRL_GET_CMD_FLAGS 18 | |
216 | ||
217 | /* ENGINE implementations should start the numbering of their own control | |
218 | * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). */ | |
219 | #define ENGINE_CMD_BASE 200 | |
220 | ||
221 | /* NB: These 2 nCipher "chil" control commands are deprecated, and their | |
222 | * functionality is now available through ENGINE-specific control commands | |
223 | * (exposed through the above-mentioned 'CMD'-handling). Code using these 2 | |
224 | * commands should be migrated to the more general command handling before these | |
225 | * are removed. */ | |
226 | ||
5270e702 RL |
227 | /* Flags specific to the nCipher "chil" engine */ |
228 | #define ENGINE_CTRL_CHIL_SET_FORKCHECK 100 | |
229 | /* Depending on the value of the (long)i argument, this sets or | |
230 | * unsets the SimpleForkCheck flag in the CHIL API to enable or | |
231 | * disable checking and workarounds for applications that fork(). | |
232 | */ | |
233 | #define ENGINE_CTRL_CHIL_NO_LOCKING 101 | |
234 | /* This prevents the initialisation function from providing mutex | |
235 | * callbacks to the nCipher library. */ | |
236 | ||
40fcda29 GT |
237 | /* If an ENGINE supports its own specific control commands and wishes the |
238 | * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on its | |
239 | * behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN entries | |
240 | * to ENGINE_set_cmd_defns(). It should also implement a ctrl() handler that | |
241 | * supports the stated commands (ie. the "cmd_num" entries as described by the | |
242 | * array). NB: The array must be ordered in increasing order of cmd_num. | |
243 | * "null-terminated" means that the last ENGINE_CMD_DEFN element has cmd_num set | |
244 | * to zero and/or cmd_name set to NULL. */ | |
245 | typedef struct ENGINE_CMD_DEFN_st | |
246 | { | |
247 | unsigned int cmd_num; /* The command number */ | |
248 | const char *cmd_name; /* The command name itself */ | |
249 | const char *cmd_desc; /* A short description of the command */ | |
250 | unsigned int cmd_flags; /* The input the command expects */ | |
251 | } ENGINE_CMD_DEFN; | |
252 | ||
d54bf145 GT |
253 | /* Generic function pointer */ |
254 | typedef int (*ENGINE_GEN_FUNC_PTR)(); | |
255 | /* Generic function pointer taking no arguments */ | |
404f952a | 256 | typedef int (*ENGINE_GEN_INT_FUNC_PTR)(ENGINE *); |
d54bf145 | 257 | /* Specific control function pointer */ |
404f952a | 258 | typedef int (*ENGINE_CTRL_FUNC_PTR)(ENGINE *, int, long, void *, void (*f)()); |
d54bf145 | 259 | /* Generic load_key function pointer */ |
6c1a3e4f | 260 | typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *, |
839590f5 | 261 | UI_METHOD *ui_method, void *callback_data); |
d54bf145 | 262 | |
40fcda29 GT |
263 | /* STRUCTURE functions ... all of these functions deal with pointers to ENGINE |
264 | * structures where the pointers have a "structural reference". This means that | |
265 | * their reference is to allowed access to the structure but it does not imply | |
266 | * that the structure is functional. To simply increment or decrement the | |
267 | * structural reference count, use ENGINE_by_id and ENGINE_free. NB: This is not | |
268 | * required when iterating using ENGINE_get_next as it will automatically | |
269 | * decrement the structural reference count of the "current" ENGINE and | |
270 | * increment the structural reference count of the ENGINE it returns (unless it | |
271 | * is NULL). */ | |
5270e702 RL |
272 | |
273 | /* Get the first/last "ENGINE" type available. */ | |
274 | ENGINE *ENGINE_get_first(void); | |
275 | ENGINE *ENGINE_get_last(void); | |
276 | /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */ | |
277 | ENGINE *ENGINE_get_next(ENGINE *e); | |
278 | ENGINE *ENGINE_get_prev(ENGINE *e); | |
279 | /* Add another "ENGINE" type into the array. */ | |
280 | int ENGINE_add(ENGINE *e); | |
281 | /* Remove an existing "ENGINE" type from the array. */ | |
282 | int ENGINE_remove(ENGINE *e); | |
283 | /* Retrieve an engine from the list by its unique "id" value. */ | |
284 | ENGINE *ENGINE_by_id(const char *id); | |
b6d1e52d GT |
285 | /* Add all the built-in engines. */ |
286 | void ENGINE_load_openssl(void); | |
287 | void ENGINE_load_dynamic(void); | |
11c0f120 RL |
288 | void ENGINE_load_cswift(void); |
289 | void ENGINE_load_chil(void); | |
290 | void ENGINE_load_atalla(void); | |
291 | void ENGINE_load_nuron(void); | |
016d7d25 | 292 | void ENGINE_load_ubsec(void); |
354c3ace | 293 | void ENGINE_load_openbsd_dev_crypto(void); |
11c0f120 | 294 | void ENGINE_load_builtin_engines(void); |
5270e702 | 295 | |
b6d1e52d GT |
296 | /* Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation |
297 | * "registry" handling. */ | |
298 | unsigned int ENGINE_get_table_flags(void); | |
299 | void ENGINE_set_table_flags(unsigned int flags); | |
300 | ||
301 | /* Manage registration of ENGINEs per "table". For each type, there are 3 | |
302 | * functions; | |
303 | * ENGINE_register_***(e) - registers the implementation from 'e' (if it has one) | |
304 | * ENGINE_unregister_***(e) - unregister the implementation from 'e' | |
305 | * ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list | |
306 | * Cleanup is automatically registered from each table when required, so | |
307 | * ENGINE_cleanup() will reverse any "register" operations. */ | |
308 | ||
309 | int ENGINE_register_RSA(ENGINE *e); | |
310 | void ENGINE_unregister_RSA(ENGINE *e); | |
311 | void ENGINE_register_all_RSA(void); | |
312 | ||
313 | int ENGINE_register_DSA(ENGINE *e); | |
314 | void ENGINE_unregister_DSA(ENGINE *e); | |
315 | void ENGINE_register_all_DSA(void); | |
316 | ||
317 | int ENGINE_register_DH(ENGINE *e); | |
318 | void ENGINE_unregister_DH(ENGINE *e); | |
319 | void ENGINE_register_all_DH(void); | |
320 | ||
321 | int ENGINE_register_RAND(ENGINE *e); | |
322 | void ENGINE_unregister_RAND(ENGINE *e); | |
323 | void ENGINE_register_all_RAND(void); | |
324 | ||
325 | /* These functions register all support from the above categories. Note, use of | |
326 | * these functions can result in static linkage of code your application may not | |
327 | * need. If you only need a subset of functionality, consider using more | |
328 | * selective initialisation. */ | |
329 | int ENGINE_register_complete(ENGINE *e); | |
330 | int ENGINE_register_all_complete(void); | |
354c3ace | 331 | |
40fcda29 GT |
332 | /* Send parametrised control commands to the engine. The possibilities to send |
333 | * down an integer, a pointer to data or a function pointer are provided. Any of | |
334 | * the parameters may or may not be NULL, depending on the command number. In | |
335 | * actuality, this function only requires a structural (rather than functional) | |
336 | * reference to an engine, but many control commands may require the engine be | |
337 | * functional. The caller should be aware of trying commands that require an | |
338 | * operational ENGINE, and only use functional references in such situations. */ | |
339 | int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)()); | |
340 | ||
341 | /* This function tests if an ENGINE-specific command is usable as a "setting". | |
342 | * Eg. in an application's config file that gets processed through | |
343 | * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to | |
344 | * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). */ | |
345 | int ENGINE_cmd_is_executable(ENGINE *e, int cmd); | |
346 | ||
839590f5 RL |
347 | /* This function works like ENGINE_ctrl() with the exception of taking a |
348 | * command name instead of a command number, and can handle optional commands. | |
349 | * See the comment on ENGINE_ctrl_cmd_string() for an explanation on how to | |
350 | * use the cmd_name and cmd_optional. */ | |
351 | int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name, | |
352 | long i, void *p, void (*f)(), int cmd_optional); | |
353 | ||
40fcda29 GT |
354 | /* This function passes a command-name and argument to an ENGINE. The cmd_name |
355 | * is converted to a command number and the control command is called using | |
356 | * 'arg' as an argument (unless the ENGINE doesn't support such a command, in | |
357 | * which case no control command is called). The command is checked for input | |
358 | * flags, and if necessary the argument will be converted to a numeric value. If | |
359 | * cmd_optional is non-zero, then if the ENGINE doesn't support the given | |
360 | * cmd_name the return value will be success anyway. This function is intended | |
361 | * for applications to use so that users (or config files) can supply | |
362 | * engine-specific config data to the ENGINE at run-time to control behaviour of | |
363 | * specific engines. As such, it shouldn't be used for calling ENGINE_ctrl() | |
364 | * functions that return data, deal with binary data, or that are otherwise | |
365 | * supposed to be used directly through ENGINE_ctrl() in application code. Any | |
366 | * "return" data from an ENGINE_ctrl() operation in this function will be lost - | |
367 | * the return value is interpreted as failure if the return value is zero, | |
368 | * success otherwise, and this function returns a boolean value as a result. In | |
369 | * other words, vendors of 'ENGINE'-enabled devices should write ENGINE | |
370 | * implementations with parameterisations that work in this scheme, so that | |
371 | * compliant ENGINE-based applications can work consistently with the same | |
372 | * configuration for the same ENGINE-enabled devices, across applications. */ | |
373 | int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg, | |
374 | int cmd_optional); | |
375 | ||
d54bf145 GT |
376 | /* These functions are useful for manufacturing new ENGINE structures. They |
377 | * don't address reference counting at all - one uses them to populate an ENGINE | |
378 | * structure with personalised implementations of things prior to using it | |
379 | * directly or adding it to the builtin ENGINE list in OpenSSL. These are also | |
380 | * here so that the ENGINE structure doesn't have to be exposed and break binary | |
381 | * compatibility! */ | |
5270e702 | 382 | ENGINE *ENGINE_new(void); |
5270e702 RL |
383 | int ENGINE_free(ENGINE *e); |
384 | int ENGINE_set_id(ENGINE *e, const char *id); | |
385 | int ENGINE_set_name(ENGINE *e, const char *name); | |
10e473e9 | 386 | int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth); |
a4aba800 | 387 | int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth); |
f971ccb2 | 388 | int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth); |
d54bf145 | 389 | int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth); |
f524ddbe | 390 | int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f); |
5270e702 RL |
391 | int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f); |
392 | int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f); | |
393 | int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f); | |
d54bf145 GT |
394 | int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f); |
395 | int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f); | |
396 | int ENGINE_set_flags(ENGINE *e, int flags); | |
40fcda29 | 397 | int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns); |
354c3ace | 398 | int ENGINE_add_cipher(ENGINE *e,const EVP_CIPHER *c); |
0ce5f3e4 GT |
399 | /* These functions (and the "get" function lower down) allow control over any |
400 | * per-structure ENGINE data. */ | |
401 | int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, | |
402 | CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); | |
403 | int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg); | |
b6d1e52d GT |
404 | |
405 | /* This function cleans up anything that needs it. Eg. the ENGINE_add() function | |
406 | * automatically ensures the list cleanup function is registered to be called | |
407 | * from ENGINE_cleanup(). Similarly, all ENGINE_register_*** functions ensure | |
408 | * ENGINE_cleanup() will clean up after them. */ | |
a679116f | 409 | void ENGINE_cleanup(void); |
5270e702 | 410 | |
d54bf145 GT |
411 | /* These return values from within the ENGINE structure. These can be useful |
412 | * with functional references as well as structural references - it depends | |
413 | * which you obtained. Using the result for functional purposes if you only | |
414 | * obtained a structural reference may be problematic! */ | |
415 | const char *ENGINE_get_id(const ENGINE *e); | |
416 | const char *ENGINE_get_name(const ENGINE *e); | |
417 | const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e); | |
418 | const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e); | |
419 | const DH_METHOD *ENGINE_get_DH(const ENGINE *e); | |
420 | const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e); | |
f524ddbe | 421 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e); |
d54bf145 GT |
422 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e); |
423 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e); | |
424 | ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e); | |
425 | ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e); | |
426 | ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e); | |
40fcda29 | 427 | const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e); |
d54bf145 | 428 | int ENGINE_get_flags(const ENGINE *e); |
0ce5f3e4 | 429 | void *ENGINE_get_ex_data(const ENGINE *e, int idx); |
5270e702 RL |
430 | |
431 | /* FUNCTIONAL functions. These functions deal with ENGINE structures | |
432 | * that have (or will) be initialised for use. Broadly speaking, the | |
433 | * structural functions are useful for iterating the list of available | |
434 | * engine types, creating new engine types, and other "list" operations. | |
435 | * These functions actually deal with ENGINEs that are to be used. As | |
436 | * such these functions can fail (if applicable) when particular | |
437 | * engines are unavailable - eg. if a hardware accelerator is not | |
438 | * attached or not functioning correctly. Each ENGINE has 2 reference | |
439 | * counts; structural and functional. Every time a functional reference | |
440 | * is obtained or released, a corresponding structural reference is | |
441 | * automatically obtained or released too. */ | |
442 | ||
443 | /* Initialise a engine type for use (or up its reference count if it's | |
444 | * already in use). This will fail if the engine is not currently | |
445 | * operational and cannot initialise. */ | |
446 | int ENGINE_init(ENGINE *e); | |
447 | /* Free a functional reference to a engine type. This does not require | |
448 | * a corresponding call to ENGINE_free as it also releases a structural | |
449 | * reference. */ | |
450 | int ENGINE_finish(ENGINE *e); | |
5270e702 RL |
451 | |
452 | /* The following functions handle keys that are stored in some secondary | |
453 | * location, handled by the engine. The storage may be on a card or | |
454 | * whatever. */ | |
455 | EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id, | |
839590f5 | 456 | UI_METHOD *ui_method, void *callback_data); |
5270e702 | 457 | EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id, |
839590f5 | 458 | UI_METHOD *ui_method, void *callback_data); |
5270e702 RL |
459 | |
460 | /* This returns a pointer for the current ENGINE structure that | |
461 | * is (by default) performing any RSA operations. The value returned | |
462 | * is an incremented reference, so it should be free'd (ENGINE_finish) | |
463 | * before it is discarded. */ | |
464 | ENGINE *ENGINE_get_default_RSA(void); | |
465 | /* Same for the other "methods" */ | |
466 | ENGINE *ENGINE_get_default_DSA(void); | |
467 | ENGINE *ENGINE_get_default_DH(void); | |
468 | ENGINE *ENGINE_get_default_RAND(void); | |
5270e702 RL |
469 | |
470 | /* This sets a new default ENGINE structure for performing RSA | |
471 | * operations. If the result is non-zero (success) then the ENGINE | |
472 | * structure will have had its reference count up'd so the caller | |
473 | * should still free their own reference 'e'. */ | |
474 | int ENGINE_set_default_RSA(ENGINE *e); | |
475 | /* Same for the other "methods" */ | |
476 | int ENGINE_set_default_DSA(ENGINE *e); | |
477 | int ENGINE_set_default_DH(ENGINE *e); | |
478 | int ENGINE_set_default_RAND(ENGINE *e); | |
5270e702 RL |
479 | |
480 | /* The combination "set" - the flags are bitwise "OR"d from the | |
b6d1e52d GT |
481 | * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()" |
482 | * function, this function can result in unnecessary static linkage. If your | |
483 | * application requires only specific functionality, consider using more | |
484 | * selective functions. */ | |
5270e702 RL |
485 | int ENGINE_set_default(ENGINE *e, unsigned int flags); |
486 | ||
b6d1e52d GT |
487 | /* Deprecated functions ... */ |
488 | /* int ENGINE_clear_defaults(void); */ | |
0e360199 | 489 | |
9391f977 GT |
490 | /**************************/ |
491 | /* DYNAMIC ENGINE SUPPORT */ | |
492 | /**************************/ | |
493 | ||
494 | /* Binary/behaviour compatibility levels */ | |
495 | #define OSSL_DYNAMIC_VERSION (unsigned long)0x00010100 | |
496 | /* Binary versions older than this are too old for us (whether we're a loader or | |
497 | * a loadee) */ | |
498 | #define OSSL_DYNAMIC_OLDEST (unsigned long)0x00010100 | |
499 | ||
500 | /* When compiling an ENGINE entirely as an external shared library, loadable by | |
501 | * the "dynamic" ENGINE, these types are needed. The 'dynamic_fns' structure | |
502 | * type provides the calling application's (or library's) error functionality | |
503 | * and memory management function pointers to the loaded library. These should | |
504 | * be used/set in the loaded library code so that the loading application's | |
505 | * 'state' will be used/changed in all operations. */ | |
e5e6a94f GT |
506 | typedef void *(*dyn_MEM_malloc_cb)(size_t); |
507 | typedef void *(*dyn_MEM_realloc_cb)(void *, size_t); | |
508 | typedef void (*dyn_MEM_free_cb)(void *); | |
9391f977 | 509 | typedef struct st_dynamic_MEM_fns { |
e5e6a94f GT |
510 | dyn_MEM_malloc_cb malloc_cb; |
511 | dyn_MEM_realloc_cb realloc_cb; | |
512 | dyn_MEM_free_cb free_cb; | |
9391f977 | 513 | } dynamic_MEM_fns; |
e5e6a94f GT |
514 | /* FIXME: Perhaps the memory and locking code (crypto.h) should declare and use |
515 | * these types so we (and any other dependant code) can simplify a bit?? */ | |
516 | typedef void (*dyn_lock_locking_cb)(int,int,const char *,int); | |
517 | typedef int (*dyn_lock_add_lock_cb)(int*,int,int,const char *,int); | |
518 | typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb)( | |
519 | const char *,int); | |
520 | typedef void (*dyn_dynlock_lock_cb)(int,struct CRYPTO_dynlock_value *, | |
521 | const char *,int); | |
522 | typedef void (*dyn_dynlock_destroy_cb)(struct CRYPTO_dynlock_value *, | |
523 | const char *,int); | |
524 | typedef struct st_dynamic_LOCK_fns { | |
525 | dyn_lock_locking_cb lock_locking_cb; | |
526 | dyn_lock_add_lock_cb lock_add_lock_cb; | |
527 | dyn_dynlock_create_cb dynlock_create_cb; | |
528 | dyn_dynlock_lock_cb dynlock_lock_cb; | |
529 | dyn_dynlock_destroy_cb dynlock_destroy_cb; | |
530 | } dynamic_LOCK_fns; | |
531 | /* The top-level structure */ | |
9391f977 GT |
532 | typedef struct st_dynamic_fns { |
533 | const ERR_FNS *err_fns; | |
534 | const CRYPTO_EX_DATA_IMPL *ex_data_fns; | |
535 | dynamic_MEM_fns mem_fns; | |
e5e6a94f | 536 | dynamic_LOCK_fns lock_fns; |
9391f977 GT |
537 | } dynamic_fns; |
538 | ||
539 | /* The version checking function should be of this prototype. NB: The | |
540 | * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading code. | |
541 | * If this function returns zero, it indicates a (potential) version | |
542 | * incompatibility and the loaded library doesn't believe it can proceed. | |
543 | * Otherwise, the returned value is the (latest) version supported by the | |
544 | * loading library. The loader may still decide that the loaded code's version | |
545 | * is unsatisfactory and could veto the load. The function is expected to | |
546 | * be implemented with the symbol name "v_check", and a default implementation | |
547 | * can be fully instantiated with IMPLEMENT_DYNAMIC_CHECK_FN(). */ | |
548 | typedef unsigned long (*dynamic_v_check_fn)(unsigned long ossl_version); | |
549 | #define IMPLEMENT_DYNAMIC_CHECK_FN() \ | |
550 | unsigned long v_check(unsigned long v) { \ | |
551 | if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \ | |
552 | return 0; } | |
553 | ||
554 | /* This function is passed the ENGINE structure to initialise with its own | |
555 | * function and command settings. It should not adjust the structural or | |
556 | * functional reference counts. If this function returns zero, (a) the load will | |
557 | * be aborted, (b) the previous ENGINE state will be memcpy'd back onto the | |
558 | * structure, and (c) the shared library will be unloaded. So implementations | |
559 | * should do their own internal cleanup in failure circumstances otherwise they | |
560 | * could leak. The 'id' parameter, if non-NULL, represents the ENGINE id that | |
561 | * the loader is looking for. If this is NULL, the shared library can choose to | |
562 | * return failure or to initialise a 'default' ENGINE. If non-NULL, the shared | |
563 | * library must initialise only an ENGINE matching the passed 'id'. The function | |
564 | * is expected to be implemented with the symbol name "bind_engine". A standard | |
565 | * implementation can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where | |
566 | * the parameter 'fn' is a callback function that populates the ENGINE structure | |
567 | * and returns an int value (zero for failure). 'fn' should have prototype; | |
568 | * [static] int fn(ENGINE *e, const char *id); */ | |
569 | typedef int (*dynamic_bind_engine)(ENGINE *e, const char *id, | |
570 | const dynamic_fns *fns); | |
571 | #define IMPLEMENT_DYNAMIC_BIND_FN(fn) \ | |
572 | int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \ | |
573 | if(!CRYPTO_set_mem_functions(fns->mem_fns.malloc_cb, \ | |
574 | fns->mem_fns.realloc_cb, fns->mem_fns.free_cb)) \ | |
575 | return 0; \ | |
e5e6a94f GT |
576 | CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \ |
577 | CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \ | |
578 | CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \ | |
579 | CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \ | |
580 | CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \ | |
9391f977 GT |
581 | if(!CRYPTO_set_ex_data_implementation(fns->ex_data_fns)) \ |
582 | return 0; \ | |
583 | if(!ERR_set_implementation(fns->err_fns)) return 0; \ | |
584 | if(!fn(e,id)) return 0; \ | |
585 | return 1; } | |
354c3ace | 586 | |
5270e702 RL |
587 | /* BEGIN ERROR CODES */ |
588 | /* The following lines are auto generated by the script mkerr.pl. Any changes | |
589 | * made after this point may be overwritten when the script is next run. | |
590 | */ | |
40fcda29 | 591 | void ERR_load_ENGINE_strings(void); |
5270e702 RL |
592 | |
593 | /* Error codes for the ENGINE functions. */ | |
594 | ||
595 | /* Function codes. */ | |
9391f977 GT |
596 | #define ENGINE_F_DYNAMIC_CTRL 180 |
597 | #define ENGINE_F_DYNAMIC_GET_DATA_CTX 181 | |
598 | #define ENGINE_F_DYNAMIC_LOAD 182 | |
5270e702 RL |
599 | #define ENGINE_F_ENGINE_ADD 105 |
600 | #define ENGINE_F_ENGINE_BY_ID 106 | |
40fcda29 | 601 | #define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE 170 |
5270e702 | 602 | #define ENGINE_F_ENGINE_CTRL 142 |
839590f5 | 603 | #define ENGINE_F_ENGINE_CTRL_CMD 178 |
40fcda29 | 604 | #define ENGINE_F_ENGINE_CTRL_CMD_STRING 171 |
5270e702 RL |
605 | #define ENGINE_F_ENGINE_FINISH 107 |
606 | #define ENGINE_F_ENGINE_FREE 108 | |
9e78e6c3 | 607 | #define ENGINE_F_ENGINE_GET_DEFAULT_TYPE 177 |
5270e702 RL |
608 | #define ENGINE_F_ENGINE_GET_NEXT 115 |
609 | #define ENGINE_F_ENGINE_GET_PREV 116 | |
5270e702 RL |
610 | #define ENGINE_F_ENGINE_INIT 119 |
611 | #define ENGINE_F_ENGINE_LIST_ADD 120 | |
612 | #define ENGINE_F_ENGINE_LIST_REMOVE 121 | |
613 | #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150 | |
614 | #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151 | |
615 | #define ENGINE_F_ENGINE_NEW 122 | |
616 | #define ENGINE_F_ENGINE_REMOVE 123 | |
5270e702 | 617 | #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE 126 |
5270e702 | 618 | #define ENGINE_F_ENGINE_SET_ID 129 |
5270e702 | 619 | #define ENGINE_F_ENGINE_SET_NAME 130 |
b6d1e52d | 620 | #define ENGINE_F_ENGINE_TABLE_REGISTER 184 |
5270e702 | 621 | #define ENGINE_F_ENGINE_UNLOAD_KEY 152 |
40fcda29 | 622 | #define ENGINE_F_INT_CTRL_HELPER 172 |
5270e702 | 623 | #define ENGINE_F_LOG_MESSAGE 141 |
9391f977 | 624 | #define ENGINE_F_SET_DATA_CTX 183 |
5270e702 RL |
625 | |
626 | /* Reason codes. */ | |
627 | #define ENGINE_R_ALREADY_LOADED 100 | |
40fcda29 | 628 | #define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER 133 |
5270e702 RL |
629 | #define ENGINE_R_BIO_WAS_FREED 121 |
630 | #define ENGINE_R_BN_CTX_FULL 101 | |
631 | #define ENGINE_R_BN_EXPAND_FAIL 102 | |
632 | #define ENGINE_R_CHIL_ERROR 123 | |
40fcda29 GT |
633 | #define ENGINE_R_CMD_NOT_EXECUTABLE 134 |
634 | #define ENGINE_R_COMMAND_TAKES_INPUT 135 | |
635 | #define ENGINE_R_COMMAND_TAKES_NO_INPUT 136 | |
5270e702 RL |
636 | #define ENGINE_R_CONFLICTING_ENGINE_ID 103 |
637 | #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119 | |
9e78e6c3 RL |
638 | #define ENGINE_R_DH_NOT_IMPLEMENTED 139 |
639 | #define ENGINE_R_DSA_NOT_IMPLEMENTED 140 | |
5270e702 RL |
640 | #define ENGINE_R_DSO_FAILURE 104 |
641 | #define ENGINE_R_DSO_FUNCTION_NOT_FOUND 131 | |
642 | #define ENGINE_R_DSO_NOT_FOUND 132 | |
643 | #define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105 | |
644 | #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128 | |
645 | #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129 | |
646 | #define ENGINE_R_FINISH_FAILED 106 | |
647 | #define ENGINE_R_GET_HANDLE_FAILED 107 | |
648 | #define ENGINE_R_ID_OR_NAME_MISSING 108 | |
649 | #define ENGINE_R_INIT_FAILED 109 | |
650 | #define ENGINE_R_INTERNAL_LIST_ERROR 110 | |
9391f977 | 651 | #define ENGINE_R_INVALID_ARGUMENT 143 |
40fcda29 GT |
652 | #define ENGINE_R_INVALID_CMD_NAME 137 |
653 | #define ENGINE_R_INVALID_CMD_NUMBER 138 | |
5270e702 RL |
654 | #define ENGINE_R_MISSING_KEY_COMPONENTS 111 |
655 | #define ENGINE_R_NOT_INITIALISED 117 | |
656 | #define ENGINE_R_NOT_LOADED 112 | |
657 | #define ENGINE_R_NO_CALLBACK 127 | |
658 | #define ENGINE_R_NO_CONTROL_FUNCTION 120 | |
9391f977 | 659 | #define ENGINE_R_NO_INDEX 144 |
5270e702 RL |
660 | #define ENGINE_R_NO_KEY 124 |
661 | #define ENGINE_R_NO_LOAD_FUNCTION 125 | |
662 | #define ENGINE_R_NO_REFERENCE 130 | |
663 | #define ENGINE_R_NO_SUCH_ENGINE 116 | |
664 | #define ENGINE_R_NO_UNLOAD_FUNCTION 126 | |
9e78e6c3 | 665 | #define ENGINE_R_PRIVATE_KEY_ALGORITHMS_DISABLED 142 |
5270e702 RL |
666 | #define ENGINE_R_PROVIDE_PARAMETERS 113 |
667 | #define ENGINE_R_REQUEST_FAILED 114 | |
668 | #define ENGINE_R_REQUEST_FALLBACK 118 | |
9e78e6c3 | 669 | #define ENGINE_R_RSA_NOT_IMPLEMENTED 141 |
5270e702 RL |
670 | #define ENGINE_R_SIZE_TOO_LARGE_OR_TOO_SMALL 122 |
671 | #define ENGINE_R_UNIT_FAILURE 115 | |
9391f977 | 672 | #define ENGINE_R_VERSION_INCOMPATIBILITY 145 |
5270e702 RL |
673 | |
674 | #ifdef __cplusplus | |
675 | } | |
676 | #endif | |
677 | #endif |