]>
Commit | Line | Data |
---|---|---|
5270e702 RL |
1 | /* crypto/engine/engine_int.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_INT_H | |
60 | #define HEADER_ENGINE_INT_H | |
61 | ||
11c0f120 RL |
62 | /* Take public definitions from engine.h */ |
63 | #include <openssl/engine.h> | |
64 | ||
5270e702 RL |
65 | #ifdef __cplusplus |
66 | extern "C" { | |
67 | #endif | |
68 | ||
b41f836e GT |
69 | /* If we compile with this symbol defined, then both reference counts in the |
70 | * ENGINE structure will be monitored with a line of output on stderr for each | |
71 | * change. This prints the engine's pointer address (truncated to unsigned int), | |
72 | * "struct" or "funct" to indicate the reference type, the before and after | |
73 | * reference count, and the file:line-number pair. The "engine_ref_debug" | |
74 | * statements must come *after* the change. */ | |
75 | #ifdef ENGINE_REF_COUNT_DEBUG | |
76 | ||
77 | #define engine_ref_debug(e, isfunct, diff) \ | |
06cb0353 | 78 | fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \ |
b41f836e GT |
79 | (unsigned int)(e), (isfunct ? "funct" : "struct"), \ |
80 | ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \ | |
81 | ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \ | |
82 | (__FILE__), (__LINE__)); | |
83 | ||
84 | #else | |
85 | ||
86 | #define engine_ref_debug(e, isfunct, diff) | |
87 | ||
88 | #endif | |
89 | ||
354c3ace BL |
90 | typedef struct engine_evp_cipher_st |
91 | { | |
92 | const EVP_CIPHER *cipher; | |
93 | } ENGINE_EVP_CIPHER; | |
94 | ||
95 | DECLARE_STACK_OF(ENGINE_EVP_CIPHER) | |
96 | ||
97 | void ENGINE_free_engine_cipher(ENGINE_EVP_CIPHER *p); | |
98 | ||
dcd87618 GT |
99 | /* NB: Bitwise OR-able values for the "flags" variable in ENGINE are now exposed |
100 | * in engine.h. */ | |
5270e702 | 101 | |
5270e702 RL |
102 | /* This is a structure for storing implementations of various crypto |
103 | * algorithms and functions. */ | |
11c0f120 | 104 | struct engine_st |
5270e702 RL |
105 | { |
106 | const char *id; | |
107 | const char *name; | |
10e473e9 | 108 | const RSA_METHOD *rsa_meth; |
a4aba800 | 109 | const DSA_METHOD *dsa_meth; |
f971ccb2 | 110 | const DH_METHOD *dh_meth; |
d54bf145 | 111 | const RAND_METHOD *rand_meth; |
354c3ace | 112 | |
5270e702 RL |
113 | BN_MOD_EXP bn_mod_exp; |
114 | BN_MOD_EXP_CRT bn_mod_exp_crt; | |
404f952a GT |
115 | ENGINE_GEN_INT_FUNC_PTR init; |
116 | ENGINE_GEN_INT_FUNC_PTR finish; | |
117 | ENGINE_CTRL_FUNC_PTR ctrl; | |
118 | ENGINE_LOAD_KEY_PTR load_privkey; | |
119 | ENGINE_LOAD_KEY_PTR load_pubkey; | |
354c3ace BL |
120 | |
121 | STACK_OF(ENGINE_EVP_CIPHER) *ciphers; | |
122 | ||
40fcda29 | 123 | const ENGINE_CMD_DEFN *cmd_defns; |
5270e702 RL |
124 | int flags; |
125 | /* reference count on the structure itself */ | |
126 | int struct_ref; | |
127 | /* reference count on usability of the engine type. NB: This | |
128 | * controls the loading and initialisation of any functionlity | |
129 | * required by this engine, whereas the previous count is | |
130 | * simply to cope with (de)allocation of this structure. Hence, | |
131 | * running_ref <= struct_ref at all times. */ | |
132 | int funct_ref; | |
0ce5f3e4 GT |
133 | /* A place to store per-key data */ |
134 | CRYPTO_EX_DATA ex_data; | |
5270e702 RL |
135 | /* Used to maintain the linked-list of engines. */ |
136 | struct engine_st *prev; | |
137 | struct engine_st *next; | |
11c0f120 | 138 | }; |
5270e702 RL |
139 | |
140 | /* BUILT-IN ENGINES. (these functions are only ever called once and | |
141 | * do not return references - they are purely for bootstrapping). */ | |
142 | ||
143 | /* Returns a structure of software only methods (the default). */ | |
144 | ENGINE *ENGINE_openssl(); | |
145 | ||
cf1b7d96 | 146 | #ifndef OPENSSL_NO_HW |
5270e702 | 147 | |
cf1b7d96 | 148 | #ifndef OPENSSL_NO_HW_CSWIFT |
5270e702 RL |
149 | /* Returns a structure of cswift methods ... NB: This can exist and be |
150 | * "used" even on non-cswift systems because the "init" will fail if the | |
151 | * card/library are not found. */ | |
152 | ENGINE *ENGINE_cswift(); | |
cf1b7d96 | 153 | #endif /* !OPENSSL_NO_HW_CSWIFT */ |
5270e702 | 154 | |
cf1b7d96 | 155 | #ifndef OPENSSL_NO_HW_NCIPHER |
5270e702 | 156 | ENGINE *ENGINE_ncipher(); |
cf1b7d96 | 157 | #endif /* !OPENSSL_NO_HW_NCIPHER */ |
5270e702 | 158 | |
cf1b7d96 | 159 | #ifndef OPENSSL_NO_HW_ATALLA |
5270e702 RL |
160 | /* Returns a structure of atalla methods. */ |
161 | ENGINE *ENGINE_atalla(); | |
cf1b7d96 | 162 | #endif /* !OPENSSL_NO_HW_ATALLA */ |
5270e702 | 163 | |
cf1b7d96 | 164 | #ifndef OPENSSL_NO_HW_NURON |
5270e702 | 165 | ENGINE *ENGINE_nuron(); |
cf1b7d96 | 166 | #endif /* !OPENSSL_NO_HW_NURON */ |
5270e702 | 167 | |
cf1b7d96 | 168 | #ifndef OPENSSL_NO_HW_UBSEC |
016d7d25 | 169 | ENGINE *ENGINE_ubsec(); |
cf1b7d96 | 170 | #endif /* !OPENSSL_NO_HW_UBSEC */ |
016d7d25 | 171 | |
354c3ace BL |
172 | #ifdef OPENSSL_OPENBSD_DEV_CRYPTO |
173 | ENGINE *ENGINE_openbsd_dev_crypto(void); | |
174 | #endif | |
175 | ||
cf1b7d96 | 176 | #endif /* !OPENSSL_NO_HW */ |
5270e702 RL |
177 | |
178 | #ifdef __cplusplus | |
179 | } | |
180 | #endif | |
181 | ||
182 | #endif /* HEADER_ENGINE_INT_H */ |