New function CRYPTO_num_locks.
[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_NUM_LOCKS                24
115
116 #define CRYPTO_LOCK             1
117 #define CRYPTO_UNLOCK           2
118 #define CRYPTO_READ             4
119 #define CRYPTO_WRITE            8
120
121 #ifndef NO_LOCKING
122 #ifndef CRYPTO_w_lock
123 #define CRYPTO_w_lock(type)     \
124         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
125 #define CRYPTO_w_unlock(type)   \
126         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
127 #define CRYPTO_r_lock(type)     \
128         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
129 #define CRYPTO_r_unlock(type)   \
130         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
131 #define CRYPTO_add(addr,amount,type)    \
132         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
133 #endif
134 #else
135 #define CRYPTO_w_lock(a)
136 #define CRYPTO_w_unlock(a)
137 #define CRYPTO_r_lock(a)
138 #define CRYPTO_r_unlock(a)
139 #define CRYPTO_add(a,b,c)       ((*(a))+=(b))
140 #endif
141
142 /* The following can be used to detect memory leaks in the SSLeay library.
143  * It used, it turns on malloc checking */
144
145 #define CRYPTO_MEM_CHECK_OFF    0x0     /* an enume */
146 #define CRYPTO_MEM_CHECK_ON     0x1     /* a bit */
147 #define CRYPTO_MEM_CHECK_ENABLE 0x2     /* a bit */
148 #define CRYPTO_MEM_CHECK_DISABLE 0x3    /* an enume */
149
150 /*
151 typedef struct crypto_mem_st
152         {
153         char *(*malloc_func)();
154         char *(*realloc_func)();
155         void (*free_func)();
156         } CRYPTO_MEM_FUNC;
157 */
158
159 /* predec of the BIO type */
160 typedef struct bio_st BIO_dummy;
161
162 typedef struct crypto_ex_data_st
163         {
164         STACK *sk;
165         int dummy; /* gcc is screwing up this data structure :-( */
166         } CRYPTO_EX_DATA;
167
168 /* This stuff is basically class callback functions
169  * The current classes are SSL_CTX, SSL, SSL_SESION, and a few more */
170 typedef struct crypto_ex_data_func_st
171         {
172         long argl;      /* Arbitary long */
173         char *argp;     /* Arbitary char * */
174         /* Called when a new object is created */
175         int (*new_func)(/*char *obj,
176                         char *item,int index,long argl,char *argp*/);
177         /* Called when this object is free()ed */
178         void (*free_func)(/*char *obj,
179                         char *item,int index,long argl,char *argp*/);
180
181         /* Called when we need to dup this one */
182         int (*dup_func)(/*char *obj_to,char *obj_from,
183                         char **new,int index,long argl,char *argp*/);
184         } CRYPTO_EX_DATA_FUNCS;
185
186 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
187  * entry.
188  */
189
190 #define CRYPTO_EX_INDEX_BIO             0
191 #define CRYPTO_EX_INDEX_SSL             1
192 #define CRYPTO_EX_INDEX_SSL_CTX         2
193 #define CRYPTO_EX_INDEX_SSL_SESSION     3
194 #define CRYPTO_EX_INDEX_X509_STORE      4
195 #define CRYPTO_EX_INDEX_X509_STORE_CTX  5
196
197 /* Use this for win32 DLL's */
198 #define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
199         (char *(*)())malloc,\
200         (char *(*)())realloc,\
201         (void (*)())free)
202
203 #ifdef CRYPTO_MDEBUG
204 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
205 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
206 #define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
207 #define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
208 #define Malloc(num)     CRYPTO_dbg_malloc((int)num,__FILE__,__LINE__)
209 #define Realloc(addr,num) \
210         CRYPTO_dbg_realloc((char *)addr,(int)num,__FILE__,__LINE__)
211 #define Remalloc(addr,num) \
212         CRYPTO_dbg_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
213 #define FreeFunc        CRYPTO_dbg_free
214 #define Free(addr)      CRYPTO_dbg_free(addr)
215 #define Malloc_locked(num) CRYPTO_malloc_locked((int)num)
216 #define Free_locked(addr) CRYPTO_free_locked(addr)
217 #else
218 #define MemCheck_start()
219 #define MemCheck_stop()
220 #define MemCheck_on()
221 #define MemCheck_off()
222 #define Remalloc        CRYPTO_remalloc
223 #if defined(WIN32) || defined(MFUNC)
224 #define Malloc          CRYPTO_malloc
225 #define Realloc(a,n)    CRYPTO_realloc(a,(n))
226 #define FreeFunc        CRYPTO_free
227 #define Free(addr)      CRYPTO_free(addr)
228 #define Malloc_locked   CRYPTO_malloc_locked
229 #define Free_locked(addr) CRYPTO_free_locked(addr)
230 #else
231 #define Malloc          malloc
232 #define Realloc         realloc
233 #define FreeFunc        free
234 #define Free(addr)      free(addr)
235 #define Malloc_locked   malloc
236 #define Free_locked(addr) free(addr)
237 #endif /* WIN32 || MFUNC */
238 #endif /* MDEBUG */
239
240 /* Case insensiteve linking causes problems.... */
241 #if defined(WIN16) || defined(VMS)
242 #define ERR_load_CRYPTO_strings ERR_load_CRYPTOlib_strings
243 #endif
244
245
246 const char *SSLeay_version(int type);
247 unsigned long SSLeay(void);
248
249 int CRYPTO_get_ex_new_index(int idx,STACK **sk,long argl,char *argp,
250         int (*new_func)(),int (*dup_func)(),void (*free_func)());
251 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad,int idx,char *val);
252 char *CRYPTO_get_ex_data(CRYPTO_EX_DATA *ad,int idx);
253 int CRYPTO_dup_ex_data(STACK *meth,CRYPTO_EX_DATA *from,CRYPTO_EX_DATA *to);
254 void CRYPTO_free_ex_data(STACK *meth,char *obj,CRYPTO_EX_DATA *ad);
255 void CRYPTO_new_ex_data(STACK *meth, char *obj, CRYPTO_EX_DATA *ad);
256
257 int CRYPTO_mem_ctrl(int mode);
258 int CRYPTO_get_new_lockid(char *name);
259
260 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
261 void CRYPTO_lock(int mode, int type,const char *file,int line);
262 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
263                                               const char *file,int line));
264 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
265                 int line);
266 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
267                                               const char *file, int line));
268 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
269                                           const char *file,int line);
270 void CRYPTO_set_id_callback(unsigned long (*func)(void));
271 unsigned long (*CRYPTO_get_id_callback(void))(void);
272 unsigned long CRYPTO_thread_id(void);
273 const char *CRYPTO_get_lock_name(int type);
274 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
275                     int line);
276
277 void CRYPTO_set_mem_functions(char *(*m)(),char *(*r)(), void (*free_func)());
278 void CRYPTO_get_mem_functions(char *(**m)(),char *(**r)(), void (**f)());
279 void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*free_func)());
280 void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)());
281
282 void *CRYPTO_malloc_locked(int num);
283 void CRYPTO_free_locked(void *);
284 void *CRYPTO_malloc(int num);
285 void CRYPTO_free(void *);
286 void *CRYPTO_realloc(void *addr,int num);
287 void *CRYPTO_remalloc(void *addr,int num);
288
289 void *CRYPTO_dbg_malloc(int num,const char *file,int line);
290 void *CRYPTO_dbg_realloc(void *addr,int num,const char *file,int line);
291 void CRYPTO_dbg_free(void *);
292 void *CRYPTO_dbg_remalloc(void *addr,int num,const char *file,int line);
293 #ifndef NO_FP_API
294 void CRYPTO_mem_leaks_fp(FILE *);
295 #endif
296 void CRYPTO_mem_leaks(struct bio_st *bio);
297 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
298 void CRYPTO_mem_leaks_cb(void (*cb)());
299
300 void ERR_load_CRYPTO_strings(void );
301
302 /* BEGIN ERROR CODES */
303 /* The following lines are auto generated by the script mkerr.pl. Any changes
304  * made after this point may be overwritten when the script is next run.
305  */
306
307 /* Error codes for the CRYPTO functions. */
308
309 /* Function codes. */
310 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
311 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
312 #define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
313
314 /* Reason codes. */
315
316 #ifdef  __cplusplus
317 }
318 #endif
319 #endif
320