Add additional explanation to CHANGES entry.
[openssl.git] / crypto / crypto.h
1 /* crypto/crypto.h */
2 /* ====================================================================
3  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer. 
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    openssl-core@openssl.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This product includes cryptographic software written by Eric Young
51  * (eay@cryptsoft.com).  This product includes software written by Tim
52  * Hudson (tjh@cryptsoft.com).
53  *
54  */
55 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
56  * All rights reserved.
57  *
58  * This package is an SSL implementation written
59  * by Eric Young (eay@cryptsoft.com).
60  * The implementation was written so as to conform with Netscapes SSL.
61  * 
62  * This library is free for commercial and non-commercial use as long as
63  * the following conditions are aheared to.  The following conditions
64  * apply to all code found in this distribution, be it the RC4, RSA,
65  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
66  * included with this distribution is covered by the same copyright terms
67  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
68  * 
69  * Copyright remains Eric Young's, and as such any Copyright notices in
70  * the code are not to be removed.
71  * If this package is used in a product, Eric Young should be given attribution
72  * as the author of the parts of the library used.
73  * This can be in the form of a textual message at program startup or
74  * in documentation (online or textual) provided with the package.
75  * 
76  * Redistribution and use in source and binary forms, with or without
77  * modification, are permitted provided that the following conditions
78  * are met:
79  * 1. Redistributions of source code must retain the copyright
80  *    notice, this list of conditions and the following disclaimer.
81  * 2. Redistributions in binary form must reproduce the above copyright
82  *    notice, this list of conditions and the following disclaimer in the
83  *    documentation and/or other materials provided with the distribution.
84  * 3. All advertising materials mentioning features or use of this software
85  *    must display the following acknowledgement:
86  *    "This product includes cryptographic software written by
87  *     Eric Young (eay@cryptsoft.com)"
88  *    The word 'cryptographic' can be left out if the rouines from the library
89  *    being used are not cryptographic related :-).
90  * 4. If you include any Windows specific code (or a derivative thereof) from 
91  *    the apps directory (application code) you must include an acknowledgement:
92  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
93  * 
94  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
95  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
96  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
97  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
98  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
99  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
100  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
101  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
102  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
103  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
104  * SUCH DAMAGE.
105  * 
106  * The licence and distribution terms for any publically available version or
107  * derivative of this code cannot be changed.  i.e. this code cannot simply be
108  * copied and put under another distribution licence
109  * [including the GNU Public Licence.]
110  */
111 /* ====================================================================
112  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
113  * ECDH support in OpenSSL originally developed by 
114  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115  */
116
117 #ifndef HEADER_CRYPTO_H
118 #define HEADER_CRYPTO_H
119
120 #include <stdlib.h>
121 #include <time.h>
122
123 #include <openssl/e_os2.h>
124
125 #ifndef OPENSSL_NO_FP_API
126 #include <stdio.h>
127 #endif
128
129 /* Get FIPS renames if needed */
130 #if defined(OPENSSL_FIPSCANISTER) && defined(OPENSSL_FIPSAPI)
131 #include <openssl/fips.h>
132 #endif
133
134 #include <openssl/stack.h>
135 #include <openssl/safestack.h>
136 #include <openssl/opensslv.h>
137 #include <openssl/ossl_typ.h>
138
139 #ifdef CHARSET_EBCDIC
140 #include <openssl/ebcdic.h>
141 #endif
142
143 /* Resolve problems on some operating systems with symbol names that clash
144    one way or another */
145 #include <openssl/symhacks.h>
146
147 /* For FIPS mode rename all OpenSSL symbols to avoid clashes with a
148  * non-FIPS OpenSSL.
149  */
150
151 #if defined(OPENSSL_FIPSCANISTER)
152 # include <openssl/fipssyms.h>
153 #else
154 # define __fips_constseg
155 #endif
156
157 #ifdef  __cplusplus
158 extern "C" {
159 #endif
160
161 /* Backward compatibility to SSLeay */
162 /* This is more to be used to check the correct DLL is being used
163  * in the MS world. */
164 #define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
165 #define SSLEAY_VERSION          0
166 /* #define SSLEAY_OPTIONS       1 no longer supported */
167 #define SSLEAY_CFLAGS           2
168 #define SSLEAY_BUILT_ON         3
169 #define SSLEAY_PLATFORM         4
170 #define SSLEAY_DIR              5
171
172 /* Already declared in ossl_typ.h */
173 #if 0
174 typedef struct crypto_ex_data_st CRYPTO_EX_DATA;
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 #endif
185
186 /* A generic structure to pass assorted data in a expandable way */
187 typedef struct openssl_item_st
188         {
189         int code;
190         void *value;            /* Not used for flag attributes */
191         size_t value_size;      /* Max size of value for output, length for input */
192         size_t *value_length;   /* Returned length of value for output */
193         } OPENSSL_ITEM;
194
195
196 /* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
197  * names in cryptlib.c
198  */
199
200 #define CRYPTO_LOCK_ERR                 1
201 #define CRYPTO_LOCK_EX_DATA             2
202 #define CRYPTO_LOCK_X509                3
203 #define CRYPTO_LOCK_X509_INFO           4
204 #define CRYPTO_LOCK_X509_PKEY           5
205 #define CRYPTO_LOCK_X509_CRL            6
206 #define CRYPTO_LOCK_X509_REQ            7
207 #define CRYPTO_LOCK_DSA                 8
208 #define CRYPTO_LOCK_RSA                 9
209 #define CRYPTO_LOCK_EVP_PKEY            10
210 #define CRYPTO_LOCK_X509_STORE          11
211 #define CRYPTO_LOCK_SSL_CTX             12
212 #define CRYPTO_LOCK_SSL_CERT            13
213 #define CRYPTO_LOCK_SSL_SESSION         14
214 #define CRYPTO_LOCK_SSL_SESS_CERT       15
215 #define CRYPTO_LOCK_SSL                 16
216 #define CRYPTO_LOCK_SSL_METHOD          17
217 #define CRYPTO_LOCK_RAND                18
218 #define CRYPTO_LOCK_RAND2               19
219 #define CRYPTO_LOCK_MALLOC              20
220 #define CRYPTO_LOCK_BIO                 21
221 #define CRYPTO_LOCK_GETHOSTBYNAME       22
222 #define CRYPTO_LOCK_GETSERVBYNAME       23
223 #define CRYPTO_LOCK_READDIR             24
224 #define CRYPTO_LOCK_RSA_BLINDING        25
225 #define CRYPTO_LOCK_DH                  26
226 #define CRYPTO_LOCK_MALLOC2             27
227 #define CRYPTO_LOCK_DSO                 28
228 #define CRYPTO_LOCK_DYNLOCK             29
229 #define CRYPTO_LOCK_ENGINE              30
230 #define CRYPTO_LOCK_UI                  31
231 #define CRYPTO_LOCK_ECDSA               32
232 #define CRYPTO_LOCK_EC                  33
233 #define CRYPTO_LOCK_ECDH                34
234 #define CRYPTO_LOCK_BN                  35
235 #define CRYPTO_LOCK_EC_PRE_COMP         36
236 #define CRYPTO_LOCK_STORE               37
237 #define CRYPTO_LOCK_COMP                38
238 #define CRYPTO_LOCK_FIPS                39
239 #define CRYPTO_LOCK_FIPS2               40
240 #define CRYPTO_NUM_LOCKS                41
241
242 #define CRYPTO_LOCK             1
243 #define CRYPTO_UNLOCK           2
244 #define CRYPTO_READ             4
245 #define CRYPTO_WRITE            8
246
247 #ifndef OPENSSL_NO_LOCKING
248 #ifndef CRYPTO_w_lock
249 #define CRYPTO_w_lock(type)     \
250         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
251 #define CRYPTO_w_unlock(type)   \
252         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
253 #define CRYPTO_r_lock(type)     \
254         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
255 #define CRYPTO_r_unlock(type)   \
256         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
257 #define CRYPTO_add(addr,amount,type)    \
258         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
259 #endif
260 #else
261 #define CRYPTO_w_lock(a)
262 #define CRYPTO_w_unlock(a)
263 #define CRYPTO_r_lock(a)
264 #define CRYPTO_r_unlock(a)
265 #define CRYPTO_add(a,b,c)       ((*(a))+=(b))
266 #endif
267
268 /* Some applications as well as some parts of OpenSSL need to allocate
269    and deallocate locks in a dynamic fashion.  The following typedef
270    makes this possible in a type-safe manner.  */
271 /* struct CRYPTO_dynlock_value has to be defined by the application. */
272 typedef struct
273         {
274         int references;
275         struct CRYPTO_dynlock_value *data;
276         } CRYPTO_dynlock;
277
278
279 /* The following can be used to detect memory leaks in the SSLeay library.
280  * It used, it turns on malloc checking */
281
282 #define CRYPTO_MEM_CHECK_OFF    0x0     /* an enume */
283 #define CRYPTO_MEM_CHECK_ON     0x1     /* a bit */
284 #define CRYPTO_MEM_CHECK_ENABLE 0x2     /* a bit */
285 #define CRYPTO_MEM_CHECK_DISABLE 0x3    /* an enume */
286
287 /* The following are bit values to turn on or off options connected to the
288  * malloc checking functionality */
289
290 /* Adds time to the memory checking information */
291 #define V_CRYPTO_MDEBUG_TIME    0x1 /* a bit */
292 /* Adds thread number to the memory checking information */
293 #define V_CRYPTO_MDEBUG_THREAD  0x2 /* a bit */
294
295 #define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
296
297
298 /* predec of the BIO type */
299 typedef struct bio_st BIO_dummy;
300
301 struct crypto_ex_data_st
302         {
303         STACK_OF(void) *sk;
304         int dummy; /* gcc is screwing up this data structure :-( */
305         };
306 DECLARE_STACK_OF(void)
307
308 /* This stuff is basically class callback functions
309  * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */
310
311 typedef struct crypto_ex_data_func_st
312         {
313         long argl;      /* Arbitary long */
314         void *argp;     /* Arbitary void * */
315         CRYPTO_EX_new *new_func;
316         CRYPTO_EX_free *free_func;
317         CRYPTO_EX_dup *dup_func;
318         } CRYPTO_EX_DATA_FUNCS;
319
320 DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
321
322 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
323  * entry.
324  */
325
326 #define CRYPTO_EX_INDEX_BIO             0
327 #define CRYPTO_EX_INDEX_SSL             1
328 #define CRYPTO_EX_INDEX_SSL_CTX         2
329 #define CRYPTO_EX_INDEX_SSL_SESSION     3
330 #define CRYPTO_EX_INDEX_X509_STORE      4
331 #define CRYPTO_EX_INDEX_X509_STORE_CTX  5
332 #define CRYPTO_EX_INDEX_RSA             6
333 #define CRYPTO_EX_INDEX_DSA             7
334 #define CRYPTO_EX_INDEX_DH              8
335 #define CRYPTO_EX_INDEX_ENGINE          9
336 #define CRYPTO_EX_INDEX_X509            10
337 #define CRYPTO_EX_INDEX_UI              11
338 #define CRYPTO_EX_INDEX_ECDSA           12
339 #define CRYPTO_EX_INDEX_ECDH            13
340 #define CRYPTO_EX_INDEX_COMP            14
341 #define CRYPTO_EX_INDEX_STORE           15
342
343 /* Dynamically assigned indexes start from this value (don't use directly, use
344  * via CRYPTO_ex_data_new_class). */
345 #define CRYPTO_EX_INDEX_USER            100
346
347
348 /* This is the default callbacks, but we can have others as well:
349  * this is needed in Win32 where the application malloc and the
350  * library malloc may not be the same.
351  */
352 #define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
353         malloc, realloc, free)
354
355 #if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
356 # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
357 #  define CRYPTO_MDEBUG
358 # endif
359 #endif
360
361 /* Set standard debugging functions (not done by default
362  * unless CRYPTO_MDEBUG is defined) */
363 #define CRYPTO_malloc_debug_init()      do {\
364         CRYPTO_set_mem_debug_functions(\
365                 CRYPTO_dbg_malloc,\
366                 CRYPTO_dbg_realloc,\
367                 CRYPTO_dbg_free,\
368                 CRYPTO_dbg_set_options,\
369                 CRYPTO_dbg_get_options);\
370         } while(0)
371
372 int CRYPTO_mem_ctrl(int mode);
373 int CRYPTO_is_mem_check_on(void);
374
375 /* for applications */
376 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
377 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
378
379 /* for library-internal use */
380 #define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
381 #define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
382 #define is_MemCheck_on() CRYPTO_is_mem_check_on()
383
384 #define OPENSSL_malloc(num)     CRYPTO_malloc((int)num,__FILE__,__LINE__)
385 #define OPENSSL_strdup(str)     CRYPTO_strdup((str),__FILE__,__LINE__)
386 #define OPENSSL_realloc(addr,num) \
387         CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
388 #define OPENSSL_realloc_clean(addr,old_num,num) \
389         CRYPTO_realloc_clean(addr,old_num,num,__FILE__,__LINE__)
390 #define OPENSSL_remalloc(addr,num) \
391         CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
392 #define OPENSSL_freeFunc        CRYPTO_free
393 #define OPENSSL_free(addr)      CRYPTO_free(addr)
394
395 #define OPENSSL_malloc_locked(num) \
396         CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
397 #define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr)
398
399
400 const char *SSLeay_version(int type);
401 unsigned long SSLeay(void);
402
403 int OPENSSL_issetugid(void);
404
405 /* An opaque type representing an implementation of "ex_data" support */
406 typedef struct st_CRYPTO_EX_DATA_IMPL   CRYPTO_EX_DATA_IMPL;
407 /* Return an opaque pointer to the current "ex_data" implementation */
408 const CRYPTO_EX_DATA_IMPL *CRYPTO_get_ex_data_implementation(void);
409 /* Sets the "ex_data" implementation to be used (if it's not too late) */
410 int CRYPTO_set_ex_data_implementation(const CRYPTO_EX_DATA_IMPL *i);
411 /* Get a new "ex_data" class, and return the corresponding "class_index" */
412 int CRYPTO_ex_data_new_class(void);
413 /* Within a given class, get/register a new index */
414 int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
415                 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
416                 CRYPTO_EX_free *free_func);
417 /* Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a given
418  * class (invokes whatever per-class callbacks are applicable) */
419 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
420 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
421                 CRYPTO_EX_DATA *from);
422 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
423 /* Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular index
424  * (relative to the class type involved) */
425 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
426 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad,int idx);
427 /* This function cleans up all "ex_data" state. It mustn't be called under
428  * potential race-conditions. */
429 void CRYPTO_cleanup_all_ex_data(void);
430
431 int CRYPTO_get_new_lockid(char *name);
432
433 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
434 void CRYPTO_lock(int mode, int type,const char *file,int line);
435 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
436                                               const char *file,int line));
437 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
438                 int line);
439 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
440                                               const char *file, int line));
441 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
442                                           const char *file,int line);
443
444 /* Don't use this structure directly. */
445 typedef struct crypto_threadid_st
446         {
447         void *ptr;
448         unsigned long val;
449         } CRYPTO_THREADID;
450 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
451 void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, unsigned long val);
452 void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr);
453 int CRYPTO_THREADID_set_callback(void (*threadid_func)(CRYPTO_THREADID *));
454 void (*CRYPTO_THREADID_get_callback(void))(CRYPTO_THREADID *);
455 void CRYPTO_THREADID_current(CRYPTO_THREADID *id);
456 int CRYPTO_THREADID_cmp(const CRYPTO_THREADID *a, const CRYPTO_THREADID *b);
457 void CRYPTO_THREADID_cpy(CRYPTO_THREADID *dest, const CRYPTO_THREADID *src);
458 unsigned long CRYPTO_THREADID_hash(const CRYPTO_THREADID *id);
459 #ifndef OPENSSL_NO_DEPRECATED
460 void CRYPTO_set_id_callback(unsigned long (*func)(void));
461 unsigned long (*CRYPTO_get_id_callback(void))(void);
462 unsigned long CRYPTO_thread_id(void);
463 #endif
464
465 const char *CRYPTO_get_lock_name(int type);
466 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
467                     int line);
468
469 int CRYPTO_get_new_dynlockid(void);
470 void CRYPTO_destroy_dynlockid(int i);
471 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
472 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, int line));
473 void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line));
474 void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, const char *file, int line));
475 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))(const char *file,int line);
476 void (*CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value *l, const char *file,int line);
477 void (*CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value *l, const char *file,int line);
478
479 /* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
480  * call the latter last if you need different functions */
481 int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
482 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
483 int CRYPTO_set_mem_ex_functions(void *(*m)(size_t,const char *,int),
484                                 void *(*r)(void *,size_t,const char *,int),
485                                 void (*f)(void *));
486 int CRYPTO_set_locked_mem_ex_functions(void *(*m)(size_t,const char *,int),
487                                        void (*free_func)(void *));
488 int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
489                                    void (*r)(void *,void *,int,const char *,int,int),
490                                    void (*f)(void *,int),
491                                    void (*so)(long),
492                                    long (*go)(void));
493 void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
494 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *));
495 void CRYPTO_get_mem_ex_functions(void *(**m)(size_t,const char *,int),
496                                  void *(**r)(void *, size_t,const char *,int),
497                                  void (**f)(void *));
498 void CRYPTO_get_locked_mem_ex_functions(void *(**m)(size_t,const char *,int),
499                                         void (**f)(void *));
500 void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
501                                     void (**r)(void *,void *,int,const char *,int,int),
502                                     void (**f)(void *,int),
503                                     void (**so)(long),
504                                     long (**go)(void));
505
506 void *CRYPTO_malloc_locked(int num, const char *file, int line);
507 void CRYPTO_free_locked(void *ptr);
508 void *CRYPTO_malloc(int num, const char *file, int line);
509 char *CRYPTO_strdup(const char *str, const char *file, int line);
510 void CRYPTO_free(void *ptr);
511 void *CRYPTO_realloc(void *addr,int num, const char *file, int line);
512 void *CRYPTO_realloc_clean(void *addr,int old_num,int num,const char *file,
513                            int line);
514 void *CRYPTO_remalloc(void *addr,int num, const char *file, int line);
515
516 void OPENSSL_cleanse(void *ptr, size_t len);
517
518 void CRYPTO_set_mem_debug_options(long bits);
519 long CRYPTO_get_mem_debug_options(void);
520
521 #define CRYPTO_push_info(info) \
522         CRYPTO_push_info_(info, __FILE__, __LINE__);
523 int CRYPTO_push_info_(const char *info, const char *file, int line);
524 int CRYPTO_pop_info(void);
525 int CRYPTO_remove_all_info(void);
526
527
528 /* Default debugging functions (enabled by CRYPTO_malloc_debug_init() macro;
529  * used as default in CRYPTO_MDEBUG compilations): */
530 /* The last argument has the following significance:
531  *
532  * 0:   called before the actual memory allocation has taken place
533  * 1:   called after the actual memory allocation has taken place
534  */
535 void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
536 void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
537 void CRYPTO_dbg_free(void *addr,int before_p);
538 /* Tell the debugging code about options.  By default, the following values
539  * apply:
540  *
541  * 0:                           Clear all options.
542  * V_CRYPTO_MDEBUG_TIME (1):    Set the "Show Time" option.
543  * V_CRYPTO_MDEBUG_THREAD (2):  Set the "Show Thread Number" option.
544  * V_CRYPTO_MDEBUG_ALL (3):     1 + 2
545  */
546 void CRYPTO_dbg_set_options(long bits);
547 long CRYPTO_dbg_get_options(void);
548
549
550 #ifndef OPENSSL_NO_FP_API
551 void CRYPTO_mem_leaks_fp(FILE *);
552 #endif
553 void CRYPTO_mem_leaks(struct bio_st *bio);
554 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
555 typedef void *CRYPTO_MEM_LEAK_CB(unsigned long, const char *, int, int, void *);
556 void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb);
557
558 /* die if we have to */
559 void OpenSSLDie(const char *file,int line,const char *assertion);
560 #define OPENSSL_assert(e)       (void)((e) ? 0 : (OpenSSLDie(__FILE__, __LINE__, #e),1))
561
562 unsigned int *OPENSSL_ia32cap_loc(void);
563 #define OPENSSL_ia32cap ((OPENSSL_ia32cap_loc())[0])
564 int OPENSSL_isservice(void);
565
566 int FIPS_mode(void);
567 int FIPS_mode_set(int r);
568
569 void OPENSSL_init(void);
570
571 /* CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal. It
572  * takes an amount of time dependent on |len|, but independent of the contents
573  * of |a| and |b|. Unlike memcmp, it cannot be used to put elements into a
574  * defined order as the return value when a != b is undefined, other than to be
575  * non-zero. */
576 int CRYPTO_memcmp(const void *a, const void *b, size_t len);
577
578 /* BEGIN ERROR CODES */
579 /* The following lines are auto generated by the script mkerr.pl. Any changes
580  * made after this point may be overwritten when the script is next run.
581  */
582 void ERR_load_CRYPTO_strings(void);
583
584 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
585 int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
586 int OPENSSL_gmtime_diff(int *pday, int *psec,
587                         const struct tm *from, const struct tm *to);
588
589 /* Error codes for the CRYPTO functions. */
590
591 /* Function codes. */
592 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
593 #define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID                103
594 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
595 #define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
596 #define CRYPTO_F_DEF_ADD_INDEX                           104
597 #define CRYPTO_F_DEF_GET_CLASS                           105
598 #define CRYPTO_F_FIPS_MODE_SET                           109
599 #define CRYPTO_F_INT_DUP_EX_DATA                         106
600 #define CRYPTO_F_INT_FREE_EX_DATA                        107
601 #define CRYPTO_F_INT_NEW_EX_DATA                         108
602
603 /* Reason codes. */
604 #define CRYPTO_R_FIPS_MODE_NOT_SUPPORTED                 101
605 #define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK              100
606
607 #ifdef  __cplusplus
608 }
609 #endif
610 #endif