engine.h 34 KB

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