Move to REF_DEBUG, for consistency.
[openssl.git] / crypto / engine / eng_lib.c
1 /*
2  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
3  * 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 #include "eng_int.h"
60 #include <openssl/rand.h>
61
62 /* The "new"/"free" stuff first */
63
64 ENGINE *ENGINE_new(void)
65 {
66     ENGINE *ret;
67
68     ret = OPENSSL_zalloc(sizeof(*ret));
69     if (ret == NULL) {
70         ENGINEerr(ENGINE_F_ENGINE_NEW, ERR_R_MALLOC_FAILURE);
71         return NULL;
72     }
73     ret->struct_ref = 1;
74     engine_ref_debug(ret, 0, 1);
75     CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data);
76     return ret;
77 }
78
79 /*
80  * Placed here (close proximity to ENGINE_new) so that modifications to the
81  * elements of the ENGINE structure are more likely to be caught and changed
82  * here.
83  */
84 void engine_set_all_null(ENGINE *e)
85 {
86     e->id = NULL;
87     e->name = NULL;
88     e->rsa_meth = NULL;
89     e->dsa_meth = NULL;
90     e->dh_meth = NULL;
91     e->rand_meth = NULL;
92     e->ciphers = NULL;
93     e->digests = NULL;
94     e->destroy = NULL;
95     e->init = NULL;
96     e->finish = NULL;
97     e->ctrl = NULL;
98     e->load_privkey = NULL;
99     e->load_pubkey = NULL;
100     e->cmd_defns = NULL;
101     e->flags = 0;
102 }
103
104 int engine_free_util(ENGINE *e, int locked)
105 {
106     int i;
107
108     if (e == NULL)
109         return 1;
110     if (locked)
111         i = CRYPTO_add(&e->struct_ref, -1, CRYPTO_LOCK_ENGINE);
112     else
113         i = --e->struct_ref;
114     engine_ref_debug(e, 0, -1)
115     if (i > 0)
116         return 1;
117     REF_ASSERT_ISNT(i < 0);
118     /* Free up any dynamically allocated public key methods */
119     engine_pkey_meths_free(e);
120     engine_pkey_asn1_meths_free(e);
121     /*
122      * Give the ENGINE a chance to do any structural cleanup corresponding to
123      * allocation it did in its constructor (eg. unload error strings)
124      */
125     if (e->destroy)
126         e->destroy(e);
127     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_ENGINE, e, &e->ex_data);
128     OPENSSL_free(e);
129     return 1;
130 }
131
132 int ENGINE_free(ENGINE *e)
133 {
134     return engine_free_util(e, 1);
135 }
136
137 /* Cleanup stuff */
138
139 /*
140  * ENGINE_cleanup() is coded such that anything that does work that will need
141  * cleanup can register a "cleanup" callback here. That way we don't get
142  * linker bloat by referring to all *possible* cleanups, but any linker bloat
143  * into code "X" will cause X's cleanup function to end up here.
144  */
145 static STACK_OF(ENGINE_CLEANUP_ITEM) *cleanup_stack = NULL;
146 static int int_cleanup_check(int create)
147 {
148     if (cleanup_stack)
149         return 1;
150     if (!create)
151         return 0;
152     cleanup_stack = sk_ENGINE_CLEANUP_ITEM_new_null();
153     return (cleanup_stack ? 1 : 0);
154 }
155
156 static ENGINE_CLEANUP_ITEM *int_cleanup_item(ENGINE_CLEANUP_CB *cb)
157 {
158     ENGINE_CLEANUP_ITEM *item = OPENSSL_malloc(sizeof(*item));
159     if (item == NULL)
160         return NULL;
161     item->cb = cb;
162     return item;
163 }
164
165 void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb)
166 {
167     ENGINE_CLEANUP_ITEM *item;
168     if (!int_cleanup_check(1))
169         return;
170     item = int_cleanup_item(cb);
171     if (item)
172         sk_ENGINE_CLEANUP_ITEM_insert(cleanup_stack, item, 0);
173 }
174
175 void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb)
176 {
177     ENGINE_CLEANUP_ITEM *item;
178     if (!int_cleanup_check(1))
179         return;
180     item = int_cleanup_item(cb);
181     if (item)
182         sk_ENGINE_CLEANUP_ITEM_push(cleanup_stack, item);
183 }
184
185 /* The API function that performs all cleanup */
186 static void engine_cleanup_cb_free(ENGINE_CLEANUP_ITEM *item)
187 {
188     (*(item->cb)) ();
189     OPENSSL_free(item);
190 }
191
192 void ENGINE_cleanup(void)
193 {
194     if (int_cleanup_check(0)) {
195         sk_ENGINE_CLEANUP_ITEM_pop_free(cleanup_stack,
196                                         engine_cleanup_cb_free);
197         cleanup_stack = NULL;
198     }
199     /*
200      * FIXME: This should be handled (somehow) through RAND, eg. by it
201      * registering a cleanup callback.
202      */
203     RAND_set_rand_method(NULL);
204 }
205
206 /* Now the "ex_data" support */
207
208 int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg)
209 {
210     return (CRYPTO_set_ex_data(&e->ex_data, idx, arg));
211 }
212
213 void *ENGINE_get_ex_data(const ENGINE *e, int idx)
214 {
215     return (CRYPTO_get_ex_data(&e->ex_data, idx));
216 }
217
218 /*
219  * Functions to get/set an ENGINE's elements - mainly to avoid exposing the
220  * ENGINE structure itself.
221  */
222
223 int ENGINE_set_id(ENGINE *e, const char *id)
224 {
225     if (id == NULL) {
226         ENGINEerr(ENGINE_F_ENGINE_SET_ID, ERR_R_PASSED_NULL_PARAMETER);
227         return 0;
228     }
229     e->id = id;
230     return 1;
231 }
232
233 int ENGINE_set_name(ENGINE *e, const char *name)
234 {
235     if (name == NULL) {
236         ENGINEerr(ENGINE_F_ENGINE_SET_NAME, ERR_R_PASSED_NULL_PARAMETER);
237         return 0;
238     }
239     e->name = name;
240     return 1;
241 }
242
243 int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f)
244 {
245     e->destroy = destroy_f;
246     return 1;
247 }
248
249 int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f)
250 {
251     e->init = init_f;
252     return 1;
253 }
254
255 int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f)
256 {
257     e->finish = finish_f;
258     return 1;
259 }
260
261 int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f)
262 {
263     e->ctrl = ctrl_f;
264     return 1;
265 }
266
267 int ENGINE_set_flags(ENGINE *e, int flags)
268 {
269     e->flags = flags;
270     return 1;
271 }
272
273 int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns)
274 {
275     e->cmd_defns = defns;
276     return 1;
277 }
278
279 const char *ENGINE_get_id(const ENGINE *e)
280 {
281     return e->id;
282 }
283
284 const char *ENGINE_get_name(const ENGINE *e)
285 {
286     return e->name;
287 }
288
289 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e)
290 {
291     return e->destroy;
292 }
293
294 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e)
295 {
296     return e->init;
297 }
298
299 ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e)
300 {
301     return e->finish;
302 }
303
304 ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e)
305 {
306     return e->ctrl;
307 }
308
309 int ENGINE_get_flags(const ENGINE *e)
310 {
311     return e->flags;
312 }
313
314 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e)
315 {
316     return e->cmd_defns;
317 }
318
319 /*
320  * eng_lib.o is pretty much linked into anything that touches ENGINE already,
321  * so put the "static_state" hack here.
322  */
323
324 static int internal_static_hack = 0;
325
326 void *ENGINE_get_static_state(void)
327 {
328     return &internal_static_hack;
329 }