2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
10 /* Part of the code in here was originally in conf.c, which is now removed */
14 #include "internal/cryptlib.h"
15 #include "internal/o_dir.h"
16 #include <openssl/lhash.h>
17 #include <openssl/conf.h>
18 #include <openssl/conf_api.h>
20 #include <openssl/buffer.h>
21 #include <openssl/err.h>
22 #ifndef OPENSSL_NO_POSIX_IO
23 # include <sys/stat.h>
26 # define strcasecmp _stricmp
31 # define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
35 * The maximum length we can grow a value to after variable expansion. 64k
36 * should be more than enough for all reasonable uses.
38 #define MAX_CONF_VALUE_LENGTH 65536
40 static int is_keytype(const CONF *conf, char c, unsigned short type);
41 static char *eat_ws(CONF *conf, char *p);
42 static void trim_ws(CONF *conf, char *start);
43 static char *eat_alpha_numeric(CONF *conf, char *p);
44 static void clear_comments(CONF *conf, char *p);
45 static int str_copy(CONF *conf, char *section, char **to, char *from);
46 static char *scan_quote(CONF *conf, char *p);
47 static char *scan_dquote(CONF *conf, char *p);
48 #define scan_esc(conf,p) (((IS_EOF((conf),(p)[1]))?((p)+1):((p)+2)))
49 #ifndef OPENSSL_NO_POSIX_IO
50 static BIO *process_include(char *include, OPENSSL_DIR_CTX **dirctx,
52 static BIO *get_next_file(const char *path, OPENSSL_DIR_CTX **dirctx);
55 static CONF *def_create(CONF_METHOD *meth);
56 static int def_init_default(CONF *conf);
57 static int def_init_WIN32(CONF *conf);
58 static int def_destroy(CONF *conf);
59 static int def_destroy_data(CONF *conf);
60 static int def_load(CONF *conf, const char *name, long *eline);
61 static int def_load_bio(CONF *conf, BIO *bp, long *eline);
62 static int def_dump(const CONF *conf, BIO *bp);
63 static int def_is_number(const CONF *conf, char c);
64 static int def_to_int(const CONF *conf, char c);
66 static CONF_METHOD default_method = {
79 static CONF_METHOD WIN32_method = {
92 CONF_METHOD *NCONF_default(void)
94 return &default_method;
97 CONF_METHOD *NCONF_WIN32(void)
102 static CONF *def_create(CONF_METHOD *meth)
106 ret = OPENSSL_malloc(sizeof(*ret));
108 if (meth->init(ret) == 0) {
115 static int def_init_default(CONF *conf)
120 conf->meth = &default_method;
121 conf->meth_data = (void *)CONF_type_default;
127 static int def_init_WIN32(CONF *conf)
132 conf->meth = &WIN32_method;
133 conf->meth_data = (void *)CONF_type_win32;
139 static int def_destroy(CONF *conf)
141 if (def_destroy_data(conf)) {
148 static int def_destroy_data(CONF *conf)
152 _CONF_free_data(conf);
156 static int def_load(CONF *conf, const char *name, long *line)
161 #ifdef OPENSSL_SYS_VMS
162 in = BIO_new_file(name, "r");
164 in = BIO_new_file(name, "rb");
167 if (ERR_GET_REASON(ERR_peek_last_error()) == BIO_R_NO_SUCH_FILE)
168 CONFerr(CONF_F_DEF_LOAD, CONF_R_NO_SUCH_FILE);
170 CONFerr(CONF_F_DEF_LOAD, ERR_R_SYS_LIB);
174 ret = def_load_bio(conf, in, line);
180 static int def_load_bio(CONF *conf, BIO *in, long *line)
182 /* The macro BUFSIZE conflicts with a system macro in VxWorks */
183 #define CONFBUFSIZE 512
184 int bufnum = 0, i, ii;
185 BUF_MEM *buff = NULL;
189 char btmp[DECIMAL_SIZE(eline) + 1];
190 CONF_VALUE *v = NULL, *tv;
191 CONF_VALUE *sv = NULL;
192 char *section = NULL, *buf;
193 char *start, *psection, *pname;
194 void *h = (void *)(conf->data);
195 STACK_OF(BIO) *biosk = NULL;
196 #ifndef OPENSSL_NO_POSIX_IO
197 char *dirpath = NULL;
198 OPENSSL_DIR_CTX *dirctx = NULL;
201 if ((buff = BUF_MEM_new()) == NULL) {
202 CONFerr(CONF_F_DEF_LOAD_BIO, ERR_R_BUF_LIB);
206 section = OPENSSL_strdup("default");
207 if (section == NULL) {
208 CONFerr(CONF_F_DEF_LOAD_BIO, ERR_R_MALLOC_FAILURE);
212 if (_CONF_new_data(conf) == 0) {
213 CONFerr(CONF_F_DEF_LOAD_BIO, ERR_R_MALLOC_FAILURE);
217 sv = _CONF_new_section(conf, section);
219 CONFerr(CONF_F_DEF_LOAD_BIO, CONF_R_UNABLE_TO_CREATE_NEW_SECTION);
226 if (!BUF_MEM_grow(buff, bufnum + CONFBUFSIZE)) {
227 CONFerr(CONF_F_DEF_LOAD_BIO, ERR_R_BUF_LIB);
230 p = &(buff->data[bufnum]);
233 BIO_gets(in, p, CONFBUFSIZE - 1);
234 p[CONFBUFSIZE - 1] = '\0';
236 if (i == 0 && !again) {
237 /* the currently processed BIO is at EOF */
240 #ifndef OPENSSL_NO_POSIX_IO
241 /* continue processing with the next file from directory */
242 if (dirctx != NULL) {
245 if ((next = get_next_file(dirpath, &dirctx)) != NULL) {
250 OPENSSL_free(dirpath);
255 /* no more files in directory, continue with processing parent */
256 if ((parent = sk_BIO_pop(biosk)) == NULL) {
257 /* everything processed get out of the loop */
267 if ((p[i - 1] != '\r') && (p[i - 1] != '\n'))
273 * we removed some trailing stuff so there is a new line on the end.
276 again = 1; /* long line */
279 eline++; /* another input line */
282 /* we now have a line with trailing \r\n removed */
284 /* i is the number of bytes */
288 /* check for line continuation */
291 * If we have bytes and the last char '\\' and second last char
294 p = &(buff->data[bufnum - 1]);
295 if (IS_ESC(conf, p[0]) && ((bufnum <= 1) || !IS_ESC(conf, p[-1]))) {
305 clear_comments(conf, buf);
306 s = eat_ws(conf, buf);
307 if (IS_EOF(conf, *s))
308 continue; /* blank line */
313 start = eat_ws(conf, s);
316 end = eat_alpha_numeric(conf, ss);
317 p = eat_ws(conf, end);
319 if (*p != '\0' && ss != p) {
323 CONFerr(CONF_F_DEF_LOAD_BIO,
324 CONF_R_MISSING_CLOSE_SQUARE_BRACKET);
328 if (!str_copy(conf, NULL, §ion, start))
330 if ((sv = _CONF_get_section(conf, section)) == NULL)
331 sv = _CONF_new_section(conf, section);
333 CONFerr(CONF_F_DEF_LOAD_BIO,
334 CONF_R_UNABLE_TO_CREATE_NEW_SECTION);
340 end = eat_alpha_numeric(conf, s);
341 if ((end[0] == ':') && (end[1] == ':')) {
346 end = eat_alpha_numeric(conf, end);
350 p = eat_ws(conf, end);
351 if (strncmp(pname, ".include", 8) == 0
352 && (p != pname + 8 || *p == '=')) {
353 char *include = NULL;
361 if (!str_copy(conf, psection, &include, p))
363 /* get the BIO of the included file */
364 #ifndef OPENSSL_NO_POSIX_IO
365 next = process_include(include, &dirctx, &dirpath);
366 if (include != dirpath) {
367 /* dirpath will contain include in case of a directory */
368 OPENSSL_free(include);
371 next = BIO_new_file(include, "r");
372 OPENSSL_free(include);
375 /* push the currently processing BIO onto stack */
377 if ((biosk = sk_BIO_new_null()) == NULL) {
378 CONFerr(CONF_F_DEF_LOAD_BIO, ERR_R_MALLOC_FAILURE);
383 if (!sk_BIO_push(biosk, in)) {
384 CONFerr(CONF_F_DEF_LOAD_BIO, ERR_R_MALLOC_FAILURE);
388 /* continue with reading from the included BIO */
392 } else if (*p != '=') {
393 CONFerr(CONF_F_DEF_LOAD_BIO, CONF_R_MISSING_EQUAL_SIGN);
398 start = eat_ws(conf, p);
399 trim_ws(conf, start);
401 if ((v = OPENSSL_malloc(sizeof(*v))) == NULL) {
402 CONFerr(CONF_F_DEF_LOAD_BIO, ERR_R_MALLOC_FAILURE);
405 v->name = OPENSSL_strdup(pname);
407 if (v->name == NULL) {
408 CONFerr(CONF_F_DEF_LOAD_BIO, ERR_R_MALLOC_FAILURE);
411 if (!str_copy(conf, psection, &(v->value), start))
414 if (strcmp(psection, section) != 0) {
415 if ((tv = _CONF_get_section(conf, psection))
417 tv = _CONF_new_section(conf, psection);
419 CONFerr(CONF_F_DEF_LOAD_BIO,
420 CONF_R_UNABLE_TO_CREATE_NEW_SECTION);
425 if (_CONF_add_string(conf, tv, v) == 0) {
426 CONFerr(CONF_F_DEF_LOAD_BIO, ERR_R_MALLOC_FAILURE);
433 OPENSSL_free(section);
435 * No need to pop, since we only get here if the stack is empty.
436 * If this causes a BIO leak, THE ISSUE IS SOMEWHERE ELSE!
442 OPENSSL_free(section);
444 * Since |in| is the first element of the stack and should NOT be freed
445 * here, we cannot use sk_BIO_pop_free(). Instead, we pop and free one
446 * BIO at a time, making sure that the last one popped isn't.
448 while (sk_BIO_num(biosk) > 0) {
449 BIO *popped = sk_BIO_pop(biosk);
454 #ifndef OPENSSL_NO_POSIX_IO
455 OPENSSL_free(dirpath);
457 OPENSSL_DIR_end(&dirctx);
461 BIO_snprintf(btmp, sizeof(btmp), "%ld", eline);
462 ERR_add_error_data(2, "line ", btmp);
463 if (h != conf->data) {
464 CONF_free(conf->data);
468 OPENSSL_free(v->name);
469 OPENSSL_free(v->value);
475 static void clear_comments(CONF *conf, char *p)
478 if (IS_FCOMMENT(conf, *p)) {
482 if (!IS_WS(conf, *p)) {
489 if (IS_COMMENT(conf, *p)) {
493 if (IS_DQUOTE(conf, *p)) {
494 p = scan_dquote(conf, p);
497 if (IS_QUOTE(conf, *p)) {
498 p = scan_quote(conf, p);
501 if (IS_ESC(conf, *p)) {
502 p = scan_esc(conf, p);
505 if (IS_EOF(conf, *p))
512 static int str_copy(CONF *conf, char *section, char **pto, char *from)
514 int q, r, rr = 0, to = 0, len = 0;
515 char *s, *e, *rp, *p, *rrp, *np, *cp, v;
518 if ((buf = BUF_MEM_new()) == NULL)
521 len = strlen(from) + 1;
522 if (!BUF_MEM_grow(buf, len))
526 if (IS_QUOTE(conf, *from)) {
529 while (!IS_EOF(conf, *from) && (*from != q)) {
530 if (IS_ESC(conf, *from)) {
532 if (IS_EOF(conf, *from))
535 buf->data[to++] = *(from++);
539 } else if (IS_DQUOTE(conf, *from)) {
542 while (!IS_EOF(conf, *from)) {
544 if (*(from + 1) == q) {
550 buf->data[to++] = *(from++);
554 } else if (IS_ESC(conf, *from)) {
568 } else if (IS_EOF(conf, *from))
570 else if (*from == '$') {
573 /* try to expand it */
587 while (IS_ALNUM(conf, *e))
589 if ((e[0] == ':') && (e[1] == ':')) {
596 while (IS_ALNUM(conf, *e))
604 CONFerr(CONF_F_STR_COPY, CONF_R_NO_CLOSE_BRACE);
610 * So at this point we have
611 * np which is the start of the name string which is
613 * cp which is the start of the section string which is
615 * e is the 'next point after'.
616 * r and rr are the chars replaced by the '\0'
617 * rp and rrp is where 'r' and 'rr' came from.
619 p = _CONF_get_string(conf, cp, np);
624 CONFerr(CONF_F_STR_COPY, CONF_R_VARIABLE_HAS_NO_VALUE);
627 newsize = strlen(p) + buf->length - (e - from);
628 if (newsize > MAX_CONF_VALUE_LENGTH) {
629 CONFerr(CONF_F_STR_COPY, CONF_R_VARIABLE_EXPANSION_TOO_LONG);
632 if (!BUF_MEM_grow_clean(buf, newsize)) {
633 CONFerr(CONF_F_STR_COPY, ERR_R_MALLOC_FAILURE);
637 buf->data[to++] = *(p++);
640 * Since we change the pointer 'from', we also have to change the
641 * perceived length of the string it points at. /RL
647 * In case there were no braces or parenthesis around the
648 * variable reference, we have to put back the character that was
649 * replaced with a '\0'. /RL
653 buf->data[to++] = *(from++);
655 buf->data[to] = '\0';
665 #ifndef OPENSSL_NO_POSIX_IO
667 * Check whether included path is a directory.
668 * Returns next BIO to process and in case of a directory
669 * also an opened directory context and the include path.
671 static BIO *process_include(char *include, OPENSSL_DIR_CTX **dirctx,
674 struct stat st = { 0 };
677 if (stat(include, &st) < 0) {
678 SYSerr(SYS_F_STAT, errno);
679 ERR_add_error_data(1, include);
680 /* missing include file is not fatal error */
684 if (S_ISDIR(st.st_mode)) {
685 if (*dirctx != NULL) {
686 CONFerr(CONF_F_PROCESS_INCLUDE,
687 CONF_R_RECURSIVE_DIRECTORY_INCLUDE);
688 ERR_add_error_data(1, include);
691 /* a directory, load its contents */
692 if ((next = get_next_file(include, dirctx)) != NULL)
697 next = BIO_new_file(include, "r");
702 * Get next file from the directory path.
703 * Returns BIO of the next file to read and updates dirctx.
705 static BIO *get_next_file(const char *path, OPENSSL_DIR_CTX **dirctx)
707 const char *filename;
710 pathlen = strlen(path);
711 while ((filename = OPENSSL_DIR_read(dirctx, path)) != NULL) {
714 namelen = strlen(filename);
717 if ((namelen > 5 && strcasecmp(filename + namelen - 5, ".conf") == 0)
718 || (namelen > 4 && strcasecmp(filename + namelen - 4, ".cnf") == 0)) {
723 newlen = pathlen + namelen + 2;
724 newpath = OPENSSL_zalloc(newlen);
725 if (newpath == NULL) {
726 CONFerr(CONF_F_GET_NEXT_FILE, ERR_R_MALLOC_FAILURE);
729 #ifdef OPENSSL_SYS_VMS
731 * If the given path isn't clear VMS syntax,
732 * we treat it as on Unix.
734 if (path[pathlen - 1] == ']'
735 || path[pathlen - 1] == '>'
736 || path[pathlen - 1] == ':') {
737 /* Clear VMS directory syntax, just copy as is */
738 OPENSSL_strlcpy(newpath, path, newlen);
741 if (newpath[0] == '\0') {
742 OPENSSL_strlcpy(newpath, path, newlen);
743 OPENSSL_strlcat(newpath, "/", newlen);
745 OPENSSL_strlcat(newpath, filename, newlen);
747 bio = BIO_new_file(newpath, "r");
748 OPENSSL_free(newpath);
749 /* Errors when opening files are non-fatal. */
754 OPENSSL_DIR_end(dirctx);
760 static int is_keytype(const CONF *conf, char c, unsigned short type)
762 const unsigned short * keytypes = (const unsigned short *) conf->meth_data;
763 unsigned char key = (unsigned char)c;
765 #ifdef CHARSET_EBCDIC
768 /* key is out of range for os_toascii table */
772 /* convert key from ebcdic to ascii */
773 key = os_toascii[key];
777 /* key is not a seven bit ascii character */
781 return (keytypes[key] & type) ? 1 : 0;
784 static char *eat_ws(CONF *conf, char *p)
786 while (IS_WS(conf, *p) && (!IS_EOF(conf, *p)))
791 static void trim_ws(CONF *conf, char *start)
795 while (!IS_EOF(conf, *p))
798 while ((p >= start) && IS_WS(conf, *p))
804 static char *eat_alpha_numeric(CONF *conf, char *p)
807 if (IS_ESC(conf, *p)) {
808 p = scan_esc(conf, p);
811 if (!IS_ALNUM_PUNCT(conf, *p))
817 static char *scan_quote(CONF *conf, char *p)
822 while (!(IS_EOF(conf, *p)) && (*p != q)) {
823 if (IS_ESC(conf, *p)) {
825 if (IS_EOF(conf, *p))
835 static char *scan_dquote(CONF *conf, char *p)
840 while (!(IS_EOF(conf, *p))) {
855 static void dump_value_doall_arg(const CONF_VALUE *a, BIO *out)
858 BIO_printf(out, "[%s] %s=%s\n", a->section, a->name, a->value);
860 BIO_printf(out, "[[%s]]\n", a->section);
863 IMPLEMENT_LHASH_DOALL_ARG_CONST(CONF_VALUE, BIO);
865 static int def_dump(const CONF *conf, BIO *out)
867 lh_CONF_VALUE_doall_BIO(conf->data, dump_value_doall_arg, out);
871 static int def_is_number(const CONF *conf, char c)
873 return IS_NUMBER(conf, c);
876 static int def_to_int(const CONF *conf, char c)