First step in fixing "ex_data" support. Warning: big commit log ...
[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 #include <stdlib.h>
63
64 #ifndef OPENSSL_NO_FP_API
65 #include <stdio.h>
66 #endif
67
68 #include <openssl/stack.h>
69 #include <openssl/safestack.h>
70 #include <openssl/opensslv.h>
71
72 #ifdef CHARSET_EBCDIC
73 #include <openssl/ebcdic.h>
74 #endif
75
76 /* Resolve problems on some operating systems with symbol names that clash
77    one way or another */
78 #include <openssl/symhacks.h>
79
80 #ifdef  __cplusplus
81 extern "C" {
82 #endif
83
84 /* Backward compatibility to SSLeay */
85 /* This is more to be used to check the correct DLL is being used
86  * in the MS world. */
87 #define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
88 #define SSLEAY_VERSION          0
89 /* #define SSLEAY_OPTIONS       1 no longer supported */
90 #define SSLEAY_CFLAGS           2
91 #define SSLEAY_BUILT_ON         3
92 #define SSLEAY_PLATFORM         4
93 #define SSLEAY_DIR              5
94
95 /* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
96  * names in cryptlib.c
97  */
98
99 #define CRYPTO_LOCK_ERR                 1
100 #define CRYPTO_LOCK_ERR_HASH            2
101 #define CRYPTO_LOCK_X509                3
102 #define CRYPTO_LOCK_X509_INFO           4
103 #define CRYPTO_LOCK_X509_PKEY           5
104 #define CRYPTO_LOCK_X509_CRL            6
105 #define CRYPTO_LOCK_X509_REQ            7
106 #define CRYPTO_LOCK_DSA                 8
107 #define CRYPTO_LOCK_RSA                 9
108 #define CRYPTO_LOCK_EVP_PKEY            10
109 #define CRYPTO_LOCK_X509_STORE          11
110 #define CRYPTO_LOCK_SSL_CTX             12
111 #define CRYPTO_LOCK_SSL_CERT            13
112 #define CRYPTO_LOCK_SSL_SESSION         14
113 #define CRYPTO_LOCK_SSL_SESS_CERT       15
114 #define CRYPTO_LOCK_SSL                 16
115 #define CRYPTO_LOCK_RAND                17
116 #define CRYPTO_LOCK_RAND2               18
117 #define CRYPTO_LOCK_MALLOC              19
118 #define CRYPTO_LOCK_BIO                 20
119 #define CRYPTO_LOCK_GETHOSTBYNAME       21
120 #define CRYPTO_LOCK_GETSERVBYNAME       22
121 #define CRYPTO_LOCK_READDIR             23
122 #define CRYPTO_LOCK_RSA_BLINDING        24
123 #define CRYPTO_LOCK_DH                  25
124 #define CRYPTO_LOCK_MALLOC2             26
125 #define CRYPTO_LOCK_DSO                 27
126 #define CRYPTO_LOCK_DYNLOCK             28
127 #define CRYPTO_LOCK_ENGINE              29
128 #define CRYPTO_LOCK_UI                  30
129 #define CRYPTO_LOCK_EX_DATA             31
130 #define CRYPTO_NUM_LOCKS                32
131
132 #define CRYPTO_LOCK             1
133 #define CRYPTO_UNLOCK           2
134 #define CRYPTO_READ             4
135 #define CRYPTO_WRITE            8
136
137 #ifndef OPENSSL_NO_LOCKING
138 #ifndef CRYPTO_w_lock
139 #define CRYPTO_w_lock(type)     \
140         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
141 #define CRYPTO_w_unlock(type)   \
142         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
143 #define CRYPTO_r_lock(type)     \
144         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
145 #define CRYPTO_r_unlock(type)   \
146         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
147 #define CRYPTO_add(addr,amount,type)    \
148         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
149 #endif
150 #else
151 #define CRYPTO_w_lock(a)
152 #define CRYPTO_w_unlock(a)
153 #define CRYPTO_r_lock(a)
154 #define CRYPTO_r_unlock(a)
155 #define CRYPTO_add(a,b,c)       ((*(a))+=(b))
156 #endif
157
158 /* Some applications as well as some parts of OpenSSL need to allocate
159    and deallocate locks in a dynamic fashion.  The following typedef
160    makes this possible in a type-safe manner.  */
161 /* struct CRYPTO_dynlock_value has to be defined by the application. */
162 typedef struct
163         {
164         int references;
165         struct CRYPTO_dynlock_value *data;
166         } CRYPTO_dynlock;
167
168
169 /* The following can be used to detect memory leaks in the SSLeay library.
170  * It used, it turns on malloc checking */
171
172 #define CRYPTO_MEM_CHECK_OFF    0x0     /* an enume */
173 #define CRYPTO_MEM_CHECK_ON     0x1     /* a bit */
174 #define CRYPTO_MEM_CHECK_ENABLE 0x2     /* a bit */
175 #define CRYPTO_MEM_CHECK_DISABLE 0x3    /* an enume */
176
177 /* The following are bit values to turn on or off options connected to the
178  * malloc checking functionality */
179
180 /* Adds time to the memory checking information */
181 #define V_CRYPTO_MDEBUG_TIME    0x1 /* a bit */
182 /* Adds thread number to the memory checking information */
183 #define V_CRYPTO_MDEBUG_THREAD  0x2 /* a bit */
184
185 #define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
186
187
188 /* predec of the BIO type */
189 typedef struct bio_st BIO_dummy;
190
191 typedef struct crypto_ex_data_st
192         {
193         STACK *sk;
194         int dummy; /* gcc is screwing up this data structure :-( */
195         } CRYPTO_EX_DATA;
196
197 /* Called when a new object is created */
198 typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
199                                         int idx, long argl, void *argp);
200 /* Called when an object is free()ed */
201 typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
202                                         int idx, long argl, void *argp);
203 /* Called when we need to dup an object */
204 typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, 
205                                         int idx, long argl, void *argp);
206
207 /* This stuff is basically class callback functions
208  * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */
209
210 typedef struct crypto_ex_data_func_st
211         {
212         long argl;      /* Arbitary long */
213         void *argp;     /* Arbitary void * */
214         CRYPTO_EX_new *new_func;
215         CRYPTO_EX_free *free_func;
216         CRYPTO_EX_dup *dup_func;
217         } CRYPTO_EX_DATA_FUNCS;
218
219 DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
220
221 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
222  * entry.
223  */
224
225 #define CRYPTO_EX_INDEX_BIO             0
226 #define CRYPTO_EX_INDEX_SSL             1
227 #define CRYPTO_EX_INDEX_SSL_CTX         2
228 #define CRYPTO_EX_INDEX_SSL_SESSION     3
229 #define CRYPTO_EX_INDEX_X509_STORE      4
230 #define CRYPTO_EX_INDEX_X509_STORE_CTX  5
231 #define CRYPTO_EX_INDEX_RSA             6
232 #define CRYPTO_EX_INDEX_DSA             7
233 #define CRYPTO_EX_INDEX_DH              8
234 #define CRYPTO_EX_INDEX_ENGINE          9
235 #define CRYPTO_EX_INDEX_X509            10
236 #define CRYPTO_EX_INDEX_UI              11
237
238 /* Dynamically assigned indexes start from this value (don't use directly, use
239  * via CRYPTO_ex_data_new_class). */
240 #define CRYPTO_EX_INDEX_USER            100
241
242
243 /* This is the default callbacks, but we can have others as well:
244  * this is needed in Win32 where the application malloc and the
245  * library malloc may not be the same.
246  */
247 #define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
248         malloc, realloc, free)
249
250 #if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
251 # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
252 #  define CRYPTO_MDEBUG
253 # endif
254 #endif
255
256 /* Set standard debugging functions (not done by default
257  * unless CRYPTO_MDEBUG is defined) */
258 #define CRYPTO_malloc_debug_init()      do {\
259         CRYPTO_set_mem_debug_functions(\
260                 CRYPTO_dbg_malloc,\
261                 CRYPTO_dbg_realloc,\
262                 CRYPTO_dbg_free,\
263                 CRYPTO_dbg_set_options,\
264                 CRYPTO_dbg_get_options);\
265         } while(0)
266
267 int CRYPTO_mem_ctrl(int mode);
268 int CRYPTO_is_mem_check_on(void);
269
270 /* for applications */
271 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
272 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
273
274 /* for library-internal use */
275 #define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
276 #define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
277 #define is_MemCheck_on() CRYPTO_is_mem_check_on()
278
279 #define OPENSSL_malloc(num)     CRYPTO_malloc((int)num,__FILE__,__LINE__)
280 #define OPENSSL_realloc(addr,num) \
281         CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
282 #define OPENSSL_remalloc(addr,num) \
283         CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
284 #define OPENSSL_freeFunc        CRYPTO_free
285 #define OPENSSL_free(addr)      CRYPTO_free(addr)
286
287 #define OPENSSL_malloc_locked(num) \
288         CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
289 #define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr)
290
291
292 const char *SSLeay_version(int type);
293 unsigned long SSLeay(void);
294
295 int OPENSSL_issetugid(void);
296
297 /* An opaque type representing an implementation of "ex_data" support */
298 typedef struct st_CRYPTO_EX_DATA_IMPL   CRYPTO_EX_DATA_IMPL;
299 /* Return an opaque pointer to the current "ex_data" implementation */
300 const CRYPTO_EX_DATA_IMPL *CRYPTO_get_ex_data_implementation(void);
301 /* Sets the "ex_data" implementation to be used (if it's not too late) */
302 int CRYPTO_set_ex_data_implementation(const CRYPTO_EX_DATA_IMPL *i);
303 /* Get a new "ex_data" class, and return the corresponding "class_index" */
304 int CRYPTO_ex_data_new_class(void);
305 /* Within a given class, get/register a new index */
306 int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
307                 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
308                 CRYPTO_EX_free *free_func);
309 /* Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a given
310  * class (invokes whatever per-class callbacks are applicable) */
311 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
312 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
313                 CRYPTO_EX_DATA *from);
314 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
315 /* Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular index
316  * (relative to the class type involved) */
317 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
318 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad,int idx);
319 /* This function cleans up all "ex_data" state. It mustn't be called under
320  * potential race-conditions. */
321 void CRYPTO_cleanup_all_ex_data(void);
322
323 int CRYPTO_get_new_lockid(char *name);
324
325 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
326 void CRYPTO_lock(int mode, int type,const char *file,int line);
327 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
328                                               const char *file,int line));
329 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
330                 int line);
331 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
332                                               const char *file, int line));
333 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
334                                           const char *file,int line);
335 void CRYPTO_set_id_callback(unsigned long (*func)(void));
336 unsigned long (*CRYPTO_get_id_callback(void))(void);
337 unsigned long CRYPTO_thread_id(void);
338 const char *CRYPTO_get_lock_name(int type);
339 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
340                     int line);
341
342 int CRYPTO_get_new_dynlockid(void);
343 void CRYPTO_destroy_dynlockid(int i);
344 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
345 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, int line));
346 void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line));
347 void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, const char *file, int line));
348 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))(const char *file,int line);
349 void (*CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value *l, const char *file,int line);
350 void (*CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value *l, const char *file,int line);
351
352 /* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
353  * call the latter last if you need different functions */
354 int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
355 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
356 int CRYPTO_set_mem_ex_functions(void *(*m)(size_t,const char *,int),
357                                 void *(*r)(void *,size_t,const char *,int),
358                                 void (*f)(void *));
359 int CRYPTO_set_locked_mem_ex_functions(void *(*m)(size_t,const char *,int),
360                                        void (*free_func)(void *));
361 int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
362                                    void (*r)(void *,void *,int,const char *,int,int),
363                                    void (*f)(void *,int),
364                                    void (*so)(long),
365                                    long (*go)(void));
366 void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
367 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *));
368 void CRYPTO_get_mem_ex_functions(void *(**m)(size_t,const char *,int),
369                                  void *(**r)(void *, size_t,const char *,int),
370                                  void (**f)(void *));
371 void CRYPTO_get_locked_mem_ex_functions(void *(**m)(size_t,const char *,int),
372                                         void (**f)(void *));
373 void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
374                                     void (**r)(void *,void *,int,const char *,int,int),
375                                     void (**f)(void *,int),
376                                     void (**so)(long),
377                                     long (**go)(void));
378
379 void *CRYPTO_malloc_locked(int num, const char *file, int line);
380 void CRYPTO_free_locked(void *);
381 void *CRYPTO_malloc(int num, const char *file, int line);
382 void CRYPTO_free(void *);
383 void *CRYPTO_realloc(void *addr,int num, const char *file, int line);
384 void *CRYPTO_remalloc(void *addr,int num, const char *file, int line);
385
386 void CRYPTO_set_mem_debug_options(long bits);
387 long CRYPTO_get_mem_debug_options(void);
388
389 #define CRYPTO_push_info(info) \
390         CRYPTO_push_info_(info, __FILE__, __LINE__);
391 int CRYPTO_push_info_(const char *info, const char *file, int line);
392 int CRYPTO_pop_info(void);
393 int CRYPTO_remove_all_info(void);
394
395 /* The last argument has the following significance:
396  *
397  * 0:   called before the actual memory allocation has taken place
398  * 1:   called after the actual memory allocation has taken place
399  */
400 void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
401 void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
402 void CRYPTO_dbg_free(void *addr,int before_p);
403
404 /* Tell the debugging code about options.  By default, the following values
405  * apply:
406  *
407  * 0:   Clear all options.
408  * 1:   Set the "Show Time" option.
409  * 2:   Set the "Show Thread Number" option.
410  * 3:   1 + 2
411  */
412 void CRYPTO_dbg_set_options(long bits);
413 long CRYPTO_dbg_get_options(void);
414
415 #ifndef OPENSSL_NO_FP_API
416 void CRYPTO_mem_leaks_fp(FILE *);
417 #endif
418 void CRYPTO_mem_leaks(struct bio_st *bio);
419 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
420 typedef void *CRYPTO_MEM_LEAK_CB(unsigned long, const char *, int, int, void *);
421 void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb);
422
423 void ERR_load_CRYPTO_strings(void);
424
425 /* BEGIN ERROR CODES */
426 /* The following lines are auto generated by the script mkerr.pl. Any changes
427  * made after this point may be overwritten when the script is next run.
428  */
429 void ERR_load_CRYPTO_strings(void);
430
431 /* Error codes for the CRYPTO functions. */
432
433 /* Function codes. */
434 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
435 #define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID                103
436 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
437 #define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
438 #define CRYPTO_F_DEF_ADD_INDEX                           104
439 #define CRYPTO_F_DEF_GET_CLASS                           105
440 #define CRYPTO_F_INT_DUP_EX_DATA                         106
441 #define CRYPTO_F_INT_FREE_EX_DATA                        107
442 #define CRYPTO_F_INT_NEW_EX_DATA                         108
443
444 /* Reason codes. */
445 #define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK              100
446
447 #ifdef  __cplusplus
448 }
449 #endif
450 #endif