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