LTKCPP-- LLRP Toolkit C Plus Plus Library
conf.h
00001 /* crypto/conf/conf.h */
00002 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
00003  * All rights reserved.
00004  *
00005  * This package is an SSL implementation written
00006  * by Eric Young (eay@cryptsoft.com).
00007  * The implementation was written so as to conform with Netscapes SSL.
00008  *
00009  * This library is free for commercial and non-commercial use as long as
00010  * the following conditions are aheared to.  The following conditions
00011  * apply to all code found in this distribution, be it the RC4, RSA,
00012  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
00013  * included with this distribution is covered by the same copyright terms
00014  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
00015  *
00016  * Copyright remains Eric Young's, and as such any Copyright notices in
00017  * the code are not to be removed.
00018  * If this package is used in a product, Eric Young should be given attribution
00019  * as the author of the parts of the library used.
00020  * This can be in the form of a textual message at program startup or
00021  * in documentation (online or textual) provided with the package.
00022  *
00023  * Redistribution and use in source and binary forms, with or without
00024  * modification, are permitted provided that the following conditions
00025  * are met:
00026  * 1. Redistributions of source code must retain the copyright
00027  *    notice, this list of conditions and the following disclaimer.
00028  * 2. Redistributions in binary form must reproduce the above copyright
00029  *    notice, this list of conditions and the following disclaimer in the
00030  *    documentation and/or other materials provided with the distribution.
00031  * 3. All advertising materials mentioning features or use of this software
00032  *    must display the following acknowledgement:
00033  *    "This product includes cryptographic software written by
00034  *     Eric Young (eay@cryptsoft.com)"
00035  *    The word 'cryptographic' can be left out if the rouines from the library
00036  *    being used are not cryptographic related :-).
00037  * 4. If you include any Windows specific code (or a derivative thereof) from
00038  *    the apps directory (application code) you must include an acknowledgement:
00039  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
00040  *
00041  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
00042  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00043  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00044  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
00045  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00046  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00047  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00049  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00050  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00051  * SUCH DAMAGE.
00052  *
00053  * The licence and distribution terms for any publically available version or
00054  * derivative of this code cannot be changed.  i.e. this code cannot simply be
00055  * copied and put under another distribution licence
00056  * [including the GNU Public Licence.]
00057  */
00058 
00059 #ifndef  HEADER_CONF_H
00060 # define HEADER_CONF_H
00061 
00062 # include <openssl/bio.h>
00063 # include <openssl/lhash.h>
00064 # include <openssl/stack.h>
00065 # include <openssl/safestack.h>
00066 # include <openssl/e_os2.h>
00067 
00068 # include <openssl/ossl_typ.h>
00069 
00070 #ifdef  __cplusplus
00071 extern "C" {
00072 #endif
00073 
00074 typedef struct {
00075     char *section;
00076     char *name;
00077     char *value;
00078 } CONF_VALUE;
00079 
00080 DECLARE_STACK_OF(CONF_VALUE)
00081 DECLARE_LHASH_OF(CONF_VALUE);
00082 
00083 struct conf_st;
00084 struct conf_method_st;
00085 typedef struct conf_method_st CONF_METHOD;
00086 
00087 struct conf_method_st {
00088     const char *name;
00089     CONF *(*create) (CONF_METHOD *meth);
00090     int (*init) (CONF *conf);
00091     int (*destroy) (CONF *conf);
00092     int (*destroy_data) (CONF *conf);
00093     int (*load_bio) (CONF *conf, BIO *bp, long *eline);
00094     int (*dump) (const CONF *conf, BIO *bp);
00095     int (*is_number) (const CONF *conf, char c);
00096     int (*to_int) (const CONF *conf, char c);
00097     int (*load) (CONF *conf, const char *name, long *eline);
00098 };
00099 
00100 /* Module definitions */
00101 
00102 typedef struct conf_imodule_st CONF_IMODULE;
00103 typedef struct conf_module_st CONF_MODULE;
00104 
00105 DECLARE_STACK_OF(CONF_MODULE)
00106 DECLARE_STACK_OF(CONF_IMODULE)
00107 
00108 /* DSO module function typedefs */
00109 typedef int conf_init_func (CONF_IMODULE *md, const CONF *cnf);
00110 typedef void conf_finish_func (CONF_IMODULE *md);
00111 
00112 # define CONF_MFLAGS_IGNORE_ERRORS       0x1
00113 # define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2
00114 # define CONF_MFLAGS_SILENT              0x4
00115 # define CONF_MFLAGS_NO_DSO              0x8
00116 # define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10
00117 # define CONF_MFLAGS_DEFAULT_SECTION     0x20
00118 
00119 int CONF_set_default_method(CONF_METHOD *meth);
00120 void CONF_set_nconf(CONF *conf, LHASH_OF(CONF_VALUE) *hash);
00121 LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf, const char *file,
00122                                 long *eline);
00123 # ifndef OPENSSL_NO_FP_API
00124 LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp,
00125                                    long *eline);
00126 # endif
00127 LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp,
00128                                     long *eline);
00129 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf,
00130                                        const char *section);
00131 char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf, const char *group,
00132                       const char *name);
00133 long CONF_get_number(LHASH_OF(CONF_VALUE) *conf, const char *group,
00134                      const char *name);
00135 void CONF_free(LHASH_OF(CONF_VALUE) *conf);
00136 int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out);
00137 int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out);
00138 
00139 void OPENSSL_config(const char *config_name);
00140 void OPENSSL_no_config(void);
00141 
00142 /*
00143  * New conf code.  The semantics are different from the functions above. If
00144  * that wasn't the case, the above functions would have been replaced
00145  */
00146 
00147 struct conf_st {
00148     CONF_METHOD *meth;
00149     void *meth_data;
00150     LHASH_OF(CONF_VALUE) *data;
00151 };
00152 
00153 CONF *NCONF_new(CONF_METHOD *meth);
00154 CONF_METHOD *NCONF_default(void);
00155 CONF_METHOD *NCONF_WIN32(void);
00156 # if 0                          /* Just to give you an idea of what I have in
00157                                  * mind */
00158 CONF_METHOD *NCONF_XML(void);
00159 # endif
00160 void NCONF_free(CONF *conf);
00161 void NCONF_free_data(CONF *conf);
00162 
00163 int NCONF_load(CONF *conf, const char *file, long *eline);
00164 # ifndef OPENSSL_NO_FP_API
00165 int NCONF_load_fp(CONF *conf, FILE *fp, long *eline);
00166 # endif
00167 int NCONF_load_bio(CONF *conf, BIO *bp, long *eline);
00168 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,
00169                                         const char *section);
00170 char *NCONF_get_string(const CONF *conf, const char *group, const char *name);
00171 int NCONF_get_number_e(const CONF *conf, const char *group, const char *name,
00172                        long *result);
00173 int NCONF_dump_fp(const CONF *conf, FILE *out);
00174 int NCONF_dump_bio(const CONF *conf, BIO *out);
00175 
00176 # if 0                          /* The following function has no error
00177                                  * checking, and should therefore be avoided */
00178 long NCONF_get_number(CONF *conf, char *group, char *name);
00179 # else
00180 #  define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
00181 # endif
00182 
00183 /* Module functions */
00184 
00185 int CONF_modules_load(const CONF *cnf, const char *appname,
00186                       unsigned long flags);
00187 int CONF_modules_load_file(const char *filename, const char *appname,
00188                            unsigned long flags);
00189 void CONF_modules_unload(int all);
00190 void CONF_modules_finish(void);
00191 void CONF_modules_free(void);
00192 int CONF_module_add(const char *name, conf_init_func *ifunc,
00193                     conf_finish_func *ffunc);
00194 
00195 const char *CONF_imodule_get_name(const CONF_IMODULE *md);
00196 const char *CONF_imodule_get_value(const CONF_IMODULE *md);
00197 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
00198 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
00199 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
00200 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
00201 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
00202 void *CONF_module_get_usr_data(CONF_MODULE *pmod);
00203 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
00204 
00205 char *CONF_get1_default_config_file(void);
00206 
00207 int CONF_parse_list(const char *list, int sep, int nospc,
00208                     int (*list_cb) (const char *elem, int len, void *usr),
00209                     void *arg);
00210 
00211 void OPENSSL_load_builtin_modules(void);
00212 
00213 /* BEGIN ERROR CODES */
00214 /*
00215  * The following lines are auto generated by the script mkerr.pl. Any changes
00216  * made after this point may be overwritten when the script is next run.
00217  */
00218 void ERR_load_CONF_strings(void);
00219 
00220 /* Error codes for the CONF functions. */
00221 
00222 /* Function codes. */
00223 # define CONF_F_CONF_DUMP_FP                              104
00224 # define CONF_F_CONF_LOAD                                 100
00225 # define CONF_F_CONF_LOAD_BIO                             102
00226 # define CONF_F_CONF_LOAD_FP                              103
00227 # define CONF_F_CONF_MODULES_LOAD                         116
00228 # define CONF_F_CONF_PARSE_LIST                           119
00229 # define CONF_F_DEF_LOAD                                  120
00230 # define CONF_F_DEF_LOAD_BIO                              121
00231 # define CONF_F_MODULE_INIT                               115
00232 # define CONF_F_MODULE_LOAD_DSO                           117
00233 # define CONF_F_MODULE_RUN                                118
00234 # define CONF_F_NCONF_DUMP_BIO                            105
00235 # define CONF_F_NCONF_DUMP_FP                             106
00236 # define CONF_F_NCONF_GET_NUMBER                          107
00237 # define CONF_F_NCONF_GET_NUMBER_E                        112
00238 # define CONF_F_NCONF_GET_SECTION                         108
00239 # define CONF_F_NCONF_GET_STRING                          109
00240 # define CONF_F_NCONF_LOAD                                113
00241 # define CONF_F_NCONF_LOAD_BIO                            110
00242 # define CONF_F_NCONF_LOAD_FP                             114
00243 # define CONF_F_NCONF_NEW                                 111
00244 # define CONF_F_STR_COPY                                  101
00245 
00246 /* Reason codes. */
00247 # define CONF_R_ERROR_LOADING_DSO                         110
00248 # define CONF_R_LIST_CANNOT_BE_NULL                       115
00249 # define CONF_R_MISSING_CLOSE_SQUARE_BRACKET              100
00250 # define CONF_R_MISSING_EQUAL_SIGN                        101
00251 # define CONF_R_MISSING_FINISH_FUNCTION                   111
00252 # define CONF_R_MISSING_INIT_FUNCTION                     112
00253 # define CONF_R_MODULE_INITIALIZATION_ERROR               109
00254 # define CONF_R_NO_CLOSE_BRACE                            102
00255 # define CONF_R_NO_CONF                                   105
00256 # define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE           106
00257 # define CONF_R_NO_SECTION                                107
00258 # define CONF_R_NO_SUCH_FILE                              114
00259 # define CONF_R_NO_VALUE                                  108
00260 # define CONF_R_UNABLE_TO_CREATE_NEW_SECTION              103
00261 # define CONF_R_UNKNOWN_MODULE_NAME                       113
00262 # define CONF_R_VARIABLE_HAS_NO_VALUE                     104
00263 
00264 #ifdef  __cplusplus
00265 }
00266 #endif
00267 #endif