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