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