1 /* crypto/engine/eng_int.h */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999-2001 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).
58 /* ====================================================================
59 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60 * ECDH support in OpenSSL originally developed by
61 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
64 #ifndef HEADER_ENGINE_INT_H
65 #define HEADER_ENGINE_INT_H
68 /* Take public definitions from engine.h */
69 #include <openssl/engine.h>
75 /* If we compile with this symbol defined, then both reference counts in the
76 * ENGINE structure will be monitored with a line of output on stderr for each
77 * change. This prints the engine's pointer address (truncated to unsigned int),
78 * "struct" or "funct" to indicate the reference type, the before and after
79 * reference count, and the file:line-number pair. The "engine_ref_debug"
80 * statements must come *after* the change. */
81 #ifdef ENGINE_REF_COUNT_DEBUG
83 #define engine_ref_debug(e, isfunct, diff) \
84 fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \
85 (unsigned int)(e), (isfunct ? "funct" : "struct"), \
86 ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \
87 ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \
88 (__FILE__), (__LINE__));
92 #define engine_ref_debug(e, isfunct, diff)
96 /* Any code that will need cleanup operations should use these functions to
97 * register callbacks. ENGINE_cleanup() will call all registered callbacks in
98 * order. NB: both the "add" functions assume CRYPTO_LOCK_ENGINE to already be
99 * held (in "write" mode). */
100 typedef void (ENGINE_CLEANUP_CB)(void);
101 typedef struct st_engine_cleanup_item
103 ENGINE_CLEANUP_CB *cb;
104 } ENGINE_CLEANUP_ITEM;
105 DECLARE_STACK_OF(ENGINE_CLEANUP_ITEM)
106 IMPORT_C void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb);
107 IMPORT_C void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb);
109 /* We need stacks of ENGINEs for use in eng_table.c */
110 DECLARE_STACK_OF(ENGINE)
112 /* If this symbol is defined then engine_table_select(), the function that is
113 * used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults and
114 * functional references (etc), will display debugging summaries to stderr. */
115 /* #define ENGINE_TABLE_DEBUG */
117 /* This represents an implementation table. Dependent code should instantiate it
118 * as a (ENGINE_TABLE *) pointer value set initially to NULL. */
119 typedef struct st_engine_table ENGINE_TABLE;
120 IMPORT_C int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
121 ENGINE *e, const int *nids, int num_nids, int setdefault);
122 IMPORT_C void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e);
123 IMPORT_C void engine_table_cleanup(ENGINE_TABLE **table);
124 #ifndef ENGINE_TABLE_DEBUG
125 IMPORT_C ENGINE *engine_table_select(ENGINE_TABLE **table, int nid);
127 ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f, int l);
128 #define engine_table_select(t,n) engine_table_select_tmp(t,n,__FILE__,__LINE__)
131 /* Internal versions of API functions that have control over locking. These are
132 * used between C files when functionality needs to be shared but the caller may
133 * already be controlling of the CRYPTO_LOCK_ENGINE lock. */
134 IMPORT_C int engine_unlocked_init(ENGINE *e);
135 IMPORT_C int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers);
136 IMPORT_C int engine_free_util(ENGINE *e, int locked);
138 /* This function will reset all "set"able values in an ENGINE to NULL. This
139 * won't touch reference counts or ex_data, but is equivalent to calling all the
140 * ENGINE_set_***() functions with a NULL value. */
141 IMPORT_C void engine_set_all_null(ENGINE *e);
143 /* NB: Bitwise OR-able values for the "flags" variable in ENGINE are now exposed
146 /* This is a structure for storing implementations of various crypto
147 * algorithms and functions. */
152 const RSA_METHOD *rsa_meth;
153 const DSA_METHOD *dsa_meth;
154 const DH_METHOD *dh_meth;
155 const ECDH_METHOD *ecdh_meth;
156 const ECDSA_METHOD *ecdsa_meth;
157 const RAND_METHOD *rand_meth;
158 const STORE_METHOD *store_meth;
159 /* Cipher handling is via this callback */
160 ENGINE_CIPHERS_PTR ciphers;
161 /* Digest handling is via this callback */
162 ENGINE_DIGESTS_PTR digests;
165 ENGINE_GEN_INT_FUNC_PTR destroy;
167 ENGINE_GEN_INT_FUNC_PTR init;
168 ENGINE_GEN_INT_FUNC_PTR finish;
169 ENGINE_CTRL_FUNC_PTR ctrl;
170 ENGINE_LOAD_KEY_PTR load_privkey;
171 ENGINE_LOAD_KEY_PTR load_pubkey;
173 const ENGINE_CMD_DEFN *cmd_defns;
175 /* reference count on the structure itself */
177 /* reference count on usability of the engine type. NB: This
178 * controls the loading and initialisation of any functionlity
179 * required by this engine, whereas the previous count is
180 * simply to cope with (de)allocation of this structure. Hence,
181 * running_ref <= struct_ref at all times. */
183 /* A place to store per-ENGINE data */
184 CRYPTO_EX_DATA ex_data;
185 /* Used to maintain the linked-list of engines. */
186 struct engine_st *prev;
187 struct engine_st *next;
194 #endif /* HEADER_ENGINE_INT_H */