2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
59 #ifndef HEADER_ENGINE_H
60 #define HEADER_ENGINE_H
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>
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
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. */
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().
101 #define ENGINE_CTRL_CHIL_NO_LOCKING 101
102 /* This prevents the initialisation function from providing mutex
103 * callbacks to the nCipher library. */
105 /* As we're missing a BIGNUM_METHOD, we need a couple of locally
106 * defined function types that engines can implement. */
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);
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);
120 /* Generic function pointer */
121 typedef int (*ENGINE_GEN_FUNC_PTR)();
122 /* Generic function pointer taking no arguments */
123 typedef int (*ENGINE_GEN_INT_FUNC_PTR)(void);
124 /* Specific control function pointer */
125 typedef int (*ENGINE_CTRL_FUNC_PTR)(int cmd, long i, void *p, void (*f)());
127 /* The list of "engine" types is a static array of (const ENGINE*)
128 * pointers (not dynamic because static is fine for now and we otherwise
129 * have to hook an appropriate load/unload function in to initialise and
132 typedef struct engine_st ENGINE;
134 /* STRUCTURE functions ... all of these functions deal with pointers to
135 * ENGINE structures where the pointers have a "structural reference".
136 * This means that their reference is to allow access to the structure
137 * but it does not imply that the structure is functional. To simply
138 * increment or decrement the structural reference count, use ENGINE_new
139 * and ENGINE_free. NB: This is not required when iterating using
140 * ENGINE_get_next as it will automatically decrement the structural
141 * reference count of the "current" ENGINE and increment the structural
142 * reference count of the ENGINE it returns (unless it is NULL). */
144 /* Get the first/last "ENGINE" type available. */
145 ENGINE *ENGINE_get_first(void);
146 ENGINE *ENGINE_get_last(void);
147 /* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */
148 ENGINE *ENGINE_get_next(ENGINE *e);
149 ENGINE *ENGINE_get_prev(ENGINE *e);
150 /* Add another "ENGINE" type into the array. */
151 int ENGINE_add(ENGINE *e);
152 /* Remove an existing "ENGINE" type from the array. */
153 int ENGINE_remove(ENGINE *e);
154 /* Retrieve an engine from the list by its unique "id" value. */
155 ENGINE *ENGINE_by_id(const char *id);
156 /* Add all the built-in engines. By default, only the OpenSSL software
158 void ENGINE_load_cswift(void);
159 void ENGINE_load_chil(void);
160 void ENGINE_load_atalla(void);
161 void ENGINE_load_nuron(void);
162 void ENGINE_load_ubsec(void);
163 void ENGINE_load_builtin_engines(void);
165 /* These functions are useful for manufacturing new ENGINE
166 * structures. They don't address reference counting at all -
167 * one uses them to populate an ENGINE structure with personalised
168 * implementations of things prior to using it directly or adding
169 * it to the builtin ENGINE list in OpenSSL. These are also here
170 * so that the ENGINE structure doesn't have to be exposed and
171 * break binary compatibility!
173 * NB: I'm changing ENGINE_new to force the ENGINE structure to
174 * be allocated from within OpenSSL. See the comment for
175 * ENGINE_get_struct_size().
178 ENGINE *ENGINE_new(ENGINE *e);
180 ENGINE *ENGINE_new(void);
182 int ENGINE_free(ENGINE *e);
183 int ENGINE_set_id(ENGINE *e, const char *id);
184 int ENGINE_set_name(ENGINE *e, const char *name);
185 int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth);
186 int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth);
187 int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth);
188 int ENGINE_set_RAND(ENGINE *e, RAND_METHOD *rand_meth);
189 int ENGINE_set_BN_mod_exp(ENGINE *e, BN_MOD_EXP bn_mod_exp);
190 int ENGINE_set_BN_mod_exp_crt(ENGINE *e, BN_MOD_EXP_CRT bn_mod_exp_crt);
191 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f);
192 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f);
193 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f);
195 /* These return values from within the ENGINE structure. These can
196 * be useful with functional references as well as structural
197 * references - it depends which you obtained. Using the result
198 * for functional purposes if you only obtained a structural
199 * reference may be problematic! */
200 const char *ENGINE_get_id(ENGINE *e);
201 const char *ENGINE_get_name(ENGINE *e);
202 const RSA_METHOD *ENGINE_get_RSA(ENGINE *e);
203 const DSA_METHOD *ENGINE_get_DSA(ENGINE *e);
204 const DH_METHOD *ENGINE_get_DH(ENGINE *e);
205 RAND_METHOD *ENGINE_get_RAND(ENGINE *e);
206 BN_MOD_EXP ENGINE_get_BN_mod_exp(ENGINE *e);
207 BN_MOD_EXP_CRT ENGINE_get_BN_mod_exp_crt(ENGINE *e);
208 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(ENGINE *e);
209 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(ENGINE *e);
210 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(ENGINE *e);
212 /* ENGINE_new is normally passed a NULL in the first parameter because
213 * the calling code doesn't have access to the definition of the ENGINE
214 * structure (for good reason). However, if the caller wishes to use
215 * its own memory allocation or use a static array, the following call
216 * should be used to check the amount of memory the ENGINE structure
217 * will occupy. This will make the code more future-proof.
219 * NB: I'm "#if 0"-ing this out because it's better to force the use of
220 * internally allocated memory. See similar change in ENGINE_new().
223 int ENGINE_get_struct_size(void);
226 /* FUNCTIONAL functions. These functions deal with ENGINE structures
227 * that have (or will) be initialised for use. Broadly speaking, the
228 * structural functions are useful for iterating the list of available
229 * engine types, creating new engine types, and other "list" operations.
230 * These functions actually deal with ENGINEs that are to be used. As
231 * such these functions can fail (if applicable) when particular
232 * engines are unavailable - eg. if a hardware accelerator is not
233 * attached or not functioning correctly. Each ENGINE has 2 reference
234 * counts; structural and functional. Every time a functional reference
235 * is obtained or released, a corresponding structural reference is
236 * automatically obtained or released too. */
238 /* Initialise a engine type for use (or up its reference count if it's
239 * already in use). This will fail if the engine is not currently
240 * operational and cannot initialise. */
241 int ENGINE_init(ENGINE *e);
242 /* Free a functional reference to a engine type. This does not require
243 * a corresponding call to ENGINE_free as it also releases a structural
245 int ENGINE_finish(ENGINE *e);
246 /* Send control parametrised commands to the engine. The possibilities
247 * to send down an integer, a pointer to data or a function pointer are
248 * provided. Any of the parameters may or may not be NULL, depending
249 * on the command number */
250 /* WARNING: This is currently experimental and may change radically! */
251 int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)());
253 /* The following functions handle keys that are stored in some secondary
254 * location, handled by the engine. The storage may be on a card or
256 EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id,
257 const char *passphrase);
258 EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id,
259 const char *passphrase);
261 /* This returns a pointer for the current ENGINE structure that
262 * is (by default) performing any RSA operations. The value returned
263 * is an incremented reference, so it should be free'd (ENGINE_finish)
264 * before it is discarded. */
265 ENGINE *ENGINE_get_default_RSA(void);
266 /* Same for the other "methods" */
267 ENGINE *ENGINE_get_default_DSA(void);
268 ENGINE *ENGINE_get_default_DH(void);
269 ENGINE *ENGINE_get_default_RAND(void);
270 ENGINE *ENGINE_get_default_BN_mod_exp(void);
271 ENGINE *ENGINE_get_default_BN_mod_exp_crt(void);
273 /* This sets a new default ENGINE structure for performing RSA
274 * operations. If the result is non-zero (success) then the ENGINE
275 * structure will have had its reference count up'd so the caller
276 * should still free their own reference 'e'. */
277 int ENGINE_set_default_RSA(ENGINE *e);
278 /* Same for the other "methods" */
279 int ENGINE_set_default_DSA(ENGINE *e);
280 int ENGINE_set_default_DH(ENGINE *e);
281 int ENGINE_set_default_RAND(ENGINE *e);
282 int ENGINE_set_default_BN_mod_exp(ENGINE *e);
283 int ENGINE_set_default_BN_mod_exp_crt(ENGINE *e);
285 /* The combination "set" - the flags are bitwise "OR"d from the
286 * ENGINE_METHOD_*** defines above. */
287 int ENGINE_set_default(ENGINE *e, unsigned int flags);
289 /* Obligatory error function. */
290 void ERR_load_ENGINE_strings(void);
293 * Error codes for all engine functions. NB: We use "generic"
294 * function names instead of per-implementation ones because this
295 * levels the playing field for externally implemented bootstrapped
296 * support code. As the filename and line number is included, it's
297 * more important to indicate the type of function, so that
298 * bootstrapped code (that can't easily add its own errors in) can
299 * use the same error codes too.
302 /* BEGIN ERROR CODES */
303 /* The following lines are auto generated by the script mkerr.pl. Any changes
304 * made after this point may be overwritten when the script is next run.
307 /* Error codes for the ENGINE functions. */
309 /* Function codes. */
310 #define ENGINE_F_ATALLA_FINISH 159
311 #define ENGINE_F_ATALLA_INIT 160
312 #define ENGINE_F_ATALLA_MOD_EXP 161
313 #define ENGINE_F_ATALLA_RSA_MOD_EXP 162
314 #define ENGINE_F_CSWIFT_DSA_SIGN 133
315 #define ENGINE_F_CSWIFT_DSA_VERIFY 134
316 #define ENGINE_F_CSWIFT_FINISH 100
317 #define ENGINE_F_CSWIFT_INIT 101
318 #define ENGINE_F_CSWIFT_MOD_EXP 102
319 #define ENGINE_F_CSWIFT_MOD_EXP_CRT 103
320 #define ENGINE_F_CSWIFT_RSA_MOD_EXP 104
321 #define ENGINE_F_ENGINE_ADD 105
322 #define ENGINE_F_ENGINE_BY_ID 106
323 #define ENGINE_F_ENGINE_CTRL 142
324 #define ENGINE_F_ENGINE_FINISH 107
325 #define ENGINE_F_ENGINE_FREE 108
326 #define ENGINE_F_ENGINE_GET_BN_MOD_EXP 109
327 #define ENGINE_F_ENGINE_GET_BN_MOD_EXP_CRT 110
328 #define ENGINE_F_ENGINE_GET_CTRL_FUNCTION 144
329 #define ENGINE_F_ENGINE_GET_DH 111
330 #define ENGINE_F_ENGINE_GET_DSA 112
331 #define ENGINE_F_ENGINE_GET_FINISH_FUNCTION 145
332 #define ENGINE_F_ENGINE_GET_ID 113
333 #define ENGINE_F_ENGINE_GET_INIT_FUNCTION 146
334 #define ENGINE_F_ENGINE_GET_NAME 114
335 #define ENGINE_F_ENGINE_GET_NEXT 115
336 #define ENGINE_F_ENGINE_GET_PREV 116
337 #define ENGINE_F_ENGINE_GET_RAND 117
338 #define ENGINE_F_ENGINE_GET_RSA 118
339 #define ENGINE_F_ENGINE_INIT 119
340 #define ENGINE_F_ENGINE_LIST_ADD 120
341 #define ENGINE_F_ENGINE_LIST_REMOVE 121
342 #define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150
343 #define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151
344 #define ENGINE_F_ENGINE_NEW 122
345 #define ENGINE_F_ENGINE_REMOVE 123
346 #define ENGINE_F_ENGINE_SET_BN_MOD_EXP 124
347 #define ENGINE_F_ENGINE_SET_BN_MOD_EXP_CRT 125
348 #define ENGINE_F_ENGINE_SET_CTRL_FUNCTION 147
349 #define ENGINE_F_ENGINE_SET_DEFAULT_TYPE 126
350 #define ENGINE_F_ENGINE_SET_DH 127
351 #define ENGINE_F_ENGINE_SET_DSA 128
352 #define ENGINE_F_ENGINE_SET_FINISH_FUNCTION 148
353 #define ENGINE_F_ENGINE_SET_ID 129
354 #define ENGINE_F_ENGINE_SET_INIT_FUNCTION 149
355 #define ENGINE_F_ENGINE_SET_NAME 130
356 #define ENGINE_F_ENGINE_SET_RAND 131
357 #define ENGINE_F_ENGINE_SET_RSA 132
358 #define ENGINE_F_ENGINE_UNLOAD_KEY 152
359 #define ENGINE_F_HWCRHK_CTRL 143
360 #define ENGINE_F_HWCRHK_FINISH 135
361 #define ENGINE_F_HWCRHK_GET_PASS 155
362 #define ENGINE_F_HWCRHK_INIT 136
363 #define ENGINE_F_HWCRHK_LOAD_PRIVKEY 153
364 #define ENGINE_F_HWCRHK_LOAD_PUBKEY 154
365 #define ENGINE_F_HWCRHK_MOD_EXP 137
366 #define ENGINE_F_HWCRHK_MOD_EXP_CRT 138
367 #define ENGINE_F_HWCRHK_RAND_BYTES 139
368 #define ENGINE_F_HWCRHK_RSA_MOD_EXP 140
369 #define ENGINE_F_LOG_MESSAGE 141
370 #define ENGINE_F_NURON_FINISH 157
371 #define ENGINE_F_NURON_INIT 156
372 #define ENGINE_F_NURON_MOD_EXP 158
373 #define ENGINE_F_UBSEC_DSA_SIGN 163
374 #define ENGINE_F_UBSEC_DSA_VERIFY 164
375 #define ENGINE_F_UBSEC_FINISH 165
376 #define ENGINE_F_UBSEC_INIT 166
377 #define ENGINE_F_UBSEC_MOD_EXP 167
378 #define ENGINE_F_UBSEC_RSA_MOD_EXP 168
379 #define ENGINE_F_UBSEC_RSA_MOD_EXP_CRT 169
382 #define ENGINE_R_ALREADY_LOADED 100
383 #define ENGINE_R_BIO_WAS_FREED 121
384 #define ENGINE_R_BN_CTX_FULL 101
385 #define ENGINE_R_BN_EXPAND_FAIL 102
386 #define ENGINE_R_CHIL_ERROR 123
387 #define ENGINE_R_CONFLICTING_ENGINE_ID 103
388 #define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119
389 #define ENGINE_R_DSO_FAILURE 104
390 #define ENGINE_R_DSO_FUNCTION_NOT_FOUND 131
391 #define ENGINE_R_DSO_NOT_FOUND 132
392 #define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105
393 #define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128
394 #define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129
395 #define ENGINE_R_FINISH_FAILED 106
396 #define ENGINE_R_GET_HANDLE_FAILED 107
397 #define ENGINE_R_ID_OR_NAME_MISSING 108
398 #define ENGINE_R_INIT_FAILED 109
399 #define ENGINE_R_INTERNAL_LIST_ERROR 110
400 #define ENGINE_R_MISSING_KEY_COMPONENTS 111
401 #define ENGINE_R_NOT_INITIALISED 117
402 #define ENGINE_R_NOT_LOADED 112
403 #define ENGINE_R_NO_CALLBACK 127
404 #define ENGINE_R_NO_CONTROL_FUNCTION 120
405 #define ENGINE_R_NO_KEY 124
406 #define ENGINE_R_NO_LOAD_FUNCTION 125
407 #define ENGINE_R_NO_REFERENCE 130
408 #define ENGINE_R_NO_SUCH_ENGINE 116
409 #define ENGINE_R_NO_UNLOAD_FUNCTION 126
410 #define ENGINE_R_PROVIDE_PARAMETERS 113
411 #define ENGINE_R_REQUEST_FAILED 114
412 #define ENGINE_R_REQUEST_FALLBACK 118
413 #define ENGINE_R_SIZE_TOO_LARGE_OR_TOO_SMALL 122
414 #define ENGINE_R_UNIT_FAILURE 115
projects / openssl.git / blob