engine.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:37k
源码类别:

其他游戏

开发平台:

Visual C++

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