[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)

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)(CONF *conf, BIO *bp);
	int (*is_number)(CONF *conf, char c);
	int (*to_int)(CONF *conf, char c);
	int (*load)(CONF *conf, const char *name, long *eline);
	};

int CONF_set_default_method(CONF_METHOD *meth);
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,char *section);
char *CONF_get_string(LHASH *conf,char *group,char *name);
long CONF_get_number(LHASH *conf,char *group,char *name);
void CONF_free(LHASH *conf);
int CONF_dump_fp(LHASH *conf, FILE *out);
int CONF_dump_bio(LHASH *conf, BIO *out);
void ERR_load_CONF_strings(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(CONF *conf,char *section);
char *NCONF_get_string(CONF *conf,char *group,char *name);
int NCONF_get_number_e(CONF *conf,char *group,char *name,long *result);
int NCONF_dump_fp(CONF *conf, FILE *out);
int NCONF_dump_bio(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


/* 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.
 */

/* 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_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_MISSING_CLOSE_SQUARE_BRACKET		 100
#define CONF_R_MISSING_EQUAL_SIGN			 101
#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_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)
d02b48c6	80
d86b6915 RL	81	struct conf_st;
	82	typedef struct conf_st CONF;
	83	struct conf_method_st;
	84	typedef struct conf_method_st CONF_METHOD;
	85
	86	struct conf_method_st
	87	{
	88	const char *name;
4270144b RL	89	CONF (create)(CONF_METHOD *meth);
	90	int (init)(CONF conf);
	91	int (destroy)(CONF conf);
	92	int (destroy_data)(CONF conf);
	93	int (load_bio)(CONF conf, BIO bp, long eline);
	94	int (dump)(CONF conf, BIO *bp);
	95	int (is_number)(CONF conf, char c);
	96	int (to_int)(CONF conf, char c);
	97	int (load)(CONF conf, const char name, long eline);
d86b6915 RL	98	};
	99
	100	int CONF_set_default_method(CONF_METHOD *meth);
8623f693	101	LHASH CONF_load(LHASH conf,const char file,long eline);
cf1b7d96	102	#ifndef OPENSSL_NO_FP_API
8623f693	103	LHASH CONF_load_fp(LHASH conf, FILE fp,long eline);
53b1899e	104	#endif
8623f693	105	LHASH CONF_load_bio(LHASH conf, BIO bp,long eline);
ba404b5e	106	STACK_OF(CONF_VALUE) CONF_get_section(LHASH conf,char *section);
d02b48c6 RE	107	char CONF_get_string(LHASH conf,char group,char name);
	108	long CONF_get_number(LHASH conf,char group,char *name);
	109	void CONF_free(LHASH *conf);
d86b6915 RL	110	int CONF_dump_fp(LHASH conf, FILE out);
d86b6915 RL	111	int CONF_dump_bio(LHASH conf, BIO out);
d02b48c6 RE	112	void ERR_load_CONF_strings(void );
d02b48c6 RE	113
d86b6915 RL	114	/* New conf code. The semantics are different from the functions above.
	115	If that wasn't the case, the above functions would have been replaced */
	116
	117	struct conf_st
	118	{
	119	CONF_METHOD *meth;
	120	void *meth_data;
	121	LHASH *data;
	122	};
	123
	124	CONF NCONF_new(CONF_METHOD meth);
	125	CONF_METHOD *NCONF_default();
	126	CONF_METHOD *NCONF_WIN32();
	127	#if 0 /* Just to give you an idea of what I have in mind */
	128	CONF_METHOD *NCONF_XML();
	129	#endif
	130	void NCONF_free(CONF *conf);
	131	void NCONF_free_data(CONF *conf);
	132
	133	int NCONF_load(CONF conf,const char file,long *eline);
cf1b7d96	134	#ifndef OPENSSL_NO_FP_API
d86b6915 RL	135	int NCONF_load_fp(CONF conf, FILE fp,long *eline);
	136	#endif
	137	int NCONF_load_bio(CONF conf, BIO bp,long *eline);
	138	STACK_OF(CONF_VALUE) NCONF_get_section(CONF conf,char *section);
	139	char NCONF_get_string(CONF conf,char group,char name);
c6f1787b	140	int NCONF_get_number_e(CONF conf,char group,char name,long result);
d86b6915 RL	141	int NCONF_dump_fp(CONF conf, FILE out);
	142	int NCONF_dump_bio(CONF conf, BIO out);
	143
c6f1787b RL	144	#if 0 /* The following function has no error checking,
	145	and should therefore be avoided */
	146	long NCONF_get_number(CONF conf,char group,char *name);
	147	#else
	148	#define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r);
	149	#endif
	150
ba404b5e	151
d02b48c6	152	/* BEGIN ERROR CODES */
6d311938 DSH	153	/* The following lines are auto generated by the script mkerr.pl. Any changes
	154	* made after this point may be overwritten when the script is next run.
	155	*/
	156
d02b48c6 RE	157	/* Error codes for the CONF functions. */
	158
	159	/* Function codes. */
d86b6915	160	#define CONF_F_CONF_DUMP_FP 104
d02b48c6	161	#define CONF_F_CONF_LOAD 100
8623f693 DSH	162	#define CONF_F_CONF_LOAD_BIO 102
8623f693 DSH	163	#define CONF_F_CONF_LOAD_FP 103
d86b6915 RL	164	#define CONF_F_NCONF_DUMP_BIO 105
	165	#define CONF_F_NCONF_DUMP_FP 106
	166	#define CONF_F_NCONF_GET_NUMBER 107
c6f1787b	167	#define CONF_F_NCONF_GET_NUMBER_E 112
d86b6915 RL	168	#define CONF_F_NCONF_GET_SECTION 108
d86b6915 RL	169	#define CONF_F_NCONF_GET_STRING 109
befb3e7a	170	#define CONF_F_NCONF_LOAD 113
d86b6915	171	#define CONF_F_NCONF_LOAD_BIO 110
befb3e7a	172	#define CONF_F_NCONF_LOAD_FP 114
d86b6915	173	#define CONF_F_NCONF_NEW 111
d02b48c6 RE	174	#define CONF_F_STR_COPY 101
	175
	176	/* Reason codes. */
	177	#define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100
	178	#define CONF_R_MISSING_EQUAL_SIGN 101
	179	#define CONF_R_NO_CLOSE_BRACE 102
d86b6915	180	#define CONF_R_NO_CONF 105
cde70093 RL	181	#define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106
cde70093 RL	182	#define CONF_R_NO_SECTION 107
c6f1787b	183	#define CONF_R_NO_VALUE 108
d02b48c6 RE	184	#define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103
d02b48c6 RE	185	#define CONF_R_VARIABLE_HAS_NO_VALUE 104
6d311938	186
d02b48c6 RE	187	#ifdef __cplusplus
	188	}
	189	#endif
	190	#endif
	191