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