]>
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 | /* ==================================================================== | |
3a87a9b9 | 6 | * Copyright (c) 1999-2004 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 | */ | |
e172d60d BM |
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 | */ | |
5270e702 RL |
63 | |
64 | #ifndef HEADER_ENGINE_H | |
65 | #define HEADER_ENGINE_H | |
66 | ||
db199abd | 67 | #include <openssl/opensslconf.h> |
0b13e9f0 RL |
68 | |
69 | #ifdef OPENSSL_NO_ENGINE | |
70 | #error ENGINE is disabled. | |
71 | #endif | |
72 | ||
3a87a9b9 | 73 | #ifndef OPENSSL_NO_DEPRECATED |
5270e702 | 74 | #include <openssl/bn.h> |
9e78e6c3 | 75 | #ifndef OPENSSL_NO_RSA |
5270e702 | 76 | #include <openssl/rsa.h> |
9e78e6c3 RL |
77 | #endif |
78 | #ifndef OPENSSL_NO_DSA | |
5270e702 | 79 | #include <openssl/dsa.h> |
9e78e6c3 RL |
80 | #endif |
81 | #ifndef OPENSSL_NO_DH | |
5270e702 | 82 | #include <openssl/dh.h> |
9e78e6c3 | 83 | #endif |
e172d60d BM |
84 | #ifndef OPENSSL_NO_ECDH |
85 | #include <openssl/ecdh.h> | |
86 | #endif | |
4d94ae00 BM |
87 | #ifndef OPENSSL_NO_ECDSA |
88 | #include <openssl/ecdsa.h> | |
89 | #endif | |
5270e702 | 90 | #include <openssl/rand.h> |
839590f5 | 91 | #include <openssl/ui.h> |
9391f977 | 92 | #include <openssl/err.h> |
3a87a9b9 GT |
93 | #endif |
94 | ||
95 | #include <openssl/ossl_typ.h> | |
96 | #include <openssl/symhacks.h> | |
5270e702 | 97 | |
5ce278a7 BL |
98 | #include <openssl/x509.h> |
99 | ||
5270e702 RL |
100 | #ifdef __cplusplus |
101 | extern "C" { | |
102 | #endif | |
103 | ||
104 | /* These flags are used to control combinations of algorithm (methods) | |
105 | * by bitwise "OR"ing. */ | |
106 | #define ENGINE_METHOD_RSA (unsigned int)0x0001 | |
107 | #define ENGINE_METHOD_DSA (unsigned int)0x0002 | |
108 | #define ENGINE_METHOD_DH (unsigned int)0x0004 | |
109 | #define ENGINE_METHOD_RAND (unsigned int)0x0008 | |
e172d60d BM |
110 | #define ENGINE_METHOD_ECDH (unsigned int)0x0010 |
111 | #define ENGINE_METHOD_ECDSA (unsigned int)0x0020 | |
b370230b GT |
112 | #define ENGINE_METHOD_CIPHERS (unsigned int)0x0040 |
113 | #define ENGINE_METHOD_DIGESTS (unsigned int)0x0080 | |
3bbb0212 | 114 | #define ENGINE_METHOD_STORE (unsigned int)0x0100 |
1892c8bf | 115 | #define ENGINE_METHOD_PKEY_METHS (unsigned int)0x0200 |
01b8b3c7 | 116 | #define ENGINE_METHOD_PKEY_ASN1_METHS (unsigned int)0x0400 |
5270e702 RL |
117 | /* Obvious all-or-nothing cases. */ |
118 | #define ENGINE_METHOD_ALL (unsigned int)0xFFFF | |
119 | #define ENGINE_METHOD_NONE (unsigned int)0x0000 | |
120 | ||
b6d1e52d GT |
121 | /* This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used |
122 | * internally to control registration of ENGINE implementations, and can be set | |
123 | * by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to | |
124 | * initialise registered ENGINEs if they are not already initialised. */ | |
125 | #define ENGINE_TABLE_FLAG_NOINIT (unsigned int)0x0001 | |
126 | ||
dcd87618 GT |
127 | /* ENGINE flags that can be set by ENGINE_set_flags(). */ |
128 | /* #define ENGINE_FLAGS_MALLOCED 0x0001 */ /* Not used */ | |
129 | ||
40fcda29 GT |
130 | /* This flag is for ENGINEs that wish to handle the various 'CMD'-related |
131 | * control commands on their own. Without this flag, ENGINE_ctrl() handles these | |
132 | * control commands on behalf of the ENGINE using their "cmd_defns" data. */ | |
133 | #define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002 | |
134 | ||
0ce5f3e4 GT |
135 | /* This flag is for ENGINEs who return new duplicate structures when found via |
136 | * "ENGINE_by_id()". When an ENGINE must store state (eg. if ENGINE_ctrl() | |
137 | * commands are called in sequence as part of some stateful process like | |
138 | * key-generation setup and execution), it can set this flag - then each attempt | |
139 | * to obtain the ENGINE will result in it being copied into a new structure. | |
140 | * Normally, ENGINEs don't declare this flag so ENGINE_by_id() just increments | |
141 | * the existing ENGINE's structural reference count. */ | |
142 | #define ENGINE_FLAGS_BY_ID_COPY (int)0x0004 | |
143 | ||
40fcda29 GT |
144 | /* ENGINEs can support their own command types, and these flags are used in |
145 | * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input each | |
146 | * command expects. Currently only numeric and string input is supported. If a | |
147 | * control command supports none of the _NUMERIC, _STRING, or _NO_INPUT options, | |
148 | * then it is regarded as an "internal" control command - and not for use in | |
149 | * config setting situations. As such, they're not available to the | |
150 | * ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() access. Changes to | |
151 | * this list of 'command types' should be reflected carefully in | |
152 | * ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). */ | |
153 | ||
154 | /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */ | |
155 | #define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001 | |
156 | /* accepts string input (cast from 'void*' to 'const char *', 4th parameter to | |
157 | * ENGINE_ctrl) */ | |
158 | #define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002 | |
159 | /* Indicates that the control command takes *no* input. Ie. the control command | |
160 | * is unparameterised. */ | |
161 | #define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004 | |
839590f5 RL |
162 | /* Indicates that the control command is internal. This control command won't |
163 | * be shown in any output, and is only usable through the ENGINE_ctrl_cmd() | |
164 | * function. */ | |
165 | #define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008 | |
40fcda29 GT |
166 | |
167 | /* NB: These 3 control commands are deprecated and should not be used. ENGINEs | |
168 | * relying on these commands should compile conditional support for | |
169 | * compatibility (eg. if these symbols are defined) but should also migrate the | |
170 | * same functionality to their own ENGINE-specific control functions that can be | |
171 | * "discovered" by calling applications. The fact these control commands | |
172 | * wouldn't be "executable" (ie. usable by text-based config) doesn't change the | |
173 | * fact that application code can find and use them without requiring per-ENGINE | |
174 | * hacking. */ | |
175 | ||
5270e702 RL |
176 | /* These flags are used to tell the ctrl function what should be done. |
177 | * All command numbers are shared between all engines, even if some don't | |
178 | * make sense to some engines. In such a case, they do nothing but return | |
179 | * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */ | |
180 | #define ENGINE_CTRL_SET_LOGSTREAM 1 | |
181 | #define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2 | |
ef02b10a GT |
182 | #define ENGINE_CTRL_HUP 3 /* Close and reinitialise any |
183 | handles/connections etc. */ | |
839590f5 RL |
184 | #define ENGINE_CTRL_SET_USER_INTERFACE 4 /* Alternative to callback */ |
185 | #define ENGINE_CTRL_SET_CALLBACK_DATA 5 /* User-specific data, used | |
3bbb0212 RL |
186 | when calling the password |
187 | callback and the user | |
188 | interface */ | |
189 | #define ENGINE_CTRL_LOAD_CONFIGURATION 6 /* Load a configuration, given | |
190 | a string that represents a | |
191 | file name or so */ | |
192 | #define ENGINE_CTRL_LOAD_SECTION 7 /* Load data from a given | |
193 | section in the already loaded | |
194 | configuration */ | |
ef02b10a | 195 | |
40fcda29 GT |
196 | /* These control commands allow an application to deal with an arbitrary engine |
197 | * in a dynamic way. Warn: Negative return values indicate errors FOR THESE | |
198 | * COMMANDS because zero is used to indicate 'end-of-list'. Other commands, | |
199 | * including ENGINE-specific command types, return zero for an error. | |
200 | * | |
201 | * An ENGINE can choose to implement these ctrl functions, and can internally | |
202 | * manage things however it chooses - it does so by setting the | |
203 | * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise the | |
204 | * ENGINE_ctrl() code handles this on the ENGINE's behalf using the cmd_defns | |
205 | * data (set using ENGINE_set_cmd_defns()). This means an ENGINE's ctrl() | |
206 | * handler need only implement its own commands - the above "meta" commands will | |
207 | * be taken care of. */ | |
208 | ||
209 | /* Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", then | |
210 | * all the remaining control commands will return failure, so it is worth | |
211 | * checking this first if the caller is trying to "discover" the engine's | |
212 | * capabilities and doesn't want errors generated unnecessarily. */ | |
213 | #define ENGINE_CTRL_HAS_CTRL_FUNCTION 10 | |
214 | /* Returns a positive command number for the first command supported by the | |
215 | * engine. Returns zero if no ctrl commands are supported. */ | |
216 | #define ENGINE_CTRL_GET_FIRST_CMD_TYPE 11 | |
217 | /* The 'long' argument specifies a command implemented by the engine, and the | |
218 | * return value is the next command supported, or zero if there are no more. */ | |
219 | #define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12 | |
220 | /* The 'void*' argument is a command name (cast from 'const char *'), and the | |
221 | * return value is the command that corresponds to it. */ | |
222 | #define ENGINE_CTRL_GET_CMD_FROM_NAME 13 | |
223 | /* The next two allow a command to be converted into its corresponding string | |
224 | * form. In each case, the 'long' argument supplies the command. In the NAME_LEN | |
225 | * case, the return value is the length of the command name (not counting a | |
226 | * trailing EOL). In the NAME case, the 'void*' argument must be a string buffer | |
227 | * large enough, and it will be populated with the name of the command (WITH a | |
228 | * trailing EOL). */ | |
229 | #define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14 | |
230 | #define ENGINE_CTRL_GET_NAME_FROM_CMD 15 | |
231 | /* The next two are similar but give a "short description" of a command. */ | |
232 | #define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16 | |
233 | #define ENGINE_CTRL_GET_DESC_FROM_CMD 17 | |
234 | /* With this command, the return value is the OR'd combination of | |
235 | * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given | |
236 | * engine-specific ctrl command expects. */ | |
237 | #define ENGINE_CTRL_GET_CMD_FLAGS 18 | |
238 | ||
239 | /* ENGINE implementations should start the numbering of their own control | |
240 | * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). */ | |
3bbb0212 | 241 | #define ENGINE_CMD_BASE 200 |
40fcda29 GT |
242 | |
243 | /* NB: These 2 nCipher "chil" control commands are deprecated, and their | |
244 | * functionality is now available through ENGINE-specific control commands | |
245 | * (exposed through the above-mentioned 'CMD'-handling). Code using these 2 | |
246 | * commands should be migrated to the more general command handling before these | |
247 | * are removed. */ | |
248 | ||
5270e702 RL |
249 | /* Flags specific to the nCipher "chil" engine */ |
250 | #define ENGINE_CTRL_CHIL_SET_FORKCHECK 100 | |
251 | /* Depending on the value of the (long)i argument, this sets or | |
252 | * unsets the SimpleForkCheck flag in the CHIL API to enable or | |
253 | * disable checking and workarounds for applications that fork(). | |
254 | */ | |
255 | #define ENGINE_CTRL_CHIL_NO_LOCKING 101 | |
256 | /* This prevents the initialisation function from providing mutex | |
257 | * callbacks to the nCipher library. */ | |
258 | ||
40fcda29 GT |
259 | /* If an ENGINE supports its own specific control commands and wishes the |
260 | * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on its | |
261 | * behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN entries | |
262 | * to ENGINE_set_cmd_defns(). It should also implement a ctrl() handler that | |
263 | * supports the stated commands (ie. the "cmd_num" entries as described by the | |
264 | * array). NB: The array must be ordered in increasing order of cmd_num. | |
265 | * "null-terminated" means that the last ENGINE_CMD_DEFN element has cmd_num set | |
266 | * to zero and/or cmd_name set to NULL. */ | |
267 | typedef struct ENGINE_CMD_DEFN_st | |
268 | { | |
269 | unsigned int cmd_num; /* The command number */ | |
270 | const char *cmd_name; /* The command name itself */ | |
271 | const char *cmd_desc; /* A short description of the command */ | |
272 | unsigned int cmd_flags; /* The input the command expects */ | |
273 | } ENGINE_CMD_DEFN; | |
274 | ||
d54bf145 | 275 | /* Generic function pointer */ |
b653327d | 276 | typedef int (*ENGINE_GEN_FUNC_PTR)(void); |
d54bf145 | 277 | /* Generic function pointer taking no arguments */ |
404f952a | 278 | typedef int (*ENGINE_GEN_INT_FUNC_PTR)(ENGINE *); |
d54bf145 | 279 | /* Specific control function pointer */ |
b653327d | 280 | typedef int (*ENGINE_CTRL_FUNC_PTR)(ENGINE *, int, long, void *, void (*f)(void)); |
d54bf145 | 281 | /* Generic load_key function pointer */ |
6c1a3e4f | 282 | typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *, |
839590f5 | 283 | UI_METHOD *ui_method, void *callback_data); |
05935c47 DSH |
284 | typedef int (*ENGINE_SSL_CLIENT_CERT_PTR)(ENGINE *, SSL *ssl, |
285 | STACK_OF(X509_NAME) *ca_dn, X509 **pcert, EVP_PKEY **pkey, | |
3fc59c84 | 286 | STACK_OF(X509) **pother, UI_METHOD *ui_method, void *callback_data); |
b370230b GT |
287 | /* These callback types are for an ENGINE's handler for cipher and digest logic. |
288 | * These handlers have these prototypes; | |
289 | * int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid); | |
290 | * int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid); | |
291 | * Looking at how to implement these handlers in the case of cipher support, if | |
292 | * the framework wants the EVP_CIPHER for 'nid', it will call; | |
293 | * foo(e, &p_evp_cipher, NULL, nid); (return zero for failure) | |
294 | * If the framework wants a list of supported 'nid's, it will call; | |
295 | * foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error) | |
296 | */ | |
297 | /* Returns to a pointer to the array of supported cipher 'nid's. If the second | |
298 | * parameter is non-NULL it is set to the size of the returned array. */ | |
299 | typedef int (*ENGINE_CIPHERS_PTR)(ENGINE *, const EVP_CIPHER **, const int **, int); | |
300 | typedef int (*ENGINE_DIGESTS_PTR)(ENGINE *, const EVP_MD **, const int **, int); | |
7e5b0681 | 301 | typedef int (*ENGINE_PKEY_METHS_PTR)(ENGINE *, EVP_PKEY_METHOD **, const int **, int); |
de9fcfe3 | 302 | typedef int (*ENGINE_PKEY_ASN1_METHS_PTR)(ENGINE *, EVP_PKEY_ASN1_METHOD **, const int **, int); |
40fcda29 GT |
303 | /* STRUCTURE functions ... all of these functions deal with pointers to ENGINE |
304 | * structures where the pointers have a "structural reference". This means that | |
305 | * their reference is to allowed access to the structure but it does not imply | |
306 | * that the structure is functional. To simply increment or decrement the | |
307 | * structural reference count, use ENGINE_by_id and ENGINE_free. NB: This is not | |
308 | * required when iterating using ENGINE_get_next as it will automatically | |
309 | * decrement the structural reference count of the "current" ENGINE and | |
310 | * increment the structural reference count of the ENGINE it returns (unless it | |
311 | * is NULL). */ | |
5270e702 RL |
312 | |
313 | /* Get the first/last "ENGINE" type available. */ | |
314 | ENGINE *ENGINE_get_first(void); | |
315 | ENGINE *ENGINE_get_last(void); | |
316 | /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */ | |
317 | ENGINE *ENGINE_get_next(ENGINE *e); | |
318 | ENGINE *ENGINE_get_prev(ENGINE *e); | |
319 | /* Add another "ENGINE" type into the array. */ | |
320 | int ENGINE_add(ENGINE *e); | |
321 | /* Remove an existing "ENGINE" type from the array. */ | |
322 | int ENGINE_remove(ENGINE *e); | |
323 | /* Retrieve an engine from the list by its unique "id" value. */ | |
324 | ENGINE *ENGINE_by_id(const char *id); | |
b6d1e52d GT |
325 | /* Add all the built-in engines. */ |
326 | void ENGINE_load_openssl(void); | |
327 | void ENGINE_load_dynamic(void); | |
6cb68620 | 328 | #ifndef OPENSSL_NO_STATIC_ENGINE |
f3c22ef1 GT |
329 | void ENGINE_load_4758cca(void); |
330 | void ENGINE_load_aep(void); | |
11c0f120 | 331 | void ENGINE_load_atalla(void); |
f3c22ef1 GT |
332 | void ENGINE_load_chil(void); |
333 | void ENGINE_load_cswift(void); | |
11c0f120 | 334 | void ENGINE_load_nuron(void); |
ba2cad19 | 335 | void ENGINE_load_sureware(void); |
f3c22ef1 | 336 | void ENGINE_load_ubsec(void); |
bb11c282 | 337 | void ENGINE_load_padlock(void); |
59d2d48f DSH |
338 | #ifndef OPENSSL_NO_CAPIENG |
339 | void ENGINE_load_capi(void); | |
340 | #endif | |
bb11c282 AP |
341 | #ifndef OPENSSL_NO_GMP |
342 | void ENGINE_load_gmp(void); | |
343 | #endif | |
344 | #ifndef OPENSSL_NO_GOST | |
08a63823 | 345 | void ENGINE_load_gost(void); |
6cb68620 | 346 | #endif |
bb11c282 | 347 | #endif |
293d5082 | 348 | void ENGINE_load_cryptodev(void); |
11c0f120 | 349 | void ENGINE_load_builtin_engines(void); |
5270e702 | 350 | |
b6d1e52d GT |
351 | /* Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation |
352 | * "registry" handling. */ | |
353 | unsigned int ENGINE_get_table_flags(void); | |
354 | void ENGINE_set_table_flags(unsigned int flags); | |
355 | ||
356 | /* Manage registration of ENGINEs per "table". For each type, there are 3 | |
357 | * functions; | |
358 | * ENGINE_register_***(e) - registers the implementation from 'e' (if it has one) | |
359 | * ENGINE_unregister_***(e) - unregister the implementation from 'e' | |
360 | * ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list | |
361 | * Cleanup is automatically registered from each table when required, so | |
362 | * ENGINE_cleanup() will reverse any "register" operations. */ | |
363 | ||
364 | int ENGINE_register_RSA(ENGINE *e); | |
365 | void ENGINE_unregister_RSA(ENGINE *e); | |
366 | void ENGINE_register_all_RSA(void); | |
367 | ||
368 | int ENGINE_register_DSA(ENGINE *e); | |
369 | void ENGINE_unregister_DSA(ENGINE *e); | |
370 | void ENGINE_register_all_DSA(void); | |
371 | ||
e172d60d BM |
372 | int ENGINE_register_ECDH(ENGINE *e); |
373 | void ENGINE_unregister_ECDH(ENGINE *e); | |
374 | void ENGINE_register_all_ECDH(void); | |
375 | ||
4d94ae00 BM |
376 | int ENGINE_register_ECDSA(ENGINE *e); |
377 | void ENGINE_unregister_ECDSA(ENGINE *e); | |
378 | void ENGINE_register_all_ECDSA(void); | |
379 | ||
b6d1e52d GT |
380 | int ENGINE_register_DH(ENGINE *e); |
381 | void ENGINE_unregister_DH(ENGINE *e); | |
382 | void ENGINE_register_all_DH(void); | |
383 | ||
384 | int ENGINE_register_RAND(ENGINE *e); | |
385 | void ENGINE_unregister_RAND(ENGINE *e); | |
386 | void ENGINE_register_all_RAND(void); | |
387 | ||
3bbb0212 RL |
388 | int ENGINE_register_STORE(ENGINE *e); |
389 | void ENGINE_unregister_STORE(ENGINE *e); | |
390 | void ENGINE_register_all_STORE(void); | |
391 | ||
b370230b GT |
392 | int ENGINE_register_ciphers(ENGINE *e); |
393 | void ENGINE_unregister_ciphers(ENGINE *e); | |
394 | void ENGINE_register_all_ciphers(void); | |
395 | ||
396 | int ENGINE_register_digests(ENGINE *e); | |
397 | void ENGINE_unregister_digests(ENGINE *e); | |
398 | void ENGINE_register_all_digests(void); | |
399 | ||
58aa573a DSH |
400 | int ENGINE_register_pkey_meths(ENGINE *e); |
401 | void ENGINE_unregister_pkey_meths(ENGINE *e); | |
402 | void ENGINE_register_all_pkey_meths(void); | |
403 | ||
777c47ac BL |
404 | int ENGINE_register_pkey_asn1_meths(ENGINE *e); |
405 | void ENGINE_unregister_pkey_asn1_meths(ENGINE *e); | |
406 | void ENGINE_register_all_pkey_asn1_meths(void); | |
407 | ||
b6d1e52d GT |
408 | /* These functions register all support from the above categories. Note, use of |
409 | * these functions can result in static linkage of code your application may not | |
410 | * need. If you only need a subset of functionality, consider using more | |
411 | * selective initialisation. */ | |
412 | int ENGINE_register_complete(ENGINE *e); | |
413 | int ENGINE_register_all_complete(void); | |
354c3ace | 414 | |
40fcda29 GT |
415 | /* Send parametrised control commands to the engine. The possibilities to send |
416 | * down an integer, a pointer to data or a function pointer are provided. Any of | |
417 | * the parameters may or may not be NULL, depending on the command number. In | |
418 | * actuality, this function only requires a structural (rather than functional) | |
419 | * reference to an engine, but many control commands may require the engine be | |
420 | * functional. The caller should be aware of trying commands that require an | |
421 | * operational ENGINE, and only use functional references in such situations. */ | |
b653327d | 422 | int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void)); |
40fcda29 GT |
423 | |
424 | /* This function tests if an ENGINE-specific command is usable as a "setting". | |
425 | * Eg. in an application's config file that gets processed through | |
426 | * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to | |
427 | * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). */ | |
428 | int ENGINE_cmd_is_executable(ENGINE *e, int cmd); | |
429 | ||
839590f5 RL |
430 | /* This function works like ENGINE_ctrl() with the exception of taking a |
431 | * command name instead of a command number, and can handle optional commands. | |
432 | * See the comment on ENGINE_ctrl_cmd_string() for an explanation on how to | |
433 | * use the cmd_name and cmd_optional. */ | |
434 | int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name, | |
b653327d | 435 | long i, void *p, void (*f)(void), int cmd_optional); |
839590f5 | 436 | |
40fcda29 GT |
437 | /* This function passes a command-name and argument to an ENGINE. The cmd_name |
438 | * is converted to a command number and the control command is called using | |
439 | * 'arg' as an argument (unless the ENGINE doesn't support such a command, in | |
440 | * which case no control command is called). The command is checked for input | |
441 | * flags, and if necessary the argument will be converted to a numeric value. If | |
442 | * cmd_optional is non-zero, then if the ENGINE doesn't support the given | |
443 | * cmd_name the return value will be success anyway. This function is intended | |
444 | * for applications to use so that users (or config files) can supply | |
445 | * engine-specific config data to the ENGINE at run-time to control behaviour of | |
446 | * specific engines. As such, it shouldn't be used for calling ENGINE_ctrl() | |
447 | * functions that return data, deal with binary data, or that are otherwise | |
448 | * supposed to be used directly through ENGINE_ctrl() in application code. Any | |
449 | * "return" data from an ENGINE_ctrl() operation in this function will be lost - | |
450 | * the return value is interpreted as failure if the return value is zero, | |
451 | * success otherwise, and this function returns a boolean value as a result. In | |
452 | * other words, vendors of 'ENGINE'-enabled devices should write ENGINE | |
453 | * implementations with parameterisations that work in this scheme, so that | |
454 | * compliant ENGINE-based applications can work consistently with the same | |
455 | * configuration for the same ENGINE-enabled devices, across applications. */ | |
456 | int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg, | |
457 | int cmd_optional); | |
458 | ||
d54bf145 GT |
459 | /* These functions are useful for manufacturing new ENGINE structures. They |
460 | * don't address reference counting at all - one uses them to populate an ENGINE | |
461 | * structure with personalised implementations of things prior to using it | |
462 | * directly or adding it to the builtin ENGINE list in OpenSSL. These are also | |
463 | * here so that the ENGINE structure doesn't have to be exposed and break binary | |
464 | * compatibility! */ | |
5270e702 | 465 | ENGINE *ENGINE_new(void); |
5270e702 | 466 | int ENGINE_free(ENGINE *e); |
314c6670 | 467 | int ENGINE_up_ref(ENGINE *e); |
5270e702 RL |
468 | int ENGINE_set_id(ENGINE *e, const char *id); |
469 | int ENGINE_set_name(ENGINE *e, const char *name); | |
10e473e9 | 470 | int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth); |
a4aba800 | 471 | int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth); |
e172d60d | 472 | int ENGINE_set_ECDH(ENGINE *e, const ECDH_METHOD *ecdh_meth); |
4d94ae00 | 473 | int ENGINE_set_ECDSA(ENGINE *e, const ECDSA_METHOD *ecdsa_meth); |
f971ccb2 | 474 | int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth); |
d54bf145 | 475 | int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth); |
3bbb0212 | 476 | int ENGINE_set_STORE(ENGINE *e, const STORE_METHOD *store_meth); |
f524ddbe | 477 | int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f); |
5270e702 RL |
478 | int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f); |
479 | int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f); | |
480 | int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f); | |
d54bf145 GT |
481 | int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f); |
482 | int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f); | |
05935c47 DSH |
483 | int ENGINE_set_load_ssl_client_cert_function(ENGINE *e, |
484 | ENGINE_SSL_CLIENT_CERT_PTR loadssl_f); | |
b370230b GT |
485 | int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f); |
486 | int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f); | |
6f88c6a6 | 487 | int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f); |
de9fcfe3 | 488 | int ENGINE_set_pkey_asn1_meths(ENGINE *e, ENGINE_PKEY_ASN1_METHS_PTR f); |
d54bf145 | 489 | int ENGINE_set_flags(ENGINE *e, int flags); |
40fcda29 | 490 | int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns); |
1275c456 | 491 | /* These functions allow control over any per-structure ENGINE data. */ |
0ce5f3e4 GT |
492 | int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, |
493 | CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); | |
494 | int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg); | |
1275c456 | 495 | void *ENGINE_get_ex_data(const ENGINE *e, int idx); |
b6d1e52d GT |
496 | |
497 | /* This function cleans up anything that needs it. Eg. the ENGINE_add() function | |
498 | * automatically ensures the list cleanup function is registered to be called | |
499 | * from ENGINE_cleanup(). Similarly, all ENGINE_register_*** functions ensure | |
500 | * ENGINE_cleanup() will clean up after them. */ | |
a679116f | 501 | void ENGINE_cleanup(void); |
5270e702 | 502 | |
d54bf145 GT |
503 | /* These return values from within the ENGINE structure. These can be useful |
504 | * with functional references as well as structural references - it depends | |
505 | * which you obtained. Using the result for functional purposes if you only | |
506 | * obtained a structural reference may be problematic! */ | |
507 | const char *ENGINE_get_id(const ENGINE *e); | |
508 | const char *ENGINE_get_name(const ENGINE *e); | |
509 | const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e); | |
510 | const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e); | |
e172d60d | 511 | const ECDH_METHOD *ENGINE_get_ECDH(const ENGINE *e); |
4d94ae00 | 512 | const ECDSA_METHOD *ENGINE_get_ECDSA(const ENGINE *e); |
d54bf145 GT |
513 | const DH_METHOD *ENGINE_get_DH(const ENGINE *e); |
514 | const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e); | |
3bbb0212 | 515 | const STORE_METHOD *ENGINE_get_STORE(const ENGINE *e); |
f524ddbe | 516 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e); |
d54bf145 GT |
517 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e); |
518 | ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e); | |
519 | ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e); | |
520 | ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e); | |
521 | ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e); | |
05935c47 | 522 | ENGINE_SSL_CLIENT_CERT_PTR ENGINE_get_ssl_client_cert_function(const ENGINE *e); |
b370230b GT |
523 | ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e); |
524 | ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e); | |
58aa573a | 525 | ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e); |
de9fcfe3 | 526 | ENGINE_PKEY_ASN1_METHS_PTR ENGINE_get_pkey_asn1_meths(const ENGINE *e); |
b370230b GT |
527 | const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid); |
528 | const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid); | |
58aa573a | 529 | const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid); |
de9fcfe3 | 530 | const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth(ENGINE *e, int nid); |
01b8b3c7 DSH |
531 | const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth_str(ENGINE *e, |
532 | const char *str, int len); | |
2f0550c4 DSH |
533 | const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe, |
534 | const char *str, int len); | |
40fcda29 | 535 | const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e); |
d54bf145 | 536 | int ENGINE_get_flags(const ENGINE *e); |
5270e702 RL |
537 | |
538 | /* FUNCTIONAL functions. These functions deal with ENGINE structures | |
539 | * that have (or will) be initialised for use. Broadly speaking, the | |
540 | * structural functions are useful for iterating the list of available | |
541 | * engine types, creating new engine types, and other "list" operations. | |
542 | * These functions actually deal with ENGINEs that are to be used. As | |
543 | * such these functions can fail (if applicable) when particular | |
544 | * engines are unavailable - eg. if a hardware accelerator is not | |
545 | * attached or not functioning correctly. Each ENGINE has 2 reference | |
546 | * counts; structural and functional. Every time a functional reference | |
547 | * is obtained or released, a corresponding structural reference is | |
548 | * automatically obtained or released too. */ | |
549 | ||
550 | /* Initialise a engine type for use (or up its reference count if it's | |
551 | * already in use). This will fail if the engine is not currently | |
552 | * operational and cannot initialise. */ | |
553 | int ENGINE_init(ENGINE *e); | |
554 | /* Free a functional reference to a engine type. This does not require | |
555 | * a corresponding call to ENGINE_free as it also releases a structural | |
556 | * reference. */ | |
557 | int ENGINE_finish(ENGINE *e); | |
5270e702 RL |
558 | |
559 | /* The following functions handle keys that are stored in some secondary | |
560 | * location, handled by the engine. The storage may be on a card or | |
561 | * whatever. */ | |
562 | EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id, | |
839590f5 | 563 | UI_METHOD *ui_method, void *callback_data); |
5270e702 | 564 | EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id, |
839590f5 | 565 | UI_METHOD *ui_method, void *callback_data); |
05935c47 DSH |
566 | int ENGINE_load_ssl_client_cert(ENGINE *e, SSL *s, |
567 | STACK_OF(X509_NAME) *ca_dn, X509 **pcert, EVP_PKEY **ppkey, | |
3fc59c84 | 568 | STACK_OF(X509) **pother, |
05935c47 | 569 | UI_METHOD *ui_method, void *callback_data); |
5270e702 RL |
570 | |
571 | /* This returns a pointer for the current ENGINE structure that | |
572 | * is (by default) performing any RSA operations. The value returned | |
573 | * is an incremented reference, so it should be free'd (ENGINE_finish) | |
574 | * before it is discarded. */ | |
575 | ENGINE *ENGINE_get_default_RSA(void); | |
576 | /* Same for the other "methods" */ | |
577 | ENGINE *ENGINE_get_default_DSA(void); | |
e172d60d | 578 | ENGINE *ENGINE_get_default_ECDH(void); |
4d94ae00 | 579 | ENGINE *ENGINE_get_default_ECDSA(void); |
5270e702 RL |
580 | ENGINE *ENGINE_get_default_DH(void); |
581 | ENGINE *ENGINE_get_default_RAND(void); | |
b370230b GT |
582 | /* These functions can be used to get a functional reference to perform |
583 | * ciphering or digesting corresponding to "nid". */ | |
584 | ENGINE *ENGINE_get_cipher_engine(int nid); | |
585 | ENGINE *ENGINE_get_digest_engine(int nid); | |
c9777d26 | 586 | ENGINE *ENGINE_get_pkey_meth_engine(int nid); |
01b8b3c7 | 587 | ENGINE *ENGINE_get_pkey_asn1_meth_engine(int nid); |
5270e702 RL |
588 | |
589 | /* This sets a new default ENGINE structure for performing RSA | |
590 | * operations. If the result is non-zero (success) then the ENGINE | |
591 | * structure will have had its reference count up'd so the caller | |
592 | * should still free their own reference 'e'. */ | |
593 | int ENGINE_set_default_RSA(ENGINE *e); | |
3822740c | 594 | int ENGINE_set_default_string(ENGINE *e, const char *def_list); |
5270e702 RL |
595 | /* Same for the other "methods" */ |
596 | int ENGINE_set_default_DSA(ENGINE *e); | |
e172d60d | 597 | int ENGINE_set_default_ECDH(ENGINE *e); |
4d94ae00 | 598 | int ENGINE_set_default_ECDSA(ENGINE *e); |
5270e702 RL |
599 | int ENGINE_set_default_DH(ENGINE *e); |
600 | int ENGINE_set_default_RAND(ENGINE *e); | |
b370230b GT |
601 | int ENGINE_set_default_ciphers(ENGINE *e); |
602 | int ENGINE_set_default_digests(ENGINE *e); | |
1892c8bf | 603 | int ENGINE_set_default_pkey_meths(ENGINE *e); |
01b8b3c7 | 604 | int ENGINE_set_default_pkey_asn1_meths(ENGINE *e); |
5270e702 RL |
605 | |
606 | /* The combination "set" - the flags are bitwise "OR"d from the | |
b6d1e52d GT |
607 | * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()" |
608 | * function, this function can result in unnecessary static linkage. If your | |
609 | * application requires only specific functionality, consider using more | |
610 | * selective functions. */ | |
5270e702 RL |
611 | int ENGINE_set_default(ENGINE *e, unsigned int flags); |
612 | ||
c9501c22 DSH |
613 | void ENGINE_add_conf_module(void); |
614 | ||
b6d1e52d GT |
615 | /* Deprecated functions ... */ |
616 | /* int ENGINE_clear_defaults(void); */ | |
0e360199 | 617 | |
9391f977 GT |
618 | /**************************/ |
619 | /* DYNAMIC ENGINE SUPPORT */ | |
620 | /**************************/ | |
621 | ||
622 | /* Binary/behaviour compatibility levels */ | |
3bbb0212 | 623 | #define OSSL_DYNAMIC_VERSION (unsigned long)0x00020000 |
9391f977 GT |
624 | /* Binary versions older than this are too old for us (whether we're a loader or |
625 | * a loadee) */ | |
3bbb0212 | 626 | #define OSSL_DYNAMIC_OLDEST (unsigned long)0x00020000 |
9391f977 GT |
627 | |
628 | /* When compiling an ENGINE entirely as an external shared library, loadable by | |
629 | * the "dynamic" ENGINE, these types are needed. The 'dynamic_fns' structure | |
630 | * type provides the calling application's (or library's) error functionality | |
631 | * and memory management function pointers to the loaded library. These should | |
632 | * be used/set in the loaded library code so that the loading application's | |
0587ec26 GT |
633 | * 'state' will be used/changed in all operations. The 'static_state' pointer |
634 | * allows the loaded library to know if it shares the same static data as the | |
635 | * calling application (or library), and thus whether these callbacks need to be | |
636 | * set or not. */ | |
e5e6a94f GT |
637 | typedef void *(*dyn_MEM_malloc_cb)(size_t); |
638 | typedef void *(*dyn_MEM_realloc_cb)(void *, size_t); | |
639 | typedef void (*dyn_MEM_free_cb)(void *); | |
9391f977 | 640 | typedef struct st_dynamic_MEM_fns { |
e5e6a94f GT |
641 | dyn_MEM_malloc_cb malloc_cb; |
642 | dyn_MEM_realloc_cb realloc_cb; | |
643 | dyn_MEM_free_cb free_cb; | |
9391f977 | 644 | } dynamic_MEM_fns; |
e5e6a94f GT |
645 | /* FIXME: Perhaps the memory and locking code (crypto.h) should declare and use |
646 | * these types so we (and any other dependant code) can simplify a bit?? */ | |
647 | typedef void (*dyn_lock_locking_cb)(int,int,const char *,int); | |
648 | typedef int (*dyn_lock_add_lock_cb)(int*,int,int,const char *,int); | |
649 | typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb)( | |
650 | const char *,int); | |
651 | typedef void (*dyn_dynlock_lock_cb)(int,struct CRYPTO_dynlock_value *, | |
652 | const char *,int); | |
653 | typedef void (*dyn_dynlock_destroy_cb)(struct CRYPTO_dynlock_value *, | |
654 | const char *,int); | |
655 | typedef struct st_dynamic_LOCK_fns { | |
656 | dyn_lock_locking_cb lock_locking_cb; | |
657 | dyn_lock_add_lock_cb lock_add_lock_cb; | |
658 | dyn_dynlock_create_cb dynlock_create_cb; | |
659 | dyn_dynlock_lock_cb dynlock_lock_cb; | |
660 | dyn_dynlock_destroy_cb dynlock_destroy_cb; | |
661 | } dynamic_LOCK_fns; | |
662 | /* The top-level structure */ | |
9391f977 | 663 | typedef struct st_dynamic_fns { |
0587ec26 | 664 | void *static_state; |
9391f977 GT |
665 | const ERR_FNS *err_fns; |
666 | const CRYPTO_EX_DATA_IMPL *ex_data_fns; | |
667 | dynamic_MEM_fns mem_fns; | |
e5e6a94f | 668 | dynamic_LOCK_fns lock_fns; |
9391f977 GT |
669 | } dynamic_fns; |
670 | ||
671 | /* The version checking function should be of this prototype. NB: The | |
672 | * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading code. | |
673 | * If this function returns zero, it indicates a (potential) version | |
674 | * incompatibility and the loaded library doesn't believe it can proceed. | |
675 | * Otherwise, the returned value is the (latest) version supported by the | |
676 | * loading library. The loader may still decide that the loaded code's version | |
677 | * is unsatisfactory and could veto the load. The function is expected to | |
678 | * be implemented with the symbol name "v_check", and a default implementation | |
679 | * can be fully instantiated with IMPLEMENT_DYNAMIC_CHECK_FN(). */ | |
680 | typedef unsigned long (*dynamic_v_check_fn)(unsigned long ossl_version); | |
681 | #define IMPLEMENT_DYNAMIC_CHECK_FN() \ | |
fbf002bb | 682 | OPENSSL_EXPORT unsigned long v_check(unsigned long v) { \ |
9391f977 GT |
683 | if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \ |
684 | return 0; } | |
685 | ||
686 | /* This function is passed the ENGINE structure to initialise with its own | |
687 | * function and command settings. It should not adjust the structural or | |
688 | * functional reference counts. If this function returns zero, (a) the load will | |
689 | * be aborted, (b) the previous ENGINE state will be memcpy'd back onto the | |
690 | * structure, and (c) the shared library will be unloaded. So implementations | |
691 | * should do their own internal cleanup in failure circumstances otherwise they | |
692 | * could leak. The 'id' parameter, if non-NULL, represents the ENGINE id that | |
693 | * the loader is looking for. If this is NULL, the shared library can choose to | |
694 | * return failure or to initialise a 'default' ENGINE. If non-NULL, the shared | |
695 | * library must initialise only an ENGINE matching the passed 'id'. The function | |
696 | * is expected to be implemented with the symbol name "bind_engine". A standard | |
697 | * implementation can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where | |
698 | * the parameter 'fn' is a callback function that populates the ENGINE structure | |
699 | * and returns an int value (zero for failure). 'fn' should have prototype; | |
700 | * [static] int fn(ENGINE *e, const char *id); */ | |
701 | typedef int (*dynamic_bind_engine)(ENGINE *e, const char *id, | |
702 | const dynamic_fns *fns); | |
703 | #define IMPLEMENT_DYNAMIC_BIND_FN(fn) \ | |
fbf002bb | 704 | OPENSSL_EXPORT \ |
9391f977 | 705 | int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \ |
0587ec26 | 706 | if(ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \ |
9391f977 GT |
707 | if(!CRYPTO_set_mem_functions(fns->mem_fns.malloc_cb, \ |
708 | fns->mem_fns.realloc_cb, fns->mem_fns.free_cb)) \ | |
709 | return 0; \ | |
e5e6a94f GT |
710 | CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \ |
711 | CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \ | |
712 | CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \ | |
713 | CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \ | |
714 | CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \ | |
9391f977 GT |
715 | if(!CRYPTO_set_ex_data_implementation(fns->ex_data_fns)) \ |
716 | return 0; \ | |
717 | if(!ERR_set_implementation(fns->err_fns)) return 0; \ | |
0587ec26 | 718 | skip_cbs: \ |
9391f977 GT |
719 | if(!fn(e,id)) return 0; \ |
720 | return 1; } | |
354c3ace | 721 | |
0587ec26 GT |
722 | /* If the loading application (or library) and the loaded ENGINE library share |
723 | * the same static data (eg. they're both dynamically linked to the same | |
724 | * libcrypto.so) we need a way to avoid trying to set system callbacks - this | |
725 | * would fail, and for the same reason that it's unnecessary to try. If the | |
726 | * loaded ENGINE has (or gets from through the loader) its own copy of the | |
727 | * libcrypto static data, we will need to set the callbacks. The easiest way to | |
728 | * detect this is to have a function that returns a pointer to some static data | |
729 | * and let the loading application and loaded ENGINE compare their respective | |
730 | * values. */ | |
731 | void *ENGINE_get_static_state(void); | |
732 | ||
33cc07f7 BL |
733 | #if defined(__OpenBSD__) || defined(__FreeBSD__) |
734 | void ENGINE_setup_bsd_cryptodev(void); | |
735 | #endif | |
0587ec26 | 736 | |
5270e702 RL |
737 | /* BEGIN ERROR CODES */ |
738 | /* The following lines are auto generated by the script mkerr.pl. Any changes | |
739 | * made after this point may be overwritten when the script is next run. | |
740 | */ | |
40fcda29 | 741 | void ERR_load_ENGINE_strings(void); |
957b6db3 | 742 | |
5270e702 RL |
743 | /* Error codes for the ENGINE functions. */ |
744 | ||
745 | /* Function codes. */ | |
9391f977 GT |
746 | #define ENGINE_F_DYNAMIC_CTRL 180 |
747 | #define ENGINE_F_DYNAMIC_GET_DATA_CTX 181 | |
748 | #define ENGINE_F_DYNAMIC_LOAD 182 | |
8afca8d9 | 749 | #define ENGINE_F_DYNAMIC_SET_DATA_CTX 183 |
5270e702 RL |
750 | #define ENGINE_F_ENGINE_ADD 105 |
751 | #define ENGINE_F_ENGINE_BY_ID 106 | |
40fcda29 | 752 | #define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE 170 |
5270e702 | 753 | #define ENGINE_F_ENGINE_CTRL 142 |
839590f5 | 754 | #define ENGINE_F_ENGINE_CTRL_CMD 178 |
40fcda29 | 755 | #define ENGINE_F_ENGINE_CTRL_CMD_STRING 171 |
5270e702 | 756 | #define ENGINE_F_ENGINE_FINISH 107 |
8afca8d9 | 757 | #define ENGINE_F_ENGINE_FREE_UTIL 108 |
b370230b | 758 | #define ENGINE_F_ENGINE_GET_CIPHER 185 |
9e78e6c3 | 759 | #define ENGINE_F_ENGINE_GET_DEFAULT_TYPE 177 |
b370230b | 760 | #define ENGINE_F_ENGINE_GET_DIGEST 186 |
5270e702 | 761 | #define ENGINE_F_ENGINE_GET_NEXT 115 |
de9fcfe3 | 762 | #define ENGINE_F_ENGINE_GET_PKEY_ASN1_METH 193 |
e0c1ea90 | 763 | #define ENGINE_F_ENGINE_GET_PKEY_METH 192 |
5270e702 | 764 | #define ENGINE_F_ENGINE_GET_PREV 116 |
5270e702 RL |
765 | #define ENGINE_F_ENGINE_INIT 119 |
766 | #define ENGINE_F_ENGINE_LIST_ADD 120 | |
767 | #define ENGINE_F_ENGINE_LIST_REMOVE 121 | |
768 | #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150 | |
769 | #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151 | |
eafd6e51 | 770 | #define ENGINE_F_ENGINE_LOAD_SSL_CLIENT_CERT 194 |
5270e702 RL |
771 | #define ENGINE_F_ENGINE_NEW 122 |
772 | #define ENGINE_F_ENGINE_REMOVE 123 | |
df5eaa8a | 773 | #define ENGINE_F_ENGINE_SET_DEFAULT_STRING 189 |
5270e702 | 774 | #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE 126 |
5270e702 | 775 | #define ENGINE_F_ENGINE_SET_ID 129 |
5270e702 | 776 | #define ENGINE_F_ENGINE_SET_NAME 130 |
b6d1e52d | 777 | #define ENGINE_F_ENGINE_TABLE_REGISTER 184 |
5270e702 | 778 | #define ENGINE_F_ENGINE_UNLOAD_KEY 152 |
8afca8d9 | 779 | #define ENGINE_F_ENGINE_UNLOCKED_FINISH 191 |
314c6670 | 780 | #define ENGINE_F_ENGINE_UP_REF 190 |
40fcda29 | 781 | #define ENGINE_F_INT_CTRL_HELPER 172 |
c9501c22 | 782 | #define ENGINE_F_INT_ENGINE_CONFIGURE 188 |
8afca8d9 | 783 | #define ENGINE_F_INT_ENGINE_MODULE_INIT 187 |
5270e702 | 784 | #define ENGINE_F_LOG_MESSAGE 141 |
5270e702 RL |
785 | |
786 | /* Reason codes. */ | |
787 | #define ENGINE_R_ALREADY_LOADED 100 | |
40fcda29 | 788 | #define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER 133 |
40fcda29 GT |
789 | #define ENGINE_R_CMD_NOT_EXECUTABLE 134 |
790 | #define ENGINE_R_COMMAND_TAKES_INPUT 135 | |
791 | #define ENGINE_R_COMMAND_TAKES_NO_INPUT 136 | |
5270e702 RL |
792 | #define ENGINE_R_CONFLICTING_ENGINE_ID 103 |
793 | #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119 | |
9e78e6c3 RL |
794 | #define ENGINE_R_DH_NOT_IMPLEMENTED 139 |
795 | #define ENGINE_R_DSA_NOT_IMPLEMENTED 140 | |
5270e702 | 796 | #define ENGINE_R_DSO_FAILURE 104 |
5270e702 | 797 | #define ENGINE_R_DSO_NOT_FOUND 132 |
c9501c22 | 798 | #define ENGINE_R_ENGINES_SECTION_ERROR 148 |
5270e702 | 799 | #define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105 |
c9501c22 | 800 | #define ENGINE_R_ENGINE_SECTION_ERROR 149 |
5270e702 RL |
801 | #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128 |
802 | #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129 | |
803 | #define ENGINE_R_FINISH_FAILED 106 | |
804 | #define ENGINE_R_GET_HANDLE_FAILED 107 | |
805 | #define ENGINE_R_ID_OR_NAME_MISSING 108 | |
806 | #define ENGINE_R_INIT_FAILED 109 | |
807 | #define ENGINE_R_INTERNAL_LIST_ERROR 110 | |
9391f977 | 808 | #define ENGINE_R_INVALID_ARGUMENT 143 |
40fcda29 GT |
809 | #define ENGINE_R_INVALID_CMD_NAME 137 |
810 | #define ENGINE_R_INVALID_CMD_NUMBER 138 | |
0dc09233 | 811 | #define ENGINE_R_INVALID_INIT_VALUE 151 |
df5eaa8a | 812 | #define ENGINE_R_INVALID_STRING 150 |
5270e702 RL |
813 | #define ENGINE_R_NOT_INITIALISED 117 |
814 | #define ENGINE_R_NOT_LOADED 112 | |
5270e702 | 815 | #define ENGINE_R_NO_CONTROL_FUNCTION 120 |
9391f977 | 816 | #define ENGINE_R_NO_INDEX 144 |
5270e702 RL |
817 | #define ENGINE_R_NO_LOAD_FUNCTION 125 |
818 | #define ENGINE_R_NO_REFERENCE 130 | |
819 | #define ENGINE_R_NO_SUCH_ENGINE 116 | |
820 | #define ENGINE_R_NO_UNLOAD_FUNCTION 126 | |
821 | #define ENGINE_R_PROVIDE_PARAMETERS 113 | |
9e78e6c3 | 822 | #define ENGINE_R_RSA_NOT_IMPLEMENTED 141 |
b370230b GT |
823 | #define ENGINE_R_UNIMPLEMENTED_CIPHER 146 |
824 | #define ENGINE_R_UNIMPLEMENTED_DIGEST 147 | |
e0c1ea90 | 825 | #define ENGINE_R_UNIMPLEMENTED_PUBLIC_KEY_METHOD 101 |
9391f977 | 826 | #define ENGINE_R_VERSION_INCOMPATIBILITY 145 |
5270e702 RL |
827 | |
828 | #ifdef __cplusplus | |
829 | } | |
830 | #endif | |
831 | #endif |