Convert CRYPTO_LOCK_GET*BYNAME to new multi-threading API
[openssl.git] / include / openssl / crypto.h
1 /* ====================================================================
2  * Copyright (c) 1998-2016 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@openssl.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This product includes cryptographic software written by Eric Young
50  * (eay@cryptsoft.com).  This product includes software written by Tim
51  * Hudson (tjh@cryptsoft.com).
52  *
53  */
54 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
55  * All rights reserved.
56  *
57  * This package is an SSL implementation written
58  * by Eric Young (eay@cryptsoft.com).
59  * The implementation was written so as to conform with Netscapes SSL.
60  *
61  * This library is free for commercial and non-commercial use as long as
62  * the following conditions are aheared to.  The following conditions
63  * apply to all code found in this distribution, be it the RC4, RSA,
64  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
65  * included with this distribution is covered by the same copyright terms
66  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
67  *
68  * Copyright remains Eric Young's, and as such any Copyright notices in
69  * the code are not to be removed.
70  * If this package is used in a product, Eric Young should be given attribution
71  * as the author of the parts of the library used.
72  * This can be in the form of a textual message at program startup or
73  * in documentation (online or textual) provided with the package.
74  *
75  * Redistribution and use in source and binary forms, with or without
76  * modification, are permitted provided that the following conditions
77  * are met:
78  * 1. Redistributions of source code must retain the copyright
79  *    notice, this list of conditions and the following disclaimer.
80  * 2. Redistributions in binary form must reproduce the above copyright
81  *    notice, this list of conditions and the following disclaimer in the
82  *    documentation and/or other materials provided with the distribution.
83  * 3. All advertising materials mentioning features or use of this software
84  *    must display the following acknowledgement:
85  *    "This product includes cryptographic software written by
86  *     Eric Young (eay@cryptsoft.com)"
87  *    The word 'cryptographic' can be left out if the rouines from the library
88  *    being used are not cryptographic related :-).
89  * 4. If you include any Windows specific code (or a derivative thereof) from
90  *    the apps directory (application code) you must include an acknowledgement:
91  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
92  *
93  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
94  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
95  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
96  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
97  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
98  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
99  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
101  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
102  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
103  * SUCH DAMAGE.
104  *
105  * The licence and distribution terms for any publically available version or
106  * derivative of this code cannot be changed.  i.e. this code cannot simply be
107  * copied and put under another distribution licence
108  * [including the GNU Public Licence.]
109  */
110 /* ====================================================================
111  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
112  * ECDH support in OpenSSL originally developed by
113  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
114  */
115
116 #ifndef HEADER_CRYPTO_H
117 # define HEADER_CRYPTO_H
118
119 # include <stdlib.h>
120 # include <time.h>
121
122 # include <openssl/e_os2.h>
123
124 # ifndef OPENSSL_NO_STDIO
125 #  include <stdio.h>
126 # endif
127
128 # include <openssl/stack.h>
129 # include <openssl/safestack.h>
130 # include <openssl/opensslv.h>
131 # include <openssl/ossl_typ.h>
132 # include <openssl/opensslconf.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 # if OPENSSL_API_COMPAT < 0x10100000L
145 #  include <openssl/opensslv.h>
146 # endif
147
148 #ifdef  __cplusplus
149 extern "C" {
150 #endif
151
152 # if OPENSSL_API_COMPAT < 0x10100000L
153 #  define SSLeay                  OpenSSL_version_num
154 #  define SSLeay_version          OpenSSL_version
155 #  define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
156 #  define SSLEAY_VERSION          OPENSSL_VERSION
157 #  define SSLEAY_CFLAGS           OPENSSL_CFLAGS
158 #  define SSLEAY_BUILT_ON         OPENSSL_BUILT_ON
159 #  define SSLEAY_PLATFORM         OPENSSL_PLATFORM
160 #  define SSLEAY_DIR              OPENSSL_DIR
161 # endif /* OPENSSL_API_COMPAT */
162
163 /*
164  * When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
165  * names in cryptlib.c
166  */
167
168 # define CRYPTO_LOCK_ERR                 1
169 # define CRYPTO_LOCK_EX_DATA             2
170 # define CRYPTO_LOCK_X509                3
171 # define CRYPTO_LOCK_X509_INFO           4
172 # define CRYPTO_LOCK_X509_PKEY           5
173 # define CRYPTO_LOCK_X509_CRL            6
174 # define CRYPTO_LOCK_X509_REQ            7
175 # define CRYPTO_LOCK_DSA                 8
176 # define CRYPTO_LOCK_RSA                 9
177 # define CRYPTO_LOCK_EVP_PKEY            10
178 # define CRYPTO_LOCK_X509_STORE          11
179 # define CRYPTO_LOCK_SSL_CTX             12
180 # define CRYPTO_LOCK_SSL_CERT            13
181 # define CRYPTO_LOCK_SSL_SESSION         14
182 # define CRYPTO_LOCK_SSL_SESS_CERT       15
183 # define CRYPTO_LOCK_SSL                 16
184 # define CRYPTO_LOCK_SSL_METHOD          17
185 # define CRYPTO_LOCK_RAND                18
186 # define CRYPTO_LOCK_RAND2               19
187 # define CRYPTO_LOCK_MALLOC              20
188 # define CRYPTO_LOCK_BIO                 21
189 # define CRYPTO_LOCK_READDIR             24
190 # define CRYPTO_LOCK_RSA_BLINDING        25
191 # define CRYPTO_LOCK_DH                  26
192 # define CRYPTO_LOCK_MALLOC2             27
193 # define CRYPTO_LOCK_DSO                 28
194 # define CRYPTO_LOCK_DYNLOCK             29
195 # define CRYPTO_LOCK_ENGINE              30
196 # define CRYPTO_LOCK_UI                  31
197 # define CRYPTO_LOCK_ECDSA               32
198 # define CRYPTO_LOCK_EC                  33
199 # define CRYPTO_LOCK_ECDH                34
200 # define CRYPTO_LOCK_BN                  35
201 # define CRYPTO_LOCK_EC_PRE_COMP         36
202 # define CRYPTO_LOCK_STORE               37
203 # define CRYPTO_LOCK_COMP                38
204 # define CRYPTO_LOCK_FIPS                39
205 # define CRYPTO_LOCK_FIPS2               40
206 # define CRYPTO_NUM_LOCKS                41
207
208 # define CRYPTO_LOCK             1
209 # define CRYPTO_UNLOCK           2
210 # define CRYPTO_READ             4
211 # define CRYPTO_WRITE            8
212
213 # ifndef OPENSSL_NO_LOCKING
214 #  ifndef CRYPTO_w_lock
215 #   define CRYPTO_w_lock(type)     \
216         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,OPENSSL_FILE,OPENSSL_LINE)
217 #   define CRYPTO_w_unlock(type)   \
218         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,OPENSSL_FILE,OPENSSL_LINE)
219 #   define CRYPTO_r_lock(type)     \
220         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,OPENSSL_FILE,OPENSSL_LINE)
221 #   define CRYPTO_r_unlock(type)   \
222         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,OPENSSL_FILE,OPENSSL_LINE)
223 #   define CRYPTO_add(addr,amount,type)    \
224         CRYPTO_add_lock(addr,amount,type,OPENSSL_FILE,OPENSSL_LINE)
225 #  endif
226 # else
227 #  define CRYPTO_w_lock(a)
228 #  define CRYPTO_w_unlock(a)
229 #  define CRYPTO_r_lock(a)
230 #  define CRYPTO_r_unlock(a)
231 #  define CRYPTO_add(a,b,c)       ((*(a))+=(b))
232 # endif
233
234 /*
235  * Some applications as well as some parts of OpenSSL need to allocate and
236  * deallocate locks in a dynamic fashion.  The following typedef makes this
237  * possible in a type-safe manner.
238  * struct CRYPTO_dynlock_value has to be defined by the application.
239  */
240 typedef struct {
241     int references;
242     struct CRYPTO_dynlock_value *data;
243 } CRYPTO_dynlock;
244
245 typedef void CRYPTO_RWLOCK;
246
247 CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void);
248 int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock);
249 int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock);
250 int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock);
251 void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock);
252
253 int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock);
254
255 /*
256  * The following can be used to detect memory leaks in the library. If
257  * used, it turns on malloc checking
258  */
259 # define CRYPTO_MEM_CHECK_OFF     0x0   /* Control only */
260 # define CRYPTO_MEM_CHECK_ON      0x1   /* Control and mode bit */
261 # define CRYPTO_MEM_CHECK_ENABLE  0x2   /* Control and mode bit */
262 # define CRYPTO_MEM_CHECK_DISABLE 0x3   /* Control only */
263
264 /* predec of the BIO type */
265 typedef struct bio_st BIO_dummy;
266
267 struct crypto_ex_data_st {
268     STACK_OF(void) *sk;
269 };
270 DEFINE_STACK_OF(void)
271
272 /*
273  * Per class, we have a STACK of function pointers.
274  */
275 # define CRYPTO_EX_INDEX_SSL              0
276 # define CRYPTO_EX_INDEX_SSL_CTX          1
277 # define CRYPTO_EX_INDEX_SSL_SESSION      2
278 # define CRYPTO_EX_INDEX_X509             3
279 # define CRYPTO_EX_INDEX_X509_STORE       4
280 # define CRYPTO_EX_INDEX_X509_STORE_CTX   5
281 # define CRYPTO_EX_INDEX_DH               6
282 # define CRYPTO_EX_INDEX_DSA              7
283 # define CRYPTO_EX_INDEX_EC_KEY           8
284 # define CRYPTO_EX_INDEX_RSA              9
285 # define CRYPTO_EX_INDEX_ENGINE          10
286 # define CRYPTO_EX_INDEX_UI              11
287 # define CRYPTO_EX_INDEX_BIO             12
288 # define CRYPTO_EX_INDEX_STORE           13
289 # define CRYPTO_EX_INDEX_APP             14
290 # define CRYPTO_EX_INDEX__COUNT          15
291
292 /*
293  * This is the default callbacks, but we can have others as well: this is
294  * needed in Win32 where the application malloc and the library malloc may
295  * not be the same.
296  */
297 #define OPENSSL_malloc_init() \
298     CRYPTO_set_mem_functions(CRYPTO_malloc, CRYPTO_realloc, CRYPTO_free)
299
300 int CRYPTO_mem_ctrl(int mode);
301
302 # define OPENSSL_malloc(num) \
303         CRYPTO_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
304 # define OPENSSL_zalloc(num) \
305         CRYPTO_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
306 # define OPENSSL_realloc(addr, num) \
307         CRYPTO_realloc(addr, num, OPENSSL_FILE, OPENSSL_LINE)
308 # define OPENSSL_clear_realloc(addr, old_num, num) \
309         CRYPTO_clear_realloc(addr, old_num, num, OPENSSL_FILE, OPENSSL_LINE)
310 # define OPENSSL_clear_free(addr, num) \
311         CRYPTO_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
312 # define OPENSSL_free(addr) \
313         CRYPTO_free(addr, OPENSSL_FILE, OPENSSL_LINE)
314 # define OPENSSL_memdup(str, s) \
315         CRYPTO_memdup((str), s, OPENSSL_FILE, OPENSSL_LINE)
316 # define OPENSSL_strdup(str) \
317         CRYPTO_strdup(str, OPENSSL_FILE, OPENSSL_LINE)
318 # define OPENSSL_strndup(str, n) \
319         CRYPTO_strndup(str, n, OPENSSL_FILE, OPENSSL_LINE)
320 # define OPENSSL_secure_malloc(num) \
321         CRYPTO_secure_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
322 # define OPENSSL_secure_zalloc(num) \
323         CRYPTO_secure_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
324 # define OPENSSL_secure_free(addr) \
325         CRYPTO_secure_free(addr, OPENSSL_FILE, OPENSSL_LINE)
326 # define OPENSSL_secure_actual_size(ptr) \
327         CRYPTO_secure_actual_size(ptr)
328
329 size_t OPENSSL_strlcpy(char *dst, const char *src, size_t siz);
330 size_t OPENSSL_strlcat(char *dst, const char *src, size_t siz);
331 size_t OPENSSL_strnlen(const char *str, size_t maxlen);
332
333 # define OPENSSL_MALLOC_MAX_NELEMS(type)  (((1U<<(sizeof(int)*8-1))-1)/sizeof(type))
334
335 unsigned long OpenSSL_version_num(void);
336 const char *OpenSSL_version(int type);
337 # define OPENSSL_VERSION          0
338 # define OPENSSL_CFLAGS           1
339 # define OPENSSL_BUILT_ON         2
340 # define OPENSSL_PLATFORM         3
341 # define OPENSSL_DIR              4
342 # define OPENSSL_ENGINES_DIR      5
343
344 int OPENSSL_issetugid(void);
345
346 typedef void CRYPTO_EX_new (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
347                            int idx, long argl, void *argp);
348 typedef void CRYPTO_EX_free (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
349                              int idx, long argl, void *argp);
350 typedef int CRYPTO_EX_dup (CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from,
351                            void *srcp, int idx, long argl, void *argp);
352 __owur int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
353                             CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
354                             CRYPTO_EX_free *free_func);
355 /* No longer use an index. */
356 int CRYPTO_free_ex_index(int class_index, int idx);
357
358 /*
359  * Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a
360  * given class (invokes whatever per-class callbacks are applicable)
361  */
362 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
363 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
364                        CRYPTO_EX_DATA *from);
365
366 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
367
368 /*
369  * Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular
370  * index (relative to the class type involved)
371  */
372 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
373 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
374 /*
375  * This function cleans up all "ex_data" state. It mustn't be called under
376  * potential race-conditions.
377  */
378 void CRYPTO_cleanup_all_ex_data(void);
379
380 int CRYPTO_get_new_lockid(char *name);
381
382 int CRYPTO_num_locks(void);     /* return CRYPTO_NUM_LOCKS (shared libs!) */
383 void CRYPTO_lock(int mode, int type, const char *file, int line);
384 void CRYPTO_set_locking_callback(void (*func) (int mode, int type,
385                                                const char *file, int line));
386 void (*CRYPTO_get_locking_callback(void)) (int mode, int type,
387                                            const char *file, int line);
388 void CRYPTO_set_add_lock_callback(int (*func)
389                                    (int *num, int mount, int type,
390                                     const char *file, int line));
391 int (*CRYPTO_get_add_lock_callback(void)) (int *num, int mount, int type,
392                                            const char *file, int line);
393
394 /* Don't use this structure directly. */
395 typedef struct crypto_threadid_st {
396     void *ptr;
397     unsigned long val;
398 } CRYPTO_THREADID;
399 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
400 void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, unsigned long val);
401 void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr);
402 int CRYPTO_THREADID_set_callback(void (*threadid_func) (CRYPTO_THREADID *));
403 void (*CRYPTO_THREADID_get_callback(void)) (CRYPTO_THREADID *);
404 void CRYPTO_THREADID_current(CRYPTO_THREADID *id);
405 int CRYPTO_THREADID_cmp(const CRYPTO_THREADID *a, const CRYPTO_THREADID *b);
406 void CRYPTO_THREADID_cpy(CRYPTO_THREADID *dest, const CRYPTO_THREADID *src);
407 unsigned long CRYPTO_THREADID_hash(const CRYPTO_THREADID *id);
408 DEPRECATEDIN_1_0_0(void CRYPTO_set_id_callback(unsigned long (*func) (void)))
409 DEPRECATEDIN_1_0_0(unsigned long (*CRYPTO_get_id_callback(void)) (void))
410 DEPRECATEDIN_1_0_0(unsigned long CRYPTO_thread_id(void))
411
412 const char *CRYPTO_get_lock_name(int type);
413 int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
414                     int line);
415
416 int CRYPTO_get_new_dynlockid(void);
417 void CRYPTO_destroy_dynlockid(int i);
418 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
419 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value
420                                         *(*dyn_create_function) (const char
421                                                                  *file,
422                                                                  int line));
423 void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)
424                                        (int mode,
425                                         struct CRYPTO_dynlock_value *l,
426                                         const char *file, int line));
427 void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)
428                                           (struct CRYPTO_dynlock_value *l,
429                                            const char *file, int line));
430 struct CRYPTO_dynlock_value
431 *(*CRYPTO_get_dynlock_create_callback(void)) (const char *file, int line);
432 void (*CRYPTO_get_dynlock_lock_callback(void)) (int mode,
433                                                 struct CRYPTO_dynlock_value
434                                                 *l, const char *file,
435                                                 int line);
436 void (*CRYPTO_get_dynlock_destroy_callback(void)) (struct CRYPTO_dynlock_value
437                                                    *l, const char *file,
438                                                    int line);
439
440 int CRYPTO_set_mem_functions(
441         void *(*m) (size_t, const char *, int),
442         void *(*r) (void *, size_t, const char *, int),
443         void (*f) (void *, const char *, int));
444 int CRYPTO_set_mem_debug(int flag);
445 void CRYPTO_get_mem_functions(
446         void *(**m) (size_t, const char *, int),
447         void *(**r) (void *, size_t, const char *, int),
448         void (**f) (void *, const char *, int));
449
450 void *CRYPTO_malloc(size_t num, const char *file, int line);
451 void *CRYPTO_zalloc(size_t num, const char *file, int line);
452 void *CRYPTO_memdup(const void *str, size_t siz, const char *file, int line);
453 char *CRYPTO_strdup(const char *str, const char *file, int line);
454 char *CRYPTO_strndup(const char *str, size_t s, const char *file, int line);
455 void CRYPTO_free(void *ptr, const char *file, int line);
456 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line);
457 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line);
458 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
459                            const char *file, int line);
460
461 int CRYPTO_secure_malloc_init(size_t sz, int minsize);
462 void CRYPTO_secure_malloc_done(void);
463 void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
464 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
465 void CRYPTO_secure_free(void *ptr, const char *file, int line);
466 int CRYPTO_secure_allocated(const void *ptr);
467 int CRYPTO_secure_malloc_initialized(void);
468 size_t CRYPTO_secure_actual_size(void *ptr);
469 size_t CRYPTO_secure_used(void);
470
471 void OPENSSL_cleanse(void *ptr, size_t len);
472
473 # ifndef OPENSSL_NO_CRYPTO_MDEBUG
474 #  define OPENSSL_mem_debug_push(info) \
475         CRYPTO_mem_debug_push(info, OPENSSL_FILE, OPENSSL_LINE)
476 #  define OPENSSL_mem_debug_pop() \
477         CRYPTO_mem_debug_pop()
478 int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
479 int CRYPTO_mem_debug_pop(void);
480
481 /*-
482  * Debugging functions (enabled by CRYPTO_set_mem_debug(1))
483  * The flag argument has the following significance:
484  *   0:   called before the actual memory allocation has taken place
485  *   1:   called after the actual memory allocation has taken place
486  */
487 void CRYPTO_mem_debug_malloc(void *addr, size_t num, int flag,
488         const char *file, int line);
489 void CRYPTO_mem_debug_realloc(void *addr1, void *addr2, size_t num, int flag,
490         const char *file, int line);
491 void CRYPTO_mem_debug_free(void *addr, int flag,
492         const char *file, int line);
493
494 #  ifndef OPENSSL_NO_STDIO
495 int CRYPTO_mem_leaks_fp(FILE *);
496 #  endif
497 int CRYPTO_mem_leaks(struct bio_st *bio);
498 # endif
499
500 /* die if we have to */
501 void OpenSSLDie(const char *file, int line, const char *assertion);
502 # define OPENSSL_assert(e)       (void)((e) ? 0 : (OpenSSLDie(OPENSSL_FILE, OPENSSL_LINE, #e),1))
503
504 unsigned int *OPENSSL_ia32cap_loc(void);
505 # define OPENSSL_ia32cap ((OPENSSL_ia32cap_loc())[0])
506 int OPENSSL_isservice(void);
507
508 int FIPS_mode(void);
509 int FIPS_mode_set(int r);
510
511 void OPENSSL_init(void);
512
513 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
514 int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
515 int OPENSSL_gmtime_diff(int *pday, int *psec,
516                         const struct tm *from, const struct tm *to);
517
518 /*
519  * CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal.
520  * It takes an amount of time dependent on |len|, but independent of the
521  * contents of |a| and |b|. Unlike memcmp, it cannot be used to put elements
522  * into a defined order as the return value when a != b is undefined, other
523  * than to be non-zero.
524  */
525 int CRYPTO_memcmp(const volatile void * volatile in_a,
526                   const volatile void * volatile in_b,
527                   size_t len);
528
529 /* Standard initialisation options */
530 # define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0x00000001L
531 # define OPENSSL_INIT_LOAD_CRYPTO_STRINGS    0x00000002L
532 # define OPENSSL_INIT_ADD_ALL_CIPHERS        0x00000004L
533 # define OPENSSL_INIT_ADD_ALL_DIGESTS        0x00000008L
534 # define OPENSSL_INIT_NO_ADD_ALL_CIPHERS     0x00000010L
535 # define OPENSSL_INIT_NO_ADD_ALL_DIGESTS     0x00000020L
536 # define OPENSSL_INIT_LOAD_CONFIG            0x00000040L
537 # define OPENSSL_INIT_NO_LOAD_CONFIG         0x00000080L
538 # define OPENSSL_INIT_ASYNC                  0x00000100L
539 # define OPENSSL_INIT_ENGINE_RDRAND          0x00000200L
540 # define OPENSSL_INIT_ENGINE_DYNAMIC         0x00000400L
541 # define OPENSSL_INIT_ENGINE_OPENSSL         0x00000800L
542 # define OPENSSL_INIT_ENGINE_CRYPTODEV       0x00001000L
543 # define OPENSSL_INIT_ENGINE_CAPI            0x00002000L
544 # define OPENSSL_INIT_ENGINE_PADLOCK         0x00004000L
545 # define OPENSSL_INIT_ENGINE_DASYNC          0x00008000L
546 /* OPENSSL_INIT flag 0x00010000 reserved for internal use */
547 # define OPENSSL_INIT_ENGINE_AFALG           0x00020000L
548 /* OPENSSL_INIT flag range 0xfff00000 reserved for OPENSSL_init_ssl() */
549 /* Max OPENSSL_INIT flag value is 0x80000000 */
550
551 /* openssl and dasync not counted as builtin */
552 # define OPENSSL_INIT_ENGINE_ALL_BUILTIN \
553     (OPENSSL_INIT_ENGINE_RDRAND | OPENSSL_INIT_ENGINE_DYNAMIC \
554     | OPENSSL_INIT_ENGINE_CRYPTODEV | OPENSSL_INIT_ENGINE_CAPI | \
555     OPENSSL_INIT_ENGINE_PADLOCK)
556
557
558 /* Library initialisation functions */
559 void OPENSSL_cleanup(void);
560 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
561 int OPENSSL_atexit(void (*handler)(void));
562 void OPENSSL_thread_stop(void);
563
564 /* Low-level control of initialization */
565 OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void);
566 #ifndef OPENSSL_NO_STDIO
567 void OPENSSL_INIT_set_config_filename(OPENSSL_INIT_SETTINGS *settings,
568                                       const char *config_file);
569 #endif
570 void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *settings);
571
572 /* BEGIN ERROR CODES */
573 /*
574  * The following lines are auto generated by the script mkerr.pl. Any changes
575  * made after this point may be overwritten when the script is next run.
576  */
577 void ERR_load_CRYPTO_strings(void);
578
579 /* Error codes for the CRYPTO functions. */
580
581 /* Function codes. */
582 # define CRYPTO_F_CRYPTO_DUP_EX_DATA                      110
583 # define CRYPTO_F_CRYPTO_FREE_EX_DATA                     111
584 # define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
585 # define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID                103
586 # define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
587 # define CRYPTO_F_CRYPTO_MEMDUP                           115
588 # define CRYPTO_F_CRYPTO_NEW_EX_DATA                      112
589 # define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
590 # define CRYPTO_F_DEF_ADD_INDEX                           104
591 # define CRYPTO_F_DEF_GET_CLASS                           105
592 # define CRYPTO_F_FIPS_MODE_SET                           109
593 # define CRYPTO_F_GET_AND_LOCK                            113
594 # define CRYPTO_F_INT_DUP_EX_DATA                         106
595 # define CRYPTO_F_INT_FREE_EX_DATA                        107
596 # define CRYPTO_F_INT_NEW_EX_DATA                         108
597 # define CRYPTO_F_OPENSSL_INIT_CRYPTO                     116
598 # define CRYPTO_F_OPENSSL_MEMDUP                          114
599
600 /* Reason codes. */
601 # define CRYPTO_R_FIPS_MODE_NOT_SUPPORTED                 101
602 # define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK              100
603
604 #ifdef  __cplusplus
605 }
606 #endif
607 #endif