2 * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
5 * Licensed under the OpenSSL license (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
11 #ifndef HEADER_CRYPTO_H
12 # define HEADER_CRYPTO_H
17 # include <openssl/e_os2.h>
19 # ifndef OPENSSL_NO_STDIO
23 # include <openssl/safestack.h>
24 # include <openssl/opensslv.h>
25 # include <openssl/ossl_typ.h>
26 # include <openssl/opensslconf.h>
27 # include <openssl/cryptoerr.h>
29 # ifdef CHARSET_EBCDIC
30 # include <openssl/ebcdic.h>
34 * Resolve problems on some operating systems with symbol names that clash
37 # include <openssl/symhacks.h>
39 # if OPENSSL_API_COMPAT < 0x10100000L
40 # include <openssl/opensslv.h>
47 # if OPENSSL_API_COMPAT < 0x10100000L
48 # define SSLeay OpenSSL_version_num
49 # define SSLeay_version OpenSSL_version
50 # define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
51 # define SSLEAY_VERSION OPENSSL_VERSION
52 # define SSLEAY_CFLAGS OPENSSL_CFLAGS
53 # define SSLEAY_BUILT_ON OPENSSL_BUILT_ON
54 # define SSLEAY_PLATFORM OPENSSL_PLATFORM
55 # define SSLEAY_DIR OPENSSL_DIR
58 * Old type for allocating dynamic locks. No longer used. Use the new thread
65 # endif /* OPENSSL_API_COMPAT */
67 typedef void CRYPTO_RWLOCK;
69 CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void);
70 CRYPTO_RWLOCK *CRYPTO_THREAD_glock_new(const char *name);
71 int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock);
72 int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock);
73 int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock);
74 void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock);
76 int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock);
77 int CRYPTO_atomic_read(int *val, int *ret, CRYPTO_RWLOCK *lock);
78 int CRYPTO_atomic_write(int *val, int n, CRYPTO_RWLOCK *lock);
81 * The following can be used to detect memory leaks in the library. If
82 * used, it turns on malloc checking
84 # define CRYPTO_MEM_CHECK_OFF 0x0 /* Control only */
85 # define CRYPTO_MEM_CHECK_ON 0x1 /* Control and mode bit */
86 # define CRYPTO_MEM_CHECK_ENABLE 0x2 /* Control and mode bit */
87 # define CRYPTO_MEM_CHECK_DISABLE 0x3 /* Control only */
89 struct crypto_ex_data_st {
95 * Per class, we have a STACK of function pointers.
97 # define CRYPTO_EX_INDEX_SSL 0
98 # define CRYPTO_EX_INDEX_SSL_CTX 1
99 # define CRYPTO_EX_INDEX_SSL_SESSION 2
100 # define CRYPTO_EX_INDEX_X509 3
101 # define CRYPTO_EX_INDEX_X509_STORE 4
102 # define CRYPTO_EX_INDEX_X509_STORE_CTX 5
103 # define CRYPTO_EX_INDEX_DH 6
104 # define CRYPTO_EX_INDEX_DSA 7
105 # define CRYPTO_EX_INDEX_EC_KEY 8
106 # define CRYPTO_EX_INDEX_RSA 9
107 # define CRYPTO_EX_INDEX_ENGINE 10
108 # define CRYPTO_EX_INDEX_UI 11
109 # define CRYPTO_EX_INDEX_BIO 12
110 # define CRYPTO_EX_INDEX_APP 13
111 # define CRYPTO_EX_INDEX_UI_METHOD 14
112 # define CRYPTO_EX_INDEX_DRBG 15
113 # define CRYPTO_EX_INDEX__COUNT 16
116 * This is the default callbacks, but we can have others as well: this is
117 * needed in Win32 where the application malloc and the library malloc may
120 #define OPENSSL_malloc_init() \
121 CRYPTO_set_mem_functions(CRYPTO_malloc, CRYPTO_realloc, CRYPTO_free)
123 int CRYPTO_mem_ctrl(int mode);
125 # define OPENSSL_malloc(num) \
126 CRYPTO_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
127 # define OPENSSL_zalloc(num) \
128 CRYPTO_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
129 # define OPENSSL_realloc(addr, num) \
130 CRYPTO_realloc(addr, num, OPENSSL_FILE, OPENSSL_LINE)
131 # define OPENSSL_clear_realloc(addr, old_num, num) \
132 CRYPTO_clear_realloc(addr, old_num, num, OPENSSL_FILE, OPENSSL_LINE)
133 # define OPENSSL_clear_free(addr, num) \
134 CRYPTO_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
135 # define OPENSSL_free(addr) \
136 CRYPTO_free(addr, OPENSSL_FILE, OPENSSL_LINE)
137 # define OPENSSL_memdup(str, s) \
138 CRYPTO_memdup((str), s, OPENSSL_FILE, OPENSSL_LINE)
139 # define OPENSSL_strdup(str) \
140 CRYPTO_strdup(str, OPENSSL_FILE, OPENSSL_LINE)
141 # define OPENSSL_strndup(str, n) \
142 CRYPTO_strndup(str, n, OPENSSL_FILE, OPENSSL_LINE)
143 # define OPENSSL_secure_malloc(num) \
144 CRYPTO_secure_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
145 # define OPENSSL_secure_zalloc(num) \
146 CRYPTO_secure_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
147 # define OPENSSL_secure_free(addr) \
148 CRYPTO_secure_free(addr, OPENSSL_FILE, OPENSSL_LINE)
149 # define OPENSSL_secure_clear_free(addr, num) \
150 CRYPTO_secure_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
151 # define OPENSSL_secure_actual_size(ptr) \
152 CRYPTO_secure_actual_size(ptr)
154 size_t OPENSSL_strlcpy(char *dst, const char *src, size_t siz);
155 size_t OPENSSL_strlcat(char *dst, const char *src, size_t siz);
156 size_t OPENSSL_strnlen(const char *str, size_t maxlen);
157 char *OPENSSL_buf2hexstr(const unsigned char *buffer, long len);
158 unsigned char *OPENSSL_hexstr2buf(const char *str, long *len);
159 int OPENSSL_hexchar2int(unsigned char c);
161 # define OPENSSL_MALLOC_MAX_NELEMS(type) (((1U<<(sizeof(int)*8-1))-1)/sizeof(type))
163 unsigned long OpenSSL_version_num(void);
164 const char *OpenSSL_version(int type);
165 # define OPENSSL_VERSION 0
166 # define OPENSSL_CFLAGS 1
167 # define OPENSSL_BUILT_ON 2
168 # define OPENSSL_PLATFORM 3
169 # define OPENSSL_DIR 4
170 # define OPENSSL_ENGINES_DIR 5
172 int OPENSSL_issetugid(void);
174 typedef void CRYPTO_EX_new (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
175 int idx, long argl, void *argp);
176 typedef void CRYPTO_EX_free (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
177 int idx, long argl, void *argp);
178 typedef int CRYPTO_EX_dup (CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
179 void *from_d, int idx, long argl, void *argp);
180 __owur int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
181 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
182 CRYPTO_EX_free *free_func);
183 /* No longer use an index. */
184 int CRYPTO_free_ex_index(int class_index, int idx);
187 * Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a
188 * given class (invokes whatever per-class callbacks are applicable)
190 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
191 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
192 const CRYPTO_EX_DATA *from);
194 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
197 * Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular
198 * index (relative to the class type involved)
200 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
201 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
203 # if OPENSSL_API_COMPAT < 0x10100000L
205 * This function cleans up all "ex_data" state. It mustn't be called under
206 * potential race-conditions.
208 # define CRYPTO_cleanup_all_ex_data() while(0) continue
211 * The old locking functions have been removed completely without compatibility
212 * macros. This is because the old functions either could not properly report
213 * errors, or the returned error values were not clearly documented.
214 * Replacing the locking functions with no-ops would cause race condition
215 * issues in the affected applications. It is far better for them to fail at
217 * On the other hand, the locking callbacks are no longer used. Consequently,
218 * the callback management functions can be safely replaced with no-op macros.
220 # define CRYPTO_num_locks() (1)
221 # define CRYPTO_set_locking_callback(func)
222 # define CRYPTO_get_locking_callback() (NULL)
223 # define CRYPTO_set_add_lock_callback(func)
224 # define CRYPTO_get_add_lock_callback() (NULL)
227 * These defines where used in combination with the old locking callbacks,
228 * they are not called anymore, but old code that's not called might still
231 # define CRYPTO_LOCK 1
232 # define CRYPTO_UNLOCK 2
233 # define CRYPTO_READ 4
234 # define CRYPTO_WRITE 8
236 /* This structure is no longer used */
237 typedef struct crypto_threadid_st {
240 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
241 # define CRYPTO_THREADID_set_numeric(id, val)
242 # define CRYPTO_THREADID_set_pointer(id, ptr)
243 # define CRYPTO_THREADID_set_callback(threadid_func) (0)
244 # define CRYPTO_THREADID_get_callback() (NULL)
245 # define CRYPTO_THREADID_current(id)
246 # define CRYPTO_THREADID_cmp(a, b) (-1)
247 # define CRYPTO_THREADID_cpy(dest, src)
248 # define CRYPTO_THREADID_hash(id) (0UL)
250 # if OPENSSL_API_COMPAT < 0x10000000L
251 # define CRYPTO_set_id_callback(func)
252 # define CRYPTO_get_id_callback() (NULL)
253 # define CRYPTO_thread_id() (0UL)
254 # endif /* OPENSSL_API_COMPAT < 0x10000000L */
256 # define CRYPTO_set_dynlock_create_callback(dyn_create_function)
257 # define CRYPTO_set_dynlock_lock_callback(dyn_lock_function)
258 # define CRYPTO_set_dynlock_destroy_callback(dyn_destroy_function)
259 # define CRYPTO_get_dynlock_create_callback() (NULL)
260 # define CRYPTO_get_dynlock_lock_callback() (NULL)
261 # define CRYPTO_get_dynlock_destroy_callback() (NULL)
262 # endif /* OPENSSL_API_COMPAT < 0x10100000L */
264 int CRYPTO_set_mem_functions(
265 void *(*m) (size_t, const char *, int),
266 void *(*r) (void *, size_t, const char *, int),
267 void (*f) (void *, const char *, int));
268 int CRYPTO_set_mem_debug(int flag);
269 void CRYPTO_get_mem_functions(
270 void *(**m) (size_t, const char *, int),
271 void *(**r) (void *, size_t, const char *, int),
272 void (**f) (void *, const char *, int));
274 void *CRYPTO_malloc(size_t num, const char *file, int line);
275 void *CRYPTO_zalloc(size_t num, const char *file, int line);
276 void *CRYPTO_memdup(const void *str, size_t siz, const char *file, int line);
277 char *CRYPTO_strdup(const char *str, const char *file, int line);
278 char *CRYPTO_strndup(const char *str, size_t s, const char *file, int line);
279 void CRYPTO_free(void *ptr, const char *file, int line);
280 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line);
281 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line);
282 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
283 const char *file, int line);
285 int CRYPTO_secure_malloc_init(size_t sz, int minsize);
286 int CRYPTO_secure_malloc_done(void);
287 void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
288 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
289 void CRYPTO_secure_free(void *ptr, const char *file, int line);
290 void CRYPTO_secure_clear_free(void *ptr, size_t num,
291 const char *file, int line);
292 int CRYPTO_secure_allocated(const void *ptr);
293 int CRYPTO_secure_malloc_initialized(void);
294 size_t CRYPTO_secure_actual_size(void *ptr);
295 size_t CRYPTO_secure_used(void);
297 void OPENSSL_cleanse(void *ptr, size_t len);
299 # ifndef OPENSSL_NO_CRYPTO_MDEBUG
300 # define OPENSSL_mem_debug_push(info) \
301 CRYPTO_mem_debug_push(info, OPENSSL_FILE, OPENSSL_LINE)
302 # define OPENSSL_mem_debug_pop() \
303 CRYPTO_mem_debug_pop()
304 int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
305 int CRYPTO_mem_debug_pop(void);
306 void CRYPTO_get_alloc_counts(int *mcount, int *rcount, int *fcount);
309 * Debugging functions (enabled by CRYPTO_set_mem_debug(1))
310 * The flag argument has the following significance:
311 * 0: called before the actual memory allocation has taken place
312 * 1: called after the actual memory allocation has taken place
314 void CRYPTO_mem_debug_malloc(void *addr, size_t num, int flag,
315 const char *file, int line);
316 void CRYPTO_mem_debug_realloc(void *addr1, void *addr2, size_t num, int flag,
317 const char *file, int line);
318 void CRYPTO_mem_debug_free(void *addr, int flag,
319 const char *file, int line);
321 int CRYPTO_mem_leaks_cb(int (*cb) (const char *str, size_t len, void *u),
323 # ifndef OPENSSL_NO_STDIO
324 int CRYPTO_mem_leaks_fp(FILE *);
326 int CRYPTO_mem_leaks(BIO *bio);
329 /* die if we have to */
330 ossl_noreturn void OPENSSL_die(const char *assertion, const char *file, int line);
331 # if OPENSSL_API_COMPAT < 0x10100000L
332 # define OpenSSLDie(f,l,a) OPENSSL_die((a),(f),(l))
334 # define OPENSSL_assert(e) \
335 (void)((e) ? 0 : (OPENSSL_die("assertion failed: " #e, OPENSSL_FILE, OPENSSL_LINE), 1))
337 int OPENSSL_isservice(void);
340 int FIPS_mode_set(int r);
342 void OPENSSL_init(void);
343 # ifdef OPENSSL_SYS_UNIX
344 void OPENSSL_fork_prepare(void);
345 void OPENSSL_fork_parent(void);
346 void OPENSSL_fork_child(void);
349 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
350 int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
351 int OPENSSL_gmtime_diff(int *pday, int *psec,
352 const struct tm *from, const struct tm *to);
355 * CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal.
356 * It takes an amount of time dependent on |len|, but independent of the
357 * contents of |a| and |b|. Unlike memcmp, it cannot be used to put elements
358 * into a defined order as the return value when a != b is undefined, other
359 * than to be non-zero.
361 int CRYPTO_memcmp(const void * in_a, const void * in_b, size_t len);
363 /* Standard initialisation options */
364 # define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0x00000001L
365 # define OPENSSL_INIT_LOAD_CRYPTO_STRINGS 0x00000002L
366 # define OPENSSL_INIT_ADD_ALL_CIPHERS 0x00000004L
367 # define OPENSSL_INIT_ADD_ALL_DIGESTS 0x00000008L
368 # define OPENSSL_INIT_NO_ADD_ALL_CIPHERS 0x00000010L
369 # define OPENSSL_INIT_NO_ADD_ALL_DIGESTS 0x00000020L
370 # define OPENSSL_INIT_LOAD_CONFIG 0x00000040L
371 # define OPENSSL_INIT_NO_LOAD_CONFIG 0x00000080L
372 # define OPENSSL_INIT_ASYNC 0x00000100L
373 # define OPENSSL_INIT_ENGINE_RDRAND 0x00000200L
374 # define OPENSSL_INIT_ENGINE_DYNAMIC 0x00000400L
375 # define OPENSSL_INIT_ENGINE_OPENSSL 0x00000800L
376 # define OPENSSL_INIT_ENGINE_CRYPTODEV 0x00001000L
377 # define OPENSSL_INIT_ENGINE_CAPI 0x00002000L
378 # define OPENSSL_INIT_ENGINE_PADLOCK 0x00004000L
379 # define OPENSSL_INIT_ENGINE_AFALG 0x00008000L
380 # define OPENSSL_INIT_reserved_internal 0x00010000L
381 # define OPENSSL_INIT_ATFORK 0x00020000L
382 /* OPENSSL_INIT flag range 0xfff00000 reserved for OPENSSL_init_ssl() */
383 /* Max OPENSSL_INIT flag value is 0x80000000 */
385 /* openssl and dasync not counted as builtin */
386 # define OPENSSL_INIT_ENGINE_ALL_BUILTIN \
387 (OPENSSL_INIT_ENGINE_RDRAND | OPENSSL_INIT_ENGINE_DYNAMIC \
388 | OPENSSL_INIT_ENGINE_CRYPTODEV | OPENSSL_INIT_ENGINE_CAPI | \
389 OPENSSL_INIT_ENGINE_PADLOCK)
392 /* Library initialisation functions */
393 void OPENSSL_cleanup(void);
394 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
395 int OPENSSL_atexit(void (*handler)(void));
396 void OPENSSL_thread_stop(void);
398 /* Low-level control of initialization */
399 OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void);
400 # ifndef OPENSSL_NO_STDIO
401 int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *settings,
402 const char *config_file);
404 void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *settings);
406 # if defined(OPENSSL_THREADS) && !defined(CRYPTO_TDEBUG)
408 # if defined(BASETYPES) || defined(_WINDEF_H)
409 /* application has to include <windows.h> in order to use this */
410 typedef DWORD CRYPTO_THREAD_LOCAL;
411 typedef DWORD CRYPTO_THREAD_ID;
413 typedef LONG CRYPTO_ONCE;
414 # define CRYPTO_ONCE_STATIC_INIT 0
417 # include <pthread.h>
418 typedef pthread_once_t CRYPTO_ONCE;
419 typedef pthread_key_t CRYPTO_THREAD_LOCAL;
420 typedef pthread_t CRYPTO_THREAD_ID;
422 # define CRYPTO_ONCE_STATIC_INIT PTHREAD_ONCE_INIT
426 # if !defined(CRYPTO_ONCE_STATIC_INIT)
427 typedef unsigned int CRYPTO_ONCE;
428 typedef unsigned int CRYPTO_THREAD_LOCAL;
429 typedef unsigned int CRYPTO_THREAD_ID;
430 # define CRYPTO_ONCE_STATIC_INIT 0
433 int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void));
435 int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL *key, void (*cleanup)(void *));
436 void *CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL *key);
437 int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL *key, void *val);
438 int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key);
440 CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void);
441 int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b);
443 int ERR_load_CRYPTO_strings(void);