4fafdeddd333d54e1b4dcaa88aaab9a5354e6ab6
[openssl.git] / crypto / conf / conf_mod.c
1 /* conf_mod.c */
2 /*
3  * Written by Stephen Henson (steve@openssl.org) for the OpenSSL project
4  * 2001.
5  */
6 /* ====================================================================
7  * Copyright (c) 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 <stdio.h>
61 #include <ctype.h>
62 #include <openssl/crypto.h>
63 #include "internal/cryptlib.h"
64 #include <openssl/conf.h>
65 #include <openssl/dso.h>
66 #include <openssl/x509.h>
67
68 #define DSO_mod_init_name "OPENSSL_init"
69 #define DSO_mod_finish_name "OPENSSL_finish"
70
71 /*
72  * This structure contains a data about supported modules. entries in this
73  * table correspond to either dynamic or static modules.
74  */
75
76 struct conf_module_st {
77     /* DSO of this module or NULL if static */
78     DSO *dso;
79     /* Name of the module */
80     char *name;
81     /* Init function */
82     conf_init_func *init;
83     /* Finish function */
84     conf_finish_func *finish;
85     /* Number of successfully initialized modules */
86     int links;
87     void *usr_data;
88 };
89
90 /*
91  * This structure contains information about modules that have been
92  * successfully initialized. There may be more than one entry for a given
93  * module.
94  */
95
96 struct conf_imodule_st {
97     CONF_MODULE *pmod;
98     char *name;
99     char *value;
100     unsigned long flags;
101     void *usr_data;
102 };
103
104 static STACK_OF(CONF_MODULE) *supported_modules = NULL;
105 static STACK_OF(CONF_IMODULE) *initialized_modules = NULL;
106
107 static void module_free(CONF_MODULE *md);
108 static void module_finish(CONF_IMODULE *imod);
109 static int module_run(const CONF *cnf, char *name, char *value,
110                       unsigned long flags);
111 static CONF_MODULE *module_add(DSO *dso, const char *name,
112                                conf_init_func *ifunc,
113                                conf_finish_func *ffunc);
114 static CONF_MODULE *module_find(char *name);
115 static int module_init(CONF_MODULE *pmod, char *name, char *value,
116                        const CONF *cnf);
117 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
118                                     unsigned long flags);
119
120 /* Main function: load modules from a CONF structure */
121
122 int CONF_modules_load(const CONF *cnf, const char *appname,
123                       unsigned long flags)
124 {
125     STACK_OF(CONF_VALUE) *values;
126     CONF_VALUE *vl;
127     char *vsection = NULL;
128
129     int ret, i;
130
131     if (!cnf)
132         return 1;
133
134     if (appname)
135         vsection = NCONF_get_string(cnf, NULL, appname);
136
137     if (!appname || (!vsection && (flags & CONF_MFLAGS_DEFAULT_SECTION)))
138         vsection = NCONF_get_string(cnf, NULL, "openssl_conf");
139
140     if (!vsection) {
141         ERR_clear_error();
142         return 1;
143     }
144
145     values = NCONF_get_section(cnf, vsection);
146
147     if (!values)
148         return 0;
149
150     for (i = 0; i < sk_CONF_VALUE_num(values); i++) {
151         vl = sk_CONF_VALUE_value(values, i);
152         ret = module_run(cnf, vl->name, vl->value, flags);
153         if (ret <= 0)
154             if (!(flags & CONF_MFLAGS_IGNORE_ERRORS))
155                 return ret;
156     }
157
158     return 1;
159
160 }
161
162 int CONF_modules_load_file(const char *filename, const char *appname,
163                            unsigned long flags)
164 {
165     char *file = NULL;
166     CONF *conf = NULL;
167     int ret = 0;
168     conf = NCONF_new(NULL);
169     if (conf == NULL)
170         goto err;
171
172     if (filename == NULL) {
173         file = CONF_get1_default_config_file();
174         if (!file)
175             goto err;
176     } else
177         file = (char *)filename;
178
179     if (NCONF_load(conf, file, NULL) <= 0) {
180         if ((flags & CONF_MFLAGS_IGNORE_MISSING_FILE) &&
181             (ERR_GET_REASON(ERR_peek_last_error()) == CONF_R_NO_SUCH_FILE)) {
182             ERR_clear_error();
183             ret = 1;
184         }
185         goto err;
186     }
187
188     ret = CONF_modules_load(conf, appname, flags);
189
190  err:
191     if (filename == NULL)
192         OPENSSL_free(file);
193     NCONF_free(conf);
194
195     return ret;
196 }
197
198 static int module_run(const CONF *cnf, char *name, char *value,
199                       unsigned long flags)
200 {
201     CONF_MODULE *md;
202     int ret;
203
204     md = module_find(name);
205
206     /* Module not found: try to load DSO */
207     if (!md && !(flags & CONF_MFLAGS_NO_DSO))
208         md = module_load_dso(cnf, name, value, flags);
209
210     if (!md) {
211         if (!(flags & CONF_MFLAGS_SILENT)) {
212             CONFerr(CONF_F_MODULE_RUN, CONF_R_UNKNOWN_MODULE_NAME);
213             ERR_add_error_data(2, "module=", name);
214         }
215         return -1;
216     }
217
218     ret = module_init(md, name, value, cnf);
219
220     if (ret <= 0) {
221         if (!(flags & CONF_MFLAGS_SILENT)) {
222             char rcode[DECIMAL_SIZE(ret) + 1];
223             CONFerr(CONF_F_MODULE_RUN, CONF_R_MODULE_INITIALIZATION_ERROR);
224             BIO_snprintf(rcode, sizeof rcode, "%-8d", ret);
225             ERR_add_error_data(6, "module=", name, ", value=", value,
226                                ", retcode=", rcode);
227         }
228     }
229
230     return ret;
231 }
232
233 /* Load a module from a DSO */
234 static CONF_MODULE *module_load_dso(const CONF *cnf, char *name, char *value,
235                                     unsigned long flags)
236 {
237     DSO *dso = NULL;
238     conf_init_func *ifunc;
239     conf_finish_func *ffunc;
240     char *path = NULL;
241     int errcode = 0;
242     CONF_MODULE *md;
243     /* Look for alternative path in module section */
244     path = NCONF_get_string(cnf, value, "path");
245     if (!path) {
246         ERR_clear_error();
247         path = name;
248     }
249     dso = DSO_load(NULL, path, NULL, 0);
250     if (!dso) {
251         errcode = CONF_R_ERROR_LOADING_DSO;
252         goto err;
253     }
254     ifunc = (conf_init_func *)DSO_bind_func(dso, DSO_mod_init_name);
255     if (!ifunc) {
256         errcode = CONF_R_MISSING_INIT_FUNCTION;
257         goto err;
258     }
259     ffunc = (conf_finish_func *)DSO_bind_func(dso, DSO_mod_finish_name);
260     /* All OK, add module */
261     md = module_add(dso, name, ifunc, ffunc);
262
263     if (!md)
264         goto err;
265
266     return md;
267
268  err:
269     DSO_free(dso);
270     CONFerr(CONF_F_MODULE_LOAD_DSO, errcode);
271     ERR_add_error_data(4, "module=", name, ", path=", path);
272     return NULL;
273 }
274
275 /* add module to list */
276 static CONF_MODULE *module_add(DSO *dso, const char *name,
277                                conf_init_func *ifunc, conf_finish_func *ffunc)
278 {
279     CONF_MODULE *tmod = NULL;
280     if (supported_modules == NULL)
281         supported_modules = sk_CONF_MODULE_new_null();
282     if (supported_modules == NULL)
283         return NULL;
284     tmod = OPENSSL_zalloc(sizeof(*tmod));
285     if (tmod == NULL)
286         return NULL;
287
288     tmod->dso = dso;
289     tmod->name = OPENSSL_strdup(name);
290     tmod->init = ifunc;
291     tmod->finish = ffunc;
292
293     if (!sk_CONF_MODULE_push(supported_modules, tmod)) {
294         OPENSSL_free(tmod);
295         return NULL;
296     }
297
298     return tmod;
299 }
300
301 /*
302  * Find a module from the list. We allow module names of the form
303  * modname.XXXX to just search for modname to allow the same module to be
304  * initialized more than once.
305  */
306
307 static CONF_MODULE *module_find(char *name)
308 {
309     CONF_MODULE *tmod;
310     int i, nchar;
311     char *p;
312     p = strrchr(name, '.');
313
314     if (p)
315         nchar = p - name;
316     else
317         nchar = strlen(name);
318
319     for (i = 0; i < sk_CONF_MODULE_num(supported_modules); i++) {
320         tmod = sk_CONF_MODULE_value(supported_modules, i);
321         if (strncmp(tmod->name, name, nchar) == 0)
322             return tmod;
323     }
324
325     return NULL;
326
327 }
328
329 /* initialize a module */
330 static int module_init(CONF_MODULE *pmod, char *name, char *value,
331                        const CONF *cnf)
332 {
333     int ret = 1;
334     int init_called = 0;
335     CONF_IMODULE *imod = NULL;
336
337     /* Otherwise add initialized module to list */
338     imod = OPENSSL_malloc(sizeof(*imod));
339     if (imod == NULL)
340         goto err;
341
342     imod->pmod = pmod;
343     imod->name = OPENSSL_strdup(name);
344     imod->value = OPENSSL_strdup(value);
345     imod->usr_data = NULL;
346
347     if (!imod->name || !imod->value)
348         goto memerr;
349
350     /* Try to initialize module */
351     if (pmod->init) {
352         ret = pmod->init(imod, cnf);
353         init_called = 1;
354         /* Error occurred, exit */
355         if (ret <= 0)
356             goto err;
357     }
358
359     if (initialized_modules == NULL) {
360         initialized_modules = sk_CONF_IMODULE_new_null();
361         if (!initialized_modules) {
362             CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
363             goto err;
364         }
365     }
366
367     if (!sk_CONF_IMODULE_push(initialized_modules, imod)) {
368         CONFerr(CONF_F_MODULE_INIT, ERR_R_MALLOC_FAILURE);
369         goto err;
370     }
371
372     pmod->links++;
373
374     return ret;
375
376  err:
377
378     /* We've started the module so we'd better finish it */
379     if (pmod->finish && init_called)
380         pmod->finish(imod);
381
382  memerr:
383     if (imod) {
384         OPENSSL_free(imod->name);
385         OPENSSL_free(imod->value);
386         OPENSSL_free(imod);
387     }
388
389     return -1;
390
391 }
392
393 /*
394  * Unload any dynamic modules that have a link count of zero: i.e. have no
395  * active initialized modules. If 'all' is set then all modules are unloaded
396  * including static ones.
397  */
398
399 void CONF_modules_unload(int all)
400 {
401     int i;
402     CONF_MODULE *md;
403     CONF_modules_finish();
404     /* unload modules in reverse order */
405     for (i = sk_CONF_MODULE_num(supported_modules) - 1; i >= 0; i--) {
406         md = sk_CONF_MODULE_value(supported_modules, i);
407         /* If static or in use and 'all' not set ignore it */
408         if (((md->links > 0) || !md->dso) && !all)
409             continue;
410         /* Since we're working in reverse this is OK */
411         (void)sk_CONF_MODULE_delete(supported_modules, i);
412         module_free(md);
413     }
414     if (sk_CONF_MODULE_num(supported_modules) == 0) {
415         sk_CONF_MODULE_free(supported_modules);
416         supported_modules = NULL;
417     }
418 }
419
420 /* unload a single module */
421 static void module_free(CONF_MODULE *md)
422 {
423     DSO_free(md->dso);
424     OPENSSL_free(md->name);
425     OPENSSL_free(md);
426 }
427
428 /* finish and free up all modules instances */
429
430 void CONF_modules_finish(void)
431 {
432     CONF_IMODULE *imod;
433     while (sk_CONF_IMODULE_num(initialized_modules) > 0) {
434         imod = sk_CONF_IMODULE_pop(initialized_modules);
435         module_finish(imod);
436     }
437     sk_CONF_IMODULE_free(initialized_modules);
438     initialized_modules = NULL;
439 }
440
441 /* finish a module instance */
442
443 static void module_finish(CONF_IMODULE *imod)
444 {
445     if (!imod)
446         return;
447     if (imod->pmod->finish)
448         imod->pmod->finish(imod);
449     imod->pmod->links--;
450     OPENSSL_free(imod->name);
451     OPENSSL_free(imod->value);
452     OPENSSL_free(imod);
453 }
454
455 /* Add a static module to OpenSSL */
456
457 int CONF_module_add(const char *name, conf_init_func *ifunc,
458                     conf_finish_func *ffunc)
459 {
460     if (module_add(NULL, name, ifunc, ffunc))
461         return 1;
462     else
463         return 0;
464 }
465
466 void CONF_modules_free(void)
467 {
468     CONF_modules_finish();
469     CONF_modules_unload(1);
470 }
471
472 /* Utility functions */
473
474 const char *CONF_imodule_get_name(const CONF_IMODULE *md)
475 {
476     return md->name;
477 }
478
479 const char *CONF_imodule_get_value(const CONF_IMODULE *md)
480 {
481     return md->value;
482 }
483
484 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md)
485 {
486     return md->usr_data;
487 }
488
489 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data)
490 {
491     md->usr_data = usr_data;
492 }
493
494 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md)
495 {
496     return md->pmod;
497 }
498
499 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md)
500 {
501     return md->flags;
502 }
503
504 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags)
505 {
506     md->flags = flags;
507 }
508
509 void *CONF_module_get_usr_data(CONF_MODULE *pmod)
510 {
511     return pmod->usr_data;
512 }
513
514 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data)
515 {
516     pmod->usr_data = usr_data;
517 }
518
519 /* Return default config file name */
520
521 char *CONF_get1_default_config_file(void)
522 {
523     char *file;
524     int len;
525
526     file = getenv("OPENSSL_CONF");
527     if (file)
528         return OPENSSL_strdup(file);
529
530     len = strlen(X509_get_default_cert_area());
531 #ifndef OPENSSL_SYS_VMS
532     len++;
533 #endif
534     len += strlen(OPENSSL_CONF);
535
536     file = OPENSSL_malloc(len + 1);
537
538     if (file == NULL)
539         return NULL;
540     OPENSSL_strlcpy(file, X509_get_default_cert_area(), len + 1);
541 #ifndef OPENSSL_SYS_VMS
542     OPENSSL_strlcat(file, "/", len + 1);
543 #endif
544     OPENSSL_strlcat(file, OPENSSL_CONF, len + 1);
545
546     return file;
547 }
548
549 /*
550  * This function takes a list separated by 'sep' and calls the callback
551  * function giving the start and length of each member optionally stripping
552  * leading and trailing whitespace. This can be used to parse comma separated
553  * lists for example.
554  */
555
556 int CONF_parse_list(const char *list_, int sep, int nospc,
557                     int (*list_cb) (const char *elem, int len, void *usr),
558                     void *arg)
559 {
560     int ret;
561     const char *lstart, *tmpend, *p;
562
563     if (list_ == NULL) {
564         CONFerr(CONF_F_CONF_PARSE_LIST, CONF_R_LIST_CANNOT_BE_NULL);
565         return 0;
566     }
567
568     lstart = list_;
569     for (;;) {
570         if (nospc) {
571             while (*lstart && isspace((unsigned char)*lstart))
572                 lstart++;
573         }
574         p = strchr(lstart, sep);
575         if (p == lstart || !*lstart)
576             ret = list_cb(NULL, 0, arg);
577         else {
578             if (p)
579                 tmpend = p - 1;
580             else
581                 tmpend = lstart + strlen(lstart) - 1;
582             if (nospc) {
583                 while (isspace((unsigned char)*tmpend))
584                     tmpend--;
585             }
586             ret = list_cb(lstart, tmpend - lstart + 1, arg);
587         }
588         if (ret <= 0)
589             return ret;
590         if (p == NULL)
591             return 1;
592         lstart = p + 1;
593     }
594 }