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