Small error fix.
[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 <stdlib.h>
67
68 #ifndef NO_FP_API
69 #include <stdio.h>
70 #endif
71
72 #include <openssl/stack.h>
73 #include <openssl/safestack.h>
74 #include <openssl/opensslv.h>
75
76 #ifdef CHARSET_EBCDIC
77 #include <openssl/ebcdic.h>
78 #endif
79
80 /* Backward compatibility to SSLeay */
81 /* This is more to be used to check the correct DLL is being used
82  * in the MS world. */
83 #define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
84 #define SSLEAY_VERSION          0
85 /* #define SSLEAY_OPTIONS       1 no longer supported */
86 #define SSLEAY_CFLAGS           2
87 #define SSLEAY_BUILT_ON         3
88 #define SSLEAY_PLATFORM         4
89
90 /* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
91  * names in cryptlib.c
92  */
93
94 #define CRYPTO_LOCK_ERR                 1
95 #define CRYPTO_LOCK_ERR_HASH            2
96 #define CRYPTO_LOCK_X509                3
97 #define CRYPTO_LOCK_X509_INFO           4
98 #define CRYPTO_LOCK_X509_PKEY           5
99 #define CRYPTO_LOCK_X509_CRL            6
100 #define CRYPTO_LOCK_X509_REQ            7
101 #define CRYPTO_LOCK_DSA                 8
102 #define CRYPTO_LOCK_RSA                 9
103 #define CRYPTO_LOCK_EVP_PKEY            10
104 #define CRYPTO_LOCK_X509_STORE          11
105 #define CRYPTO_LOCK_SSL_CTX             12
106 #define CRYPTO_LOCK_SSL_CERT            13
107 #define CRYPTO_LOCK_SSL_SESSION         14
108 #define CRYPTO_LOCK_SSL_SESS_CERT       15
109 #define CRYPTO_LOCK_SSL                 16
110 #define CRYPTO_LOCK_RAND                17
111 #define CRYPTO_LOCK_MALLOC              18
112 #define CRYPTO_LOCK_BIO                 19
113 #define CRYPTO_LOCK_GETHOSTBYNAME       20
114 #define CRYPTO_LOCK_GETSERVBYNAME       21
115 #define CRYPTO_LOCK_READDIR             22
116 #define CRYPTO_LOCK_RSA_BLINDING        23
117 #define CRYPTO_LOCK_DH                  24
118 #define CRYPTO_LOCK_MALLOC2             25
119 #define CRYPTO_NUM_LOCKS                26
120
121 #define CRYPTO_LOCK             1
122 #define CRYPTO_UNLOCK           2
123 #define CRYPTO_READ             4
124 #define CRYPTO_WRITE            8
125
126 #ifndef NO_LOCKING
127 #ifndef CRYPTO_w_lock
128 #define CRYPTO_w_lock(type)     \
129         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
130 #define CRYPTO_w_unlock(type)   \
131         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
132 #define CRYPTO_r_lock(type)     \
133         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
134 #define CRYPTO_r_unlock(type)   \
135         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
136 #define CRYPTO_add(addr,amount,type)    \
137         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
138 #endif
139 #else
140 #define CRYPTO_w_lock(a)
141 #define CRYPTO_w_unlock(a)
142 #define CRYPTO_r_lock(a)
143 #define CRYPTO_r_unlock(a)
144 #define CRYPTO_add(a,b,c)       ((*(a))+=(b))
145 #endif
146
147 /* The following can be used to detect memory leaks in the SSLeay library.
148  * It used, it turns on malloc checking */
149
150 #define CRYPTO_MEM_CHECK_OFF    0x0     /* an enume */
151 #define CRYPTO_MEM_CHECK_ON     0x1     /* a bit */
152 #define CRYPTO_MEM_CHECK_ENABLE 0x2     /* a bit */
153 #define CRYPTO_MEM_CHECK_DISABLE 0x3    /* an enume */
154
155 /* The following are bit values to turn on or off options connected to the
156  * malloc checking functionality */
157
158 /* Adds time to the memory checking information */
159 #define V_CRYPTO_MDEBUG_TIME    0x1 /* a bit */
160 /* Adds thread number to the memory checking information */
161 #define V_CRYPTO_MDEBUG_THREAD  0x2 /* a bit */
162
163 #define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
164
165
166 /* predec of the BIO type */
167 typedef struct bio_st BIO_dummy;
168
169 typedef struct crypto_ex_data_st
170         {
171         STACK *sk;
172         int dummy; /* gcc is screwing up this data structure :-( */
173         } CRYPTO_EX_DATA;
174
175 /* Called when a new object is created */
176 typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
177                                         int idx, long argl, void *argp);
178 /* Called when an object is free()ed */
179 typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
180                                         int idx, long argl, void *argp);
181 /* Called when we need to dup an object */
182 typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, 
183                                         int idx, long argl, void *argp);
184
185 /* This stuff is basically class callback functions
186  * The current classes are SSL_CTX, SSL, SSL_SESION, and a few more */
187
188 typedef struct crypto_ex_data_func_st
189         {
190         long argl;      /* Arbitary long */
191         void *argp;     /* Arbitary void * */
192         CRYPTO_EX_new *new_func;
193         CRYPTO_EX_free *free_func;
194         CRYPTO_EX_dup *dup_func;
195         } CRYPTO_EX_DATA_FUNCS;
196
197 DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
198
199 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
200  * entry.
201  */
202
203 #define CRYPTO_EX_INDEX_BIO             0
204 #define CRYPTO_EX_INDEX_SSL             1
205 #define CRYPTO_EX_INDEX_SSL_CTX         2
206 #define CRYPTO_EX_INDEX_SSL_SESSION     3
207 #define CRYPTO_EX_INDEX_X509_STORE      4
208 #define CRYPTO_EX_INDEX_X509_STORE_CTX  5
209
210
211 /* This is the default callbacks, but we can have others as well:
212  * this is needed in Win32 where the application malloc and the
213  * library malloc may not be the same.
214  */
215 #define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
216         malloc, realloc, free)
217
218 #if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
219 # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
220 #  define CRYPTO_MDEBUG
221 # endif
222 #endif
223
224 /* Set standard debugging functions (not done by default
225  * unless CRYPTO_MDEBUG is defined) */
226 #define CRYPTO_malloc_debug_init()      do {\
227         CRYPTO_set_mem_debug_functions(\
228                 (void (*)())CRYPTO_dbg_malloc,\
229                 (void (*)())CRYPTO_dbg_realloc,\
230                 (void (*)())CRYPTO_dbg_free,\
231                 (void (*)())CRYPTO_dbg_set_options,\
232                 (long (*)())CRYPTO_dbg_get_options);\
233         } while(0)
234
235 int CRYPTO_mem_ctrl(int mode);
236 int CRYPTO_is_mem_check_on(void);
237
238 /* for applications */
239 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
240 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
241
242 /* for library-internal use */
243 #define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
244 #define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
245 #define is_MemCheck_on() CRYPTO_is_mem_check_on()
246
247 #define Malloc(num)     CRYPTO_malloc((int)num,__FILE__,__LINE__)
248 #define Realloc(addr,num) \
249         CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
250 #define Remalloc(addr,num) \
251         CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
252 #define FreeFunc        CRYPTO_free
253 #define Free(addr)      CRYPTO_free(addr)
254
255 #define Malloc_locked(num) CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
256 #define Free_locked(addr) CRYPTO_free_locked(addr)
257
258
259 /* Case insensiteve linking causes problems.... */
260 #if defined(WIN16) || defined(VMS)
261 #define ERR_load_CRYPTO_strings ERR_load_CRYPTOlib_strings
262 #endif
263
264
265 const char *SSLeay_version(int type);
266 unsigned long SSLeay(void);
267
268 int CRYPTO_get_ex_new_index(int idx, STACK_OF(CRYPTO_EX_DATA_FUNCS) **skp, long argl, void *argp,
269              CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
270 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
271 void *CRYPTO_get_ex_data(CRYPTO_EX_DATA *ad,int idx);
272 int CRYPTO_dup_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, CRYPTO_EX_DATA *to,
273              CRYPTO_EX_DATA *from);
274 void CRYPTO_free_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
275 void CRYPTO_new_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
276
277 int CRYPTO_get_new_lockid(char *name);
278
279 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
280 void CRYPTO_lock(int mode, int type,const char *file,int line);
281 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
282                                               const char *file,int line));
283 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
284                 int line);
285 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
286                                               const char *file, int line));
287 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
288                                           const char *file,int line);
289 void CRYPTO_set_id_callback(unsigned long (*func)(void));
290 unsigned long (*CRYPTO_get_id_callback(void))(void);
291 unsigned long CRYPTO_thread_id(void);
292 const char *CRYPTO_get_lock_name(int type);
293 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
294                     int line);
295
296 /* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
297  * call the latter last if you need different functions */
298 int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
299 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
300 int CRYPTO_set_mem_debug_functions(void (*m)(),void (*r)(),void (*f)(),void (*so)(),long (*go)());
301 void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
302 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *));
303 void CRYPTO_get_mem_debug_functions(void (**m)(),void (**r)(),void (**f)(),void (**so)(),long (**go)());
304
305 void *CRYPTO_malloc_locked(int num, const char *file, int line);
306 void CRYPTO_free_locked(void *);
307 void *CRYPTO_malloc(int num, const char *file, int line);
308 void CRYPTO_free(void *);
309 void *CRYPTO_realloc(void *addr,int num, const char *file, int line);
310 void *CRYPTO_remalloc(void *addr,int num, const char *file, int line);
311
312 void CRYPTO_set_mem_debug_options(long bits);
313 long CRYPTO_get_mem_debug_options(void);
314
315 #define CRYPTO_push_info(info) \
316         CRYPTO_push_info_(info, __FILE__, __LINE__);
317 int CRYPTO_push_info_(const char *info, const char *file, int line);
318 int CRYPTO_pop_info(void);
319 int CRYPTO_remove_all_info(void);
320
321 /* The last argument has the following significance:
322  *
323  * 0:   called before the actual memory allocation has taken place
324  * 1:   called after the actual memory allocation has taken place
325  */
326 void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
327 void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
328 void CRYPTO_dbg_free(void *addr,int before_p);
329
330 /* Tell the debugging code about options.  By default, the following values
331  * apply:
332  *
333  * 0:   Clear all options.
334  * 1:   Set the "Show Time" option.
335  * 2:   Set the "Show Thread Number" option.
336  * 3:   1 + 2
337  */
338 void CRYPTO_dbg_set_options(long bits);
339 long CRYPTO_dbg_get_options(void);
340
341 #ifndef NO_FP_API
342 void CRYPTO_mem_leaks_fp(FILE *);
343 #endif
344 void CRYPTO_mem_leaks(struct bio_st *bio);
345 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
346 void CRYPTO_mem_leaks_cb(void (*cb)());
347
348 void ERR_load_CRYPTO_strings(void);
349
350 /* BEGIN ERROR CODES */
351 /* The following lines are auto generated by the script mkerr.pl. Any changes
352  * made after this point may be overwritten when the script is next run.
353  */
354
355 /* Error codes for the CRYPTO functions. */
356
357 /* Function codes. */
358 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
359 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
360 #define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
361
362 /* Reason codes. */
363
364 #ifdef  __cplusplus
365 }
366 #endif
367 #endif
368