2 /* Written by Stephen Henson (steve@openssl.org) for the OpenSSL
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>
63 #include <openssl/conf.h>
64 #include <openssl/dso.h>
65 #include <openssl/x509.h>
68 #define DSO_mod_init_name "OPENSSL_init"
69 #define DSO_mod_finish_name "OPENSSL_finish"
72 /* This structure contains a data about supported modules.
73 * entries in this table correspond to either dynamic or
79 /* DSO of this module or NULL if static */
81 /* Name of the module */
86 conf_finish_func *finish;
87 /* Number of successfully initialized modules */
93 /* This structure contains information about modules that have been
94 * successfully initialized. There may be more than one entry for a
98 struct conf_imodule_st
107 static STACK_OF(CONF_MODULE) *supported_modules = NULL;
108 static STACK_OF(CONF_IMODULE) *initialized_modules = NULL;
110 static void module_free(CONF_MODULE *md);
111 static void module_finish(CONF_IMODULE *imod);
112 static int module_run(const CONF *cnf, char *name, char *value,
113 unsigned long flags);
114 static CONF_MODULE *module_add(DSO *dso, const char *name,
115 conf_init_func *ifunc, conf_finish_func *ffunc);
116 static CONF_MODULE *module_find(char *name);
117 static int module_init(CONF_MODULE *pmod, char *name, char *value,
119 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
120 unsigned long flags);
122 /* Main function: load modules from a CONF structure */
124 int CONF_modules_load(const CONF *cnf, const char *appname,
127 STACK_OF(CONF_VALUE) *values;
129 char *vsection = NULL;
137 vsection = NCONF_get_string(cnf, NULL, appname);
139 if (!appname || (!vsection && (flags & CONF_MFLAGS_DEFAULT_SECTION)))
140 vsection = NCONF_get_string(cnf, NULL, "openssl_conf");
148 values = NCONF_get_section(cnf, vsection);
153 for (i = 0; i < sk_CONF_VALUE_num(values); i++)
155 vl = sk_CONF_VALUE_value(values, i);
156 ret = module_run(cnf, vl->name, vl->value, flags);
158 if(!(flags & CONF_MFLAGS_IGNORE_ERRORS))
166 int CONF_modules_load_file(const char *filename, const char *appname,
172 conf = NCONF_new(NULL);
176 if (filename == NULL)
178 file = CONF_get1_default_config_file();
183 file = (char *)filename;
185 if (NCONF_load(conf, file, NULL) <= 0)
187 if ((flags & CONF_MFLAGS_IGNORE_MISSING_FILE) &&
188 (ERR_GET_REASON(ERR_peek_last_error()) == CONF_R_NO_SUCH_FILE))
196 ret = CONF_modules_load(conf, appname, flags);
199 if (filename == NULL)
206 static int module_run(const CONF *cnf, char *name, char *value,
212 md = module_find(name);
214 /* Module not found: try to load DSO */
215 if (!md && !(flags & CONF_MFLAGS_NO_DSO))
216 md = module_load_dso(cnf, name, value, flags);
220 if (!(flags & CONF_MFLAGS_SILENT))
222 CONFerr(CONF_F_MODULE_RUN, CONF_R_UNKNOWN_MODULE_NAME);
223 ERR_add_error_data(2, "module=", name);
228 ret = module_init(md, name, value, cnf);
232 if (!(flags & CONF_MFLAGS_SILENT))
234 char rcode[DECIMAL_SIZE(ret)+1];
235 CONFerr(CONF_F_MODULE_RUN, CONF_R_MODULE_INITIALIZATION_ERROR);
236 BIO_snprintf(rcode, sizeof rcode, "%-8d", ret);
237 ERR_add_error_data(6, "module=", name, ", value=", value, ", retcode=", rcode);
244 /* Load a module from a DSO */
245 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
249 conf_init_func *ifunc;
250 conf_finish_func *ffunc;
254 /* Look for alternative path in module section */
255 path = NCONF_get_string(cnf, value, "path");
261 dso = DSO_load(NULL, path, NULL, 0);
264 errcode = CONF_R_ERROR_LOADING_DSO;
267 ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
270 errcode = CONF_R_MISSING_INIT_FUNCTION;
273 ffunc = (conf_finish_func *)DSO_bind_func(dso, DSO_mod_finish_name);
274 /* All OK, add module */
275 md = module_add(dso, name, ifunc, ffunc);
285 CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
286 ERR_add_error_data(4, "module=", name, ", path=", path);
290 /* add module to list */
291 static CONF_MODULE *module_add(DSO *dso, const char *name,
292 conf_init_func *ifunc, conf_finish_func *ffunc)
294 CONF_MODULE *tmod = NULL;
295 if (supported_modules == NULL)
296 supported_modules = sk_CONF_MODULE_new_null();
297 if (supported_modules == NULL)
299 tmod = OPENSSL_malloc(sizeof(CONF_MODULE));
304 tmod->name = BUF_strdup(name);
306 tmod->finish = ffunc;
309 if (!sk_CONF_MODULE_push(supported_modules, tmod))
318 /* Find a module from the list. We allow module names of the
319 * form modname.XXXX to just search for modname to allow the
320 * same module to be initialized more than once.
323 static CONF_MODULE *module_find(char *name)
328 p = strrchr(name, '.');
333 nchar = strlen(name);
335 for (i = 0; i < sk_CONF_MODULE_num(supported_modules); i++)
337 tmod = sk_CONF_MODULE_value(supported_modules, i);
338 if (!strncmp(tmod->name, name, nchar))
346 /* initialize a module */
347 static int module_init(CONF_MODULE *pmod, char *name, char *value,
352 CONF_IMODULE *imod = NULL;
354 /* Otherwise add initialized module to list */
355 imod = OPENSSL_malloc(sizeof(CONF_IMODULE));
360 imod->name = BUF_strdup(name);
361 imod->value = BUF_strdup(value);
362 imod->usr_data = NULL;
364 if (!imod->name || !imod->value)
367 /* Try to initialize module */
370 ret = pmod->init(imod, cnf);
372 /* Error occurred, exit */
377 if (initialized_modules == NULL)
379 initialized_modules = sk_CONF_IMODULE_new_null();
380 if (!initialized_modules)
382 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
387 if (!sk_CONF_IMODULE_push(initialized_modules, imod))
389 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
399 /* We've started the module so we'd better finish it */
400 if (pmod->finish && init_called)
407 OPENSSL_free(imod->name);
409 OPENSSL_free(imod->value);
417 /* Unload any dynamic modules that have a link count of zero:
418 * i.e. have no active initialized modules. If 'all' is set
419 * then all modules are unloaded including static ones.
422 void CONF_modules_unload(int all)
426 CONF_modules_finish();
427 /* unload modules in reverse order */
428 for (i = sk_CONF_MODULE_num(supported_modules) - 1; i >= 0; i--)
430 md = sk_CONF_MODULE_value(supported_modules, i);
431 /* If static or in use and 'all' not set ignore it */
432 if (((md->links > 0) || !md->dso) && !all)
434 /* Since we're working in reverse this is OK */
435 (void)sk_CONF_MODULE_delete(supported_modules, i);
438 if (sk_CONF_MODULE_num(supported_modules) == 0)
440 sk_CONF_MODULE_free(supported_modules);
441 supported_modules = NULL;
445 /* unload a single module */
446 static void module_free(CONF_MODULE *md)
450 OPENSSL_free(md->name);
454 /* finish and free up all modules instances */
456 void CONF_modules_finish(void)
459 while (sk_CONF_IMODULE_num(initialized_modules) > 0)
461 imod = sk_CONF_IMODULE_pop(initialized_modules);
464 sk_CONF_IMODULE_free(initialized_modules);
465 initialized_modules = NULL;
468 /* finish a module instance */
470 static void module_finish(CONF_IMODULE *imod)
472 if (imod->pmod->finish)
473 imod->pmod->finish(imod);
475 OPENSSL_free(imod->name);
476 OPENSSL_free(imod->value);
480 /* Add a static module to OpenSSL */
482 int CONF_module_add(const char *name, conf_init_func *ifunc,
483 conf_finish_func *ffunc)
485 if (module_add(NULL, name, ifunc, ffunc))
491 void CONF_modules_free(void)
493 CONF_modules_finish();
494 CONF_modules_unload(1);
497 /* Utility functions */
499 const char *CONF_imodule_get_name(const CONF_IMODULE *md)
504 const char *CONF_imodule_get_value(const CONF_IMODULE *md)
509 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md)
514 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data)
516 md->usr_data = usr_data;
519 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md)
524 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md)
529 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags)
534 void *CONF_module_get_usr_data(CONF_MODULE *pmod)
536 return pmod->usr_data;
539 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data)
541 pmod->usr_data = usr_data;
544 /* Return default config file name */
546 char *CONF_get1_default_config_file(void)
551 file = getenv("OPENSSL_CONF");
553 return BUF_strdup(file);
555 len = strlen(X509_get_default_cert_area());
556 #ifndef OPENSSL_SYS_VMS
559 len += strlen(OPENSSL_CONF);
561 file = OPENSSL_malloc(len + 1);
565 BUF_strlcpy(file,X509_get_default_cert_area(),len + 1);
566 #ifndef OPENSSL_SYS_VMS
567 BUF_strlcat(file,"/",len + 1);
569 BUF_strlcat(file,OPENSSL_CONF,len + 1);
574 /* This function takes a list separated by 'sep' and calls the
575 * callback function giving the start and length of each member
576 * optionally stripping leading and trailing whitespace. This can
577 * be used to parse comma separated lists for example.
580 int CONF_parse_list(const char *list_, int sep, int nospc,
581 int (*list_cb)(const char *elem, int len, void *usr), void *arg)
584 const char *lstart, *tmpend, *p;
588 CONFerr(CONF_F_CONF_PARSE_LIST, CONF_R_LIST_CANNOT_BE_NULL);
597 while(*lstart && isspace((unsigned char)*lstart))
600 p = strchr(lstart, sep);
601 if (p == lstart || !*lstart)
602 ret = list_cb(NULL, 0, arg);
608 tmpend = lstart + strlen(lstart) - 1;
611 while(isspace((unsigned char)*tmpend))
614 ret = list_cb(lstart, tmpend - lstart + 1, arg);