Commit d86b6915 authored by Richard Levitte's avatar Richard Levitte
Browse files

I've always wanted to make the CONF library more adaptable. Here's 

the result.

I have retained the old behavior of the CONF_* functions, and have
added a more "object oriented" interface through NCONF_* functions
(New CONF, you see :-)), working the same way as, for example, the
BIO interface.  Really, the CONF_* are rewritten so they use the
NCONF_* functions internally.

In addition to that, I've split the old conf.c code into two files,
conf_def.c and conf_api.c.  conf_def.c contains the default config
object that reads a configuration file the standard OpenSSL way, as
well as configuration file with Win32 registry file syntax (I'm not
sure I got that one right).  conf_api.c provides an API to build other
configuration file readers around (can you see a configuraion file in
XML?  I can :-)).

Finally, I've changed the name conf_lcl.h to conf_def.h, since it's
made specifically for that "class" and none others.
parent 05e15b04

crypto/conf/Makefile.ssl

+30 −14
Original line number Diff line number Diff line
@@ -22,14 +22,14 @@ TEST= 
APPS=



LIB=$(TOP)/libcrypto.a

LIBSRC= conf.c conf_err.c

LIBSRC= conf_err.c conf_lib.c conf_api.c conf_def.c



LIBOBJ=	conf.o conf_err.o

LIBOBJ=	conf_err.o conf_lib.o conf_api.o conf_def.o



SRC= $(LIBSRC)



EXHEADER= conf.h

HEADER=	conf_lcl.h $(EXHEADER)

EXHEADER= conf.h conf_api.h

HEADER=	conf_def.h $(EXHEADER)



ALL=    $(GENERAL) $(SRC) $(HEADER)
@@ -79,14 +79,30 @@ clean: 


# DO NOT DELETE THIS LINE -- make depend depends on it.



conf.o: ../../include/openssl/bio.h ../../include/openssl/buffer.h

conf.o: ../../include/openssl/conf.h ../../include/openssl/crypto.h

conf.o: ../../include/openssl/e_os.h ../../include/openssl/e_os2.h

conf.o: ../../include/openssl/err.h ../../include/openssl/lhash.h

conf.o: ../../include/openssl/opensslconf.h ../../include/openssl/opensslv.h

conf.o: ../../include/openssl/safestack.h ../../include/openssl/stack.h

conf.o: ../cryptlib.h conf_lcl.h

conf_api.o: ../../include/openssl/bio.h ../../include/openssl/conf.h

conf_api.o: ../../include/openssl/conf_api.h ../../include/openssl/crypto.h

conf_api.o: ../../include/openssl/e_os.h ../../include/openssl/e_os2.h

conf_api.o: ../../include/openssl/lhash.h ../../include/openssl/opensslconf.h

conf_api.o: ../../include/openssl/opensslv.h ../../include/openssl/safestack.h

conf_api.o: ../../include/openssl/stack.h

conf_def.o: ../../include/openssl/bio.h ../../include/openssl/buffer.h

conf_def.o: ../../include/openssl/conf.h ../../include/openssl/conf_api.h

conf_def.o: ../../include/openssl/crypto.h ../../include/openssl/e_os.h

conf_def.o: ../../include/openssl/e_os.h ../../include/openssl/e_os2.h

conf_def.o: ../../include/openssl/err.h ../../include/openssl/lhash.h

conf_def.o: ../../include/openssl/opensslconf.h

conf_def.o: ../../include/openssl/opensslv.h ../../include/openssl/safestack.h

conf_def.o: ../../include/openssl/stack.h ../cryptlib.h conf_def.h

conf_err.o: ../../include/openssl/bio.h ../../include/openssl/conf.h

conf_err.o: ../../include/openssl/crypto.h ../../include/openssl/err.h

conf_err.o: ../../include/openssl/lhash.h ../../include/openssl/opensslv.h

conf_err.o: ../../include/openssl/safestack.h ../../include/openssl/stack.h
 
conf_err.o: ../../include/openssl/crypto.h ../../include/openssl/e_os.h

conf_err.o: ../../include/openssl/e_os2.h ../../include/openssl/err.h

conf_err.o: ../../include/openssl/lhash.h ../../include/openssl/opensslconf.h

conf_err.o: ../../include/openssl/opensslv.h ../../include/openssl/safestack.h

conf_err.o: ../../include/openssl/stack.h

conf_lib.o: ../../include/openssl/bio.h ../../include/openssl/conf.h

conf_lib.o: ../../include/openssl/conf_api.h ../../include/openssl/crypto.h

conf_lib.o: ../../include/openssl/e_os.h ../../include/openssl/e_os2.h

conf_lib.o: ../../include/openssl/err.h ../../include/openssl/lhash.h

conf_lib.o: ../../include/openssl/opensslconf.h

conf_lib.o: ../../include/openssl/opensslv.h ../../include/openssl/safestack.h

conf_lib.o: ../../include/openssl/stack.h

crypto/conf/conf.h

+62 −0
Original line number Diff line number Diff line
@@ -67,6 +67,7 @@ extern "C" { 
#include <openssl/lhash.h>

#include <openssl/stack.h>

#include <openssl/safestack.h>

#include <openssl/e_os.h>



typedef struct

	{
@@ -77,6 +78,25 @@ typedef struct 


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 *(MS_FAR *create)(CONF_METHOD *meth);

	int (MS_FAR *init)(CONF *conf);

	int (MS_FAR *destroy)(CONF *conf);

	int (MS_FAR *destroy_data)(CONF *conf);

	int (MS_FAR *load)(CONF *conf, BIO *bp, long *eline);

	int (MS_FAR *dump)(CONF *conf, BIO *bp);

	int (MS_FAR *is_number)(CONF *conf, char c);

	int (MS_FAR *to_int)(CONF *conf, char c);

	};



int CONF_set_default_method(CONF_METHOD *meth);

LHASH *CONF_load(LHASH *conf,const char *file,long *eline);

#ifndef NO_FP_API

LHASH *CONF_load_fp(LHASH *conf, FILE *fp,long *eline);
@@ -86,8 +106,41 @@ 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);

void CONF_dump(LHASH *conf, BIO *out);

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

long NCONF_get_number(CONF *conf,char *group,char *name);

int NCONF_dump_fp(CONF *conf, FILE *out);

int NCONF_dump_bio(CONF *conf, BIO *out);





/* BEGIN ERROR CODES */

/* The following lines are auto generated by the script mkerr.pl. Any changes
@@ -97,15 +150,24 @@ 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_NCONF_DUMP_BIO				 105

#define CONF_F_NCONF_DUMP_FP				 106

#define CONF_F_NCONF_GET_NUMBER				 107

#define CONF_F_NCONF_GET_SECTION			 108

#define CONF_F_NCONF_GET_STRING				 109

#define CONF_F_NCONF_LOAD_BIO				 110

#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_UNABLE_TO_CREATE_NEW_SECTION		 103

#define CONF_R_VARIABLE_HAS_NO_VALUE			 104

crypto/conf/conf_api.c

0 → 100644
+288 −0
Original line number Diff line number Diff line 
/* conf_api.c */

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

 */



/* Part of the code in here was originally in conf.c, which is now removed */



#include <openssl/conf.h>

#include <openssl/conf_api.h>



static void value_free_hash(CONF_VALUE *a, LHASH *conf);

static void value_free_stack(CONF_VALUE *a,LHASH *conf);

static unsigned long hash(CONF_VALUE *v);

static int cmp_conf(CONF_VALUE *a,CONF_VALUE *b);



/* This was get_section */

CONF_VALUE *_CONF_get_section(CONF *conf, char *section)

	{

	CONF_VALUE *v,vv;



	if ((conf == NULL) || (section == NULL)) return(NULL);

	vv.name=NULL;

	vv.section=section;

	v=(CONF_VALUE *)lh_retrieve(conf->data,&vv);

	return(v);

	}



/* This was CONF_get_section */

STACK_OF(CONF_VALUE) *_CONF_get_section_values(CONF *conf, char *section)

	{

	CONF_VALUE *v;



	v=_CONF_get_section(conf,section);

	if (v != NULL)

		return((STACK_OF(CONF_VALUE) *)v->value);

	else

		return(NULL);

	}



int _CONF_add_string(CONF *conf, CONF_VALUE *section, CONF_VALUE *value)

	{

	CONF_VALUE *v = NULL;

	STACK_OF(CONF_VALUE) *ts;



	ts = (STACK_OF(CONF_VALUE) *)section->value;



	value->section=section->section;	

	if (!sk_CONF_VALUE_push(ts,value))

		{

		return 0;

		}



	v = (CONF_VALUE *)lh_insert(conf->data, value);

	if (v != NULL)

		{

		sk_CONF_VALUE_delete_ptr(ts,v);

		Free(v->name);

		Free(v->value);

		Free(v);

		}

	return 1;

	}



char *_CONF_get_string(CONF *conf, char *section, char *name)

	{

	CONF_VALUE *v,vv;

	char *p;



	if (name == NULL) return(NULL);

	if (conf != NULL)

		{

		if (section != NULL)

			{

			vv.name=name;

			vv.section=section;

			v=(CONF_VALUE *)lh_retrieve(conf->data,&vv);

			if (v != NULL) return(v->value);

			if (strcmp(section,"ENV") == 0)

				{

				p=Getenv(name);

				if (p != NULL) return(p);

				}

			}

		vv.section="default";

		vv.name=name;

		v=(CONF_VALUE *)lh_retrieve(conf->data,&vv);

		if (v != NULL)

			return(v->value);

		else

			return(NULL);

		}

	else

		return(Getenv(name));

	}



long _CONF_get_number(CONF *conf, char *section, char *name)

	{

	char *str;

	long ret=0;



	str=_CONF_get_string(conf,section,name);

	if (str == NULL) return(0);

	for (;;)

		{

		if (conf->meth->is_number(conf, *str))

			ret=ret*10+conf->meth->to_int(conf, *str);

		else

			return(ret);

		str++;

		}

	}



int _CONF_new_data(CONF *conf)

	{

	if (conf == NULL)

		{

		return 0;

		}

	if (conf->data == NULL)

		if ((conf->data = lh_new(hash,cmp_conf)) == NULL)

			{

			return 0;

			}

	return 1;

	}



void _CONF_free_data(CONF *conf)

	{

	if (conf == NULL || conf->data == NULL) return;



	conf->data->down_load=0; /* evil thing to make sure the 'Free()'

				  * works as expected */

	lh_doall_arg(conf->data,(void (*)())value_free_hash,conf->data);



	/* We now have only 'section' entries in the hash table.

	 * Due to problems with */



	lh_doall_arg(conf->data,(void (*)())value_free_stack,conf->data);

	lh_free(conf->data);

	}



static void value_free_hash(CONF_VALUE *a, LHASH *conf)

	{

	if (a->name != NULL)

		{

		a=(CONF_VALUE *)lh_delete(conf,a);

		}

	}



static void value_free_stack(CONF_VALUE *a, LHASH *conf)

	{

	CONF_VALUE *vv;

	STACK *sk;

	int i;



	if (a->name != NULL) return;



	sk=(STACK *)a->value;

	for (i=sk_num(sk)-1; i>=0; i--)

		{

		vv=(CONF_VALUE *)sk_value(sk,i);

		Free(vv->value);

		Free(vv->name);

		Free(vv);

		}

	if (sk != NULL) sk_free(sk);

	Free(a->section);

	Free(a);

	}



static unsigned long hash(CONF_VALUE *v)

	{

	return((lh_strhash(v->section)<<2)^lh_strhash(v->name));

	}



static int cmp_conf(CONF_VALUE *a, CONF_VALUE *b)

	{

	int i;



	if (a->section != b->section)

		{

		i=strcmp(a->section,b->section);

		if (i) return(i);

		}



	if ((a->name != NULL) && (b->name != NULL))

		{

		i=strcmp(a->name,b->name);

		return(i);

		}

	else if (a->name == b->name)

		return(0);

	else

		return((a->name == NULL)?-1:1);

	}



/* This was new_section */

CONF_VALUE *_CONF_new_section(CONF *conf, char *section)

	{

	STACK *sk=NULL;

	int ok=0,i;

	CONF_VALUE *v=NULL,*vv;



	if ((sk=sk_new_null()) == NULL)

		goto err;

	if ((v=(CONF_VALUE *)Malloc(sizeof(CONF_VALUE))) == NULL)

		goto err;

	i=strlen(section)+1;

	if ((v->section=(char *)Malloc(i)) == NULL)

		goto err;



	memcpy(v->section,section,i);

	v->name=NULL;

	v->value=(char *)sk;

	

	vv=(CONF_VALUE *)lh_insert(conf->data,v);

	if (vv != NULL)

		{

#if !defined(NO_STDIO) && !defined(WIN16)

		fprintf(stderr,"internal fault\n");

#endif

		abort();

		}

	ok=1;

err:

	if (!ok)

		{

		if (sk != NULL) sk_free(sk);

		if (v != NULL) Free(v);

		v=NULL;

		}

	return(v);

	}



IMPLEMENT_STACK_OF(CONF_VALUE)

crypto/conf/conf_api.h

0 → 100644
+88 −0
Original line number Diff line number Diff line 
/* conf_api.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_API_H

#define HEADER_CONF_API_H



#ifdef  __cplusplus

extern "C" {

#endif



#include <openssl/lhash.h>

#include <openssl/conf.h>



/* This was new_section */

CONF_VALUE *_CONF_new_section(CONF *conf, char *section);

/* This was get_section */

CONF_VALUE *_CONF_get_section(CONF *conf, char *section);

/* This was CONF_get_section */

STACK_OF(CONF_VALUE) *_CONF_get_section_values(CONF *conf, char *section);



STACK_OF(CONF_VALUE) *_CONF_get_section_values(CONF *conf, char *section);

int _CONF_add_string(CONF *conf, CONF_VALUE *section, CONF_VALUE *value);

char *_CONF_get_string(CONF *conf, char *section, char *name);

long _CONF_get_number(CONF *conf, char *section, char *name);



int _CONF_new_data(CONF *conf);

void _CONF_free_data(CONF *conf);



#ifdef  __cplusplus

}

#endif

#endif

crypto/conf/conf.c→crypto/conf/conf_def.c

+245 −273

File changed and moved.

Preview size limit exceeded, changes collapsed.