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