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