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