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

/* crypto/crypto.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_CRYPTO_H
#define HEADER_CRYPTO_H

#include <stdlib.h>

#ifndef NO_FP_API
#include <stdio.h>
#endif

#include <openssl/stack.h>
#include <openssl/safestack.h>
#include <openssl/opensslv.h>

#ifdef CHARSET_EBCDIC
#include <openssl/ebcdic.h>
#endif

/* Resolve problems on some operating systems with symbol names that clash
   one way or another */
#include <openssl/symhacks.h>

#ifdef  __cplusplus
extern "C" {
#endif

/* Backward compatibility to SSLeay */
/* This is more to be used to check the correct DLL is being used
 * in the MS world. */
#define SSLEAY_VERSION_NUMBER	OPENSSL_VERSION_NUMBER
#define SSLEAY_VERSION		0
/* #define SSLEAY_OPTIONS	1 no longer supported */
#define SSLEAY_CFLAGS		2
#define SSLEAY_BUILT_ON		3
#define SSLEAY_PLATFORM		4
#define SSLEAY_DIR		5

/* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
 * names in cryptlib.c
 */

#define	CRYPTO_LOCK_ERR			1
#define	CRYPTO_LOCK_ERR_HASH		2
#define	CRYPTO_LOCK_X509		3
#define	CRYPTO_LOCK_X509_INFO		4
#define	CRYPTO_LOCK_X509_PKEY		5
#define CRYPTO_LOCK_X509_CRL		6
#define CRYPTO_LOCK_X509_REQ		7
#define CRYPTO_LOCK_DSA			8
#define CRYPTO_LOCK_RSA			9
#define CRYPTO_LOCK_EVP_PKEY		10
#define	CRYPTO_LOCK_X509_STORE		11
#define	CRYPTO_LOCK_SSL_CTX		12
#define	CRYPTO_LOCK_SSL_CERT		13
#define	CRYPTO_LOCK_SSL_SESSION		14
#define	CRYPTO_LOCK_SSL_SESS_CERT	15
#define	CRYPTO_LOCK_SSL			16
#define	CRYPTO_LOCK_RAND		17
#define	CRYPTO_LOCK_MALLOC		18
#define	CRYPTO_LOCK_BIO			19
#define	CRYPTO_LOCK_GETHOSTBYNAME	20
#define	CRYPTO_LOCK_GETSERVBYNAME	21
#define	CRYPTO_LOCK_READDIR		22
#define	CRYPTO_LOCK_RSA_BLINDING	23
#define	CRYPTO_LOCK_DH			24
#define	CRYPTO_LOCK_MALLOC2		25
#define	CRYPTO_LOCK_DSO			26
#define	CRYPTO_LOCK_DYNLOCK		27
#define	CRYPTO_LOCK_ENGINE		28
#define	CRYPTO_NUM_LOCKS		29

#define CRYPTO_LOCK		1
#define CRYPTO_UNLOCK		2
#define CRYPTO_READ		4
#define CRYPTO_WRITE		8

#ifndef NO_LOCKING
#ifndef CRYPTO_w_lock
#define CRYPTO_w_lock(type)	\
	CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
#define CRYPTO_w_unlock(type)	\
	CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
#define CRYPTO_r_lock(type)	\
	CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
#define CRYPTO_r_unlock(type)	\
	CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
#define CRYPTO_add(addr,amount,type)	\
	CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
#endif
#else
#define CRYPTO_w_lock(a)
#define	CRYPTO_w_unlock(a)
#define CRYPTO_r_lock(a)
#define CRYPTO_r_unlock(a)
#define CRYPTO_add(a,b,c)	((*(a))+=(b))
#endif

/* Some applications as well as some parts of OpenSSL need to allocate
   and deallocate locks in a dynamic fashion.  The following typedef
   makes this possible in a type-safe manner.  */
/* struct CRYPTO_dynlock_value has to be defined by the application. */
typedef struct
	{
	int references;
	struct CRYPTO_dynlock_value *data;
	} CRYPTO_dynlock;


/* The following can be used to detect memory leaks in the SSLeay library.
 * It used, it turns on malloc checking */

#define CRYPTO_MEM_CHECK_OFF	0x0	/* an enume */
#define CRYPTO_MEM_CHECK_ON	0x1	/* a bit */
#define CRYPTO_MEM_CHECK_ENABLE	0x2	/* a bit */
#define CRYPTO_MEM_CHECK_DISABLE 0x3	/* an enume */

/* The following are bit values to turn on or off options connected to the
 * malloc checking functionality */

/* Adds time to the memory checking information */
#define V_CRYPTO_MDEBUG_TIME	0x1 /* a bit */
/* Adds thread number to the memory checking information */
#define V_CRYPTO_MDEBUG_THREAD	0x2 /* a bit */

#define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)


/* predec of the BIO type */
typedef struct bio_st BIO_dummy;

typedef struct crypto_ex_data_st
	{
	STACK *sk;
	int dummy; /* gcc is screwing up this data structure :-( */
	} CRYPTO_EX_DATA;

/* Called when a new object is created */
typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
					int idx, long argl, void *argp);
/* Called when an object is free()ed */
typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
					int idx, long argl, void *argp);
/* Called when we need to dup an object */
typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, 
					int idx, long argl, void *argp);

/* This stuff is basically class callback functions
 * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */

typedef struct crypto_ex_data_func_st
	{
	long argl;	/* Arbitary long */
	void *argp;	/* Arbitary void * */
	CRYPTO_EX_new *new_func;
	CRYPTO_EX_free *free_func;
	CRYPTO_EX_dup *dup_func;
	} CRYPTO_EX_DATA_FUNCS;

DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)

/* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
 * entry.
 */

#define CRYPTO_EX_INDEX_BIO		0
#define CRYPTO_EX_INDEX_SSL		1
#define CRYPTO_EX_INDEX_SSL_CTX		2
#define CRYPTO_EX_INDEX_SSL_SESSION	3
#define CRYPTO_EX_INDEX_X509_STORE	4
#define CRYPTO_EX_INDEX_X509_STORE_CTX	5


/* This is the default callbacks, but we can have others as well:
 * this is needed in Win32 where the application malloc and the
 * library malloc may not be the same.
 */
#define CRYPTO_malloc_init()	CRYPTO_set_mem_functions(\
	malloc, realloc, free)

#if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
# ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
#  define CRYPTO_MDEBUG
# endif
#endif

/* Set standard debugging functions (not done by default
 * unless CRYPTO_MDEBUG is defined) */
#define CRYPTO_malloc_debug_init()	do {\
	CRYPTO_set_mem_debug_functions(\
		CRYPTO_dbg_malloc,\
		CRYPTO_dbg_realloc,\
		CRYPTO_dbg_free,\
		CRYPTO_dbg_set_options,\
		CRYPTO_dbg_get_options);\
	} while(0)

int CRYPTO_mem_ctrl(int mode);
int CRYPTO_is_mem_check_on(void);

/* for applications */
#define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
#define MemCheck_stop()	CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)

/* for library-internal use */
#define MemCheck_on()	CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
#define MemCheck_off()	CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
#define is_MemCheck_on() CRYPTO_is_mem_check_on()

#define OPENSSL_malloc(num)	CRYPTO_malloc((int)num,__FILE__,__LINE__)
#define OPENSSL_realloc(addr,num) \
	CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
#define OPENSSL_remalloc(addr,num) \
	CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
#define OPENSSL_freeFunc	CRYPTO_free
#define OPENSSL_free(addr)	CRYPTO_free(addr)

#define OPENSSL_malloc_locked(num) \
	CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
#define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr)


const char *SSLeay_version(int type);
unsigned long SSLeay(void);

int OPENSSL_issetugid(void);

int CRYPTO_get_ex_new_index(int idx, STACK_OF(CRYPTO_EX_DATA_FUNCS) **skp, long argl, void *argp,
	     CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad,int idx);
int CRYPTO_dup_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, CRYPTO_EX_DATA *to,
	     CRYPTO_EX_DATA *from);
void CRYPTO_free_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
void CRYPTO_new_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);

int CRYPTO_get_new_lockid(char *name);

int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
void CRYPTO_lock(int mode, int type,const char *file,int line);
void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
					      const char *file,int line));
void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
		int line);
void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
					      const char *file, int line));
int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
					  const char *file,int line);
void CRYPTO_set_id_callback(unsigned long (*func)(void));
unsigned long (*CRYPTO_get_id_callback(void))(void);
unsigned long CRYPTO_thread_id(void);
const char *CRYPTO_get_lock_name(int type);
int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
		    int line);

int CRYPTO_get_new_dynlockid(void);
void CRYPTO_destroy_dynlockid(int i);
struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, int line));
void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line));
void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, const char *file, int line));
struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))(const char *file,int line);
void (*CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value *l, const char *file,int line);
void (*CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value *l, const char *file,int line);

/* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
 * call the latter last if you need different functions */
int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
int CRYPTO_set_mem_ex_functions(void *(*m)(size_t,const char *,int),
                                void *(*r)(void *,size_t,const char *,int),
                                void (*f)(void *));
int CRYPTO_set_locked_mem_ex_functions(void *(*m)(size_t,const char *,int),
                                       void (*free_func)(void *));
int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
				   void (*r)(void *,void *,int,const char *,int,int),
				   void (*f)(void *,int),
				   void (*so)(long),
				   long (*go)(void));
void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *));
void CRYPTO_get_mem_ex_functions(void *(**m)(size_t,const char *,int),
                                 void *(**r)(void *, size_t,const char *,int),
                                 void (**f)(void *));
void CRYPTO_get_locked_mem_ex_functions(void *(**m)(size_t,const char *,int),
                                        void (**f)(void *));
void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
				    void (**r)(void *,void *,int,const char *,int,int),
				    void (**f)(void *,int),
				    void (**so)(long),
				    long (**go)(void));

void *CRYPTO_malloc_locked(int num, const char *file, int line);
void CRYPTO_free_locked(void *);
void *CRYPTO_malloc(int num, const char *file, int line);
void CRYPTO_free(void *);
void *CRYPTO_realloc(void *addr,int num, const char *file, int line);
void *CRYPTO_remalloc(void *addr,int num, const char *file, int line);

void CRYPTO_set_mem_debug_options(long bits);
long CRYPTO_get_mem_debug_options(void);

#define CRYPTO_push_info(info) \
        CRYPTO_push_info_(info, __FILE__, __LINE__);
int CRYPTO_push_info_(const char *info, const char *file, int line);
int CRYPTO_pop_info(void);
int CRYPTO_remove_all_info(void);

/* The last argument has the following significance:
 *
 * 0:	called before the actual memory allocation has taken place
 * 1:	called after the actual memory allocation has taken place
 */
void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
void CRYPTO_dbg_free(void *addr,int before_p);

/* Tell the debugging code about options.  By default, the following values
 * apply:
 *
 * 0:	Clear all options.
 * 1:	Set the "Show Time" option.
 * 2:	Set the "Show Thread Number" option.
 * 3:	1 + 2
 */
void CRYPTO_dbg_set_options(long bits);
long CRYPTO_dbg_get_options(void);

#ifndef NO_FP_API
void CRYPTO_mem_leaks_fp(FILE *);
#endif
void CRYPTO_mem_leaks(struct bio_st *bio);
/* unsigned long order, char *file, int line, int num_bytes, char *addr */
typedef void *CRYPTO_MEM_LEAK_CB(unsigned long, const char *, int, int, void *);
void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB cb);

void ERR_load_CRYPTO_strings(void);

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

/* Function codes. */
#define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX		 100
#define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID		 103
#define CRYPTO_F_CRYPTO_GET_NEW_LOCKID			 101
#define CRYPTO_F_CRYPTO_SET_EX_DATA			 102

/* Reason codes. */
#define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK		 100

#ifdef  __cplusplus
}
#endif
#endif
Commit	Line	Data
d02b48c6	1	/* crypto/crypto.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_CRYPTO_H
	60	#define HEADER_CRYPTO_H
	61
f3e9b338 UM	62	#include <stdlib.h>
f3e9b338 UM	63
0b86eb3e BM	64	#ifndef NO_FP_API
	65	#include <stdio.h>
	66	#endif
	67
ec577822	68	#include <openssl/stack.h>
dd9d233e	69	#include <openssl/safestack.h>
ec577822	70	#include <openssl/opensslv.h>
5f326803	71
a53955d8 UM	72	#ifdef CHARSET_EBCDIC
	73	#include <openssl/ebcdic.h>
	74	#endif
	75
9fc25706 RL	76	/* Resolve problems on some operating systems with symbol names that clash
	77	one way or another */
	78	#include <openssl/symhacks.h>
c29b6d56	79
65962686 RL	80	#ifdef __cplusplus
	81	extern "C" {
	82	#endif
	83
5f326803	84	/* Backward compatibility to SSLeay */
d02b48c6 RE	85	/* This is more to be used to check the correct DLL is being used
d02b48c6 RE	86	* in the MS world. */
5f326803	87	#define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
d02b48c6 RE	88	#define SSLEAY_VERSION 0
	89	/* #define SSLEAY_OPTIONS 1 no longer supported */
	90	#define SSLEAY_CFLAGS 2
	91	#define SSLEAY_BUILT_ON 3
dfeab068	92	#define SSLEAY_PLATFORM 4
673b3fde	93	#define SSLEAY_DIR 5
d02b48c6 RE	94
	95	/* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
	96	* names in cryptlib.c
	97	*/
	98
	99	#define CRYPTO_LOCK_ERR 1
	100	#define CRYPTO_LOCK_ERR_HASH 2
	101	#define CRYPTO_LOCK_X509 3
	102	#define CRYPTO_LOCK_X509_INFO 4
	103	#define CRYPTO_LOCK_X509_PKEY 5
	104	#define CRYPTO_LOCK_X509_CRL 6
	105	#define CRYPTO_LOCK_X509_REQ 7
	106	#define CRYPTO_LOCK_DSA 8
	107	#define CRYPTO_LOCK_RSA 9
	108	#define CRYPTO_LOCK_EVP_PKEY 10
	109	#define CRYPTO_LOCK_X509_STORE 11
	110	#define CRYPTO_LOCK_SSL_CTX 12
	111	#define CRYPTO_LOCK_SSL_CERT 13
	112	#define CRYPTO_LOCK_SSL_SESSION 14
b56bce4f BM	113	#define CRYPTO_LOCK_SSL_SESS_CERT 15
	114	#define CRYPTO_LOCK_SSL 16
	115	#define CRYPTO_LOCK_RAND 17
	116	#define CRYPTO_LOCK_MALLOC 18
	117	#define CRYPTO_LOCK_BIO 19
2a82c7cf BM	118	#define CRYPTO_LOCK_GETHOSTBYNAME 20
	119	#define CRYPTO_LOCK_GETSERVBYNAME 21
	120	#define CRYPTO_LOCK_READDIR 22
	121	#define CRYPTO_LOCK_RSA_BLINDING 23
13066cee	122	#define CRYPTO_LOCK_DH 24
1f575f1b	123	#define CRYPTO_LOCK_MALLOC2 25
9ec0126e	124	#define CRYPTO_LOCK_DSO 26
e73a6965	125	#define CRYPTO_LOCK_DYNLOCK 27
5270e702 RL	126	#define CRYPTO_LOCK_ENGINE 28
5270e702 RL	127	#define CRYPTO_NUM_LOCKS 29
d02b48c6 RE	128
	129	#define CRYPTO_LOCK 1
	130	#define CRYPTO_UNLOCK 2
	131	#define CRYPTO_READ 4
	132	#define CRYPTO_WRITE 8
	133
dfeab068	134	#ifndef NO_LOCKING
d02b48c6 RE	135	#ifndef CRYPTO_w_lock
	136	#define CRYPTO_w_lock(type) \
	137	CRYPTO_lock(CRYPTO_LOCK\|CRYPTO_WRITE,type,__FILE__,__LINE__)
	138	#define CRYPTO_w_unlock(type) \
	139	CRYPTO_lock(CRYPTO_UNLOCK\|CRYPTO_WRITE,type,__FILE__,__LINE__)
	140	#define CRYPTO_r_lock(type) \
	141	CRYPTO_lock(CRYPTO_LOCK\|CRYPTO_READ,type,__FILE__,__LINE__)
	142	#define CRYPTO_r_unlock(type) \
	143	CRYPTO_lock(CRYPTO_UNLOCK\|CRYPTO_READ,type,__FILE__,__LINE__)
	144	#define CRYPTO_add(addr,amount,type) \
	145	CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
dfeab068 RE	146	#endif
	147	#else
	148	#define CRYPTO_w_lock(a)
	149	#define CRYPTO_w_unlock(a)
	150	#define CRYPTO_r_lock(a)
	151	#define CRYPTO_r_unlock(a)
	152	#define CRYPTO_add(a,b,c) ((*(a))+=(b))
d02b48c6 RE	153	#endif
d02b48c6 RE	154
c7922304 RL	155	/* Some applications as well as some parts of OpenSSL need to allocate
	156	and deallocate locks in a dynamic fashion. The following typedef
	157	makes this possible in a type-safe manner. */
e73a6965 RL	158	/* struct CRYPTO_dynlock_value has to be defined by the application. */
	159	typedef struct
	160	{
	161	int references;
	162	struct CRYPTO_dynlock_value *data;
	163	} CRYPTO_dynlock;
c7922304 RL	164
c7922304 RL	165
d02b48c6 RE	166	/* The following can be used to detect memory leaks in the SSLeay library.
	167	* It used, it turns on malloc checking */
	168
dfeab068 RE	169	#define CRYPTO_MEM_CHECK_OFF 0x0 /* an enume */
	170	#define CRYPTO_MEM_CHECK_ON 0x1 /* a bit */
	171	#define CRYPTO_MEM_CHECK_ENABLE 0x2 /* a bit */
	172	#define CRYPTO_MEM_CHECK_DISABLE 0x3 /* an enume */
d02b48c6	173
d8df48a9 RL	174	/* The following are bit values to turn on or off options connected to the
	175	* malloc checking functionality */
	176
	177	/* Adds time to the memory checking information */
	178	#define V_CRYPTO_MDEBUG_TIME 0x1 /* a bit */
	179	/* Adds thread number to the memory checking information */
	180	#define V_CRYPTO_MDEBUG_THREAD 0x2 /* a bit */
	181
b64e735b BM	182	#define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME \| V_CRYPTO_MDEBUG_THREAD)
b64e735b BM	183
d02b48c6	184
58964a49 RE	185	/* predec of the BIO type */
	186	typedef struct bio_st BIO_dummy;
	187
	188	typedef struct crypto_ex_data_st
	189	{
	190	STACK *sk;
	191	int dummy; /* gcc is screwing up this data structure :-( */
	192	} CRYPTO_EX_DATA;
	193
dd9d233e DSH	194	/* Called when a new object is created */
	195	typedef int CRYPTO_EX_new(void parent, void ptr, CRYPTO_EX_DATA *ad,
	196	int idx, long argl, void *argp);
	197	/* Called when an object is free()ed */
	198	typedef void CRYPTO_EX_free(void parent, void ptr, CRYPTO_EX_DATA *ad,
	199	int idx, long argl, void *argp);
	200	/* Called when we need to dup an object */
	201	typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA to, CRYPTO_EX_DATA from, void *from_d,
	202	int idx, long argl, void *argp);
	203
58964a49	204	/* This stuff is basically class callback functions
c29b6d56	205	* The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */
dd9d233e	206
58964a49 RE	207	typedef struct crypto_ex_data_func_st
	208	{
	209	long argl; /* Arbitary long */
dd9d233e DSH	210	void argp; / Arbitary void * */
	211	CRYPTO_EX_new *new_func;
	212	CRYPTO_EX_free *free_func;
	213	CRYPTO_EX_dup *dup_func;
58964a49 RE	214	} CRYPTO_EX_DATA_FUNCS;
58964a49 RE	215
dd9d233e DSH	216	DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
dd9d233e DSH	217
58964a49 RE	218	/* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
	219	* entry.
	220	*/
	221
	222	#define CRYPTO_EX_INDEX_BIO 0
	223	#define CRYPTO_EX_INDEX_SSL 1
	224	#define CRYPTO_EX_INDEX_SSL_CTX 2
	225	#define CRYPTO_EX_INDEX_SSL_SESSION 3
	226	#define CRYPTO_EX_INDEX_X509_STORE 4
	227	#define CRYPTO_EX_INDEX_X509_STORE_CTX 5
d02b48c6	228
d8df48a9	229
3d14b9d0 DSH	230	/* This is the default callbacks, but we can have others as well:
	231	* this is needed in Win32 where the application malloc and the
	232	* library malloc may not be the same.
	233	*/
d02b48c6	234	#define CRYPTO_malloc_init() CRYPTO_set_mem_functions(\
0cd08cce	235	malloc, realloc, free)
0cd08cce BM	236
	237	#if defined CRYPTO_MDEBUG_ALL \|\| defined CRYPTO_MDEBUG_TIME \|\| defined CRYPTO_MDEBUG_THREAD
	238	# ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
	239	# define CRYPTO_MDEBUG
	240	# endif
	241	#endif
d02b48c6	242
0cd08cce	243	/* Set standard debugging functions (not done by default
75acc288	244	* unless CRYPTO_MDEBUG is defined) */
9ac42ed8 RL	245	#define CRYPTO_malloc_debug_init() do {\
9ac42ed8 RL	246	CRYPTO_set_mem_debug_functions(\
e5acb2bd RL	247	CRYPTO_dbg_malloc,\
	248	CRYPTO_dbg_realloc,\
	249	CRYPTO_dbg_free,\
	250	CRYPTO_dbg_set_options,\
	251	CRYPTO_dbg_get_options);\
f3a2a044	252	} while(0)
9ac42ed8	253
0cd08cce BM	254	int CRYPTO_mem_ctrl(int mode);
0cd08cce BM	255	int CRYPTO_is_mem_check_on(void);
458cddc1	256
0cd08cce	257	/* for applications */
dfeab068 RE	258	#define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
dfeab068 RE	259	#define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
0cd08cce BM	260
0cd08cce BM	261	/* for library-internal use */
dfeab068 RE	262	#define MemCheck_on() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
dfeab068 RE	263	#define MemCheck_off() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
0cd08cce	264	#define is_MemCheck_on() CRYPTO_is_mem_check_on()
9ac42ed8	265
26a3a48d RL	266	#define OPENSSL_malloc(num) CRYPTO_malloc((int)num,__FILE__,__LINE__)
26a3a48d RL	267	#define OPENSSL_realloc(addr,num) \
9ac42ed8	268	CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
26a3a48d	269	#define OPENSSL_remalloc(addr,num) \
9ac42ed8	270	CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
26a3a48d RL	271	#define OPENSSL_freeFunc CRYPTO_free
26a3a48d RL	272	#define OPENSSL_free(addr) CRYPTO_free(addr)
9ac42ed8	273
26a3a48d RL	274	#define OPENSSL_malloc_locked(num) \
	275	CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
	276	#define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr)
9ac42ed8	277
d02b48c6	278
e778802f	279	const char *SSLeay_version(int type);
d02b48c6 RE	280	unsigned long SSLeay(void);
d02b48c6 RE	281
36fafffa UM	282	int OPENSSL_issetugid(void);
36fafffa UM	283
dd9d233e DSH	284	int CRYPTO_get_ex_new_index(int idx, STACK_OF(CRYPTO_EX_DATA_FUNCS) *skp, long argl, void argp,
	285	CRYPTO_EX_new new_func, CRYPTO_EX_dup dup_func, CRYPTO_EX_free *free_func);
	286	int CRYPTO_set_ex_data(CRYPTO_EX_DATA ad, int idx, void val);
bbbc96a8	287	void CRYPTO_get_ex_data(const CRYPTO_EX_DATA ad,int idx);
dd9d233e DSH	288	int CRYPTO_dup_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) meth, CRYPTO_EX_DATA to,
	289	CRYPTO_EX_DATA *from);
	290	void CRYPTO_free_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) meth, void obj, CRYPTO_EX_DATA *ad);
	291	void CRYPTO_new_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) meth, void obj, CRYPTO_EX_DATA *ad);
58964a49	292
58964a49	293	int CRYPTO_get_new_lockid(char *name);
a111306b BM	294
a111306b BM	295	int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
e778802f BL	296	void CRYPTO_lock(int mode, int type,const char *file,int line);
	297	void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
	298	const char *file,int line));
	299	void (CRYPTO_get_locking_callback(void))(int mode,int type,const char file,
d02b48c6	300	int line);
e778802f BL	301	void CRYPTO_set_add_lock_callback(int (func)(int num,int mount,int type,
	302	const char *file, int line));
	303	int (CRYPTO_get_add_lock_callback(void))(int num,int mount,int type,
	304	const char *file,int line);
d02b48c6 RE	305	void CRYPTO_set_id_callback(unsigned long (*func)(void));
	306	unsigned long (*CRYPTO_get_id_callback(void))(void);
	307	unsigned long CRYPTO_thread_id(void);
e778802f BL	308	const char *CRYPTO_get_lock_name(int type);
	309	int CRYPTO_add_lock(int pointer,int amount,int type, const char file,
	310	int line);
55b7688e	311
c7922304 RL	312	int CRYPTO_get_new_dynlockid(void);
c7922304 RL	313	void CRYPTO_destroy_dynlockid(int i);
e73a6965	314	struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
55b7688e RL	315	void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value (dyn_create_function)(const char *file, int line));
	316	void CRYPTO_set_dynlock_lock_callback(void (dyn_lock_function)(int mode, struct CRYPTO_dynlock_value l, const char *file, int line));
	317	void CRYPTO_set_dynlock_destroy_callback(void (dyn_destroy_function)(struct CRYPTO_dynlock_value l, const char *file, int line));
	318	struct CRYPTO_dynlock_value (CRYPTO_get_dynlock_create_callback(void))(const char *file,int line);
	319	void (CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value l, const char *file,int line);
	320	void (CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value l, const char *file,int line);
d02b48c6	321
0cd08cce BM	322	/* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
	323	* call the latter last if you need different functions */
	324	int CRYPTO_set_mem_functions(void (m)(size_t),void (r)(void ,size_t), void (f)(void *));
	325	int CRYPTO_set_locked_mem_functions(void (m)(size_t), void (free_func)(void ));
65a22e8e RL	326	int CRYPTO_set_mem_ex_functions(void (m)(size_t,const char *,int),
65a22e8e RL	327	void (r)(void ,size_t,const char ,int),
cd56182b	328	void (f)(void ));
65a22e8e	329	int CRYPTO_set_locked_mem_ex_functions(void (m)(size_t,const char *,int),
cd56182b	330	void (free_func)(void ));
65962686 RL	331	int CRYPTO_set_mem_debug_functions(void (m)(void ,int,const char *,int,int),
	332	void (r)(void ,void ,int,const char ,int,int),
	333	void (f)(void ,int),
	334	void (*so)(long),
	335	long (*go)(void));
0cd08cce BM	336	void CRYPTO_get_mem_functions(void (m)(size_t),void (*r)(void , size_t), void (*f)(void ));
0cd08cce BM	337	void CRYPTO_get_locked_mem_functions(void (m)(size_t), void (f)(void ));
65a22e8e RL	338	void CRYPTO_get_mem_ex_functions(void (m)(size_t,const char ,int),
65a22e8e RL	339	void (r)(void , size_t,const char *,int),
cd56182b	340	void (*f)(void ));
65a22e8e	341	void CRYPTO_get_locked_mem_ex_functions(void (m)(size_t,const char ,int),
cd56182b	342	void (*f)(void ));
65962686 RL	343	void CRYPTO_get_mem_debug_functions(void (*m)(void ,int,const char *,int,int),
	344	void (*r)(void ,void ,int,const char ,int,int),
	345	void (*f)(void ,int),
	346	void (**so)(long),
	347	long (**go)(void));
d02b48c6	348
9d1a01be	349	void CRYPTO_malloc_locked(int num, const char file, int line);
5a88a6ea	350	void CRYPTO_free_locked(void *);
9d1a01be	351	void CRYPTO_malloc(int num, const char file, int line);
5a88a6ea	352	void CRYPTO_free(void *);
9d1a01be UM	353	void CRYPTO_realloc(void addr,int num, const char *file, int line);
9d1a01be UM	354	void CRYPTO_remalloc(void addr,int num, const char *file, int line);
5a88a6ea	355
0cd08cce	356	void CRYPTO_set_mem_debug_options(long bits);
667ac4ec	357	long CRYPTO_get_mem_debug_options(void);
0cd08cce	358
2b6313d0 BM	359	#define CRYPTO_push_info(info) \
	360	CRYPTO_push_info_(info, __FILE__, __LINE__);
	361	int CRYPTO_push_info_(const char info, const char file, int line);
	362	int CRYPTO_pop_info(void);
9ac42ed8 RL	363	int CRYPTO_remove_all_info(void);
	364
	365	/* The last argument has the following significance:
	366	*
	367	* 0: called before the actual memory allocation has taken place
	368	* 1: called after the actual memory allocation has taken place
	369	*/
	370	void CRYPTO_dbg_malloc(void addr,int num,const char file,int line,int before_p);
	371	void CRYPTO_dbg_realloc(void addr1,void addr2,int num,const char *file,int line,int before_p);
d8df48a9	372	void CRYPTO_dbg_free(void *addr,int before_p);
9ac42ed8 RL	373
	374	/* Tell the debugging code about options. By default, the following values
	375	* apply:
	376	*
	377	* 0: Clear all options.
	378	* 1: Set the "Show Time" option.
	379	* 2: Set the "Show Thread Number" option.
	380	* 3: 1 + 2
	381	*/
0cd08cce	382	void CRYPTO_dbg_set_options(long bits);
667ac4ec	383	long CRYPTO_dbg_get_options(void);
1f575f1b	384
58964a49	385	#ifndef NO_FP_API
d02b48c6 RE	386	void CRYPTO_mem_leaks_fp(FILE *);
d02b48c6 RE	387	#endif
58964a49	388	void CRYPTO_mem_leaks(struct bio_st *bio);
d02b48c6	389	/* unsigned long order, char file, int line, int num_bytes, char addr */
98d517c5 GT	390	typedef void CRYPTO_MEM_LEAK_CB(unsigned long, const char , int, int, void *);
98d517c5 GT	391	void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB cb);
d02b48c6	392
667ac4ec	393	void ERR_load_CRYPTO_strings(void);
58964a49	394
58964a49	395	/* BEGIN ERROR CODES */
6d311938 DSH	396	/* The following lines are auto generated by the script mkerr.pl. Any changes
	397	* made after this point may be overwritten when the script is next run.
	398	*/
	399
58964a49 RE	400	/* Error codes for the CRYPTO functions. */
	401
	402	/* Function codes. */
	403	#define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX 100
c7922304	404	#define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID 103
58964a49 RE	405	#define CRYPTO_F_CRYPTO_GET_NEW_LOCKID 101
	406	#define CRYPTO_F_CRYPTO_SET_EX_DATA 102
	407
	408	/* Reason codes. */
c7922304	409	#define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK 100
6d311938	410
d02b48c6 RE	411	#ifdef __cplusplus
	412	}
	413	#endif
d02b48c6	414	#endif
c7922304	415