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