2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
5 * Licensed under the Apache License 2.0 (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 OPENSSL_CRYPTO_H
12 # define OPENSSL_CRYPTO_H
15 # include <openssl/macros.h>
17 # define HEADER_CRYPTO_H
23 # include <openssl/e_os2.h>
25 # ifndef OPENSSL_NO_STDIO
29 # include <openssl/safestack.h>
30 # include <openssl/opensslv.h>
31 # include <openssl/types.h>
32 # include <openssl/opensslconf.h>
33 # include <openssl/cryptoerr.h>
35 # ifdef CHARSET_EBCDIC
36 # include <openssl/ebcdic.h>
40 * Resolve problems on some operating systems with symbol names that clash
43 # include <openssl/symhacks.h>
45 # if !OPENSSL_API_1_1_0
46 # include <openssl/opensslv.h>
53 # if !OPENSSL_API_1_1_0
54 # define SSLeay OpenSSL_version_num
55 # define SSLeay_version OpenSSL_version
56 # define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
57 # define SSLEAY_VERSION OPENSSL_VERSION
58 # define SSLEAY_CFLAGS OPENSSL_CFLAGS
59 # define SSLEAY_BUILT_ON OPENSSL_BUILT_ON
60 # define SSLEAY_PLATFORM OPENSSL_PLATFORM
61 # define SSLEAY_DIR OPENSSL_DIR
64 * Old type for allocating dynamic locks. No longer used. Use the new thread
71 # endif /* OPENSSL_API_1_1_0 */
73 typedef void CRYPTO_RWLOCK;
75 CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void);
76 int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock);
77 int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock);
78 int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock);
79 void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock);
81 int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock);
84 * The following can be used to detect memory leaks in the library. If
85 * used, it turns on malloc checking
87 # define CRYPTO_MEM_CHECK_OFF 0x0 /* Control only */
88 # define CRYPTO_MEM_CHECK_ON 0x1 /* Control and mode bit */
89 # define CRYPTO_MEM_CHECK_ENABLE 0x2 /* Control and mode bit */
90 # define CRYPTO_MEM_CHECK_DISABLE 0x3 /* Control only */
92 struct crypto_ex_data_st {
99 * Per class, we have a STACK of function pointers.
101 # define CRYPTO_EX_INDEX_SSL 0
102 # define CRYPTO_EX_INDEX_SSL_CTX 1
103 # define CRYPTO_EX_INDEX_SSL_SESSION 2
104 # define CRYPTO_EX_INDEX_X509 3
105 # define CRYPTO_EX_INDEX_X509_STORE 4
106 # define CRYPTO_EX_INDEX_X509_STORE_CTX 5
107 # define CRYPTO_EX_INDEX_DH 6
108 # define CRYPTO_EX_INDEX_DSA 7
109 # define CRYPTO_EX_INDEX_EC_KEY 8
110 # define CRYPTO_EX_INDEX_RSA 9
111 # define CRYPTO_EX_INDEX_ENGINE 10
112 # define CRYPTO_EX_INDEX_UI 11
113 # define CRYPTO_EX_INDEX_BIO 12
114 # define CRYPTO_EX_INDEX_APP 13
115 # define CRYPTO_EX_INDEX_UI_METHOD 14
116 # define CRYPTO_EX_INDEX_DRBG 15
117 # define CRYPTO_EX_INDEX_OPENSSL_CTX 16
118 # define CRYPTO_EX_INDEX__COUNT 17
120 /* No longer needed, so this is a no-op */
121 #define OPENSSL_malloc_init() while(0) continue
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 int OPENSSL_buf2hexstr_ex(char *str, size_t str_n, size_t *strlen,
158 const unsigned char *buf, size_t buflen);
159 char *OPENSSL_buf2hexstr(const unsigned char *buf, long buflen);
160 int OPENSSL_hexstr2buf_ex(unsigned char *buf, size_t buf_n, size_t *buflen,
162 unsigned char *OPENSSL_hexstr2buf(const char *str, long *buflen);
163 int OPENSSL_hexchar2int(unsigned char c);
165 # define OPENSSL_MALLOC_MAX_NELEMS(type) (((1U<<(sizeof(int)*8-1))-1)/sizeof(type))
167 unsigned long OpenSSL_version_num(void);
168 const char *OpenSSL_version(int type);
169 # define OPENSSL_VERSION 0
170 # define OPENSSL_CFLAGS 1
171 # define OPENSSL_BUILT_ON 2
172 # define OPENSSL_PLATFORM 3
173 # define OPENSSL_DIR 4
174 # define OPENSSL_ENGINES_DIR 5
175 # define OPENSSL_VERSION_STRING 6
176 # define OPENSSL_FULL_VERSION_STRING 7
177 # define OPENSSL_MODULES_DIR 8
178 # define OPENSSL_CPU_INFO 9
180 const char *OPENSSL_info(int type);
182 * The series starts at 1001 to avoid confusion with the OpenSSL_version
185 # define OPENSSL_INFO_CONFIG_DIR 1001
186 # define OPENSSL_INFO_ENGINES_DIR 1002
187 # define OPENSSL_INFO_MODULES_DIR 1003
188 # define OPENSSL_INFO_DSO_EXTENSION 1004
189 # define OPENSSL_INFO_DIR_FILENAME_SEPARATOR 1005
190 # define OPENSSL_INFO_LIST_SEPARATOR 1006
191 # define OPENSSL_INFO_SEED_SOURCE 1007
192 # define OPENSSL_INFO_CPU_SETTINGS 1008
194 int OPENSSL_issetugid(void);
196 typedef void CRYPTO_EX_new (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
197 int idx, long argl, void *argp);
198 typedef void CRYPTO_EX_free (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
199 int idx, long argl, void *argp);
200 typedef int CRYPTO_EX_dup (CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
201 void *from_d, int idx, long argl, void *argp);
202 __owur int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
203 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
204 CRYPTO_EX_free *free_func);
205 /* No longer use an index. */
206 int CRYPTO_free_ex_index(int class_index, int idx);
209 * Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a
210 * given class (invokes whatever per-class callbacks are applicable)
212 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
213 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
214 const CRYPTO_EX_DATA *from);
216 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
218 /* Allocate a single item in the CRYPTO_EX_DATA variable */
219 int CRYPTO_alloc_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad,
223 * Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular
224 * index (relative to the class type involved)
226 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
227 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
229 # if !OPENSSL_API_1_1_0
231 * This function cleans up all "ex_data" state. It mustn't be called under
232 * potential race-conditions.
234 # define CRYPTO_cleanup_all_ex_data() while(0) continue
237 * The old locking functions have been removed completely without compatibility
238 * macros. This is because the old functions either could not properly report
239 * errors, or the returned error values were not clearly documented.
240 * Replacing the locking functions with no-ops would cause race condition
241 * issues in the affected applications. It is far better for them to fail at
243 * On the other hand, the locking callbacks are no longer used. Consequently,
244 * the callback management functions can be safely replaced with no-op macros.
246 # define CRYPTO_num_locks() (1)
247 # define CRYPTO_set_locking_callback(func)
248 # define CRYPTO_get_locking_callback() (NULL)
249 # define CRYPTO_set_add_lock_callback(func)
250 # define CRYPTO_get_add_lock_callback() (NULL)
253 * These defines where used in combination with the old locking callbacks,
254 * they are not called anymore, but old code that's not called might still
257 # define CRYPTO_LOCK 1
258 # define CRYPTO_UNLOCK 2
259 # define CRYPTO_READ 4
260 # define CRYPTO_WRITE 8
262 /* This structure is no longer used */
263 typedef struct crypto_threadid_st {
266 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
267 # define CRYPTO_THREADID_set_numeric(id, val)
268 # define CRYPTO_THREADID_set_pointer(id, ptr)
269 # define CRYPTO_THREADID_set_callback(threadid_func) (0)
270 # define CRYPTO_THREADID_get_callback() (NULL)
271 # define CRYPTO_THREADID_current(id)
272 # define CRYPTO_THREADID_cmp(a, b) (-1)
273 # define CRYPTO_THREADID_cpy(dest, src)
274 # define CRYPTO_THREADID_hash(id) (0UL)
276 # if !OPENSSL_API_1_0_0
277 # define CRYPTO_set_id_callback(func)
278 # define CRYPTO_get_id_callback() (NULL)
279 # define CRYPTO_thread_id() (0UL)
280 # endif /* OPENSSL_API_1_0_0 */
282 # define CRYPTO_set_dynlock_create_callback(dyn_create_function)
283 # define CRYPTO_set_dynlock_lock_callback(dyn_lock_function)
284 # define CRYPTO_set_dynlock_destroy_callback(dyn_destroy_function)
285 # define CRYPTO_get_dynlock_create_callback() (NULL)
286 # define CRYPTO_get_dynlock_lock_callback() (NULL)
287 # define CRYPTO_get_dynlock_destroy_callback() (NULL)
288 # endif /* OPENSSL_API_1_1_0 */
290 int CRYPTO_set_mem_functions(
291 void *(*m) (size_t, const char *, int),
292 void *(*r) (void *, size_t, const char *, int),
293 void (*f) (void *, const char *, int));
294 int CRYPTO_set_mem_debug(int flag);
295 void CRYPTO_get_mem_functions(
296 void *(**m) (size_t, const char *, int),
297 void *(**r) (void *, size_t, const char *, int),
298 void (**f) (void *, const char *, int));
300 void *CRYPTO_malloc(size_t num, const char *file, int line);
301 void *CRYPTO_zalloc(size_t num, const char *file, int line);
302 void *CRYPTO_memdup(const void *str, size_t siz, const char *file, int line);
303 char *CRYPTO_strdup(const char *str, const char *file, int line);
304 char *CRYPTO_strndup(const char *str, size_t s, const char *file, int line);
305 void CRYPTO_free(void *ptr, const char *file, int line);
306 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line);
307 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line);
308 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
309 const char *file, int line);
311 int CRYPTO_secure_malloc_init(size_t sz, int minsize);
312 int CRYPTO_secure_malloc_done(void);
313 void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
314 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
315 void CRYPTO_secure_free(void *ptr, const char *file, int line);
316 void CRYPTO_secure_clear_free(void *ptr, size_t num,
317 const char *file, int line);
318 int CRYPTO_secure_allocated(const void *ptr);
319 int CRYPTO_secure_malloc_initialized(void);
320 size_t CRYPTO_secure_actual_size(void *ptr);
321 size_t CRYPTO_secure_used(void);
323 void OPENSSL_cleanse(void *ptr, size_t len);
325 # ifndef OPENSSL_NO_CRYPTO_MDEBUG
327 # define OPENSSL_mem_debug_push(info) \
328 CRYPTO_mem_debug_push(info, OPENSSL_FILE, OPENSSL_LINE)
329 # define OPENSSL_mem_debug_pop() \
330 CRYPTO_mem_debug_pop()
332 DEPRECATEDIN_3(int CRYPTO_mem_debug_push(const char *info,
333 const char *file, int line))
334 DEPRECATEDIN_3(int CRYPTO_mem_debug_pop(void))
336 void CRYPTO_get_alloc_counts(int *mcount, int *rcount, int *fcount);
339 * Debugging functions (enabled by CRYPTO_set_mem_debug(1))
340 * The flag argument has the following significance:
341 * 0: called before the actual memory allocation has taken place
342 * 1: called after the actual memory allocation has taken place
344 void CRYPTO_mem_debug_malloc(void *addr, size_t num, int flag,
345 const char *file, int line);
346 void CRYPTO_mem_debug_realloc(void *addr1, void *addr2, size_t num, int flag,
347 const char *file, int line);
348 void CRYPTO_mem_debug_free(void *addr, int flag,
349 const char *file, int line);
351 int CRYPTO_mem_leaks_cb(int (*cb) (const char *str, size_t len, void *u),
353 # ifndef OPENSSL_NO_STDIO
354 int CRYPTO_mem_leaks_fp(FILE *);
356 int CRYPTO_mem_leaks(BIO *bio);
359 /* die if we have to */
360 ossl_noreturn void OPENSSL_die(const char *assertion, const char *file, int line);
361 # if !OPENSSL_API_1_1_0
362 # define OpenSSLDie(f,l,a) OPENSSL_die((a),(f),(l))
364 # define OPENSSL_assert(e) \
365 (void)((e) ? 0 : (OPENSSL_die("assertion failed: " #e, OPENSSL_FILE, OPENSSL_LINE), 1))
367 int OPENSSL_isservice(void);
370 int FIPS_mode_set(int r);
372 void OPENSSL_init(void);
373 # ifdef OPENSSL_SYS_UNIX
374 void OPENSSL_fork_prepare(void);
375 void OPENSSL_fork_parent(void);
376 void OPENSSL_fork_child(void);
379 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
380 int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
381 int OPENSSL_gmtime_diff(int *pday, int *psec,
382 const struct tm *from, const struct tm *to);
385 * CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal.
386 * It takes an amount of time dependent on |len|, but independent of the
387 * contents of |a| and |b|. Unlike memcmp, it cannot be used to put elements
388 * into a defined order as the return value when a != b is undefined, other
389 * than to be non-zero.
391 int CRYPTO_memcmp(const void * in_a, const void * in_b, size_t len);
393 /* Standard initialisation options */
394 # define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0x00000001L
395 # define OPENSSL_INIT_LOAD_CRYPTO_STRINGS 0x00000002L
396 # define OPENSSL_INIT_ADD_ALL_CIPHERS 0x00000004L
397 # define OPENSSL_INIT_ADD_ALL_DIGESTS 0x00000008L
398 # define OPENSSL_INIT_NO_ADD_ALL_CIPHERS 0x00000010L
399 # define OPENSSL_INIT_NO_ADD_ALL_DIGESTS 0x00000020L
400 # define OPENSSL_INIT_LOAD_CONFIG 0x00000040L
401 # define OPENSSL_INIT_NO_LOAD_CONFIG 0x00000080L
402 # define OPENSSL_INIT_ASYNC 0x00000100L
403 # define OPENSSL_INIT_ENGINE_RDRAND 0x00000200L
404 # define OPENSSL_INIT_ENGINE_DYNAMIC 0x00000400L
405 # define OPENSSL_INIT_ENGINE_OPENSSL 0x00000800L
406 # define OPENSSL_INIT_ENGINE_CRYPTODEV 0x00001000L
407 # define OPENSSL_INIT_ENGINE_CAPI 0x00002000L
408 # define OPENSSL_INIT_ENGINE_PADLOCK 0x00004000L
409 # define OPENSSL_INIT_ENGINE_AFALG 0x00008000L
410 /* OPENSSL_INIT_ZLIB 0x00010000L */
411 # define OPENSSL_INIT_ATFORK 0x00020000L
412 /* OPENSSL_INIT_BASE_ONLY 0x00040000L */
413 # define OPENSSL_INIT_NO_ATEXIT 0x00080000L
414 /* OPENSSL_INIT flag range 0x03f00000 reserved for OPENSSL_init_ssl() */
415 /* FREE: 0x04000000L */
416 /* FREE: 0x08000000L */
417 /* FREE: 0x10000000L */
418 /* FREE: 0x20000000L */
419 /* FREE: 0x40000000L */
420 /* FREE: 0x80000000L */
421 /* Max OPENSSL_INIT flag value is 0x80000000 */
423 /* openssl and dasync not counted as builtin */
424 # define OPENSSL_INIT_ENGINE_ALL_BUILTIN \
425 (OPENSSL_INIT_ENGINE_RDRAND | OPENSSL_INIT_ENGINE_DYNAMIC \
426 | OPENSSL_INIT_ENGINE_CRYPTODEV | OPENSSL_INIT_ENGINE_CAPI | \
427 OPENSSL_INIT_ENGINE_PADLOCK)
430 /* Library initialisation functions */
431 void OPENSSL_cleanup(void);
432 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
433 int OPENSSL_atexit(void (*handler)(void));
434 void OPENSSL_thread_stop(void);
435 void OPENSSL_thread_stop_ex(OPENSSL_CTX *ctx);
437 /* Low-level control of initialization */
438 OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void);
439 # ifndef OPENSSL_NO_STDIO
440 int OPENSSL_INIT_set_config_filename(OPENSSL_INIT_SETTINGS *settings,
441 const char *config_filename);
442 void OPENSSL_INIT_set_config_file_flags(OPENSSL_INIT_SETTINGS *settings,
443 unsigned long flags);
444 int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *settings,
445 const char *config_appname);
447 void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *settings);
449 # if defined(OPENSSL_THREADS) && !defined(CRYPTO_TDEBUG)
451 # if defined(BASETYPES) || defined(_WINDEF_H)
452 /* application has to include <windows.h> in order to use this */
453 typedef DWORD CRYPTO_THREAD_LOCAL;
454 typedef DWORD CRYPTO_THREAD_ID;
456 typedef LONG CRYPTO_ONCE;
457 # define CRYPTO_ONCE_STATIC_INIT 0
460 # include <pthread.h>
461 typedef pthread_once_t CRYPTO_ONCE;
462 typedef pthread_key_t CRYPTO_THREAD_LOCAL;
463 typedef pthread_t CRYPTO_THREAD_ID;
465 # define CRYPTO_ONCE_STATIC_INIT PTHREAD_ONCE_INIT
469 # if !defined(CRYPTO_ONCE_STATIC_INIT)
470 typedef unsigned int CRYPTO_ONCE;
471 typedef unsigned int CRYPTO_THREAD_LOCAL;
472 typedef unsigned int CRYPTO_THREAD_ID;
473 # define CRYPTO_ONCE_STATIC_INIT 0
476 int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void));
478 int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL *key, void (*cleanup)(void *));
479 void *CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL *key);
480 int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL *key, void *val);
481 int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key);
483 CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void);
484 int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b);
486 OPENSSL_CTX *OPENSSL_CTX_new(void);
487 void OPENSSL_CTX_free(OPENSSL_CTX *);