conf.h revision 160814
1145485Swpaul/* crypto/conf/conf.h */ 2145485Swpaul/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 3145485Swpaul * All rights reserved. 4145485Swpaul * 5145485Swpaul * This package is an SSL implementation written 6145485Swpaul * by Eric Young (eay@cryptsoft.com). 7145485Swpaul * The implementation was written so as to conform with Netscapes SSL. 8145485Swpaul * 9145485Swpaul * This library is free for commercial and non-commercial use as long as 10145485Swpaul * the following conditions are aheared to. The following conditions 11145485Swpaul * apply to all code found in this distribution, be it the RC4, RSA, 12145485Swpaul * lhash, DES, etc., code; not just the SSL code. The SSL documentation 13145485Swpaul * included with this distribution is covered by the same copyright terms 14145485Swpaul * except that the holder is Tim Hudson (tjh@cryptsoft.com). 15145485Swpaul * 16145485Swpaul * Copyright remains Eric Young's, and as such any Copyright notices in 17145485Swpaul * the code are not to be removed. 18145485Swpaul * If this package is used in a product, Eric Young should be given attribution 19145485Swpaul * as the author of the parts of the library used. 20145485Swpaul * This can be in the form of a textual message at program startup or 21145485Swpaul * in documentation (online or textual) provided with the package. 22145485Swpaul * 23145485Swpaul * Redistribution and use in source and binary forms, with or without 24145485Swpaul * modification, are permitted provided that the following conditions 25145485Swpaul * are met: 26145485Swpaul * 1. Redistributions of source code must retain the copyright 27145485Swpaul * notice, this list of conditions and the following disclaimer. 28145485Swpaul * 2. Redistributions in binary form must reproduce the above copyright 29145485Swpaul * notice, this list of conditions and the following disclaimer in the 30145485Swpaul * documentation and/or other materials provided with the distribution. 31145485Swpaul * 3. All advertising materials mentioning features or use of this software 32145485Swpaul * must display the following acknowledgement: 33145485Swpaul * "This product includes cryptographic software written by 34145485Swpaul * Eric Young (eay@cryptsoft.com)" 35145485Swpaul * The word 'cryptographic' can be left out if the rouines from the library 36145485Swpaul * being used are not cryptographic related :-). 37145485Swpaul * 4. If you include any Windows specific code (or a derivative thereof) from 38145485Swpaul * the apps directory (application code) you must include an acknowledgement: 39145485Swpaul * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 40145485Swpaul * 41145485Swpaul * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 42145485Swpaul * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 43148350Sdougb * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 44145485Swpaul * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 45145485Swpaul * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 46145485Swpaul * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 47145485Swpaul * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48145485Swpaul * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 49147436Sru * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 50147436Sru * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 51147436Sru * SUCH DAMAGE. 52145485Swpaul * 53145485Swpaul * The licence and distribution terms for any publically available version or 54145485Swpaul * derivative of this code cannot be changed. i.e. this code cannot simply be 55145485Swpaul * copied and put under another distribution licence 56145485Swpaul * [including the GNU Public Licence.] 57145485Swpaul */ 58145485Swpaul 59145485Swpaul#ifndef HEADER_CONF_H 60147436Sru#define HEADER_CONF_H 61148350Sdougb 62148350Sdougb#include <openssl/bio.h> 63145485Swpaul#include <openssl/lhash.h> 64145485Swpaul#include <openssl/stack.h> 65145485Swpaul#include <openssl/safestack.h> 66148350Sdougb#include <openssl/e_os2.h> 67147436Sru 68147436Sru#include <openssl/ossl_typ.h> 69148350Sdougb 70148350Sdougb#ifdef __cplusplus 71145485Swpaulextern "C" { 72145485Swpaul#endif 73145485Swpaul 74145485Swpaultypedef struct 75145485Swpaul { 76180730Sweongyo char *section; 77145485Swpaul char *name; 78145485Swpaul char *value; 79145485Swpaul } CONF_VALUE; 80145485Swpaul 81145485SwpaulDECLARE_STACK_OF(CONF_VALUE) 82145485SwpaulDECLARE_STACK_OF(CONF_MODULE) 83145485SwpaulDECLARE_STACK_OF(CONF_IMODULE) 84145485Swpaul 85145485Swpaulstruct conf_st; 86267668Sbaptstruct conf_method_st; 87typedef struct conf_method_st CONF_METHOD; 88 89struct conf_method_st 90 { 91 const char *name; 92 CONF *(*create)(CONF_METHOD *meth); 93 int (*init)(CONF *conf); 94 int (*destroy)(CONF *conf); 95 int (*destroy_data)(CONF *conf); 96 int (*load_bio)(CONF *conf, BIO *bp, long *eline); 97 int (*dump)(const CONF *conf, BIO *bp); 98 int (*is_number)(const CONF *conf, char c); 99 int (*to_int)(const CONF *conf, char c); 100 int (*load)(CONF *conf, const char *name, long *eline); 101 }; 102 103/* Module definitions */ 104 105typedef struct conf_imodule_st CONF_IMODULE; 106typedef struct conf_module_st CONF_MODULE; 107 108/* DSO module function typedefs */ 109typedef int conf_init_func(CONF_IMODULE *md, const CONF *cnf); 110typedef void conf_finish_func(CONF_IMODULE *md); 111 112#define CONF_MFLAGS_IGNORE_ERRORS 0x1 113#define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2 114#define CONF_MFLAGS_SILENT 0x4 115#define CONF_MFLAGS_NO_DSO 0x8 116#define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10 117 118int CONF_set_default_method(CONF_METHOD *meth); 119void CONF_set_nconf(CONF *conf,LHASH *hash); 120LHASH *CONF_load(LHASH *conf,const char *file,long *eline); 121#ifndef OPENSSL_NO_FP_API 122LHASH *CONF_load_fp(LHASH *conf, FILE *fp,long *eline); 123#endif 124LHASH *CONF_load_bio(LHASH *conf, BIO *bp,long *eline); 125STACK_OF(CONF_VALUE) *CONF_get_section(LHASH *conf,const char *section); 126char *CONF_get_string(LHASH *conf,const char *group,const char *name); 127long CONF_get_number(LHASH *conf,const char *group,const char *name); 128void CONF_free(LHASH *conf); 129int CONF_dump_fp(LHASH *conf, FILE *out); 130int CONF_dump_bio(LHASH *conf, BIO *out); 131 132void OPENSSL_config(const char *config_name); 133void OPENSSL_no_config(void); 134 135/* New conf code. The semantics are different from the functions above. 136 If that wasn't the case, the above functions would have been replaced */ 137 138struct conf_st 139 { 140 CONF_METHOD *meth; 141 void *meth_data; 142 LHASH *data; 143 }; 144 145CONF *NCONF_new(CONF_METHOD *meth); 146CONF_METHOD *NCONF_default(void); 147CONF_METHOD *NCONF_WIN32(void); 148#if 0 /* Just to give you an idea of what I have in mind */ 149CONF_METHOD *NCONF_XML(void); 150#endif 151void NCONF_free(CONF *conf); 152void NCONF_free_data(CONF *conf); 153 154int NCONF_load(CONF *conf,const char *file,long *eline); 155#ifndef OPENSSL_NO_FP_API 156int NCONF_load_fp(CONF *conf, FILE *fp,long *eline); 157#endif 158int NCONF_load_bio(CONF *conf, BIO *bp,long *eline); 159STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,const char *section); 160char *NCONF_get_string(const CONF *conf,const char *group,const char *name); 161int NCONF_get_number_e(const CONF *conf,const char *group,const char *name, 162 long *result); 163int NCONF_dump_fp(const CONF *conf, FILE *out); 164int NCONF_dump_bio(const CONF *conf, BIO *out); 165 166#if 0 /* The following function has no error checking, 167 and should therefore be avoided */ 168long NCONF_get_number(CONF *conf,char *group,char *name); 169#else 170#define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r) 171#endif 172 173/* Module functions */ 174 175int CONF_modules_load(const CONF *cnf, const char *appname, 176 unsigned long flags); 177int CONF_modules_load_file(const char *filename, const char *appname, 178 unsigned long flags); 179void CONF_modules_unload(int all); 180void CONF_modules_finish(void); 181void CONF_modules_free(void); 182int CONF_module_add(const char *name, conf_init_func *ifunc, 183 conf_finish_func *ffunc); 184 185const char *CONF_imodule_get_name(const CONF_IMODULE *md); 186const char *CONF_imodule_get_value(const CONF_IMODULE *md); 187void *CONF_imodule_get_usr_data(const CONF_IMODULE *md); 188void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data); 189CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md); 190unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md); 191void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags); 192void *CONF_module_get_usr_data(CONF_MODULE *pmod); 193void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data); 194 195char *CONF_get1_default_config_file(void); 196 197int CONF_parse_list(const char *list, int sep, int nospc, 198 int (*list_cb)(const char *elem, int len, void *usr), void *arg); 199 200void OPENSSL_load_builtin_modules(void); 201 202/* BEGIN ERROR CODES */ 203/* The following lines are auto generated by the script mkerr.pl. Any changes 204 * made after this point may be overwritten when the script is next run. 205 */ 206void ERR_load_CONF_strings(void); 207 208/* Error codes for the CONF functions. */ 209 210/* Function codes. */ 211#define CONF_F_CONF_DUMP_FP 104 212#define CONF_F_CONF_LOAD 100 213#define CONF_F_CONF_LOAD_BIO 102 214#define CONF_F_CONF_LOAD_FP 103 215#define CONF_F_CONF_MODULES_LOAD 116 216#define CONF_F_DEF_LOAD 120 217#define CONF_F_DEF_LOAD_BIO 121 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