2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
59 #ifndef HEADER_ENGINE_H
60 #define HEADER_ENGINE_H
62 #include <openssl/bn.h>
63 #ifndef OPENSSL_NO_RSA
64 #include <openssl/rsa.h>
66 #ifndef OPENSSL_NO_DSA
67 #include <openssl/dsa.h>
70 #include <openssl/dh.h>
72 #include <openssl/rand.h>
73 #include <openssl/evp.h>
74 #include <openssl/symhacks.h>
80 /* Fixups for missing algorithms */
82 typedef void RSA_METHOD;
85 typedef void DSA_METHOD;
88 typedef void DH_METHOD;
91 /* These flags are used to control combinations of algorithm (methods)
92 * by bitwise "OR"ing. */
93 #define ENGINE_METHOD_RSA (unsigned int)0x0001
94 #define ENGINE_METHOD_DSA (unsigned int)0x0002
95 #define ENGINE_METHOD_DH (unsigned int)0x0004
96 #define ENGINE_METHOD_RAND (unsigned int)0x0008
97 #define ENGINE_METHOD_BN_MOD_EXP (unsigned int)0x0010
98 #define ENGINE_METHOD_BN_MOD_EXP_CRT (unsigned int)0x0020
99 /* Obvious all-or-nothing cases. */
100 #define ENGINE_METHOD_ALL (unsigned int)0xFFFF
101 #define ENGINE_METHOD_NONE (unsigned int)0x0000
103 /* ENGINE flags that can be set by ENGINE_set_flags(). */
104 /* #define ENGINE_FLAGS_MALLOCED 0x0001 */ /* Not used */
106 /* This flag is for ENGINEs that wish to handle the various 'CMD'-related
107 * control commands on their own. Without this flag, ENGINE_ctrl() handles these
108 * control commands on behalf of the ENGINE using their "cmd_defns" data. */
109 #define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002
111 /* This flag is for ENGINEs who return new duplicate structures when found via
112 * "ENGINE_by_id()". When an ENGINE must store state (eg. if ENGINE_ctrl()
113 * commands are called in sequence as part of some stateful process like
114 * key-generation setup and execution), it can set this flag - then each attempt
115 * to obtain the ENGINE will result in it being copied into a new structure.
116 * Normally, ENGINEs don't declare this flag so ENGINE_by_id() just increments
117 * the existing ENGINE's structural reference count. */
118 #define ENGINE_FLAGS_BY_ID_COPY (int)0x0004
120 /* ENGINEs can support their own command types, and these flags are used in
121 * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input each
122 * command expects. Currently only numeric and string input is supported. If a
123 * control command supports none of the _NUMERIC, _STRING, or _NO_INPUT options,
124 * then it is regarded as an "internal" control command - and not for use in
125 * config setting situations. As such, they're not available to the
126 * ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() access. Changes to
127 * this list of 'command types' should be reflected carefully in
128 * ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). */
130 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
131 #define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001
132 /* accepts string input (cast from 'void*' to 'const char *', 4th parameter to
134 #define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002
135 /* Indicates that the control command takes *no* input. Ie. the control command
136 * is unparameterised. */
137 #define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004
139 /* NB: These 3 control commands are deprecated and should not be used. ENGINEs
140 * relying on these commands should compile conditional support for
141 * compatibility (eg. if these symbols are defined) but should also migrate the
142 * same functionality to their own ENGINE-specific control functions that can be
143 * "discovered" by calling applications. The fact these control commands
144 * wouldn't be "executable" (ie. usable by text-based config) doesn't change the
145 * fact that application code can find and use them without requiring per-ENGINE
148 /* These flags are used to tell the ctrl function what should be done.
149 * All command numbers are shared between all engines, even if some don't
150 * make sense to some engines. In such a case, they do nothing but return
151 * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */
152 #define ENGINE_CTRL_SET_LOGSTREAM 1
153 #define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2
154 #define ENGINE_CTRL_HUP 3 /* Close and reinitialise any
155 handles/connections etc. */
157 /* These control commands allow an application to deal with an arbitrary engine
158 * in a dynamic way. Warn: Negative return values indicate errors FOR THESE
159 * COMMANDS because zero is used to indicate 'end-of-list'. Other commands,
160 * including ENGINE-specific command types, return zero for an error.
162 * An ENGINE can choose to implement these ctrl functions, and can internally
163 * manage things however it chooses - it does so by setting the
164 * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise the
165 * ENGINE_ctrl() code handles this on the ENGINE's behalf using the cmd_defns
166 * data (set using ENGINE_set_cmd_defns()). This means an ENGINE's ctrl()
167 * handler need only implement its own commands - the above "meta" commands will
168 * be taken care of. */
170 /* Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", then
171 * all the remaining control commands will return failure, so it is worth
172 * checking this first if the caller is trying to "discover" the engine's
173 * capabilities and doesn't want errors generated unnecessarily. */
174 #define ENGINE_CTRL_HAS_CTRL_FUNCTION 10
175 /* Returns a positive command number for the first command supported by the
176 * engine. Returns zero if no ctrl commands are supported. */
177 #define ENGINE_CTRL_GET_FIRST_CMD_TYPE 11
178 /* The 'long' argument specifies a command implemented by the engine, and the
179 * return value is the next command supported, or zero if there are no more. */
180 #define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12
181 /* The 'void*' argument is a command name (cast from 'const char *'), and the
182 * return value is the command that corresponds to it. */
183 #define ENGINE_CTRL_GET_CMD_FROM_NAME 13
184 /* The next two allow a command to be converted into its corresponding string
185 * form. In each case, the 'long' argument supplies the command. In the NAME_LEN
186 * case, the return value is the length of the command name (not counting a
187 * trailing EOL). In the NAME case, the 'void*' argument must be a string buffer
188 * large enough, and it will be populated with the name of the command (WITH a
190 #define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14
191 #define ENGINE_CTRL_GET_NAME_FROM_CMD 15
192 /* The next two are similar but give a "short description" of a command. */
193 #define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16
194 #define ENGINE_CTRL_GET_DESC_FROM_CMD 17
195 /* With this command, the return value is the OR'd combination of
196 * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
197 * engine-specific ctrl command expects. */
198 #define ENGINE_CTRL_GET_CMD_FLAGS 18
200 /* ENGINE implementations should start the numbering of their own control
201 * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). */
202 #define ENGINE_CMD_BASE 200
204 /* NB: These 2 nCipher "chil" control commands are deprecated, and their
205 * functionality is now available through ENGINE-specific control commands
206 * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
207 * commands should be migrated to the more general command handling before these
210 /* Flags specific to the nCipher "chil" engine */
211 #define ENGINE_CTRL_CHIL_SET_FORKCHECK 100
212 /* Depending on the value of the (long)i argument, this sets or
213 * unsets the SimpleForkCheck flag in the CHIL API to enable or
214 * disable checking and workarounds for applications that fork().
216 #define ENGINE_CTRL_CHIL_NO_LOCKING 101
217 /* This prevents the initialisation function from providing mutex
218 * callbacks to the nCipher library. */
220 /* If an ENGINE supports its own specific control commands and wishes the
221 * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on its
222 * behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN entries
223 * to ENGINE_set_cmd_defns(). It should also implement a ctrl() handler that
224 * supports the stated commands (ie. the "cmd_num" entries as described by the
225 * array). NB: The array must be ordered in increasing order of cmd_num.
226 * "null-terminated" means that the last ENGINE_CMD_DEFN element has cmd_num set
227 * to zero and/or cmd_name set to NULL. */
228 typedef struct ENGINE_CMD_DEFN_st
230 unsigned int cmd_num; /* The command number */
231 const char *cmd_name; /* The command name itself */
232 const char *cmd_desc; /* A short description of the command */
233 unsigned int cmd_flags; /* The input the command expects */
236 /* As we're missing a BIGNUM_METHOD, we need a couple of locally
237 * defined function types that engines can implement. */
239 /* mod_exp operation, calculates; r = a ^ p mod m
240 * NB: ctx can be NULL, but if supplied, the implementation may use
241 * it if it wishes. */
242 typedef int (*BN_MOD_EXP)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
243 const BIGNUM *m, BN_CTX *ctx);
245 /* private key operation for RSA, provided seperately in case other
246 * RSA implementations wish to use it. */
247 typedef int (*BN_MOD_EXP_CRT)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
248 const BIGNUM *q, const BIGNUM *dmp1, const BIGNUM *dmq1,
249 const BIGNUM *iqmp, BN_CTX *ctx);
251 /* The list of "engine" types is a static array of (const ENGINE*)
252 * pointers (not dynamic because static is fine for now and we otherwise
253 * have to hook an appropriate load/unload function in to initialise and
256 typedef struct engine_st ENGINE;
258 /* Generic function pointer */
259 typedef int (*ENGINE_GEN_FUNC_PTR)();
260 /* Generic function pointer taking no arguments */
261 typedef int (*ENGINE_GEN_INT_FUNC_PTR)(ENGINE *);
262 /* Specific control function pointer */
263 typedef int (*ENGINE_CTRL_FUNC_PTR)(ENGINE *, int, long, void *, void (*f)());
264 /* Generic load_key function pointer */
265 typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *, const char *);
267 /* STRUCTURE functions ... all of these functions deal with pointers to ENGINE
268 * structures where the pointers have a "structural reference". This means that
269 * their reference is to allowed access to the structure but it does not imply
270 * that the structure is functional. To simply increment or decrement the
271 * structural reference count, use ENGINE_by_id and ENGINE_free. NB: This is not
272 * required when iterating using ENGINE_get_next as it will automatically
273 * decrement the structural reference count of the "current" ENGINE and
274 * increment the structural reference count of the ENGINE it returns (unless it
277 /* Get the first/last "ENGINE" type available. */
278 ENGINE *ENGINE_get_first(void);
279 ENGINE *ENGINE_get_last(void);
280 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
281 ENGINE *ENGINE_get_next(ENGINE *e);
282 ENGINE *ENGINE_get_prev(ENGINE *e);
283 /* Add another "ENGINE" type into the array. */
284 int ENGINE_add(ENGINE *e);
285 /* Remove an existing "ENGINE" type from the array. */
286 int ENGINE_remove(ENGINE *e);
287 /* Retrieve an engine from the list by its unique "id" value. */
288 ENGINE *ENGINE_by_id(const char *id);
289 /* Add all the built-in engines. By default, only the OpenSSL software
291 void ENGINE_load_cswift(void);
292 void ENGINE_load_chil(void);
293 void ENGINE_load_atalla(void);
294 void ENGINE_load_nuron(void);
295 void ENGINE_load_ubsec(void);
296 void ENGINE_load_builtin_engines(void);
298 /* Send parametrised control commands to the engine. The possibilities to send
299 * down an integer, a pointer to data or a function pointer are provided. Any of
300 * the parameters may or may not be NULL, depending on the command number. In
301 * actuality, this function only requires a structural (rather than functional)
302 * reference to an engine, but many control commands may require the engine be
303 * functional. The caller should be aware of trying commands that require an
304 * operational ENGINE, and only use functional references in such situations. */
305 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
307 /* This function tests if an ENGINE-specific command is usable as a "setting".
308 * Eg. in an application's config file that gets processed through
309 * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
310 * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). */
311 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
313 /* This function passes a command-name and argument to an ENGINE. The cmd_name
314 * is converted to a command number and the control command is called using
315 * 'arg' as an argument (unless the ENGINE doesn't support such a command, in
316 * which case no control command is called). The command is checked for input
317 * flags, and if necessary the argument will be converted to a numeric value. If
318 * cmd_optional is non-zero, then if the ENGINE doesn't support the given
319 * cmd_name the return value will be success anyway. This function is intended
320 * for applications to use so that users (or config files) can supply
321 * engine-specific config data to the ENGINE at run-time to control behaviour of
322 * specific engines. As such, it shouldn't be used for calling ENGINE_ctrl()
323 * functions that return data, deal with binary data, or that are otherwise
324 * supposed to be used directly through ENGINE_ctrl() in application code. Any
325 * "return" data from an ENGINE_ctrl() operation in this function will be lost -
326 * the return value is interpreted as failure if the return value is zero,
327 * success otherwise, and this function returns a boolean value as a result. In
328 * other words, vendors of 'ENGINE'-enabled devices should write ENGINE
329 * implementations with parameterisations that work in this scheme, so that
330 * compliant ENGINE-based applications can work consistently with the same
331 * configuration for the same ENGINE-enabled devices, across applications. */
332 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
335 /* These functions are useful for manufacturing new ENGINE structures. They
336 * don't address reference counting at all - one uses them to populate an ENGINE
337 * structure with personalised implementations of things prior to using it
338 * directly or adding it to the builtin ENGINE list in OpenSSL. These are also
339 * here so that the ENGINE structure doesn't have to be exposed and break binary
341 ENGINE *ENGINE_new(void);
342 int ENGINE_free(ENGINE *e);
343 int ENGINE_set_id(ENGINE *e, const char *id);
344 int ENGINE_set_name(ENGINE *e, const char *name);
345 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
346 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
347 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
348 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
349 int ENGINE_set_BN_mod_exp(ENGINE *e, BN_MOD_EXP bn_mod_exp);
350 int ENGINE_set_BN_mod_exp_crt(ENGINE *e, BN_MOD_EXP_CRT bn_mod_exp_crt);
351 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
352 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
353 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
354 int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
355 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
356 int ENGINE_set_flags(ENGINE *e, int flags);
357 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
358 /* Copies across all ENGINE methods and pointers. NB: This does *not* change
359 * reference counts however. */
360 int ENGINE_cpy(ENGINE *dest, const ENGINE *src);
361 /* These functions (and the "get" function lower down) allow control over any
362 * per-structure ENGINE data. */
363 int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
364 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
365 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
366 /* Cleans the internal engine structure. This should only be used when the
367 * application is about to exit. */
368 void ENGINE_cleanup(void);
370 /* These return values from within the ENGINE structure. These can be useful
371 * with functional references as well as structural references - it depends
372 * which you obtained. Using the result for functional purposes if you only
373 * obtained a structural reference may be problematic! */
374 const char *ENGINE_get_id(const ENGINE *e);
375 const char *ENGINE_get_name(const ENGINE *e);
376 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
377 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
378 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
379 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
380 BN_MOD_EXP ENGINE_get_BN_mod_exp(const ENGINE *e);
381 BN_MOD_EXP_CRT ENGINE_get_BN_mod_exp_crt(const ENGINE *e);
382 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
383 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
384 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
385 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
386 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
387 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
388 int ENGINE_get_flags(const ENGINE *e);
389 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
391 /* FUNCTIONAL functions. These functions deal with ENGINE structures
392 * that have (or will) be initialised for use. Broadly speaking, the
393 * structural functions are useful for iterating the list of available
394 * engine types, creating new engine types, and other "list" operations.
395 * These functions actually deal with ENGINEs that are to be used. As
396 * such these functions can fail (if applicable) when particular
397 * engines are unavailable - eg. if a hardware accelerator is not
398 * attached or not functioning correctly. Each ENGINE has 2 reference
399 * counts; structural and functional. Every time a functional reference
400 * is obtained or released, a corresponding structural reference is
401 * automatically obtained or released too. */
403 /* Initialise a engine type for use (or up its reference count if it's
404 * already in use). This will fail if the engine is not currently
405 * operational and cannot initialise. */
406 int ENGINE_init(ENGINE *e);
407 /* Free a functional reference to a engine type. This does not require
408 * a corresponding call to ENGINE_free as it also releases a structural
410 int ENGINE_finish(ENGINE *e);
412 /* The following functions handle keys that are stored in some secondary
413 * location, handled by the engine. The storage may be on a card or
415 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
416 const char *passphrase);
417 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
418 const char *passphrase);
420 /* This returns a pointer for the current ENGINE structure that
421 * is (by default) performing any RSA operations. The value returned
422 * is an incremented reference, so it should be free'd (ENGINE_finish)
423 * before it is discarded. */
424 ENGINE *ENGINE_get_default_RSA(void);
425 /* Same for the other "methods" */
426 ENGINE *ENGINE_get_default_DSA(void);
427 ENGINE *ENGINE_get_default_DH(void);
428 ENGINE *ENGINE_get_default_RAND(void);
429 ENGINE *ENGINE_get_default_BN_mod_exp(void);
430 ENGINE *ENGINE_get_default_BN_mod_exp_crt(void);
432 /* This sets a new default ENGINE structure for performing RSA
433 * operations. If the result is non-zero (success) then the ENGINE
434 * structure will have had its reference count up'd so the caller
435 * should still free their own reference 'e'. */
436 int ENGINE_set_default_RSA(ENGINE *e);
437 /* Same for the other "methods" */
438 int ENGINE_set_default_DSA(ENGINE *e);
439 int ENGINE_set_default_DH(ENGINE *e);
440 int ENGINE_set_default_RAND(ENGINE *e);
441 int ENGINE_set_default_BN_mod_exp(ENGINE *e);
442 int ENGINE_set_default_BN_mod_exp_crt(ENGINE *e);
444 /* The combination "set" - the flags are bitwise "OR"d from the
445 * ENGINE_METHOD_*** defines above. */
446 int ENGINE_set_default(ENGINE *e, unsigned int flags);
448 /* Obligatory error function. */
449 void ERR_load_ENGINE_strings(void);
451 /* BEGIN ERROR CODES */
452 /* The following lines are auto generated by the script mkerr.pl. Any changes
453 * made after this point may be overwritten when the script is next run.
455 void ERR_load_ENGINE_strings(void);
457 /* Error codes for the ENGINE functions. */
459 /* Function codes. */
460 #define ENGINE_F_ATALLA_CTRL 173
461 #define ENGINE_F_ATALLA_FINISH 159
462 #define ENGINE_F_ATALLA_INIT 160
463 #define ENGINE_F_ATALLA_MOD_EXP 161
464 #define ENGINE_F_ATALLA_RSA_MOD_EXP 162
465 #define ENGINE_F_CSWIFT_CTRL 174
466 #define ENGINE_F_CSWIFT_DSA_SIGN 133
467 #define ENGINE_F_CSWIFT_DSA_VERIFY 134
468 #define ENGINE_F_CSWIFT_FINISH 100
469 #define ENGINE_F_CSWIFT_INIT 101
470 #define ENGINE_F_CSWIFT_MOD_EXP 102
471 #define ENGINE_F_CSWIFT_MOD_EXP_CRT 103
472 #define ENGINE_F_CSWIFT_RSA_MOD_EXP 104
473 #define ENGINE_F_ENGINE_ADD 105
474 #define ENGINE_F_ENGINE_BY_ID 106
475 #define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE 170
476 #define ENGINE_F_ENGINE_CTRL 142
477 #define ENGINE_F_ENGINE_CTRL_CMD_STRING 171
478 #define ENGINE_F_ENGINE_FINISH 107
479 #define ENGINE_F_ENGINE_FREE 108
480 #define ENGINE_F_ENGINE_GET_DEFAULT_TYPE 177
481 #define ENGINE_F_ENGINE_GET_NEXT 115
482 #define ENGINE_F_ENGINE_GET_PREV 116
483 #define ENGINE_F_ENGINE_INIT 119
484 #define ENGINE_F_ENGINE_LIST_ADD 120
485 #define ENGINE_F_ENGINE_LIST_REMOVE 121
486 #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150
487 #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151
488 #define ENGINE_F_ENGINE_NEW 122
489 #define ENGINE_F_ENGINE_REMOVE 123
490 #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE 126
491 #define ENGINE_F_ENGINE_SET_ID 129
492 #define ENGINE_F_ENGINE_SET_NAME 130
493 #define ENGINE_F_ENGINE_UNLOAD_KEY 152
494 #define ENGINE_F_HWCRHK_CTRL 143
495 #define ENGINE_F_HWCRHK_FINISH 135
496 #define ENGINE_F_HWCRHK_GET_PASS 155
497 #define ENGINE_F_HWCRHK_INIT 136
498 #define ENGINE_F_HWCRHK_LOAD_PRIVKEY 153
499 #define ENGINE_F_HWCRHK_LOAD_PUBKEY 154
500 #define ENGINE_F_HWCRHK_MOD_EXP 137
501 #define ENGINE_F_HWCRHK_MOD_EXP_CRT 138
502 #define ENGINE_F_HWCRHK_RAND_BYTES 139
503 #define ENGINE_F_HWCRHK_RSA_MOD_EXP 140
504 #define ENGINE_F_INT_CTRL_HELPER 172
505 #define ENGINE_F_LOG_MESSAGE 141
506 #define ENGINE_F_NURON_CTRL 175
507 #define ENGINE_F_NURON_FINISH 157
508 #define ENGINE_F_NURON_INIT 156
509 #define ENGINE_F_NURON_MOD_EXP 158
510 #define ENGINE_F_UBSEC_CTRL 176
511 #define ENGINE_F_UBSEC_DSA_SIGN 163
512 #define ENGINE_F_UBSEC_DSA_VERIFY 164
513 #define ENGINE_F_UBSEC_FINISH 165
514 #define ENGINE_F_UBSEC_INIT 166
515 #define ENGINE_F_UBSEC_MOD_EXP 167
516 #define ENGINE_F_UBSEC_RSA_MOD_EXP 168
517 #define ENGINE_F_UBSEC_RSA_MOD_EXP_CRT 169
520 #define ENGINE_R_ALREADY_LOADED 100
521 #define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER 133
522 #define ENGINE_R_BIO_WAS_FREED 121
523 #define ENGINE_R_BN_CTX_FULL 101
524 #define ENGINE_R_BN_EXPAND_FAIL 102
525 #define ENGINE_R_CHIL_ERROR 123
526 #define ENGINE_R_CMD_NOT_EXECUTABLE 134
527 #define ENGINE_R_COMMAND_TAKES_INPUT 135
528 #define ENGINE_R_COMMAND_TAKES_NO_INPUT 136
529 #define ENGINE_R_CONFLICTING_ENGINE_ID 103
530 #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119
531 #define ENGINE_R_DH_NOT_IMPLEMENTED 139
532 #define ENGINE_R_DSA_NOT_IMPLEMENTED 140
533 #define ENGINE_R_DSO_FAILURE 104
534 #define ENGINE_R_DSO_FUNCTION_NOT_FOUND 131
535 #define ENGINE_R_DSO_NOT_FOUND 132
536 #define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105
537 #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128
538 #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129
539 #define ENGINE_R_FINISH_FAILED 106
540 #define ENGINE_R_GET_HANDLE_FAILED 107
541 #define ENGINE_R_ID_OR_NAME_MISSING 108
542 #define ENGINE_R_INIT_FAILED 109
543 #define ENGINE_R_INTERNAL_LIST_ERROR 110
544 #define ENGINE_R_INVALID_CMD_NAME 137
545 #define ENGINE_R_INVALID_CMD_NUMBER 138
546 #define ENGINE_R_MISSING_KEY_COMPONENTS 111
547 #define ENGINE_R_NOT_INITIALISED 117
548 #define ENGINE_R_NOT_LOADED 112
549 #define ENGINE_R_NO_CALLBACK 127
550 #define ENGINE_R_NO_CONTROL_FUNCTION 120
551 #define ENGINE_R_NO_KEY 124
552 #define ENGINE_R_NO_LOAD_FUNCTION 125
553 #define ENGINE_R_NO_REFERENCE 130
554 #define ENGINE_R_NO_SUCH_ENGINE 116
555 #define ENGINE_R_NO_UNLOAD_FUNCTION 126
556 #define ENGINE_R_PRIVATE_KEY_ALGORITHMS_DISABLED 142
557 #define ENGINE_R_PROVIDE_PARAMETERS 113
558 #define ENGINE_R_REQUEST_FAILED 114
559 #define ENGINE_R_REQUEST_FALLBACK 118
560 #define ENGINE_R_RSA_NOT_IMPLEMENTED 141
561 #define ENGINE_R_SIZE_TOO_LARGE_OR_TOO_SMALL 122
562 #define ENGINE_R_UNIT_FAILURE 115