65ba9d43a67de565a2c7bbffa0787959964fe37e
[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 #ifndef HEADER_ENGINE_INT_H
60 #define HEADER_ENGINE_INT_H
61
62 /* Take public definitions from engine.h */
63 #include <openssl/engine.h>
64
65 #ifdef  __cplusplus
66 extern "C" {
67 #endif
68
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) \
78         fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \
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
90 /* Any code that will need cleanup operations should use these functions to
91  * register callbacks. ENGINE_cleanup() will call all registered callbacks in
92  * order. NB: both the "add" functions assume CRYPTO_LOCK_ENGINE to already be
93  * held (in "write" mode). */
94 typedef void (ENGINE_CLEANUP_CB)(void);
95 DECLARE_STACK_OF(ENGINE_CLEANUP_CB)
96 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb);
97 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb);
98
99 /* We need stacks of ENGINEs for use in eng_table.c */
100 DECLARE_STACK_OF(ENGINE)
101
102 /* If this symbol is defined then engine_table_select(), the function that is
103  * used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults and
104  * functional references (etc), will display debugging summaries to stderr. */
105 /* #define ENGINE_TABLE_DEBUG */
106
107 /* This represents an implementation table. Dependent code should instantiate it
108  * as a (ENGINE_TABLE *) pointer value set initially to NULL. */
109 typedef struct st_engine_table ENGINE_TABLE;
110 int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
111                 ENGINE *e, const int *nids, int num_nids, int setdefault);
112 void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e);
113 void engine_table_cleanup(ENGINE_TABLE **table);
114 #ifndef ENGINE_TABLE_DEBUG
115 ENGINE *engine_table_select(ENGINE_TABLE **table, int nid);
116 #else
117 ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f, int l);
118 #define engine_table_select(t,n) engine_table_select_tmp(t,n,__FILE__,__LINE__)
119 #endif
120
121 /* Internal versions of API functions that have control over locking. These are
122  * used between C files when functionality needs to be shared but the caller may
123  * already be controlling of the CRYPTO_LOCK_ENGINE lock. */
124 int engine_unlocked_init(ENGINE *e);
125 int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers);
126 int engine_free_util(ENGINE *e, int locked);
127
128 /* NB: Bitwise OR-able values for the "flags" variable in ENGINE are now exposed
129  * in engine.h. */
130
131 /* This is a structure for storing implementations of various crypto
132  * algorithms and functions. */
133 struct engine_st
134         {
135         const char *id;
136         const char *name;
137         const RSA_METHOD *rsa_meth;
138         const DSA_METHOD *dsa_meth;
139         const DH_METHOD *dh_meth;
140         const RAND_METHOD *rand_meth;
141         /* Cipher handling is via this callback */
142         ENGINE_CIPHERS_PTR ciphers;
143         /* Digest handling is via this callback */
144         ENGINE_DIGESTS_PTR digests;
145
146
147         ENGINE_GEN_INT_FUNC_PTR destroy;
148
149         ENGINE_GEN_INT_FUNC_PTR init;
150         ENGINE_GEN_INT_FUNC_PTR finish;
151         ENGINE_CTRL_FUNC_PTR ctrl;
152         ENGINE_LOAD_KEY_PTR load_privkey;
153         ENGINE_LOAD_KEY_PTR load_pubkey;
154
155         const ENGINE_CMD_DEFN *cmd_defns;
156         int flags;
157         /* reference count on the structure itself */
158         int struct_ref;
159         /* reference count on usability of the engine type. NB: This
160          * controls the loading and initialisation of any functionlity
161          * required by this engine, whereas the previous count is
162          * simply to cope with (de)allocation of this structure. Hence,
163          * running_ref <= struct_ref at all times. */
164         int funct_ref;
165         /* A place to store per-ENGINE data */
166         CRYPTO_EX_DATA ex_data;
167         /* Used to maintain the linked-list of engines. */
168         struct engine_st *prev;
169         struct engine_st *next;
170         };
171
172 #ifdef  __cplusplus
173 }
174 #endif
175
176 #endif /* HEADER_ENGINE_INT_H */