crypto/engine/engine.h

   1 /* openssl/engine.h */
   2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
   3  * project 2000.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    licensing@OpenSSL.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #ifndef HEADER_ENGINE_H
  60 #define HEADER_ENGINE_H
  61
  62 #include <openssl/bn.h>
  63 #include <openssl/rsa.h>
  64 #include <openssl/dsa.h>
  65 #include <openssl/dh.h>
  66 #include <openssl/rand.h>
  67 #include <openssl/evp.h>
  68 #include <openssl/symhacks.h>
  69
  70 #ifdef  __cplusplus
  71 extern "C" {
  72 #endif
  73
  74 /* These flags are used to control combinations of algorithm (methods)
  75  * by bitwise "OR"ing. */
  76 #define ENGINE_METHOD_RSA               (unsigned int)0x0001
  77 #define ENGINE_METHOD_DSA               (unsigned int)0x0002
  78 #define ENGINE_METHOD_DH                (unsigned int)0x0004
  79 #define ENGINE_METHOD_RAND              (unsigned int)0x0008
  80 #define ENGINE_METHOD_BN_MOD_EXP        (unsigned int)0x0010
  81 #define ENGINE_METHOD_BN_MOD_EXP_CRT    (unsigned int)0x0020
  82 /* Obvious all-or-nothing cases. */
  83 #define ENGINE_METHOD_ALL               (unsigned int)0xFFFF
  84 #define ENGINE_METHOD_NONE              (unsigned int)0x0000
  85
  86 /* These flags are used to tell the ctrl function what should be done.
  87  * All command numbers are shared between all engines, even if some don't
  88  * make sense to some engines.  In such a case, they do nothing but return
  89  * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */
  90 #define ENGINE_CTRL_SET_LOGSTREAM               1
  91 #define ENGINE_CTRL_SET_PASSWORD_CALLBACK       2
  92 #define ENGINE_CTRL_HUP                         3 /* Close and reinitialise any
  93                                                      handles/connections etc. */
  94
  95 /* Flags specific to the nCipher "chil" engine */
  96 #define ENGINE_CTRL_CHIL_SET_FORKCHECK          100
  97         /* Depending on the value of the (long)i argument, this sets or
  98          * unsets the SimpleForkCheck flag in the CHIL API to enable or
  99          * disable checking and workarounds for applications that fork().
 100          */
 101 #define ENGINE_CTRL_CHIL_NO_LOCKING             101
 102         /* This prevents the initialisation function from providing mutex
 103          * callbacks to the nCipher library. */
 104
 105 /* As we're missing a BIGNUM_METHOD, we need a couple of locally
 106  * defined function types that engines can implement. */
 107
 108 /* mod_exp operation, calculates; r = a ^ p mod m
 109  * NB: ctx can be NULL, but if supplied, the implementation may use
 110  * it if it wishes. */
 111 typedef int (*BN_MOD_EXP)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 112                 const BIGNUM *m, BN_CTX *ctx);
 113
 114 /* private key operation for RSA, provided seperately in case other
 115  * RSA implementations wish to use it. */
 116 typedef int (*BN_MOD_EXP_CRT)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 117                 const BIGNUM *q, const BIGNUM *dmp1, const BIGNUM *dmq1,
 118                 const BIGNUM *iqmp, BN_CTX *ctx);
 119
 120 /* The list of "engine" types is a static array of (const ENGINE*)
 121  * pointers (not dynamic because static is fine for now and we otherwise
 122  * have to hook an appropriate load/unload function in to initialise and
 123  * cleanup). */
 124 struct engine_st;
 125 typedef struct engine_st ENGINE;
 126
 127 /* Generic function pointer */
 128 typedef int (*ENGINE_GEN_FUNC_PTR)();
 129 /* Generic function pointer taking no arguments */
 130 typedef int (*ENGINE_GEN_INT_FUNC_PTR)(void);
 131 /* Specific control function pointer */
 132 typedef int (*ENGINE_CTRL_FUNC_PTR)(int cmd, long i, void *p, void (*f)());
 133 /* Generic load_key function pointer */
 134 typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(const char *key_id, const char *passphrase);
 135
 136 /* STRUCTURE functions ... all of these functions deal with pointers to
 137  * ENGINE structures where the pointers have a "structural reference".
 138  * This means that their reference is to allow access to the structure
 139  * but it does not imply that the structure is functional. To simply
 140  * increment or decrement the structural reference count, use ENGINE_new
 141  * and ENGINE_free. NB: This is not required when iterating using
 142  * ENGINE_get_next as it will automatically decrement the structural
 143  * reference count of the "current" ENGINE and increment the structural
 144  * reference count of the ENGINE it returns (unless it is NULL). */
 145
 146 /* Get the first/last "ENGINE" type available. */
 147 ENGINE *ENGINE_get_first(void);
 148 ENGINE *ENGINE_get_last(void);
 149 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
 150 ENGINE *ENGINE_get_next(ENGINE *e);
 151 ENGINE *ENGINE_get_prev(ENGINE *e);
 152 /* Add another "ENGINE" type into the array. */
 153 int ENGINE_add(ENGINE *e);
 154 /* Remove an existing "ENGINE" type from the array. */
 155 int ENGINE_remove(ENGINE *e);
 156 /* Retrieve an engine from the list by its unique "id" value. */
 157 ENGINE *ENGINE_by_id(const char *id);
 158 /* Add all the built-in engines.  By default, only the OpenSSL software
 159    engine is loaded */
 160 void ENGINE_load_cswift(void);
 161 void ENGINE_load_chil(void);
 162 void ENGINE_load_atalla(void);
 163 void ENGINE_load_nuron(void);
 164 void ENGINE_load_ubsec(void);
 165 void ENGINE_load_builtin_engines(void);
 166
 167 /* These functions are useful for manufacturing new ENGINE structures. They
 168  * don't address reference counting at all - one uses them to populate an ENGINE
 169  * structure with personalised implementations of things prior to using it
 170  * directly or adding it to the builtin ENGINE list in OpenSSL. These are also
 171  * here so that the ENGINE structure doesn't have to be exposed and break binary
 172  * compatibility! */
 173 ENGINE *ENGINE_new(void);
 174 int ENGINE_free(ENGINE *e);
 175 int ENGINE_set_id(ENGINE *e, const char *id);
 176 int ENGINE_set_name(ENGINE *e, const char *name);
 177 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
 178 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
 179 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
 180 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
 181 int ENGINE_set_BN_mod_exp(ENGINE *e, BN_MOD_EXP bn_mod_exp);
 182 int ENGINE_set_BN_mod_exp_crt(ENGINE *e, BN_MOD_EXP_CRT bn_mod_exp_crt);
 183 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
 184 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
 185 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
 186 int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
 187 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
 188 int ENGINE_set_flags(ENGINE *e, int flags);
 189 int ENGINE_cpy(ENGINE *dest, const ENGINE *src);
 190
 191 /* These return values from within the ENGINE structure. These can be useful
 192  * with functional references as well as structural references - it depends
 193  * which you obtained. Using the result for functional purposes if you only
 194  * obtained a structural reference may be problematic! */
 195 const char *ENGINE_get_id(const ENGINE *e);
 196 const char *ENGINE_get_name(const ENGINE *e);
 197 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
 198 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
 199 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
 200 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
 201 BN_MOD_EXP ENGINE_get_BN_mod_exp(const ENGINE *e);
 202 BN_MOD_EXP_CRT ENGINE_get_BN_mod_exp_crt(const ENGINE *e);
 203 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
 204 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
 205 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
 206 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
 207 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
 208 int ENGINE_get_flags(const ENGINE *e);
 209
 210 /* FUNCTIONAL functions. These functions deal with ENGINE structures
 211  * that have (or will) be initialised for use. Broadly speaking, the
 212  * structural functions are useful for iterating the list of available
 213  * engine types, creating new engine types, and other "list" operations.
 214  * These functions actually deal with ENGINEs that are to be used. As
 215  * such these functions can fail (if applicable) when particular
 216  * engines are unavailable - eg. if a hardware accelerator is not
 217  * attached or not functioning correctly. Each ENGINE has 2 reference
 218  * counts; structural and functional. Every time a functional reference
 219  * is obtained or released, a corresponding structural reference is
 220  * automatically obtained or released too. */
 221
 222 /* Initialise a engine type for use (or up its reference count if it's
 223  * already in use). This will fail if the engine is not currently
 224  * operational and cannot initialise. */
 225 int ENGINE_init(ENGINE *e);
 226 /* Free a functional reference to a engine type. This does not require
 227  * a corresponding call to ENGINE_free as it also releases a structural
 228  * reference. */
 229 int ENGINE_finish(ENGINE *e);
 230 /* Send control parametrised commands to the engine.  The possibilities
 231  * to send down an integer, a pointer to data or a function pointer are
 232  * provided.  Any of the parameters may or may not be NULL, depending
 233  * on the command number */
 234 /* WARNING: This is currently experimental and may change radically! */
 235 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
 236
 237 /* The following functions handle keys that are stored in some secondary
 238  * location, handled by the engine.  The storage may be on a card or
 239  * whatever. */
 240 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
 241         const char *passphrase);
 242 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
 243         const char *passphrase);
 244
 245 /* This returns a pointer for the current ENGINE structure that
 246  * is (by default) performing any RSA operations. The value returned
 247  * is an incremented reference, so it should be free'd (ENGINE_finish)
 248  * before it is discarded. */
 249 ENGINE *ENGINE_get_default_RSA(void);
 250 /* Same for the other "methods" */
 251 ENGINE *ENGINE_get_default_DSA(void);
 252 ENGINE *ENGINE_get_default_DH(void);
 253 ENGINE *ENGINE_get_default_RAND(void);
 254 ENGINE *ENGINE_get_default_BN_mod_exp(void);
 255 ENGINE *ENGINE_get_default_BN_mod_exp_crt(void);
 256
 257 /* This sets a new default ENGINE structure for performing RSA
 258  * operations. If the result is non-zero (success) then the ENGINE
 259  * structure will have had its reference count up'd so the caller
 260  * should still free their own reference 'e'. */
 261 int ENGINE_set_default_RSA(ENGINE *e);
 262 /* Same for the other "methods" */
 263 int ENGINE_set_default_DSA(ENGINE *e);
 264 int ENGINE_set_default_DH(ENGINE *e);
 265 int ENGINE_set_default_RAND(ENGINE *e);
 266 int ENGINE_set_default_BN_mod_exp(ENGINE *e);
 267 int ENGINE_set_default_BN_mod_exp_crt(ENGINE *e);
 268
 269 /* The combination "set" - the flags are bitwise "OR"d from the
 270  * ENGINE_METHOD_*** defines above. */
 271 int ENGINE_set_default(ENGINE *e, unsigned int flags);
 272
 273 /* Obligatory error function. */
 274 void ERR_load_ENGINE_strings(void);
 275
 276 /*
 277  * Error codes for all engine functions. NB: We use "generic"
 278  * function names instead of per-implementation ones because this
 279  * levels the playing field for externally implemented bootstrapped
 280  * support code. As the filename and line number is included, it's
 281  * more important to indicate the type of function, so that
 282  * bootstrapped code (that can't easily add its own errors in) can
 283  * use the same error codes too.
 284  */
 285
 286 /* BEGIN ERROR CODES */
 287 /* The following lines are auto generated by the script mkerr.pl. Any changes
 288  * made after this point may be overwritten when the script is next run.
 289  */
 290
 291 /* Error codes for the ENGINE functions. */
 292
 293 /* Function codes. */
 294 #define ENGINE_F_ATALLA_FINISH                           159
 295 #define ENGINE_F_ATALLA_INIT                             160
 296 #define ENGINE_F_ATALLA_MOD_EXP                          161
 297 #define ENGINE_F_ATALLA_RSA_MOD_EXP                      162
 298 #define ENGINE_F_CSWIFT_DSA_SIGN                         133
 299 #define ENGINE_F_CSWIFT_DSA_VERIFY                       134
 300 #define ENGINE_F_CSWIFT_FINISH                           100
 301 #define ENGINE_F_CSWIFT_INIT                             101
 302 #define ENGINE_F_CSWIFT_MOD_EXP                          102
 303 #define ENGINE_F_CSWIFT_MOD_EXP_CRT                      103
 304 #define ENGINE_F_CSWIFT_RSA_MOD_EXP                      104
 305 #define ENGINE_F_ENGINE_ADD                              105
 306 #define ENGINE_F_ENGINE_BY_ID                            106
 307 #define ENGINE_F_ENGINE_CTRL                             142
 308 #define ENGINE_F_ENGINE_FINISH                           107
 309 #define ENGINE_F_ENGINE_FREE                             108
 310 #define ENGINE_F_ENGINE_GET_NEXT                         115
 311 #define ENGINE_F_ENGINE_GET_PREV                         116
 312 #define ENGINE_F_ENGINE_INIT                             119
 313 #define ENGINE_F_ENGINE_LIST_ADD                         120
 314 #define ENGINE_F_ENGINE_LIST_REMOVE                      121
 315 #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY                 150
 316 #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY                  151
 317 #define ENGINE_F_ENGINE_NEW                              122
 318 #define ENGINE_F_ENGINE_REMOVE                           123
 319 #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE                 126
 320 #define ENGINE_F_ENGINE_SET_ID                           129
 321 #define ENGINE_F_ENGINE_SET_NAME                         130
 322 #define ENGINE_F_ENGINE_UNLOAD_KEY                       152
 323 #define ENGINE_F_HWCRHK_CTRL                             143
 324 #define ENGINE_F_HWCRHK_FINISH                           135
 325 #define ENGINE_F_HWCRHK_GET_PASS                         155
 326 #define ENGINE_F_HWCRHK_INIT                             136
 327 #define ENGINE_F_HWCRHK_LOAD_PRIVKEY                     153
 328 #define ENGINE_F_HWCRHK_LOAD_PUBKEY                      154
 329 #define ENGINE_F_HWCRHK_MOD_EXP                          137
 330 #define ENGINE_F_HWCRHK_MOD_EXP_CRT                      138
 331 #define ENGINE_F_HWCRHK_RAND_BYTES                       139
 332 #define ENGINE_F_HWCRHK_RSA_MOD_EXP                      140
 333 #define ENGINE_F_LOG_MESSAGE                             141
 334 #define ENGINE_F_NURON_FINISH                            157
 335 #define ENGINE_F_NURON_INIT                              156
 336 #define ENGINE_F_NURON_MOD_EXP                           158
 337 #define ENGINE_F_UBSEC_DSA_SIGN                          163
 338 #define ENGINE_F_UBSEC_DSA_VERIFY                        164
 339 #define ENGINE_F_UBSEC_FINISH                            165
 340 #define ENGINE_F_UBSEC_INIT                              166
 341 #define ENGINE_F_UBSEC_MOD_EXP                           167
 342 #define ENGINE_F_UBSEC_RSA_MOD_EXP                       168
 343 #define ENGINE_F_UBSEC_RSA_MOD_EXP_CRT                   169
 344
 345 /* Reason codes. */
 346 #define ENGINE_R_ALREADY_LOADED                          100
 347 #define ENGINE_R_BIO_WAS_FREED                           121
 348 #define ENGINE_R_BN_CTX_FULL                             101
 349 #define ENGINE_R_BN_EXPAND_FAIL                          102
 350 #define ENGINE_R_CHIL_ERROR                              123
 351 #define ENGINE_R_CONFLICTING_ENGINE_ID                   103
 352 #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED            119
 353 #define ENGINE_R_DSO_FAILURE                             104
 354 #define ENGINE_R_DSO_FUNCTION_NOT_FOUND                  131
 355 #define ENGINE_R_DSO_NOT_FOUND                           132
 356 #define ENGINE_R_ENGINE_IS_NOT_IN_LIST                   105
 357 #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY              128
 358 #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY               129
 359 #define ENGINE_R_FINISH_FAILED                           106
 360 #define ENGINE_R_GET_HANDLE_FAILED                       107
 361 #define ENGINE_R_ID_OR_NAME_MISSING                      108
 362 #define ENGINE_R_INIT_FAILED                             109
 363 #define ENGINE_R_INTERNAL_LIST_ERROR                     110
 364 #define ENGINE_R_MISSING_KEY_COMPONENTS                  111
 365 #define ENGINE_R_NOT_INITIALISED                         117
 366 #define ENGINE_R_NOT_LOADED                              112
 367 #define ENGINE_R_NO_CALLBACK                             127
 368 #define ENGINE_R_NO_CONTROL_FUNCTION                     120
 369 #define ENGINE_R_NO_KEY                                  124
 370 #define ENGINE_R_NO_LOAD_FUNCTION                        125
 371 #define ENGINE_R_NO_REFERENCE                            130
 372 #define ENGINE_R_NO_SUCH_ENGINE                          116
 373 #define ENGINE_R_NO_UNLOAD_FUNCTION                      126
 374 #define ENGINE_R_PROVIDE_PARAMETERS                      113
 375 #define ENGINE_R_REQUEST_FAILED                          114
 376 #define ENGINE_R_REQUEST_FALLBACK                        118
 377 #define ENGINE_R_SIZE_TOO_LARGE_OR_TOO_SMALL             122
 378 #define ENGINE_R_UNIT_FAILURE                            115
 379
 380 #ifdef  __cplusplus
 381 }
 382 #endif
 383 #endif
 384