1 /* crypto/conf/conf.h */ 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 <AvailabilityMacros.h> 63 64 #include <openssl/bio.h> 65 #include <openssl/lhash.h> 66 #include <openssl/stack.h> 67 #include <openssl/safestack.h> 68 #include <openssl/e_os2.h> 69 70 #include <openssl/ossl_typ.h> 71 72 #ifdef __cplusplus 73 extern "C" { 74 #endif 75 76 typedef struct 77 { 78 char *section; 79 char *name; 80 char *value; 81 } CONF_VALUE; 82 83 DECLARE_STACK_OF(CONF_VALUE) 84 DECLARE_STACK_OF(CONF_MODULE) 85 DECLARE_STACK_OF(CONF_IMODULE) 86 87 struct conf_st; 88 struct conf_method_st; 89 typedef struct conf_method_st CONF_METHOD; 90 91 struct conf_method_st 92 { 93 const char *name; 94 CONF *(*create)(CONF_METHOD *meth) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 95 int (*init)(CONF *conf) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 96 int (*destroy)(CONF *conf) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 97 int (*destroy_data)(CONF *conf) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 98 int (*load_bio)(CONF *conf, BIO *bp, long *eline) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 99 int (*dump)(const CONF *conf, BIO *bp) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 100 int (*is_number)(const CONF *conf, char c) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 101 int (*to_int)(const CONF *conf, char c) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 102 int (*load)(CONF *conf, const char *name, long *eline) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 103 }; 104 105 /* Module definitions */ 106 107 typedef struct conf_imodule_st CONF_IMODULE; 108 typedef struct conf_module_st CONF_MODULE; 109 110 /* DSO module function typedefs */ 111 typedef int conf_init_func(CONF_IMODULE *md, const CONF *cnf); 112 typedef void conf_finish_func(CONF_IMODULE *md); 113 114 #define CONF_MFLAGS_IGNORE_ERRORS 0x1 115 #define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2 116 #define CONF_MFLAGS_SILENT 0x4 117 #define CONF_MFLAGS_NO_DSO 0x8 118 #define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10 119 #define CONF_MFLAGS_DEFAULT_SECTION 0x20 120 121 int CONF_set_default_method(CONF_METHOD *meth) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 122 void CONF_set_nconf(CONF *conf,LHASH *hash) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 123 LHASH *CONF_load(LHASH *conf,const char *file,long *eline) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 124 #ifndef OPENSSL_NO_FP_API 125 LHASH *CONF_load_fp(LHASH *conf, FILE *fp,long *eline) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 126 #endif 127 LHASH *CONF_load_bio(LHASH *conf, BIO *bp,long *eline) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 128 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH *conf,const char *section) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 129 char *CONF_get_string(LHASH *conf,const char *group,const char *name) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 130 long CONF_get_number(LHASH *conf,const char *group,const char *name) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 131 void CONF_free(LHASH *conf) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 132 int CONF_dump_fp(LHASH *conf, FILE *out) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 133 int CONF_dump_bio(LHASH *conf, BIO *out) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 134 135 void OPENSSL_config(const char *config_name) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 136 void OPENSSL_no_config(void) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 137 138 /* New conf code. The semantics are different from the functions above. 139 If that wasn't the case, the above functions would have been replaced */ 140 141 struct conf_st 142 { 143 CONF_METHOD *meth; 144 void *meth_data; 145 LHASH *data; 146 }; 147 148 CONF *NCONF_new(CONF_METHOD *meth) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 149 CONF_METHOD *NCONF_default(void) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 150 CONF_METHOD *NCONF_WIN32(void) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 151 #if 0 /* Just to give you an idea of what I have in mind */ 152 CONF_METHOD *NCONF_XML(void) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 153 #endif 154 void NCONF_free(CONF *conf) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 155 void NCONF_free_data(CONF *conf) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 156 157 int NCONF_load(CONF *conf,const char *file,long *eline) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 158 #ifndef OPENSSL_NO_FP_API 159 int NCONF_load_fp(CONF *conf, FILE *fp,long *eline) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 160 #endif 161 int NCONF_load_bio(CONF *conf, BIO *bp,long *eline) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 162 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,const char *section) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 163 char *NCONF_get_string(const CONF *conf,const char *group,const char *name) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 164 int NCONF_get_number_e(const CONF *conf,const char *group,const char *name, 165 long *result) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 166 int NCONF_dump_fp(const CONF *conf, FILE *out) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 167 int NCONF_dump_bio(const CONF *conf, BIO *out) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 168 169 #if 0 /* The following function has no error checking, 170 and should therefore be avoided */ 171 long NCONF_get_number(CONF *conf,char *group,char *name) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 172 #else 173 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r) 174 #endif 175 176 /* Module functions */ 177 178 int CONF_modules_load(const CONF *cnf, const char *appname, 179 unsigned long flags) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 180 int CONF_modules_load_file(const char *filename, const char *appname, 181 unsigned long flags) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 182 void CONF_modules_unload(int all) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 183 void CONF_modules_finish(void) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 184 void CONF_modules_free(void) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 185 int CONF_module_add(const char *name, conf_init_func *ifunc, 186 conf_finish_func *ffunc) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 187 188 const char *CONF_imodule_get_name(const CONF_IMODULE *md) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 189 const char *CONF_imodule_get_value(const CONF_IMODULE *md) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 190 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 191 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 192 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 193 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 194 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 195 void *CONF_module_get_usr_data(CONF_MODULE *pmod) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 196 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 197 198 char *CONF_get1_default_config_file(void) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 199 200 int CONF_parse_list(const char *list, int sep, int nospc, 201 int (*list_cb)(const char *elem, int len, void *usr), void *arg) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 202 203 void OPENSSL_load_builtin_modules(void) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 204 205 /* BEGIN ERROR CODES */ 206 /* The following lines are auto generated by the script mkerr.pl. Any changes 207 * made after this point may be overwritten when the script is next run. 208 */ 209 void ERR_load_CONF_strings(void) DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER; 210 211 /* Error codes for the CONF functions. */ 212 213 /* Function codes. */ 214 #define CONF_F_CONF_DUMP_FP 104 215 #define CONF_F_CONF_LOAD 100 216 #define CONF_F_CONF_LOAD_BIO 102 217 #define CONF_F_CONF_LOAD_FP 103 218 #define CONF_F_CONF_MODULES_LOAD 116 219 #define CONF_F_DEF_LOAD 120 220 #define CONF_F_DEF_LOAD_BIO 121 221 #define CONF_F_MODULE_INIT 115 222 #define CONF_F_MODULE_LOAD_DSO 117 223 #define CONF_F_MODULE_RUN 118 224 #define CONF_F_NCONF_DUMP_BIO 105 225 #define CONF_F_NCONF_DUMP_FP 106 226 #define CONF_F_NCONF_GET_NUMBER 107 227 #define CONF_F_NCONF_GET_NUMBER_E 112 228 #define CONF_F_NCONF_GET_SECTION 108 229 #define CONF_F_NCONF_GET_STRING 109 230 #define CONF_F_NCONF_LOAD 113 231 #define CONF_F_NCONF_LOAD_BIO 110 232 #define CONF_F_NCONF_LOAD_FP 114 233 #define CONF_F_NCONF_NEW 111 234 #define CONF_F_STR_COPY 101 235 236 /* Reason codes. */ 237 #define CONF_R_ERROR_LOADING_DSO 110 238 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100 239 #define CONF_R_MISSING_EQUAL_SIGN 101 240 #define CONF_R_MISSING_FINISH_FUNCTION 111 241 #define CONF_R_MISSING_INIT_FUNCTION 112 242 #define CONF_R_MODULE_INITIALIZATION_ERROR 109 243 #define CONF_R_NO_CLOSE_BRACE 102 244 #define CONF_R_NO_CONF 105 245 #define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106 246 #define CONF_R_NO_SECTION 107 247 #define CONF_R_NO_SUCH_FILE 114 248 #define CONF_R_NO_VALUE 108 249 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103 250 #define CONF_R_UNKNOWN_MODULE_NAME 113 251 #define CONF_R_VARIABLE_HAS_NO_VALUE 104 252 253 #ifdef __cplusplus 254 } 255 #endif 256 #endif 257