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