Add support for passing the libctx to the config loader
[openssl.git] / crypto / conf / conf_lib.c
1 /*
2  * Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include "e_os.h"
11 #include <stdio.h>
12 #include <string.h>
13 #include "internal/conf.h"
14 #include "crypto/ctype.h"
15 #include <openssl/crypto.h>
16 #include <openssl/err.h>
17 #include <openssl/conf.h>
18 #include <openssl/conf_api.h>
19 #include <openssl/lhash.h>
20
21 static CONF_METHOD *default_CONF_method = NULL;
22
23 /* Init a 'CONF' structure from an old LHASH */
24
25 void CONF_set_nconf(CONF *conf, LHASH_OF(CONF_VALUE) *hash)
26 {
27     if (default_CONF_method == NULL)
28         default_CONF_method = NCONF_default();
29
30     default_CONF_method->init(conf);
31     conf->data = hash;
32 }
33
34 /*
35  * The following section contains the "CONF classic" functions, rewritten in
36  * terms of the new CONF interface.
37  */
38
39 int CONF_set_default_method(CONF_METHOD *meth)
40 {
41     default_CONF_method = meth;
42     return 1;
43 }
44
45 LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
46                                 long *eline)
47 {
48     LHASH_OF(CONF_VALUE) *ltmp;
49     BIO *in = NULL;
50
51 #ifdef OPENSSL_SYS_VMS
52     in = BIO_new_file(file, "r");
53 #else
54     in = BIO_new_file(file, "rb");
55 #endif
56     if (in == NULL) {
57         CONFerr(CONF_F_CONF_LOAD, ERR_R_SYS_LIB);
58         return NULL;
59     }
60
61     ltmp = CONF_load_bio(conf, in, eline);
62     BIO_free(in);
63
64     return ltmp;
65 }
66
67 #ifndef OPENSSL_NO_STDIO
68 LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
69                                    long *eline)
70 {
71     BIO *btmp;
72     LHASH_OF(CONF_VALUE) *ltmp;
73     if ((btmp = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
74         CONFerr(CONF_F_CONF_LOAD_FP, ERR_R_BUF_LIB);
75         return NULL;
76     }
77     ltmp = CONF_load_bio(conf, btmp, eline);
78     BIO_free(btmp);
79     return ltmp;
80 }
81 #endif
82
83 LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp,
84                                     long *eline)
85 {
86     CONF ctmp;
87     int ret;
88
89     CONF_set_nconf(&ctmp, conf);
90
91     ret = NCONF_load_bio(&ctmp, bp, eline);
92     if (ret)
93         return ctmp.data;
94     return NULL;
95 }
96
97 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
98                                        const char *section)
99 {
100     if (conf == NULL) {
101         return NULL;
102     } else {
103         CONF ctmp;
104         CONF_set_nconf(&ctmp, conf);
105         return NCONF_get_section(&ctmp, section);
106     }
107 }
108
109 char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
110                       const char *name)
111 {
112     if (conf == NULL) {
113         return NCONF_get_string(NULL, group, name);
114     } else {
115         CONF ctmp;
116         CONF_set_nconf(&ctmp, conf);
117         return NCONF_get_string(&ctmp, group, name);
118     }
119 }
120
121 long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
122                      const char *name)
123 {
124     int status;
125     long result = 0;
126
127     ERR_set_mark();
128     if (conf == NULL) {
129         status = NCONF_get_number_e(NULL, group, name, &result);
130     } else {
131         CONF ctmp;
132         CONF_set_nconf(&ctmp, conf);
133         status = NCONF_get_number_e(&ctmp, group, name, &result);
134     }
135     ERR_pop_to_mark();
136     return status == 0 ? 0L : result;
137 }
138
139 void CONF_free(LHASH_OF(CONF_VALUE) *conf)
140 {
141     CONF ctmp;
142     CONF_set_nconf(&ctmp, conf);
143     NCONF_free_data(&ctmp);
144 }
145
146 #ifndef OPENSSL_NO_STDIO
147 int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out)
148 {
149     BIO *btmp;
150     int ret;
151
152     if ((btmp = BIO_new_fp(out, BIO_NOCLOSE)) == NULL) {
153         CONFerr(CONF_F_CONF_DUMP_FP, ERR_R_BUF_LIB);
154         return 0;
155     }
156     ret = CONF_dump_bio(conf, btmp);
157     BIO_free(btmp);
158     return ret;
159 }
160 #endif
161
162 int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out)
163 {
164     CONF ctmp;
165     CONF_set_nconf(&ctmp, conf);
166     return NCONF_dump_bio(&ctmp, out);
167 }
168
169 /*
170  * The following section contains the "New CONF" functions.  They are
171  * completely centralised around a new CONF structure that may contain
172  * basically anything, but at least a method pointer and a table of data.
173  * These functions are also written in terms of the bridge functions used by
174  * the "CONF classic" functions, for consistency.
175  */
176
177 CONF *NCONF_new_with_libctx(OPENSSL_CTX *libctx, CONF_METHOD *meth)
178 {
179     CONF *ret;
180
181     if (meth == NULL)
182         meth = NCONF_default();
183
184     ret = meth->create(meth);
185     if (ret == NULL) {
186         CONFerr(0, ERR_R_MALLOC_FAILURE);
187         return NULL;
188     }
189     ret->libctx = libctx;
190
191     return ret;
192 }
193
194 CONF *NCONF_new(CONF_METHOD *meth)
195 {
196     return NCONF_new_with_libctx(NULL, meth);
197 }
198
199 void NCONF_free(CONF *conf)
200 {
201     if (conf == NULL)
202         return;
203     conf->meth->destroy(conf);
204 }
205
206 void NCONF_free_data(CONF *conf)
207 {
208     if (conf == NULL)
209         return;
210     conf->meth->destroy_data(conf);
211 }
212
213 int NCONF_load(CONF *conf, const char *file, long *eline)
214 {
215     if (conf == NULL) {
216         CONFerr(CONF_F_NCONF_LOAD, CONF_R_NO_CONF);
217         return 0;
218     }
219
220     return conf->meth->load(conf, file, eline);
221 }
222
223 #ifndef OPENSSL_NO_STDIO
224 int NCONF_load_fp(CONF *conf, FILE *fp, long *eline)
225 {
226     BIO *btmp;
227     int ret;
228     if ((btmp = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
229         CONFerr(CONF_F_NCONF_LOAD_FP, ERR_R_BUF_LIB);
230         return 0;
231     }
232     ret = NCONF_load_bio(conf, btmp, eline);
233     BIO_free(btmp);
234     return ret;
235 }
236 #endif
237
238 int NCONF_load_bio(CONF *conf, BIO *bp, long *eline)
239 {
240     if (conf == NULL) {
241         CONFerr(CONF_F_NCONF_LOAD_BIO, CONF_R_NO_CONF);
242         return 0;
243     }
244
245     return conf->meth->load_bio(conf, bp, eline);
246 }
247
248 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *section)
249 {
250     if (conf == NULL) {
251         CONFerr(CONF_F_NCONF_GET_SECTION, CONF_R_NO_CONF);
252         return NULL;
253     }
254
255     if (section == NULL) {
256         CONFerr(CONF_F_NCONF_GET_SECTION, CONF_R_NO_SECTION);
257         return NULL;
258     }
259
260     return _CONF_get_section_values(conf, section);
261 }
262
263 char *NCONF_get_string(const CONF *conf, const char *group, const char *name)
264 {
265     char *s = _CONF_get_string(conf, group, name);
266
267     /*
268      * Since we may get a value from an environment variable even if conf is
269      * NULL, let's check the value first
270      */
271     if (s)
272         return s;
273
274     if (conf == NULL) {
275         CONFerr(CONF_F_NCONF_GET_STRING,
276                 CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE);
277         return NULL;
278     }
279     CONFerr(CONF_F_NCONF_GET_STRING, CONF_R_NO_VALUE);
280     ERR_add_error_data(4, "group=", group, " name=", name);
281     return NULL;
282 }
283
284 static int default_is_number(const CONF *conf, char c)
285 {
286     return ossl_isdigit(c);
287 }
288
289 static int default_to_int(const CONF *conf, char c)
290 {
291     return (int)(c - '0');
292 }
293
294 int NCONF_get_number_e(const CONF *conf, const char *group, const char *name,
295                        long *result)
296 {
297     char *str;
298     long res;
299     int (*is_number)(const CONF *, char) = &default_is_number;
300     int (*to_int)(const CONF *, char) = &default_to_int;
301
302     if (result == NULL) {
303         CONFerr(CONF_F_NCONF_GET_NUMBER_E, ERR_R_PASSED_NULL_PARAMETER);
304         return 0;
305     }
306
307     str = NCONF_get_string(conf, group, name);
308
309     if (str == NULL)
310         return 0;
311
312     if (conf != NULL) {
313         if (conf->meth->is_number != NULL)
314             is_number = conf->meth->is_number;
315         if (conf->meth->to_int != NULL)
316             to_int = conf->meth->to_int;
317     }
318     for (res = 0; is_number(conf, *str); str++) {
319         const int d = to_int(conf, *str);
320
321         if (res > (LONG_MAX - d) / 10L) {
322             CONFerr(CONF_F_NCONF_GET_NUMBER_E, CONF_R_NUMBER_TOO_LARGE);
323             return 0;
324         }
325         res = res * 10 + d;
326     }
327
328     *result = res;
329     return 1;
330 }
331
332 #ifndef OPENSSL_NO_STDIO
333 int NCONF_dump_fp(const CONF *conf, FILE *out)
334 {
335     BIO *btmp;
336     int ret;
337     if ((btmp = BIO_new_fp(out, BIO_NOCLOSE)) == NULL) {
338         CONFerr(CONF_F_NCONF_DUMP_FP, ERR_R_BUF_LIB);
339         return 0;
340     }
341     ret = NCONF_dump_bio(conf, btmp);
342     BIO_free(btmp);
343     return ret;
344 }
345 #endif
346
347 int NCONF_dump_bio(const CONF *conf, BIO *out)
348 {
349     if (conf == NULL) {
350         CONFerr(CONF_F_NCONF_DUMP_BIO, CONF_R_NO_CONF);
351         return 0;
352     }
353
354     return conf->meth->dump(conf, out);
355 }
356
357 /*
358  * These routines call the C malloc/free, to avoid intermixing with
359  * OpenSSL function pointers before the library is initialized.
360  */
361 OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void)
362 {
363     OPENSSL_INIT_SETTINGS *ret = malloc(sizeof(*ret));
364
365     if (ret == NULL)
366         return NULL;
367
368     memset(ret, 0, sizeof(*ret));
369     ret->flags = DEFAULT_CONF_MFLAGS;
370
371     return ret;
372 }
373
374
375 #ifndef OPENSSL_NO_STDIO
376 int OPENSSL_INIT_set_config_filename(OPENSSL_INIT_SETTINGS *settings,
377                                      const char *filename)
378 {
379     char *newfilename = NULL;
380
381     if (filename != NULL) {
382         newfilename = strdup(filename);
383         if (newfilename == NULL)
384             return 0;
385     }
386
387     free(settings->filename);
388     settings->filename = newfilename;
389
390     return 1;
391 }
392
393 void OPENSSL_INIT_set_config_file_flags(OPENSSL_INIT_SETTINGS *settings,
394                                         unsigned long flags)
395 {
396     settings->flags = flags;
397 }
398
399 int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *settings,
400                                     const char *appname)
401 {
402     char *newappname = NULL;
403
404     if (appname != NULL) {
405         newappname = strdup(appname);
406         if (newappname == NULL)
407             return 0;
408     }
409
410     free(settings->appname);
411     settings->appname = newappname;
412
413     return 1;
414 }
415 #endif
416
417 void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *settings)
418 {
419     free(settings->filename);
420     free(settings->appname);
421     free(settings);
422 }