[thirdparty/openssl.git] / crypto / conf / conf.h

/* crypto/conf/conf.h */
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
 *
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
 * 
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
 * 
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from 
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
 * 
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * 
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */

#ifndef  HEADER_CONF_H
#define HEADER_CONF_H

#include <openssl/bio.h>
#include <openssl/lhash.h>
#include <openssl/stack.h>
#include <openssl/safestack.h>
#include <openssl/e_os2.h>

#ifdef  __cplusplus
extern "C" {
#endif

typedef struct
	{
	char *section;
	char *name;
	char *value;
	} CONF_VALUE;

DECLARE_STACK_OF(CONF_VALUE)
DECLARE_STACK_OF(CONF_MODULE)
DECLARE_STACK_OF(CONF_IMODULE)

struct conf_st;
typedef struct conf_st CONF;
struct conf_method_st;
typedef struct conf_method_st CONF_METHOD;

struct conf_method_st
	{
	const char *name;
	CONF *(*create)(CONF_METHOD *meth);
	int (*init)(CONF *conf);
	int (*destroy)(CONF *conf);
	int (*destroy_data)(CONF *conf);
	int (*load_bio)(CONF *conf, BIO *bp, long *eline);
	int (*dump)(const CONF *conf, BIO *bp);
	int (*is_number)(const CONF *conf, char c);
	int (*to_int)(const CONF *conf, char c);
	int (*load)(CONF *conf, const char *name, long *eline);
	};

/* Module definitions */

typedef struct conf_imodule_st CONF_IMODULE;
typedef struct conf_module_st CONF_MODULE;

/* DSO module function typedefs */
typedef int conf_init_func(CONF_IMODULE *md, const CONF *cnf);
typedef void conf_finish_func(CONF_IMODULE *md);

#define	CONF_MFLAGS_IGNORE_ERRORS	0x1
#define CONF_MFLAGS_IGNORE_RETURN_CODES	0x2
#define CONF_MFLAGS_SILENT		0x4
#define CONF_MFLAGS_NO_DSO		0x8

int CONF_set_default_method(CONF_METHOD *meth);
void CONF_set_nconf(CONF *conf,LHASH *hash);
LHASH *CONF_load(LHASH *conf,const char *file,long *eline);
#ifndef OPENSSL_NO_FP_API
LHASH *CONF_load_fp(LHASH *conf, FILE *fp,long *eline);
#endif
LHASH *CONF_load_bio(LHASH *conf, BIO *bp,long *eline);
STACK_OF(CONF_VALUE) *CONF_get_section(LHASH *conf,const char *section);
char *CONF_get_string(LHASH *conf,const char *group,const char *name);
long CONF_get_number(LHASH *conf,const char *group,const char *name);
void CONF_free(LHASH *conf);
int CONF_dump_fp(LHASH *conf, FILE *out);
int CONF_dump_bio(LHASH *conf, BIO *out);

void OPENSSL_config(void);

/* New conf code.  The semantics are different from the functions above.
   If that wasn't the case, the above functions would have been replaced */

struct conf_st
	{
	CONF_METHOD *meth;
	void *meth_data;
	LHASH *data;
	};

CONF *NCONF_new(CONF_METHOD *meth);
CONF_METHOD *NCONF_default();
CONF_METHOD *NCONF_WIN32();
#if 0 /* Just to give you an idea of what I have in mind */
CONF_METHOD *NCONF_XML();
#endif
void NCONF_free(CONF *conf);
void NCONF_free_data(CONF *conf);

int NCONF_load(CONF *conf,const char *file,long *eline);
#ifndef OPENSSL_NO_FP_API
int NCONF_load_fp(CONF *conf, FILE *fp,long *eline);
#endif
int NCONF_load_bio(CONF *conf, BIO *bp,long *eline);
STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,const char *section);
char *NCONF_get_string(const CONF *conf,const char *group,const char *name);
int NCONF_get_number_e(const CONF *conf,const char *group,const char *name,
		       long *result);
int NCONF_dump_fp(const CONF *conf, FILE *out);
int NCONF_dump_bio(const CONF *conf, BIO *out);

#if 0 /* The following function has no error checking,
	 and should therefore be avoided */
long NCONF_get_number(CONF *conf,char *group,char *name);
#else
#define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
#endif
  
/* Module functions */

int CONF_modules_load(const CONF *cnf, const char *appname,
		      unsigned long flags);
int CONF_modules_load_file(const char *filename, const char *appname,
			   unsigned long flags);
void CONF_modules_unload(int all);
void CONF_modules_finish(void);
int CONF_module_add(const char *name, conf_init_func *ifunc,
		    conf_finish_func *ffunc);

const char *CONF_imodule_get_name(const CONF_IMODULE *md);
const char *CONF_imodule_get_value(const CONF_IMODULE *md);
void *CONF_imodule_get_usr_data(const CONF_IMODULE *md);
void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data);
CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md);
unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
void *CONF_module_get_usr_data(CONF_MODULE *pmod);
void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data);

/* BEGIN ERROR CODES */
/* The following lines are auto generated by the script mkerr.pl. Any changes
 * made after this point may be overwritten when the script is next run.
 */
void ERR_load_CONF_strings(void);
/* Error codes for the CONF functions. */

/* Function codes. */
#define CONF_F_CONF_DUMP_FP				 104
#define CONF_F_CONF_LOAD				 100
#define CONF_F_CONF_LOAD_BIO				 102
#define CONF_F_CONF_LOAD_FP				 103
#define CONF_F_CONF_MODULES_LOAD			 116
#define CONF_F_MODULE_INIT				 115
#define CONF_F_MODULE_LOAD_DSO				 117
#define CONF_F_MODULE_RUN				 118
#define CONF_F_NCONF_DUMP_BIO				 105
#define CONF_F_NCONF_DUMP_FP				 106
#define CONF_F_NCONF_GET_NUMBER				 107
#define CONF_F_NCONF_GET_NUMBER_E			 112
#define CONF_F_NCONF_GET_SECTION			 108
#define CONF_F_NCONF_GET_STRING				 109
#define CONF_F_NCONF_LOAD				 113
#define CONF_F_NCONF_LOAD_BIO				 110
#define CONF_F_NCONF_LOAD_FP				 114
#define CONF_F_NCONF_NEW				 111
#define CONF_F_STR_COPY					 101

/* Reason codes. */
#define CONF_R_ERROR_LOADING_DSO			 110
#define CONF_R_MISSING_CLOSE_SQUARE_BRACKET		 100
#define CONF_R_MISSING_EQUAL_SIGN			 101
#define CONF_R_MISSING_FINISH_FUNCTION			 111
#define CONF_R_MISSING_INIT_FUNCTION			 112
#define CONF_R_MODULE_INITIALIZATION_ERROR		 109
#define CONF_R_NO_CLOSE_BRACE				 102
#define CONF_R_NO_CONF					 105
#define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE		 106
#define CONF_R_NO_SECTION				 107
#define CONF_R_NO_VALUE					 108
#define CONF_R_UNABLE_TO_CREATE_NEW_SECTION		 103
#define CONF_R_UNKNOWN_MODULE_NAME			 113
#define CONF_R_VARIABLE_HAS_NO_VALUE			 104

#ifdef  __cplusplus
}
#endif
#endif
Commit	Line	Data
d02b48c6	1	/* crypto/conf/conf.h */
58964a49	2	/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6 RE	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
8623f693	62	#include <openssl/bio.h>
ec577822	63	#include <openssl/lhash.h>
8623f693	64	#include <openssl/stack.h>
ba404b5e	65	#include <openssl/safestack.h>
c38171ba	66	#include <openssl/e_os2.h>
d02b48c6	67
82271cee RL	68	#ifdef __cplusplus
	69	extern "C" {
	70	#endif
	71
d02b48c6 RE	72	typedef struct
	73	{
	74	char *section;
	75	char *name;
	76	char *value;
	77	} CONF_VALUE;
	78
ba404b5e	79	DECLARE_STACK_OF(CONF_VALUE)
bc37d996 DSH	80	DECLARE_STACK_OF(CONF_MODULE)
bc37d996 DSH	81	DECLARE_STACK_OF(CONF_IMODULE)
d02b48c6	82
d86b6915 RL	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;
4270144b RL	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);
9dd5ae65 BL	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);
4270144b	99	int (load)(CONF conf, const char name, long eline);
d86b6915 RL	100	};
d86b6915 RL	101
bc37d996 DSH	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 */
9dd5ae65	108	typedef int conf_init_func(CONF_IMODULE md, const CONF cnf);
bc37d996 DSH	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
d86b6915	116	int CONF_set_default_method(CONF_METHOD *meth);
b7a26e6d	117	void CONF_set_nconf(CONF conf,LHASH hash);
8623f693	118	LHASH CONF_load(LHASH conf,const char file,long eline);
cf1b7d96	119	#ifndef OPENSSL_NO_FP_API
8623f693	120	LHASH CONF_load_fp(LHASH conf, FILE fp,long eline);
53b1899e	121	#endif
8623f693	122	LHASH CONF_load_bio(LHASH conf, BIO bp,long eline);
9dd5ae65 BL	123	STACK_OF(CONF_VALUE) CONF_get_section(LHASH conf,const char *section);
	124	char CONF_get_string(LHASH conf,const char group,const char name);
	125	long CONF_get_number(LHASH conf,const char group,const char *name);
d02b48c6	126	void CONF_free(LHASH *conf);
d86b6915 RL	127	int CONF_dump_fp(LHASH conf, FILE out);
d86b6915 RL	128	int CONF_dump_bio(LHASH conf, BIO out);
d02b48c6	129
cca28b29 BL	130	void OPENSSL_config(void);
cca28b29 BL	131
d86b6915 RL	132	/* New conf code. The semantics are different from the functions above.
	133	If that wasn't the case, the above functions would have been replaced */
	134
	135	struct conf_st
	136	{
	137	CONF_METHOD *meth;
	138	void *meth_data;
	139	LHASH *data;
	140	};
	141
	142	CONF NCONF_new(CONF_METHOD meth);
	143	CONF_METHOD *NCONF_default();
	144	CONF_METHOD *NCONF_WIN32();
	145	#if 0 /* Just to give you an idea of what I have in mind */
	146	CONF_METHOD *NCONF_XML();
	147	#endif
	148	void NCONF_free(CONF *conf);
	149	void NCONF_free_data(CONF *conf);
	150
	151	int NCONF_load(CONF conf,const char file,long *eline);
cf1b7d96	152	#ifndef OPENSSL_NO_FP_API
d86b6915 RL	153	int NCONF_load_fp(CONF conf, FILE fp,long *eline);
	154	#endif
	155	int NCONF_load_bio(CONF conf, BIO bp,long *eline);
9dd5ae65 BL	156	STACK_OF(CONF_VALUE) NCONF_get_section(const CONF conf,const char *section);
	157	char NCONF_get_string(const CONF conf,const char group,const char name);
	158	int NCONF_get_number_e(const CONF conf,const char group,const char *name,
	159	long *result);
	160	int NCONF_dump_fp(const CONF conf, FILE out);
	161	int NCONF_dump_bio(const CONF conf, BIO out);
d86b6915	162
c6f1787b RL	163	#if 0 /* The following function has no error checking,
	164	and should therefore be avoided */
	165	long NCONF_get_number(CONF conf,char group,char *name);
	166	#else
b7a26e6d	167	#define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r)
c6f1787b	168	#endif
bc37d996 DSH	169
	170	/* Module functions */
	171
9dd5ae65 BL	172	int CONF_modules_load(const CONF cnf, const char appname,
	173	unsigned long flags);
	174	int CONF_modules_load_file(const char filename, const char appname,
	175	unsigned long flags);
bc37d996 DSH	176	void CONF_modules_unload(int all);
bc37d996 DSH	177	void CONF_modules_finish(void);
cca28b29 BL	178	int CONF_module_add(const char name, conf_init_func ifunc,
cca28b29 BL	179	conf_finish_func *ffunc);
bc37d996	180
9dd5ae65 BL	181	const char CONF_imodule_get_name(const CONF_IMODULE md);
	182	const char CONF_imodule_get_value(const CONF_IMODULE md);
	183	void CONF_imodule_get_usr_data(const CONF_IMODULE md);
bc37d996	184	void CONF_imodule_set_usr_data(CONF_IMODULE md, void usr_data);
9dd5ae65 BL	185	CONF_MODULE CONF_imodule_get_module(const CONF_IMODULE md);
9dd5ae65 BL	186	unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md);
bc37d996 DSH	187	void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags);
	188	void CONF_module_get_usr_data(CONF_MODULE pmod);
	189	void CONF_module_set_usr_data(CONF_MODULE pmod, void usr_data);
ba404b5e	190
d02b48c6	191	/* BEGIN ERROR CODES */
6d311938 DSH	192	/* The following lines are auto generated by the script mkerr.pl. Any changes
	193	* made after this point may be overwritten when the script is next run.
	194	*/
b476df64	195	void ERR_load_CONF_strings(void);
d02b48c6 RE	196	/* Error codes for the CONF functions. */
	197
	198	/* Function codes. */
d86b6915	199	#define CONF_F_CONF_DUMP_FP 104
d02b48c6	200	#define CONF_F_CONF_LOAD 100
8623f693 DSH	201	#define CONF_F_CONF_LOAD_BIO 102
8623f693 DSH	202	#define CONF_F_CONF_LOAD_FP 103
bc37d996 DSH	203	#define CONF_F_CONF_MODULES_LOAD 116
	204	#define CONF_F_MODULE_INIT 115
	205	#define CONF_F_MODULE_LOAD_DSO 117
	206	#define CONF_F_MODULE_RUN 118
d86b6915 RL	207	#define CONF_F_NCONF_DUMP_BIO 105
	208	#define CONF_F_NCONF_DUMP_FP 106
	209	#define CONF_F_NCONF_GET_NUMBER 107
c6f1787b	210	#define CONF_F_NCONF_GET_NUMBER_E 112
d86b6915 RL	211	#define CONF_F_NCONF_GET_SECTION 108
d86b6915 RL	212	#define CONF_F_NCONF_GET_STRING 109
befb3e7a	213	#define CONF_F_NCONF_LOAD 113
d86b6915	214	#define CONF_F_NCONF_LOAD_BIO 110
befb3e7a	215	#define CONF_F_NCONF_LOAD_FP 114
d86b6915	216	#define CONF_F_NCONF_NEW 111
d02b48c6 RE	217	#define CONF_F_STR_COPY 101
	218
	219	/* Reason codes. */
bc37d996	220	#define CONF_R_ERROR_LOADING_DSO 110
d02b48c6 RE	221	#define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100
d02b48c6 RE	222	#define CONF_R_MISSING_EQUAL_SIGN 101
bc37d996 DSH	223	#define CONF_R_MISSING_FINISH_FUNCTION 111
	224	#define CONF_R_MISSING_INIT_FUNCTION 112
	225	#define CONF_R_MODULE_INITIALIZATION_ERROR 109
d02b48c6	226	#define CONF_R_NO_CLOSE_BRACE 102
d86b6915	227	#define CONF_R_NO_CONF 105
cde70093 RL	228	#define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106
cde70093 RL	229	#define CONF_R_NO_SECTION 107
c6f1787b	230	#define CONF_R_NO_VALUE 108
d02b48c6	231	#define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103
bc37d996	232	#define CONF_R_UNKNOWN_MODULE_NAME 113
d02b48c6	233	#define CONF_R_VARIABLE_HAS_NO_VALUE 104
6d311938	234
d02b48c6 RE	235	#ifdef __cplusplus
	236	}
	237	#endif
	238	#endif