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>
16 # ifndef OPENSSL_NO_DEPRECATED_3_0
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 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
46 # include <openssl/opensslv.h>
53 # ifndef OPENSSL_NO_DEPRECATED_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_NO_DEPRECATED_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_RAND_DRBG 15
117 # define CRYPTO_EX_INDEX_DRBG CRYPTO_EX_INDEX_RAND_DRBG
118 # define CRYPTO_EX_INDEX_OPENSSL_CTX 16
119 # define CRYPTO_EX_INDEX__COUNT 17
121 /* No longer needed, so this is a no-op */
122 #define OPENSSL_malloc_init() while(0) continue
124 # define OPENSSL_malloc(num) \
125 CRYPTO_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
126 # define OPENSSL_zalloc(num) \
127 CRYPTO_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
128 # define OPENSSL_realloc(addr, num) \
129 CRYPTO_realloc(addr, num, OPENSSL_FILE, OPENSSL_LINE)
130 # define OPENSSL_clear_realloc(addr, old_num, num) \
131 CRYPTO_clear_realloc(addr, old_num, num, OPENSSL_FILE, OPENSSL_LINE)
132 # define OPENSSL_clear_free(addr, num) \
133 CRYPTO_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
134 # define OPENSSL_free(addr) \
135 CRYPTO_free(addr, OPENSSL_FILE, OPENSSL_LINE)
136 # define OPENSSL_memdup(str, s) \
137 CRYPTO_memdup((str), s, OPENSSL_FILE, OPENSSL_LINE)
138 # define OPENSSL_strdup(str) \
139 CRYPTO_strdup(str, OPENSSL_FILE, OPENSSL_LINE)
140 # define OPENSSL_strndup(str, n) \
141 CRYPTO_strndup(str, n, OPENSSL_FILE, OPENSSL_LINE)
142 # define OPENSSL_secure_malloc(num) \
143 CRYPTO_secure_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
144 # define OPENSSL_secure_zalloc(num) \
145 CRYPTO_secure_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
146 # define OPENSSL_secure_free(addr) \
147 CRYPTO_secure_free(addr, OPENSSL_FILE, OPENSSL_LINE)
148 # define OPENSSL_secure_clear_free(addr, num) \
149 CRYPTO_secure_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
150 # define OPENSSL_secure_actual_size(ptr) \
151 CRYPTO_secure_actual_size(ptr)
153 size_t OPENSSL_strlcpy(char *dst, const char *src, size_t siz);
154 size_t OPENSSL_strlcat(char *dst, const char *src, size_t siz);
155 size_t OPENSSL_strnlen(const char *str, size_t maxlen);
156 int OPENSSL_buf2hexstr_ex(char *str, size_t str_n, size_t *strlen,
157 const unsigned char *buf, size_t buflen);
158 char *OPENSSL_buf2hexstr(const unsigned char *buf, long buflen);
159 int OPENSSL_hexstr2buf_ex(unsigned char *buf, size_t buf_n, size_t *buflen,
161 unsigned char *OPENSSL_hexstr2buf(const char *str, long *buflen);
162 int OPENSSL_hexchar2int(unsigned char c);
164 # define OPENSSL_MALLOC_MAX_NELEMS(type) (((1U<<(sizeof(int)*8-1))-1)/sizeof(type))
167 * These functions return the values of OPENSSL_VERSION_MAJOR,
168 * OPENSSL_VERSION_MINOR, OPENSSL_VERSION_PATCH, OPENSSL_VERSION_PRE_RELEASE
169 * and OPENSSL_VERSION_BUILD_METADATA, respectively.
171 unsigned int OPENSSL_version_major(void);
172 unsigned int OPENSSL_version_minor(void);
173 unsigned int OPENSSL_version_patch(void);
174 const char *OPENSSL_version_pre_release(void);
175 const char *OPENSSL_version_build_metadata(void);
177 unsigned long OpenSSL_version_num(void);
178 const char *OpenSSL_version(int type);
179 # define OPENSSL_VERSION 0
180 # define OPENSSL_CFLAGS 1
181 # define OPENSSL_BUILT_ON 2
182 # define OPENSSL_PLATFORM 3
183 # define OPENSSL_DIR 4
184 # define OPENSSL_ENGINES_DIR 5
185 # define OPENSSL_VERSION_STRING 6
186 # define OPENSSL_FULL_VERSION_STRING 7
187 # define OPENSSL_MODULES_DIR 8
188 # define OPENSSL_CPU_INFO 9
190 const char *OPENSSL_info(int type);
192 * The series starts at 1001 to avoid confusion with the OpenSSL_version
195 # define OPENSSL_INFO_CONFIG_DIR 1001
196 # define OPENSSL_INFO_ENGINES_DIR 1002
197 # define OPENSSL_INFO_MODULES_DIR 1003
198 # define OPENSSL_INFO_DSO_EXTENSION 1004
199 # define OPENSSL_INFO_DIR_FILENAME_SEPARATOR 1005
200 # define OPENSSL_INFO_LIST_SEPARATOR 1006
201 # define OPENSSL_INFO_SEED_SOURCE 1007
202 # define OPENSSL_INFO_CPU_SETTINGS 1008
204 int OPENSSL_issetugid(void);
206 typedef void CRYPTO_EX_new (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
207 int idx, long argl, void *argp);
208 typedef void CRYPTO_EX_free (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
209 int idx, long argl, void *argp);
210 typedef int CRYPTO_EX_dup (CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
211 void *from_d, int idx, long argl, void *argp);
212 __owur int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
213 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
214 CRYPTO_EX_free *free_func);
215 /* No longer use an index. */
216 int CRYPTO_free_ex_index(int class_index, int idx);
219 * Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a
220 * given class (invokes whatever per-class callbacks are applicable)
222 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
223 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
224 const CRYPTO_EX_DATA *from);
226 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
228 /* Allocate a single item in the CRYPTO_EX_DATA variable */
229 int CRYPTO_alloc_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad,
233 * Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular
234 * index (relative to the class type involved)
236 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
237 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
239 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
241 * This function cleans up all "ex_data" state. It mustn't be called under
242 * potential race-conditions.
244 # define CRYPTO_cleanup_all_ex_data() while(0) continue
247 * The old locking functions have been removed completely without compatibility
248 * macros. This is because the old functions either could not properly report
249 * errors, or the returned error values were not clearly documented.
250 * Replacing the locking functions with no-ops would cause race condition
251 * issues in the affected applications. It is far better for them to fail at
253 * On the other hand, the locking callbacks are no longer used. Consequently,
254 * the callback management functions can be safely replaced with no-op macros.
256 # define CRYPTO_num_locks() (1)
257 # define CRYPTO_set_locking_callback(func)
258 # define CRYPTO_get_locking_callback() (NULL)
259 # define CRYPTO_set_add_lock_callback(func)
260 # define CRYPTO_get_add_lock_callback() (NULL)
263 * These defines where used in combination with the old locking callbacks,
264 * they are not called anymore, but old code that's not called might still
267 # define CRYPTO_LOCK 1
268 # define CRYPTO_UNLOCK 2
269 # define CRYPTO_READ 4
270 # define CRYPTO_WRITE 8
272 /* This structure is no longer used */
273 typedef struct crypto_threadid_st {
276 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
277 # define CRYPTO_THREADID_set_numeric(id, val)
278 # define CRYPTO_THREADID_set_pointer(id, ptr)
279 # define CRYPTO_THREADID_set_callback(threadid_func) (0)
280 # define CRYPTO_THREADID_get_callback() (NULL)
281 # define CRYPTO_THREADID_current(id)
282 # define CRYPTO_THREADID_cmp(a, b) (-1)
283 # define CRYPTO_THREADID_cpy(dest, src)
284 # define CRYPTO_THREADID_hash(id) (0UL)
286 # ifndef OPENSSL_NO_DEPRECATED_1_0_0
287 # define CRYPTO_set_id_callback(func)
288 # define CRYPTO_get_id_callback() (NULL)
289 # define CRYPTO_thread_id() (0UL)
290 # endif /* OPENSSL_NO_DEPRECATED_1_0_0 */
292 # define CRYPTO_set_dynlock_create_callback(dyn_create_function)
293 # define CRYPTO_set_dynlock_lock_callback(dyn_lock_function)
294 # define CRYPTO_set_dynlock_destroy_callback(dyn_destroy_function)
295 # define CRYPTO_get_dynlock_create_callback() (NULL)
296 # define CRYPTO_get_dynlock_lock_callback() (NULL)
297 # define CRYPTO_get_dynlock_destroy_callback() (NULL)
298 # endif /* OPENSSL_NO_DEPRECATED_1_1_0 */
300 int CRYPTO_set_mem_functions(
301 void *(*m) (size_t, const char *, int),
302 void *(*r) (void *, size_t, const char *, int),
303 void (*f) (void *, const char *, int));
304 void CRYPTO_get_mem_functions(
305 void *(**m) (size_t, const char *, int),
306 void *(**r) (void *, size_t, const char *, int),
307 void (**f) (void *, const char *, int));
309 void *CRYPTO_malloc(size_t num, const char *file, int line);
310 void *CRYPTO_zalloc(size_t num, const char *file, int line);
311 void *CRYPTO_memdup(const void *str, size_t siz, const char *file, int line);
312 char *CRYPTO_strdup(const char *str, const char *file, int line);
313 char *CRYPTO_strndup(const char *str, size_t s, const char *file, int line);
314 void CRYPTO_free(void *ptr, const char *file, int line);
315 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line);
316 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line);
317 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
318 const char *file, int line);
320 int CRYPTO_secure_malloc_init(size_t sz, int minsize);
321 int CRYPTO_secure_malloc_done(void);
322 void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
323 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
324 void CRYPTO_secure_free(void *ptr, const char *file, int line);
325 void CRYPTO_secure_clear_free(void *ptr, size_t num,
326 const char *file, int line);
327 int CRYPTO_secure_allocated(const void *ptr);
328 int CRYPTO_secure_malloc_initialized(void);
329 size_t CRYPTO_secure_actual_size(void *ptr);
330 size_t CRYPTO_secure_used(void);
332 void OPENSSL_cleanse(void *ptr, size_t len);
334 # ifndef OPENSSL_NO_CRYPTO_MDEBUG
335 void CRYPTO_get_alloc_counts(int *mcount, int *rcount, int *fcount);
336 # ifndef OPENSSL_NO_DEPRECATED_3_0
337 # define OPENSSL_mem_debug_push(info) \
338 CRYPTO_mem_debug_push(info, OPENSSL_FILE, OPENSSL_LINE)
339 # define OPENSSL_mem_debug_pop() \
340 CRYPTO_mem_debug_pop()
342 DEPRECATEDIN_3_0(int CRYPTO_set_mem_debug(int flag))
343 DEPRECATEDIN_3_0(int CRYPTO_mem_ctrl(int mode))
344 DEPRECATEDIN_3_0(int CRYPTO_mem_debug_push(const char *info,
345 const char *file, int line))
346 DEPRECATEDIN_3_0(int CRYPTO_mem_debug_pop(void))
348 DEPRECATEDIN_3_0(void CRYPTO_mem_debug_malloc(void *addr, size_t num,
350 const char *file, int line))
351 DEPRECATEDIN_3_0(void CRYPTO_mem_debug_realloc(void *addr1, void *addr2,
352 size_t num, int flag,
353 const char *file, int line))
354 DEPRECATEDIN_3_0(void CRYPTO_mem_debug_free(void *addr, int flag,
355 const char *file, int line))
357 DEPRECATEDIN_3_0(int CRYPTO_mem_leaks_cb(
358 int (*cb)(const char *str, size_t len, void *u), void *u))
359 # ifndef OPENSSL_NO_STDIO
360 DEPRECATEDIN_3_0(int CRYPTO_mem_leaks_fp(FILE *))
362 DEPRECATEDIN_3_0(int CRYPTO_mem_leaks(BIO *bio))
365 /* die if we have to */
366 ossl_noreturn void OPENSSL_die(const char *assertion, const char *file, int line);
367 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
368 # define OpenSSLDie(f,l,a) OPENSSL_die((a),(f),(l))
370 # define OPENSSL_assert(e) \
371 (void)((e) ? 0 : (OPENSSL_die("assertion failed: " #e, OPENSSL_FILE, OPENSSL_LINE), 1))
373 int OPENSSL_isservice(void);
376 int FIPS_mode_set(int r);
378 void OPENSSL_init(void);
379 # ifdef OPENSSL_SYS_UNIX
380 void OPENSSL_fork_prepare(void);
381 void OPENSSL_fork_parent(void);
382 void OPENSSL_fork_child(void);
385 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
386 int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
387 int OPENSSL_gmtime_diff(int *pday, int *psec,
388 const struct tm *from, const struct tm *to);
391 * CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal.
392 * It takes an amount of time dependent on |len|, but independent of the
393 * contents of |a| and |b|. Unlike memcmp, it cannot be used to put elements
394 * into a defined order as the return value when a != b is undefined, other
395 * than to be non-zero.
397 int CRYPTO_memcmp(const void * in_a, const void * in_b, size_t len);
399 /* Standard initialisation options */
400 # define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0x00000001L
401 # define OPENSSL_INIT_LOAD_CRYPTO_STRINGS 0x00000002L
402 # define OPENSSL_INIT_ADD_ALL_CIPHERS 0x00000004L
403 # define OPENSSL_INIT_ADD_ALL_DIGESTS 0x00000008L
404 # define OPENSSL_INIT_NO_ADD_ALL_CIPHERS 0x00000010L
405 # define OPENSSL_INIT_NO_ADD_ALL_DIGESTS 0x00000020L
406 # define OPENSSL_INIT_LOAD_CONFIG 0x00000040L
407 # define OPENSSL_INIT_NO_LOAD_CONFIG 0x00000080L
408 # define OPENSSL_INIT_ASYNC 0x00000100L
409 # define OPENSSL_INIT_ENGINE_RDRAND 0x00000200L
410 # define OPENSSL_INIT_ENGINE_DYNAMIC 0x00000400L
411 # define OPENSSL_INIT_ENGINE_OPENSSL 0x00000800L
412 # define OPENSSL_INIT_ENGINE_CRYPTODEV 0x00001000L
413 # define OPENSSL_INIT_ENGINE_CAPI 0x00002000L
414 # define OPENSSL_INIT_ENGINE_PADLOCK 0x00004000L
415 # define OPENSSL_INIT_ENGINE_AFALG 0x00008000L
416 /* OPENSSL_INIT_ZLIB 0x00010000L */
417 # define OPENSSL_INIT_ATFORK 0x00020000L
418 /* OPENSSL_INIT_BASE_ONLY 0x00040000L */
419 # define OPENSSL_INIT_NO_ATEXIT 0x00080000L
420 /* OPENSSL_INIT flag range 0x03f00000 reserved for OPENSSL_init_ssl() */
421 /* FREE: 0x04000000L */
422 /* FREE: 0x08000000L */
423 /* FREE: 0x10000000L */
424 /* FREE: 0x20000000L */
425 /* FREE: 0x40000000L */
426 /* FREE: 0x80000000L */
427 /* Max OPENSSL_INIT flag value is 0x80000000 */
429 /* openssl and dasync not counted as builtin */
430 # define OPENSSL_INIT_ENGINE_ALL_BUILTIN \
431 (OPENSSL_INIT_ENGINE_RDRAND | OPENSSL_INIT_ENGINE_DYNAMIC \
432 | OPENSSL_INIT_ENGINE_CRYPTODEV | OPENSSL_INIT_ENGINE_CAPI | \
433 OPENSSL_INIT_ENGINE_PADLOCK)
436 /* Library initialisation functions */
437 void OPENSSL_cleanup(void);
438 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
439 int OPENSSL_atexit(void (*handler)(void));
440 void OPENSSL_thread_stop(void);
441 void OPENSSL_thread_stop_ex(OPENSSL_CTX *ctx);
443 /* Low-level control of initialization */
444 OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void);
445 # ifndef OPENSSL_NO_STDIO
446 int OPENSSL_INIT_set_config_filename(OPENSSL_INIT_SETTINGS *settings,
447 const char *config_filename);
448 void OPENSSL_INIT_set_config_file_flags(OPENSSL_INIT_SETTINGS *settings,
449 unsigned long flags);
450 int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *settings,
451 const char *config_appname);
453 void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *settings);
455 # if defined(OPENSSL_THREADS) && !defined(CRYPTO_TDEBUG)
457 # if defined(BASETYPES) || defined(_WINDEF_H)
458 /* application has to include <windows.h> in order to use this */
459 typedef DWORD CRYPTO_THREAD_LOCAL;
460 typedef DWORD CRYPTO_THREAD_ID;
462 typedef LONG CRYPTO_ONCE;
463 # define CRYPTO_ONCE_STATIC_INIT 0
466 # include <pthread.h>
467 typedef pthread_once_t CRYPTO_ONCE;
468 typedef pthread_key_t CRYPTO_THREAD_LOCAL;
469 typedef pthread_t CRYPTO_THREAD_ID;
471 # define CRYPTO_ONCE_STATIC_INIT PTHREAD_ONCE_INIT
475 # if !defined(CRYPTO_ONCE_STATIC_INIT)
476 typedef unsigned int CRYPTO_ONCE;
477 typedef unsigned int CRYPTO_THREAD_LOCAL;
478 typedef unsigned int CRYPTO_THREAD_ID;
479 # define CRYPTO_ONCE_STATIC_INIT 0
482 int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void));
484 int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL *key, void (*cleanup)(void *));
485 void *CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL *key);
486 int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL *key, void *val);
487 int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key);
489 CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void);
490 int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b);
492 OPENSSL_CTX *OPENSSL_CTX_new(void);
493 void OPENSSL_CTX_free(OPENSSL_CTX *);