00001 /* openssl/engine.h */ 00002 /* Written by Geoff Thorpe ([email protected]) for the OpenSSL 00003 * project 2000. 00004 */ 00005 /* ==================================================================== 00006 * Copyright (c) 1999-2004 The OpenSSL Project. All rights reserved. 00007 * 00008 * Redistribution and use in source and binary forms, with or without 00009 * modification, are permitted provided that the following conditions 00010 * are met: 00011 * 00012 * 1. Redistributions of source code must retain the above copyright 00013 * notice, this list of conditions and the following disclaimer. 00014 * 00015 * 2. Redistributions in binary form must reproduce the above copyright 00016 * notice, this list of conditions and the following disclaimer in 00017 * the documentation and/or other materials provided with the 00018 * distribution. 00019 * 00020 * 3. All advertising materials mentioning features or use of this 00021 * software must display the following acknowledgment: 00022 * "This product includes software developed by the OpenSSL Project 00023 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 00024 * 00025 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 00026 * endorse or promote products derived from this software without 00027 * prior written permission. For written permission, please contact 00028 * [email protected] 00029 * 00030 * 5. Products derived from this software may not be called "OpenSSL" 00031 * nor may "OpenSSL" appear in their names without prior written 00032 * permission of the OpenSSL Project. 00033 * 00034 * 6. Redistributions of any form whatsoever must retain the following 00035 * acknowledgment: 00036 * "This product includes software developed by the OpenSSL Project 00037 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 00038 * 00039 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 00040 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00041 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00042 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 00043 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00044 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 00045 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 00046 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 00047 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 00048 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00049 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 00050 * OF THE POSSIBILITY OF SUCH DAMAGE. 00051 * ==================================================================== 00052 * 00053 * This product includes cryptographic software written by Eric Young 00054 * ([email protected]). This product includes software written by Tim 00055 * Hudson ([email protected]). 00056 * 00057 */ 00058 /* ==================================================================== 00059 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. 00060 * ECDH support in OpenSSL originally developed by 00061 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project. 00062 */ 00063 00064 #ifndef HEADER_ENGINE_H 00065 #define HEADER_ENGINE_H 00066 00067 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN)) 00068 #define SYMBIAN 00069 #endif 00070 00071 #include <openssl/opensslconf.h> 00072 00073 #ifdef OPENSSL_NO_ENGINE 00074 #error ENGINE is disabled. 00075 #endif 00076 00077 #ifndef OPENSSL_NO_DEPRECATED 00078 #include <openssl/bn.h> 00079 #ifndef OPENSSL_NO_RSA 00080 #include <openssl/rsa.h> 00081 #endif 00082 #ifndef OPENSSL_NO_DSA 00083 #include <openssl/dsa.h> 00084 #endif 00085 #ifndef OPENSSL_NO_DH 00086 #include <openssl/dh.h> 00087 #endif 00088 #ifndef OPENSSL_NO_ECDH 00089 #include <openssl/ecdh.h> 00090 #endif 00091 #ifndef OPENSSL_NO_ECDSA 00092 #include <openssl/ecdsa.h> 00093 #endif 00094 #include <openssl/rand.h> 00095 #include <openssl/store.h> 00096 #include <openssl/ui.h> 00097 #include <openssl/err.h> 00098 #endif 00099 00100 #include <openssl/ossl_typ.h> 00101 #include <openssl/symhacks.h> 00102 00103 #ifdef __cplusplus 00104 extern "C" { 00105 #endif 00106 00107 /* These flags are used to control combinations of algorithm (methods) 00108 * by bitwise "OR"ing. */ 00109 #define ENGINE_METHOD_RSA (unsigned int)0x0001 00110 #define ENGINE_METHOD_DSA (unsigned int)0x0002 00111 #define ENGINE_METHOD_DH (unsigned int)0x0004 00112 #define ENGINE_METHOD_RAND (unsigned int)0x0008 00113 #define ENGINE_METHOD_ECDH (unsigned int)0x0010 00114 #define ENGINE_METHOD_ECDSA (unsigned int)0x0020 00115 #define ENGINE_METHOD_CIPHERS (unsigned int)0x0040 00116 #define ENGINE_METHOD_DIGESTS (unsigned int)0x0080 00117 #define ENGINE_METHOD_STORE (unsigned int)0x0100 00118 /* Obvious all-or-nothing cases. */ 00119 #define ENGINE_METHOD_ALL (unsigned int)0xFFFF 00120 #define ENGINE_METHOD_NONE (unsigned int)0x0000 00121 00122 /* This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used 00123 * internally to control registration of ENGINE implementations, and can be set 00124 * by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to 00125 * initialise registered ENGINEs if they are not already initialised. */ 00126 #define ENGINE_TABLE_FLAG_NOINIT (unsigned int)0x0001 00127 00128 /* ENGINE flags that can be set by ENGINE_set_flags(). */ 00129 /* #define ENGINE_FLAGS_MALLOCED 0x0001 */ /* Not used */ 00130 00131 /* This flag is for ENGINEs that wish to handle the various 'CMD'-related 00132 * control commands on their own. Without this flag, ENGINE_ctrl() handles these 00133 * control commands on behalf of the ENGINE using their "cmd_defns" data. */ 00134 #define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002 00135 00136 /* This flag is for ENGINEs who return new duplicate structures when found via 00137 * "ENGINE_by_id()". When an ENGINE must store state (eg. if ENGINE_ctrl() 00138 * commands are called in sequence as part of some stateful process like 00139 * key-generation setup and execution), it can set this flag - then each attempt 00140 * to obtain the ENGINE will result in it being copied into a new structure. 00141 * Normally, ENGINEs don't declare this flag so ENGINE_by_id() just increments 00142 * the existing ENGINE's structural reference count. */ 00143 #define ENGINE_FLAGS_BY_ID_COPY (int)0x0004 00144 00145 /* ENGINEs can support their own command types, and these flags are used in 00146 * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input each 00147 * command expects. Currently only numeric and string input is supported. If a 00148 * control command supports none of the _NUMERIC, _STRING, or _NO_INPUT options, 00149 * then it is regarded as an "internal" control command - and not for use in 00150 * config setting situations. As such, they're not available to the 00151 * ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() access. Changes to 00152 * this list of 'command types' should be reflected carefully in 00153 * ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). */ 00154 00155 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */ 00156 #define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001 00157 /* accepts string input (cast from 'void*' to 'const char *', 4th parameter to 00158 * ENGINE_ctrl) */ 00159 #define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002 00160 /* Indicates that the control command takes *no* input. Ie. the control command 00161 * is unparameterised. */ 00162 #define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004 00163 /* Indicates that the control command is internal. This control command won't 00164 * be shown in any output, and is only usable through the ENGINE_ctrl_cmd() 00165 * function. */ 00166 #define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008 00167 00168 /* NB: These 3 control commands are deprecated and should not be used. ENGINEs 00169 * relying on these commands should compile conditional support for 00170 * compatibility (eg. if these symbols are defined) but should also migrate the 00171 * same functionality to their own ENGINE-specific control functions that can be 00172 * "discovered" by calling applications. The fact these control commands 00173 * wouldn't be "executable" (ie. usable by text-based config) doesn't change the 00174 * fact that application code can find and use them without requiring per-ENGINE 00175 * hacking. */ 00176 00177 /* These flags are used to tell the ctrl function what should be done. 00178 * All command numbers are shared between all engines, even if some don't 00179 * make sense to some engines. In such a case, they do nothing but return 00180 * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */ 00181 #define ENGINE_CTRL_SET_LOGSTREAM 1 00182 #define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2 00183 #define ENGINE_CTRL_HUP 3 /* Close and reinitialise any 00184 handles/connections etc. */ 00185 #define ENGINE_CTRL_SET_USER_INTERFACE 4 /* Alternative to callback */ 00186 #define ENGINE_CTRL_SET_CALLBACK_DATA 5 /* User-specific data, used 00187 when calling the password 00188 callback and the user 00189 interface */ 00190 #define ENGINE_CTRL_LOAD_CONFIGURATION 6 /* Load a configuration, given 00191 a string that represents a 00192 file name or so */ 00193 #define ENGINE_CTRL_LOAD_SECTION 7 /* Load data from a given 00194 section in the already loaded 00195 configuration */ 00196 00197 /* These control commands allow an application to deal with an arbitrary engine 00198 * in a dynamic way. Warn: Negative return values indicate errors FOR THESE 00199 * COMMANDS because zero is used to indicate 'end-of-list'. Other commands, 00200 * including ENGINE-specific command types, return zero for an error. 00201 * 00202 * An ENGINE can choose to implement these ctrl functions, and can internally 00203 * manage things however it chooses - it does so by setting the 00204 * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise the 00205 * ENGINE_ctrl() code handles this on the ENGINE's behalf using the cmd_defns 00206 * data (set using ENGINE_set_cmd_defns()). This means an ENGINE's ctrl() 00207 * handler need only implement its own commands - the above "meta" commands will 00208 * be taken care of. */ 00209 00210 /* Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", then 00211 * all the remaining control commands will return failure, so it is worth 00212 * checking this first if the caller is trying to "discover" the engine's 00213 * capabilities and doesn't want errors generated unnecessarily. */ 00214 #define ENGINE_CTRL_HAS_CTRL_FUNCTION 10 00215 /* Returns a positive command number for the first command supported by the 00216 * engine. Returns zero if no ctrl commands are supported. */ 00217 #define ENGINE_CTRL_GET_FIRST_CMD_TYPE 11 00218 /* The 'long' argument specifies a command implemented by the engine, and the 00219 * return value is the next command supported, or zero if there are no more. */ 00220 #define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12 00221 /* The 'void*' argument is a command name (cast from 'const char *'), and the 00222 * return value is the command that corresponds to it. */ 00223 #define ENGINE_CTRL_GET_CMD_FROM_NAME 13 00224 /* The next two allow a command to be converted into its corresponding string 00225 * form. In each case, the 'long' argument supplies the command. In the NAME_LEN 00226 * case, the return value is the length of the command name (not counting a 00227 * trailing EOL). In the NAME case, the 'void*' argument must be a string buffer 00228 * large enough, and it will be populated with the name of the command (WITH a 00229 * trailing EOL). */ 00230 #define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14 00231 #define ENGINE_CTRL_GET_NAME_FROM_CMD 15 00232 /* The next two are similar but give a "short description" of a command. */ 00233 #define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16 00234 #define ENGINE_CTRL_GET_DESC_FROM_CMD 17 00235 /* With this command, the return value is the OR'd combination of 00236 * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given 00237 * engine-specific ctrl command expects. */ 00238 #define ENGINE_CTRL_GET_CMD_FLAGS 18 00239 00240 /* ENGINE implementations should start the numbering of their own control 00241 * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). */ 00242 #define ENGINE_CMD_BASE 200 00243 00244 /* NB: These 2 nCipher "chil" control commands are deprecated, and their 00245 * functionality is now available through ENGINE-specific control commands 00246 * (exposed through the above-mentioned 'CMD'-handling). Code using these 2 00247 * commands should be migrated to the more general command handling before these 00248 * are removed. */ 00249 00250 /* Flags specific to the nCipher "chil" engine */ 00251 #define ENGINE_CTRL_CHIL_SET_FORKCHECK 100 00252 /* Depending on the value of the (long)i argument, this sets or 00253 * unsets the SimpleForkCheck flag in the CHIL API to enable or 00254 * disable checking and workarounds for applications that fork(). 00255 */ 00256 #define ENGINE_CTRL_CHIL_NO_LOCKING 101 00257 /* This prevents the initialisation function from providing mutex 00258 * callbacks to the nCipher library. */ 00259 00260 /* If an ENGINE supports its own specific control commands and wishes the 00261 * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on its 00262 * behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN entries 00263 * to ENGINE_set_cmd_defns(). It should also implement a ctrl() handler that 00264 * supports the stated commands (ie. the "cmd_num" entries as described by the 00265 * array). NB: The array must be ordered in increasing order of cmd_num. 00266 * "null-terminated" means that the last ENGINE_CMD_DEFN element has cmd_num set 00267 * to zero and/or cmd_name set to NULL. */ 00268 typedef struct ENGINE_CMD_DEFN_st 00269 { 00270 unsigned int cmd_num; /* The command number */ 00271 const char *cmd_name; /* The command name itself */ 00272 const char *cmd_desc; /* A short description of the command */ 00273 unsigned int cmd_flags; /* The input the command expects */ 00274 } ENGINE_CMD_DEFN; 00275 00276 /* Generic function pointer */ 00277 typedef int (*ENGINE_GEN_FUNC_PTR)(void); 00278 /* Generic function pointer taking no arguments */ 00279 typedef int (*ENGINE_GEN_INT_FUNC_PTR)(ENGINE *); 00280 /* Specific control function pointer */ 00281 typedef int (*ENGINE_CTRL_FUNC_PTR)(ENGINE *, int, long, void *, void (*f)(void)); 00282 /* Generic load_key function pointer */ 00283 typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *, 00284 UI_METHOD *ui_method, void *callback_data); 00285 /* These callback types are for an ENGINE's handler for cipher and digest logic. 00286 * These handlers have these prototypes; 00287 * int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid); 00288 * int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid); 00289 * Looking at how to implement these handlers in the case of cipher support, if 00290 * the framework wants the EVP_CIPHER for 'nid', it will call; 00291 * foo(e, &p_evp_cipher, NULL, nid); (return zero for failure) 00292 * If the framework wants a list of supported 'nid's, it will call; 00293 * foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error) 00294 */ 00295 /* Returns to a pointer to the array of supported cipher 'nid's. If the second 00296 * parameter is non-NULL it is set to the size of the returned array. */ 00297 typedef int (*ENGINE_CIPHERS_PTR)(ENGINE *, const EVP_CIPHER **, const int **, int); 00298 typedef int (*ENGINE_DIGESTS_PTR)(ENGINE *, const EVP_MD **, const int **, int); 00299 00300 /* STRUCTURE functions ... all of these functions deal with pointers to ENGINE 00301 * structures where the pointers have a "structural reference". This means that 00302 * their reference is to allowed access to the structure but it does not imply 00303 * that the structure is functional. To simply increment or decrement the 00304 * structural reference count, use ENGINE_by_id and ENGINE_free. NB: This is not 00305 * required when iterating using ENGINE_get_next as it will automatically 00306 * decrement the structural reference count of the "current" ENGINE and 00307 * increment the structural reference count of the ENGINE it returns (unless it 00308 * is NULL). */ 00309 00310 /* Get the first/last "ENGINE" type available. */ 00311 IMPORT_C ENGINE *ENGINE_get_first(void); 00312 IMPORT_C ENGINE *ENGINE_get_last(void); 00313 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */ 00314 IMPORT_C ENGINE *ENGINE_get_next(ENGINE *e); 00315 IMPORT_C ENGINE *ENGINE_get_prev(ENGINE *e); 00316 /* Add another "ENGINE" type into the array. */ 00317 IMPORT_C int ENGINE_add(ENGINE *e); 00318 /* Remove an existing "ENGINE" type from the array. */ 00319 IMPORT_C int ENGINE_remove(ENGINE *e); 00320 /* Retrieve an engine from the list by its unique "id" value. */ 00321 IMPORT_C ENGINE *ENGINE_by_id(const char *id); 00322 /* Add all the built-in engines. */ 00323 IMPORT_C void ENGINE_load_openssl(void); 00324 IMPORT_C void ENGINE_load_dynamic(void); 00325 #ifndef OPENSSL_NO_STATIC_ENGINE 00326 #ifndef OPENSSL_NO_GMP 00327 void ENGINE_load_gmp(void); 00328 #endif 00329 #endif 00330 IMPORT_C void ENGINE_load_cryptodev(void); 00331 IMPORT_C void ENGINE_load_builtin_engines(void); 00332 00333 /* Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation 00334 * "registry" handling. */ 00335 IMPORT_C unsigned int ENGINE_get_table_flags(void); 00336 IMPORT_C void ENGINE_set_table_flags(unsigned int flags); 00337 00338 /* Manage registration of ENGINEs per "table". For each type, there are 3 00339 * functions; 00340 * ENGINE_register_***(e) - registers the implementation from 'e' (if it has one) 00341 * ENGINE_unregister_***(e) - unregister the implementation from 'e' 00342 * ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list 00343 * Cleanup is automatically registered from each table when required, so 00344 * ENGINE_cleanup() will reverse any "register" operations. */ 00345 00346 IMPORT_C int ENGINE_register_RSA(ENGINE *e); 00347 IMPORT_C void ENGINE_unregister_RSA(ENGINE *e); 00348 IMPORT_C void ENGINE_register_all_RSA(void); 00349 00350 IMPORT_C int ENGINE_register_DSA(ENGINE *e); 00351 IMPORT_C void ENGINE_unregister_DSA(ENGINE *e); 00352 IMPORT_C void ENGINE_register_all_DSA(void); 00353 00354 00355 IMPORT_C int ENGINE_register_DH(ENGINE *e); 00356 IMPORT_C void ENGINE_unregister_DH(ENGINE *e); 00357 IMPORT_C void ENGINE_register_all_DH(void); 00358 00359 IMPORT_C int ENGINE_register_RAND(ENGINE *e); 00360 IMPORT_C void ENGINE_unregister_RAND(ENGINE *e); 00361 IMPORT_C void ENGINE_register_all_RAND(void); 00362 00363 IMPORT_C int ENGINE_register_STORE(ENGINE *e); 00364 IMPORT_C void ENGINE_unregister_STORE(ENGINE *e); 00365 IMPORT_C void ENGINE_register_all_STORE(void); 00366 00367 IMPORT_C int ENGINE_register_ciphers(ENGINE *e); 00368 IMPORT_C void ENGINE_unregister_ciphers(ENGINE *e); 00369 IMPORT_C void ENGINE_register_all_ciphers(void); 00370 00371 IMPORT_C int ENGINE_register_digests(ENGINE *e); 00372 IMPORT_C void ENGINE_unregister_digests(ENGINE *e); 00373 IMPORT_C void ENGINE_register_all_digests(void); 00374 00375 /* These functions register all support from the above categories. Note, use of 00376 * these functions can result in static linkage of code your application may not 00377 * need. If you only need a subset of functionality, consider using more 00378 * selective initialisation. */ 00379 IMPORT_C int ENGINE_register_complete(ENGINE *e); 00380 IMPORT_C int ENGINE_register_all_complete(void); 00381 00382 /* Send parametrised control commands to the engine. The possibilities to send 00383 * down an integer, a pointer to data or a function pointer are provided. Any of 00384 * the parameters may or may not be NULL, depending on the command number. In 00385 * actuality, this function only requires a structural (rather than functional) 00386 * reference to an engine, but many control commands may require the engine be 00387 * functional. The caller should be aware of trying commands that require an 00388 * operational ENGINE, and only use functional references in such situations. */ 00389 IMPORT_C int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void)); 00390 00391 /* This function tests if an ENGINE-specific command is usable as a "setting". 00392 * Eg. in an application's config file that gets processed through 00393 * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to 00394 * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). */ 00395 IMPORT_C int ENGINE_cmd_is_executable(ENGINE *e, int cmd); 00396 00397 /* This function works like ENGINE_ctrl() with the exception of taking a 00398 * command name instead of a command number, and can handle optional commands. 00399 * See the comment on ENGINE_ctrl_cmd_string() for an explanation on how to 00400 * use the cmd_name and cmd_optional. */ 00401 IMPORT_C int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name, 00402 long i, void *p, void (*f)(void), int cmd_optional); 00403 00404 /* This function passes a command-name and argument to an ENGINE. The cmd_name 00405 * is converted to a command number and the control command is called using 00406 * 'arg' as an argument (unless the ENGINE doesn't support such a command, in 00407 * which case no control command is called). The command is checked for input 00408 * flags, and if necessary the argument will be converted to a numeric value. If 00409 * cmd_optional is non-zero, then if the ENGINE doesn't support the given 00410 * cmd_name the return value will be success anyway. This function is intended 00411 * for applications to use so that users (or config files) can supply 00412 * engine-specific config data to the ENGINE at run-time to control behaviour of 00413 * specific engines. As such, it shouldn't be used for calling ENGINE_ctrl() 00414 * functions that return data, deal with binary data, or that are otherwise 00415 * supposed to be used directly through ENGINE_ctrl() in application code. Any 00416 * "return" data from an ENGINE_ctrl() operation in this function will be lost - 00417 * the return value is interpreted as failure if the return value is zero, 00418 * success otherwise, and this function returns a boolean value as a result. In 00419 * other words, vendors of 'ENGINE'-enabled devices should write ENGINE 00420 * implementations with parameterisations that work in this scheme, so that 00421 * compliant ENGINE-based applications can work consistently with the same 00422 * configuration for the same ENGINE-enabled devices, across applications. */ 00423 IMPORT_C int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg, 00424 int cmd_optional); 00425 00426 /* These functions are useful for manufacturing new ENGINE structures. They 00427 * don't address reference counting at all - one uses them to populate an ENGINE 00428 * structure with personalised implementations of things prior to using it 00429 * directly or adding it to the builtin ENGINE list in OpenSSL. These are also 00430 * here so that the ENGINE structure doesn't have to be exposed and break binary 00431 * compatibility! */ 00432 IMPORT_C ENGINE *ENGINE_new(void); 00433 IMPORT_C int ENGINE_free(ENGINE *e); 00434 IMPORT_C int ENGINE_up_ref(ENGINE *e); 00435 IMPORT_C int ENGINE_set_id(ENGINE *e, const char *id); 00436 IMPORT_C int ENGINE_set_name(ENGINE *e, const char *name); 00437 IMPORT_C int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth); 00438 IMPORT_C int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth); 00439 IMPORT_C int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth); 00440 IMPORT_C int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth); 00441 IMPORT_C int ENGINE_set_STORE(ENGINE *e, const STORE_METHOD *store_meth); 00442 IMPORT_C int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f); 00443 IMPORT_C int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f); 00444 IMPORT_C int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f); 00445 IMPORT_C int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f); 00446 IMPORT_C int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f); 00447 IMPORT_C int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f); 00448 IMPORT_C int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f); 00449 IMPORT_C int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f); 00450 IMPORT_C int ENGINE_set_flags(ENGINE *e, int flags); 00451 IMPORT_C int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns); 00452 /* These functions allow control over any per-structure ENGINE data. */ 00453 IMPORT_C int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 00454 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 00455 IMPORT_C int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg); 00456 IMPORT_C void *ENGINE_get_ex_data(const ENGINE *e, int idx); 00457 00458 /* This function cleans up anything that needs it. Eg. the ENGINE_add() function 00459 * automatically ensures the list cleanup function is registered to be called 00460 * from ENGINE_cleanup(). Similarly, all ENGINE_register_*** functions ensure 00461 * ENGINE_cleanup() will clean up after them. */ 00462 IMPORT_C void ENGINE_cleanup(void); 00463 00464 /* These return values from within the ENGINE structure. These can be useful 00465 * with functional references as well as structural references - it depends 00466 * which you obtained. Using the result for functional purposes if you only 00467 * obtained a structural reference may be problematic! */ 00468 IMPORT_C const char *ENGINE_get_id(const ENGINE *e); 00469 IMPORT_C const char *ENGINE_get_name(const ENGINE *e); 00470 IMPORT_C const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e); 00471 IMPORT_C const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e); 00472 IMPORT_C const DH_METHOD *ENGINE_get_DH(const ENGINE *e); 00473 IMPORT_C const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e); 00474 IMPORT_C const STORE_METHOD *ENGINE_get_STORE(const ENGINE *e); 00475 IMPORT_C ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e); 00476 IMPORT_C ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e); 00477 IMPORT_C ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e); 00478 IMPORT_C ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e); 00479 IMPORT_C ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e); 00480 IMPORT_C ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e); 00481 IMPORT_C ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e); 00482 IMPORT_C ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e); 00483 IMPORT_C const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid); 00484 IMPORT_C const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid); 00485 IMPORT_C const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e); 00486 IMPORT_C int ENGINE_get_flags(const ENGINE *e); 00487 00488 /* FUNCTIONAL functions. These functions deal with ENGINE structures 00489 * that have (or will) be initialised for use. Broadly speaking, the 00490 * structural functions are useful for iterating the list of available 00491 * engine types, creating new engine types, and other "list" operations. 00492 * These functions actually deal with ENGINEs that are to be used. As 00493 * such these functions can fail (if applicable) when particular 00494 * engines are unavailable - eg. if a hardware accelerator is not 00495 * attached or not functioning correctly. Each ENGINE has 2 reference 00496 * counts; structural and functional. Every time a functional reference 00497 * is obtained or released, a corresponding structural reference is 00498 * automatically obtained or released too. */ 00499 00500 /* Initialise a engine type for use (or up its reference count if it's 00501 * already in use). This will fail if the engine is not currently 00502 * operational and cannot initialise. */ 00503 IMPORT_C int ENGINE_init(ENGINE *e); 00504 /* Free a functional reference to a engine type. This does not require 00505 * a corresponding call to ENGINE_free as it also releases a structural 00506 * reference. */ 00507 IMPORT_C int ENGINE_finish(ENGINE *e); 00508 00509 /* The following functions handle keys that are stored in some secondary 00510 * location, handled by the engine. The storage may be on a card or 00511 * whatever. */ 00512 IMPORT_C EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id, 00513 UI_METHOD *ui_method, void *callback_data); 00514 IMPORT_C EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id, 00515 UI_METHOD *ui_method, void *callback_data); 00516 00517 /* This returns a pointer for the current ENGINE structure that 00518 * is (by default) performing any RSA operations. The value returned 00519 * is an incremented reference, so it should be free'd (ENGINE_finish) 00520 * before it is discarded. */ 00521 IMPORT_C ENGINE *ENGINE_get_default_RSA(void); 00522 /* Same for the other "methods" */ 00523 IMPORT_C ENGINE *ENGINE_get_default_DSA(void); 00524 IMPORT_C ENGINE *ENGINE_get_default_DH(void); 00525 IMPORT_C ENGINE *ENGINE_get_default_RAND(void); 00526 /* These functions can be used to get a functional reference to perform 00527 * ciphering or digesting corresponding to "nid". */ 00528 IMPORT_C ENGINE *ENGINE_get_cipher_engine(int nid); 00529 IMPORT_C ENGINE *ENGINE_get_digest_engine(int nid); 00530 00531 /* This sets a new default ENGINE structure for performing RSA 00532 * operations. If the result is non-zero (success) then the ENGINE 00533 * structure will have had its reference count up'd so the caller 00534 * should still free their own reference 'e'. */ 00535 IMPORT_C int ENGINE_set_default_RSA(ENGINE *e); 00536 IMPORT_C int ENGINE_set_default_string(ENGINE *e, const char *def_list); 00537 /* Same for the other "methods" */ 00538 IMPORT_C int ENGINE_set_default_DSA(ENGINE *e); 00539 int ENGINE_set_default_ECDH(ENGINE *e); 00540 int ENGINE_set_default_ECDSA(ENGINE *e); 00541 IMPORT_C int ENGINE_set_default_DH(ENGINE *e); 00542 IMPORT_C int ENGINE_set_default_RAND(ENGINE *e); 00543 IMPORT_C int ENGINE_set_default_ciphers(ENGINE *e); 00544 IMPORT_C int ENGINE_set_default_digests(ENGINE *e); 00545 00546 /* The combination "set" - the flags are bitwise "OR"d from the 00547 * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()" 00548 * function, this function can result in unnecessary static linkage. If your 00549 * application requires only specific functionality, consider using more 00550 * selective functions. */ 00551 IMPORT_C int ENGINE_set_default(ENGINE *e, unsigned int flags); 00552 00553 IMPORT_C void ENGINE_add_conf_module(void); 00554 00555 /* Deprecated functions ... */ 00556 /* int ENGINE_clear_defaults(void); */ 00557 00558 /**************************/ 00559 /* DYNAMIC ENGINE SUPPORT */ 00560 /**************************/ 00561 00562 /* Binary/behaviour compatibility levels */ 00563 #define OSSL_DYNAMIC_VERSION (unsigned long)0x00020000 00564 /* Binary versions older than this are too old for us (whether we're a loader or 00565 * a loadee) */ 00566 #define OSSL_DYNAMIC_OLDEST (unsigned long)0x00020000 00567 00568 /* When compiling an ENGINE entirely as an external shared library, loadable by 00569 * the "dynamic" ENGINE, these types are needed. The 'dynamic_fns' structure 00570 * type provides the calling application's (or library's) error functionality 00571 * and memory management function pointers to the loaded library. These should 00572 * be used/set in the loaded library code so that the loading application's 00573 * 'state' will be used/changed in all operations. The 'static_state' pointer 00574 * allows the loaded library to know if it shares the same static data as the 00575 * calling application (or library), and thus whether these callbacks need to be 00576 * set or not. */ 00577 typedef void *(*dyn_MEM_malloc_cb)(size_t); 00578 typedef void *(*dyn_MEM_realloc_cb)(void *, size_t); 00579 typedef void (*dyn_MEM_free_cb)(void *); 00580 typedef struct st_dynamic_MEM_fns { 00581 dyn_MEM_malloc_cb malloc_cb; 00582 dyn_MEM_realloc_cb realloc_cb; 00583 dyn_MEM_free_cb free_cb; 00584 } dynamic_MEM_fns; 00585 /* FIXME: Perhaps the memory and locking code (crypto.h) should declare and use 00586 * these types so we (and any other dependant code) can simplify a bit?? */ 00587 typedef void (*dyn_lock_locking_cb)(int,int,const char *,int); 00588 typedef int (*dyn_lock_add_lock_cb)(int*,int,int,const char *,int); 00589 typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb)( 00590 const char *,int); 00591 typedef void (*dyn_dynlock_lock_cb)(int,struct CRYPTO_dynlock_value *, 00592 const char *,int); 00593 typedef void (*dyn_dynlock_destroy_cb)(struct CRYPTO_dynlock_value *, 00594 const char *,int); 00595 typedef struct st_dynamic_LOCK_fns { 00596 dyn_lock_locking_cb lock_locking_cb; 00597 dyn_lock_add_lock_cb lock_add_lock_cb; 00598 dyn_dynlock_create_cb dynlock_create_cb; 00599 dyn_dynlock_lock_cb dynlock_lock_cb; 00600 dyn_dynlock_destroy_cb dynlock_destroy_cb; 00601 } dynamic_LOCK_fns; 00602 /* The top-level structure */ 00603 typedef struct st_dynamic_fns { 00604 void *static_state; 00605 const ERR_FNS *err_fns; 00606 const CRYPTO_EX_DATA_IMPL *ex_data_fns; 00607 dynamic_MEM_fns mem_fns; 00608 dynamic_LOCK_fns lock_fns; 00609 } dynamic_fns; 00610 00611 /* The version checking function should be of this prototype. NB: The 00612 * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading code. 00613 * If this function returns zero, it indicates a (potential) version 00614 * incompatibility and the loaded library doesn't believe it can proceed. 00615 * Otherwise, the returned value is the (latest) version supported by the 00616 * loading library. The loader may still decide that the loaded code's version 00617 * is unsatisfactory and could veto the load. The function is expected to 00618 * be implemented with the symbol name "v_check", and a default implementation 00619 * can be fully instantiated with IMPLEMENT_DYNAMIC_CHECK_FN(). */ 00620 typedef unsigned long (*dynamic_v_check_fn)(unsigned long ossl_version); 00621 #define IMPLEMENT_DYNAMIC_CHECK_FN() \ 00622 unsigned long v_check(unsigned long v) { \ 00623 if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \ 00624 return 0; } 00625 00626 /* This function is passed the ENGINE structure to initialise with its own 00627 * function and command settings. It should not adjust the structural or 00628 * functional reference counts. If this function returns zero, (a) the load will 00629 * be aborted, (b) the previous ENGINE state will be memcpy'd back onto the 00630 * structure, and (c) the shared library will be unloaded. So implementations 00631 * should do their own internal cleanup in failure circumstances otherwise they 00632 * could leak. The 'id' parameter, if non-NULL, represents the ENGINE id that 00633 * the loader is looking for. If this is NULL, the shared library can choose to 00634 * return failure or to initialise a 'default' ENGINE. If non-NULL, the shared 00635 * library must initialise only an ENGINE matching the passed 'id'. The function 00636 * is expected to be implemented with the symbol name "bind_engine". A standard 00637 * implementation can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where 00638 * the parameter 'fn' is a callback function that populates the ENGINE structure 00639 * and returns an int value (zero for failure). 'fn' should have prototype; 00640 * [static] int fn(ENGINE *e, const char *id); */ 00641 typedef int (*dynamic_bind_engine)(ENGINE *e, const char *id, 00642 const dynamic_fns *fns); 00643 #define IMPLEMENT_DYNAMIC_BIND_FN(fn) \ 00644 int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \ 00645 if(ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \ 00646 if(!CRYPTO_set_mem_functions(fns->mem_fns.malloc_cb, \ 00647 fns->mem_fns.realloc_cb, fns->mem_fns.free_cb)) \ 00648 return 0; \ 00649 CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \ 00650 CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \ 00651 CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \ 00652 CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \ 00653 CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \ 00654 if(!CRYPTO_set_ex_data_implementation(fns->ex_data_fns)) \ 00655 return 0; \ 00656 if(!ERR_set_implementation(fns->err_fns)) return 0; \ 00657 skip_cbs: \ 00658 if(!fn(e,id)) return 0; \ 00659 return 1; } 00660 00661 /* If the loading application (or library) and the loaded ENGINE library share 00662 * the same static data (eg. they're both dynamically linked to the same 00663 * libcrypto.so) we need a way to avoid trying to set system callbacks - this 00664 * would fail, and for the same reason that it's unnecessary to try. If the 00665 * loaded ENGINE has (or gets from through the loader) its own copy of the 00666 * libcrypto static data, we will need to set the callbacks. The easiest way to 00667 * detect this is to have a function that returns a pointer to some static data 00668 * and let the loading application and loaded ENGINE compare their respective 00669 * values. */ 00670 IMPORT_C void *ENGINE_get_static_state(void); 00671 00672 00673 /* BEGIN ERROR CODES */ 00674 /* The following lines are auto generated by the script mkerr.pl. Any changes 00675 * made after this point may be overwritten when the script is next run. 00676 */ 00677 IMPORT_C void ERR_load_ENGINE_strings(void); 00678 00679 /* Error codes for the ENGINE functions. */ 00680 00681 /* Function codes. */ 00682 #define ENGINE_F_DYNAMIC_CTRL 180 00683 #define ENGINE_F_DYNAMIC_GET_DATA_CTX 181 00684 #define ENGINE_F_DYNAMIC_LOAD 182 00685 #define ENGINE_F_DYNAMIC_SET_DATA_CTX 183 00686 #define ENGINE_F_ENGINE_ADD 105 00687 #define ENGINE_F_ENGINE_BY_ID 106 00688 #define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE 170 00689 #define ENGINE_F_ENGINE_CTRL 142 00690 #define ENGINE_F_ENGINE_CTRL_CMD 178 00691 #define ENGINE_F_ENGINE_CTRL_CMD_STRING 171 00692 #define ENGINE_F_ENGINE_FINISH 107 00693 #define ENGINE_F_ENGINE_FREE_UTIL 108 00694 #define ENGINE_F_ENGINE_GET_CIPHER 185 00695 #define ENGINE_F_ENGINE_GET_DEFAULT_TYPE 177 00696 #define ENGINE_F_ENGINE_GET_DIGEST 186 00697 #define ENGINE_F_ENGINE_GET_NEXT 115 00698 #define ENGINE_F_ENGINE_GET_PREV 116 00699 #define ENGINE_F_ENGINE_INIT 119 00700 #define ENGINE_F_ENGINE_LIST_ADD 120 00701 #define ENGINE_F_ENGINE_LIST_REMOVE 121 00702 #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150 00703 #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151 00704 #define ENGINE_F_ENGINE_NEW 122 00705 #define ENGINE_F_ENGINE_REMOVE 123 00706 #define ENGINE_F_ENGINE_SET_DEFAULT_STRING 189 00707 #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE 126 00708 #define ENGINE_F_ENGINE_SET_ID 129 00709 #define ENGINE_F_ENGINE_SET_NAME 130 00710 #define ENGINE_F_ENGINE_TABLE_REGISTER 184 00711 #define ENGINE_F_ENGINE_UNLOAD_KEY 152 00712 #define ENGINE_F_ENGINE_UNLOCKED_FINISH 191 00713 #define ENGINE_F_ENGINE_UP_REF 190 00714 #define ENGINE_F_INT_CTRL_HELPER 172 00715 #define ENGINE_F_INT_ENGINE_CONFIGURE 188 00716 #define ENGINE_F_INT_ENGINE_MODULE_INIT 187 00717 #define ENGINE_F_LOG_MESSAGE 141 00718 00719 /* Reason codes. */ 00720 #define ENGINE_R_ALREADY_LOADED 100 00721 #define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER 133 00722 #define ENGINE_R_CMD_NOT_EXECUTABLE 134 00723 #define ENGINE_R_COMMAND_TAKES_INPUT 135 00724 #define ENGINE_R_COMMAND_TAKES_NO_INPUT 136 00725 #define ENGINE_R_CONFLICTING_ENGINE_ID 103 00726 #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119 00727 #define ENGINE_R_DH_NOT_IMPLEMENTED 139 00728 #define ENGINE_R_DSA_NOT_IMPLEMENTED 140 00729 #define ENGINE_R_DSO_FAILURE 104 00730 #define ENGINE_R_DSO_NOT_FOUND 132 00731 #define ENGINE_R_ENGINES_SECTION_ERROR 148 00732 #define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105 00733 #define ENGINE_R_ENGINE_SECTION_ERROR 149 00734 #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128 00735 #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129 00736 #define ENGINE_R_FINISH_FAILED 106 00737 #define ENGINE_R_GET_HANDLE_FAILED 107 00738 #define ENGINE_R_ID_OR_NAME_MISSING 108 00739 #define ENGINE_R_INIT_FAILED 109 00740 #define ENGINE_R_INTERNAL_LIST_ERROR 110 00741 #define ENGINE_R_INVALID_ARGUMENT 143 00742 #define ENGINE_R_INVALID_CMD_NAME 137 00743 #define ENGINE_R_INVALID_CMD_NUMBER 138 00744 #define ENGINE_R_INVALID_INIT_VALUE 151 00745 #define ENGINE_R_INVALID_STRING 150 00746 #define ENGINE_R_NOT_INITIALISED 117 00747 #define ENGINE_R_NOT_LOADED 112 00748 #define ENGINE_R_NO_CONTROL_FUNCTION 120 00749 #define ENGINE_R_NO_INDEX 144 00750 #define ENGINE_R_NO_LOAD_FUNCTION 125 00751 #define ENGINE_R_NO_REFERENCE 130 00752 #define ENGINE_R_NO_SUCH_ENGINE 116 00753 #define ENGINE_R_NO_UNLOAD_FUNCTION 126 00754 #define ENGINE_R_PROVIDE_PARAMETERS 113 00755 #define ENGINE_R_RSA_NOT_IMPLEMENTED 141 00756 #define ENGINE_R_UNIMPLEMENTED_CIPHER 146 00757 #define ENGINE_R_UNIMPLEMENTED_DIGEST 147 00758 #define ENGINE_R_VERSION_INCOMPATIBILITY 145 00759 00760 #ifdef __cplusplus 00761 } 00762 #endif 00763 #endif