Move more comments that confuse indent
[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_STDIO
126 #include <stdio.h>
127 #endif
128
129 #include <openssl/stack.h>
130 #include <openssl/safestack.h>
131 #include <openssl/opensslv.h>
132 #include <openssl/ossl_typ.h>
133
134 #ifdef CHARSET_EBCDIC
135 #include <openssl/ebcdic.h>
136 #endif
137
138 /* Resolve problems on some operating systems with symbol names that clash
139    one way or another */
140 #include <openssl/symhacks.h>
141
142 #ifdef  __cplusplus
143 extern "C" {
144 #endif
145
146 /* Backward compatibility to SSLeay */
147 /* This is more to be used to check the correct DLL is being used
148  * in the MS world. */
149 #define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
150 #define SSLEAY_VERSION          0
151 /* #define SSLEAY_OPTIONS       1 no longer supported */
152 #define SSLEAY_CFLAGS           2
153 #define SSLEAY_BUILT_ON         3
154 #define SSLEAY_PLATFORM         4
155 #define SSLEAY_DIR              5
156
157 /* Already declared in ossl_typ.h */
158 #if 0
159 typedef struct crypto_ex_data_st CRYPTO_EX_DATA;
160 /* Called when a new object is created */
161 typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
162                                         int idx, long argl, void *argp);
163 /* Called when an object is free()ed */
164 typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
165                                         int idx, long argl, void *argp);
166 /* Called when we need to dup an object */
167 typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, 
168                                         int idx, long argl, void *argp);
169 #endif
170
171 /* A generic structure to pass assorted data in a expandable way */
172 typedef struct openssl_item_st
173         {
174         int code;
175         void *value;            /* Not used for flag attributes */
176         size_t value_size;      /* Max size of value for output, length for input */
177         size_t *value_length;   /* Returned length of value for output */
178         } OPENSSL_ITEM;
179
180
181 /* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
182  * names in cryptlib.c
183  */
184
185 #define CRYPTO_LOCK_ERR                 1
186 #define CRYPTO_LOCK_EX_DATA             2
187 #define CRYPTO_LOCK_X509                3
188 #define CRYPTO_LOCK_X509_INFO           4
189 #define CRYPTO_LOCK_X509_PKEY           5
190 #define CRYPTO_LOCK_X509_CRL            6
191 #define CRYPTO_LOCK_X509_REQ            7
192 #define CRYPTO_LOCK_DSA                 8
193 #define CRYPTO_LOCK_RSA                 9
194 #define CRYPTO_LOCK_EVP_PKEY            10
195 #define CRYPTO_LOCK_X509_STORE          11
196 #define CRYPTO_LOCK_SSL_CTX             12
197 #define CRYPTO_LOCK_SSL_CERT            13
198 #define CRYPTO_LOCK_SSL_SESSION         14
199 #define CRYPTO_LOCK_SSL_SESS_CERT       15
200 #define CRYPTO_LOCK_SSL                 16
201 #define CRYPTO_LOCK_SSL_METHOD          17
202 #define CRYPTO_LOCK_RAND                18
203 #define CRYPTO_LOCK_RAND2               19
204 #define CRYPTO_LOCK_MALLOC              20
205 #define CRYPTO_LOCK_BIO                 21
206 #define CRYPTO_LOCK_GETHOSTBYNAME       22
207 #define CRYPTO_LOCK_GETSERVBYNAME       23
208 #define CRYPTO_LOCK_READDIR             24
209 #define CRYPTO_LOCK_RSA_BLINDING        25
210 #define CRYPTO_LOCK_DH                  26
211 #define CRYPTO_LOCK_MALLOC2             27
212 #define CRYPTO_LOCK_DSO                 28
213 #define CRYPTO_LOCK_DYNLOCK             29
214 #define CRYPTO_LOCK_ENGINE              30
215 #define CRYPTO_LOCK_UI                  31
216 #define CRYPTO_LOCK_ECDSA               32
217 #define CRYPTO_LOCK_EC                  33
218 #define CRYPTO_LOCK_ECDH                34
219 #define CRYPTO_LOCK_BN                  35
220 #define CRYPTO_LOCK_EC_PRE_COMP         36
221 #define CRYPTO_LOCK_STORE               37
222 #define CRYPTO_LOCK_COMP                38
223 #define CRYPTO_LOCK_FIPS                39
224 #define CRYPTO_LOCK_FIPS2               40
225 #define CRYPTO_NUM_LOCKS                41
226
227 #define CRYPTO_LOCK             1
228 #define CRYPTO_UNLOCK           2
229 #define CRYPTO_READ             4
230 #define CRYPTO_WRITE            8
231
232 #ifndef OPENSSL_NO_LOCKING
233 #ifndef CRYPTO_w_lock
234 #define CRYPTO_w_lock(type)     \
235         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
236 #define CRYPTO_w_unlock(type)   \
237         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
238 #define CRYPTO_r_lock(type)     \
239         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
240 #define CRYPTO_r_unlock(type)   \
241         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
242 #define CRYPTO_add(addr,amount,type)    \
243         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
244 #endif
245 #else
246 #define CRYPTO_w_lock(a)
247 #define CRYPTO_w_unlock(a)
248 #define CRYPTO_r_lock(a)
249 #define CRYPTO_r_unlock(a)
250 #define CRYPTO_add(a,b,c)       ((*(a))+=(b))
251 #endif
252
253 /* Some applications as well as some parts of OpenSSL need to allocate
254    and deallocate locks in a dynamic fashion.  The following typedef
255    makes this possible in a type-safe manner.  */
256 /* struct CRYPTO_dynlock_value has to be defined by the application. */
257 typedef struct
258         {
259         int references;
260         struct CRYPTO_dynlock_value *data;
261         } CRYPTO_dynlock;
262
263
264 /* The following can be used to detect memory leaks in the SSLeay library.
265  * It used, it turns on malloc checking */
266
267 #define CRYPTO_MEM_CHECK_OFF    0x0     /* an enume */
268 #define CRYPTO_MEM_CHECK_ON     0x1     /* a bit */
269 #define CRYPTO_MEM_CHECK_ENABLE 0x2     /* a bit */
270 #define CRYPTO_MEM_CHECK_DISABLE 0x3    /* an enume */
271
272 /* The following are bit values to turn on or off options connected to the
273  * malloc checking functionality */
274
275 /* Adds time to the memory checking information */
276 #define V_CRYPTO_MDEBUG_TIME    0x1 /* a bit */
277 /* Adds thread number to the memory checking information */
278 #define V_CRYPTO_MDEBUG_THREAD  0x2 /* a bit */
279
280 #define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
281
282
283 /* predec of the BIO type */
284 typedef struct bio_st BIO_dummy;
285
286 struct crypto_ex_data_st
287         {
288         STACK_OF(void) *sk;
289         /* gcc is screwing up this data structure :-( */
290         int dummy;
291         };
292 DECLARE_STACK_OF(void)
293
294 /* This stuff is basically class callback functions
295  * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */
296
297 typedef struct crypto_ex_data_func_st
298         {
299         long argl;      /* Arbitary long */
300         void *argp;     /* Arbitary void * */
301         CRYPTO_EX_new *new_func;
302         CRYPTO_EX_free *free_func;
303         CRYPTO_EX_dup *dup_func;
304         } CRYPTO_EX_DATA_FUNCS;
305
306 DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
307
308 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
309  * entry.
310  */
311
312 #define CRYPTO_EX_INDEX_BIO             0
313 #define CRYPTO_EX_INDEX_SSL             1
314 #define CRYPTO_EX_INDEX_SSL_CTX         2
315 #define CRYPTO_EX_INDEX_SSL_SESSION     3
316 #define CRYPTO_EX_INDEX_X509_STORE      4
317 #define CRYPTO_EX_INDEX_X509_STORE_CTX  5
318 #define CRYPTO_EX_INDEX_RSA             6
319 #define CRYPTO_EX_INDEX_DSA             7
320 #define CRYPTO_EX_INDEX_DH              8
321 #define CRYPTO_EX_INDEX_ENGINE          9
322 #define CRYPTO_EX_INDEX_X509            10
323 #define CRYPTO_EX_INDEX_UI              11
324 #define CRYPTO_EX_INDEX_ECDSA           12
325 #define CRYPTO_EX_INDEX_ECDH            13
326 #define CRYPTO_EX_INDEX_COMP            14
327 #define CRYPTO_EX_INDEX_STORE           15
328
329 /* Dynamically assigned indexes start from this value (don't use directly, use
330  * via CRYPTO_ex_data_new_class). */
331 #define CRYPTO_EX_INDEX_USER            100
332
333
334 /* This is the default callbacks, but we can have others as well:
335  * this is needed in Win32 where the application malloc and the
336  * library malloc may not be the same.
337  */
338 #define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
339         malloc, realloc, free)
340
341 #if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
342 # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
343 #  define CRYPTO_MDEBUG
344 # endif
345 #endif
346
347 /* Set standard debugging functions (not done by default
348  * unless CRYPTO_MDEBUG is defined) */
349 #define CRYPTO_malloc_debug_init()      do {\
350         CRYPTO_set_mem_debug_functions(\
351                 CRYPTO_dbg_malloc,\
352                 CRYPTO_dbg_realloc,\
353                 CRYPTO_dbg_free,\
354                 CRYPTO_dbg_set_options,\
355                 CRYPTO_dbg_get_options);\
356         } while(0)
357
358 int CRYPTO_mem_ctrl(int mode);
359 int CRYPTO_is_mem_check_on(void);
360
361 /* for applications */
362 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
363 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
364
365 /* for library-internal use */
366 #define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
367 #define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
368 #define is_MemCheck_on() CRYPTO_is_mem_check_on()
369
370 #define OPENSSL_malloc(num)     CRYPTO_malloc((int)num,__FILE__,__LINE__)
371 #define OPENSSL_strdup(str)     CRYPTO_strdup((str),__FILE__,__LINE__)
372 #define OPENSSL_realloc(addr,num) \
373         CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
374 #define OPENSSL_realloc_clean(addr,old_num,num) \
375         CRYPTO_realloc_clean(addr,old_num,num,__FILE__,__LINE__)
376 #define OPENSSL_remalloc(addr,num) \
377         CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
378 #define OPENSSL_freeFunc        CRYPTO_free
379 #define OPENSSL_free(addr)      CRYPTO_free(addr)
380
381 #define OPENSSL_malloc_locked(num) \
382         CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
383 #define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr)
384 #define OPENSSL_MALLOC_MAX_NELEMS(type)  (((1U<<(sizeof(int)*8-1))-1)/sizeof(type))
385
386
387 const char *SSLeay_version(int type);
388 unsigned long SSLeay(void);
389
390 int OPENSSL_issetugid(void);
391
392 /* An opaque type representing an implementation of "ex_data" support */
393 typedef struct st_CRYPTO_EX_DATA_IMPL   CRYPTO_EX_DATA_IMPL;
394 /* Return an opaque pointer to the current "ex_data" implementation */
395 const CRYPTO_EX_DATA_IMPL *CRYPTO_get_ex_data_implementation(void);
396 /* Sets the "ex_data" implementation to be used (if it's not too late) */
397 int CRYPTO_set_ex_data_implementation(const CRYPTO_EX_DATA_IMPL *i);
398 /* Get a new "ex_data" class, and return the corresponding "class_index" */
399 int CRYPTO_ex_data_new_class(void);
400 /* Within a given class, get/register a new index */
401 int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
402                 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
403                 CRYPTO_EX_free *free_func);
404 /* Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a given
405  * class (invokes whatever per-class callbacks are applicable) */
406 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
407 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
408                 CRYPTO_EX_DATA *from);
409 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
410 /* Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular index
411  * (relative to the class type involved) */
412 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
413 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad,int idx);
414 /* This function cleans up all "ex_data" state. It mustn't be called under
415  * potential race-conditions. */
416 void CRYPTO_cleanup_all_ex_data(void);
417
418 int CRYPTO_get_new_lockid(char *name);
419
420 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
421 void CRYPTO_lock(int mode, int type,const char *file,int line);
422 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
423                                               const char *file,int line));
424 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
425                 int line);
426 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
427                                               const char *file, int line));
428 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
429                                           const char *file,int line);
430
431 /* Don't use this structure directly. */
432 typedef struct crypto_threadid_st
433         {
434         void *ptr;
435         unsigned long val;
436         } CRYPTO_THREADID;
437 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
438 void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, unsigned long val);
439 void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr);
440 int CRYPTO_THREADID_set_callback(void (*threadid_func)(CRYPTO_THREADID *));
441 void (*CRYPTO_THREADID_get_callback(void))(CRYPTO_THREADID *);
442 void CRYPTO_THREADID_current(CRYPTO_THREADID *id);
443 int CRYPTO_THREADID_cmp(const CRYPTO_THREADID *a, const CRYPTO_THREADID *b);
444 void CRYPTO_THREADID_cpy(CRYPTO_THREADID *dest, const CRYPTO_THREADID *src);
445 unsigned long CRYPTO_THREADID_hash(const CRYPTO_THREADID *id);
446 #ifdef OPENSSL_USE_DEPRECATED
447 DECLARE_DEPRECATED(void CRYPTO_set_id_callback(unsigned long (*func)(void)));
448 /*
449  * mkdef.pl cannot handle this next one so not inside DECLARE_DEPRECATED,
450  * but still inside OPENSSL_USE_DEPRECATED
451  */
452 unsigned long (*CRYPTO_get_id_callback(void))(void);
453 DECLARE_DEPRECATED(unsigned long CRYPTO_thread_id(void));
454 #endif
455
456 const char *CRYPTO_get_lock_name(int type);
457 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
458                     int line);
459
460 int CRYPTO_get_new_dynlockid(void);
461 void CRYPTO_destroy_dynlockid(int i);
462 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
463 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, int line));
464 void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line));
465 void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, const char *file, int line));
466 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))(const char *file,int line);
467 void (*CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value *l, const char *file,int line);
468 void (*CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value *l, const char *file,int line);
469
470 /* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
471  * call the latter last if you need different functions */
472 int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
473 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
474 int CRYPTO_set_mem_ex_functions(void *(*m)(size_t,const char *,int),
475                                 void *(*r)(void *,size_t,const char *,int),
476                                 void (*f)(void *));
477 int CRYPTO_set_locked_mem_ex_functions(void *(*m)(size_t,const char *,int),
478                                        void (*free_func)(void *));
479 int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
480                                    void (*r)(void *,void *,int,const char *,int,int),
481                                    void (*f)(void *,int),
482                                    void (*so)(long),
483                                    long (*go)(void));
484 void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
485 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *));
486 void CRYPTO_get_mem_ex_functions(void *(**m)(size_t,const char *,int),
487                                  void *(**r)(void *, size_t,const char *,int),
488                                  void (**f)(void *));
489 void CRYPTO_get_locked_mem_ex_functions(void *(**m)(size_t,const char *,int),
490                                         void (**f)(void *));
491 void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
492                                     void (**r)(void *,void *,int,const char *,int,int),
493                                     void (**f)(void *,int),
494                                     void (**so)(long),
495                                     long (**go)(void));
496
497 void *CRYPTO_malloc_locked(int num, const char *file, int line);
498 void CRYPTO_free_locked(void *ptr);
499 void *CRYPTO_malloc(int num, const char *file, int line);
500 char *CRYPTO_strdup(const char *str, const char *file, int line);
501 void CRYPTO_free(void *ptr);
502 void *CRYPTO_realloc(void *addr,int num, const char *file, int line);
503 void *CRYPTO_realloc_clean(void *addr,int old_num,int num,const char *file,
504                            int line);
505 void *CRYPTO_remalloc(void *addr,int num, const char *file, int line);
506
507 void OPENSSL_cleanse(void *ptr, size_t len);
508
509 void CRYPTO_set_mem_debug_options(long bits);
510 long CRYPTO_get_mem_debug_options(void);
511
512 #define CRYPTO_push_info(info) \
513         CRYPTO_push_info_(info, __FILE__, __LINE__);
514 int CRYPTO_push_info_(const char *info, const char *file, int line);
515 int CRYPTO_pop_info(void);
516 int CRYPTO_remove_all_info(void);
517
518
519 /* Default debugging functions (enabled by CRYPTO_malloc_debug_init() macro;
520  * used as default in CRYPTO_MDEBUG compilations): */
521 /*-
522  * The last argument has the following significance:
523  *
524  * 0:   called before the actual memory allocation has taken place
525  * 1:   called after the actual memory allocation has taken place
526  */
527 void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
528 void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
529 void CRYPTO_dbg_free(void *addr,int before_p);
530 /*-
531  * Tell the debugging code about options.  By default, the following values
532  * apply:
533  *
534  * 0:                           Clear all options.
535  * V_CRYPTO_MDEBUG_TIME (1):    Set the "Show Time" option.
536  * V_CRYPTO_MDEBUG_THREAD (2):  Set the "Show Thread Number" option.
537  * V_CRYPTO_MDEBUG_ALL (3):     1 + 2
538  */
539 void CRYPTO_dbg_set_options(long bits);
540 long CRYPTO_dbg_get_options(void);
541
542
543 #ifndef OPENSSL_NO_STDIO
544 void CRYPTO_mem_leaks_fp(FILE *);
545 #endif
546 void CRYPTO_mem_leaks(struct bio_st *bio);
547 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
548 typedef void *CRYPTO_MEM_LEAK_CB(unsigned long, const char *, int, int, void *);
549 void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb);
550
551 /* die if we have to */
552 void OpenSSLDie(const char *file,int line,const char *assertion);
553 #define OPENSSL_assert(e)       (void)((e) ? 0 : (OpenSSLDie(__FILE__, __LINE__, #e),1))
554
555 unsigned int *OPENSSL_ia32cap_loc(void);
556 #define OPENSSL_ia32cap ((OPENSSL_ia32cap_loc())[0])
557 int OPENSSL_isservice(void);
558
559 int FIPS_mode(void);
560 int FIPS_mode_set(int r);
561
562 void OPENSSL_init(void);
563
564 /* CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal. It
565  * takes an amount of time dependent on |len|, but independent of the contents
566  * of |a| and |b|. Unlike memcmp, it cannot be used to put elements into a
567  * defined order as the return value when a != b is undefined, other than to be
568  * non-zero. */
569 int CRYPTO_memcmp(const void *a, const void *b, size_t len);
570
571 /* BEGIN ERROR CODES */
572 /* The following lines are auto generated by the script mkerr.pl. Any changes
573  * made after this point may be overwritten when the script is next run.
574  */
575 void ERR_load_CRYPTO_strings(void);
576
577 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
578 int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
579 int OPENSSL_gmtime_diff(int *pday, int *psec,
580                         const struct tm *from, const struct tm *to);
581
582 /* Error codes for the CRYPTO functions. */
583
584 /* Function codes. */
585 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
586 #define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID                103
587 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
588 #define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
589 #define CRYPTO_F_DEF_ADD_INDEX                           104
590 #define CRYPTO_F_DEF_GET_CLASS                           105
591 #define CRYPTO_F_FIPS_MODE_SET                           109
592 #define CRYPTO_F_INT_DUP_EX_DATA                         106
593 #define CRYPTO_F_INT_FREE_EX_DATA                        107
594 #define CRYPTO_F_INT_NEW_EX_DATA                         108
595
596 /* Reason codes. */
597 #define CRYPTO_R_FIPS_MODE_NOT_SUPPORTED                 101
598 #define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK              100
599
600 #ifdef  __cplusplus
601 }
602 #endif
603 #endif