Eneboo - Documentación para desarrolladores
src/libdigidoc/openssl/include/openssl/conf.h
Ir a la documentación de este archivo.
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         {
00076         char *section;
00077         char *name;
00078         char *value;
00079         } CONF_VALUE;
00080 
00081 DECLARE_STACK_OF(CONF_VALUE)
00082 DECLARE_STACK_OF(CONF_MODULE)
00083 DECLARE_STACK_OF(CONF_IMODULE)
00084 
00085 struct conf_st;
00086 struct conf_method_st;
00087 typedef struct conf_method_st CONF_METHOD;
00088 
00089 struct conf_method_st
00090         {
00091         const char *name;
00092         CONF *(*create)(CONF_METHOD *meth);
00093         int (*init)(CONF *conf);
00094         int (*destroy)(CONF *conf);
00095         int (*destroy_data)(CONF *conf);
00096         int (*load_bio)(CONF *conf, BIO *bp, long *eline);
00097         int (*dump)(const CONF *conf, BIO *bp);
00098         int (*is_number)(const CONF *conf, char c);
00099         int (*to_int)(const CONF *conf, char c);
00100         int (*load)(CONF *conf, const char *name, long *eline);
00101         };
00102 
00103 /* Module definitions */
00104 
00105 typedef struct conf_imodule_st CONF_IMODULE;
00106 typedef struct conf_module_st CONF_MODULE;
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 *hash);
00121 LHASH *CONF_load(LHASH *conf,const char *file,long *eline);
00122 #ifndef OPENSSL_NO_FP_API
00123 LHASH *CONF_load_fp(LHASH *conf, FILE *fp,long *eline);
00124 #endif
00125 LHASH *CONF_load_bio(LHASH *conf, BIO *bp,long *eline);
00126 STACK_OF(CONF_VALUE) *CONF_get_section(LHASH *conf,const char *section);
00127 char *CONF_get_string(LHASH *conf,const char *group,const char *name);
00128 long CONF_get_number(LHASH *conf,const char *group,const char *name);
00129 void CONF_free(LHASH *conf);
00130 int CONF_dump_fp(LHASH *conf, FILE *out);
00131 int CONF_dump_bio(LHASH *conf, BIO *out);
00132 
00133 void OPENSSL_config(const char *config_name);
00134 void OPENSSL_no_config(void);
00135 
00136 /* New conf code.  The semantics are different from the functions above.
00137    If that wasn't the case, the above functions would have been replaced */
00138 
00139 struct conf_st
00140         {
00141         CONF_METHOD *meth;
00142         void *meth_data;
00143         LHASH *data;
00144         };
00145 
00146 CONF *NCONF_new(CONF_METHOD *meth);
00147 CONF_METHOD *NCONF_default(void);
00148 CONF_METHOD *NCONF_WIN32(void);
00149 #if 0 /* Just to give you an idea of what I have in mind */
00150 CONF_METHOD *NCONF_XML(void);
00151 #endif
00152 void NCONF_free(CONF *conf);
00153 void NCONF_free_data(CONF *conf);
00154 
00155 int NCONF_load(CONF *conf,const char *file,long *eline);
00156 #ifndef OPENSSL_NO_FP_API
00157 int NCONF_load_fp(CONF *conf, FILE *fp,long *eline);
00158 #endif
00159 int NCONF_load_bio(CONF *conf, BIO *bp,long *eline);
00160 STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,const char *section);
00161 char *NCONF_get_string(const CONF *conf,const char *group,const char *name);
00162 int NCONF_get_number_e(const CONF *conf,const char *group,const char *name,
00163                        long *result);
00164 int NCONF_dump_fp(const CONF *conf, FILE *out);
00165 int NCONF_dump_bio(const CONF *conf, BIO *out);
00166 
00167 #if 0 /* The following function has no error checking,
00168          and should therefore be avoided */
00169 long NCONF_get_number(CONF *conf,char *group,char *name);
00170 #else
00171 #define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
00172 #endif
00173   
00174 /* Module functions */
00175 
00176 int CONF_modules_load(const CONF *cnf, const char *appname,
00177                       unsigned long flags);
00178 int CONF_modules_load_file(const char *filename, const char *appname,
00179                            unsigned long flags);
00180 void CONF_modules_unload(int all);
00181 void CONF_modules_finish(void);
00182 void CONF_modules_free(void);
00183 int CONF_module_add(const char *name, conf_init_func *ifunc,
00184                     conf_finish_func *ffunc);
00185 
00186 const char *CONF_imodule_get_name(const CONF_IMODULE *md);
00187 const char *CONF_imodule_get_value(const CONF_IMODULE *md);
00188 void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
00189 void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
00190 CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
00191 unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
00192 void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
00193 void *CONF_module_get_usr_data(CONF_MODULE *pmod);
00194 void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);
00195 
00196 char *CONF_get1_default_config_file(void);
00197 
00198 int CONF_parse_list(const char *list, int sep, int nospc,
00199         int (*list_cb)(const char *elem, int len, void *usr), void *arg);
00200 
00201 void OPENSSL_load_builtin_modules(void);
00202 
00203 /* BEGIN ERROR CODES */
00204 /* The following lines are auto generated by the script mkerr.pl. Any changes
00205  * made after this point may be overwritten when the script is next run.
00206  */
00207 void ERR_load_CONF_strings(void);
00208 
00209 /* Error codes for the CONF functions. */
00210 
00211 /* Function codes. */
00212 #define CONF_F_CONF_DUMP_FP                              104
00213 #define CONF_F_CONF_LOAD                                 100
00214 #define CONF_F_CONF_LOAD_BIO                             102
00215 #define CONF_F_CONF_LOAD_FP                              103
00216 #define CONF_F_CONF_MODULES_LOAD                         116
00217 #define CONF_F_DEF_LOAD                                  120
00218 #define CONF_F_DEF_LOAD_BIO                              121
00219 #define CONF_F_MODULE_INIT                               115
00220 #define CONF_F_MODULE_LOAD_DSO                           117
00221 #define CONF_F_MODULE_RUN                                118
00222 #define CONF_F_NCONF_DUMP_BIO                            105
00223 #define CONF_F_NCONF_DUMP_FP                             106
00224 #define CONF_F_NCONF_GET_NUMBER                          107
00225 #define CONF_F_NCONF_GET_NUMBER_E                        112
00226 #define CONF_F_NCONF_GET_SECTION                         108
00227 #define CONF_F_NCONF_GET_STRING                          109
00228 #define CONF_F_NCONF_LOAD                                113
00229 #define CONF_F_NCONF_LOAD_BIO                            110
00230 #define CONF_F_NCONF_LOAD_FP                             114
00231 #define CONF_F_NCONF_NEW                                 111
00232 #define CONF_F_STR_COPY                                  101
00233 
00234 /* Reason codes. */
00235 #define CONF_R_ERROR_LOADING_DSO                         110
00236 #define CONF_R_MISSING_CLOSE_SQUARE_BRACKET              100
00237 #define CONF_R_MISSING_EQUAL_SIGN                        101
00238 #define CONF_R_MISSING_FINISH_FUNCTION                   111
00239 #define CONF_R_MISSING_INIT_FUNCTION                     112
00240 #define CONF_R_MODULE_INITIALIZATION_ERROR               109
00241 #define CONF_R_NO_CLOSE_BRACE                            102
00242 #define CONF_R_NO_CONF                                   105
00243 #define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE           106
00244 #define CONF_R_NO_SECTION                                107
00245 #define CONF_R_NO_SUCH_FILE                              114
00246 #define CONF_R_NO_VALUE                                  108
00247 #define CONF_R_UNABLE_TO_CREATE_NEW_SECTION              103
00248 #define CONF_R_UNKNOWN_MODULE_NAME                       113
00249 #define CONF_R_VARIABLE_HAS_NO_VALUE                     104
00250 
00251 #ifdef  __cplusplus
00252 }
00253 #endif
00254 #endif
 Todo Clases Namespaces Archivos Funciones Variables 'typedefs' Enumeraciones Valores de enumeraciones Propiedades Amigas 'defines'