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