1 /* $MirOS: src/lib/libssl/src/crypto/conf/conf.h,v 1.2 2014/06/05 12:47:58 tg Exp $ */ 2 3 /* crypto/conf/conf.h */ 4 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 5 * All rights reserved. 6 * 7 * This package is an SSL implementation written 8 * by Eric Young (eay@cryptsoft.com). 9 * The implementation was written so as to conform with Netscapes SSL. 10 * 11 * This library is free for commercial and non-commercial use as long as 12 * the following conditions are aheared to. The following conditions 13 * apply to all code found in this distribution, be it the RC4, RSA, 14 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 15 * included with this distribution is covered by the same copyright terms 16 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 17 * 18 * Copyright remains Eric Young's, and as such any Copyright notices in 19 * the code are not to be removed. 20 * If this package is used in a product, Eric Young should be given attribution 21 * as the author of the parts of the library used. 22 * This can be in the form of a textual message at program startup or 23 * in documentation (online or textual) provided with the package. 24 * 25 * Redistribution and use in source and binary forms, with or without 26 * modification, are permitted provided that the following conditions 27 * are met: 28 * 1. Redistributions of source code must retain the copyright 29 * notice, this list of conditions and the following disclaimer. 30 * 2. Redistributions in binary form must reproduce the above copyright 31 * notice, this list of conditions and the following disclaimer in the 32 * documentation and/or other materials provided with the distribution. 33 * 3. All advertising materials mentioning features or use of this software 34 * must display the following acknowledgement: 35 * "This product includes cryptographic software written by 36 * Eric Young (eay@cryptsoft.com)" 37 * The word 'cryptographic' can be left out if the rouines from the library 38 * being used are not cryptographic related :-). 39 * 4. If you include any Windows specific code (or a derivative thereof) from 40 * the apps directory (application code) you must include an acknowledgement: 41 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 42 * 43 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 46 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 53 * SUCH DAMAGE. 54 * 55 * The licence and distribution terms for any publically available version or 56 * derivative of this code cannot be changed. i.e. this code cannot simply be 57 * copied and put under another distribution licence 58 * [including the GNU Public Licence.] 59 */ 60 61 #ifndef HEADER_CONF_H 62 #define HEADER_CONF_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 #ifdef __cplusplus 71 extern "C" { 72 #endif 73 74 typedef struct 75 { 76 char *section; 77 char *name; 78 char *value; 79 } CONF_VALUE; 80 81 DECLARE_STACK_OF(CONF_VALUE) 82 DECLARE_STACK_OF(CONF_MODULE) 83 DECLARE_STACK_OF(CONF_IMODULE) 84 85 struct conf_st; 86 typedef struct conf_st CONF; 87 struct conf_method_st; 88 typedef struct conf_method_st CONF_METHOD; 89 90 struct conf_method_st 91 { 92 const char *name; 93 CONF *(*create)(CONF_METHOD *meth); 94 int (*init)(CONF *conf); 95 int (*destroy)(CONF *conf); 96 int (*destroy_data)(CONF *conf); 97 int (*load_bio)(CONF *conf, BIO *bp, long *eline); 98 int (*dump)(const CONF *conf, BIO *bp); 99 int (*is_number)(const CONF *conf, char c); 100 int (*to_int)(const CONF *conf, char c); 101 int (*load)(CONF *conf, const char *name, long *eline); 102 }; 103 104 /* Module definitions */ 105 106 typedef struct conf_imodule_st CONF_IMODULE; 107 typedef struct conf_module_st CONF_MODULE; 108 109 /* DSO module function typedefs */ 110 typedef int conf_init_func(CONF_IMODULE *md, const CONF *cnf); 111 typedef void conf_finish_func(CONF_IMODULE *md); 112 113 #define CONF_MFLAGS_IGNORE_ERRORS 0x1 114 #define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2 115 #define CONF_MFLAGS_SILENT 0x4 116 #define CONF_MFLAGS_NO_DSO 0x8 117 #define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10 118 #define CONF_MFLAGS_DEFAULT_SECTION 0x20 119 120 int CONF_set_default_method(CONF_METHOD *meth); 121 void CONF_set_nconf(CONF *conf,LHASH *hash); 122 LHASH *CONF_load(LHASH *conf,const char *file,long *eline); 123 #ifndef OPENSSL_NO_FP_API 124 LHASH *CONF_load_fp(LHASH *conf, FILE *fp,long *eline); 125 #endif 126 LHASH *CONF_load_bio(LHASH *conf, BIO *bp,long *eline); 127 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH *conf,const char *section); 128 char *CONF_get_string(LHASH *conf,const char *group,const char *name); 129 long CONF_get_number(LHASH *conf,const char *group,const char *name); 130 void CONF_free(LHASH *conf); 131 int CONF_dump_fp(LHASH *conf, FILE *out); 132 int CONF_dump_bio(LHASH *conf, BIO *out); 133 134 void OPENSSL_config(const char *config_name); 135 void OPENSSL_no_config(void); 136 137 /* New conf code. The semantics are different from the functions above. 138 If that wasn't the case, the above functions would have been replaced */ 139 140 struct conf_st 141 { 142 CONF_METHOD *meth; 143 void *meth_data; 144 LHASH *data; 145 }; 146 147 CONF *NCONF_new(CONF_METHOD *meth); 148 CONF_METHOD *NCONF_default(void); 149 CONF_METHOD *NCONF_WIN32(void); 150 #if 0 /* Just to give you an idea of what I have in mind */ 151 CONF_METHOD *NCONF_XML(void); 152 #endif 153 void NCONF_free(CONF *conf); 154 void NCONF_free_data(CONF *conf); 155 156 int NCONF_load(CONF *conf,const char *file,long *eline); 157 #ifndef OPENSSL_NO_FP_API 158 int NCONF_load_fp(CONF *conf, FILE *fp,long *eline); 159 #endif 160 int NCONF_load_bio(CONF *conf, BIO *bp,long *eline); 161 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,const char *section); 162 char *NCONF_get_string(const CONF *conf,const char *group,const char *name); 163 int NCONF_get_number_e(const CONF *conf,const char *group,const char *name, 164 long *result); 165 int NCONF_dump_fp(const CONF *conf, FILE *out); 166 int NCONF_dump_bio(const CONF *conf, BIO *out); 167 168 #if 0 /* The following function has no error checking, 169 and should therefore be avoided */ 170 long NCONF_get_number(CONF *conf,char *group,char *name); 171 #else 172 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r) 173 #endif 174 175 /* Module functions */ 176 177 int CONF_modules_load(const CONF *cnf, const char *appname, 178 unsigned long flags); 179 int CONF_modules_load_file(const char *filename, const char *appname, 180 unsigned long flags); 181 void CONF_modules_unload(int all); 182 void CONF_modules_finish(void); 183 void CONF_modules_free(void); 184 int CONF_module_add(const char *name, conf_init_func *ifunc, 185 conf_finish_func *ffunc); 186 187 const char *CONF_imodule_get_name(const CONF_IMODULE *md); 188 const char *CONF_imodule_get_value(const CONF_IMODULE *md); 189 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md); 190 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data); 191 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md); 192 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md); 193 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags); 194 void *CONF_module_get_usr_data(CONF_MODULE *pmod); 195 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data); 196 197 char *CONF_get1_default_config_file(void); 198 199 int CONF_parse_list(const char *list, int sep, int nospc, 200 int (*list_cb)(const char *elem, int len, void *usr), void *arg); 201 202 void OPENSSL_load_builtin_modules(void); 203 204 /* BEGIN ERROR CODES */ 205 /* The following lines are auto generated by the script mkerr.pl. Any changes 206 * made after this point may be overwritten when the script is next run. 207 */ 208 void ERR_load_CONF_strings(void); 209 210 /* Error codes for the CONF functions. */ 211 212 /* Function codes. */ 213 #define CONF_F_CONF_DUMP_FP 104 214 #define CONF_F_CONF_LOAD 100 215 #define CONF_F_CONF_LOAD_BIO 102 216 #define CONF_F_CONF_LOAD_FP 103 217 #define CONF_F_CONF_MODULES_LOAD 116 218 #define CONF_F_MODULE_INIT 115 219 #define CONF_F_MODULE_LOAD_DSO 117 220 #define CONF_F_MODULE_RUN 118 221 #define CONF_F_NCONF_DUMP_BIO 105 222 #define CONF_F_NCONF_DUMP_FP 106 223 #define CONF_F_NCONF_GET_NUMBER 107 224 #define CONF_F_NCONF_GET_NUMBER_E 112 225 #define CONF_F_NCONF_GET_SECTION 108 226 #define CONF_F_NCONF_GET_STRING 109 227 #define CONF_F_NCONF_LOAD 113 228 #define CONF_F_NCONF_LOAD_BIO 110 229 #define CONF_F_NCONF_LOAD_FP 114 230 #define CONF_F_NCONF_NEW 111 231 #define CONF_F_STR_COPY 101 232 233 /* Reason codes. */ 234 #define CONF_R_ERROR_LOADING_DSO 110 235 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100 236 #define CONF_R_MISSING_EQUAL_SIGN 101 237 #define CONF_R_MISSING_FINISH_FUNCTION 111 238 #define CONF_R_MISSING_INIT_FUNCTION 112 239 #define CONF_R_MODULE_INITIALIZATION_ERROR 109 240 #define CONF_R_NO_CLOSE_BRACE 102 241 #define CONF_R_NO_CONF 105 242 #define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106 243 #define CONF_R_NO_SECTION 107 244 #define CONF_R_NO_SUCH_FILE 114 245 #define CONF_R_NO_VALUE 108 246 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103 247 #define CONF_R_UNKNOWN_MODULE_NAME 113 248 #define CONF_R_VARIABLE_HAS_NO_VALUE 104 249 250 #ifdef __cplusplus 251 } 252 #endif 253 #endif 254