2 * Written by Stephen Henson (steve@openssl.org) for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
61 #include <openssl/crypto.h>
62 #include "internal/cryptlib.h"
63 #include <openssl/conf.h>
64 #include <openssl/dso.h>
65 #include <openssl/x509.h>
67 #define DSO_mod_init_name "OPENSSL_init"
68 #define DSO_mod_finish_name "OPENSSL_finish"
71 * This structure contains a data about supported modules. entries in this
72 * table correspond to either dynamic or static modules.
75 struct conf_module_st {
76 /* DSO of this module or NULL if static */
78 /* Name of the module */
83 conf_finish_func *finish;
84 /* Number of successfully initialized modules */
90 * This structure contains information about modules that have been
91 * successfully initialized. There may be more than one entry for a given
95 struct conf_imodule_st {
103 static STACK_OF(CONF_MODULE) *supported_modules = NULL;
104 static STACK_OF(CONF_IMODULE) *initialized_modules = NULL;
106 static void module_free(CONF_MODULE *md);
107 static void module_finish(CONF_IMODULE *imod);
108 static int module_run(const CONF *cnf, char *name, char *value,
109 unsigned long flags);
110 static CONF_MODULE *module_add(DSO *dso, const char *name,
111 conf_init_func *ifunc,
112 conf_finish_func *ffunc);
113 static CONF_MODULE *module_find(char *name);
114 static int module_init(CONF_MODULE *pmod, char *name, char *value,
116 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
117 unsigned long flags);
119 /* Main function: load modules from a CONF structure */
121 int CONF_modules_load(const CONF *cnf, const char *appname,
124 STACK_OF(CONF_VALUE) *values;
126 char *vsection = NULL;
134 vsection = NCONF_get_string(cnf, NULL, appname);
136 if (!appname || (!vsection && (flags & CONF_MFLAGS_DEFAULT_SECTION)))
137 vsection = NCONF_get_string(cnf, NULL, "openssl_conf");
144 values = NCONF_get_section(cnf, vsection);
149 for (i = 0; i < sk_CONF_VALUE_num(values); i++) {
150 vl = sk_CONF_VALUE_value(values, i);
151 ret = module_run(cnf, vl->name, vl->value, flags);
153 if (!(flags & CONF_MFLAGS_IGNORE_ERRORS))
161 int CONF_modules_load_file(const char *filename, const char *appname,
167 conf = NCONF_new(NULL);
171 if (filename == NULL) {
172 file = CONF_get1_default_config_file();
176 file = (char *)filename;
178 if (NCONF_load(conf, file, NULL) <= 0) {
179 if ((flags & CONF_MFLAGS_IGNORE_MISSING_FILE) &&
180 (ERR_GET_REASON(ERR_peek_last_error()) == CONF_R_NO_SUCH_FILE)) {
187 ret = CONF_modules_load(conf, appname, flags);
190 if (filename == NULL)
197 static int module_run(const CONF *cnf, char *name, char *value,
203 md = module_find(name);
205 /* Module not found: try to load DSO */
206 if (!md && !(flags & CONF_MFLAGS_NO_DSO))
207 md = module_load_dso(cnf, name, value, flags);
210 if (!(flags & CONF_MFLAGS_SILENT)) {
211 CONFerr(CONF_F_MODULE_RUN, CONF_R_UNKNOWN_MODULE_NAME);
212 ERR_add_error_data(2, "module=", name);
217 ret = module_init(md, name, value, cnf);
220 if (!(flags & CONF_MFLAGS_SILENT)) {
221 char rcode[DECIMAL_SIZE(ret) + 1];
222 CONFerr(CONF_F_MODULE_RUN, CONF_R_MODULE_INITIALIZATION_ERROR);
223 BIO_snprintf(rcode, sizeof rcode, "%-8d", ret);
224 ERR_add_error_data(6, "module=", name, ", value=", value,
225 ", retcode=", rcode);
232 /* Load a module from a DSO */
233 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
237 conf_init_func *ifunc;
238 conf_finish_func *ffunc;
242 /* Look for alternative path in module section */
243 path = NCONF_get_string(cnf, value, "path");
248 dso = DSO_load(NULL, path, NULL, 0);
250 errcode = CONF_R_ERROR_LOADING_DSO;
253 ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
255 errcode = CONF_R_MISSING_INIT_FUNCTION;
258 ffunc = (conf_finish_func *)DSO_bind_func(dso, DSO_mod_finish_name);
259 /* All OK, add module */
260 md = module_add(dso, name, ifunc, ffunc);
269 CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
270 ERR_add_error_data(4, "module=", name, ", path=", path);
274 /* add module to list */
275 static CONF_MODULE *module_add(DSO *dso, const char *name,
276 conf_init_func *ifunc, conf_finish_func *ffunc)
278 CONF_MODULE *tmod = NULL;
279 if (supported_modules == NULL)
280 supported_modules = sk_CONF_MODULE_new_null();
281 if (supported_modules == NULL)
283 tmod = OPENSSL_zalloc(sizeof(*tmod));
288 tmod->name = OPENSSL_strdup(name);
290 tmod->finish = ffunc;
292 if (!sk_CONF_MODULE_push(supported_modules, tmod)) {
301 * Find a module from the list. We allow module names of the form
302 * modname.XXXX to just search for modname to allow the same module to be
303 * initialized more than once.
306 static CONF_MODULE *module_find(char *name)
311 p = strrchr(name, '.');
316 nchar = strlen(name);
318 for (i = 0; i < sk_CONF_MODULE_num(supported_modules); i++) {
319 tmod = sk_CONF_MODULE_value(supported_modules, i);
320 if (strncmp(tmod->name, name, nchar) == 0)
328 /* initialize a module */
329 static int module_init(CONF_MODULE *pmod, char *name, char *value,
334 CONF_IMODULE *imod = NULL;
336 /* Otherwise add initialized module to list */
337 imod = OPENSSL_malloc(sizeof(*imod));
342 imod->name = OPENSSL_strdup(name);
343 imod->value = OPENSSL_strdup(value);
344 imod->usr_data = NULL;
346 if (!imod->name || !imod->value)
349 /* Try to initialize module */
351 ret = pmod->init(imod, cnf);
353 /* Error occurred, exit */
358 if (initialized_modules == NULL) {
359 initialized_modules = sk_CONF_IMODULE_new_null();
360 if (!initialized_modules) {
361 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
366 if (!sk_CONF_IMODULE_push(initialized_modules, imod)) {
367 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
377 /* We've started the module so we'd better finish it */
378 if (pmod->finish && init_called)
383 OPENSSL_free(imod->name);
384 OPENSSL_free(imod->value);
393 * Unload any dynamic modules that have a link count of zero: i.e. have no
394 * active initialized modules. If 'all' is set then all modules are unloaded
395 * including static ones.
398 void CONF_modules_unload(int all)
402 CONF_modules_finish();
403 /* unload modules in reverse order */
404 for (i = sk_CONF_MODULE_num(supported_modules) - 1; i >= 0; i--) {
405 md = sk_CONF_MODULE_value(supported_modules, i);
406 /* If static or in use and 'all' not set ignore it */
407 if (((md->links > 0) || !md->dso) && !all)
409 /* Since we're working in reverse this is OK */
410 (void)sk_CONF_MODULE_delete(supported_modules, i);
413 if (sk_CONF_MODULE_num(supported_modules) == 0) {
414 sk_CONF_MODULE_free(supported_modules);
415 supported_modules = NULL;
419 /* unload a single module */
420 static void module_free(CONF_MODULE *md)
423 OPENSSL_free(md->name);
427 /* finish and free up all modules instances */
429 void CONF_modules_finish(void)
432 while (sk_CONF_IMODULE_num(initialized_modules) > 0) {
433 imod = sk_CONF_IMODULE_pop(initialized_modules);
436 sk_CONF_IMODULE_free(initialized_modules);
437 initialized_modules = NULL;
440 /* finish a module instance */
442 static void module_finish(CONF_IMODULE *imod)
446 if (imod->pmod->finish)
447 imod->pmod->finish(imod);
449 OPENSSL_free(imod->name);
450 OPENSSL_free(imod->value);
454 /* Add a static module to OpenSSL */
456 int CONF_module_add(const char *name, conf_init_func *ifunc,
457 conf_finish_func *ffunc)
459 if (module_add(NULL, name, ifunc, ffunc))
465 void CONF_modules_free(void)
467 CONF_modules_finish();
468 CONF_modules_unload(1);
471 /* Utility functions */
473 const char *CONF_imodule_get_name(const CONF_IMODULE *md)
478 const char *CONF_imodule_get_value(const CONF_IMODULE *md)
483 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md)
488 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data)
490 md->usr_data = usr_data;
493 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md)
498 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md)
503 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags)
508 void *CONF_module_get_usr_data(CONF_MODULE *pmod)
510 return pmod->usr_data;
513 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data)
515 pmod->usr_data = usr_data;
518 /* Return default config file name */
520 char *CONF_get1_default_config_file(void)
525 file = getenv("OPENSSL_CONF");
527 return OPENSSL_strdup(file);
529 len = strlen(X509_get_default_cert_area());
530 #ifndef OPENSSL_SYS_VMS
533 len += strlen(OPENSSL_CONF);
535 file = OPENSSL_malloc(len + 1);
539 OPENSSL_strlcpy(file, X509_get_default_cert_area(), len + 1);
540 #ifndef OPENSSL_SYS_VMS
541 OPENSSL_strlcat(file, "/", len + 1);
543 OPENSSL_strlcat(file, OPENSSL_CONF, len + 1);
549 * This function takes a list separated by 'sep' and calls the callback
550 * function giving the start and length of each member optionally stripping
551 * leading and trailing whitespace. This can be used to parse comma separated
555 int CONF_parse_list(const char *list_, int sep, int nospc,
556 int (*list_cb) (const char *elem, int len, void *usr),
560 const char *lstart, *tmpend, *p;
563 CONFerr(CONF_F_CONF_PARSE_LIST, CONF_R_LIST_CANNOT_BE_NULL);
570 while (*lstart && isspace((unsigned char)*lstart))
573 p = strchr(lstart, sep);
574 if (p == lstart || !*lstart)
575 ret = list_cb(NULL, 0, arg);
580 tmpend = lstart + strlen(lstart) - 1;
582 while (isspace((unsigned char)*tmpend))
585 ret = list_cb(lstart, tmpend - lstart + 1, arg);