3bc9b1a9afa9ec60c695530e3ceb7e0ba32a1707
[openssl.git] / crypto / crypto.h
1 /* crypto/crypto.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 #ifndef HEADER_CRYPTO_H
60 #define HEADER_CRYPTO_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 #ifndef NO_FP_API
67 #include <stdio.h>
68 #endif
69
70 #include <openssl/stack.h>
71 #include <openssl/opensslv.h>
72
73 #ifdef CHARSET_EBCDIC
74 #include <openssl/ebcdic.h>
75 #endif
76
77 /* Backward compatibility to SSLeay */
78 /* This is more to be used to check the correct DLL is being used
79  * in the MS world. */
80 #define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
81 #define SSLEAY_VERSION          0
82 /* #define SSLEAY_OPTIONS       1 no longer supported */
83 #define SSLEAY_CFLAGS           2
84 #define SSLEAY_BUILT_ON         3
85 #define SSLEAY_PLATFORM         4
86
87 /* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
88  * names in cryptlib.c
89  */
90
91 #define CRYPTO_LOCK_ERR                 1
92 #define CRYPTO_LOCK_ERR_HASH            2
93 #define CRYPTO_LOCK_X509                3
94 #define CRYPTO_LOCK_X509_INFO           4
95 #define CRYPTO_LOCK_X509_PKEY           5
96 #define CRYPTO_LOCK_X509_CRL            6
97 #define CRYPTO_LOCK_X509_REQ            7
98 #define CRYPTO_LOCK_DSA                 8
99 #define CRYPTO_LOCK_RSA                 9
100 #define CRYPTO_LOCK_EVP_PKEY            10
101 #define CRYPTO_LOCK_X509_STORE          11
102 #define CRYPTO_LOCK_SSL_CTX             12
103 #define CRYPTO_LOCK_SSL_CERT            13
104 #define CRYPTO_LOCK_SSL_SESSION         14
105 #define CRYPTO_LOCK_SSL_SESS_CERT       15
106 #define CRYPTO_LOCK_SSL                 16
107 #define CRYPTO_LOCK_RAND                17
108 #define CRYPTO_LOCK_MALLOC              18
109 #define CRYPTO_LOCK_BIO                 19
110 #define CRYPTO_LOCK_GETHOSTBYNAME       20
111 #define CRYPTO_LOCK_GETSERVBYNAME       21
112 #define CRYPTO_LOCK_READDIR             22
113 #define CRYPTO_LOCK_RSA_BLINDING        23
114 #define CRYPTO_LOCK_DH                  24
115 #define CRYPTO_LOCK_MALLOC2             25
116 #define CRYPTO_NUM_LOCKS                26
117
118 #define CRYPTO_LOCK             1
119 #define CRYPTO_UNLOCK           2
120 #define CRYPTO_READ             4
121 #define CRYPTO_WRITE            8
122
123 #ifndef NO_LOCKING
124 #ifndef CRYPTO_w_lock
125 #define CRYPTO_w_lock(type)     \
126         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
127 #define CRYPTO_w_unlock(type)   \
128         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
129 #define CRYPTO_r_lock(type)     \
130         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
131 #define CRYPTO_r_unlock(type)   \
132         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
133 #define CRYPTO_add(addr,amount,type)    \
134         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
135 #endif
136 #else
137 #define CRYPTO_w_lock(a)
138 #define CRYPTO_w_unlock(a)
139 #define CRYPTO_r_lock(a)
140 #define CRYPTO_r_unlock(a)
141 #define CRYPTO_add(a,b,c)       ((*(a))+=(b))
142 #endif
143
144 /* The following can be used to detect memory leaks in the SSLeay library.
145  * It used, it turns on malloc checking */
146
147 #define CRYPTO_MEM_CHECK_OFF    0x0     /* an enume */
148 #define CRYPTO_MEM_CHECK_ON     0x1     /* a bit */
149 #define CRYPTO_MEM_CHECK_ENABLE 0x2     /* a bit */
150 #define CRYPTO_MEM_CHECK_DISABLE 0x3    /* an enume */
151
152 /*
153 typedef struct crypto_mem_st
154         {
155         char *(*malloc_func)();
156         char *(*realloc_func)();
157         void (*free_func)();
158         } CRYPTO_MEM_FUNC;
159 */
160
161 /* predec of the BIO type */
162 typedef struct bio_st BIO_dummy;
163
164 typedef struct crypto_ex_data_st
165         {
166         STACK *sk;
167         int dummy; /* gcc is screwing up this data structure :-( */
168         } CRYPTO_EX_DATA;
169
170 /* This stuff is basically class callback functions
171  * The current classes are SSL_CTX, SSL, SSL_SESION, and a few more */
172 typedef struct crypto_ex_data_func_st
173         {
174         long argl;      /* Arbitary long */
175         char *argp;     /* Arbitary char * */
176         /* Called when a new object is created */
177         int (*new_func)(/*char *obj,
178                         char *item,int index,long argl,char *argp*/);
179         /* Called when this object is free()ed */
180         void (*free_func)(/*char *obj,
181                         char *item,int index,long argl,char *argp*/);
182
183         /* Called when we need to dup this one */
184         int (*dup_func)(/*char *obj_to,char *obj_from,
185                         char **new,int index,long argl,char *argp*/);
186         } CRYPTO_EX_DATA_FUNCS;
187
188 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
189  * entry.
190  */
191
192 #define CRYPTO_EX_INDEX_BIO             0
193 #define CRYPTO_EX_INDEX_SSL             1
194 #define CRYPTO_EX_INDEX_SSL_CTX         2
195 #define CRYPTO_EX_INDEX_SSL_SESSION     3
196 #define CRYPTO_EX_INDEX_X509_STORE      4
197 #define CRYPTO_EX_INDEX_X509_STORE_CTX  5
198
199 /* Use this for win32 DLL's */
200 #define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
201         (char *(*)())malloc,\
202         (char *(*)())realloc,\
203         (void (*)())free)
204
205 #ifdef CRYPTO_MDEBUG_ALL
206 # ifndef CRYPTO_MDEBUG_TIME
207 #  define CRYPTO_MDEBUG_TIME
208 # endif
209 # ifndef CRYPTO_MDEBUG_THREAD
210 #  define CRYPTO_MDEBUG_THREAD
211 # endif
212 #endif
213
214 #if defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
215 # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
216 #  define CRYPTO_MDEBUG
217 # endif
218 #endif
219
220 #ifdef CRYPTO_MDEBUG
221 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
222 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
223 #define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
224 #define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
225 #define Malloc(num)     CRYPTO_dbg_malloc((int)num,__FILE__,__LINE__)
226 #define Realloc(addr,num) \
227         CRYPTO_dbg_realloc((char *)addr,(int)num,__FILE__,__LINE__)
228 #define Remalloc(addr,num) \
229         CRYPTO_dbg_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
230 #define FreeFunc        CRYPTO_dbg_free
231 #define Free(addr)      CRYPTO_dbg_free(addr)
232 #define Malloc_locked(num) CRYPTO_malloc_locked((int)num)
233 #define Free_locked(addr) CRYPTO_free_locked(addr)
234 #else
235 #define MemCheck_start()
236 #define MemCheck_stop()
237 #define MemCheck_on()
238 #define MemCheck_off()
239 #define Remalloc        CRYPTO_remalloc
240 #if defined(WIN32) || defined(MFUNC)
241 #define Malloc          CRYPTO_malloc
242 #define Realloc(a,n)    CRYPTO_realloc(a,(n))
243 #define FreeFunc        CRYPTO_free
244 #define Free(addr)      CRYPTO_free(addr)
245 #define Malloc_locked   CRYPTO_malloc_locked
246 #define Free_locked(addr) CRYPTO_free_locked(addr)
247 #else
248 #define Malloc          malloc
249 #define Realloc         realloc
250 #define FreeFunc        free
251 #define Free(addr)      free(addr)
252 #define Malloc_locked   malloc
253 #define Free_locked(addr) free(addr)
254 #endif /* WIN32 || MFUNC */
255 #endif /* MDEBUG */
256
257 /* Case insensiteve linking causes problems.... */
258 #if defined(WIN16) || defined(VMS)
259 #define ERR_load_CRYPTO_strings ERR_load_CRYPTOlib_strings
260 #endif
261
262
263 const char *SSLeay_version(int type);
264 unsigned long SSLeay(void);
265
266 int CRYPTO_get_ex_new_index(int idx,STACK **sk,long argl,char *argp,
267         int (*new_func)(),int (*dup_func)(),void (*free_func)());
268 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad,int idx,char *val);
269 char *CRYPTO_get_ex_data(CRYPTO_EX_DATA *ad,int idx);
270 int CRYPTO_dup_ex_data(STACK *meth,CRYPTO_EX_DATA *from,CRYPTO_EX_DATA *to);
271 void CRYPTO_free_ex_data(STACK *meth,char *obj,CRYPTO_EX_DATA *ad);
272 void CRYPTO_new_ex_data(STACK *meth, char *obj, CRYPTO_EX_DATA *ad);
273
274 int CRYPTO_mem_ctrl(int mode);
275 int CRYPTO_get_new_lockid(char *name);
276
277 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
278 void CRYPTO_lock(int mode, int type,const char *file,int line);
279 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
280                                               const char *file,int line));
281 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
282                 int line);
283 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
284                                               const char *file, int line));
285 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
286                                           const char *file,int line);
287 void CRYPTO_set_id_callback(unsigned long (*func)(void));
288 unsigned long (*CRYPTO_get_id_callback(void))(void);
289 unsigned long CRYPTO_thread_id(void);
290 const char *CRYPTO_get_lock_name(int type);
291 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
292                     int line);
293
294 void CRYPTO_set_mem_functions(char *(*m)(),char *(*r)(), void (*free_func)());
295 void CRYPTO_get_mem_functions(char *(**m)(),char *(**r)(), void (**f)());
296 void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*free_func)());
297 void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)());
298
299 void *CRYPTO_malloc_locked(int num);
300 void CRYPTO_free_locked(void *);
301 void *CRYPTO_malloc(int num);
302 void CRYPTO_free(void *);
303 void *CRYPTO_realloc(void *addr,int num);
304 void *CRYPTO_remalloc(void *addr,int num);
305
306 int CRYPTO_add_info(const char *file, int line, const char *info);
307 int CRYPTO_remove_info();
308
309 void *CRYPTO_dbg_malloc(int num,const char *file,int line);
310 void *CRYPTO_dbg_realloc(void *addr,int num,const char *file,int line);
311 void CRYPTO_dbg_free(void *);
312 void *CRYPTO_dbg_remalloc(void *addr,int num,const char *file,int line);
313 #ifndef NO_FP_API
314 void CRYPTO_mem_leaks_fp(FILE *);
315 #endif
316 void CRYPTO_mem_leaks(struct bio_st *bio);
317 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
318 void CRYPTO_mem_leaks_cb(void (*cb)());
319
320 void ERR_load_CRYPTO_strings(void );
321
322 /* BEGIN ERROR CODES */
323 /* The following lines are auto generated by the script mkerr.pl. Any changes
324  * made after this point may be overwritten when the script is next run.
325  */
326
327 /* Error codes for the CRYPTO functions. */
328
329 /* Function codes. */
330 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
331 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
332 #define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
333
334 /* Reason codes. */
335
336 #ifdef  __cplusplus
337 }
338 #endif
339 #endif
340