7931df0e6fc28429cf9f379dd606bb8ed08e99c4
[openssl.git] / 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 /* ENGINE flags that can be set by ENGINE_set_flags(). */
87 /* #define ENGINE_FLAGS_MALLOCED        0x0001 */ /* Not used */
88
89 /* These flags are used to tell the ctrl function what should be done.
90  * All command numbers are shared between all engines, even if some don't
91  * make sense to some engines.  In such a case, they do nothing but return
92  * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */
93 #define ENGINE_CTRL_SET_LOGSTREAM               1
94 #define ENGINE_CTRL_SET_PASSWORD_CALLBACK       2
95 #define ENGINE_CTRL_HUP                         3 /* Close and reinitialise any
96                                                      handles/connections etc. */
97
98 /* Flags specific to the nCipher "chil" engine */
99 #define ENGINE_CTRL_CHIL_SET_FORKCHECK          100
100         /* Depending on the value of the (long)i argument, this sets or
101          * unsets the SimpleForkCheck flag in the CHIL API to enable or
102          * disable checking and workarounds for applications that fork().
103          */
104 #define ENGINE_CTRL_CHIL_NO_LOCKING             101
105         /* This prevents the initialisation function from providing mutex
106          * callbacks to the nCipher library. */
107
108 /* As we're missing a BIGNUM_METHOD, we need a couple of locally
109  * defined function types that engines can implement. */
110
111 /* mod_exp operation, calculates; r = a ^ p mod m
112  * NB: ctx can be NULL, but if supplied, the implementation may use
113  * it if it wishes. */
114 typedef int (*BN_MOD_EXP)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
115                 const BIGNUM *m, BN_CTX *ctx);
116
117 /* private key operation for RSA, provided seperately in case other
118  * RSA implementations wish to use it. */
119 typedef int (*BN_MOD_EXP_CRT)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
120                 const BIGNUM *q, const BIGNUM *dmp1, const BIGNUM *dmq1,
121                 const BIGNUM *iqmp, BN_CTX *ctx);
122
123 /* The list of "engine" types is a static array of (const ENGINE*)
124  * pointers (not dynamic because static is fine for now and we otherwise
125  * have to hook an appropriate load/unload function in to initialise and
126  * cleanup). */
127 struct engine_st;
128 typedef struct engine_st ENGINE;
129
130 /* Generic function pointer */
131 typedef int (*ENGINE_GEN_FUNC_PTR)();
132 /* Generic function pointer taking no arguments */
133 typedef int (*ENGINE_GEN_INT_FUNC_PTR)(ENGINE *);
134 /* Specific control function pointer */
135 typedef int (*ENGINE_CTRL_FUNC_PTR)(ENGINE *, int, long, void *, void (*f)());
136 /* Generic load_key function pointer */
137 typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *, const char *);
138
139 /* STRUCTURE functions ... all of these functions deal with pointers to
140  * ENGINE structures where the pointers have a "structural reference".
141  * This means that their reference is to allow access to the structure
142  * but it does not imply that the structure is functional. To simply
143  * increment or decrement the structural reference count, use ENGINE_new
144  * and ENGINE_free. NB: This is not required when iterating using
145  * ENGINE_get_next as it will automatically decrement the structural
146  * reference count of the "current" ENGINE and increment the structural
147  * reference count of the ENGINE it returns (unless it is NULL). */
148
149 /* Get the first/last "ENGINE" type available. */
150 ENGINE *ENGINE_get_first(void);
151 ENGINE *ENGINE_get_last(void);
152 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
153 ENGINE *ENGINE_get_next(ENGINE *e);
154 ENGINE *ENGINE_get_prev(ENGINE *e);
155 /* Add another "ENGINE" type into the array. */
156 int ENGINE_add(ENGINE *e);
157 /* Remove an existing "ENGINE" type from the array. */
158 int ENGINE_remove(ENGINE *e);
159 /* Retrieve an engine from the list by its unique "id" value. */
160 ENGINE *ENGINE_by_id(const char *id);
161 /* Add all the built-in engines.  By default, only the OpenSSL software
162    engine is loaded */
163 void ENGINE_load_cswift(void);
164 void ENGINE_load_chil(void);
165 void ENGINE_load_atalla(void);
166 void ENGINE_load_nuron(void);
167 void ENGINE_load_ubsec(void);
168 void ENGINE_load_builtin_engines(void);
169
170 /* These functions are useful for manufacturing new ENGINE structures. They
171  * don't address reference counting at all - one uses them to populate an ENGINE
172  * structure with personalised implementations of things prior to using it
173  * directly or adding it to the builtin ENGINE list in OpenSSL. These are also
174  * here so that the ENGINE structure doesn't have to be exposed and break binary
175  * compatibility! */
176 ENGINE *ENGINE_new(void);
177 int ENGINE_free(ENGINE *e);
178 int ENGINE_set_id(ENGINE *e, const char *id);
179 int ENGINE_set_name(ENGINE *e, const char *name);
180 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
181 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
182 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
183 int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth);
184 int ENGINE_set_BN_mod_exp(ENGINE *e, BN_MOD_EXP bn_mod_exp);
185 int ENGINE_set_BN_mod_exp_crt(ENGINE *e, BN_MOD_EXP_CRT bn_mod_exp_crt);
186 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
187 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
188 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
189 int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f);
190 int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f);
191 int ENGINE_set_flags(ENGINE *e, int flags);
192 int ENGINE_cpy(ENGINE *dest, const ENGINE *src);
193
194 /* These return values from within the ENGINE structure. These can be useful
195  * with functional references as well as structural references - it depends
196  * which you obtained. Using the result for functional purposes if you only
197  * obtained a structural reference may be problematic! */
198 const char *ENGINE_get_id(const ENGINE *e);
199 const char *ENGINE_get_name(const ENGINE *e);
200 const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e);
201 const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e);
202 const DH_METHOD *ENGINE_get_DH(const ENGINE *e);
203 const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e);
204 BN_MOD_EXP ENGINE_get_BN_mod_exp(const ENGINE *e);
205 BN_MOD_EXP_CRT ENGINE_get_BN_mod_exp_crt(const ENGINE *e);
206 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e);
207 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e);
208 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e);
209 ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
210 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
211 int ENGINE_get_flags(const ENGINE *e);
212
213 /* FUNCTIONAL functions. These functions deal with ENGINE structures
214  * that have (or will) be initialised for use. Broadly speaking, the
215  * structural functions are useful for iterating the list of available
216  * engine types, creating new engine types, and other "list" operations.
217  * These functions actually deal with ENGINEs that are to be used. As
218  * such these functions can fail (if applicable) when particular
219  * engines are unavailable - eg. if a hardware accelerator is not
220  * attached or not functioning correctly. Each ENGINE has 2 reference
221  * counts; structural and functional. Every time a functional reference
222  * is obtained or released, a corresponding structural reference is
223  * automatically obtained or released too. */
224
225 /* Initialise a engine type for use (or up its reference count if it's
226  * already in use). This will fail if the engine is not currently
227  * operational and cannot initialise. */
228 int ENGINE_init(ENGINE *e);
229 /* Free a functional reference to a engine type. This does not require
230  * a corresponding call to ENGINE_free as it also releases a structural
231  * reference. */
232 int ENGINE_finish(ENGINE *e);
233 /* Send control parametrised commands to the engine.  The possibilities
234  * to send down an integer, a pointer to data or a function pointer are
235  * provided.  Any of the parameters may or may not be NULL, depending
236  * on the command number */
237 /* WARNING: This is currently experimental and may change radically! */
238 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
239
240 /* The following functions handle keys that are stored in some secondary
241  * location, handled by the engine.  The storage may be on a card or
242  * whatever. */
243 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
244         const char *passphrase);
245 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
246         const char *passphrase);
247
248 /* This returns a pointer for the current ENGINE structure that
249  * is (by default) performing any RSA operations. The value returned
250  * is an incremented reference, so it should be free'd (ENGINE_finish)
251  * before it is discarded. */
252 ENGINE *ENGINE_get_default_RSA(void);
253 /* Same for the other "methods" */
254 ENGINE *ENGINE_get_default_DSA(void);
255 ENGINE *ENGINE_get_default_DH(void);
256 ENGINE *ENGINE_get_default_RAND(void);
257 ENGINE *ENGINE_get_default_BN_mod_exp(void);
258 ENGINE *ENGINE_get_default_BN_mod_exp_crt(void);
259
260 /* This sets a new default ENGINE structure for performing RSA
261  * operations. If the result is non-zero (success) then the ENGINE
262  * structure will have had its reference count up'd so the caller
263  * should still free their own reference 'e'. */
264 int ENGINE_set_default_RSA(ENGINE *e);
265 /* Same for the other "methods" */
266 int ENGINE_set_default_DSA(ENGINE *e);
267 int ENGINE_set_default_DH(ENGINE *e);
268 int ENGINE_set_default_RAND(ENGINE *e);
269 int ENGINE_set_default_BN_mod_exp(ENGINE *e);
270 int ENGINE_set_default_BN_mod_exp_crt(ENGINE *e);
271
272 /* The combination "set" - the flags are bitwise "OR"d from the
273  * ENGINE_METHOD_*** defines above. */
274 int ENGINE_set_default(ENGINE *e, unsigned int flags);
275
276 /* Obligatory error function. */
277 void ERR_load_ENGINE_strings(void);
278
279 /*
280  * Error codes for all engine functions. NB: We use "generic"
281  * function names instead of per-implementation ones because this
282  * levels the playing field for externally implemented bootstrapped
283  * support code. As the filename and line number is included, it's
284  * more important to indicate the type of function, so that
285  * bootstrapped code (that can't easily add its own errors in) can
286  * use the same error codes too.
287  */
288
289 /* BEGIN ERROR CODES */
290 /* The following lines are auto generated by the script mkerr.pl. Any changes
291  * made after this point may be overwritten when the script is next run.
292  */
293
294 /* Error codes for the ENGINE functions. */
295
296 /* Function codes. */
297 #define ENGINE_F_ATALLA_FINISH                           159
298 #define ENGINE_F_ATALLA_INIT                             160
299 #define ENGINE_F_ATALLA_MOD_EXP                          161
300 #define ENGINE_F_ATALLA_RSA_MOD_EXP                      162
301 #define ENGINE_F_CSWIFT_DSA_SIGN                         133
302 #define ENGINE_F_CSWIFT_DSA_VERIFY                       134
303 #define ENGINE_F_CSWIFT_FINISH                           100
304 #define ENGINE_F_CSWIFT_INIT                             101
305 #define ENGINE_F_CSWIFT_MOD_EXP                          102
306 #define ENGINE_F_CSWIFT_MOD_EXP_CRT                      103
307 #define ENGINE_F_CSWIFT_RSA_MOD_EXP                      104
308 #define ENGINE_F_ENGINE_ADD                              105
309 #define ENGINE_F_ENGINE_BY_ID                            106
310 #define ENGINE_F_ENGINE_CTRL                             142
311 #define ENGINE_F_ENGINE_FINISH                           107
312 #define ENGINE_F_ENGINE_FREE                             108
313 #define ENGINE_F_ENGINE_GET_NEXT                         115
314 #define ENGINE_F_ENGINE_GET_PREV                         116
315 #define ENGINE_F_ENGINE_INIT                             119
316 #define ENGINE_F_ENGINE_LIST_ADD                         120
317 #define ENGINE_F_ENGINE_LIST_REMOVE                      121
318 #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY                 150
319 #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY                  151
320 #define ENGINE_F_ENGINE_NEW                              122
321 #define ENGINE_F_ENGINE_REMOVE                           123
322 #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE                 126
323 #define ENGINE_F_ENGINE_SET_ID                           129
324 #define ENGINE_F_ENGINE_SET_NAME                         130
325 #define ENGINE_F_ENGINE_UNLOAD_KEY                       152
326 #define ENGINE_F_HWCRHK_CTRL                             143
327 #define ENGINE_F_HWCRHK_FINISH                           135
328 #define ENGINE_F_HWCRHK_GET_PASS                         155
329 #define ENGINE_F_HWCRHK_INIT                             136
330 #define ENGINE_F_HWCRHK_LOAD_PRIVKEY                     153
331 #define ENGINE_F_HWCRHK_LOAD_PUBKEY                      154
332 #define ENGINE_F_HWCRHK_MOD_EXP                          137
333 #define ENGINE_F_HWCRHK_MOD_EXP_CRT                      138
334 #define ENGINE_F_HWCRHK_RAND_BYTES                       139
335 #define ENGINE_F_HWCRHK_RSA_MOD_EXP                      140
336 #define ENGINE_F_LOG_MESSAGE                             141
337 #define ENGINE_F_NURON_FINISH                            157
338 #define ENGINE_F_NURON_INIT                              156
339 #define ENGINE_F_NURON_MOD_EXP                           158
340 #define ENGINE_F_UBSEC_DSA_SIGN                          163
341 #define ENGINE_F_UBSEC_DSA_VERIFY                        164
342 #define ENGINE_F_UBSEC_FINISH                            165
343 #define ENGINE_F_UBSEC_INIT                              166
344 #define ENGINE_F_UBSEC_MOD_EXP                           167
345 #define ENGINE_F_UBSEC_RSA_MOD_EXP                       168
346 #define ENGINE_F_UBSEC_RSA_MOD_EXP_CRT                   169
347
348 /* Reason codes. */
349 #define ENGINE_R_ALREADY_LOADED                          100
350 #define ENGINE_R_BIO_WAS_FREED                           121
351 #define ENGINE_R_BN_CTX_FULL                             101
352 #define ENGINE_R_BN_EXPAND_FAIL                          102
353 #define ENGINE_R_CHIL_ERROR                              123
354 #define ENGINE_R_CONFLICTING_ENGINE_ID                   103
355 #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED            119
356 #define ENGINE_R_DSO_FAILURE                             104
357 #define ENGINE_R_DSO_FUNCTION_NOT_FOUND                  131
358 #define ENGINE_R_DSO_NOT_FOUND                           132
359 #define ENGINE_R_ENGINE_IS_NOT_IN_LIST                   105
360 #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY              128
361 #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY               129
362 #define ENGINE_R_FINISH_FAILED                           106
363 #define ENGINE_R_GET_HANDLE_FAILED                       107
364 #define ENGINE_R_ID_OR_NAME_MISSING                      108
365 #define ENGINE_R_INIT_FAILED                             109
366 #define ENGINE_R_INTERNAL_LIST_ERROR                     110
367 #define ENGINE_R_MISSING_KEY_COMPONENTS                  111
368 #define ENGINE_R_NOT_INITIALISED                         117
369 #define ENGINE_R_NOT_LOADED                              112
370 #define ENGINE_R_NO_CALLBACK                             127
371 #define ENGINE_R_NO_CONTROL_FUNCTION                     120
372 #define ENGINE_R_NO_KEY                                  124
373 #define ENGINE_R_NO_LOAD_FUNCTION                        125
374 #define ENGINE_R_NO_REFERENCE                            130
375 #define ENGINE_R_NO_SUCH_ENGINE                          116
376 #define ENGINE_R_NO_UNLOAD_FUNCTION                      126
377 #define ENGINE_R_PROVIDE_PARAMETERS                      113
378 #define ENGINE_R_REQUEST_FAILED                          114
379 #define ENGINE_R_REQUEST_FALLBACK                        118
380 #define ENGINE_R_SIZE_TOO_LARGE_OR_TOO_SMALL             122
381 #define ENGINE_R_UNIT_FAILURE                            115
382
383 #ifdef  __cplusplus
384 }
385 #endif
386 #endif
387