19e8d10cbf18a898861a8baf84d87a64b72ea99b
[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 /* The following are bit values to turn on or off options connected to the
153  * malloc checking functionality */
154
155 /* Adds time to the memory checking information */
156 #define V_CRYPTO_MDEBUG_TIME    0x1 /* a bit */
157 /* Adds thread number to the memory checking information */
158 #define V_CRYPTO_MDEBUG_THREAD  0x2 /* a bit */
159
160 /*
161 typedef struct crypto_mem_st
162         {
163         char *(*malloc_func)();
164         char *(*realloc_func)();
165         void (*free_func)();
166         } CRYPTO_MEM_FUNC;
167 */
168
169 /* predec of the BIO type */
170 typedef struct bio_st BIO_dummy;
171
172 typedef struct crypto_ex_data_st
173         {
174         STACK *sk;
175         int dummy; /* gcc is screwing up this data structure :-( */
176         } CRYPTO_EX_DATA;
177
178 /* This stuff is basically class callback functions
179  * The current classes are SSL_CTX, SSL, SSL_SESION, and a few more */
180 typedef struct crypto_ex_data_func_st
181         {
182         long argl;      /* Arbitary long */
183         char *argp;     /* Arbitary char * */
184         /* Called when a new object is created */
185         int (*new_func)(/*char *obj,
186                         char *item,int index,long argl,char *argp*/);
187         /* Called when this object is free()ed */
188         void (*free_func)(/*char *obj,
189                         char *item,int index,long argl,char *argp*/);
190
191         /* Called when we need to dup this one */
192         int (*dup_func)(/*char *obj_to,char *obj_from,
193                         char **new,int index,long argl,char *argp*/);
194         } CRYPTO_EX_DATA_FUNCS;
195
196 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
197  * entry.
198  */
199
200 #define CRYPTO_EX_INDEX_BIO             0
201 #define CRYPTO_EX_INDEX_SSL             1
202 #define CRYPTO_EX_INDEX_SSL_CTX         2
203 #define CRYPTO_EX_INDEX_SSL_SESSION     3
204 #define CRYPTO_EX_INDEX_X509_STORE      4
205 #define CRYPTO_EX_INDEX_X509_STORE_CTX  5
206
207
208 /* This is the default callbacks, but we can have others as well */
209 #define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
210         (char *(*)())malloc,\
211         (char *(*)())realloc,\
212         (void (*)())free)
213
214 #define CRYPTO_malloc_debug_init()      do {\
215         CRYPTO_set_mem_debug_functions(\
216                 (void (*)())CRYPTO_dbg_malloc,\
217                 (void (*)())CRYPTO_dbg_realloc,\
218                 (void (*)())CRYPTO_dbg_free,\
219                 (void (*)())CRYPTO_dbg_set_options,\
220                 (int (*)())CRYPTO_dbg_get_options);\
221         } while(0)
222
223 #if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
224 # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
225 #  define CRYPTO_MDEBUG
226 # endif
227 #endif
228
229 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
230 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
231 #define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
232 #define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
233 #define is_MemCheck_on() CRYPTO_mem_check_on()
234
235 #define Malloc(num)     CRYPTO_malloc((int)num,__FILE__,__LINE__)
236 #define Realloc(addr,num) \
237         CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
238 #define Remalloc(addr,num) \
239         CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
240 #define FreeFunc        CRYPTO_free
241 #define Free(addr)      CRYPTO_free(addr)
242
243 #define Malloc_locked(num) CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
244 #define Free_locked(addr) CRYPTO_free_locked(addr)
245
246
247 /* Case insensiteve linking causes problems.... */
248 #if defined(WIN16) || defined(VMS)
249 #define ERR_load_CRYPTO_strings ERR_load_CRYPTOlib_strings
250 #endif
251
252
253 const char *SSLeay_version(int type);
254 unsigned long SSLeay(void);
255
256 int CRYPTO_get_ex_new_index(int idx,STACK **sk,long argl,char *argp,
257         int (*new_func)(),int (*dup_func)(),void (*free_func)());
258 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad,int idx,char *val);
259 char *CRYPTO_get_ex_data(CRYPTO_EX_DATA *ad,int idx);
260 int CRYPTO_dup_ex_data(STACK *meth,CRYPTO_EX_DATA *from,CRYPTO_EX_DATA *to);
261 void CRYPTO_free_ex_data(STACK *meth,char *obj,CRYPTO_EX_DATA *ad);
262 void CRYPTO_new_ex_data(STACK *meth, char *obj, CRYPTO_EX_DATA *ad);
263
264 int CRYPTO_mem_ctrl(int mode);
265 int CRYPTO_mem_check_on(void);
266 int CRYPTO_get_new_lockid(char *name);
267
268 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
269 void CRYPTO_lock(int mode, int type,const char *file,int line);
270 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
271                                               const char *file,int line));
272 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
273                 int line);
274 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
275                                               const char *file, int line));
276 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
277                                           const char *file,int line);
278 void CRYPTO_set_id_callback(unsigned long (*func)(void));
279 unsigned long (*CRYPTO_get_id_callback(void))(void);
280 unsigned long CRYPTO_thread_id(void);
281 const char *CRYPTO_get_lock_name(int type);
282 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
283                     int line);
284
285 void CRYPTO_set_mem_functions(char *(*m)(),char *(*r)(), void (*f)());
286 void CRYPTO_set_mem_debug_functions(void (*m)(),void (*r)(),void (*f)(),void (*so)(),int (*go)());
287 void CRYPTO_set_mem_debug_options(int bits);
288 void CRYPTO_get_mem_functions(char *(**m)(),char *(**r)(), void (**f)());
289 void CRYPTO_get_mem_debug_functions(void (**m)(),void (**r)(),void (**f)(),void (**so)(),int (**go)());
290 int CRYPTO_get_mem_debug_options();
291 void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*free_func)());
292 void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)());
293
294 void *CRYPTO_malloc_locked(int num, char *file, int line);
295 void CRYPTO_free_locked(void *);
296 void *CRYPTO_malloc(int num, char *file, int line);
297 void CRYPTO_free(void *);
298 void *CRYPTO_realloc(void *addr,int num, char *file, int line);
299 void *CRYPTO_remalloc(void *addr,int num, char *file, int line);
300
301 int CRYPTO_add_info(const char *file, int line, const char *info);
302 int CRYPTO_remove_info(void);
303 int CRYPTO_remove_all_info(void);
304
305 /* The last argument has the following significance:
306  *
307  * 0:   called before the actual memory allocation has taken place
308  * 1:   called after the actual memory allocation has taken place
309  */
310 void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
311 void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
312 void CRYPTO_dbg_free(void *addr,int before_p);
313
314 /* Tell the debugging code about options.  By default, the following values
315  * apply:
316  *
317  * 0:   Clear all options.
318  * 1:   Set the "Show Time" option.
319  * 2:   Set the "Show Thread Number" option.
320  * 3:   1 + 2
321  */
322 void CRYPTO_dbg_set_options(int num);
323 int CRYPTO_dbg_get_options();
324
325 #ifndef NO_FP_API
326 void CRYPTO_mem_leaks_fp(FILE *);
327 #endif
328 void CRYPTO_mem_leaks(struct bio_st *bio);
329 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
330 void CRYPTO_mem_leaks_cb(void (*cb)());
331
332 void ERR_load_CRYPTO_strings(void );
333
334 /* BEGIN ERROR CODES */
335 /* The following lines are auto generated by the script mkerr.pl. Any changes
336  * made after this point may be overwritten when the script is next run.
337  */
338
339 /* Error codes for the CRYPTO functions. */
340
341 /* Function codes. */
342 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
343 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
344 #define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
345
346 /* Reason codes. */
347
348 #ifdef  __cplusplus
349 }
350 #endif
351 #endif
352