LTKCPP-- LLRP Toolkit C Plus Plus Library
engine.h
00001 /* openssl/engine.h */
00002 /*
00003  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
00004  * 2000.
00005  */
00006 /* ====================================================================
00007  * Copyright (c) 1999-2004 The OpenSSL Project.  All rights reserved.
00008  *
00009  * Redistribution and use in source and binary forms, with or without
00010  * modification, are permitted provided that the following conditions
00011  * are met:
00012  *
00013  * 1. Redistributions of source code must retain the above copyright
00014  *    notice, this list of conditions and the following disclaimer.
00015  *
00016  * 2. Redistributions in binary form must reproduce the above copyright
00017  *    notice, this list of conditions and the following disclaimer in
00018  *    the documentation and/or other materials provided with the
00019  *    distribution.
00020  *
00021  * 3. All advertising materials mentioning features or use of this
00022  *    software must display the following acknowledgment:
00023  *    "This product includes software developed by the OpenSSL Project
00024  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
00025  *
00026  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
00027  *    endorse or promote products derived from this software without
00028  *    prior written permission. For written permission, please contact
00029  *    licensing@OpenSSL.org.
00030  *
00031  * 5. Products derived from this software may not be called "OpenSSL"
00032  *    nor may "OpenSSL" appear in their names without prior written
00033  *    permission of the OpenSSL Project.
00034  *
00035  * 6. Redistributions of any form whatsoever must retain the following
00036  *    acknowledgment:
00037  *    "This product includes software developed by the OpenSSL Project
00038  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
00039  *
00040  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
00041  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00042  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00043  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
00044  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00045  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00046  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00047  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
00049  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00050  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
00051  * OF THE POSSIBILITY OF SUCH DAMAGE.
00052  * ====================================================================
00053  *
00054  * This product includes cryptographic software written by Eric Young
00055  * (eay@cryptsoft.com).  This product includes software written by Tim
00056  * Hudson (tjh@cryptsoft.com).
00057  *
00058  */
00059 /* ====================================================================
00060  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
00061  * ECDH support in OpenSSL originally developed by
00062  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
00063  */
00064 
00065 #ifndef HEADER_ENGINE_H
00066 # define HEADER_ENGINE_H
00067 
00068 # include <openssl/opensslconf.h>
00069 
00070 # ifdef OPENSSL_NO_ENGINE
00071 #  error ENGINE is disabled.
00072 # endif
00073 
00074 # ifndef OPENSSL_NO_DEPRECATED
00075 #  include <openssl/bn.h>
00076 #  ifndef OPENSSL_NO_RSA
00077 #   include <openssl/rsa.h>
00078 #  endif
00079 #  ifndef OPENSSL_NO_DSA
00080 #   include <openssl/dsa.h>
00081 #  endif
00082 #  ifndef OPENSSL_NO_DH
00083 #   include <openssl/dh.h>
00084 #  endif
00085 #  ifndef OPENSSL_NO_ECDH
00086 #   include <openssl/ecdh.h>
00087 #  endif
00088 #  ifndef OPENSSL_NO_ECDSA
00089 #   include <openssl/ecdsa.h>
00090 #  endif
00091 #  include <openssl/rand.h>
00092 #  include <openssl/ui.h>
00093 #  include <openssl/err.h>
00094 # endif
00095 
00096 # include <openssl/ossl_typ.h>
00097 # include <openssl/symhacks.h>
00098 
00099 # include <openssl/x509.h>
00100 
00101 #ifdef  __cplusplus
00102 extern "C" {
00103 #endif
00104 
00105 /*
00106  * These flags are used to control combinations of algorithm (methods) by
00107  * bitwise "OR"ing.
00108  */
00109 # define ENGINE_METHOD_RSA               (unsigned int)0x0001
00110 # define ENGINE_METHOD_DSA               (unsigned int)0x0002
00111 # define ENGINE_METHOD_DH                (unsigned int)0x0004
00112 # define ENGINE_METHOD_RAND              (unsigned int)0x0008
00113 # define ENGINE_METHOD_ECDH              (unsigned int)0x0010
00114 # define ENGINE_METHOD_ECDSA             (unsigned int)0x0020
00115 # define ENGINE_METHOD_CIPHERS           (unsigned int)0x0040
00116 # define ENGINE_METHOD_DIGESTS           (unsigned int)0x0080
00117 # define ENGINE_METHOD_STORE             (unsigned int)0x0100
00118 # define ENGINE_METHOD_PKEY_METHS        (unsigned int)0x0200
00119 # define ENGINE_METHOD_PKEY_ASN1_METHS   (unsigned int)0x0400
00120 /* Obvious all-or-nothing cases. */
00121 # define ENGINE_METHOD_ALL               (unsigned int)0xFFFF
00122 # define ENGINE_METHOD_NONE              (unsigned int)0x0000
00123 
00124 /*
00125  * This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used
00126  * internally to control registration of ENGINE implementations, and can be
00127  * set by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to
00128  * initialise registered ENGINEs if they are not already initialised.
00129  */
00130 # define ENGINE_TABLE_FLAG_NOINIT        (unsigned int)0x0001
00131 
00132 /* ENGINE flags that can be set by ENGINE_set_flags(). */
00133 /* Not used */
00134 /* #define ENGINE_FLAGS_MALLOCED        0x0001 */
00135 
00136 /*
00137  * This flag is for ENGINEs that wish to handle the various 'CMD'-related
00138  * control commands on their own. Without this flag, ENGINE_ctrl() handles
00139  * these control commands on behalf of the ENGINE using their "cmd_defns"
00140  * data.
00141  */
00142 # define ENGINE_FLAGS_MANUAL_CMD_CTRL    (int)0x0002
00143 
00144 /*
00145  * This flag is for ENGINEs who return new duplicate structures when found
00146  * via "ENGINE_by_id()". When an ENGINE must store state (eg. if
00147  * ENGINE_ctrl() commands are called in sequence as part of some stateful
00148  * process like key-generation setup and execution), it can set this flag -
00149  * then each attempt to obtain the ENGINE will result in it being copied into
00150  * a new structure. Normally, ENGINEs don't declare this flag so
00151  * ENGINE_by_id() just increments the existing ENGINE's structural reference
00152  * count.
00153  */
00154 # define ENGINE_FLAGS_BY_ID_COPY         (int)0x0004
00155 
00156 /*
00157  * This flag if for an ENGINE that does not want its methods registered as
00158  * part of ENGINE_register_all_complete() for example if the methods are not
00159  * usable as default methods.
00160  */
00161 
00162 # define ENGINE_FLAGS_NO_REGISTER_ALL    (int)0x0008
00163 
00164 /*
00165  * ENGINEs can support their own command types, and these flags are used in
00166  * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input
00167  * each command expects. Currently only numeric and string input is
00168  * supported. If a control command supports none of the _NUMERIC, _STRING, or
00169  * _NO_INPUT options, then it is regarded as an "internal" control command -
00170  * and not for use in config setting situations. As such, they're not
00171  * available to the ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl()
00172  * access. Changes to this list of 'command types' should be reflected
00173  * carefully in ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string().
00174  */
00175 
00176 /* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */
00177 # define ENGINE_CMD_FLAG_NUMERIC         (unsigned int)0x0001
00178 /*
00179  * accepts string input (cast from 'void*' to 'const char *', 4th parameter
00180  * to ENGINE_ctrl)
00181  */
00182 # define ENGINE_CMD_FLAG_STRING          (unsigned int)0x0002
00183 /*
00184  * Indicates that the control command takes *no* input. Ie. the control
00185  * command is unparameterised.
00186  */
00187 # define ENGINE_CMD_FLAG_NO_INPUT        (unsigned int)0x0004
00188 /*
00189  * Indicates that the control command is internal. This control command won't
00190  * be shown in any output, and is only usable through the ENGINE_ctrl_cmd()
00191  * function.
00192  */
00193 # define ENGINE_CMD_FLAG_INTERNAL        (unsigned int)0x0008
00194 
00195 /*
00196  * NB: These 3 control commands are deprecated and should not be used.
00197  * ENGINEs relying on these commands should compile conditional support for
00198  * compatibility (eg. if these symbols are defined) but should also migrate
00199  * the same functionality to their own ENGINE-specific control functions that
00200  * can be "discovered" by calling applications. The fact these control
00201  * commands wouldn't be "executable" (ie. usable by text-based config)
00202  * doesn't change the fact that application code can find and use them
00203  * without requiring per-ENGINE hacking.
00204  */
00205 
00206 /*
00207  * These flags are used to tell the ctrl function what should be done. All
00208  * command numbers are shared between all engines, even if some don't make
00209  * sense to some engines.  In such a case, they do nothing but return the
00210  * error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED.
00211  */
00212 # define ENGINE_CTRL_SET_LOGSTREAM               1
00213 # define ENGINE_CTRL_SET_PASSWORD_CALLBACK       2
00214 # define ENGINE_CTRL_HUP                         3/* Close and reinitialise
00215                                                    * any handles/connections
00216                                                    * etc. */
00217 # define ENGINE_CTRL_SET_USER_INTERFACE          4/* Alternative to callback */
00218 # define ENGINE_CTRL_SET_CALLBACK_DATA           5/* User-specific data, used
00219                                                    * when calling the password
00220                                                    * callback and the user
00221                                                    * interface */
00222 # define ENGINE_CTRL_LOAD_CONFIGURATION          6/* Load a configuration,
00223                                                    * given a string that
00224                                                    * represents a file name
00225                                                    * or so */
00226 # define ENGINE_CTRL_LOAD_SECTION                7/* Load data from a given
00227                                                    * section in the already
00228                                                    * loaded configuration */
00229 
00230 /*
00231  * These control commands allow an application to deal with an arbitrary
00232  * engine in a dynamic way. Warn: Negative return values indicate errors FOR
00233  * THESE COMMANDS because zero is used to indicate 'end-of-list'. Other
00234  * commands, including ENGINE-specific command types, return zero for an
00235  * error. An ENGINE can choose to implement these ctrl functions, and can
00236  * internally manage things however it chooses - it does so by setting the
00237  * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise
00238  * the ENGINE_ctrl() code handles this on the ENGINE's behalf using the
00239  * cmd_defns data (set using ENGINE_set_cmd_defns()). This means an ENGINE's
00240  * ctrl() handler need only implement its own commands - the above "meta"
00241  * commands will be taken care of.
00242  */
00243 
00244 /*
00245  * Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not",
00246  * then all the remaining control commands will return failure, so it is
00247  * worth checking this first if the caller is trying to "discover" the
00248  * engine's capabilities and doesn't want errors generated unnecessarily.
00249  */
00250 # define ENGINE_CTRL_HAS_CTRL_FUNCTION           10
00251 /*
00252  * Returns a positive command number for the first command supported by the
00253  * engine. Returns zero if no ctrl commands are supported.
00254  */
00255 # define ENGINE_CTRL_GET_FIRST_CMD_TYPE          11
00256 /*
00257  * The 'long' argument specifies a command implemented by the engine, and the
00258  * return value is the next command supported, or zero if there are no more.
00259  */
00260 # define ENGINE_CTRL_GET_NEXT_CMD_TYPE           12
00261 /*
00262  * The 'void*' argument is a command name (cast from 'const char *'), and the
00263  * return value is the command that corresponds to it.
00264  */
00265 # define ENGINE_CTRL_GET_CMD_FROM_NAME           13
00266 /*
00267  * The next two allow a command to be converted into its corresponding string
00268  * form. In each case, the 'long' argument supplies the command. In the
00269  * NAME_LEN case, the return value is the length of the command name (not
00270  * counting a trailing EOL). In the NAME case, the 'void*' argument must be a
00271  * string buffer large enough, and it will be populated with the name of the
00272  * command (WITH a trailing EOL).
00273  */
00274 # define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD       14
00275 # define ENGINE_CTRL_GET_NAME_FROM_CMD           15
00276 /* The next two are similar but give a "short description" of a command. */
00277 # define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD       16
00278 # define ENGINE_CTRL_GET_DESC_FROM_CMD           17
00279 /*
00280  * With this command, the return value is the OR'd combination of
00281  * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given
00282  * engine-specific ctrl command expects.
00283  */
00284 # define ENGINE_CTRL_GET_CMD_FLAGS               18
00285 
00286 /*
00287  * ENGINE implementations should start the numbering of their own control
00288  * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc).
00289  */
00290 # define ENGINE_CMD_BASE                         200
00291 
00292 /*
00293  * NB: These 2 nCipher "chil" control commands are deprecated, and their
00294  * functionality is now available through ENGINE-specific control commands
00295  * (exposed through the above-mentioned 'CMD'-handling). Code using these 2
00296  * commands should be migrated to the more general command handling before
00297  * these are removed.
00298  */
00299 
00300 /* Flags specific to the nCipher "chil" engine */
00301 # define ENGINE_CTRL_CHIL_SET_FORKCHECK          100
00302         /*
00303          * Depending on the value of the (long)i argument, this sets or
00304          * unsets the SimpleForkCheck flag in the CHIL API to enable or
00305          * disable checking and workarounds for applications that fork().
00306          */
00307 # define ENGINE_CTRL_CHIL_NO_LOCKING             101
00308         /*
00309          * This prevents the initialisation function from providing mutex
00310          * callbacks to the nCipher library.
00311          */
00312 
00313 /*
00314  * If an ENGINE supports its own specific control commands and wishes the
00315  * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on
00316  * its behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN
00317  * entries to ENGINE_set_cmd_defns(). It should also implement a ctrl()
00318  * handler that supports the stated commands (ie. the "cmd_num" entries as
00319  * described by the array). NB: The array must be ordered in increasing order
00320  * of cmd_num. "null-terminated" means that the last ENGINE_CMD_DEFN element
00321  * has cmd_num set to zero and/or cmd_name set to NULL.
00322  */
00323 typedef struct ENGINE_CMD_DEFN_st {
00324     unsigned int cmd_num;       /* The command number */
00325     const char *cmd_name;       /* The command name itself */
00326     const char *cmd_desc;       /* A short description of the command */
00327     unsigned int cmd_flags;     /* The input the command expects */
00328 } ENGINE_CMD_DEFN;
00329 
00330 /* Generic function pointer */
00331 typedef int (*ENGINE_GEN_FUNC_PTR) (void);
00332 /* Generic function pointer taking no arguments */
00333 typedef int (*ENGINE_GEN_INT_FUNC_PTR) (ENGINE *);
00334 /* Specific control function pointer */
00335 typedef int (*ENGINE_CTRL_FUNC_PTR) (ENGINE *, int, long, void *,
00336                                      void (*f) (void));
00337 /* Generic load_key function pointer */
00338 typedef EVP_PKEY *(*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
00339                                          UI_METHOD *ui_method,
00340                                          void *callback_data);
00341 typedef int (*ENGINE_SSL_CLIENT_CERT_PTR) (ENGINE *, SSL *ssl,
00342                                            STACK_OF(X509_NAME) *ca_dn,
00343                                            X509 **pcert, EVP_PKEY **pkey,
00344                                            STACK_OF(X509) **pother,
00345                                            UI_METHOD *ui_method,
00346                                            void *callback_data);
00347 /*-
00348  * These callback types are for an ENGINE's handler for cipher and digest logic.
00349  * These handlers have these prototypes;
00350  *   int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid);
00351  *   int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid);
00352  * Looking at how to implement these handlers in the case of cipher support, if
00353  * the framework wants the EVP_CIPHER for 'nid', it will call;
00354  *   foo(e, &p_evp_cipher, NULL, nid);    (return zero for failure)
00355  * If the framework wants a list of supported 'nid's, it will call;
00356  *   foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error)
00357  */
00358 /*
00359  * Returns to a pointer to the array of supported cipher 'nid's. If the
00360  * second parameter is non-NULL it is set to the size of the returned array.
00361  */
00362 typedef int (*ENGINE_CIPHERS_PTR) (ENGINE *, const EVP_CIPHER **,
00363                                    const int **, int);
00364 typedef int (*ENGINE_DIGESTS_PTR) (ENGINE *, const EVP_MD **, const int **,
00365                                    int);
00366 typedef int (*ENGINE_PKEY_METHS_PTR) (ENGINE *, EVP_PKEY_METHOD **,
00367                                       const int **, int);
00368 typedef int (*ENGINE_PKEY_ASN1_METHS_PTR) (ENGINE *, EVP_PKEY_ASN1_METHOD **,
00369                                            const int **, int);
00370 /*
00371  * STRUCTURE functions ... all of these functions deal with pointers to
00372  * ENGINE structures where the pointers have a "structural reference". This
00373  * means that their reference is to allowed access to the structure but it
00374  * does not imply that the structure is functional. To simply increment or
00375  * decrement the structural reference count, use ENGINE_by_id and
00376  * ENGINE_free. NB: This is not required when iterating using ENGINE_get_next
00377  * as it will automatically decrement the structural reference count of the
00378  * "current" ENGINE and increment the structural reference count of the
00379  * ENGINE it returns (unless it is NULL).
00380  */
00381 
00382 /* Get the first/last "ENGINE" type available. */
00383 ENGINE *ENGINE_get_first(void);
00384 ENGINE *ENGINE_get_last(void);
00385 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
00386 ENGINE *ENGINE_get_next(ENGINE *e);
00387 ENGINE *ENGINE_get_prev(ENGINE *e);
00388 /* Add another "ENGINE" type into the array. */
00389 int ENGINE_add(ENGINE *e);
00390 /* Remove an existing "ENGINE" type from the array. */
00391 int ENGINE_remove(ENGINE *e);
00392 /* Retrieve an engine from the list by its unique "id" value. */
00393 ENGINE *ENGINE_by_id(const char *id);
00394 /* Add all the built-in engines. */
00395 void ENGINE_load_openssl(void);
00396 void ENGINE_load_dynamic(void);
00397 # ifndef OPENSSL_NO_STATIC_ENGINE
00398 void ENGINE_load_4758cca(void);
00399 void ENGINE_load_aep(void);
00400 void ENGINE_load_atalla(void);
00401 void ENGINE_load_chil(void);
00402 void ENGINE_load_cswift(void);
00403 void ENGINE_load_nuron(void);
00404 void ENGINE_load_sureware(void);
00405 void ENGINE_load_ubsec(void);
00406 void ENGINE_load_padlock(void);
00407 void ENGINE_load_capi(void);
00408 #  ifndef OPENSSL_NO_GMP
00409 void ENGINE_load_gmp(void);
00410 #  endif
00411 #  ifndef OPENSSL_NO_GOST
00412 void ENGINE_load_gost(void);
00413 #  endif
00414 # endif
00415 void ENGINE_load_cryptodev(void);
00416 void ENGINE_load_rdrand(void);
00417 void ENGINE_load_builtin_engines(void);
00418 
00419 /*
00420  * Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation
00421  * "registry" handling.
00422  */
00423 unsigned int ENGINE_get_table_flags(void);
00424 void ENGINE_set_table_flags(unsigned int flags);
00425 
00426 /*- Manage registration of ENGINEs per "table". For each type, there are 3
00427  * functions;
00428  *   ENGINE_register_***(e) - registers the implementation from 'e' (if it has one)
00429  *   ENGINE_unregister_***(e) - unregister the implementation from 'e'
00430  *   ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list
00431  * Cleanup is automatically registered from each table when required, so
00432  * ENGINE_cleanup() will reverse any "register" operations.
00433  */
00434 
00435 int ENGINE_register_RSA(ENGINE *e);
00436 void ENGINE_unregister_RSA(ENGINE *e);
00437 void ENGINE_register_all_RSA(void);
00438 
00439 int ENGINE_register_DSA(ENGINE *e);
00440 void ENGINE_unregister_DSA(ENGINE *e);
00441 void ENGINE_register_all_DSA(void);
00442 
00443 int ENGINE_register_ECDH(ENGINE *e);
00444 void ENGINE_unregister_ECDH(ENGINE *e);
00445 void ENGINE_register_all_ECDH(void);
00446 
00447 int ENGINE_register_ECDSA(ENGINE *e);
00448 void ENGINE_unregister_ECDSA(ENGINE *e);
00449 void ENGINE_register_all_ECDSA(void);
00450 
00451 int ENGINE_register_DH(ENGINE *e);
00452 void ENGINE_unregister_DH(ENGINE *e);
00453 void ENGINE_register_all_DH(void);
00454 
00455 int ENGINE_register_RAND(ENGINE *e);
00456 void ENGINE_unregister_RAND(ENGINE *e);
00457 void ENGINE_register_all_RAND(void);
00458 
00459 int ENGINE_register_STORE(ENGINE *e);
00460 void ENGINE_unregister_STORE(ENGINE *e);
00461 void ENGINE_register_all_STORE(void);
00462 
00463 int ENGINE_register_ciphers(ENGINE *e);
00464 void ENGINE_unregister_ciphers(ENGINE *e);
00465 void ENGINE_register_all_ciphers(void);
00466 
00467 int ENGINE_register_digests(ENGINE *e);
00468 void ENGINE_unregister_digests(ENGINE *e);
00469 void ENGINE_register_all_digests(void);
00470 
00471 int ENGINE_register_pkey_meths(ENGINE *e);
00472 void ENGINE_unregister_pkey_meths(ENGINE *e);
00473 void ENGINE_register_all_pkey_meths(void);
00474 
00475 int ENGINE_register_pkey_asn1_meths(ENGINE *e);
00476 void ENGINE_unregister_pkey_asn1_meths(ENGINE *e);
00477 void ENGINE_register_all_pkey_asn1_meths(void);
00478 
00479 /*
00480  * These functions register all support from the above categories. Note, use
00481  * of these functions can result in static linkage of code your application
00482  * may not need. If you only need a subset of functionality, consider using
00483  * more selective initialisation.
00484  */
00485 int ENGINE_register_complete(ENGINE *e);
00486 int ENGINE_register_all_complete(void);
00487 
00488 /*
00489  * Send parametrised control commands to the engine. The possibilities to
00490  * send down an integer, a pointer to data or a function pointer are
00491  * provided. Any of the parameters may or may not be NULL, depending on the
00492  * command number. In actuality, this function only requires a structural
00493  * (rather than functional) reference to an engine, but many control commands
00494  * may require the engine be functional. The caller should be aware of trying
00495  * commands that require an operational ENGINE, and only use functional
00496  * references in such situations.
00497  */
00498 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
00499 
00500 /*
00501  * This function tests if an ENGINE-specific command is usable as a
00502  * "setting". Eg. in an application's config file that gets processed through
00503  * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to
00504  * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl().
00505  */
00506 int ENGINE_cmd_is_executable(ENGINE *e, int cmd);
00507 
00508 /*
00509  * This function works like ENGINE_ctrl() with the exception of taking a
00510  * command name instead of a command number, and can handle optional
00511  * commands. See the comment on ENGINE_ctrl_cmd_string() for an explanation
00512  * on how to use the cmd_name and cmd_optional.
00513  */
00514 int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name,
00515                     long i, void *p, void (*f) (void), int cmd_optional);
00516 
00517 /*
00518  * This function passes a command-name and argument to an ENGINE. The
00519  * cmd_name is converted to a command number and the control command is
00520  * called using 'arg' as an argument (unless the ENGINE doesn't support such
00521  * a command, in which case no control command is called). The command is
00522  * checked for input flags, and if necessary the argument will be converted
00523  * to a numeric value. If cmd_optional is non-zero, then if the ENGINE
00524  * doesn't support the given cmd_name the return value will be success
00525  * anyway. This function is intended for applications to use so that users
00526  * (or config files) can supply engine-specific config data to the ENGINE at
00527  * run-time to control behaviour of specific engines. As such, it shouldn't
00528  * be used for calling ENGINE_ctrl() functions that return data, deal with
00529  * binary data, or that are otherwise supposed to be used directly through
00530  * ENGINE_ctrl() in application code. Any "return" data from an ENGINE_ctrl()
00531  * operation in this function will be lost - the return value is interpreted
00532  * as failure if the return value is zero, success otherwise, and this
00533  * function returns a boolean value as a result. In other words, vendors of
00534  * 'ENGINE'-enabled devices should write ENGINE implementations with
00535  * parameterisations that work in this scheme, so that compliant ENGINE-based
00536  * applications can work consistently with the same configuration for the
00537  * same ENGINE-enabled devices, across applications.
00538  */
00539 int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg,
00540                            int cmd_optional);
00541 
00542 /*
00543  * These functions are useful for manufacturing new ENGINE structures. They
00544  * don't address reference counting at all - one uses them to populate an
00545  * ENGINE structure with personalised implementations of things prior to
00546  * using it directly or adding it to the builtin ENGINE list in OpenSSL.
00547  * These are also here so that the ENGINE structure doesn't have to be
00548  * exposed and break binary compatibility!
00549  */
00550 ENGINE *ENGINE_new(void);
00551 int ENGINE_free(ENGINE *e);
00552 int ENGINE_up_ref(ENGINE *e);
00553 int ENGINE_set_id(ENGINE *e, const char *id);
00554 int ENGINE_set_name(ENGINE *e, const char *name);
00555 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
00556 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
00557 int ENGINE_set_ECDH(ENGINE *e, const ECDH_METHOD *ecdh_meth);
00558 int ENGINE_set_ECDSA(ENGINE *e, const ECDSA_METHOD *ecdsa_meth);
00559 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
00560 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
00561 int ENGINE_set_STORE(ENGINE *e, const STORE_METHOD *store_meth);
00562 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f);
00563 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
00564 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
00565 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
00566 int ENGINE_set_load_privkey_function(ENGINE *e,
00567                                      ENGINE_LOAD_KEY_PTR loadpriv_f);
00568 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
00569 int ENGINE_set_load_ssl_client_cert_function(ENGINE *e,
00570                                              ENGINE_SSL_CLIENT_CERT_PTR
00571                                              loadssl_f);
00572 int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f);
00573 int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f);
00574 int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f);
00575 int ENGINE_set_pkey_asn1_meths(ENGINE *e, ENGINE_PKEY_ASN1_METHS_PTR f);
00576 int ENGINE_set_flags(ENGINE *e, int flags);
00577 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns);
00578 /* These functions allow control over any per-structure ENGINE data. */
00579 int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
00580                             CRYPTO_EX_dup *dup_func,
00581                             CRYPTO_EX_free *free_func);
00582 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg);
00583 void *ENGINE_get_ex_data(const ENGINE *e, int idx);
00584 
00585 /*
00586  * This function cleans up anything that needs it. Eg. the ENGINE_add()
00587  * function automatically ensures the list cleanup function is registered to
00588  * be called from ENGINE_cleanup(). Similarly, all ENGINE_register_***
00589  * functions ensure ENGINE_cleanup() will clean up after them.
00590  */
00591 void ENGINE_cleanup(void);
00592 
00593 /*
00594  * These return values from within the ENGINE structure. These can be useful
00595  * with functional references as well as structural references - it depends
00596  * which you obtained. Using the result for functional purposes if you only
00597  * obtained a structural reference may be problematic!
00598  */
00599 const char *ENGINE_get_id(const ENGINE *e);
00600 const char *ENGINE_get_name(const ENGINE *e);
00601 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
00602 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
00603 const ECDH_METHOD *ENGINE_get_ECDH(const ENGINE *e);
00604 const ECDSA_METHOD *ENGINE_get_ECDSA(const ENGINE *e);
00605 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
00606 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
00607 const STORE_METHOD *ENGINE_get_STORE(const ENGINE *e);
00608 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e);
00609 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
00610 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
00611 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
00612 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
00613 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
00614 ENGINE_SSL_CLIENT_CERT_PTR ENGINE_get_ssl_client_cert_function(const ENGINE
00615                                                                *e);
00616 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
00617 ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
00618 ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e);
00619 ENGINE_PKEY_ASN1_METHS_PTR ENGINE_get_pkey_asn1_meths(const ENGINE *e);
00620 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
00621 const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
00622 const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid);
00623 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth(ENGINE *e, int nid);
00624 const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth_str(ENGINE *e,
00625                                                           const char *str,
00626                                                           int len);
00627 const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe,
00628                                                       const char *str,
00629                                                       int len);
00630 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
00631 int ENGINE_get_flags(const ENGINE *e);
00632 
00633 /*
00634  * FUNCTIONAL functions. These functions deal with ENGINE structures that
00635  * have (or will) be initialised for use. Broadly speaking, the structural
00636  * functions are useful for iterating the list of available engine types,
00637  * creating new engine types, and other "list" operations. These functions
00638  * actually deal with ENGINEs that are to be used. As such these functions
00639  * can fail (if applicable) when particular engines are unavailable - eg. if
00640  * a hardware accelerator is not attached or not functioning correctly. Each
00641  * ENGINE has 2 reference counts; structural and functional. Every time a
00642  * functional reference is obtained or released, a corresponding structural
00643  * reference is automatically obtained or released too.
00644  */
00645 
00646 /*
00647  * Initialise a engine type for use (or up its reference count if it's
00648  * already in use). This will fail if the engine is not currently operational
00649  * and cannot initialise.
00650  */
00651 int ENGINE_init(ENGINE *e);
00652 /*
00653  * Free a functional reference to a engine type. This does not require a
00654  * corresponding call to ENGINE_free as it also releases a structural
00655  * reference.
00656  */
00657 int ENGINE_finish(ENGINE *e);
00658 
00659 /*
00660  * The following functions handle keys that are stored in some secondary
00661  * location, handled by the engine.  The storage may be on a card or
00662  * whatever.
00663  */
00664 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
00665                                   UI_METHOD *ui_method, void *callback_data);
00666 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
00667                                  UI_METHOD *ui_method, void *callback_data);
00668 int ENGINE_load_ssl_client_cert(ENGINE *e, SSL *s,
00669                                 STACK_OF(X509_NAME) *ca_dn, X509 **pcert,
00670                                 EVP_PKEY **ppkey, STACK_OF(X509) **pother,
00671                                 UI_METHOD *ui_method, void *callback_data);
00672 
00673 /*
00674  * This returns a pointer for the current ENGINE structure that is (by
00675  * default) performing any RSA operations. The value returned is an
00676  * incremented reference, so it should be free'd (ENGINE_finish) before it is
00677  * discarded.
00678  */
00679 ENGINE *ENGINE_get_default_RSA(void);
00680 /* Same for the other "methods" */
00681 ENGINE *ENGINE_get_default_DSA(void);
00682 ENGINE *ENGINE_get_default_ECDH(void);
00683 ENGINE *ENGINE_get_default_ECDSA(void);
00684 ENGINE *ENGINE_get_default_DH(void);
00685 ENGINE *ENGINE_get_default_RAND(void);
00686 /*
00687  * These functions can be used to get a functional reference to perform
00688  * ciphering or digesting corresponding to "nid".
00689  */
00690 ENGINE *ENGINE_get_cipher_engine(int nid);
00691 ENGINE *ENGINE_get_digest_engine(int nid);
00692 ENGINE *ENGINE_get_pkey_meth_engine(int nid);
00693 ENGINE *ENGINE_get_pkey_asn1_meth_engine(int nid);
00694 
00695 /*
00696  * This sets a new default ENGINE structure for performing RSA operations. If
00697  * the result is non-zero (success) then the ENGINE structure will have had
00698  * its reference count up'd so the caller should still free their own
00699  * reference 'e'.
00700  */
00701 int ENGINE_set_default_RSA(ENGINE *e);
00702 int ENGINE_set_default_string(ENGINE *e, const char *def_list);
00703 /* Same for the other "methods" */
00704 int ENGINE_set_default_DSA(ENGINE *e);
00705 int ENGINE_set_default_ECDH(ENGINE *e);
00706 int ENGINE_set_default_ECDSA(ENGINE *e);
00707 int ENGINE_set_default_DH(ENGINE *e);
00708 int ENGINE_set_default_RAND(ENGINE *e);
00709 int ENGINE_set_default_ciphers(ENGINE *e);
00710 int ENGINE_set_default_digests(ENGINE *e);
00711 int ENGINE_set_default_pkey_meths(ENGINE *e);
00712 int ENGINE_set_default_pkey_asn1_meths(ENGINE *e);
00713 
00714 /*
00715  * The combination "set" - the flags are bitwise "OR"d from the
00716  * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()"
00717  * function, this function can result in unnecessary static linkage. If your
00718  * application requires only specific functionality, consider using more
00719  * selective functions.
00720  */
00721 int ENGINE_set_default(ENGINE *e, unsigned int flags);
00722 
00723 void ENGINE_add_conf_module(void);
00724 
00725 /* Deprecated functions ... */
00726 /* int ENGINE_clear_defaults(void); */
00727 
00728 /**************************/
00729 /* DYNAMIC ENGINE SUPPORT */
00730 /**************************/
00731 
00732 /* Binary/behaviour compatibility levels */
00733 # define OSSL_DYNAMIC_VERSION            (unsigned long)0x00020000
00734 /*
00735  * Binary versions older than this are too old for us (whether we're a loader
00736  * or a loadee)
00737  */
00738 # define OSSL_DYNAMIC_OLDEST             (unsigned long)0x00020000
00739 
00740 /*
00741  * When compiling an ENGINE entirely as an external shared library, loadable
00742  * by the "dynamic" ENGINE, these types are needed. The 'dynamic_fns'
00743  * structure type provides the calling application's (or library's) error
00744  * functionality and memory management function pointers to the loaded
00745  * library. These should be used/set in the loaded library code so that the
00746  * loading application's 'state' will be used/changed in all operations. The
00747  * 'static_state' pointer allows the loaded library to know if it shares the
00748  * same static data as the calling application (or library), and thus whether
00749  * these callbacks need to be set or not.
00750  */
00751 typedef void *(*dyn_MEM_malloc_cb) (size_t);
00752 typedef void *(*dyn_MEM_realloc_cb) (void *, size_t);
00753 typedef void (*dyn_MEM_free_cb) (void *);
00754 typedef struct st_dynamic_MEM_fns {
00755     dyn_MEM_malloc_cb malloc_cb;
00756     dyn_MEM_realloc_cb realloc_cb;
00757     dyn_MEM_free_cb free_cb;
00758 } dynamic_MEM_fns;
00759 /*
00760  * FIXME: Perhaps the memory and locking code (crypto.h) should declare and
00761  * use these types so we (and any other dependant code) can simplify a bit??
00762  */
00763 typedef void (*dyn_lock_locking_cb) (int, int, const char *, int);
00764 typedef int (*dyn_lock_add_lock_cb) (int *, int, int, const char *, int);
00765 typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb) (const char *,
00766                                                                int);
00767 typedef void (*dyn_dynlock_lock_cb) (int, struct CRYPTO_dynlock_value *,
00768                                      const char *, int);
00769 typedef void (*dyn_dynlock_destroy_cb) (struct CRYPTO_dynlock_value *,
00770                                         const char *, int);
00771 typedef struct st_dynamic_LOCK_fns {
00772     dyn_lock_locking_cb lock_locking_cb;
00773     dyn_lock_add_lock_cb lock_add_lock_cb;
00774     dyn_dynlock_create_cb dynlock_create_cb;
00775     dyn_dynlock_lock_cb dynlock_lock_cb;
00776     dyn_dynlock_destroy_cb dynlock_destroy_cb;
00777 } dynamic_LOCK_fns;
00778 /* The top-level structure */
00779 typedef struct st_dynamic_fns {
00780     void *static_state;
00781     const ERR_FNS *err_fns;
00782     const CRYPTO_EX_DATA_IMPL *ex_data_fns;
00783     dynamic_MEM_fns mem_fns;
00784     dynamic_LOCK_fns lock_fns;
00785 } dynamic_fns;
00786 
00787 /*
00788  * The version checking function should be of this prototype. NB: The
00789  * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading
00790  * code. If this function returns zero, it indicates a (potential) version
00791  * incompatibility and the loaded library doesn't believe it can proceed.
00792  * Otherwise, the returned value is the (latest) version supported by the
00793  * loading library. The loader may still decide that the loaded code's
00794  * version is unsatisfactory and could veto the load. The function is
00795  * expected to be implemented with the symbol name "v_check", and a default
00796  * implementation can be fully instantiated with
00797  * IMPLEMENT_DYNAMIC_CHECK_FN().
00798  */
00799 typedef unsigned long (*dynamic_v_check_fn) (unsigned long ossl_version);
00800 # define IMPLEMENT_DYNAMIC_CHECK_FN() \
00801         OPENSSL_EXPORT unsigned long v_check(unsigned long v); \
00802         OPENSSL_EXPORT unsigned long v_check(unsigned long v) { \
00803                 if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \
00804                 return 0; }
00805 
00806 /*
00807  * This function is passed the ENGINE structure to initialise with its own
00808  * function and command settings. It should not adjust the structural or
00809  * functional reference counts. If this function returns zero, (a) the load
00810  * will be aborted, (b) the previous ENGINE state will be memcpy'd back onto
00811  * the structure, and (c) the shared library will be unloaded. So
00812  * implementations should do their own internal cleanup in failure
00813  * circumstances otherwise they could leak. The 'id' parameter, if non-NULL,
00814  * represents the ENGINE id that the loader is looking for. If this is NULL,
00815  * the shared library can choose to return failure or to initialise a
00816  * 'default' ENGINE. If non-NULL, the shared library must initialise only an
00817  * ENGINE matching the passed 'id'. The function is expected to be
00818  * implemented with the symbol name "bind_engine". A standard implementation
00819  * can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where the parameter
00820  * 'fn' is a callback function that populates the ENGINE structure and
00821  * returns an int value (zero for failure). 'fn' should have prototype;
00822  * [static] int fn(ENGINE *e, const char *id);
00823  */
00824 typedef int (*dynamic_bind_engine) (ENGINE *e, const char *id,
00825                                     const dynamic_fns *fns);
00826 # define IMPLEMENT_DYNAMIC_BIND_FN(fn) \
00827         OPENSSL_EXPORT \
00828         int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns); \
00829         OPENSSL_EXPORT \
00830         int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \
00831                 if(ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \
00832                 if(!CRYPTO_set_mem_functions(fns->mem_fns.malloc_cb, \
00833                         fns->mem_fns.realloc_cb, fns->mem_fns.free_cb)) \
00834                         return 0; \
00835                 CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \
00836                 CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \
00837                 CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \
00838                 CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \
00839                 CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \
00840                 if(!CRYPTO_set_ex_data_implementation(fns->ex_data_fns)) \
00841                         return 0; \
00842                 if(!ERR_set_implementation(fns->err_fns)) return 0; \
00843         skip_cbs: \
00844                 if(!fn(e,id)) return 0; \
00845                 return 1; }
00846 
00847 /*
00848  * If the loading application (or library) and the loaded ENGINE library
00849  * share the same static data (eg. they're both dynamically linked to the
00850  * same libcrypto.so) we need a way to avoid trying to set system callbacks -
00851  * this would fail, and for the same reason that it's unnecessary to try. If
00852  * the loaded ENGINE has (or gets from through the loader) its own copy of
00853  * the libcrypto static data, we will need to set the callbacks. The easiest
00854  * way to detect this is to have a function that returns a pointer to some
00855  * static data and let the loading application and loaded ENGINE compare
00856  * their respective values.
00857  */
00858 void *ENGINE_get_static_state(void);
00859 
00860 # if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV)
00861 void ENGINE_setup_bsd_cryptodev(void);
00862 # endif
00863 
00864 /* BEGIN ERROR CODES */
00865 /*
00866  * The following lines are auto generated by the script mkerr.pl. Any changes
00867  * made after this point may be overwritten when the script is next run.
00868  */
00869 void ERR_load_ENGINE_strings(void);
00870 
00871 /* Error codes for the ENGINE functions. */
00872 
00873 /* Function codes. */
00874 # define ENGINE_F_DYNAMIC_CTRL                            180
00875 # define ENGINE_F_DYNAMIC_GET_DATA_CTX                    181
00876 # define ENGINE_F_DYNAMIC_LOAD                            182
00877 # define ENGINE_F_DYNAMIC_SET_DATA_CTX                    183
00878 # define ENGINE_F_ENGINE_ADD                              105
00879 # define ENGINE_F_ENGINE_BY_ID                            106
00880 # define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE                170
00881 # define ENGINE_F_ENGINE_CTRL                             142
00882 # define ENGINE_F_ENGINE_CTRL_CMD                         178
00883 # define ENGINE_F_ENGINE_CTRL_CMD_STRING                  171
00884 # define ENGINE_F_ENGINE_FINISH                           107
00885 # define ENGINE_F_ENGINE_FREE_UTIL                        108
00886 # define ENGINE_F_ENGINE_GET_CIPHER                       185
00887 # define ENGINE_F_ENGINE_GET_DEFAULT_TYPE                 177
00888 # define ENGINE_F_ENGINE_GET_DIGEST                       186
00889 # define ENGINE_F_ENGINE_GET_NEXT                         115
00890 # define ENGINE_F_ENGINE_GET_PKEY_ASN1_METH               193
00891 # define ENGINE_F_ENGINE_GET_PKEY_METH                    192
00892 # define ENGINE_F_ENGINE_GET_PREV                         116
00893 # define ENGINE_F_ENGINE_INIT                             119
00894 # define ENGINE_F_ENGINE_LIST_ADD                         120
00895 # define ENGINE_F_ENGINE_LIST_REMOVE                      121
00896 # define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY                 150
00897 # define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY                  151
00898 # define ENGINE_F_ENGINE_LOAD_SSL_CLIENT_CERT             194
00899 # define ENGINE_F_ENGINE_NEW                              122
00900 # define ENGINE_F_ENGINE_REMOVE                           123
00901 # define ENGINE_F_ENGINE_SET_DEFAULT_STRING               189
00902 # define ENGINE_F_ENGINE_SET_DEFAULT_TYPE                 126
00903 # define ENGINE_F_ENGINE_SET_ID                           129
00904 # define ENGINE_F_ENGINE_SET_NAME                         130
00905 # define ENGINE_F_ENGINE_TABLE_REGISTER                   184
00906 # define ENGINE_F_ENGINE_UNLOAD_KEY                       152
00907 # define ENGINE_F_ENGINE_UNLOCKED_FINISH                  191
00908 # define ENGINE_F_ENGINE_UP_REF                           190
00909 # define ENGINE_F_INT_CTRL_HELPER                         172
00910 # define ENGINE_F_INT_ENGINE_CONFIGURE                    188
00911 # define ENGINE_F_INT_ENGINE_MODULE_INIT                  187
00912 # define ENGINE_F_LOG_MESSAGE                             141
00913 
00914 /* Reason codes. */
00915 # define ENGINE_R_ALREADY_LOADED                          100
00916 # define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER                133
00917 # define ENGINE_R_CMD_NOT_EXECUTABLE                      134
00918 # define ENGINE_R_COMMAND_TAKES_INPUT                     135
00919 # define ENGINE_R_COMMAND_TAKES_NO_INPUT                  136
00920 # define ENGINE_R_CONFLICTING_ENGINE_ID                   103
00921 # define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED            119
00922 # define ENGINE_R_DH_NOT_IMPLEMENTED                      139
00923 # define ENGINE_R_DSA_NOT_IMPLEMENTED                     140
00924 # define ENGINE_R_DSO_FAILURE                             104
00925 # define ENGINE_R_DSO_NOT_FOUND                           132
00926 # define ENGINE_R_ENGINES_SECTION_ERROR                   148
00927 # define ENGINE_R_ENGINE_CONFIGURATION_ERROR              102
00928 # define ENGINE_R_ENGINE_IS_NOT_IN_LIST                   105
00929 # define ENGINE_R_ENGINE_SECTION_ERROR                    149
00930 # define ENGINE_R_FAILED_LOADING_PRIVATE_KEY              128
00931 # define ENGINE_R_FAILED_LOADING_PUBLIC_KEY               129
00932 # define ENGINE_R_FINISH_FAILED                           106
00933 # define ENGINE_R_GET_HANDLE_FAILED                       107
00934 # define ENGINE_R_ID_OR_NAME_MISSING                      108
00935 # define ENGINE_R_INIT_FAILED                             109
00936 # define ENGINE_R_INTERNAL_LIST_ERROR                     110
00937 # define ENGINE_R_INVALID_ARGUMENT                        143
00938 # define ENGINE_R_INVALID_CMD_NAME                        137
00939 # define ENGINE_R_INVALID_CMD_NUMBER                      138
00940 # define ENGINE_R_INVALID_INIT_VALUE                      151
00941 # define ENGINE_R_INVALID_STRING                          150
00942 # define ENGINE_R_NOT_INITIALISED                         117
00943 # define ENGINE_R_NOT_LOADED                              112
00944 # define ENGINE_R_NO_CONTROL_FUNCTION                     120
00945 # define ENGINE_R_NO_INDEX                                144
00946 # define ENGINE_R_NO_LOAD_FUNCTION                        125
00947 # define ENGINE_R_NO_REFERENCE                            130
00948 # define ENGINE_R_NO_SUCH_ENGINE                          116
00949 # define ENGINE_R_NO_UNLOAD_FUNCTION                      126
00950 # define ENGINE_R_PROVIDE_PARAMETERS                      113
00951 # define ENGINE_R_RSA_NOT_IMPLEMENTED                     141
00952 # define ENGINE_R_UNIMPLEMENTED_CIPHER                    146
00953 # define ENGINE_R_UNIMPLEMENTED_DIGEST                    147
00954 # define ENGINE_R_UNIMPLEMENTED_PUBLIC_KEY_METHOD         101
00955 # define ENGINE_R_VERSION_INCOMPATIBILITY                 145
00956 
00957 #ifdef  __cplusplus
00958 }
00959 #endif
00960 #endif