include/openssl/conf.h

0001 /*
0002  * WARNING: do not edit!
0003  * Generated by Makefile from include/openssl/conf.h.in
0004  *
0005  * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
0006  *
0007  * Licensed under the Apache License 2.0 (the "License").  You may not use
0008  * this file except in compliance with the License.  You can obtain a copy
0009  * in the file LICENSE in the source distribution or at
0010  * https://www.openssl.org/source/license.html
0011  */
0012
0013 /* clang-format off */
0014
0015 /* clang-format on */
0016
0017 #ifndef OPENSSL_CONF_H
0018 #define OPENSSL_CONF_H
0019 #pragma once
0020
0021 #include <openssl/macros.h>
0022 #ifndef OPENSSL_NO_DEPRECATED_3_0
0023 #define HEADER_CONF_H
0024 #endif
0025
0026 #include <openssl/bio.h>
0027 #include <openssl/lhash.h>
0028 #include <openssl/safestack.h>
0029 #include <openssl/e_os2.h>
0030 #include <openssl/types.h>
0031 #include <openssl/conferr.h>
0032 #ifndef OPENSSL_NO_STDIO
0033 #include <stdio.h>
0034 #endif
0035
0036 #ifdef __cplusplus
0037 extern "C" {
0038 #endif
0039
0040 typedef struct {
0041     char *section;
0042     char *name;
0043     char *value;
0044 } CONF_VALUE;
0045
0046 /* clang-format off */
0047 SKM_DEFINE_STACK_OF_INTERNAL(CONF_VALUE, CONF_VALUE, CONF_VALUE)
0048 #define sk_CONF_VALUE_num(sk) OPENSSL_sk_num(ossl_check_const_CONF_VALUE_sk_type(sk))
0049 #define sk_CONF_VALUE_value(sk, idx) ((CONF_VALUE *)OPENSSL_sk_value(ossl_check_const_CONF_VALUE_sk_type(sk), (idx)))
0050 #define sk_CONF_VALUE_new(cmp) ((STACK_OF(CONF_VALUE) *)OPENSSL_sk_new(ossl_check_CONF_VALUE_compfunc_type(cmp)))
0051 #define sk_CONF_VALUE_new_null() ((STACK_OF(CONF_VALUE) *)OPENSSL_sk_new_null())
0052 #define sk_CONF_VALUE_new_reserve(cmp, n) ((STACK_OF(CONF_VALUE) *)OPENSSL_sk_new_reserve(ossl_check_CONF_VALUE_compfunc_type(cmp), (n)))
0053 #define sk_CONF_VALUE_reserve(sk, n) OPENSSL_sk_reserve(ossl_check_CONF_VALUE_sk_type(sk), (n))
0054 #define sk_CONF_VALUE_free(sk) OPENSSL_sk_free(ossl_check_CONF_VALUE_sk_type(sk))
0055 #define sk_CONF_VALUE_zero(sk) OPENSSL_sk_zero(ossl_check_CONF_VALUE_sk_type(sk))
0056 #define sk_CONF_VALUE_delete(sk, i) ((CONF_VALUE *)OPENSSL_sk_delete(ossl_check_CONF_VALUE_sk_type(sk), (i)))
0057 #define sk_CONF_VALUE_delete_ptr(sk, ptr) ((CONF_VALUE *)OPENSSL_sk_delete_ptr(ossl_check_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_type(ptr)))
0058 #define sk_CONF_VALUE_push(sk, ptr) OPENSSL_sk_push(ossl_check_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_type(ptr))
0059 #define sk_CONF_VALUE_unshift(sk, ptr) OPENSSL_sk_unshift(ossl_check_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_type(ptr))
0060 #define sk_CONF_VALUE_pop(sk) ((CONF_VALUE *)OPENSSL_sk_pop(ossl_check_CONF_VALUE_sk_type(sk)))
0061 #define sk_CONF_VALUE_shift(sk) ((CONF_VALUE *)OPENSSL_sk_shift(ossl_check_CONF_VALUE_sk_type(sk)))
0062 #define sk_CONF_VALUE_pop_free(sk, freefunc) OPENSSL_sk_pop_free(ossl_check_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_freefunc_type(freefunc))
0063 #define sk_CONF_VALUE_insert(sk, ptr, idx) OPENSSL_sk_insert(ossl_check_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_type(ptr), (idx))
0064 #define sk_CONF_VALUE_set(sk, idx, ptr) ((CONF_VALUE *)OPENSSL_sk_set(ossl_check_CONF_VALUE_sk_type(sk), (idx), ossl_check_CONF_VALUE_type(ptr)))
0065 #define sk_CONF_VALUE_find(sk, ptr) OPENSSL_sk_find(ossl_check_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_type(ptr))
0066 #define sk_CONF_VALUE_find_ex(sk, ptr) OPENSSL_sk_find_ex(ossl_check_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_type(ptr))
0067 #define sk_CONF_VALUE_find_all(sk, ptr, pnum) OPENSSL_sk_find_all(ossl_check_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_type(ptr), pnum)
0068 #define sk_CONF_VALUE_sort(sk) OPENSSL_sk_sort(ossl_check_CONF_VALUE_sk_type(sk))
0069 #define sk_CONF_VALUE_is_sorted(sk) OPENSSL_sk_is_sorted(ossl_check_const_CONF_VALUE_sk_type(sk))
0070 #define sk_CONF_VALUE_dup(sk) ((STACK_OF(CONF_VALUE) *)OPENSSL_sk_dup(ossl_check_const_CONF_VALUE_sk_type(sk)))
0071 #define sk_CONF_VALUE_deep_copy(sk, copyfunc, freefunc) ((STACK_OF(CONF_VALUE) *)OPENSSL_sk_deep_copy(ossl_check_const_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_copyfunc_type(copyfunc), ossl_check_CONF_VALUE_freefunc_type(freefunc)))
0072 #define sk_CONF_VALUE_set_cmp_func(sk, cmp) ((sk_CONF_VALUE_compfunc)OPENSSL_sk_set_cmp_func(ossl_check_CONF_VALUE_sk_type(sk), ossl_check_CONF_VALUE_compfunc_type(cmp)))
0073 DEFINE_LHASH_OF_INTERNAL(CONF_VALUE);
0074 #define lh_CONF_VALUE_new(hfn, cmp) ((LHASH_OF(CONF_VALUE) *)OPENSSL_LH_set_thunks(OPENSSL_LH_new(ossl_check_CONF_VALUE_lh_hashfunc_type(hfn), ossl_check_CONF_VALUE_lh_compfunc_type(cmp)), lh_CONF_VALUE_hash_thunk, lh_CONF_VALUE_comp_thunk, lh_CONF_VALUE_doall_thunk, lh_CONF_VALUE_doall_arg_thunk))
0075 #define lh_CONF_VALUE_free(lh) OPENSSL_LH_free(ossl_check_CONF_VALUE_lh_type(lh))
0076 #define lh_CONF_VALUE_flush(lh) OPENSSL_LH_flush(ossl_check_CONF_VALUE_lh_type(lh))
0077 #define lh_CONF_VALUE_insert(lh, ptr) ((CONF_VALUE *)OPENSSL_LH_insert(ossl_check_CONF_VALUE_lh_type(lh), ossl_check_CONF_VALUE_lh_plain_type(ptr)))
0078 #define lh_CONF_VALUE_delete(lh, ptr) ((CONF_VALUE *)OPENSSL_LH_delete(ossl_check_CONF_VALUE_lh_type(lh), ossl_check_const_CONF_VALUE_lh_plain_type(ptr)))
0079 #define lh_CONF_VALUE_retrieve(lh, ptr) ((CONF_VALUE *)OPENSSL_LH_retrieve(ossl_check_CONF_VALUE_lh_type(lh), ossl_check_const_CONF_VALUE_lh_plain_type(ptr)))
0080 #define lh_CONF_VALUE_error(lh) OPENSSL_LH_error(ossl_check_CONF_VALUE_lh_type(lh))
0081 #define lh_CONF_VALUE_num_items(lh) OPENSSL_LH_num_items(ossl_check_CONF_VALUE_lh_type(lh))
0082 #define lh_CONF_VALUE_node_stats_bio(lh, out) OPENSSL_LH_node_stats_bio(ossl_check_const_CONF_VALUE_lh_type(lh), out)
0083 #define lh_CONF_VALUE_node_usage_stats_bio(lh, out) OPENSSL_LH_node_usage_stats_bio(ossl_check_const_CONF_VALUE_lh_type(lh), out)
0084 #define lh_CONF_VALUE_stats_bio(lh, out) OPENSSL_LH_stats_bio(ossl_check_const_CONF_VALUE_lh_type(lh), out)
0085 #define lh_CONF_VALUE_get_down_load(lh) OPENSSL_LH_get_down_load(ossl_check_CONF_VALUE_lh_type(lh))
0086 #define lh_CONF_VALUE_set_down_load(lh, dl) OPENSSL_LH_set_down_load(ossl_check_CONF_VALUE_lh_type(lh), dl)
0087 #define lh_CONF_VALUE_doall(lh, dfn) OPENSSL_LH_doall(ossl_check_CONF_VALUE_lh_type(lh), ossl_check_CONF_VALUE_lh_doallfunc_type(dfn))
0088
0089 /* clang-format on */
0090
0091 struct conf_st;
0092 struct conf_method_st;
0093 typedef struct conf_method_st CONF_METHOD;
0094
0095 #ifndef OPENSSL_NO_DEPRECATED_3_0
0096 #include <openssl/conftypes.h>
0097 #endif
0098
0099 /* Module definitions */
0100 typedef struct conf_imodule_st CONF_IMODULE;
0101 typedef struct conf_module_st CONF_MODULE;
0102
0103 STACK_OF(CONF_MODULE);
0104 STACK_OF(CONF_IMODULE);
0105
0106 /* DSO module function typedefs */
0107 typedef int conf_init_func(CONF_IMODULE *md, const CONF *cnf);
0108 typedef void conf_finish_func(CONF_IMODULE *md);
0109
0110 #define CONF_MFLAGS_IGNORE_ERRORS 0x1
0111 #define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2
0112 #define CONF_MFLAGS_SILENT 0x4
0113 #define CONF_MFLAGS_NO_DSO 0x8
0114 #define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10
0115 #define CONF_MFLAGS_DEFAULT_SECTION 0x20
0116
0117 int CONF_set_default_method(CONF_METHOD *meth);
0118 void CONF_set_nconf(CONF *conf, LHASH_OF(CONF_VALUE) *hash);
0119 LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
0120     long *eline);
0121 #ifndef OPENSSL_NO_STDIO
0122 LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
0123     long *eline);
0124 #endif
0125 LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp,
0126     long *eline);
0127 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
0128     const char *section);
0129 char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
0130     const char *name);
0131 long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
0132     const char *name);
0133 void CONF_free(LHASH_OF(CONF_VALUE) *conf);
0134 #ifndef OPENSSL_NO_STDIO
0135 int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out);
0136 #endif
0137 int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out);
0138 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
0139 OSSL_DEPRECATEDIN_1_1_0 void OPENSSL_config(const char *config_name);
0140 #endif
0141
0142 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
0143 #define OPENSSL_no_config() \
0144     OPENSSL_init_crypto(OPENSSL_INIT_NO_LOAD_CONFIG, NULL)
0145 #endif
0146
0147 /*
0148  * New conf code.  The semantics are different from the functions above. If
0149  * that wasn't the case, the above functions would have been replaced
0150  */
0151
0152 CONF *NCONF_new_ex(OSSL_LIB_CTX *libctx, CONF_METHOD *meth);
0153 OSSL_LIB_CTX *NCONF_get0_libctx(const CONF *conf);
0154 CONF *NCONF_new(CONF_METHOD *meth);
0155 CONF_METHOD *NCONF_default(void);
0156 #ifndef OPENSSL_NO_DEPRECATED_3_0
0157 OSSL_DEPRECATEDIN_3_0 CONF_METHOD *NCONF_WIN32(void);
0158 #endif
0159 void NCONF_free(CONF *conf);
0160 void NCONF_free_data(CONF *conf);
0161
0162 int NCONF_load(CONF *conf, const char *file, long *eline);
0163 #ifndef OPENSSL_NO_STDIO
0164 int NCONF_load_fp(CONF *conf, FILE *fp, long *eline);
0165 #endif
0166 int NCONF_load_bio(CONF *conf, BIO *bp, long *eline);
0167 STACK_OF(OPENSSL_CSTRING) *NCONF_get_section_names(const CONF *conf);
0168 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,
0169     const char *section);
0170 char *NCONF_get_string(const CONF *conf, const char *group, const char *name);
0171 int NCONF_get_number_e(const CONF *conf, const char *group, const char *name,
0172     long *result);
0173 #ifndef OPENSSL_NO_STDIO
0174 int NCONF_dump_fp(const CONF *conf, FILE *out);
0175 #endif
0176 int NCONF_dump_bio(const CONF *conf, BIO *out);
0177
0178 #define NCONF_get_number(c, g, n, r) NCONF_get_number_e(c, g, n, r)
0179
0180 /* Module functions */
0181
0182 int CONF_modules_load(const CONF *cnf, const char *appname,
0183     unsigned long flags);
0184 int CONF_modules_load_file_ex(OSSL_LIB_CTX *libctx, const char *filename,
0185     const char *appname, unsigned long flags);
0186 int CONF_modules_load_file(const char *filename, const char *appname,
0187     unsigned long flags);
0188 void CONF_modules_unload(int all);
0189 void CONF_modules_finish(void);
0190 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
0191 #define CONF_modules_free() \
0192     while (0)               \
0193     continue
0194 #endif
0195 int CONF_module_add(const char *name, conf_init_func *ifunc,
0196     conf_finish_func *ffunc);
0197
0198 const char *CONF_imodule_get_name(const CONF_IMODULE *md);
0199 const char *CONF_imodule_get_value(const CONF_IMODULE *md);
0200 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
0201 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
0202 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
0203 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
0204 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
0205 void *CONF_module_get_usr_data(CONF_MODULE *pmod);
0206 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
0207
0208 char *CONF_get1_default_config_file(void);
0209
0210 int CONF_parse_list(const char *list, int sep, int nospc,
0211     int (*list_cb)(const char *elem, int len, void *usr),
0212     void *arg);
0213
0214 void OPENSSL_load_builtin_modules(void);
0215
0216 #ifdef __cplusplus
0217 }
0218 #endif
0219 #endif