codekingpro/portable-devtools

1/*2 * Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved4 *5 * Licensed under the Apache License 2.0 (the "License").  You may not use6 * this file except in compliance with the License.  You can obtain a copy7 * in the file LICENSE in the source distribution or at8 * https://www.openssl.org/source/license.html9 */10 11#ifndef OPENSSL_ENGINE_H12# define OPENSSL_ENGINE_H13# pragma once14 15# include <openssl/macros.h>16# ifndef OPENSSL_NO_DEPRECATED_3_017#  define HEADER_ENGINE_H18# endif19 20# include <openssl/opensslconf.h>21 22# ifndef OPENSSL_NO_ENGINE23#  ifndef OPENSSL_NO_DEPRECATED_1_1_024#   include <openssl/bn.h>25#   include <openssl/rsa.h>26#   include <openssl/dsa.h>27#   include <openssl/dh.h>28#   include <openssl/ec.h>29#   include <openssl/rand.h>30#   include <openssl/ui.h>31#   include <openssl/err.h>32#  endif33#  include <openssl/types.h>34#  include <openssl/symhacks.h>35#  include <openssl/x509.h>36#  include <openssl/engineerr.h>37#  ifdef  __cplusplus38extern "C" {39#  endif40 41/*42 * These flags are used to control combinations of algorithm (methods) by43 * bitwise "OR"ing.44 */45#  define ENGINE_METHOD_RSA               (unsigned int)0x000146#  define ENGINE_METHOD_DSA               (unsigned int)0x000247#  define ENGINE_METHOD_DH                (unsigned int)0x000448#  define ENGINE_METHOD_RAND              (unsigned int)0x000849#  define ENGINE_METHOD_CIPHERS           (unsigned int)0x004050#  define ENGINE_METHOD_DIGESTS           (unsigned int)0x008051#  define ENGINE_METHOD_PKEY_METHS        (unsigned int)0x020052#  define ENGINE_METHOD_PKEY_ASN1_METHS   (unsigned int)0x040053#  define ENGINE_METHOD_EC                (unsigned int)0x080054/* Obvious all-or-nothing cases. */55#  define ENGINE_METHOD_ALL               (unsigned int)0xFFFF56#  define ENGINE_METHOD_NONE              (unsigned int)0x000057 58/*59 * This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used60 * internally to control registration of ENGINE implementations, and can be61 * set by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to62 * initialise registered ENGINEs if they are not already initialised.63 */64#  define ENGINE_TABLE_FLAG_NOINIT        (unsigned int)0x000165 66/* ENGINE flags that can be set by ENGINE_set_flags(). */67/* Not used */68/* #define ENGINE_FLAGS_MALLOCED        0x0001 */69 70/*71 * This flag is for ENGINEs that wish to handle the various 'CMD'-related72 * control commands on their own. Without this flag, ENGINE_ctrl() handles73 * these control commands on behalf of the ENGINE using their "cmd_defns"74 * data.75 */76#  define ENGINE_FLAGS_MANUAL_CMD_CTRL    (int)0x000277 78/*79 * This flag is for ENGINEs who return new duplicate structures when found80 * via "ENGINE_by_id()". When an ENGINE must store state (eg. if81 * ENGINE_ctrl() commands are called in sequence as part of some stateful82 * process like key-generation setup and execution), it can set this flag -83 * then each attempt to obtain the ENGINE will result in it being copied into84 * a new structure. Normally, ENGINEs don't declare this flag so85 * ENGINE_by_id() just increments the existing ENGINE's structural reference86 * count.87 */88#  define ENGINE_FLAGS_BY_ID_COPY         (int)0x000489 90/*91 * This flag if for an ENGINE that does not want its methods registered as92 * part of ENGINE_register_all_complete() for example if the methods are not93 * usable as default methods.94 */95 96#  define ENGINE_FLAGS_NO_REGISTER_ALL    (int)0x000897 98/*99 * ENGINEs can support their own command types, and these flags are used in100 * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input101 * each command expects. Currently only numeric and string input is102 * supported. If a control command supports none of the _NUMERIC, _STRING, or103 * _NO_INPUT options, then it is regarded as an "internal" control command -104 * and not for use in config setting situations. As such, they're not105 * available to the ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl()106 * access. Changes to this list of 'command types' should be reflected107 * carefully in ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string().108 */109 110/* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */111#  define ENGINE_CMD_FLAG_NUMERIC         (unsigned int)0x0001112/*113 * accepts string input (cast from 'void*' to 'const char *', 4th parameter114 * to ENGINE_ctrl)115 */116#  define ENGINE_CMD_FLAG_STRING          (unsigned int)0x0002117/*118 * Indicates that the control command takes *no* input. Ie. the control119 * command is unparameterised.120 */121#  define ENGINE_CMD_FLAG_NO_INPUT        (unsigned int)0x0004122/*123 * Indicates that the control command is internal. This control command won't124 * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()125 * function.126 */127#  define ENGINE_CMD_FLAG_INTERNAL        (unsigned int)0x0008128 129/*130 * NB: These 3 control commands are deprecated and should not be used.131 * ENGINEs relying on these commands should compile conditional support for132 * compatibility (eg. if these symbols are defined) but should also migrate133 * the same functionality to their own ENGINE-specific control functions that134 * can be "discovered" by calling applications. The fact these control135 * commands wouldn't be "executable" (ie. usable by text-based config)136 * doesn't change the fact that application code can find and use them137 * without requiring per-ENGINE hacking.138 */139 140/*141 * These flags are used to tell the ctrl function what should be done. All142 * command numbers are shared between all engines, even if some don't make143 * sense to some engines.  In such a case, they do nothing but return the144 * error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED.145 */146#  define ENGINE_CTRL_SET_LOGSTREAM               1147#  define ENGINE_CTRL_SET_PASSWORD_CALLBACK       2148#  define ENGINE_CTRL_HUP                         3/* Close and reinitialise149                                                   * any handles/connections150                                                   * etc. */151#  define ENGINE_CTRL_SET_USER_INTERFACE          4/* Alternative to callback */152#  define ENGINE_CTRL_SET_CALLBACK_DATA           5/* User-specific data, used153                                                   * when calling the password154                                                   * callback and the user155                                                   * interface */156#  define ENGINE_CTRL_LOAD_CONFIGURATION          6/* Load a configuration,157                                                   * given a string that158                                                   * represents a file name159                                                   * or so */160#  define ENGINE_CTRL_LOAD_SECTION                7/* Load data from a given161                                                   * section in the already162                                                   * loaded configuration */163 164/*165 * These control commands allow an application to deal with an arbitrary166 * engine in a dynamic way. Warn: Negative return values indicate errors FOR167 * THESE COMMANDS because zero is used to indicate 'end-of-list'. Other168 * commands, including ENGINE-specific command types, return zero for an169 * error. An ENGINE can choose to implement these ctrl functions, and can170 * internally manage things however it chooses - it does so by setting the171 * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise172 * the ENGINE_ctrl() code handles this on the ENGINE's behalf using the173 * cmd_defns data (set using ENGINE_set_cmd_defns()). This means an ENGINE's174 * ctrl() handler need only implement its own commands - the above "meta"175 * commands will be taken care of.176 */177 178/*179 * Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not",180 * then all the remaining control commands will return failure, so it is181 * worth checking this first if the caller is trying to "discover" the182 * engine's capabilities and doesn't want errors generated unnecessarily.183 */184#  define ENGINE_CTRL_HAS_CTRL_FUNCTION           10185/*186 * Returns a positive command number for the first command supported by the187 * engine. Returns zero if no ctrl commands are supported.188 */189#  define ENGINE_CTRL_GET_FIRST_CMD_TYPE          11190/*191 * The 'long' argument specifies a command implemented by the engine, and the192 * return value is the next command supported, or zero if there are no more.193 */194#  define ENGINE_CTRL_GET_NEXT_CMD_TYPE           12195/*196 * The 'void*' argument is a command name (cast from 'const char *'), and the197 * return value is the command that corresponds to it.198 */199#  define ENGINE_CTRL_GET_CMD_FROM_NAME           13200/*201 * The next two allow a command to be converted into its corresponding string202 * form. In each case, the 'long' argument supplies the command. In the203 * NAME_LEN case, the return value is the length of the command name (not204 * counting a trailing EOL). In the NAME case, the 'void*' argument must be a205 * string buffer large enough, and it will be populated with the name of the206 * command (WITH a trailing EOL).207 */208#  define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD       14209#  define ENGINE_CTRL_GET_NAME_FROM_CMD           15210/* The next two are similar but give a "short description" of a command. */211#  define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD       16212#  define ENGINE_CTRL_GET_DESC_FROM_CMD           17213/*214 * With this command, the return value is the OR'd combination of215 * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given216 * engine-specific ctrl command expects.217 */218#  define ENGINE_CTRL_GET_CMD_FLAGS               18219 220/*221 * ENGINE implementations should start the numbering of their own control222 * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc).223 */224#  define ENGINE_CMD_BASE                         200225 226/*227 * NB: These 2 nCipher "chil" control commands are deprecated, and their228 * functionality is now available through ENGINE-specific control commands229 * (exposed through the above-mentioned 'CMD'-handling). Code using these 2230 * commands should be migrated to the more general command handling before231 * these are removed.232 */233 234/* Flags specific to the nCipher "chil" engine */235#  define ENGINE_CTRL_CHIL_SET_FORKCHECK          100236         /*237          * Depending on the value of the (long)i argument, this sets or238          * unsets the SimpleForkCheck flag in the CHIL API to enable or239          * disable checking and workarounds for applications that fork().240          */241#  define ENGINE_CTRL_CHIL_NO_LOCKING             101242         /*243          * This prevents the initialisation function from providing mutex244          * callbacks to the nCipher library.245          */246 247/*248 * If an ENGINE supports its own specific control commands and wishes the249 * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on250 * its behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN251 * entries to ENGINE_set_cmd_defns(). It should also implement a ctrl()252 * handler that supports the stated commands (ie. the "cmd_num" entries as253 * described by the array). NB: The array must be ordered in increasing order254 * of cmd_num. "null-terminated" means that the last ENGINE_CMD_DEFN element255 * has cmd_num set to zero and/or cmd_name set to NULL.256 */257typedef struct ENGINE_CMD_DEFN_st {258    unsigned int cmd_num;       /* The command number */259    const char *cmd_name;       /* The command name itself */260    const char *cmd_desc;       /* A short description of the command */261    unsigned int cmd_flags;     /* The input the command expects */262} ENGINE_CMD_DEFN;263 264/* Generic function pointer */265typedef int (*ENGINE_GEN_FUNC_PTR) (void);266/* Generic function pointer taking no arguments */267typedef int (*ENGINE_GEN_INT_FUNC_PTR) (ENGINE *);268/* Specific control function pointer */269typedef int (*ENGINE_CTRL_FUNC_PTR) (ENGINE *, int, long, void *,270                                     void (*f) (void));271/* Generic load_key function pointer */272typedef EVP_PKEY *(*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,273                                         UI_METHOD *ui_method,274                                         void *callback_data);275typedef int (*ENGINE_SSL_CLIENT_CERT_PTR) (ENGINE *, SSL *ssl,276                                           STACK_OF(X509_NAME) *ca_dn,277                                           X509 **pcert, EVP_PKEY **pkey,278                                           STACK_OF(X509) **pother,279                                           UI_METHOD *ui_method,280                                           void *callback_data);281/*-282 * These callback types are for an ENGINE's handler for cipher and digest logic.283 * These handlers have these prototypes;284 *   int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid);285 *   int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid);286 * Looking at how to implement these handlers in the case of cipher support, if287 * the framework wants the EVP_CIPHER for 'nid', it will call;288 *   foo(e, &p_evp_cipher, NULL, nid);    (return zero for failure)289 * If the framework wants a list of supported 'nid's, it will call;290 *   foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error)291 */292/*293 * Returns to a pointer to the array of supported cipher 'nid's. If the294 * second parameter is non-NULL it is set to the size of the returned array.295 */296typedef int (*ENGINE_CIPHERS_PTR) (ENGINE *, const EVP_CIPHER **,297                                   const int **, int);298typedef int (*ENGINE_DIGESTS_PTR) (ENGINE *, const EVP_MD **, const int **,299                                   int);300typedef int (*ENGINE_PKEY_METHS_PTR) (ENGINE *, EVP_PKEY_METHOD **,301                                      const int **, int);302typedef int (*ENGINE_PKEY_ASN1_METHS_PTR) (ENGINE *, EVP_PKEY_ASN1_METHOD **,303                                           const int **, int);304/*305 * STRUCTURE functions ... all of these functions deal with pointers to306 * ENGINE structures where the pointers have a "structural reference". This307 * means that their reference is to allowed access to the structure but it308 * does not imply that the structure is functional. To simply increment or309 * decrement the structural reference count, use ENGINE_by_id and310 * ENGINE_free. NB: This is not required when iterating using ENGINE_get_next311 * as it will automatically decrement the structural reference count of the312 * "current" ENGINE and increment the structural reference count of the313 * ENGINE it returns (unless it is NULL).314 */315 316/* Get the first/last "ENGINE" type available. */317#  ifndef OPENSSL_NO_DEPRECATED_3_0318OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_first(void);319OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_last(void);320#  endif321/* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */322#  ifndef OPENSSL_NO_DEPRECATED_3_0323OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_next(ENGINE *e);324OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_prev(ENGINE *e);325#  endif326/* Add another "ENGINE" type into the array. */327#  ifndef OPENSSL_NO_DEPRECATED_3_0328OSSL_DEPRECATEDIN_3_0 int ENGINE_add(ENGINE *e);329#  endif330/* Remove an existing "ENGINE" type from the array. */331#  ifndef OPENSSL_NO_DEPRECATED_3_0332OSSL_DEPRECATEDIN_3_0 int ENGINE_remove(ENGINE *e);333#  endif334/* Retrieve an engine from the list by its unique "id" value. */335#  ifndef OPENSSL_NO_DEPRECATED_3_0336OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_by_id(const char *id);337#  endif338 339#  ifndef OPENSSL_NO_DEPRECATED_1_1_0340#   define ENGINE_load_openssl() \341        OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_OPENSSL, NULL)342#   define ENGINE_load_dynamic() \343        OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_DYNAMIC, NULL)344#   ifndef OPENSSL_NO_STATIC_ENGINE345#    define ENGINE_load_padlock() \346        OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_PADLOCK, NULL)347#    define ENGINE_load_capi() \348        OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_CAPI, NULL)349#    define ENGINE_load_afalg() \350        OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_AFALG, NULL)351#   endif352#   define ENGINE_load_cryptodev() \353        OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_CRYPTODEV, NULL)354#   define ENGINE_load_rdrand() \355        OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_RDRAND, NULL)356#  endif357#  ifndef OPENSSL_NO_DEPRECATED_3_0358OSSL_DEPRECATEDIN_3_0 void ENGINE_load_builtin_engines(void);359#  endif360 361/*362 * Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation363 * "registry" handling.364 */365#  ifndef OPENSSL_NO_DEPRECATED_3_0366OSSL_DEPRECATEDIN_3_0 unsigned int ENGINE_get_table_flags(void);367OSSL_DEPRECATEDIN_3_0 void ENGINE_set_table_flags(unsigned int flags);368#  endif369 370/*- Manage registration of ENGINEs per "table". For each type, there are 3371 * functions;372 *   ENGINE_register_***(e) - registers the implementation from 'e' (if it has one)373 *   ENGINE_unregister_***(e) - unregister the implementation from 'e'374 *   ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list375 * Cleanup is automatically registered from each table when required.376 */377#  ifndef OPENSSL_NO_DEPRECATED_3_0378OSSL_DEPRECATEDIN_3_0 int ENGINE_register_RSA(ENGINE *e);379OSSL_DEPRECATEDIN_3_0 void ENGINE_unregister_RSA(ENGINE *e);380OSSL_DEPRECATEDIN_3_0 void ENGINE_register_all_RSA(void);381OSSL_DEPRECATEDIN_3_0 int ENGINE_register_DSA(ENGINE *e);382OSSL_DEPRECATEDIN_3_0 void ENGINE_unregister_DSA(ENGINE *e);383OSSL_DEPRECATEDIN_3_0 void ENGINE_register_all_DSA(void);384OSSL_DEPRECATEDIN_3_0 int ENGINE_register_EC(ENGINE *e);385OSSL_DEPRECATEDIN_3_0 void ENGINE_unregister_EC(ENGINE *e);386OSSL_DEPRECATEDIN_3_0 void ENGINE_register_all_EC(void);387OSSL_DEPRECATEDIN_3_0 int ENGINE_register_DH(ENGINE *e);388OSSL_DEPRECATEDIN_3_0 void ENGINE_unregister_DH(ENGINE *e);389OSSL_DEPRECATEDIN_3_0 void ENGINE_register_all_DH(void);390OSSL_DEPRECATEDIN_3_0 int ENGINE_register_RAND(ENGINE *e);391OSSL_DEPRECATEDIN_3_0 void ENGINE_unregister_RAND(ENGINE *e);392OSSL_DEPRECATEDIN_3_0 void ENGINE_register_all_RAND(void);393OSSL_DEPRECATEDIN_3_0 int ENGINE_register_ciphers(ENGINE *e);394OSSL_DEPRECATEDIN_3_0 void ENGINE_unregister_ciphers(ENGINE *e);395OSSL_DEPRECATEDIN_3_0 void ENGINE_register_all_ciphers(void);396OSSL_DEPRECATEDIN_3_0 int ENGINE_register_digests(ENGINE *e);397OSSL_DEPRECATEDIN_3_0 void ENGINE_unregister_digests(ENGINE *e);398OSSL_DEPRECATEDIN_3_0 void ENGINE_register_all_digests(void);399OSSL_DEPRECATEDIN_3_0 int ENGINE_register_pkey_meths(ENGINE *e);400OSSL_DEPRECATEDIN_3_0 void ENGINE_unregister_pkey_meths(ENGINE *e);401OSSL_DEPRECATEDIN_3_0 void ENGINE_register_all_pkey_meths(void);402OSSL_DEPRECATEDIN_3_0 int ENGINE_register_pkey_asn1_meths(ENGINE *e);403OSSL_DEPRECATEDIN_3_0 void ENGINE_unregister_pkey_asn1_meths(ENGINE *e);404OSSL_DEPRECATEDIN_3_0 void ENGINE_register_all_pkey_asn1_meths(void);405#  endif406 407/*408 * These functions register all support from the above categories. Note, use409 * of these functions can result in static linkage of code your application410 * may not need. If you only need a subset of functionality, consider using411 * more selective initialisation.412 */413#  ifndef OPENSSL_NO_DEPRECATED_3_0414OSSL_DEPRECATEDIN_3_0 int ENGINE_register_complete(ENGINE *e);415OSSL_DEPRECATEDIN_3_0 int ENGINE_register_all_complete(void);416#  endif417 418/*419 * Send parameterised control commands to the engine. The possibilities to420 * send down an integer, a pointer to data or a function pointer are421 * provided. Any of the parameters may or may not be NULL, depending on the422 * command number. In actuality, this function only requires a structural423 * (rather than functional) reference to an engine, but many control commands424 * may require the engine be functional. The caller should be aware of trying425 * commands that require an operational ENGINE, and only use functional426 * references in such situations.427 */428#  ifndef OPENSSL_NO_DEPRECATED_3_0429OSSL_DEPRECATEDIN_3_0 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p,430                                      void (*f) (void));431#  endif432 433/*434 * This function tests if an ENGINE-specific command is usable as a435 * "setting". Eg. in an application's config file that gets processed through436 * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to437 * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl().438 */439#  ifndef OPENSSL_NO_DEPRECATED_3_0440OSSL_DEPRECATEDIN_3_0 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);441#  endif442 443/*444 * This function works like ENGINE_ctrl() with the exception of taking a445 * command name instead of a command number, and can handle optional446 * commands. See the comment on ENGINE_ctrl_cmd_string() for an explanation447 * on how to use the cmd_name and cmd_optional.448 */449#  ifndef OPENSSL_NO_DEPRECATED_3_0450OSSL_DEPRECATEDIN_3_0 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,451                                          long i, void *p, void (*f) (void),452                                          int cmd_optional);453#  endif454 455/*456 * This function passes a command-name and argument to an ENGINE. The457 * cmd_name is converted to a command number and the control command is458 * called using 'arg' as an argument (unless the ENGINE doesn't support such459 * a command, in which case no control command is called). The command is460 * checked for input flags, and if necessary the argument will be converted461 * to a numeric value. If cmd_optional is non-zero, then if the ENGINE462 * doesn't support the given cmd_name the return value will be success463 * anyway. This function is intended for applications to use so that users464 * (or config files) can supply engine-specific config data to the ENGINE at465 * run-time to control behaviour of specific engines. As such, it shouldn't466 * be used for calling ENGINE_ctrl() functions that return data, deal with467 * binary data, or that are otherwise supposed to be used directly through468 * ENGINE_ctrl() in application code. Any "return" data from an ENGINE_ctrl()469 * operation in this function will be lost - the return value is interpreted470 * as failure if the return value is zero, success otherwise, and this471 * function returns a boolean value as a result. In other words, vendors of472 * 'ENGINE'-enabled devices should write ENGINE implementations with473 * parameterisations that work in this scheme, so that compliant ENGINE-based474 * applications can work consistently with the same configuration for the475 * same ENGINE-enabled devices, across applications.476 */477#  ifndef OPENSSL_NO_DEPRECATED_3_0478OSSL_DEPRECATEDIN_3_0479int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,480                           int cmd_optional);481#  endif482 483/*484 * These functions are useful for manufacturing new ENGINE structures. They485 * don't address reference counting at all - one uses them to populate an486 * ENGINE structure with personalised implementations of things prior to487 * using it directly or adding it to the builtin ENGINE list in OpenSSL.488 * These are also here so that the ENGINE structure doesn't have to be489 * exposed and break binary compatibility!490 */491#  ifndef OPENSSL_NO_DEPRECATED_3_0492OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_new(void);493OSSL_DEPRECATEDIN_3_0 int ENGINE_free(ENGINE *e);494OSSL_DEPRECATEDIN_3_0 int ENGINE_up_ref(ENGINE *e);495OSSL_DEPRECATEDIN_3_0 int ENGINE_set_id(ENGINE *e, const char *id);496OSSL_DEPRECATEDIN_3_0 int ENGINE_set_name(ENGINE *e, const char *name);497OSSL_DEPRECATEDIN_3_0 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);498OSSL_DEPRECATEDIN_3_0 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);499OSSL_DEPRECATEDIN_3_0 int ENGINE_set_EC(ENGINE *e, const EC_KEY_METHOD *ecdsa_meth);500OSSL_DEPRECATEDIN_3_0 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);501OSSL_DEPRECATEDIN_3_0 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);502OSSL_DEPRECATEDIN_3_0503int ENGINE_set_destroy_function(ENGINE *e,ENGINE_GEN_INT_FUNC_PTR destroy_f);504OSSL_DEPRECATEDIN_3_0505int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);506OSSL_DEPRECATEDIN_3_0507int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);508OSSL_DEPRECATEDIN_3_0509int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);510OSSL_DEPRECATEDIN_3_0511int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);512OSSL_DEPRECATEDIN_3_0513int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);514OSSL_DEPRECATEDIN_3_0515int ENGINE_set_load_ssl_client_cert_function(ENGINE *e,516                                             ENGINE_SSL_CLIENT_CERT_PTR loadssl_f);517OSSL_DEPRECATEDIN_3_0518int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);519OSSL_DEPRECATEDIN_3_0520int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);521OSSL_DEPRECATEDIN_3_0522int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f);523OSSL_DEPRECATEDIN_3_0524int ENGINE_set_pkey_asn1_meths(ENGINE *e, ENGINE_PKEY_ASN1_METHS_PTR f);525OSSL_DEPRECATEDIN_3_0 int ENGINE_set_flags(ENGINE *e, int flags);526OSSL_DEPRECATEDIN_3_0 int ENGINE_set_cmd_defns(ENGINE *e,527                                               const ENGINE_CMD_DEFN *defns);528#  endif529/* These functions allow control over any per-structure ENGINE data. */530#  define ENGINE_get_ex_new_index(l, p, newf, dupf, freef) \531    CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ENGINE, l, p, newf, dupf, freef)532# ifndef OPENSSL_NO_DEPRECATED_3_0533OSSL_DEPRECATEDIN_3_0 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);534OSSL_DEPRECATEDIN_3_0 void *ENGINE_get_ex_data(const ENGINE *e, int idx);535# endif536 537#  ifndef OPENSSL_NO_DEPRECATED_1_1_0538/*539 * This function previously cleaned up anything that needs it. Auto-deinit will540 * now take care of it so it is no longer required to call this function.541 */542#   define ENGINE_cleanup() while(0) continue543#  endif544 545/*546 * These return values from within the ENGINE structure. These can be useful547 * with functional references as well as structural references - it depends548 * which you obtained. Using the result for functional purposes if you only549 * obtained a structural reference may be problematic!550 */551#  ifndef OPENSSL_NO_DEPRECATED_3_0552OSSL_DEPRECATEDIN_3_0 const char *ENGINE_get_id(const ENGINE *e);553OSSL_DEPRECATEDIN_3_0 const char *ENGINE_get_name(const ENGINE *e);554OSSL_DEPRECATEDIN_3_0 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);555OSSL_DEPRECATEDIN_3_0 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);556OSSL_DEPRECATEDIN_3_0 const EC_KEY_METHOD *ENGINE_get_EC(const ENGINE *e);557OSSL_DEPRECATEDIN_3_0 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);558OSSL_DEPRECATEDIN_3_0 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);559OSSL_DEPRECATEDIN_3_0560ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);561OSSL_DEPRECATEDIN_3_0562ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);563OSSL_DEPRECATEDIN_3_0564ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);565OSSL_DEPRECATEDIN_3_0566ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);567OSSL_DEPRECATEDIN_3_0568ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);569OSSL_DEPRECATEDIN_3_0570ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);571OSSL_DEPRECATEDIN_3_0572ENGINE_SSL_CLIENT_CERT_PTR ENGINE_get_ssl_client_cert_function(const ENGINE *e);573OSSL_DEPRECATEDIN_3_0574ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);575OSSL_DEPRECATEDIN_3_0576ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);577OSSL_DEPRECATEDIN_3_0578ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e);579OSSL_DEPRECATEDIN_3_0580ENGINE_PKEY_ASN1_METHS_PTR ENGINE_get_pkey_asn1_meths(const ENGINE *e);581OSSL_DEPRECATEDIN_3_0582const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);583OSSL_DEPRECATEDIN_3_0584const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);585OSSL_DEPRECATEDIN_3_0586const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid);587OSSL_DEPRECATEDIN_3_0588const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth(ENGINE *e, int nid);589OSSL_DEPRECATEDIN_3_0590const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth_str(ENGINE *e,591                                                          const char *str,592                                                          int len);593OSSL_DEPRECATEDIN_3_0594const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe,595                                                      const char *str, int len);596OSSL_DEPRECATEDIN_3_0597const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);598OSSL_DEPRECATEDIN_3_0 int ENGINE_get_flags(const ENGINE *e);599#  endif600 601/*602 * FUNCTIONAL functions. These functions deal with ENGINE structures that603 * have (or will) be initialised for use. Broadly speaking, the structural604 * functions are useful for iterating the list of available engine types,605 * creating new engine types, and other "list" operations. These functions606 * actually deal with ENGINEs that are to be used. As such these functions607 * can fail (if applicable) when particular engines are unavailable - eg. if608 * a hardware accelerator is not attached or not functioning correctly. Each609 * ENGINE has 2 reference counts; structural and functional. Every time a610 * functional reference is obtained or released, a corresponding structural611 * reference is automatically obtained or released too.612 */613 614/*615 * Initialise a engine type for use (or up its reference count if it's616 * already in use). This will fail if the engine is not currently operational617 * and cannot initialise.618 */619#  ifndef OPENSSL_NO_DEPRECATED_3_0620OSSL_DEPRECATEDIN_3_0 int ENGINE_init(ENGINE *e);621#  endif622/*623 * Free a functional reference to a engine type. This does not require a624 * corresponding call to ENGINE_free as it also releases a structural625 * reference.626 */627#  ifndef OPENSSL_NO_DEPRECATED_3_0628OSSL_DEPRECATEDIN_3_0 int ENGINE_finish(ENGINE *e);629#  endif630 631/*632 * The following functions handle keys that are stored in some secondary633 * location, handled by the engine.  The storage may be on a card or634 * whatever.635 */636#  ifndef OPENSSL_NO_DEPRECATED_3_0637OSSL_DEPRECATEDIN_3_0638EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,639                                  UI_METHOD *ui_method, void *callback_data);640OSSL_DEPRECATEDIN_3_0641EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,642                                 UI_METHOD *ui_method, void *callback_data);643OSSL_DEPRECATEDIN_3_0644int ENGINE_load_ssl_client_cert(ENGINE *e, SSL *s, STACK_OF(X509_NAME) *ca_dn,645                                X509 **pcert, EVP_PKEY **ppkey,646                                STACK_OF(X509) **pother,647                                UI_METHOD *ui_method, void *callback_data);648#  endif649 650/*651 * This returns a pointer for the current ENGINE structure that is (by652 * default) performing any RSA operations. The value returned is an653 * incremented reference, so it should be free'd (ENGINE_finish) before it is654 * discarded.655 */656#  ifndef OPENSSL_NO_DEPRECATED_3_0657OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_default_RSA(void);658#  endif659/* Same for the other "methods" */660#  ifndef OPENSSL_NO_DEPRECATED_3_0661OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_default_DSA(void);662OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_default_EC(void);663OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_default_DH(void);664OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_default_RAND(void);665#  endif666/*667 * These functions can be used to get a functional reference to perform668 * ciphering or digesting corresponding to "nid".669 */670#  ifndef OPENSSL_NO_DEPRECATED_3_0671OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_cipher_engine(int nid);672OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_digest_engine(int nid);673OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_pkey_meth_engine(int nid);674OSSL_DEPRECATEDIN_3_0 ENGINE *ENGINE_get_pkey_asn1_meth_engine(int nid);675#  endif676 677/*678 * This sets a new default ENGINE structure for performing RSA operations. If679 * the result is non-zero (success) then the ENGINE structure will have had680 * its reference count up'd so the caller should still free their own681 * reference 'e'.682 */683#  ifndef OPENSSL_NO_DEPRECATED_3_0684OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_RSA(ENGINE *e);685OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_string(ENGINE *e,686                                                    const char *def_list);687#  endif688/* Same for the other "methods" */689#  ifndef OPENSSL_NO_DEPRECATED_3_0690OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_DSA(ENGINE *e);691OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_EC(ENGINE *e);692OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_DH(ENGINE *e);693OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_RAND(ENGINE *e);694OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_ciphers(ENGINE *e);695OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_digests(ENGINE *e);696OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_pkey_meths(ENGINE *e);697OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default_pkey_asn1_meths(ENGINE *e);698#  endif699 700/*701 * The combination "set" - the flags are bitwise "OR"d from the702 * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()"703 * function, this function can result in unnecessary static linkage. If your704 * application requires only specific functionality, consider using more705 * selective functions.706 */707#  ifndef OPENSSL_NO_DEPRECATED_3_0708OSSL_DEPRECATEDIN_3_0 int ENGINE_set_default(ENGINE *e, unsigned int flags);709OSSL_DEPRECATEDIN_3_0 void ENGINE_add_conf_module(void);710#  endif711 712/* Deprecated functions ... */713/* int ENGINE_clear_defaults(void); */714 715/**************************/716/* DYNAMIC ENGINE SUPPORT */717/**************************/718 719/* Binary/behaviour compatibility levels */720#  define OSSL_DYNAMIC_VERSION            (unsigned long)0x00030000721/*722 * Binary versions older than this are too old for us (whether we're a loader723 * or a loadee)724 */725#  define OSSL_DYNAMIC_OLDEST             (unsigned long)0x00030000726 727/*728 * When compiling an ENGINE entirely as an external shared library, loadable729 * by the "dynamic" ENGINE, these types are needed. The 'dynamic_fns'730 * structure type provides the calling application's (or library's) error731 * functionality and memory management function pointers to the loaded732 * library. These should be used/set in the loaded library code so that the733 * loading application's 'state' will be used/changed in all operations. The734 * 'static_state' pointer allows the loaded library to know if it shares the735 * same static data as the calling application (or library), and thus whether736 * these callbacks need to be set or not.737 */738typedef void *(*dyn_MEM_malloc_fn) (size_t, const char *, int);739typedef void *(*dyn_MEM_realloc_fn) (void *, size_t, const char *, int);740typedef void (*dyn_MEM_free_fn) (void *, const char *, int);741typedef struct st_dynamic_MEM_fns {742    dyn_MEM_malloc_fn malloc_fn;743    dyn_MEM_realloc_fn realloc_fn;744    dyn_MEM_free_fn free_fn;745} dynamic_MEM_fns;746/*747 * FIXME: Perhaps the memory and locking code (crypto.h) should declare and748 * use these types so we (and any other dependent code) can simplify a bit??749 */750/* The top-level structure */751typedef struct st_dynamic_fns {752    void *static_state;753    dynamic_MEM_fns mem_fns;754} dynamic_fns;755 756/*757 * The version checking function should be of this prototype. NB: The758 * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading759 * code. If this function returns zero, it indicates a (potential) version760 * incompatibility and the loaded library doesn't believe it can proceed.761 * Otherwise, the returned value is the (latest) version supported by the762 * loading library. The loader may still decide that the loaded code's763 * version is unsatisfactory and could veto the load. The function is764 * expected to be implemented with the symbol name "v_check", and a default765 * implementation can be fully instantiated with766 * IMPLEMENT_DYNAMIC_CHECK_FN().767 */768typedef unsigned long (*dynamic_v_check_fn) (unsigned long ossl_version);769#  define IMPLEMENT_DYNAMIC_CHECK_FN() \770        OPENSSL_EXPORT unsigned long v_check(unsigned long v); \771        OPENSSL_EXPORT unsigned long v_check(unsigned long v) { \772                if (v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \773                return 0; }774 775/*776 * This function is passed the ENGINE structure to initialise with its own777 * function and command settings. It should not adjust the structural or778 * functional reference counts. If this function returns zero, (a) the load779 * will be aborted, (b) the previous ENGINE state will be memcpy'd back onto780 * the structure, and (c) the shared library will be unloaded. So781 * implementations should do their own internal cleanup in failure782 * circumstances otherwise they could leak. The 'id' parameter, if non-NULL,783 * represents the ENGINE id that the loader is looking for. If this is NULL,784 * the shared library can choose to return failure or to initialise a785 * 'default' ENGINE. If non-NULL, the shared library must initialise only an786 * ENGINE matching the passed 'id'. The function is expected to be787 * implemented with the symbol name "bind_engine". A standard implementation788 * can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where the parameter789 * 'fn' is a callback function that populates the ENGINE structure and790 * returns an int value (zero for failure). 'fn' should have prototype;791 * [static] int fn(ENGINE *e, const char *id);792 */793typedef int (*dynamic_bind_engine) (ENGINE *e, const char *id,794                                    const dynamic_fns *fns);795#  define IMPLEMENT_DYNAMIC_BIND_FN(fn) \796        OPENSSL_EXPORT \797        int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns); \798        OPENSSL_EXPORT \799        int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \800            if (ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \801            CRYPTO_set_mem_functions(fns->mem_fns.malloc_fn, \802                                     fns->mem_fns.realloc_fn, \803                                     fns->mem_fns.free_fn); \804            OPENSSL_init_crypto(OPENSSL_INIT_NO_ATEXIT, NULL); \805        skip_cbs: \806            if (!fn(e, id)) return 0; \807            return 1; }808 809/*810 * If the loading application (or library) and the loaded ENGINE library811 * share the same static data (eg. they're both dynamically linked to the812 * same libcrypto.so) we need a way to avoid trying to set system callbacks -813 * this would fail, and for the same reason that it's unnecessary to try. If814 * the loaded ENGINE has (or gets from through the loader) its own copy of815 * the libcrypto static data, we will need to set the callbacks. The easiest816 * way to detect this is to have a function that returns a pointer to some817 * static data and let the loading application and loaded ENGINE compare818 * their respective values.819 */820void *ENGINE_get_static_state(void);821 822#  if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__DragonFly__)823#   ifndef OPENSSL_NO_DEPRECATED_1_1_0824OSSL_DEPRECATEDIN_1_1_0 void ENGINE_setup_bsd_cryptodev(void);825#   endif826#  endif827 828 829#  ifdef  __cplusplus830}831#  endif832# endif /* OPENSSL_NO_ENGINE */833#endif  /* OPENSSL_ENGINE_H */834