2 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
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
10 /* Part of the code in here was originally in conf.c, which is now removed */
14 #include "internal/e_os.h" /* struct stat */
16 # include <sys/types.h> /* needed for stat.h */
17 # include <sys/stat.h> /* struct stat */
19 #include "internal/cryptlib.h"
20 #include "internal/o_dir.h"
21 #include <openssl/lhash.h>
22 #include <openssl/conf.h>
23 #include <openssl/conf_api.h>
24 #include "conf_local.h"
26 #include <openssl/buffer.h>
27 #include <openssl/err.h>
28 #ifndef OPENSSL_NO_POSIX_IO
29 # include <sys/stat.h>
36 # define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
40 * The maximum length we can grow a value to after variable expansion. 64k
41 * should be more than enough for all reasonable uses.
43 #define MAX_CONF_VALUE_LENGTH 65536
45 static int is_keytype(const CONF
*conf
, char c
, unsigned short type
);
46 static char *eat_ws(CONF
*conf
, char *p
);
47 static void trim_ws(CONF
*conf
, char *start
);
48 static char *eat_alpha_numeric(CONF
*conf
, char *p
);
49 static void clear_comments(CONF
*conf
, char *p
);
50 static int str_copy(CONF
*conf
, char *section
, char **to
, char *from
);
51 static char *scan_quote(CONF
*conf
, char *p
);
52 static char *scan_dquote(CONF
*conf
, char *p
);
53 #define scan_esc(conf,p) (((IS_EOF((conf),(p)[1]))?((p)+1):((p)+2)))
54 #ifndef OPENSSL_NO_POSIX_IO
55 static BIO
*process_include(char *include
, OPENSSL_DIR_CTX
**dirctx
,
57 static BIO
*get_next_file(const char *path
, OPENSSL_DIR_CTX
**dirctx
);
60 static CONF
*def_create(CONF_METHOD
*meth
);
61 static int def_init_default(CONF
*conf
);
62 #ifndef OPENSSL_NO_DEPRECATED_3_0
63 static int def_init_WIN32(CONF
*conf
);
65 static int def_destroy(CONF
*conf
);
66 static int def_destroy_data(CONF
*conf
);
67 static int def_load(CONF
*conf
, const char *name
, long *eline
);
68 static int def_load_bio(CONF
*conf
, BIO
*bp
, long *eline
);
69 static int def_dump(const CONF
*conf
, BIO
*bp
);
70 static int def_is_number(const CONF
*conf
, char c
);
71 static int def_to_int(const CONF
*conf
, char c
);
73 static CONF_METHOD default_method
= {
86 CONF_METHOD
*NCONF_default(void)
88 return &default_method
;
91 #ifndef OPENSSL_NO_DEPRECATED_3_0
92 static CONF_METHOD WIN32_method
= {
105 CONF_METHOD
*NCONF_WIN32(void)
107 return &WIN32_method
;
111 static CONF
*def_create(CONF_METHOD
*meth
)
115 ret
= OPENSSL_malloc(sizeof(*ret
));
117 if (meth
->init(ret
) == 0) {
124 static int def_init_default(CONF
*conf
)
129 memset(conf
, 0, sizeof(*conf
));
130 conf
->meth
= &default_method
;
131 conf
->meth_data
= (void *)CONF_type_default
;
136 #ifndef OPENSSL_NO_DEPRECATED_3_0
137 static int def_init_WIN32(CONF
*conf
)
142 memset(conf
, 0, sizeof(*conf
));
143 conf
->meth
= &WIN32_method
;
144 conf
->meth_data
= (void *)CONF_type_win32
;
150 static int def_destroy(CONF
*conf
)
152 if (def_destroy_data(conf
)) {
159 static int def_destroy_data(CONF
*conf
)
163 _CONF_free_data(conf
);
167 static int def_load(CONF
*conf
, const char *name
, long *line
)
172 #ifdef OPENSSL_SYS_VMS
173 in
= BIO_new_file(name
, "r");
175 in
= BIO_new_file(name
, "rb");
178 if (ERR_GET_REASON(ERR_peek_last_error()) == BIO_R_NO_SUCH_FILE
)
179 ERR_raise(ERR_LIB_CONF
, CONF_R_NO_SUCH_FILE
);
181 ERR_raise(ERR_LIB_CONF
, ERR_R_SYS_LIB
);
185 ret
= def_load_bio(conf
, in
, line
);
192 /* Parse a boolean value and fill in *flag. Return 0 on error. */
193 static int parsebool(const char *pval
, int *flag
)
195 if (OPENSSL_strcasecmp(pval
, "on") == 0
196 || OPENSSL_strcasecmp(pval
, "true") == 0) {
198 } else if (OPENSSL_strcasecmp(pval
, "off") == 0
199 || OPENSSL_strcasecmp(pval
, "false") == 0) {
202 ERR_raise(ERR_LIB_CONF
, CONF_R_INVALID_PRAGMA
);
208 static int def_load_bio(CONF
*conf
, BIO
*in
, long *line
)
210 /* The macro BUFSIZE conflicts with a system macro in VxWorks */
211 #define CONFBUFSIZE 512
212 int bufnum
= 0, i
, ii
;
213 BUF_MEM
*buff
= NULL
;
218 char btmp
[DECIMAL_SIZE(eline
) + 1];
219 CONF_VALUE
*v
= NULL
, *tv
;
220 CONF_VALUE
*sv
= NULL
;
221 char *section
= NULL
, *buf
;
222 char *start
, *psection
, *pname
;
223 void *h
= (void *)(conf
->data
);
224 STACK_OF(BIO
) *biosk
= NULL
;
225 #ifndef OPENSSL_NO_POSIX_IO
226 char *dirpath
= NULL
;
227 OPENSSL_DIR_CTX
*dirctx
= NULL
;
229 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
233 if ((buff
= BUF_MEM_new()) == NULL
) {
234 ERR_raise(ERR_LIB_CONF
, ERR_R_BUF_LIB
);
238 section
= OPENSSL_strdup("default");
242 if (_CONF_new_data(conf
) == 0) {
243 ERR_raise(ERR_LIB_CONF
, ERR_R_CONF_LIB
);
247 sv
= _CONF_new_section(conf
, section
);
249 ERR_raise(ERR_LIB_CONF
, CONF_R_UNABLE_TO_CREATE_NEW_SECTION
);
256 if (!BUF_MEM_grow(buff
, bufnum
+ CONFBUFSIZE
)) {
257 ERR_raise(ERR_LIB_CONF
, ERR_R_BUF_LIB
);
260 p
= &(buff
->data
[bufnum
]);
263 if (in
!= NULL
&& BIO_gets(in
, p
, CONFBUFSIZE
- 1) < 0)
265 p
[CONFBUFSIZE
- 1] = '\0';
268 /* Other BOMs imply unsupported multibyte encoding,
269 * so don't strip them and let the error raise */
270 const unsigned char utf8_bom
[3] = {0xEF, 0xBB, 0xBF};
272 if (i
>= 3 && memcmp(p
, utf8_bom
, 3) == 0) {
273 memmove(p
, p
+ 3, i
- 3);
280 if (i
== 0 && !again
) {
281 /* the currently processed BIO is NULL or at EOF */
284 #ifndef OPENSSL_NO_POSIX_IO
285 /* continue processing with the next file from directory */
286 if (dirctx
!= NULL
) {
289 if ((next
= get_next_file(dirpath
, &dirctx
)) != NULL
) {
294 OPENSSL_free(dirpath
);
299 /* no more files in directory, continue with processing parent */
300 if ((parent
= sk_BIO_pop(biosk
)) == NULL
) {
301 /* everything processed get out of the loop */
311 if ((p
[i
- 1] != '\r') && (p
[i
- 1] != '\n'))
317 * we removed some trailing stuff so there is a new line on the end.
320 again
= 1; /* long line */
323 eline
++; /* another input line */
326 /* we now have a line with trailing \r\n removed */
328 /* i is the number of bytes */
332 /* check for line continuation */
335 * If we have bytes and the last char '\\' and second last char
338 p
= &(buff
->data
[bufnum
- 1]);
339 if (IS_ESC(conf
, p
[0]) && ((bufnum
<= 1) || !IS_ESC(conf
, p
[-1]))) {
349 clear_comments(conf
, buf
);
350 s
= eat_ws(conf
, buf
);
351 if (IS_EOF(conf
, *s
))
352 continue; /* blank line */
357 start
= eat_ws(conf
, s
);
360 end
= eat_alpha_numeric(conf
, ss
);
361 p
= eat_ws(conf
, end
);
363 if (*p
!= '\0' && ss
!= p
) {
367 ERR_raise(ERR_LIB_CONF
, CONF_R_MISSING_CLOSE_SQUARE_BRACKET
);
371 if (!str_copy(conf
, NULL
, §ion
, start
))
373 if ((sv
= _CONF_get_section(conf
, section
)) == NULL
)
374 sv
= _CONF_new_section(conf
, section
);
376 ERR_raise(ERR_LIB_CONF
, CONF_R_UNABLE_TO_CREATE_NEW_SECTION
);
382 end
= eat_alpha_numeric(conf
, s
);
383 if ((end
[0] == ':') && (end
[1] == ':')) {
388 end
= eat_alpha_numeric(conf
, end
);
392 p
= eat_ws(conf
, end
);
393 if (CHECK_AND_SKIP_PREFIX(pname
, ".pragma")
394 && (p
!= pname
|| *p
== '=')) {
403 /* Pragma values take the form keyword:value */
404 pval
= strchr(p
, ':');
405 if (pval
== NULL
|| pval
== p
|| pval
[1] == '\0') {
406 ERR_raise(ERR_LIB_CONF
, CONF_R_INVALID_PRAGMA
);
412 pval
= eat_ws(conf
, pval
);
417 * dollarid takes "on", "true or "off", "false"
418 * abspath takes "on", "true or "off", "false"
419 * includedir directory prefix
421 if (strcmp(p
, "dollarid") == 0) {
422 if (!parsebool(pval
, &conf
->flag_dollarid
))
424 } else if (strcmp(p
, "abspath") == 0) {
425 if (!parsebool(pval
, &conf
->flag_abspath
))
427 } else if (strcmp(p
, "includedir") == 0) {
428 OPENSSL_free(conf
->includedir
);
429 if ((conf
->includedir
= OPENSSL_strdup(pval
)) == NULL
)
434 * We *ignore* any unknown pragma.
437 } else if (CHECK_AND_SKIP_PREFIX(pname
, ".include")
438 && (p
!= pname
|| *p
== '=')) {
439 char *include
= NULL
;
441 const char *include_dir
= ossl_safe_getenv("OPENSSL_CONF_INCLUDE");
442 char *include_path
= NULL
;
444 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
446 * The include processing below can cause the "conf" fuzzer to
447 * timeout due to the fuzzer inserting large and complicated
448 * includes - with a large amount of time spent in
449 * OPENSSL_strlcat/OPENSSL_strcpy. This is not a security
450 * concern because config files should never come from untrusted
451 * sources. We just set an arbitrary limit on the allowed
452 * number of includes when fuzzing to prevent this timeout.
454 if (numincludes
++ > 10)
458 if (include_dir
== NULL
)
459 include_dir
= conf
->includedir
;
466 if (!str_copy(conf
, psection
, &include
, p
))
469 if (include_dir
!= NULL
&& !ossl_is_absolute_path(include
)) {
470 size_t newlen
= strlen(include_dir
) + strlen(include
) + 2;
472 include_path
= OPENSSL_malloc(newlen
);
473 if (include_path
== NULL
) {
474 OPENSSL_free(include
);
478 OPENSSL_strlcpy(include_path
, include_dir
, newlen
);
479 if (!ossl_ends_with_dirsep(include_path
))
480 OPENSSL_strlcat(include_path
, "/", newlen
);
481 OPENSSL_strlcat(include_path
, include
, newlen
);
482 OPENSSL_free(include
);
484 include_path
= include
;
487 if (conf
->flag_abspath
488 && !ossl_is_absolute_path(include_path
)) {
489 ERR_raise(ERR_LIB_CONF
, CONF_R_RELATIVE_PATH
);
490 OPENSSL_free(include_path
);
494 /* get the BIO of the included file */
495 #ifndef OPENSSL_NO_POSIX_IO
496 next
= process_include(include_path
, &dirctx
, &dirpath
);
497 if (include_path
!= dirpath
) {
498 /* dirpath will contain include in case of a directory */
499 OPENSSL_free(include_path
);
502 next
= BIO_new_file(include_path
, "r");
503 OPENSSL_free(include_path
);
507 /* push the currently processing BIO onto stack */
509 if ((biosk
= sk_BIO_new_null()) == NULL
) {
510 ERR_raise(ERR_LIB_CONF
, ERR_R_CRYPTO_LIB
);
515 if (!sk_BIO_push(biosk
, in
)) {
516 ERR_raise(ERR_LIB_CONF
, ERR_R_CRYPTO_LIB
);
520 /* continue with reading from the included BIO */
524 } else if (*p
!= '=') {
525 ERR_raise_data(ERR_LIB_CONF
, CONF_R_MISSING_EQUAL_SIGN
,
531 start
= eat_ws(conf
, p
);
532 trim_ws(conf
, start
);
534 if ((v
= OPENSSL_malloc(sizeof(*v
))) == NULL
)
536 v
->name
= OPENSSL_strdup(pname
);
540 if (!str_copy(conf
, psection
, &(v
->value
), start
))
543 if (strcmp(psection
, section
) != 0) {
544 if ((tv
= _CONF_get_section(conf
, psection
))
546 tv
= _CONF_new_section(conf
, psection
);
548 ERR_raise(ERR_LIB_CONF
,
549 CONF_R_UNABLE_TO_CREATE_NEW_SECTION
);
554 if (_CONF_add_string(conf
, tv
, v
) == 0) {
555 ERR_raise(ERR_LIB_CONF
, ERR_R_CONF_LIB
);
562 OPENSSL_free(section
);
564 * No need to pop, since we only get here if the stack is empty.
565 * If this causes a BIO leak, THE ISSUE IS SOMEWHERE ELSE!
572 OPENSSL_free(section
);
574 * Since |in| is the first element of the stack and should NOT be freed
575 * here, we cannot use sk_BIO_pop_free(). Instead, we pop and free one
576 * BIO at a time, making sure that the last one popped isn't.
578 while (sk_BIO_num(biosk
) > 0) {
579 BIO
*popped
= sk_BIO_pop(biosk
);
584 #ifndef OPENSSL_NO_POSIX_IO
585 OPENSSL_free(dirpath
);
587 OPENSSL_DIR_end(&dirctx
);
591 BIO_snprintf(btmp
, sizeof(btmp
), "%ld", eline
);
592 ERR_add_error_data(2, "line ", btmp
);
593 if (h
!= conf
->data
) {
594 CONF_free(conf
->data
);
598 OPENSSL_free(v
->name
);
599 OPENSSL_free(v
->value
);
605 static void clear_comments(CONF
*conf
, char *p
)
608 if (IS_FCOMMENT(conf
, *p
)) {
612 if (!IS_WS(conf
, *p
)) {
619 if (IS_COMMENT(conf
, *p
)) {
623 if (IS_DQUOTE(conf
, *p
)) {
624 p
= scan_dquote(conf
, p
);
627 if (IS_QUOTE(conf
, *p
)) {
628 p
= scan_quote(conf
, p
);
631 if (IS_ESC(conf
, *p
)) {
632 p
= scan_esc(conf
, p
);
635 if (IS_EOF(conf
, *p
))
642 static int str_copy(CONF
*conf
, char *section
, char **pto
, char *from
)
644 int q
, r
, rr
= 0, to
= 0, len
= 0;
645 char *s
, *e
, *rp
, *p
, *rrp
, *np
, *cp
, v
;
648 if ((buf
= BUF_MEM_new()) == NULL
)
651 len
= strlen(from
) + 1;
652 if (!BUF_MEM_grow(buf
, len
))
656 if (IS_QUOTE(conf
, *from
)) {
659 while (!IS_EOF(conf
, *from
) && (*from
!= q
)) {
660 if (IS_ESC(conf
, *from
)) {
662 if (IS_EOF(conf
, *from
))
665 buf
->data
[to
++] = *(from
++);
669 } else if (IS_DQUOTE(conf
, *from
)) {
672 while (!IS_EOF(conf
, *from
)) {
674 if (*(from
+ 1) == q
) {
680 buf
->data
[to
++] = *(from
++);
684 } else if (IS_ESC(conf
, *from
)) {
698 } else if (IS_EOF(conf
, *from
))
700 else if (*from
== '$'
701 && (!conf
->flag_dollarid
703 || from
[1] == '(')) {
706 /* try to expand it */
720 while (IS_ALNUM(conf
, *e
)
721 || (conf
->flag_dollarid
&& IS_DOLLAR(conf
, *e
)))
723 if ((e
[0] == ':') && (e
[1] == ':')) {
730 while (IS_ALNUM(conf
, *e
)
731 || (conf
->flag_dollarid
&& IS_DOLLAR(conf
, *e
)))
739 ERR_raise(ERR_LIB_CONF
, CONF_R_NO_CLOSE_BRACE
);
745 * So at this point we have
746 * np which is the start of the name string which is
748 * cp which is the start of the section string which is
750 * e is the 'next point after'.
751 * r and rr are the chars replaced by the '\0'
752 * rp and rrp is where 'r' and 'rr' came from.
754 p
= _CONF_get_string(conf
, cp
, np
);
759 ERR_raise(ERR_LIB_CONF
, CONF_R_VARIABLE_HAS_NO_VALUE
);
762 newsize
= strlen(p
) + buf
->length
- (e
- from
);
763 if (newsize
> MAX_CONF_VALUE_LENGTH
) {
764 ERR_raise(ERR_LIB_CONF
, CONF_R_VARIABLE_EXPANSION_TOO_LONG
);
767 if (!BUF_MEM_grow_clean(buf
, newsize
)) {
768 ERR_raise(ERR_LIB_CONF
, ERR_R_BUF_LIB
);
772 buf
->data
[to
++] = *(p
++);
775 * Since we change the pointer 'from', we also have to change the
776 * perceived length of the string it points at. /RL
782 * In case there were no braces or parenthesis around the
783 * variable reference, we have to put back the character that was
784 * replaced with a '\0'. /RL
788 buf
->data
[to
++] = *(from
++);
790 buf
->data
[to
] = '\0';
800 #ifndef OPENSSL_NO_POSIX_IO
802 * Check whether included path is a directory.
803 * Returns next BIO to process and in case of a directory
804 * also an opened directory context and the include path.
806 static BIO
*process_include(char *include
, OPENSSL_DIR_CTX
**dirctx
,
812 if (stat(include
, &st
) < 0) {
813 ERR_raise_data(ERR_LIB_SYS
, errno
, "calling stat(%s)", include
);
814 /* missing include file is not fatal error */
818 if (S_ISDIR(st
.st_mode
)) {
819 if (*dirctx
!= NULL
) {
820 ERR_raise_data(ERR_LIB_CONF
, CONF_R_RECURSIVE_DIRECTORY_INCLUDE
,
824 /* a directory, load its contents */
825 if ((next
= get_next_file(include
, dirctx
)) != NULL
)
830 next
= BIO_new_file(include
, "r");
835 * Get next file from the directory path.
836 * Returns BIO of the next file to read and updates dirctx.
838 static BIO
*get_next_file(const char *path
, OPENSSL_DIR_CTX
**dirctx
)
840 const char *filename
;
843 pathlen
= strlen(path
);
844 while ((filename
= OPENSSL_DIR_read(dirctx
, path
)) != NULL
) {
847 namelen
= strlen(filename
);
851 && OPENSSL_strcasecmp(filename
+ namelen
- 5, ".conf") == 0)
853 && OPENSSL_strcasecmp(filename
+ namelen
- 4, ".cnf") == 0)) {
858 newlen
= pathlen
+ namelen
+ 2;
859 newpath
= OPENSSL_zalloc(newlen
);
862 #ifdef OPENSSL_SYS_VMS
864 * If the given path isn't clear VMS syntax,
865 * we treat it as on Unix.
867 if (path
[pathlen
- 1] == ']'
868 || path
[pathlen
- 1] == '>'
869 || path
[pathlen
- 1] == ':') {
870 /* Clear VMS directory syntax, just copy as is */
871 OPENSSL_strlcpy(newpath
, path
, newlen
);
874 if (newpath
[0] == '\0') {
875 OPENSSL_strlcpy(newpath
, path
, newlen
);
876 OPENSSL_strlcat(newpath
, "/", newlen
);
878 OPENSSL_strlcat(newpath
, filename
, newlen
);
880 bio
= BIO_new_file(newpath
, "r");
881 OPENSSL_free(newpath
);
882 /* Errors when opening files are non-fatal. */
887 OPENSSL_DIR_end(dirctx
);
893 static int is_keytype(const CONF
*conf
, char c
, unsigned short type
)
895 const unsigned short * keytypes
= (const unsigned short *) conf
->meth_data
;
896 unsigned char key
= (unsigned char)c
;
898 #ifdef CHARSET_EBCDIC
901 /* key is out of range for os_toascii table */
905 /* convert key from ebcdic to ascii */
906 key
= os_toascii
[key
];
910 /* key is not a seven bit ascii character */
914 return (keytypes
[key
] & type
) ? 1 : 0;
917 static char *eat_ws(CONF
*conf
, char *p
)
919 while (IS_WS(conf
, *p
) && (!IS_EOF(conf
, *p
)))
924 static void trim_ws(CONF
*conf
, char *start
)
928 while (!IS_EOF(conf
, *p
))
931 while ((p
>= start
) && IS_WS(conf
, *p
))
937 static char *eat_alpha_numeric(CONF
*conf
, char *p
)
940 if (IS_ESC(conf
, *p
)) {
941 p
= scan_esc(conf
, p
);
944 if (!(IS_ALNUM_PUNCT(conf
, *p
)
945 || (conf
->flag_dollarid
&& IS_DOLLAR(conf
, *p
))))
951 static char *scan_quote(CONF
*conf
, char *p
)
956 while (!(IS_EOF(conf
, *p
)) && (*p
!= q
)) {
957 if (IS_ESC(conf
, *p
)) {
959 if (IS_EOF(conf
, *p
))
969 static char *scan_dquote(CONF
*conf
, char *p
)
974 while (!(IS_EOF(conf
, *p
))) {
989 static void dump_value_doall_arg(const CONF_VALUE
*a
, BIO
*out
)
992 BIO_printf(out
, "[%s] %s=%s\n", a
->section
, a
->name
, a
->value
);
994 BIO_printf(out
, "[[%s]]\n", a
->section
);
997 IMPLEMENT_LHASH_DOALL_ARG_CONST(CONF_VALUE
, BIO
);
999 static int def_dump(const CONF
*conf
, BIO
*out
)
1001 lh_CONF_VALUE_doall_BIO(conf
->data
, dump_value_doall_arg
, out
);
1005 static int def_is_number(const CONF
*conf
, char c
)
1007 return IS_NUMBER(conf
, c
);
1010 static int def_to_int(const CONF
*conf
, char c
)