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