include/openssl/engine.h

   1 /* openssl/engine.h */
   2 /*
   3  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
   4  * 2000.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 1999-2004 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59 /* ====================================================================
  60  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  61  * ECDH support in OpenSSL originally developed by
  62  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
  63  */
  64
  65 #ifndef HEADER_ENGINE_H
  66 # define HEADER_ENGINE_H
  67
  68 # include <openssl/opensslconf.h>
  69
  70 # ifdef OPENSSL_NO_ENGINE
  71 #  error ENGINE is disabled.
  72 # endif
  73
  74 # ifdef OPENSSL_USE_DEPRECATED
  75 #  include <openssl/bn.h>
  76 #  ifndef OPENSSL_NO_RSA
  77 #   include <openssl/rsa.h>
  78 #  endif
  79 #  ifndef OPENSSL_NO_DSA
  80 #   include <openssl/dsa.h>
  81 #  endif
  82 #  ifndef OPENSSL_NO_DH
  83 #   include <openssl/dh.h>
  84 #  endif
  85 #  ifndef OPENSSL_NO_EC
  86 #   include <openssl/ecdh.h>
  87 #   include <openssl/ecdsa.h>
  88 #  endif
  89 #  include <openssl/rand.h>
  90 #  include <openssl/ui.h>
  91 #  include <openssl/err.h>
  92 # endif
  93
  94 # include <openssl/ossl_typ.h>
  95 # include <openssl/symhacks.h>
  96
  97 # include <openssl/x509.h>
  98
  99 #ifdef  __cplusplus
 100 extern "C" {
 101 #endif
 102
 103 /*
 104  * These flags are used to control combinations of algorithm (methods) by
 105  * bitwise "OR"ing.
 106  */
 107 # define ENGINE_METHOD_RSA               (unsigned int)0x0001
 108 # define ENGINE_METHOD_DSA               (unsigned int)0x0002
 109 # define ENGINE_METHOD_DH                (unsigned int)0x0004
 110 # define ENGINE_METHOD_RAND              (unsigned int)0x0008
 111 # define ENGINE_METHOD_ECDH              (unsigned int)0x0010
 112 # define ENGINE_METHOD_ECDSA             (unsigned int)0x0020
 113 # define ENGINE_METHOD_CIPHERS           (unsigned int)0x0040
 114 # define ENGINE_METHOD_DIGESTS           (unsigned int)0x0080
 115 # define ENGINE_METHOD_STORE             (unsigned int)0x0100
 116 # define ENGINE_METHOD_PKEY_METHS        (unsigned int)0x0200
 117 # define ENGINE_METHOD_PKEY_ASN1_METHS   (unsigned int)0x0400
 118 /* Obvious all-or-nothing cases. */
 119 # define ENGINE_METHOD_ALL               (unsigned int)0xFFFF
 120 # define ENGINE_METHOD_NONE              (unsigned int)0x0000
 121
 122 /*
 123  * This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used
 124  * internally to control registration of ENGINE implementations, and can be
 125  * set by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to
 126  * initialise registered ENGINEs if they are not already initialised.
 127  */
 128 # define ENGINE_TABLE_FLAG_NOINIT        (unsigned int)0x0001
 129
 130 /* ENGINE flags that can be set by ENGINE_set_flags(). */
 131 /* Not used */
 132 /* #define ENGINE_FLAGS_MALLOCED        0x0001 */
 133
 134 /*
 135  * This flag is for ENGINEs that wish to handle the various 'CMD'-related
 136  * control commands on their own. Without this flag, ENGINE_ctrl() handles
 137  * these control commands on behalf of the ENGINE using their "cmd_defns"
 138  * data.
 139  */
 140 # define ENGINE_FLAGS_MANUAL_CMD_CTRL    (int)0x0002
 141
 142 /*
 143  * This flag is for ENGINEs who return new duplicate structures when found
 144  * via "ENGINE_by_id()". When an ENGINE must store state (eg. if
 145  * ENGINE_ctrl() commands are called in sequence as part of some stateful
 146  * process like key-generation setup and execution), it can set this flag -
 147  * then each attempt to obtain the ENGINE will result in it being copied into
 148  * a new structure. Normally, ENGINEs don't declare this flag so
 149  * ENGINE_by_id() just increments the existing ENGINE's structural reference
 150  * count.
 151  */
 152 # define ENGINE_FLAGS_BY_ID_COPY         (int)0x0004
 153
 154 /*
 155  * This flag if for an ENGINE that does not want its methods registered as
 156  * part of ENGINE_register_all_complete() for example if the methods are not
 157  * usable as default methods.
 158  */
 159
 160 # define ENGINE_FLAGS_NO_REGISTER_ALL    (int)0x0008
 161
 162 /*
 163  * ENGINEs can support their own command types, and these flags are used in
 164  * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input
 165  * each command expects. Currently only numeric and string input is
 166  * supported. If a control command supports none of the _NUMERIC, _STRING, or
 167  * _NO_INPUT options, then it is regarded as an "internal" control command -
 168  * and not for use in config setting situations. As such, they're not
 169  * available to the ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl()
 170  * access. Changes to this list of 'command types' should be reflected
 171  * carefully in ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string().
 172  */
 173
 174 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
 175 # define ENGINE_CMD_FLAG_NUMERIC         (unsigned int)0x0001
 176 /*
 177  * accepts string input (cast from 'void*' to 'const char *', 4th parameter
 178  * to ENGINE_ctrl)
 179  */
 180 # define ENGINE_CMD_FLAG_STRING          (unsigned int)0x0002
 181 /*
 182  * Indicates that the control command takes *no* input. Ie. the control
 183  * command is unparameterised.
 184  */
 185 # define ENGINE_CMD_FLAG_NO_INPUT        (unsigned int)0x0004
 186 /*
 187  * Indicates that the control command is internal. This control command won't
 188  * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()
 189  * function.
 190  */
 191 # define ENGINE_CMD_FLAG_INTERNAL        (unsigned int)0x0008
 192
 193 /*
 194  * NB: These 3 control commands are deprecated and should not be used.
 195  * ENGINEs relying on these commands should compile conditional support for
 196  * compatibility (eg. if these symbols are defined) but should also migrate
 197  * the same functionality to their own ENGINE-specific control functions that
 198  * can be "discovered" by calling applications. The fact these control
 199  * commands wouldn't be "executable" (ie. usable by text-based config)
 200  * doesn't change the fact that application code can find and use them
 201  * without requiring per-ENGINE hacking.
 202  */
 203
 204 /*
 205  * These flags are used to tell the ctrl function what should be done. All
 206  * command numbers are shared between all engines, even if some don't make
 207  * sense to some engines.  In such a case, they do nothing but return the
 208  * error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED.
 209  */
 210 # define ENGINE_CTRL_SET_LOGSTREAM               1
 211 # define ENGINE_CTRL_SET_PASSWORD_CALLBACK       2
 212 # define ENGINE_CTRL_HUP                         3/* Close and reinitialise
 213                                                    * any handles/connections
 214                                                    * etc. */
 215 # define ENGINE_CTRL_SET_USER_INTERFACE          4/* Alternative to callback */
 216 # define ENGINE_CTRL_SET_CALLBACK_DATA           5/* User-specific data, used
 217                                                    * when calling the password
 218                                                    * callback and the user
 219                                                    * interface */
 220 # define ENGINE_CTRL_LOAD_CONFIGURATION          6/* Load a configuration,
 221                                                    * given a string that
 222                                                    * represents a file name
 223                                                    * or so */
 224 # define ENGINE_CTRL_LOAD_SECTION                7/* Load data from a given
 225                                                    * section in the already
 226                                                    * loaded configuration */
 227
 228 /*
 229  * These control commands allow an application to deal with an arbitrary
 230  * engine in a dynamic way. Warn: Negative return values indicate errors FOR
 231  * THESE COMMANDS because zero is used to indicate 'end-of-list'. Other
 232  * commands, including ENGINE-specific command types, return zero for an
 233  * error. An ENGINE can choose to implement these ctrl functions, and can
 234  * internally manage things however it chooses - it does so by setting the
 235  * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise
 236  * the ENGINE_ctrl() code handles this on the ENGINE's behalf using the
 237  * cmd_defns data (set using ENGINE_set_cmd_defns()). This means an ENGINE's
 238  * ctrl() handler need only implement its own commands - the above "meta"
 239  * commands will be taken care of.
 240  */
 241
 242 /*
 243  * Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not",
 244  * then all the remaining control commands will return failure, so it is
 245  * worth checking this first if the caller is trying to "discover" the
 246  * engine's capabilities and doesn't want errors generated unnecessarily.
 247  */
 248 # define ENGINE_CTRL_HAS_CTRL_FUNCTION           10
 249 /*
 250  * Returns a positive command number for the first command supported by the
 251  * engine. Returns zero if no ctrl commands are supported.
 252  */
 253 # define ENGINE_CTRL_GET_FIRST_CMD_TYPE          11
 254 /*
 255  * The 'long' argument specifies a command implemented by the engine, and the
 256  * return value is the next command supported, or zero if there are no more.
 257  */
 258 # define ENGINE_CTRL_GET_NEXT_CMD_TYPE           12
 259 /*
 260  * The 'void*' argument is a command name (cast from 'const char *'), and the
 261  * return value is the command that corresponds to it.
 262  */
 263 # define ENGINE_CTRL_GET_CMD_FROM_NAME           13
 264 /*
 265  * The next two allow a command to be converted into its corresponding string
 266  * form. In each case, the 'long' argument supplies the command. In the
 267  * NAME_LEN case, the return value is the length of the command name (not
 268  * counting a trailing EOL). In the NAME case, the 'void*' argument must be a
 269  * string buffer large enough, and it will be populated with the name of the
 270  * command (WITH a trailing EOL).
 271  */
 272 # define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD       14
 273 # define ENGINE_CTRL_GET_NAME_FROM_CMD           15
 274 /* The next two are similar but give a "short description" of a command. */
 275 # define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD       16
 276 # define ENGINE_CTRL_GET_DESC_FROM_CMD           17
 277 /*
 278  * With this command, the return value is the OR'd combination of
 279  * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
 280  * engine-specific ctrl command expects.
 281  */
 282 # define ENGINE_CTRL_GET_CMD_FLAGS               18
 283
 284 /*
 285  * ENGINE implementations should start the numbering of their own control
 286  * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc).
 287  */
 288 # define ENGINE_CMD_BASE                         200
 289
 290 /*
 291  * NB: These 2 nCipher "chil" control commands are deprecated, and their
 292  * functionality is now available through ENGINE-specific control commands
 293  * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
 294  * commands should be migrated to the more general command handling before
 295  * these are removed.
 296  */
 297
 298 /* Flags specific to the nCipher "chil" engine */
 299 # define ENGINE_CTRL_CHIL_SET_FORKCHECK          100
 300         /*
 301          * Depending on the value of the (long)i argument, this sets or
 302          * unsets the SimpleForkCheck flag in the CHIL API to enable or
 303          * disable checking and workarounds for applications that fork().
 304          */
 305 # define ENGINE_CTRL_CHIL_NO_LOCKING             101
 306         /*
 307          * This prevents the initialisation function from providing mutex
 308          * callbacks to the nCipher library.
 309          */
 310
 311 /*
 312  * If an ENGINE supports its own specific control commands and wishes the
 313  * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on
 314  * its behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN
 315  * entries to ENGINE_set_cmd_defns(). It should also implement a ctrl()
 316  * handler that supports the stated commands (ie. the "cmd_num" entries as
 317  * described by the array). NB: The array must be ordered in increasing order
 318  * of cmd_num. "null-terminated" means that the last ENGINE_CMD_DEFN element
 319  * has cmd_num set to zero and/or cmd_name set to NULL.
 320  */
 321 typedef struct ENGINE_CMD_DEFN_st {
 322     unsigned int cmd_num;       /* The command number */
 323     const char *cmd_name;       /* The command name itself */
 324     const char *cmd_desc;       /* A short description of the command */
 325     unsigned int cmd_flags;     /* The input the command expects */
 326 } ENGINE_CMD_DEFN;
 327
 328 /* Generic function pointer */
 329 typedef int (*ENGINE_GEN_FUNC_PTR) (void);
 330 /* Generic function pointer taking no arguments */
 331 typedef int (*ENGINE_GEN_INT_FUNC_PTR) (ENGINE *);
 332 /* Specific control function pointer */
 333 typedef int (*ENGINE_CTRL_FUNC_PTR) (ENGINE *, int, long, void *,
 334                                      void (*f) (void));
 335 /* Generic load_key function pointer */
 336 typedef EVP_PKEY *(*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
 337                                          UI_METHOD *ui_method,
 338                                          void *callback_data);
 339 typedef int (*ENGINE_SSL_CLIENT_CERT_PTR) (ENGINE *, SSL *ssl,
 340                                            STACK_OF(X509_NAME) *ca_dn,
 341                                            X509 **pcert, EVP_PKEY **pkey,
 342                                            STACK_OF(X509) **pother,
 343                                            UI_METHOD *ui_method,
 344                                            void *callback_data);
 345 /*-
 346  * These callback types are for an ENGINE's handler for cipher and digest logic.
 347  * These handlers have these prototypes;
 348  *   int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid);
 349  *   int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid);
 350  * Looking at how to implement these handlers in the case of cipher support, if
 351  * the framework wants the EVP_CIPHER for 'nid', it will call;
 352  *   foo(e, &p_evp_cipher, NULL, nid);    (return zero for failure)
 353  * If the framework wants a list of supported 'nid's, it will call;
 354  *   foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error)
 355  */
 356 /*
 357  * Returns to a pointer to the array of supported cipher 'nid's. If the
 358  * second parameter is non-NULL it is set to the size of the returned array.
 359  */
 360 typedef int (*ENGINE_CIPHERS_PTR) (ENGINE *, const EVP_CIPHER **,
 361                                    const int **, int);
 362 typedef int (*ENGINE_DIGESTS_PTR) (ENGINE *, const EVP_MD **, const int **,
 363                                    int);
 364 typedef int (*ENGINE_PKEY_METHS_PTR) (ENGINE *, EVP_PKEY_METHOD **,
 365                                       const int **, int);
 366 typedef int (*ENGINE_PKEY_ASN1_METHS_PTR) (ENGINE *, EVP_PKEY_ASN1_METHOD **,
 367                                            const int **, int);
 368 /*
 369  * STRUCTURE functions ... all of these functions deal with pointers to
 370  * ENGINE structures where the pointers have a "structural reference". This
 371  * means that their reference is to allowed access to the structure but it
 372  * does not imply that the structure is functional. To simply increment or
 373  * decrement the structural reference count, use ENGINE_by_id and
 374  * ENGINE_free. NB: This is not required when iterating using ENGINE_get_next
 375  * as it will automatically decrement the structural reference count of the
 376  * "current" ENGINE and increment the structural reference count of the
 377  * ENGINE it returns (unless it is NULL).
 378  */
 379
 380 /* Get the first/last "ENGINE" type available. */
 381 ENGINE *ENGINE_get_first(void);
 382 ENGINE *ENGINE_get_last(void);
 383 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
 384 ENGINE *ENGINE_get_next(ENGINE *e);
 385 ENGINE *ENGINE_get_prev(ENGINE *e);
 386 /* Add another "ENGINE" type into the array. */
 387 int ENGINE_add(ENGINE *e);
 388 /* Remove an existing "ENGINE" type from the array. */
 389 int ENGINE_remove(ENGINE *e);
 390 /* Retrieve an engine from the list by its unique "id" value. */
 391 ENGINE *ENGINE_by_id(const char *id);
 392 /* Add all the built-in engines. */
 393 void ENGINE_load_openssl(void);
 394 void ENGINE_load_dynamic(void);
 395 # ifndef OPENSSL_NO_STATIC_ENGINE
 396 void ENGINE_load_4758cca(void);
 397 void ENGINE_load_aep(void);
 398 void ENGINE_load_atalla(void);
 399 void ENGINE_load_chil(void);
 400 void ENGINE_load_cswift(void);
 401 void ENGINE_load_nuron(void);
 402 void ENGINE_load_sureware(void);
 403 void ENGINE_load_ubsec(void);
 404 void ENGINE_load_padlock(void);
 405 void ENGINE_load_capi(void);
 406 #  ifndef OPENSSL_NO_GMP
 407 void ENGINE_load_gmp(void);
 408 #  endif
 409 #  ifndef OPENSSL_NO_GOST
 410 void ENGINE_load_gost(void);
 411 #  endif
 412 # endif
 413 void ENGINE_load_cryptodev(void);
 414 void ENGINE_load_rdrand(void);
 415 void ENGINE_load_builtin_engines(void);
 416
 417 /*
 418  * Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation
 419  * "registry" handling.
 420  */
 421 unsigned int ENGINE_get_table_flags(void);
 422 void ENGINE_set_table_flags(unsigned int flags);
 423
 424 /*- Manage registration of ENGINEs per "table". For each type, there are 3
 425  * functions;
 426  *   ENGINE_register_***(e) - registers the implementation from 'e' (if it has one)
 427  *   ENGINE_unregister_***(e) - unregister the implementation from 'e'
 428  *   ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list
 429  * Cleanup is automatically registered from each table when required, so
 430  * ENGINE_cleanup() will reverse any "register" operations.
 431  */
 432
 433 int ENGINE_register_RSA(ENGINE *e);
 434 void ENGINE_unregister_RSA(ENGINE *e);
 435 void ENGINE_register_all_RSA(void);
 436
 437 int ENGINE_register_DSA(ENGINE *e);
 438 void ENGINE_unregister_DSA(ENGINE *e);
 439 void ENGINE_register_all_DSA(void);
 440
 441 int ENGINE_register_ECDH(ENGINE *e);
 442 void ENGINE_unregister_ECDH(ENGINE *e);
 443 void ENGINE_register_all_ECDH(void);
 444
 445 int ENGINE_register_ECDSA(ENGINE *e);
 446 void ENGINE_unregister_ECDSA(ENGINE *e);
 447 void ENGINE_register_all_ECDSA(void);
 448
 449 int ENGINE_register_DH(ENGINE *e);
 450 void ENGINE_unregister_DH(ENGINE *e);
 451 void ENGINE_register_all_DH(void);
 452
 453 int ENGINE_register_RAND(ENGINE *e);
 454 void ENGINE_unregister_RAND(ENGINE *e);
 455 void ENGINE_register_all_RAND(void);
 456
 457 int ENGINE_register_STORE(ENGINE *e);
 458 void ENGINE_unregister_STORE(ENGINE *e);
 459 void ENGINE_register_all_STORE(void);
 460
 461 int ENGINE_register_ciphers(ENGINE *e);
 462 void ENGINE_unregister_ciphers(ENGINE *e);
 463 void ENGINE_register_all_ciphers(void);
 464
 465 int ENGINE_register_digests(ENGINE *e);
 466 void ENGINE_unregister_digests(ENGINE *e);
 467 void ENGINE_register_all_digests(void);
 468
 469 int ENGINE_register_pkey_meths(ENGINE *e);
 470 void ENGINE_unregister_pkey_meths(ENGINE *e);
 471 void ENGINE_register_all_pkey_meths(void);
 472
 473 int ENGINE_register_pkey_asn1_meths(ENGINE *e);
 474 void ENGINE_unregister_pkey_asn1_meths(ENGINE *e);
 475 void ENGINE_register_all_pkey_asn1_meths(void);
 476
 477 /*
 478  * These functions register all support from the above categories. Note, use
 479  * of these functions can result in static linkage of code your application
 480  * may not need. If you only need a subset of functionality, consider using
 481  * more selective initialisation.
 482  */
 483 int ENGINE_register_complete(ENGINE *e);
 484 int ENGINE_register_all_complete(void);
 485
 486 /*
 487  * Send parametrised control commands to the engine. The possibilities to
 488  * send down an integer, a pointer to data or a function pointer are
 489  * provided. Any of the parameters may or may not be NULL, depending on the
 490  * command number. In actuality, this function only requires a structural
 491  * (rather than functional) reference to an engine, but many control commands
 492  * may require the engine be functional. The caller should be aware of trying
 493  * commands that require an operational ENGINE, and only use functional
 494  * references in such situations.
 495  */
 496 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
 497
 498 /*
 499  * This function tests if an ENGINE-specific command is usable as a
 500  * "setting". Eg. in an application's config file that gets processed through
 501  * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
 502  * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl().
 503  */
 504 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
 505
 506 /*
 507  * This function works like ENGINE_ctrl() with the exception of taking a
 508  * command name instead of a command number, and can handle optional
 509  * commands. See the comment on ENGINE_ctrl_cmd_string() for an explanation
 510  * on how to use the cmd_name and cmd_optional.
 511  */
 512 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
 513                     long i, void *p, void (*f) (void), int cmd_optional);
 514
 515 /*
 516  * This function passes a command-name and argument to an ENGINE. The
 517  * cmd_name is converted to a command number and the control command is
 518  * called using 'arg' as an argument (unless the ENGINE doesn't support such
 519  * a command, in which case no control command is called). The command is
 520  * checked for input flags, and if necessary the argument will be converted
 521  * to a numeric value. If cmd_optional is non-zero, then if the ENGINE
 522  * doesn't support the given cmd_name the return value will be success
 523  * anyway. This function is intended for applications to use so that users
 524  * (or config files) can supply engine-specific config data to the ENGINE at
 525  * run-time to control behaviour of specific engines. As such, it shouldn't
 526  * be used for calling ENGINE_ctrl() functions that return data, deal with
 527  * binary data, or that are otherwise supposed to be used directly through
 528  * ENGINE_ctrl() in application code. Any "return" data from an ENGINE_ctrl()
 529  * operation in this function will be lost - the return value is interpreted
 530  * as failure if the return value is zero, success otherwise, and this
 531  * function returns a boolean value as a result. In other words, vendors of
 532  * 'ENGINE'-enabled devices should write ENGINE implementations with
 533  * parameterisations that work in this scheme, so that compliant ENGINE-based
 534  * applications can work consistently with the same configuration for the
 535  * same ENGINE-enabled devices, across applications.
 536  */
 537 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
 538                            int cmd_optional);
 539
 540 /*
 541  * These functions are useful for manufacturing new ENGINE structures. They
 542  * don't address reference counting at all - one uses them to populate an
 543  * ENGINE structure with personalised implementations of things prior to
 544  * using it directly or adding it to the builtin ENGINE list in OpenSSL.
 545  * These are also here so that the ENGINE structure doesn't have to be
 546  * exposed and break binary compatibility!
 547  */
 548 ENGINE *ENGINE_new(void);
 549 int ENGINE_free(ENGINE *e);
 550 int ENGINE_up_ref(ENGINE *e);
 551 int ENGINE_set_id(ENGINE *e, const char *id);
 552 int ENGINE_set_name(ENGINE *e, const char *name);
 553 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
 554 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
 555 int ENGINE_set_ECDH(ENGINE *e, const ECDH_METHOD *ecdh_meth);
 556 int ENGINE_set_ECDSA(ENGINE *e, const ECDSA_METHOD *ecdsa_meth);
 557 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
 558 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
 559 int ENGINE_set_STORE(ENGINE *e, const STORE_METHOD *store_meth);
 560 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
 561 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
 562 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
 563 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
 564 int ENGINE_set_load_privkey_function(ENGINE *e,
 565                                      ENGINE_LOAD_KEY_PTR loadpriv_f);
 566 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
 567 int ENGINE_set_load_ssl_client_cert_function(ENGINE *e,
 568                                              ENGINE_SSL_CLIENT_CERT_PTR
 569                                              loadssl_f);
 570 int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
 571 int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
 572 int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f);
 573 int ENGINE_set_pkey_asn1_meths(ENGINE *e, ENGINE_PKEY_ASN1_METHS_PTR f);
 574 int ENGINE_set_flags(ENGINE *e, int flags);
 575 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
 576 /* These functions allow control over any per-structure ENGINE data. */
 577 int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 578                             CRYPTO_EX_dup *dup_func,
 579                             CRYPTO_EX_free *free_func);
 580 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
 581 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
 582
 583 /*
 584  * This function cleans up anything that needs it. Eg. the ENGINE_add()
 585  * function automatically ensures the list cleanup function is registered to
 586  * be called from ENGINE_cleanup(). Similarly, all ENGINE_register_***
 587  * functions ensure ENGINE_cleanup() will clean up after them.
 588  */
 589 void ENGINE_cleanup(void);
 590
 591 /*
 592  * These return values from within the ENGINE structure. These can be useful
 593  * with functional references as well as structural references - it depends
 594  * which you obtained. Using the result for functional purposes if you only
 595  * obtained a structural reference may be problematic!
 596  */
 597 const char *ENGINE_get_id(const ENGINE *e);
 598 const char *ENGINE_get_name(const ENGINE *e);
 599 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
 600 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
 601 const ECDH_METHOD *ENGINE_get_ECDH(const ENGINE *e);
 602 const ECDSA_METHOD *ENGINE_get_ECDSA(const ENGINE *e);
 603 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
 604 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
 605 const STORE_METHOD *ENGINE_get_STORE(const ENGINE *e);
 606 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);
 607 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
 608 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
 609 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
 610 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
 611 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
 612 ENGINE_SSL_CLIENT_CERT_PTR ENGINE_get_ssl_client_cert_function(const ENGINE
 613                                                                *e);
 614 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
 615 ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
 616 ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e);
 617 ENGINE_PKEY_ASN1_METHS_PTR ENGINE_get_pkey_asn1_meths(const ENGINE *e);
 618 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
 619 const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
 620 const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid);
 621 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth(ENGINE *e, int nid);
 622 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth_str(ENGINE *e,
 623                                                           const char *str,
 624                                                           int len);
 625 const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe,
 626                                                       const char *str,
 627                                                       int len);
 628 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
 629 int ENGINE_get_flags(const ENGINE *e);
 630
 631 /*
 632  * FUNCTIONAL functions. These functions deal with ENGINE structures that
 633  * have (or will) be initialised for use. Broadly speaking, the structural
 634  * functions are useful for iterating the list of available engine types,
 635  * creating new engine types, and other "list" operations. These functions
 636  * actually deal with ENGINEs that are to be used. As such these functions
 637  * can fail (if applicable) when particular engines are unavailable - eg. if
 638  * a hardware accelerator is not attached or not functioning correctly. Each
 639  * ENGINE has 2 reference counts; structural and functional. Every time a
 640  * functional reference is obtained or released, a corresponding structural
 641  * reference is automatically obtained or released too.
 642  */
 643
 644 /*
 645  * Initialise a engine type for use (or up its reference count if it's
 646  * already in use). This will fail if the engine is not currently operational
 647  * and cannot initialise.
 648  */
 649 int ENGINE_init(ENGINE *e);
 650 /*
 651  * Free a functional reference to a engine type. This does not require a
 652  * corresponding call to ENGINE_free as it also releases a structural
 653  * reference.
 654  */
 655 int ENGINE_finish(ENGINE *e);
 656
 657 /*
 658  * The following functions handle keys that are stored in some secondary
 659  * location, handled by the engine.  The storage may be on a card or
 660  * whatever.
 661  */
 662 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
 663                                   UI_METHOD *ui_method, void *callback_data);
 664 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
 665                                  UI_METHOD *ui_method, void *callback_data);
 666 int ENGINE_load_ssl_client_cert(ENGINE *e, SSL *s,
 667                                 STACK_OF(X509_NAME) *ca_dn, X509 **pcert,
 668                                 EVP_PKEY **ppkey, STACK_OF(X509) **pother,
 669                                 UI_METHOD *ui_method, void *callback_data);
 670
 671 /*
 672  * This returns a pointer for the current ENGINE structure that is (by
 673  * default) performing any RSA operations. The value returned is an
 674  * incremented reference, so it should be free'd (ENGINE_finish) before it is
 675  * discarded.
 676  */
 677 ENGINE *ENGINE_get_default_RSA(void);
 678 /* Same for the other "methods" */
 679 ENGINE *ENGINE_get_default_DSA(void);
 680 ENGINE *ENGINE_get_default_ECDH(void);
 681 ENGINE *ENGINE_get_default_ECDSA(void);
 682 ENGINE *ENGINE_get_default_DH(void);
 683 ENGINE *ENGINE_get_default_RAND(void);
 684 /*
 685  * These functions can be used to get a functional reference to perform
 686  * ciphering or digesting corresponding to "nid".
 687  */
 688 ENGINE *ENGINE_get_cipher_engine(int nid);
 689 ENGINE *ENGINE_get_digest_engine(int nid);
 690 ENGINE *ENGINE_get_pkey_meth_engine(int nid);
 691 ENGINE *ENGINE_get_pkey_asn1_meth_engine(int nid);
 692
 693 /*
 694  * This sets a new default ENGINE structure for performing RSA operations. If
 695  * the result is non-zero (success) then the ENGINE structure will have had
 696  * its reference count up'd so the caller should still free their own
 697  * reference 'e'.
 698  */
 699 int ENGINE_set_default_RSA(ENGINE *e);
 700 int ENGINE_set_default_string(ENGINE *e, const char *def_list);
 701 /* Same for the other "methods" */
 702 int ENGINE_set_default_DSA(ENGINE *e);
 703 int ENGINE_set_default_ECDH(ENGINE *e);
 704 int ENGINE_set_default_ECDSA(ENGINE *e);
 705 int ENGINE_set_default_DH(ENGINE *e);
 706 int ENGINE_set_default_RAND(ENGINE *e);
 707 int ENGINE_set_default_ciphers(ENGINE *e);
 708 int ENGINE_set_default_digests(ENGINE *e);
 709 int ENGINE_set_default_pkey_meths(ENGINE *e);
 710 int ENGINE_set_default_pkey_asn1_meths(ENGINE *e);
 711
 712 /*
 713  * The combination "set" - the flags are bitwise "OR"d from the
 714  * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()"
 715  * function, this function can result in unnecessary static linkage. If your
 716  * application requires only specific functionality, consider using more
 717  * selective functions.
 718  */
 719 int ENGINE_set_default(ENGINE *e, unsigned int flags);
 720
 721 void ENGINE_add_conf_module(void);
 722
 723 /* Deprecated functions ... */
 724 /* int ENGINE_clear_defaults(void); */
 725
 726 /**************************/
 727 /* DYNAMIC ENGINE SUPPORT */
 728 /**************************/
 729
 730 /* Binary/behaviour compatibility levels */
 731 # define OSSL_DYNAMIC_VERSION            (unsigned long)0x00020000
 732 /*
 733  * Binary versions older than this are too old for us (whether we're a loader
 734  * or a loadee)
 735  */
 736 # define OSSL_DYNAMIC_OLDEST             (unsigned long)0x00020000
 737
 738 /*
 739  * When compiling an ENGINE entirely as an external shared library, loadable
 740  * by the "dynamic" ENGINE, these types are needed. The 'dynamic_fns'
 741  * structure type provides the calling application's (or library's) error
 742  * functionality and memory management function pointers to the loaded
 743  * library. These should be used/set in the loaded library code so that the
 744  * loading application's 'state' will be used/changed in all operations. The
 745  * 'static_state' pointer allows the loaded library to know if it shares the
 746  * same static data as the calling application (or library), and thus whether
 747  * these callbacks need to be set or not.
 748  */
 749 typedef void *(*dyn_MEM_malloc_cb) (size_t);
 750 typedef void *(*dyn_MEM_realloc_cb) (void *, size_t);
 751 typedef void (*dyn_MEM_free_cb) (void *);
 752 typedef struct st_dynamic_MEM_fns {
 753     dyn_MEM_malloc_cb malloc_cb;
 754     dyn_MEM_realloc_cb realloc_cb;
 755     dyn_MEM_free_cb free_cb;
 756 } dynamic_MEM_fns;
 757 /*
 758  * FIXME: Perhaps the memory and locking code (crypto.h) should declare and
 759  * use these types so we (and any other dependant code) can simplify a bit??
 760  */
 761 typedef void (*dyn_lock_locking_cb) (int, int, const char *, int);
 762 typedef int (*dyn_lock_add_lock_cb) (int *, int, int, const char *, int);
 763 typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb) (const char *,
 764                                                                int);
 765 typedef void (*dyn_dynlock_lock_cb) (int, struct CRYPTO_dynlock_value *,
 766                                      const char *, int);
 767 typedef void (*dyn_dynlock_destroy_cb) (struct CRYPTO_dynlock_value *,
 768                                         const char *, int);
 769 typedef struct st_dynamic_LOCK_fns {
 770     dyn_lock_locking_cb lock_locking_cb;
 771     dyn_lock_add_lock_cb lock_add_lock_cb;
 772     dyn_dynlock_create_cb dynlock_create_cb;
 773     dyn_dynlock_lock_cb dynlock_lock_cb;
 774     dyn_dynlock_destroy_cb dynlock_destroy_cb;
 775 } dynamic_LOCK_fns;
 776 /* The top-level structure */
 777 typedef struct st_dynamic_fns {
 778     void *static_state;
 779     dynamic_MEM_fns mem_fns;
 780     dynamic_LOCK_fns lock_fns;
 781 } dynamic_fns;
 782
 783 /*
 784  * The version checking function should be of this prototype. NB: The
 785  * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading
 786  * code. If this function returns zero, it indicates a (potential) version
 787  * incompatibility and the loaded library doesn't believe it can proceed.
 788  * Otherwise, the returned value is the (latest) version supported by the
 789  * loading library. The loader may still decide that the loaded code's
 790  * version is unsatisfactory and could veto the load. The function is
 791  * expected to be implemented with the symbol name "v_check", and a default
 792  * implementation can be fully instantiated with
 793  * IMPLEMENT_DYNAMIC_CHECK_FN().
 794  */
 795 typedef unsigned long (*dynamic_v_check_fn) (unsigned long ossl_version);
 796 # define IMPLEMENT_DYNAMIC_CHECK_FN() \
 797         OPENSSL_EXPORT unsigned long v_check(unsigned long v); \
 798         OPENSSL_EXPORT unsigned long v_check(unsigned long v) { \
 799                 if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \
 800                 return 0; }
 801
 802 /*
 803  * This function is passed the ENGINE structure to initialise with its own
 804  * function and command settings. It should not adjust the structural or
 805  * functional reference counts. If this function returns zero, (a) the load
 806  * will be aborted, (b) the previous ENGINE state will be memcpy'd back onto
 807  * the structure, and (c) the shared library will be unloaded. So
 808  * implementations should do their own internal cleanup in failure
 809  * circumstances otherwise they could leak. The 'id' parameter, if non-NULL,
 810  * represents the ENGINE id that the loader is looking for. If this is NULL,
 811  * the shared library can choose to return failure or to initialise a
 812  * 'default' ENGINE. If non-NULL, the shared library must initialise only an
 813  * ENGINE matching the passed 'id'. The function is expected to be
 814  * implemented with the symbol name "bind_engine". A standard implementation
 815  * can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where the parameter
 816  * 'fn' is a callback function that populates the ENGINE structure and
 817  * returns an int value (zero for failure). 'fn' should have prototype;
 818  * [static] int fn(ENGINE *e, const char *id);
 819  */
 820 typedef int (*dynamic_bind_engine) (ENGINE *e, const char *id,
 821                                     const dynamic_fns *fns);
 822 # define IMPLEMENT_DYNAMIC_BIND_FN(fn) \
 823         OPENSSL_EXPORT \
 824         int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns); \
 825         OPENSSL_EXPORT \
 826         int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \
 827                 if(ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \
 828                 if(!CRYPTO_set_mem_functions(fns->mem_fns.malloc_cb, \
 829                         fns->mem_fns.realloc_cb, fns->mem_fns.free_cb)) \
 830                         return 0; \
 831                 CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \
 832                 CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \
 833                 CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \
 834                 CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \
 835                 CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \
 836         skip_cbs: \
 837                 if(!fn(e,id)) return 0; \
 838                 return 1; }
 839
 840 /*
 841  * If the loading application (or library) and the loaded ENGINE library
 842  * share the same static data (eg. they're both dynamically linked to the
 843  * same libcrypto.so) we need a way to avoid trying to set system callbacks -
 844  * this would fail, and for the same reason that it's unnecessary to try. If
 845  * the loaded ENGINE has (or gets from through the loader) its own copy of
 846  * the libcrypto static data, we will need to set the callbacks. The easiest
 847  * way to detect this is to have a function that returns a pointer to some
 848  * static data and let the loading application and loaded ENGINE compare
 849  * their respective values.
 850  */
 851 void *ENGINE_get_static_state(void);
 852
 853 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
 854 void ENGINE_setup_bsd_cryptodev(void);
 855 # endif
 856
 857 /* BEGIN ERROR CODES */
 858 /*
 859  * The following lines are auto generated by the script mkerr.pl. Any changes
 860  * made after this point may be overwritten when the script is next run.
 861  */
 862 void ERR_load_ENGINE_strings(void);
 863
 864 /* Error codes for the ENGINE functions. */
 865
 866 /* Function codes. */
 867 # define ENGINE_F_DYNAMIC_CTRL                            180
 868 # define ENGINE_F_DYNAMIC_GET_DATA_CTX                    181
 869 # define ENGINE_F_DYNAMIC_LOAD                            182
 870 # define ENGINE_F_DYNAMIC_SET_DATA_CTX                    183
 871 # define ENGINE_F_ENGINE_ADD                              105
 872 # define ENGINE_F_ENGINE_BY_ID                            106
 873 # define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE                170
 874 # define ENGINE_F_ENGINE_CTRL                             142
 875 # define ENGINE_F_ENGINE_CTRL_CMD                         178
 876 # define ENGINE_F_ENGINE_CTRL_CMD_STRING                  171
 877 # define ENGINE_F_ENGINE_FINISH                           107
 878 # define ENGINE_F_ENGINE_FREE_UTIL                        108
 879 # define ENGINE_F_ENGINE_GET_CIPHER                       185
 880 # define ENGINE_F_ENGINE_GET_DEFAULT_TYPE                 177
 881 # define ENGINE_F_ENGINE_GET_DIGEST                       186
 882 # define ENGINE_F_ENGINE_GET_NEXT                         115
 883 # define ENGINE_F_ENGINE_GET_PKEY_ASN1_METH               193
 884 # define ENGINE_F_ENGINE_GET_PKEY_METH                    192
 885 # define ENGINE_F_ENGINE_GET_PREV                         116
 886 # define ENGINE_F_ENGINE_INIT                             119
 887 # define ENGINE_F_ENGINE_LIST_ADD                         120
 888 # define ENGINE_F_ENGINE_LIST_REMOVE                      121
 889 # define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY                 150
 890 # define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY                  151
 891 # define ENGINE_F_ENGINE_LOAD_SSL_CLIENT_CERT             194
 892 # define ENGINE_F_ENGINE_NEW                              122
 893 # define ENGINE_F_ENGINE_REMOVE                           123
 894 # define ENGINE_F_ENGINE_SET_DEFAULT_STRING               189
 895 # define ENGINE_F_ENGINE_SET_DEFAULT_TYPE                 126
 896 # define ENGINE_F_ENGINE_SET_ID                           129
 897 # define ENGINE_F_ENGINE_SET_NAME                         130
 898 # define ENGINE_F_ENGINE_TABLE_REGISTER                   184
 899 # define ENGINE_F_ENGINE_UNLOAD_KEY                       152
 900 # define ENGINE_F_ENGINE_UNLOCKED_FINISH                  191
 901 # define ENGINE_F_ENGINE_UP_REF                           190
 902 # define ENGINE_F_INT_CTRL_HELPER                         172
 903 # define ENGINE_F_INT_ENGINE_CONFIGURE                    188
 904 # define ENGINE_F_INT_ENGINE_MODULE_INIT                  187
 905 # define ENGINE_F_LOG_MESSAGE                             141
 906
 907 /* Reason codes. */
 908 # define ENGINE_R_ALREADY_LOADED                          100
 909 # define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER                133
 910 # define ENGINE_R_CMD_NOT_EXECUTABLE                      134
 911 # define ENGINE_R_COMMAND_TAKES_INPUT                     135
 912 # define ENGINE_R_COMMAND_TAKES_NO_INPUT                  136
 913 # define ENGINE_R_CONFLICTING_ENGINE_ID                   103
 914 # define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED            119
 915 # define ENGINE_R_DH_NOT_IMPLEMENTED                      139
 916 # define ENGINE_R_DSA_NOT_IMPLEMENTED                     140
 917 # define ENGINE_R_DSO_FAILURE                             104
 918 # define ENGINE_R_DSO_NOT_FOUND                           132
 919 # define ENGINE_R_ENGINES_SECTION_ERROR                   148
 920 # define ENGINE_R_ENGINE_CONFIGURATION_ERROR              102
 921 # define ENGINE_R_ENGINE_IS_NOT_IN_LIST                   105
 922 # define ENGINE_R_ENGINE_SECTION_ERROR                    149
 923 # define ENGINE_R_FAILED_LOADING_PRIVATE_KEY              128
 924 # define ENGINE_R_FAILED_LOADING_PUBLIC_KEY               129
 925 # define ENGINE_R_FINISH_FAILED                           106
 926 # define ENGINE_R_GET_HANDLE_FAILED                       107
 927 # define ENGINE_R_ID_OR_NAME_MISSING                      108
 928 # define ENGINE_R_INIT_FAILED                             109
 929 # define ENGINE_R_INTERNAL_LIST_ERROR                     110
 930 # define ENGINE_R_INVALID_ARGUMENT                        143
 931 # define ENGINE_R_INVALID_CMD_NAME                        137
 932 # define ENGINE_R_INVALID_CMD_NUMBER                      138
 933 # define ENGINE_R_INVALID_INIT_VALUE                      151
 934 # define ENGINE_R_INVALID_STRING                          150
 935 # define ENGINE_R_NOT_INITIALISED                         117
 936 # define ENGINE_R_NOT_LOADED                              112
 937 # define ENGINE_R_NO_CONTROL_FUNCTION                     120
 938 # define ENGINE_R_NO_INDEX                                144
 939 # define ENGINE_R_NO_LOAD_FUNCTION                        125
 940 # define ENGINE_R_NO_REFERENCE                            130
 941 # define ENGINE_R_NO_SUCH_ENGINE                          116
 942 # define ENGINE_R_NO_UNLOAD_FUNCTION                      126
 943 # define ENGINE_R_PROVIDE_PARAMETERS                      113
 944 # define ENGINE_R_RSA_NOT_IMPLEMENTED                     141
 945 # define ENGINE_R_UNIMPLEMENTED_CIPHER                    146
 946 # define ENGINE_R_UNIMPLEMENTED_DIGEST                    147
 947 # define ENGINE_R_UNIMPLEMENTED_PUBLIC_KEY_METHOD         101
 948 # define ENGINE_R_VERSION_INCOMPATIBILITY                 145
 949
 950 #ifdef  __cplusplus
 951 }
 952 #endif
 953 #endif