1 /* crypto/engine/engine_int.h */
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_INT_H
60 #define HEADER_ENGINE_INT_H
62 /* Take public definitions from engine.h */
63 #include <openssl/engine.h>
69 #define ENGINE_REF_COUNT_DEBUG
71 /* If we compile with this symbol defined, then both reference counts in the
72 * ENGINE structure will be monitored with a line of output on stderr for each
73 * change. This prints the engine's pointer address (truncated to unsigned int),
74 * "struct" or "funct" to indicate the reference type, the before and after
75 * reference count, and the file:line-number pair. The "engine_ref_debug"
76 * statements must come *after* the change. */
77 #ifdef ENGINE_REF_COUNT_DEBUG
79 #define engine_ref_debug(e, isfunct, diff) \
80 fprintf(stderr, "blargle: %08x %s from %d to %d (%s:%d)\n", \
81 (unsigned int)(e), (isfunct ? "funct" : "struct"), \
82 ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \
83 ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \
84 (__FILE__), (__LINE__));
88 #define engine_ref_debug(e, isfunct, diff)
92 /* NB: Bitwise OR-able values for the "flags" variable in ENGINE are now exposed
95 /* This is a structure for storing implementations of various crypto
96 * algorithms and functions. */
101 const RSA_METHOD *rsa_meth;
102 const DSA_METHOD *dsa_meth;
103 const DH_METHOD *dh_meth;
104 const RAND_METHOD *rand_meth;
105 BN_MOD_EXP bn_mod_exp;
106 BN_MOD_EXP_CRT bn_mod_exp_crt;
107 ENGINE_GEN_INT_FUNC_PTR init;
108 ENGINE_GEN_INT_FUNC_PTR finish;
109 ENGINE_CTRL_FUNC_PTR ctrl;
110 ENGINE_LOAD_KEY_PTR load_privkey;
111 ENGINE_LOAD_KEY_PTR load_pubkey;
112 const ENGINE_CMD_DEFN *cmd_defns;
114 /* reference count on the structure itself */
116 /* reference count on usability of the engine type. NB: This
117 * controls the loading and initialisation of any functionlity
118 * required by this engine, whereas the previous count is
119 * simply to cope with (de)allocation of this structure. Hence,
120 * running_ref <= struct_ref at all times. */
122 /* A place to store per-key data */
123 CRYPTO_EX_DATA ex_data;
124 /* Used to maintain the linked-list of engines. */
125 struct engine_st *prev;
126 struct engine_st *next;
129 /* BUILT-IN ENGINES. (these functions are only ever called once and
130 * do not return references - they are purely for bootstrapping). */
132 /* Returns a structure of software only methods (the default). */
133 ENGINE *ENGINE_openssl();
135 #ifndef OPENSSL_NO_HW
137 #ifndef OPENSSL_NO_HW_CSWIFT
138 /* Returns a structure of cswift methods ... NB: This can exist and be
139 * "used" even on non-cswift systems because the "init" will fail if the
140 * card/library are not found. */
141 ENGINE *ENGINE_cswift();
142 #endif /* !OPENSSL_NO_HW_CSWIFT */
144 #ifndef OPENSSL_NO_HW_NCIPHER
145 ENGINE *ENGINE_ncipher();
146 #endif /* !OPENSSL_NO_HW_NCIPHER */
148 #ifndef OPENSSL_NO_HW_ATALLA
149 /* Returns a structure of atalla methods. */
150 ENGINE *ENGINE_atalla();
151 #endif /* !OPENSSL_NO_HW_ATALLA */
153 #ifndef OPENSSL_NO_HW_NURON
154 ENGINE *ENGINE_nuron();
155 #endif /* !OPENSSL_NO_HW_NURON */
157 #ifndef OPENSSL_NO_HW_UBSEC
158 ENGINE *ENGINE_ubsec();
159 #endif /* !OPENSSL_NO_HW_UBSEC */
161 #endif /* !OPENSSL_NO_HW */
167 #endif /* HEADER_ENGINE_INT_H */