userapps/opensource/openssl/crypto/conf/conf.h

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