]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/crypto.h.in
Always check CRYPTO_LOCK_{read,write}_lock
[thirdparty/openssl.git] / include / openssl / crypto.h.in
CommitLineData
21dcbebc 1/*
15c3dcfc
MC
2 * {- join("\n * ", @autowarntext) -}
3 *
a28d06f3 4 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
aa8f3d76 5 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
19b8d06a 6 *
48f4ad77 7 * Licensed under the Apache License 2.0 (the "License"). You may not use
21dcbebc
RS
8 * this file except in compliance with the License. You can obtain a copy
9 * in the file LICENSE in the source distribution or at
10 * https://www.openssl.org/source/license.html
19b8d06a 11 */
21dcbebc 12
15c3dcfc
MC
13{-
14use OpenSSL::stackhash qw(generate_stack_macros);
15-}
16
ae4186b0
DMSP
17#ifndef OPENSSL_CRYPTO_H
18# define OPENSSL_CRYPTO_H
d86167ec
DMSP
19# pragma once
20
21# include <openssl/macros.h>
936c2b9e 22# ifndef OPENSSL_NO_DEPRECATED_3_0
d86167ec
DMSP
23# define HEADER_CRYPTO_H
24# endif
d02b48c6 25
0f113f3e
MC
26# include <stdlib.h>
27# include <time.h>
f3e9b338 28
0f113f3e 29# include <openssl/e_os2.h>
7b5a6c7a 30
0f113f3e
MC
31# ifndef OPENSSL_NO_STDIO
32# include <stdio.h>
33# endif
0b86eb3e 34
0f113f3e
MC
35# include <openssl/safestack.h>
36# include <openssl/opensslv.h>
50cd4768 37# include <openssl/types.h>
98186eb4 38# include <openssl/opensslconf.h>
52df25cf 39# include <openssl/cryptoerr.h>
5f326803 40
0f113f3e
MC
41# ifdef CHARSET_EBCDIC
42# include <openssl/ebcdic.h>
43# endif
a53955d8 44
0f113f3e
MC
45/*
46 * Resolve problems on some operating systems with symbol names that clash
47 * one way or another
48 */
49# include <openssl/symhacks.h>
c29b6d56 50
00db8c60 51# ifndef OPENSSL_NO_DEPRECATED_1_1_0
98186eb4
VD
52# include <openssl/opensslv.h>
53# endif
54
65962686
RL
55#ifdef __cplusplus
56extern "C" {
57#endif
58
00db8c60 59# ifndef OPENSSL_NO_DEPRECATED_1_1_0
98186eb4
VD
60# define SSLeay OpenSSL_version_num
61# define SSLeay_version OpenSSL_version
62# define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
63# define SSLEAY_VERSION OPENSSL_VERSION
64# define SSLEAY_CFLAGS OPENSSL_CFLAGS
65# define SSLEAY_BUILT_ON OPENSSL_BUILT_ON
66# define SSLEAY_PLATFORM OPENSSL_PLATFORM
67# define SSLEAY_DIR OPENSSL_DIR
d02b48c6 68
0f113f3e 69/*
2e52e7df
MC
70 * Old type for allocating dynamic locks. No longer used. Use the new thread
71 * API instead.
0f113f3e 72 */
0f113f3e 73typedef struct {
2e52e7df 74 int dummy;
0f113f3e 75} CRYPTO_dynlock;
c7922304 76
00db8c60 77# endif /* OPENSSL_NO_DEPRECATED_1_1_0 */
2e52e7df 78
71a04cfc
AG
79typedef void CRYPTO_RWLOCK;
80
81CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void);
cd3f8c1b
RS
82__owur int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock);
83__owur int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock);
71a04cfc
AG
84int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock);
85void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock);
86
87int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock);
d5e742de
MC
88int CRYPTO_atomic_or(uint64_t *val, uint64_t op, uint64_t *ret,
89 CRYPTO_RWLOCK *lock);
90int CRYPTO_atomic_load(uint64_t *val, uint64_t *ret, CRYPTO_RWLOCK *lock);
71a04cfc 91
ef45aa14
MC
92/* No longer needed, so this is a no-op */
93#define OPENSSL_malloc_init() while(0) continue
d02b48c6 94
05c7b163 95# define OPENSSL_malloc(num) \
eaa7e483 96 CRYPTO_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 97# define OPENSSL_zalloc(num) \
eaa7e483 98 CRYPTO_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 99# define OPENSSL_realloc(addr, num) \
eaa7e483 100 CRYPTO_realloc(addr, num, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 101# define OPENSSL_clear_realloc(addr, old_num, num) \
eaa7e483 102 CRYPTO_clear_realloc(addr, old_num, num, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 103# define OPENSSL_clear_free(addr, num) \
eaa7e483 104 CRYPTO_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 105# define OPENSSL_free(addr) \
eaa7e483 106 CRYPTO_free(addr, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 107# define OPENSSL_memdup(str, s) \
eaa7e483 108 CRYPTO_memdup((str), s, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 109# define OPENSSL_strdup(str) \
eaa7e483 110 CRYPTO_strdup(str, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 111# define OPENSSL_strndup(str, n) \
eaa7e483 112 CRYPTO_strndup(str, n, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 113# define OPENSSL_secure_malloc(num) \
eaa7e483 114 CRYPTO_secure_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 115# define OPENSSL_secure_zalloc(num) \
eaa7e483 116 CRYPTO_secure_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 117# define OPENSSL_secure_free(addr) \
eaa7e483 118 CRYPTO_secure_free(addr, OPENSSL_FILE, OPENSSL_LINE)
4dae7cd3
BE
119# define OPENSSL_secure_clear_free(addr, num) \
120 CRYPTO_secure_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
05c7b163 121# define OPENSSL_secure_actual_size(ptr) \
d594199b 122 CRYPTO_secure_actual_size(ptr)
bbd86bf5 123
7644a9ae
RS
124size_t OPENSSL_strlcpy(char *dst, const char *src, size_t siz);
125size_t OPENSSL_strlcat(char *dst, const char *src, size_t siz);
126size_t OPENSSL_strnlen(const char *str, size_t maxlen);
82bd7c2c 127int OPENSSL_buf2hexstr_ex(char *str, size_t str_n, size_t *strlen,
abdd3fa0
SL
128 const unsigned char *buf, size_t buflen,
129 const char sep);
82bd7c2c
RL
130char *OPENSSL_buf2hexstr(const unsigned char *buf, long buflen);
131int OPENSSL_hexstr2buf_ex(unsigned char *buf, size_t buf_n, size_t *buflen,
abdd3fa0 132 const char *str, const char sep);
82bd7c2c 133unsigned char *OPENSSL_hexstr2buf(const char *str, long *buflen);
14f051a0 134int OPENSSL_hexchar2int(unsigned char c);
7644a9ae 135
0f113f3e 136# define OPENSSL_MALLOC_MAX_NELEMS(type) (((1U<<(sizeof(int)*8-1))-1)/sizeof(type))
d02b48c6 137
f5453462
RL
138/*
139 * These functions return the values of OPENSSL_VERSION_MAJOR,
140 * OPENSSL_VERSION_MINOR, OPENSSL_VERSION_PATCH, OPENSSL_VERSION_PRE_RELEASE
141 * and OPENSSL_VERSION_BUILD_METADATA, respectively.
142 */
143unsigned int OPENSSL_version_major(void);
144unsigned int OPENSSL_version_minor(void);
145unsigned int OPENSSL_version_patch(void);
146const char *OPENSSL_version_pre_release(void);
147const char *OPENSSL_version_build_metadata(void);
148
7e8c3381 149unsigned long OpenSSL_version_num(void);
b0700d2c 150const char *OpenSSL_version(int type);
3a63dbef
RL
151# define OPENSSL_VERSION 0
152# define OPENSSL_CFLAGS 1
153# define OPENSSL_BUILT_ON 2
154# define OPENSSL_PLATFORM 3
155# define OPENSSL_DIR 4
156# define OPENSSL_ENGINES_DIR 5
157# define OPENSSL_VERSION_STRING 6
158# define OPENSSL_FULL_VERSION_STRING 7
47ca8338 159# define OPENSSL_MODULES_DIR 8
363e941e 160# define OPENSSL_CPU_INFO 9
d02b48c6 161
0109e030
RL
162const char *OPENSSL_info(int type);
163/*
164 * The series starts at 1001 to avoid confusion with the OpenSSL_version
165 * types.
166 */
167# define OPENSSL_INFO_CONFIG_DIR 1001
168# define OPENSSL_INFO_ENGINES_DIR 1002
169# define OPENSSL_INFO_MODULES_DIR 1003
170# define OPENSSL_INFO_DSO_EXTENSION 1004
171# define OPENSSL_INFO_DIR_FILENAME_SEPARATOR 1005
172# define OPENSSL_INFO_LIST_SEPARATOR 1006
096978f0 173# define OPENSSL_INFO_SEED_SOURCE 1007
363e941e 174# define OPENSSL_INFO_CPU_SETTINGS 1008
0109e030 175
36fafffa
UM
176int OPENSSL_issetugid(void);
177
f4dcc09b 178struct crypto_ex_data_st {
b4250010 179 OSSL_LIB_CTX *ctx;
f4dcc09b
DG
180 STACK_OF(void) *sk;
181};
852c2ed2 182
15c3dcfc
MC
183{-
184 generate_stack_macros("void");
185-}
186
f4dcc09b
DG
187
188/*
189 * Per class, we have a STACK of function pointers.
190 */
191# define CRYPTO_EX_INDEX_SSL 0
192# define CRYPTO_EX_INDEX_SSL_CTX 1
193# define CRYPTO_EX_INDEX_SSL_SESSION 2
194# define CRYPTO_EX_INDEX_X509 3
195# define CRYPTO_EX_INDEX_X509_STORE 4
196# define CRYPTO_EX_INDEX_X509_STORE_CTX 5
197# define CRYPTO_EX_INDEX_DH 6
198# define CRYPTO_EX_INDEX_DSA 7
199# define CRYPTO_EX_INDEX_EC_KEY 8
200# define CRYPTO_EX_INDEX_RSA 9
201# define CRYPTO_EX_INDEX_ENGINE 10
202# define CRYPTO_EX_INDEX_UI 11
203# define CRYPTO_EX_INDEX_BIO 12
204# define CRYPTO_EX_INDEX_APP 13
205# define CRYPTO_EX_INDEX_UI_METHOD 14
206# define CRYPTO_EX_INDEX_RAND_DRBG 15
207# define CRYPTO_EX_INDEX_DRBG CRYPTO_EX_INDEX_RAND_DRBG
b4250010 208# define CRYPTO_EX_INDEX_OSSL_LIB_CTX 16
ff1f7cde
AT
209# define CRYPTO_EX_INDEX_EVP_PKEY 17
210# define CRYPTO_EX_INDEX__COUNT 18
f4dcc09b 211
e6390aca
RS
212typedef void CRYPTO_EX_new (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
213 int idx, long argl, void *argp);
214typedef void CRYPTO_EX_free (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
215 int idx, long argl, void *argp);
3c853776 216typedef int CRYPTO_EX_dup (CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
712e8deb 217 void **from_d, int idx, long argl, void *argp);
e6390aca 218__owur int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
f4dcc09b
DG
219 CRYPTO_EX_new *new_func,
220 CRYPTO_EX_dup *dup_func,
221 CRYPTO_EX_free *free_func);
e6390aca
RS
222/* No longer use an index. */
223int CRYPTO_free_ex_index(int class_index, int idx);
224
0f113f3e
MC
225/*
226 * Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a
227 * given class (invokes whatever per-class callbacks are applicable)
228 */
3a079997
GT
229int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
230int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
3c853776 231 const CRYPTO_EX_DATA *from);
e6390aca 232
3a079997 233void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
e6390aca 234
e17f5b6a
RL
235/* Allocate a single item in the CRYPTO_EX_DATA variable */
236int CRYPTO_alloc_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad,
237 int idx);
238
0f113f3e
MC
239/*
240 * Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular
241 * index (relative to the class type involved)
242 */
dd9d233e 243int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
0f113f3e 244void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
a5e3ac13 245
00db8c60 246# ifndef OPENSSL_NO_DEPRECATED_1_1_0
0f113f3e
MC
247/*
248 * This function cleans up all "ex_data" state. It mustn't be called under
249 * potential race-conditions.
250 */
6457615a 251# define CRYPTO_cleanup_all_ex_data() while(0) continue
58964a49 252
2e52e7df 253/*
b5851bbc
MT
254 * The old locking functions have been removed completely without compatibility
255 * macros. This is because the old functions either could not properly report
256 * errors, or the returned error values were not clearly documented.
19f05ebc 257 * Replacing the locking functions with no-ops would cause race condition
b5851bbc
MT
258 * issues in the affected applications. It is far better for them to fail at
259 * compile time.
260 * On the other hand, the locking callbacks are no longer used. Consequently,
261 * the callback management functions can be safely replaced with no-op macros.
2e52e7df 262 */
453bff22 263# define CRYPTO_num_locks() (1)
2e52e7df
MC
264# define CRYPTO_set_locking_callback(func)
265# define CRYPTO_get_locking_callback() (NULL)
266# define CRYPTO_set_add_lock_callback(func)
267# define CRYPTO_get_add_lock_callback() (NULL)
268
dd850bcb
KR
269/*
270 * These defines where used in combination with the old locking callbacks,
271 * they are not called anymore, but old code that's not called might still
272 * use them.
273 */
274# define CRYPTO_LOCK 1
275# define CRYPTO_UNLOCK 2
276# define CRYPTO_READ 4
277# define CRYPTO_WRITE 8
278
2e52e7df 279/* This structure is no longer used */
0f113f3e 280typedef struct crypto_threadid_st {
2e52e7df 281 int dummy;
0f113f3e 282} CRYPTO_THREADID;
4c329696 283/* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
2e52e7df
MC
284# define CRYPTO_THREADID_set_numeric(id, val)
285# define CRYPTO_THREADID_set_pointer(id, ptr)
286# define CRYPTO_THREADID_set_callback(threadid_func) (0)
287# define CRYPTO_THREADID_get_callback() (NULL)
288# define CRYPTO_THREADID_current(id)
289# define CRYPTO_THREADID_cmp(a, b) (-1)
290# define CRYPTO_THREADID_cpy(dest, src)
291# define CRYPTO_THREADID_hash(id) (0UL)
292
00db8c60 293# ifndef OPENSSL_NO_DEPRECATED_1_0_0
2e52e7df
MC
294# define CRYPTO_set_id_callback(func)
295# define CRYPTO_get_id_callback() (NULL)
296# define CRYPTO_thread_id() (0UL)
00db8c60 297# endif /* OPENSSL_NO_DEPRECATED_1_0_0 */
2e52e7df 298
2e52e7df
MC
299# define CRYPTO_set_dynlock_create_callback(dyn_create_function)
300# define CRYPTO_set_dynlock_lock_callback(dyn_lock_function)
301# define CRYPTO_set_dynlock_destroy_callback(dyn_destroy_function)
302# define CRYPTO_get_dynlock_create_callback() (NULL)
303# define CRYPTO_get_dynlock_lock_callback() (NULL)
304# define CRYPTO_get_dynlock_destroy_callback() (NULL)
00db8c60 305# endif /* OPENSSL_NO_DEPRECATED_1_1_0 */
0f113f3e 306
f4dcc09b
DG
307typedef void *(*CRYPTO_malloc_fn)(size_t num, const char *file, int line);
308typedef void *(*CRYPTO_realloc_fn)(void *addr, size_t num, const char *file,
309 int line);
310typedef void (*CRYPTO_free_fn)(void *addr, const char *file, int line);
311int CRYPTO_set_mem_functions(CRYPTO_malloc_fn malloc_fn,
312 CRYPTO_realloc_fn realloc_fn,
313 CRYPTO_free_fn free_fn);
314void CRYPTO_get_mem_functions(CRYPTO_malloc_fn *malloc_fn,
315 CRYPTO_realloc_fn *realloc_fn,
316 CRYPTO_free_fn *free_fn);
d02b48c6 317
ff842856
RL
318void *CRYPTO_malloc(size_t num, const char *file, int line);
319void *CRYPTO_zalloc(size_t num, const char *file, int line);
7644a9ae 320void *CRYPTO_memdup(const void *str, size_t siz, const char *file, int line);
6caa4edd 321char *CRYPTO_strdup(const char *str, const char *file, int line);
7644a9ae 322char *CRYPTO_strndup(const char *str, size_t s, const char *file, int line);
05c7b163
RL
323void CRYPTO_free(void *ptr, const char *file, int line);
324void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line);
ff842856 325void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line);
c99de053 326void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
ff842856 327 const char *file, int line);
5a88a6ea 328
34b16762 329int CRYPTO_secure_malloc_init(size_t sz, size_t minsize);
e8408681 330int CRYPTO_secure_malloc_done(void);
ff842856 331void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
3538c7da 332void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
05c7b163 333void CRYPTO_secure_free(void *ptr, const char *file, int line);
4dae7cd3
BE
334void CRYPTO_secure_clear_free(void *ptr, size_t num,
335 const char *file, int line);
74924dcb
RS
336int CRYPTO_secure_allocated(const void *ptr);
337int CRYPTO_secure_malloc_initialized(void);
d594199b 338size_t CRYPTO_secure_actual_size(void *ptr);
bbd86bf5 339size_t CRYPTO_secure_used(void);
74924dcb 340
df29cc8f
RL
341void OPENSSL_cleanse(void *ptr, size_t len);
342
6ac11bd0 343# ifndef OPENSSL_NO_CRYPTO_MDEBUG
f4dcc09b
DG
344/*
345 * The following can be used to detect memory leaks in the library. If
346 * used, it turns on malloc checking
347 */
348# define CRYPTO_MEM_CHECK_OFF 0x0 /* Control only */
349# define CRYPTO_MEM_CHECK_ON 0x1 /* Control and mode bit */
350# define CRYPTO_MEM_CHECK_ENABLE 0x2 /* Control and mode bit */
351# define CRYPTO_MEM_CHECK_DISABLE 0x3 /* Control only */
352
742ccab3 353void CRYPTO_get_alloc_counts(int *mcount, int *rcount, int *fcount);
936c2b9e 354# ifndef OPENSSL_NO_DEPRECATED_3_0
e7aa7c11
RS
355# define OPENSSL_mem_debug_push(info) \
356 CRYPTO_mem_debug_push(info, OPENSSL_FILE, OPENSSL_LINE)
357# define OPENSSL_mem_debug_pop() \
358 CRYPTO_mem_debug_pop()
359# endif
05cb2238
RL
360# ifndef OPENSSL_NO_DEPRECATED_3_0
361OSSL_DEPRECATEDIN_3_0 int CRYPTO_set_mem_debug(int flag);
362OSSL_DEPRECATEDIN_3_0 int CRYPTO_mem_ctrl(int mode);
363OSSL_DEPRECATEDIN_3_0 int CRYPTO_mem_debug_push(const char *info,
364 const char *file, int line);
365OSSL_DEPRECATEDIN_3_0 int CRYPTO_mem_debug_pop(void);
366OSSL_DEPRECATEDIN_3_0 void CRYPTO_mem_debug_malloc(void *addr, size_t num,
367 int flag,
368 const char *file, int line);
369OSSL_DEPRECATEDIN_3_0 void CRYPTO_mem_debug_realloc(void *addr1, void *addr2,
370 size_t num, int flag,
371 const char *file, int line);
372OSSL_DEPRECATEDIN_3_0 void CRYPTO_mem_debug_free(void *addr, int flag,
373 const char *file, int line);
374OSSL_DEPRECATEDIN_3_0
375int CRYPTO_mem_leaks_cb(int (*cb)(const char *str, size_t len, void *u),
376 void *u);
377# endif
6ac11bd0 378# ifndef OPENSSL_NO_STDIO
05cb2238
RL
379# ifndef OPENSSL_NO_DEPRECATED_3_0
380OSSL_DEPRECATEDIN_3_0 int CRYPTO_mem_leaks_fp(FILE *);
6ac11bd0 381# endif
05cb2238
RL
382# endif
383# ifndef OPENSSL_NO_DEPRECATED_3_0
384OSSL_DEPRECATEDIN_3_0 int CRYPTO_mem_leaks(BIO *bio);
385# endif
f4dcc09b 386# endif /* OPENSSL_NO_CRYPTO_MDEBUG */
d02b48c6 387
17ed6c06 388/* die if we have to */
87275905 389ossl_noreturn void OPENSSL_die(const char *assertion, const char *file, int line);
00db8c60 390# ifndef OPENSSL_NO_DEPRECATED_1_1_0
040d43b3
RS
391# define OpenSSLDie(f,l,a) OPENSSL_die((a),(f),(l))
392# endif
040d43b3
RS
393# define OPENSSL_assert(e) \
394 (void)((e) ? 0 : (OPENSSL_die("assertion failed: " #e, OPENSSL_FILE, OPENSSL_LINE), 1))
17ed6c06 395
ca9f55f7 396int OPENSSL_isservice(void);
3547478f 397
71fa4513 398void OPENSSL_init(void);
2915fe19 399# ifdef OPENSSL_SYS_UNIX
9750b4d3
RB
400# ifndef OPENSSL_NO_DEPRECATED_3_0
401OSSL_DEPRECATEDIN_3_0 void OPENSSL_fork_prepare(void);
402OSSL_DEPRECATEDIN_3_0 void OPENSSL_fork_parent(void);
403OSSL_DEPRECATEDIN_3_0 void OPENSSL_fork_child(void);
404# endif
2915fe19 405# endif
71fa4513 406
7e5363ab
RS
407struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
408int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
409int OPENSSL_gmtime_diff(int *pday, int *psec,
410 const struct tm *from, const struct tm *to);
411
0f113f3e
MC
412/*
413 * CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal.
414 * It takes an amount of time dependent on |len|, but independent of the
415 * contents of |a| and |b|. Unlike memcmp, it cannot be used to put elements
416 * into a defined order as the return value when a != b is undefined, other
417 * than to be non-zero.
418 */
49791083 419int CRYPTO_memcmp(const void * in_a, const void * in_b, size_t len);
7c770d57 420
b184e3ef 421/* Standard initialisation options */
2c90015c
RL
422# define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0x00000001L
423# define OPENSSL_INIT_LOAD_CRYPTO_STRINGS 0x00000002L
424# define OPENSSL_INIT_ADD_ALL_CIPHERS 0x00000004L
425# define OPENSSL_INIT_ADD_ALL_DIGESTS 0x00000008L
426# define OPENSSL_INIT_NO_ADD_ALL_CIPHERS 0x00000010L
427# define OPENSSL_INIT_NO_ADD_ALL_DIGESTS 0x00000020L
428# define OPENSSL_INIT_LOAD_CONFIG 0x00000040L
429# define OPENSSL_INIT_NO_LOAD_CONFIG 0x00000080L
430# define OPENSSL_INIT_ASYNC 0x00000100L
431# define OPENSSL_INIT_ENGINE_RDRAND 0x00000200L
432# define OPENSSL_INIT_ENGINE_DYNAMIC 0x00000400L
433# define OPENSSL_INIT_ENGINE_OPENSSL 0x00000800L
434# define OPENSSL_INIT_ENGINE_CRYPTODEV 0x00001000L
435# define OPENSSL_INIT_ENGINE_CAPI 0x00002000L
436# define OPENSSL_INIT_ENGINE_PADLOCK 0x00004000L
8d00e30f 437# define OPENSSL_INIT_ENGINE_AFALG 0x00008000L
eb2b9892 438/* OPENSSL_INIT_ZLIB 0x00010000L */
b5319bdb 439# define OPENSSL_INIT_ATFORK 0x00020000L
eb2b9892 440/* OPENSSL_INIT_BASE_ONLY 0x00040000L */
8f6a5c56 441# define OPENSSL_INIT_NO_ATEXIT 0x00080000L
0145dd32 442/* OPENSSL_INIT flag range 0x03f00000 reserved for OPENSSL_init_ssl() */
e74bd290
RL
443/* FREE: 0x04000000L */
444/* FREE: 0x08000000L */
b50ca330
P
445/* FREE: 0x10000000L */
446/* FREE: 0x20000000L */
0145dd32
RL
447/* FREE: 0x40000000L */
448/* FREE: 0x80000000L */
b184e3ef
MC
449/* Max OPENSSL_INIT flag value is 0x80000000 */
450
451/* openssl and dasync not counted as builtin */
452# define OPENSSL_INIT_ENGINE_ALL_BUILTIN \
453 (OPENSSL_INIT_ENGINE_RDRAND | OPENSSL_INIT_ENGINE_DYNAMIC \
454 | OPENSSL_INIT_ENGINE_CRYPTODEV | OPENSSL_INIT_ENGINE_CAPI | \
455 OPENSSL_INIT_ENGINE_PADLOCK)
456
b184e3ef 457/* Library initialisation functions */
f672aee4 458void OPENSSL_cleanup(void);
0fc32b07 459int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
f672aee4
RS
460int OPENSSL_atexit(void (*handler)(void));
461void OPENSSL_thread_stop(void);
b4250010 462void OPENSSL_thread_stop_ex(OSSL_LIB_CTX *ctx);
b184e3ef 463
7253fd55
RS
464/* Low-level control of initialization */
465OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void);
f1f5ee17 466# ifndef OPENSSL_NO_STDIO
df1f538f
VD
467int OPENSSL_INIT_set_config_filename(OPENSSL_INIT_SETTINGS *settings,
468 const char *config_filename);
469void OPENSSL_INIT_set_config_file_flags(OPENSSL_INIT_SETTINGS *settings,
470 unsigned long flags);
cda3ae5b 471int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *settings,
df1f538f 472 const char *config_appname);
f1f5ee17 473# endif
7253fd55
RS
474void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *settings);
475
f1f5ee17
AP
476# if defined(OPENSSL_THREADS) && !defined(CRYPTO_TDEBUG)
477# if defined(_WIN32)
478# if defined(BASETYPES) || defined(_WINDEF_H)
479/* application has to include <windows.h> in order to use this */
5c4328f0
VD
480typedef DWORD CRYPTO_THREAD_LOCAL;
481typedef DWORD CRYPTO_THREAD_ID;
482
5c4328f0 483typedef LONG CRYPTO_ONCE;
f1f5ee17
AP
484# define CRYPTO_ONCE_STATIC_INIT 0
485# endif
486# else
08073700
RB
487# if defined(__TANDEM) && defined(_SPT_MODEL_)
488# define SPT_THREAD_SIGNAL 1
489# define SPT_THREAD_AWARE 1
490# include <spthread.h>
491# else
492# include <pthread.h>
493# endif
5c4328f0
VD
494typedef pthread_once_t CRYPTO_ONCE;
495typedef pthread_key_t CRYPTO_THREAD_LOCAL;
496typedef pthread_t CRYPTO_THREAD_ID;
497
f1f5ee17
AP
498# define CRYPTO_ONCE_STATIC_INIT PTHREAD_ONCE_INIT
499# endif
500# endif
501
502# if !defined(CRYPTO_ONCE_STATIC_INIT)
503typedef unsigned int CRYPTO_ONCE;
504typedef unsigned int CRYPTO_THREAD_LOCAL;
505typedef unsigned int CRYPTO_THREAD_ID;
506# define CRYPTO_ONCE_STATIC_INIT 0
5c4328f0
VD
507# endif
508
509int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void));
510
511int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL *key, void (*cleanup)(void *));
512void *CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL *key);
513int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL *key, void *val);
514int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key);
515
516CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void);
517int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b);
518
b4250010
DMSP
519OSSL_LIB_CTX *OSSL_LIB_CTX_new(void);
520int OSSL_LIB_CTX_load_config(OSSL_LIB_CTX *ctx, const char *config_file);
521void OSSL_LIB_CTX_free(OSSL_LIB_CTX *);
522OSSL_LIB_CTX *OSSL_LIB_CTX_set0_default(OSSL_LIB_CTX *libctx);
6d311938 523
0cd0a820 524# ifdef __cplusplus
d02b48c6 525}
0cd0a820 526# endif
d02b48c6 527#endif