include/openssl/engine.h

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