Add and use OPENSSL_zalloc
[openssl.git] / crypto / engine / eng_dyn.c
1 /* crypto/engine/eng_dyn.c */
2 /*
3  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
4  * 2001.
5  */
6 /* ====================================================================
7  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59
60 #include "eng_int.h"
61 #include <openssl/dso.h>
62
63 /*
64  * Shared libraries implementing ENGINEs for use by the "dynamic" ENGINE
65  * loader should implement the hook-up functions with the following
66  * prototypes.
67  */
68
69 /* Our ENGINE handlers */
70 static int dynamic_init(ENGINE *e);
71 static int dynamic_finish(ENGINE *e);
72 static int dynamic_ctrl(ENGINE *e, int cmd, long i, void *p,
73                         void (*f) (void));
74 /* Predeclare our context type */
75 typedef struct st_dynamic_data_ctx dynamic_data_ctx;
76 /* The implementation for the important control command */
77 static int dynamic_load(ENGINE *e, dynamic_data_ctx *ctx);
78
79 #define DYNAMIC_CMD_SO_PATH             ENGINE_CMD_BASE
80 #define DYNAMIC_CMD_NO_VCHECK           (ENGINE_CMD_BASE + 1)
81 #define DYNAMIC_CMD_ID                  (ENGINE_CMD_BASE + 2)
82 #define DYNAMIC_CMD_LIST_ADD            (ENGINE_CMD_BASE + 3)
83 #define DYNAMIC_CMD_DIR_LOAD            (ENGINE_CMD_BASE + 4)
84 #define DYNAMIC_CMD_DIR_ADD             (ENGINE_CMD_BASE + 5)
85 #define DYNAMIC_CMD_LOAD                (ENGINE_CMD_BASE + 6)
86
87 /* The constants used when creating the ENGINE */
88 static const char *engine_dynamic_id = "dynamic";
89 static const char *engine_dynamic_name = "Dynamic engine loading support";
90 static const ENGINE_CMD_DEFN dynamic_cmd_defns[] = {
91     {DYNAMIC_CMD_SO_PATH,
92      "SO_PATH",
93      "Specifies the path to the new ENGINE shared library",
94      ENGINE_CMD_FLAG_STRING},
95     {DYNAMIC_CMD_NO_VCHECK,
96      "NO_VCHECK",
97      "Specifies to continue even if version checking fails (boolean)",
98      ENGINE_CMD_FLAG_NUMERIC},
99     {DYNAMIC_CMD_ID,
100      "ID",
101      "Specifies an ENGINE id name for loading",
102      ENGINE_CMD_FLAG_STRING},
103     {DYNAMIC_CMD_LIST_ADD,
104      "LIST_ADD",
105      "Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)",
106      ENGINE_CMD_FLAG_NUMERIC},
107     {DYNAMIC_CMD_DIR_LOAD,
108      "DIR_LOAD",
109      "Specifies whether to load from 'DIR_ADD' directories (0=no,1=yes,2=mandatory)",
110      ENGINE_CMD_FLAG_NUMERIC},
111     {DYNAMIC_CMD_DIR_ADD,
112      "DIR_ADD",
113      "Adds a directory from which ENGINEs can be loaded",
114      ENGINE_CMD_FLAG_STRING},
115     {DYNAMIC_CMD_LOAD,
116      "LOAD",
117      "Load up the ENGINE specified by other settings",
118      ENGINE_CMD_FLAG_NO_INPUT},
119     {0, NULL, NULL, 0}
120 };
121
122 /*
123  * Loading code stores state inside the ENGINE structure via the "ex_data"
124  * element. We load all our state into a single structure and use that as a
125  * single context in the "ex_data" stack.
126  */
127 struct st_dynamic_data_ctx {
128     /* The DSO object we load that supplies the ENGINE code */
129     DSO *dynamic_dso;
130     /*
131      * The function pointer to the version checking shared library function
132      */
133     dynamic_v_check_fn v_check;
134     /*
135      * The function pointer to the engine-binding shared library function
136      */
137     dynamic_bind_engine bind_engine;
138     /* The default name/path for loading the shared library */
139     char *DYNAMIC_LIBNAME;
140     /* Whether to continue loading on a version check failure */
141     int no_vcheck;
142     /* If non-NULL, stipulates the 'id' of the ENGINE to be loaded */
143     char *engine_id;
144     /*
145      * If non-zero, a successfully loaded ENGINE should be added to the
146      * internal ENGINE list. If 2, the add must succeed or the entire load
147      * should fail.
148      */
149     int list_add_value;
150     /* The symbol name for the version checking function */
151     const char *DYNAMIC_F1;
152     /* The symbol name for the "initialise ENGINE structure" function */
153     const char *DYNAMIC_F2;
154     /*
155      * Whether to never use 'dirs', use 'dirs' as a fallback, or only use
156      * 'dirs' for loading. Default is to use 'dirs' as a fallback.
157      */
158     int dir_load;
159     /* A stack of directories from which ENGINEs could be loaded */
160     STACK_OF(OPENSSL_STRING) *dirs;
161 };
162
163 /*
164  * This is the "ex_data" index we obtain and reserve for use with our context
165  * structure.
166  */
167 static int dynamic_ex_data_idx = -1;
168
169 static void int_free_str(char *s)
170 {
171     OPENSSL_free(s);
172 }
173
174 /*
175  * Because our ex_data element may or may not get allocated depending on
176  * whether a "first-use" occurs before the ENGINE is freed, we have a memory
177  * leak problem to solve. We can't declare a "new" handler for the ex_data as
178  * we don't want a dynamic_data_ctx in *all* ENGINE structures of all types
179  * (this is a bug in the design of CRYPTO_EX_DATA). As such, we just declare
180  * a "free" handler and that will get called if an ENGINE is being destroyed
181  * and there was an ex_data element corresponding to our context type.
182  */
183 static void dynamic_data_ctx_free_func(void *parent, void *ptr,
184                                        CRYPTO_EX_DATA *ad, int idx, long argl,
185                                        void *argp)
186 {
187     if (ptr) {
188         dynamic_data_ctx *ctx = (dynamic_data_ctx *)ptr;
189         DSO_free(ctx->dynamic_dso);
190         OPENSSL_free(ctx->DYNAMIC_LIBNAME);
191         OPENSSL_free(ctx->engine_id);
192         sk_OPENSSL_STRING_pop_free(ctx->dirs, int_free_str);
193         OPENSSL_free(ctx);
194     }
195 }
196
197 /*
198  * Construct the per-ENGINE context. We create it blindly and then use a lock
199  * to check for a race - if so, all but one of the threads "racing" will have
200  * wasted their time. The alternative involves creating everything inside the
201  * lock which is far worse.
202  */
203 static int dynamic_set_data_ctx(ENGINE *e, dynamic_data_ctx **ctx)
204 {
205     dynamic_data_ctx *c = OPENSSL_zalloc(sizeof(*c));
206
207     if (!c) {
208         ENGINEerr(ENGINE_F_DYNAMIC_SET_DATA_CTX, ERR_R_MALLOC_FAILURE);
209         return 0;
210     }
211     c->dynamic_dso = NULL;
212     c->v_check = NULL;
213     c->bind_engine = NULL;
214     c->DYNAMIC_LIBNAME = NULL;
215     c->no_vcheck = 0;
216     c->engine_id = NULL;
217     c->list_add_value = 0;
218     c->DYNAMIC_F1 = "v_check";
219     c->DYNAMIC_F2 = "bind_engine";
220     c->dir_load = 1;
221     c->dirs = sk_OPENSSL_STRING_new_null();
222     if (!c->dirs) {
223         ENGINEerr(ENGINE_F_DYNAMIC_SET_DATA_CTX, ERR_R_MALLOC_FAILURE);
224         OPENSSL_free(c);
225         return 0;
226     }
227     CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
228     if ((*ctx = (dynamic_data_ctx *)ENGINE_get_ex_data(e,
229                                                        dynamic_ex_data_idx))
230         == NULL) {
231         /* Good, we're the first */
232         ENGINE_set_ex_data(e, dynamic_ex_data_idx, c);
233         *ctx = c;
234         c = NULL;
235     }
236     CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
237     /*
238      * If we lost the race to set the context, c is non-NULL and *ctx is the
239      * context of the thread that won.
240      */
241     OPENSSL_free(c);
242     return 1;
243 }
244
245 /*
246  * This function retrieves the context structure from an ENGINE's "ex_data",
247  * or if it doesn't exist yet, sets it up.
248  */
249 static dynamic_data_ctx *dynamic_get_data_ctx(ENGINE *e)
250 {
251     dynamic_data_ctx *ctx;
252     if (dynamic_ex_data_idx < 0) {
253         /*
254          * Create and register the ENGINE ex_data, and associate our "free"
255          * function with it to ensure any allocated contexts get freed when
256          * an ENGINE goes underground.
257          */
258         int new_idx = ENGINE_get_ex_new_index(0, NULL, NULL, NULL,
259                                               dynamic_data_ctx_free_func);
260         if (new_idx == -1) {
261             ENGINEerr(ENGINE_F_DYNAMIC_GET_DATA_CTX, ENGINE_R_NO_INDEX);
262             return NULL;
263         }
264         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
265         /* Avoid a race by checking again inside this lock */
266         if (dynamic_ex_data_idx < 0) {
267             /* Good, someone didn't beat us to it */
268             dynamic_ex_data_idx = new_idx;
269             new_idx = -1;
270         }
271         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
272         /*
273          * In theory we could "give back" the index here if (new_idx>-1), but
274          * it's not possible and wouldn't gain us much if it were.
275          */
276     }
277     ctx = (dynamic_data_ctx *)ENGINE_get_ex_data(e, dynamic_ex_data_idx);
278     /* Check if the context needs to be created */
279     if ((ctx == NULL) && !dynamic_set_data_ctx(e, &ctx))
280         /* "set_data" will set errors if necessary */
281         return NULL;
282     return ctx;
283 }
284
285 static ENGINE *engine_dynamic(void)
286 {
287     ENGINE *ret = ENGINE_new();
288     if (!ret)
289         return NULL;
290     if (!ENGINE_set_id(ret, engine_dynamic_id) ||
291         !ENGINE_set_name(ret, engine_dynamic_name) ||
292         !ENGINE_set_init_function(ret, dynamic_init) ||
293         !ENGINE_set_finish_function(ret, dynamic_finish) ||
294         !ENGINE_set_ctrl_function(ret, dynamic_ctrl) ||
295         !ENGINE_set_flags(ret, ENGINE_FLAGS_BY_ID_COPY) ||
296         !ENGINE_set_cmd_defns(ret, dynamic_cmd_defns)) {
297         ENGINE_free(ret);
298         return NULL;
299     }
300     return ret;
301 }
302
303 void ENGINE_load_dynamic(void)
304 {
305     ENGINE *toadd = engine_dynamic();
306     if (!toadd)
307         return;
308     ENGINE_add(toadd);
309     /*
310      * If the "add" worked, it gets a structural reference. So either way, we
311      * release our just-created reference.
312      */
313     ENGINE_free(toadd);
314     /*
315      * If the "add" didn't work, it was probably a conflict because it was
316      * already added (eg. someone calling ENGINE_load_blah then calling
317      * ENGINE_load_builtin_engines() perhaps).
318      */
319     ERR_clear_error();
320 }
321
322 static int dynamic_init(ENGINE *e)
323 {
324     /*
325      * We always return failure - the "dyanamic" engine itself can't be used
326      * for anything.
327      */
328     return 0;
329 }
330
331 static int dynamic_finish(ENGINE *e)
332 {
333     /*
334      * This should never be called on account of "dynamic_init" always
335      * failing.
336      */
337     return 0;
338 }
339
340 static int dynamic_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
341 {
342     dynamic_data_ctx *ctx = dynamic_get_data_ctx(e);
343     int initialised;
344
345     if (!ctx) {
346         ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_NOT_LOADED);
347         return 0;
348     }
349     initialised = ((ctx->dynamic_dso == NULL) ? 0 : 1);
350     /* All our control commands require the ENGINE to be uninitialised */
351     if (initialised) {
352         ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_ALREADY_LOADED);
353         return 0;
354     }
355     switch (cmd) {
356     case DYNAMIC_CMD_SO_PATH:
357         /* a NULL 'p' or a string of zero-length is the same thing */
358         if (p && (strlen((const char *)p) < 1))
359             p = NULL;
360         OPENSSL_free(ctx->DYNAMIC_LIBNAME);
361         if (p)
362             ctx->DYNAMIC_LIBNAME = BUF_strdup(p);
363         else
364             ctx->DYNAMIC_LIBNAME = NULL;
365         return (ctx->DYNAMIC_LIBNAME ? 1 : 0);
366     case DYNAMIC_CMD_NO_VCHECK:
367         ctx->no_vcheck = ((i == 0) ? 0 : 1);
368         return 1;
369     case DYNAMIC_CMD_ID:
370         /* a NULL 'p' or a string of zero-length is the same thing */
371         if (p && (strlen((const char *)p) < 1))
372             p = NULL;
373         OPENSSL_free(ctx->engine_id);
374         if (p)
375             ctx->engine_id = BUF_strdup(p);
376         else
377             ctx->engine_id = NULL;
378         return (ctx->engine_id ? 1 : 0);
379     case DYNAMIC_CMD_LIST_ADD:
380         if ((i < 0) || (i > 2)) {
381             ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_INVALID_ARGUMENT);
382             return 0;
383         }
384         ctx->list_add_value = (int)i;
385         return 1;
386     case DYNAMIC_CMD_LOAD:
387         return dynamic_load(e, ctx);
388     case DYNAMIC_CMD_DIR_LOAD:
389         if ((i < 0) || (i > 2)) {
390             ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_INVALID_ARGUMENT);
391             return 0;
392         }
393         ctx->dir_load = (int)i;
394         return 1;
395     case DYNAMIC_CMD_DIR_ADD:
396         /* a NULL 'p' or a string of zero-length is the same thing */
397         if (!p || (strlen((const char *)p) < 1)) {
398             ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_INVALID_ARGUMENT);
399             return 0;
400         }
401         {
402             char *tmp_str = BUF_strdup(p);
403             if (!tmp_str) {
404                 ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ERR_R_MALLOC_FAILURE);
405                 return 0;
406             }
407             sk_OPENSSL_STRING_insert(ctx->dirs, tmp_str, -1);
408         }
409         return 1;
410     default:
411         break;
412     }
413     ENGINEerr(ENGINE_F_DYNAMIC_CTRL, ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED);
414     return 0;
415 }
416
417 static int int_load(dynamic_data_ctx *ctx)
418 {
419     int num, loop;
420     /* Unless told not to, try a direct load */
421     if ((ctx->dir_load != 2) && (DSO_load(ctx->dynamic_dso,
422                                           ctx->DYNAMIC_LIBNAME, NULL,
423                                           0)) != NULL)
424         return 1;
425     /* If we're not allowed to use 'dirs' or we have none, fail */
426     if (!ctx->dir_load || (num = sk_OPENSSL_STRING_num(ctx->dirs)) < 1)
427         return 0;
428     for (loop = 0; loop < num; loop++) {
429         const char *s = sk_OPENSSL_STRING_value(ctx->dirs, loop);
430         char *merge = DSO_merge(ctx->dynamic_dso, ctx->DYNAMIC_LIBNAME, s);
431         if (!merge)
432             return 0;
433         if (DSO_load(ctx->dynamic_dso, merge, NULL, 0)) {
434             /* Found what we're looking for */
435             OPENSSL_free(merge);
436             return 1;
437         }
438         OPENSSL_free(merge);
439     }
440     return 0;
441 }
442
443 static int dynamic_load(ENGINE *e, dynamic_data_ctx *ctx)
444 {
445     ENGINE cpy;
446     dynamic_fns fns;
447
448     if (!ctx->dynamic_dso)
449         ctx->dynamic_dso = DSO_new();
450     if (!ctx->DYNAMIC_LIBNAME) {
451         if (!ctx->engine_id)
452             return 0;
453         ctx->DYNAMIC_LIBNAME =
454             DSO_convert_filename(ctx->dynamic_dso, ctx->engine_id);
455     }
456     if (!int_load(ctx)) {
457         ENGINEerr(ENGINE_F_DYNAMIC_LOAD, ENGINE_R_DSO_NOT_FOUND);
458         DSO_free(ctx->dynamic_dso);
459         ctx->dynamic_dso = NULL;
460         return 0;
461     }
462     /* We have to find a bind function otherwise it'll always end badly */
463     if (!
464         (ctx->bind_engine =
465          (dynamic_bind_engine) DSO_bind_func(ctx->dynamic_dso,
466                                              ctx->DYNAMIC_F2))) {
467         ctx->bind_engine = NULL;
468         DSO_free(ctx->dynamic_dso);
469         ctx->dynamic_dso = NULL;
470         ENGINEerr(ENGINE_F_DYNAMIC_LOAD, ENGINE_R_DSO_FAILURE);
471         return 0;
472     }
473     /* Do we perform version checking? */
474     if (!ctx->no_vcheck) {
475         unsigned long vcheck_res = 0;
476         /*
477          * Now we try to find a version checking function and decide how to
478          * cope with failure if/when it fails.
479          */
480         ctx->v_check =
481             (dynamic_v_check_fn) DSO_bind_func(ctx->dynamic_dso,
482                                                ctx->DYNAMIC_F1);
483         if (ctx->v_check)
484             vcheck_res = ctx->v_check(OSSL_DYNAMIC_VERSION);
485         /*
486          * We fail if the version checker veto'd the load *or* if it is
487          * deferring to us (by returning its version) and we think it is too
488          * old.
489          */
490         if (vcheck_res < OSSL_DYNAMIC_OLDEST) {
491             /* Fail */
492             ctx->bind_engine = NULL;
493             ctx->v_check = NULL;
494             DSO_free(ctx->dynamic_dso);
495             ctx->dynamic_dso = NULL;
496             ENGINEerr(ENGINE_F_DYNAMIC_LOAD,
497                       ENGINE_R_VERSION_INCOMPATIBILITY);
498             return 0;
499         }
500     }
501     /*
502      * First binary copy the ENGINE structure so that we can roll back if the
503      * hand-over fails
504      */
505     memcpy(&cpy, e, sizeof(ENGINE));
506     /*
507      * Provide the ERR, "ex_data", memory, and locking callbacks so the
508      * loaded library uses our state rather than its own. FIXME: As noted in
509      * engine.h, much of this would be simplified if each area of code
510      * provided its own "summary" structure of all related callbacks. It
511      * would also increase opaqueness.
512      */
513     fns.static_state = ENGINE_get_static_state();
514     CRYPTO_get_mem_functions(&fns.mem_fns.malloc_cb,
515                              &fns.mem_fns.realloc_cb, &fns.mem_fns.free_cb);
516     fns.lock_fns.lock_locking_cb = CRYPTO_get_locking_callback();
517     fns.lock_fns.lock_add_lock_cb = CRYPTO_get_add_lock_callback();
518     fns.lock_fns.dynlock_create_cb = CRYPTO_get_dynlock_create_callback();
519     fns.lock_fns.dynlock_lock_cb = CRYPTO_get_dynlock_lock_callback();
520     fns.lock_fns.dynlock_destroy_cb = CRYPTO_get_dynlock_destroy_callback();
521     /*
522      * Now that we've loaded the dynamic engine, make sure no "dynamic"
523      * ENGINE elements will show through.
524      */
525     engine_set_all_null(e);
526
527     /* Try to bind the ENGINE onto our own ENGINE structure */
528     if (!ctx->bind_engine(e, ctx->engine_id, &fns)) {
529         ctx->bind_engine = NULL;
530         ctx->v_check = NULL;
531         DSO_free(ctx->dynamic_dso);
532         ctx->dynamic_dso = NULL;
533         ENGINEerr(ENGINE_F_DYNAMIC_LOAD, ENGINE_R_INIT_FAILED);
534         /* Copy the original ENGINE structure back */
535         memcpy(e, &cpy, sizeof(ENGINE));
536         return 0;
537     }
538     /* Do we try to add this ENGINE to the internal list too? */
539     if (ctx->list_add_value > 0) {
540         if (!ENGINE_add(e)) {
541             /* Do we tolerate this or fail? */
542             if (ctx->list_add_value > 1) {
543                 /*
544                  * Fail - NB: By this time, it's too late to rollback, and
545                  * trying to do so allows the bind_engine() code to have
546                  * created leaks. We just have to fail where we are, after
547                  * the ENGINE has changed.
548                  */
549                 ENGINEerr(ENGINE_F_DYNAMIC_LOAD,
550                           ENGINE_R_CONFLICTING_ENGINE_ID);
551                 return 0;
552             }
553             /* Tolerate */
554             ERR_clear_error();
555         }
556     }
557     return 1;
558 }