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