2 /* Written by Stephen Henson (shenson@bigfoot.com) 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;
133 if (!cnf || !appname)
137 vsection = NCONF_get_string(cnf, NULL, appname);
145 values = NCONF_get_section(cnf, vsection);
150 for (i = 0; i < sk_CONF_VALUE_num(values); i++)
152 vl = sk_CONF_VALUE_value(values, i);
153 ret = module_run(cnf, vl->name, vl->value, flags);
155 if(!(flags & CONF_MFLAGS_IGNORE_ERRORS))
163 int CONF_modules_load_file(const char *filename, const char *appname,
168 conf = NCONF_new(NULL);
172 if (NCONF_load(conf, filename, NULL) <= 0)
175 ret = CONF_modules_load(conf, appname, flags);
183 static int module_run(const CONF *cnf, char *name, char *value,
189 md = module_find(name);
191 /* Module not found: try to load DSO */
193 md = module_load_dso(cnf, name, value, flags);
197 if (!(flags & CONF_MFLAGS_SILENT))
199 CONFerr(CONF_F_MODULE_RUN, CONF_R_UNKNOWN_MODULE_NAME);
200 ERR_add_error_data(2, "module=", name);
205 ret = module_init(md, name, value, cnf);
209 if (!(flags & CONF_MFLAGS_SILENT))
212 CONFerr(CONF_F_CONF_MODULES_LOAD, CONF_R_MODULE_INITIALIZATION_ERROR);
213 sprintf(rcode, "%-8d", ret);
214 ERR_add_error_data(6, "module=", name, ", value=", value, ", retcode=", rcode);
221 /* Load a module from a DSO */
222 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
226 conf_init_func *ifunc;
227 conf_finish_func *ffunc;
231 /* Look for alternative path in module section */
232 path = NCONF_get_string(cnf, value, "path");
238 dso = DSO_load(NULL, path, NULL, 0);
241 errcode = CONF_R_ERROR_LOADING_DSO;
244 ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
247 errcode = CONF_R_MISSING_INIT_FUNCTION;
250 ffunc = (conf_finish_func *)DSO_bind_func(dso, DSO_mod_finish_name);
253 errcode = CONF_R_MISSING_FINISH_FUNCTION;
256 /* All OK, add module */
257 md = module_add(dso, name, ifunc, ffunc);
267 CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
268 ERR_add_error_data(4, "module=", name, ", path=", path);
272 /* add module to list */
273 static CONF_MODULE *module_add(DSO *dso, const char *name,
274 conf_init_func *ifunc, conf_finish_func *ffunc)
276 CONF_MODULE *tmod = NULL;
277 if (supported_modules == NULL)
278 supported_modules = sk_CONF_MODULE_new_null();
279 if (supported_modules == NULL)
281 tmod = OPENSSL_malloc(sizeof(CONF_MODULE));
286 tmod->name = BUF_strdup(name);
288 tmod->finish = ffunc;
291 if (!sk_CONF_MODULE_push(supported_modules, tmod))
300 /* Find a module from the list. We allow module names of the
301 * form modname.XXXX to just search for modname to allow the
302 * same module to be initialized more than once.
305 static CONF_MODULE *module_find(char *name)
310 p = strrchr(name, '.');
315 nchar = strlen(name);
317 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))
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(CONF_IMODULE));
342 imod->name = BUF_strdup(name);
343 imod->value = BUF_strdup(value);
344 imod->usr_data = NULL;
346 if (!imod->name || !imod->value)
349 /* Try to initialize module */
352 ret = pmod->init(imod, cnf);
354 /* Error occurred, exit */
359 if (initialized_modules == NULL)
361 initialized_modules = sk_CONF_IMODULE_new_null();
362 if (!initialized_modules)
364 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
369 if (!sk_CONF_IMODULE_push(initialized_modules, imod))
371 CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
381 /* We've started the module so we'd better finish it */
382 if (pmod->finish && init_called)
389 OPENSSL_free(imod->name);
391 OPENSSL_free(imod->value);
399 /* Unload any dynamic modules that have a link count of zero:
400 * i.e. have no active initialized modules. If 'all' is set
401 * then all modules are unloaded including static ones.
404 void CONF_modules_unload(int all)
408 /* unload modules in reverse order */
409 for (i = sk_CONF_MODULE_num(supported_modules) - 1; i >= 0; i--)
411 md = sk_CONF_MODULE_value(supported_modules, i);
412 /* If static or in use and 'all' not set ignore it */
413 if (((md->links > 0) || !md->dso) && !all)
415 /* Since we're working in reverse this is OK */
416 sk_CONF_MODULE_delete(supported_modules, i);
419 if (sk_CONF_MODULE_num(supported_modules) == 0)
421 sk_CONF_MODULE_free(supported_modules);
422 supported_modules = NULL;
426 /* unload a single module */
427 static void module_free(CONF_MODULE *md)
431 OPENSSL_free(md->name);
435 /* finish and free up all modules instances */
437 void CONF_modules_finish(void)
440 while (sk_CONF_IMODULE_num(initialized_modules) > 0)
442 imod = sk_CONF_IMODULE_pop(initialized_modules);
445 sk_CONF_IMODULE_free(initialized_modules);
446 initialized_modules = NULL;
449 /* finish a module instance */
451 static void module_finish(CONF_IMODULE *imod)
453 imod->pmod->finish(imod);
455 OPENSSL_free(imod->name);
456 OPENSSL_free(imod->value);
460 /* Add a static module to OpenSSL */
462 int CONF_module_add(const char *name, conf_init_func *ifunc,
463 conf_finish_func *ffunc)
465 if (module_add(NULL, name, ifunc, ffunc))
471 void CONF_modules_free(void)
473 CONF_modules_finish();
474 CONF_modules_unload(1);
477 /* Utility functions */
479 const char *CONF_imodule_get_name(const CONF_IMODULE *md)
484 const char *CONF_imodule_get_value(const CONF_IMODULE *md)
489 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md)
494 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data)
496 md->usr_data = usr_data;
499 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md)
504 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md)
509 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags)
514 void *CONF_module_get_usr_data(CONF_MODULE *pmod)
516 return pmod->usr_data;
519 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data)
521 pmod->usr_data = usr_data;
524 /* Return default config file name */
526 char *CONF_get1_default_config_file(void)
531 file = getenv("OPENSSL_CONF");
533 return BUF_strdup(file);
535 len = strlen(X509_get_default_cert_area());
536 #ifndef OPENSSL_SYS_VMS
539 len += strlen(OPENSSL_CONF);
541 file = OPENSSL_malloc(len + 1);
545 strcpy(file,X509_get_default_cert_area());
546 #ifndef OPENSSL_SYS_VMS
549 strcat(file,OPENSSL_CONF);
554 /* This function takes a list separated by 'sep' and calls the
555 * callback function giving the start and length of each member
556 * optionally stripping leading and trailing whitespace. This can
557 * be used to parse comma separated lists for example.
560 int CONF_parse_list(const char *list, int sep, int nospc,
561 int (*list_cb)(const char *elem, int len, void *usr), void *arg)
564 const char *lstart, *tmpend, *p;
571 while(*lstart && isspace((unsigned char)*lstart))
574 p = strchr(lstart, sep);
575 if (p == lstart || !*lstart)
576 ret = list_cb(NULL, 0, arg);
582 tmpend = lstart + strlen(lstart) - 1;
585 while(isspace((unsigned char)*tmpend))
588 ret = list_cb(lstart, tmpend - lstart + 1, arg);