d6cedecd60afee38f1c67fec1b384cd04937ee87
[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_GETHOSTBYNAME       22
190 # define CRYPTO_LOCK_GETSERVBYNAME       23
191 # define CRYPTO_LOCK_READDIR             24
192 # define CRYPTO_LOCK_RSA_BLINDING        25
193 # define CRYPTO_LOCK_DH                  26
194 # define CRYPTO_LOCK_MALLOC2             27
195 # define CRYPTO_LOCK_DSO                 28
196 # define CRYPTO_LOCK_DYNLOCK             29
197 # define CRYPTO_LOCK_ENGINE              30
198 # define CRYPTO_LOCK_UI                  31
199 # define CRYPTO_LOCK_ECDSA               32
200 # define CRYPTO_LOCK_EC                  33
201 # define CRYPTO_LOCK_ECDH                34
202 # define CRYPTO_LOCK_BN                  35
203 # define CRYPTO_LOCK_EC_PRE_COMP         36
204 # define CRYPTO_LOCK_STORE               37
205 # define CRYPTO_LOCK_COMP                38
206 # define CRYPTO_LOCK_FIPS                39
207 # define CRYPTO_LOCK_FIPS2               40
208 # define CRYPTO_LOCK_INIT                41
209 # define CRYPTO_NUM_LOCKS                42
210
211 # define CRYPTO_LOCK             1
212 # define CRYPTO_UNLOCK           2
213 # define CRYPTO_READ             4
214 # define CRYPTO_WRITE            8
215
216 # ifndef OPENSSL_NO_LOCKING
217 #  ifndef CRYPTO_w_lock
218 #   define CRYPTO_w_lock(type)     \
219         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
220 #   define CRYPTO_w_unlock(type)   \
221         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
222 #   define CRYPTO_r_lock(type)     \
223         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
224 #   define CRYPTO_r_unlock(type)   \
225         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
226 #   define CRYPTO_add(addr,amount,type)    \
227         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
228 #  endif
229 # else
230 #  define CRYPTO_w_lock(a)
231 #  define CRYPTO_w_unlock(a)
232 #  define CRYPTO_r_lock(a)
233 #  define CRYPTO_r_unlock(a)
234 #  define CRYPTO_add(a,b,c)       ((*(a))+=(b))
235 # endif
236
237 /*
238  * Some applications as well as some parts of OpenSSL need to allocate and
239  * deallocate locks in a dynamic fashion.  The following typedef makes this
240  * possible in a type-safe manner.
241  * struct CRYPTO_dynlock_value has to be defined by the application.
242  */
243 typedef struct {
244     int references;
245     struct CRYPTO_dynlock_value *data;
246 } CRYPTO_dynlock;
247
248 /*
249  * The following can be used to detect memory leaks in the library. If
250  * used, it turns on malloc checking
251  */
252 # define CRYPTO_MEM_CHECK_OFF     0x0   /* Control only */
253 # define CRYPTO_MEM_CHECK_ON      0x1   /* Control and mode bit */
254 # define CRYPTO_MEM_CHECK_ENABLE  0x2   /* Control and mode bit */
255 # define CRYPTO_MEM_CHECK_DISABLE 0x3   /* Control only */
256
257 /* predec of the BIO type */
258 typedef struct bio_st BIO_dummy;
259
260 struct crypto_ex_data_st {
261     STACK_OF(void) *sk;
262 };
263 DEFINE_STACK_OF(void)
264
265 /*
266  * Per class, we have a STACK of function pointers.
267  */
268 # define CRYPTO_EX_INDEX_SSL              0
269 # define CRYPTO_EX_INDEX_SSL_CTX          1
270 # define CRYPTO_EX_INDEX_SSL_SESSION      2
271 # define CRYPTO_EX_INDEX_X509             3
272 # define CRYPTO_EX_INDEX_X509_STORE       4
273 # define CRYPTO_EX_INDEX_X509_STORE_CTX   5
274 # define CRYPTO_EX_INDEX_DH               6
275 # define CRYPTO_EX_INDEX_DSA              7
276 # define CRYPTO_EX_INDEX_EC_KEY           8
277 # define CRYPTO_EX_INDEX_RSA              9
278 # define CRYPTO_EX_INDEX_ENGINE          10
279 # define CRYPTO_EX_INDEX_UI              11
280 # define CRYPTO_EX_INDEX_BIO             12
281 # define CRYPTO_EX_INDEX_STORE           13
282 # define CRYPTO_EX_INDEX_APP             14
283 # define CRYPTO_EX_INDEX__COUNT          15
284
285 /*
286  * This is the default callbacks, but we can have others as well: this is
287  * needed in Win32 where the application malloc and the library malloc may
288  * not be the same.
289  */
290 #define OPENSSL_malloc_init() \
291     CRYPTO_set_mem_functions(CRYPTO_malloc, CRYPTO_realloc, CRYPTO_free)
292
293 int CRYPTO_mem_ctrl(int mode);
294
295 # ifndef OPENSSL_NO_CRYPTO_MDEBUG
296 #  define OPENSSL_malloc(num) \
297         CRYPTO_malloc(num, __FILE__, __LINE__)
298 #  define OPENSSL_zalloc(num) \
299         CRYPTO_zalloc(num, __FILE__, __LINE__)
300 #  define OPENSSL_realloc(addr, num) \
301         CRYPTO_realloc(addr, num, __FILE__, __LINE__)
302 #  define OPENSSL_clear_realloc(addr, old_num, num) \
303         CRYPTO_clear_realloc(addr, old_num, num, __FILE__, __LINE__)
304 #  define OPENSSL_clear_free(addr, num) \
305         CRYPTO_clear_free(addr, num)
306 #  define OPENSSL_free(addr) \
307         CRYPTO_free(addr)
308 #  define OPENSSL_memdup(str, s) \
309         CRYPTO_memdup((str), s, __FILE__, __LINE__)
310 #  define OPENSSL_strdup(str) \
311         CRYPTO_strdup(str, __FILE__, __LINE__)
312 #  define OPENSSL_strndup(str, n) \
313         CRYPTO_strndup(str, n, __FILE__, __LINE__)
314 #  define OPENSSL_secure_malloc(num) \
315         CRYPTO_secure_malloc(num, __FILE__, __LINE__)
316 #  define OPENSSL_secure_zalloc(num) \
317         CRYPTO_secure_zalloc(num, __FILE__, __LINE__)
318 #  define OPENSSL_secure_free(addr) \
319         CRYPTO_secure_free(addr)
320 #  define OPENSSL_secure_actual_size(ptr) \
321         CRYPTO_secure_actual_size(ptr)
322 # else
323 #  define OPENSSL_malloc(num) \
324         CRYPTO_malloc(num, NULL, 0)
325 #  define OPENSSL_zalloc(num) \
326         CRYPTO_zalloc(num, NULL, 0)
327 #  define OPENSSL_realloc(addr, num) \
328         CRYPTO_realloc(addr, num, NULL, 0)
329 #  define OPENSSL_clear_realloc(addr, old_num, num) \
330         CRYPTO_clear_realloc(addr, old_num, num, NULL, 0)
331 #  define OPENSSL_clear_free(addr, num) \
332         CRYPTO_clear_free(addr, num)
333 #  define OPENSSL_free(addr) \
334         CRYPTO_free(addr)
335 #  define OPENSSL_memdup(str, s) \
336         CRYPTO_memdup(str, s, NULL, 0)
337 #  define OPENSSL_strdup(str) \
338         CRYPTO_strdup(str, NULL, 0)
339 #  define OPENSSL_strndup(str, s) \
340         CRYPTO_strndup(str, s, NULL, 0)
341 #  define OPENSSL_secure_malloc(num) \
342         CRYPTO_secure_malloc(num, NULL, 0)
343 #  define OPENSSL_secure_zalloc(num) \
344         CRYPTO_secure_zalloc(num, NULL, 0)
345 #  define OPENSSL_secure_free(addr) \
346         CRYPTO_secure_free(addr)
347 #  define OPENSSL_secure_actual_size(ptr) \
348         CRYPTO_secure_actual_size(ptr)
349
350 # endif
351
352 size_t OPENSSL_strlcpy(char *dst, const char *src, size_t siz);
353 size_t OPENSSL_strlcat(char *dst, const char *src, size_t siz);
354 size_t OPENSSL_strnlen(const char *str, size_t maxlen);
355
356 # define OPENSSL_MALLOC_MAX_NELEMS(type)  (((1U<<(sizeof(int)*8-1))-1)/sizeof(type))
357
358 unsigned long OpenSSL_version_num(void);
359 const char *OpenSSL_version(int type);
360 # define OPENSSL_VERSION          0
361 # define OPENSSL_CFLAGS           1
362 # define OPENSSL_BUILT_ON         2
363 # define OPENSSL_PLATFORM         3
364 # define OPENSSL_DIR              4
365
366 int OPENSSL_issetugid(void);
367
368 typedef void CRYPTO_EX_new (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
369                            int idx, long argl, void *argp);
370 typedef void CRYPTO_EX_free (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
371                              int idx, long argl, void *argp);
372 typedef int CRYPTO_EX_dup (CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from,
373                            void *srcp, int idx, long argl, void *argp);
374 __owur int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
375                             CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
376                             CRYPTO_EX_free *free_func);
377 /* No longer use an index. */
378 int CRYPTO_free_ex_index(int class_index, int idx);
379
380 /*
381  * Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a
382  * given class (invokes whatever per-class callbacks are applicable)
383  */
384 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
385 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
386                        CRYPTO_EX_DATA *from);
387
388 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
389
390 /*
391  * Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular
392  * index (relative to the class type involved)
393  */
394 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
395 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
396 /*
397  * This function cleans up all "ex_data" state. It mustn't be called under
398  * potential race-conditions.
399  */
400 void CRYPTO_cleanup_all_ex_data(void);
401
402 int CRYPTO_get_new_lockid(char *name);
403
404 int CRYPTO_num_locks(void);     /* return CRYPTO_NUM_LOCKS (shared libs!) */
405 void CRYPTO_lock(int mode, int type, const char *file, int line);
406 void CRYPTO_set_locking_callback(void (*func) (int mode, int type,
407                                                const char *file, int line));
408 void (*CRYPTO_get_locking_callback(void)) (int mode, int type,
409                                            const char *file, int line);
410 void CRYPTO_set_add_lock_callback(int (*func)
411                                    (int *num, int mount, int type,
412                                     const char *file, int line));
413 int (*CRYPTO_get_add_lock_callback(void)) (int *num, int mount, int type,
414                                            const char *file, int line);
415
416 /* Don't use this structure directly. */
417 typedef struct crypto_threadid_st {
418     void *ptr;
419     unsigned long val;
420 } CRYPTO_THREADID;
421 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
422 void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, unsigned long val);
423 void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr);
424 int CRYPTO_THREADID_set_callback(void (*threadid_func) (CRYPTO_THREADID *));
425 void (*CRYPTO_THREADID_get_callback(void)) (CRYPTO_THREADID *);
426 void CRYPTO_THREADID_current(CRYPTO_THREADID *id);
427 int CRYPTO_THREADID_cmp(const CRYPTO_THREADID *a, const CRYPTO_THREADID *b);
428 void CRYPTO_THREADID_cpy(CRYPTO_THREADID *dest, const CRYPTO_THREADID *src);
429 unsigned long CRYPTO_THREADID_hash(const CRYPTO_THREADID *id);
430 DEPRECATEDIN_1_0_0(void CRYPTO_set_id_callback(unsigned long (*func) (void)))
431 DEPRECATEDIN_1_0_0(unsigned long (*CRYPTO_get_id_callback(void)) (void))
432 DEPRECATEDIN_1_0_0(unsigned long CRYPTO_thread_id(void))
433
434 const char *CRYPTO_get_lock_name(int type);
435 int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
436                     int line);
437
438 int CRYPTO_get_new_dynlockid(void);
439 void CRYPTO_destroy_dynlockid(int i);
440 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
441 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value
442                                         *(*dyn_create_function) (const char
443                                                                  *file,
444                                                                  int line));
445 void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)
446                                        (int mode,
447                                         struct CRYPTO_dynlock_value *l,
448                                         const char *file, int line));
449 void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)
450                                           (struct CRYPTO_dynlock_value *l,
451                                            const char *file, int line));
452 struct CRYPTO_dynlock_value
453 *(*CRYPTO_get_dynlock_create_callback(void)) (const char *file, int line);
454 void (*CRYPTO_get_dynlock_lock_callback(void)) (int mode,
455                                                 struct CRYPTO_dynlock_value
456                                                 *l, const char *file,
457                                                 int line);
458 void (*CRYPTO_get_dynlock_destroy_callback(void)) (struct CRYPTO_dynlock_value
459                                                    *l, const char *file,
460                                                    int line);
461
462 int CRYPTO_set_mem_functions(
463         void *(*m) (size_t, const char *, int),
464         void *(*r) (void *, size_t, const char *, int),
465         void (*f) (void *));
466 int CRYPTO_set_mem_debug(int flag);
467 void CRYPTO_get_mem_functions(
468         void *(**m) (size_t, const char *, int),
469         void *(**r) (void *, size_t, const char *, int),
470         void (**f) (void *));
471
472 void *CRYPTO_malloc(size_t num, const char *file, int line);
473 void *CRYPTO_zalloc(size_t num, const char *file, int line);
474 void *CRYPTO_memdup(const void *str, size_t siz, const char *file, int line);
475 char *CRYPTO_strdup(const char *str, const char *file, int line);
476 char *CRYPTO_strndup(const char *str, size_t s, const char *file, int line);
477 void CRYPTO_free(void *ptr);
478 void CRYPTO_clear_free(void *ptr, size_t num);
479 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line);
480 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
481                            const char *file, int line);
482
483 int CRYPTO_secure_malloc_init(size_t sz, int minsize);
484 void CRYPTO_secure_malloc_done(void);
485 void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
486 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
487 void CRYPTO_secure_free(void *ptr);
488 int CRYPTO_secure_allocated(const void *ptr);
489 int CRYPTO_secure_malloc_initialized(void);
490 size_t CRYPTO_secure_actual_size(void *ptr);
491 size_t CRYPTO_secure_used(void);
492
493 void OPENSSL_cleanse(void *ptr, size_t len);
494
495 # ifndef OPENSSL_NO_CRYPTO_MDEBUG
496 #  define OPENSSL_mem_debug_push(info) \
497         CRYPTO_mem_debug_push(info, __FILE__, __LINE__)
498 #  define OPENSSL_mem_debug_pop() \
499         CRYPTO_mem_debug_pop()
500 int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
501 int CRYPTO_mem_debug_pop(void);
502
503 /*-
504  * Debugging functions (enabled by CRYPTO_set_mem_debug(1))
505  * The flag argument has the following significance:
506  *   0:   called before the actual memory allocation has taken place
507  *   1:   called after the actual memory allocation has taken place
508  */
509 void CRYPTO_mem_debug_malloc(void *addr, size_t num, int flag,
510         const char *file, int line);
511 void CRYPTO_mem_debug_realloc(void *addr1, void *addr2, size_t num, int flag,
512         const char *file, int line);
513 void CRYPTO_mem_debug_free(void *addr, int flag);
514
515 #  ifndef OPENSSL_NO_STDIO
516 int CRYPTO_mem_leaks_fp(FILE *);
517 #  endif
518 int CRYPTO_mem_leaks(struct bio_st *bio);
519 # endif
520
521 /* die if we have to */
522 void OpenSSLDie(const char *file, int line, const char *assertion);
523 # define OPENSSL_assert(e)       (void)((e) ? 0 : (OpenSSLDie(__FILE__, __LINE__, #e),1))
524
525 unsigned int *OPENSSL_ia32cap_loc(void);
526 # define OPENSSL_ia32cap ((OPENSSL_ia32cap_loc())[0])
527 int OPENSSL_isservice(void);
528
529 int FIPS_mode(void);
530 int FIPS_mode_set(int r);
531
532 void OPENSSL_init(void);
533
534 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
535 int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
536 int OPENSSL_gmtime_diff(int *pday, int *psec,
537                         const struct tm *from, const struct tm *to);
538
539 /*
540  * CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal.
541  * It takes an amount of time dependent on |len|, but independent of the
542  * contents of |a| and |b|. Unlike memcmp, it cannot be used to put elements
543  * into a defined order as the return value when a != b is undefined, other
544  * than to be non-zero.
545  */
546 int CRYPTO_memcmp(const volatile void * volatile in_a,
547                   const volatile void * volatile in_b,
548                   size_t len);
549
550 /* Standard initialisation options */
551 # define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0x000001
552 # define OPENSSL_INIT_LOAD_CRYPTO_STRINGS    0x000002
553 # define OPENSSL_INIT_ADD_ALL_CIPHERS        0x000004
554 # define OPENSSL_INIT_ADD_ALL_DIGESTS        0x000008
555 # define OPENSSL_INIT_NO_ADD_ALL_CIPHERS     0x000010
556 # define OPENSSL_INIT_NO_ADD_ALL_DIGESTS     0x000020
557 # define OPENSSL_INIT_LOAD_CONFIG            0x000040
558 # define OPENSSL_INIT_NO_LOAD_CONFIG         0x000080
559 # define OPENSSL_INIT_ASYNC                  0x000100
560 # define OPENSSL_INIT_ENGINE_RDRAND          0x000200
561 # define OPENSSL_INIT_ENGINE_DYNAMIC         0x000400
562 # define OPENSSL_INIT_ENGINE_OPENSSL         0x000800
563 # define OPENSSL_INIT_ENGINE_CRYPTODEV       0x001000
564 # define OPENSSL_INIT_ENGINE_CAPI            0x002000
565 # define OPENSSL_INIT_ENGINE_PADLOCK         0x004000
566 # define OPENSSL_INIT_ENGINE_DASYNC          0x008000
567 /* OPENSSL_INIT flag 0x010000 reserved for internal use */
568 /* Max OPENSSL_INIT flag value is 0x80000000 */
569
570 /* openssl and dasync not counted as builtin */
571 # define OPENSSL_INIT_ENGINE_ALL_BUILTIN \
572     (OPENSSL_INIT_ENGINE_RDRAND | OPENSSL_INIT_ENGINE_DYNAMIC \
573     | OPENSSL_INIT_ENGINE_CRYPTODEV | OPENSSL_INIT_ENGINE_CAPI | \
574     OPENSSL_INIT_ENGINE_PADLOCK)
575
576
577
578 /* Optional settings for initialisation */
579 # define OPENSSL_INIT_SET_END                0
580 # define OPENSSL_INIT_SET_CONF_FILENAME      1
581
582 typedef struct ossl_init_settings_st {
583     int name;
584     union {
585         int type_int;
586         long type_long;
587         int32_t type_int32_t;
588         uint32_t type_uint32_t;
589         int64_t type_int64_t;
590         uint64_t type_uint64_t;
591         size_t type_size_t;
592         const char *type_string;
593         void *type_void_ptr;
594     } value;
595 } OPENSSL_INIT_SETTINGS;
596
597 typedef struct ossl_init_stop_st OPENSSL_INIT_STOP;
598
599 /* Library initialisation functions */
600 void OPENSSL_cleanup(void);
601 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
602 int OPENSSL_atexit(void (*handler)(void));
603 void OPENSSL_thread_stop(void);
604
605 /* BEGIN ERROR CODES */
606 /*
607  * The following lines are auto generated by the script mkerr.pl. Any changes
608  * made after this point may be overwritten when the script is next run.
609  */
610 void ERR_load_CRYPTO_strings(void);
611
612 /* Error codes for the CRYPTO functions. */
613
614 /* Function codes. */
615 # define CRYPTO_F_CRYPTO_DUP_EX_DATA                      110
616 # define CRYPTO_F_CRYPTO_FREE_EX_DATA                     111
617 # define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
618 # define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID                103
619 # define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
620 # define CRYPTO_F_CRYPTO_MEMDUP                           115
621 # define CRYPTO_F_CRYPTO_NEW_EX_DATA                      112
622 # define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
623 # define CRYPTO_F_DEF_ADD_INDEX                           104
624 # define CRYPTO_F_DEF_GET_CLASS                           105
625 # define CRYPTO_F_FIPS_MODE_SET                           109
626 # define CRYPTO_F_GET_AND_LOCK                            113
627 # define CRYPTO_F_INT_DUP_EX_DATA                         106
628 # define CRYPTO_F_INT_FREE_EX_DATA                        107
629 # define CRYPTO_F_INT_NEW_EX_DATA                         108
630 # define CRYPTO_F_OPENSSL_MEMDUP                          114
631
632 /* Reason codes. */
633 # define CRYPTO_R_FIPS_MODE_NOT_SUPPORTED                 101
634 # define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK              100
635
636 #ifdef  __cplusplus
637 }
638 #endif
639 #endif