2 * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
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
67 # include "internal/cryptlib.h"
68 # include <internal/engine.h>
74 extern CRYPTO_RWLOCK *global_engine_lock;
77 * If we compile with this symbol defined, then both reference counts in the
78 * ENGINE structure will be monitored with a line of output on stderr for
79 * each change. This prints the engine's pointer address (truncated to
80 * unsigned int), "struct" or "funct" to indicate the reference type, the
81 * before and after reference count, and the file:line-number pair. The
82 * "engine_ref_debug" statements must come *after* the change.
84 # ifdef ENGINE_REF_COUNT_DEBUG
86 # define engine_ref_debug(e, isfunct, diff) \
87 fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \
88 (unsigned int)(e), (isfunct ? "funct" : "struct"), \
89 ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \
90 ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \
91 (OPENSSL_FILE), (OPENSSL_LINE))
95 # define engine_ref_debug(e, isfunct, diff)
100 * Any code that will need cleanup operations should use these functions to
101 * register callbacks. engine_cleanup_int() will call all registered
102 * callbacks in order. NB: both the "add" functions assume the engine lock to
103 * already be held (in "write" mode).
105 typedef void (ENGINE_CLEANUP_CB) (void);
106 typedef struct st_engine_cleanup_item {
107 ENGINE_CLEANUP_CB *cb;
108 } ENGINE_CLEANUP_ITEM;
109 DEFINE_STACK_OF(ENGINE_CLEANUP_ITEM)
110 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb);
111 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb);
113 /* We need stacks of ENGINEs for use in eng_table.c */
114 DEFINE_STACK_OF(ENGINE)
117 * If this symbol is defined then engine_table_select(), the function that is
118 * used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults
119 * and functional references (etc), will display debugging summaries to
122 /* #define ENGINE_TABLE_DEBUG */
125 * This represents an implementation table. Dependent code should instantiate
126 * it as a (ENGINE_TABLE *) pointer value set initially to NULL.
128 typedef struct st_engine_table ENGINE_TABLE;
129 int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
130 ENGINE *e, const int *nids, int num_nids,
132 void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e);
133 void engine_table_cleanup(ENGINE_TABLE **table);
134 # ifndef ENGINE_TABLE_DEBUG
135 ENGINE *engine_table_select(ENGINE_TABLE **table, int nid);
137 ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f,
139 # define engine_table_select(t,n) engine_table_select_tmp(t,n,OPENSSL_FILE,OPENSSL_LINE)
141 typedef void (engine_table_doall_cb) (int nid, STACK_OF(ENGINE) *sk,
142 ENGINE *def, void *arg);
143 void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb,
147 * Internal versions of API functions that have control over locking. These
148 * are used between C files when functionality needs to be shared but the
149 * caller may already be controlling of the engine lock.
151 int engine_unlocked_init(ENGINE *e);
152 int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers);
153 int engine_free_util(ENGINE *e, int locked);
156 * This function will reset all "set"able values in an ENGINE to NULL. This
157 * won't touch reference counts or ex_data, but is equivalent to calling all
158 * the ENGINE_set_***() functions with a NULL value.
160 void engine_set_all_null(ENGINE *e);
163 * NB: Bitwise OR-able values for the "flags" variable in ENGINE are now
164 * exposed in engine.h.
167 /* Free up dynamically allocated public key methods associated with ENGINE */
169 void engine_pkey_meths_free(ENGINE *e);
170 void engine_pkey_asn1_meths_free(ENGINE *e);
172 /* Once initialisation function */
173 extern CRYPTO_ONCE engine_lock_init;
174 void do_engine_lock_init(void);
177 * This is a structure for storing implementations of various crypto
178 * algorithms and functions.
183 const RSA_METHOD *rsa_meth;
184 const DSA_METHOD *dsa_meth;
185 const DH_METHOD *dh_meth;
186 const EC_KEY_METHOD *ec_meth;
187 const RAND_METHOD *rand_meth;
188 /* Cipher handling is via this callback */
189 ENGINE_CIPHERS_PTR ciphers;
190 /* Digest handling is via this callback */
191 ENGINE_DIGESTS_PTR digests;
192 /* Public key handling via this callback */
193 ENGINE_PKEY_METHS_PTR pkey_meths;
194 /* ASN1 public key handling via this callback */
195 ENGINE_PKEY_ASN1_METHS_PTR pkey_asn1_meths;
196 ENGINE_GEN_INT_FUNC_PTR destroy;
197 ENGINE_GEN_INT_FUNC_PTR init;
198 ENGINE_GEN_INT_FUNC_PTR finish;
199 ENGINE_CTRL_FUNC_PTR ctrl;
200 ENGINE_LOAD_KEY_PTR load_privkey;
201 ENGINE_LOAD_KEY_PTR load_pubkey;
202 ENGINE_SSL_CLIENT_CERT_PTR load_ssl_client_cert;
203 const ENGINE_CMD_DEFN *cmd_defns;
205 /* reference count on the structure itself */
208 * reference count on usability of the engine type. NB: This controls the
209 * loading and initialisation of any functionality required by this
210 * engine, whereas the previous count is simply to cope with
211 * (de)allocation of this structure. Hence, running_ref <= struct_ref at
215 /* A place to store per-ENGINE data */
216 CRYPTO_EX_DATA ex_data;
217 /* Used to maintain the linked-list of engines. */
218 struct engine_st *prev;
219 struct engine_st *next;
222 typedef struct st_engine_pile ENGINE_PILE;
224 DEFINE_LHASH_OF(ENGINE_PILE);
230 #endif /* HEADER_ENGINE_INT_H */