1 /* $OpenBSD: conf.h,v 1.27 2024/08/31 09:54:31 tb Exp $ */ 2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 3 * All rights reserved. 4 * 5 * This package is an SSL implementation written 6 * by Eric Young (eay@cryptsoft.com). 7 * The implementation was written so as to conform with Netscapes SSL. 8 * 9 * This library is free for commercial and non-commercial use as long as 10 * the following conditions are aheared to. The following conditions 11 * apply to all code found in this distribution, be it the RC4, RSA, 12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 13 * included with this distribution is covered by the same copyright terms 14 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 15 * 16 * Copyright remains Eric Young's, and as such any Copyright notices in 17 * the code are not to be removed. 18 * If this package is used in a product, Eric Young should be given attribution 19 * as the author of the parts of the library used. 20 * This can be in the form of a textual message at program startup or 21 * in documentation (online or textual) provided with the package. 22 * 23 * Redistribution and use in source and binary forms, with or without 24 * modification, are permitted provided that the following conditions 25 * are met: 26 * 1. Redistributions of source code must retain the copyright 27 * notice, this list of conditions and the following disclaimer. 28 * 2. Redistributions in binary form must reproduce the above copyright 29 * notice, this list of conditions and the following disclaimer in the 30 * documentation and/or other materials provided with the distribution. 31 * 3. All advertising materials mentioning features or use of this software 32 * must display the following acknowledgement: 33 * "This product includes cryptographic software written by 34 * Eric Young (eay@cryptsoft.com)" 35 * The word 'cryptographic' can be left out if the rouines from the library 36 * being used are not cryptographic related :-). 37 * 4. If you include any Windows specific code (or a derivative thereof) from 38 * the apps directory (application code) you must include an acknowledgement: 39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 40 * 41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 51 * SUCH DAMAGE. 52 * 53 * The licence and distribution terms for any publically available version or 54 * derivative of this code cannot be changed. i.e. this code cannot simply be 55 * copied and put under another distribution licence 56 * [including the GNU Public Licence.] 57 */ 58 59 #ifndef HEADER_CONF_H 60 #define HEADER_CONF_H 61 62 #include <openssl/opensslconf.h> 63 64 #include <openssl/bio.h> 65 #include <openssl/lhash.h> 66 #include <openssl/stack.h> 67 #include <openssl/safestack.h> 68 69 #include <openssl/ossl_typ.h> 70 71 #ifdef __cplusplus 72 extern "C" { 73 #endif 74 75 typedef struct { 76 char *section; 77 char *name; 78 char *value; 79 } CONF_VALUE; 80 81 DECLARE_STACK_OF(CONF_VALUE) 82 DECLARE_LHASH_OF(CONF_VALUE); 83 84 struct conf_st; 85 struct conf_method_st; 86 typedef struct conf_method_st CONF_METHOD; 87 88 /* Module definitions */ 89 90 typedef struct conf_imodule_st CONF_IMODULE; 91 typedef struct conf_module_st CONF_MODULE; 92 93 DECLARE_STACK_OF(CONF_MODULE) 94 DECLARE_STACK_OF(CONF_IMODULE) 95 96 /* DSO module function typedefs */ 97 typedef int conf_init_func(CONF_IMODULE *md, const CONF *cnf); 98 typedef void conf_finish_func(CONF_IMODULE *md); 99 100 #define CONF_MFLAGS_IGNORE_ERRORS 0x1 101 #define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2 102 #define CONF_MFLAGS_SILENT 0x4 103 #define CONF_MFLAGS_NO_DSO 0x8 104 #define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10 105 #define CONF_MFLAGS_DEFAULT_SECTION 0x20 106 107 void OPENSSL_config(const char *config_name); 108 void OPENSSL_no_config(void); 109 110 /* New conf code. The semantics are different from the functions above. 111 If that wasn't the case, the above functions would have been replaced */ 112 113 struct conf_st { 114 const CONF_METHOD *meth; 115 LHASH_OF(CONF_VALUE) *data; 116 }; 117 118 CONF *NCONF_new(const CONF_METHOD *meth); 119 void NCONF_free(CONF *conf); 120 121 int NCONF_load(CONF *conf, const char *file, long *eline); 122 int NCONF_load_bio(CONF *conf, BIO *bp, long *eline); 123 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *section); 124 char *NCONF_get_string(const CONF *conf, const char *group, const char *name); 125 int NCONF_get_number_e(const CONF *conf, const char *group, const char *name, 126 long *result); 127 128 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r) 129 130 /* Module functions */ 131 132 int CONF_modules_load(const CONF *cnf, const char *appname, 133 unsigned long flags); 134 int CONF_modules_load_file(const char *filename, const char *appname, 135 unsigned long flags); 136 void CONF_modules_unload(int all); 137 void CONF_modules_finish(void); 138 void CONF_modules_free(void); 139 140 char *CONF_get1_default_config_file(void); 141 142 void ERR_load_CONF_strings(void); 143 144 /* Error codes for the CONF functions. */ 145 146 /* Function codes. */ 147 #define CONF_F_CONF_DUMP_FP 104 148 #define CONF_F_CONF_LOAD 100 149 #define CONF_F_CONF_LOAD_BIO 102 150 #define CONF_F_CONF_LOAD_FP 103 151 #define CONF_F_CONF_MODULES_LOAD 116 152 #define CONF_F_CONF_PARSE_LIST 119 153 #define CONF_F_DEF_LOAD 120 154 #define CONF_F_DEF_LOAD_BIO 121 155 #define CONF_F_MODULE_INIT 115 156 #define CONF_F_MODULE_LOAD_DSO 117 157 #define CONF_F_MODULE_RUN 118 158 #define CONF_F_NCONF_DUMP_BIO 105 159 #define CONF_F_NCONF_DUMP_FP 106 160 #define CONF_F_NCONF_GET_NUMBER 107 161 #define CONF_F_NCONF_GET_NUMBER_E 112 162 #define CONF_F_NCONF_GET_SECTION 108 163 #define CONF_F_NCONF_GET_STRING 109 164 #define CONF_F_NCONF_LOAD 113 165 #define CONF_F_NCONF_LOAD_BIO 110 166 #define CONF_F_NCONF_LOAD_FP 114 167 #define CONF_F_NCONF_NEW 111 168 #define CONF_F_STR_COPY 101 169 170 /* Reason codes. */ 171 #define CONF_R_ERROR_LOADING_DSO 110 172 #define CONF_R_LIST_CANNOT_BE_NULL 115 173 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100 174 #define CONF_R_MISSING_EQUAL_SIGN 101 175 #define CONF_R_MISSING_FINISH_FUNCTION 111 176 #define CONF_R_MISSING_INIT_FUNCTION 112 177 #define CONF_R_MODULE_INITIALIZATION_ERROR 109 178 #define CONF_R_NO_CLOSE_BRACE 102 179 #define CONF_R_NO_CONF 105 180 #define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106 181 #define CONF_R_NO_SECTION 107 182 #define CONF_R_NO_SUCH_FILE 114 183 #define CONF_R_NO_VALUE 108 184 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103 185 #define CONF_R_UNKNOWN_MODULE_NAME 113 186 #define CONF_R_VARIABLE_EXPANSION_TOO_LONG 116 187 #define CONF_R_VARIABLE_HAS_NO_VALUE 104 188 189 #ifdef __cplusplus 190 } 191 #endif 192 #endif 193