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 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_1_1_0
40 # include <openssl/opensslv.h>
47 # if !OPENSSL_API_1_1_0
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_1_1_0 */
67 typedef void CRYPTO_RWLOCK;
69 CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void);
70 int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock);
71 int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock);
72 int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock);
73 void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock);
75 int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock);
78 * The following can be used to detect memory leaks in the library. If
79 * used, it turns on malloc checking
81 # define CRYPTO_MEM_CHECK_OFF 0x0 /* Control only */
82 # define CRYPTO_MEM_CHECK_ON 0x1 /* Control and mode bit */
83 # define CRYPTO_MEM_CHECK_ENABLE 0x2 /* Control and mode bit */
84 # define CRYPTO_MEM_CHECK_DISABLE 0x3 /* Control only */
86 struct crypto_ex_data_st {
92 * Per class, we have a STACK of function pointers.
94 # define CRYPTO_EX_INDEX_SSL 0
95 # define CRYPTO_EX_INDEX_SSL_CTX 1
96 # define CRYPTO_EX_INDEX_SSL_SESSION 2
97 # define CRYPTO_EX_INDEX_X509 3
98 # define CRYPTO_EX_INDEX_X509_STORE 4
99 # define CRYPTO_EX_INDEX_X509_STORE_CTX 5
100 # define CRYPTO_EX_INDEX_DH 6
101 # define CRYPTO_EX_INDEX_DSA 7
102 # define CRYPTO_EX_INDEX_EC_KEY 8
103 # define CRYPTO_EX_INDEX_RSA 9
104 # define CRYPTO_EX_INDEX_ENGINE 10
105 # define CRYPTO_EX_INDEX_UI 11
106 # define CRYPTO_EX_INDEX_BIO 12
107 # define CRYPTO_EX_INDEX_APP 13
108 # define CRYPTO_EX_INDEX_UI_METHOD 14
109 # define CRYPTO_EX_INDEX_DRBG 15
110 # define CRYPTO_EX_INDEX_OPENSSL_CTX 16
111 # define CRYPTO_EX_INDEX__COUNT 17
113 /* No longer needed, so this is a no-op */
114 #define OPENSSL_malloc_init() while(0) continue
116 int CRYPTO_mem_ctrl(int mode);
118 # define OPENSSL_malloc(num) \
119 CRYPTO_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
120 # define OPENSSL_zalloc(num) \
121 CRYPTO_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
122 # define OPENSSL_realloc(addr, num) \
123 CRYPTO_realloc(addr, num, OPENSSL_FILE, OPENSSL_LINE)
124 # define OPENSSL_clear_realloc(addr, old_num, num) \
125 CRYPTO_clear_realloc(addr, old_num, num, OPENSSL_FILE, OPENSSL_LINE)
126 # define OPENSSL_clear_free(addr, num) \
127 CRYPTO_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
128 # define OPENSSL_free(addr) \
129 CRYPTO_free(addr, OPENSSL_FILE, OPENSSL_LINE)
130 # define OPENSSL_memdup(str, s) \
131 CRYPTO_memdup((str), s, OPENSSL_FILE, OPENSSL_LINE)
132 # define OPENSSL_strdup(str) \
133 CRYPTO_strdup(str, OPENSSL_FILE, OPENSSL_LINE)
134 # define OPENSSL_strndup(str, n) \
135 CRYPTO_strndup(str, n, OPENSSL_FILE, OPENSSL_LINE)
136 # define OPENSSL_secure_malloc(num) \
137 CRYPTO_secure_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
138 # define OPENSSL_secure_zalloc(num) \
139 CRYPTO_secure_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
140 # define OPENSSL_secure_free(addr) \
141 CRYPTO_secure_free(addr, OPENSSL_FILE, OPENSSL_LINE)
142 # define OPENSSL_secure_clear_free(addr, num) \
143 CRYPTO_secure_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
144 # define OPENSSL_secure_actual_size(ptr) \
145 CRYPTO_secure_actual_size(ptr)
147 size_t OPENSSL_strlcpy(char *dst, const char *src, size_t siz);
148 size_t OPENSSL_strlcat(char *dst, const char *src, size_t siz);
149 size_t OPENSSL_strnlen(const char *str, size_t maxlen);
150 char *OPENSSL_buf2hexstr(const unsigned char *buffer, long len);
151 unsigned char *OPENSSL_hexstr2buf(const char *str, long *len);
152 int OPENSSL_hexchar2int(unsigned char c);
154 # define OPENSSL_MALLOC_MAX_NELEMS(type) (((1U<<(sizeof(int)*8-1))-1)/sizeof(type))
156 DEPRECATEDIN_3(unsigned long OpenSSL_version_num(void))
157 const char *OpenSSL_version(int type);
158 # define OPENSSL_VERSION 0
159 # define OPENSSL_CFLAGS 1
160 # define OPENSSL_BUILT_ON 2
161 # define OPENSSL_PLATFORM 3
162 # define OPENSSL_DIR 4
163 # define OPENSSL_ENGINES_DIR 5
164 # define OPENSSL_VERSION_STRING 6
165 # define OPENSSL_FULL_VERSION_STRING 7
166 # define OPENSSL_MODULES_DIR 8
168 const char *OPENSSL_info(int type);
170 * The series starts at 1001 to avoid confusion with the OpenSSL_version
173 # define OPENSSL_INFO_CONFIG_DIR 1001
174 # define OPENSSL_INFO_ENGINES_DIR 1002
175 # define OPENSSL_INFO_MODULES_DIR 1003
176 # define OPENSSL_INFO_DSO_EXTENSION 1004
177 # define OPENSSL_INFO_DIR_FILENAME_SEPARATOR 1005
178 # define OPENSSL_INFO_LIST_SEPARATOR 1006
180 int OPENSSL_issetugid(void);
182 typedef void CRYPTO_EX_new (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
183 int idx, long argl, void *argp);
184 typedef void CRYPTO_EX_free (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
185 int idx, long argl, void *argp);
186 typedef int CRYPTO_EX_dup (CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
187 void *from_d, int idx, long argl, void *argp);
188 __owur int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
189 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
190 CRYPTO_EX_free *free_func);
191 /* No longer use an index. */
192 int CRYPTO_free_ex_index(int class_index, int idx);
195 * Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a
196 * given class (invokes whatever per-class callbacks are applicable)
198 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
199 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
200 const CRYPTO_EX_DATA *from);
202 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
204 /* Allocate a single item in the CRYPTO_EX_DATA variable */
205 int CRYPTO_alloc_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad,
209 * Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular
210 * index (relative to the class type involved)
212 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
213 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
215 # if !OPENSSL_API_1_1_0
217 * This function cleans up all "ex_data" state. It mustn't be called under
218 * potential race-conditions.
220 # define CRYPTO_cleanup_all_ex_data() while(0) continue
223 * The old locking functions have been removed completely without compatibility
224 * macros. This is because the old functions either could not properly report
225 * errors, or the returned error values were not clearly documented.
226 * Replacing the locking functions with no-ops would cause race condition
227 * issues in the affected applications. It is far better for them to fail at
229 * On the other hand, the locking callbacks are no longer used. Consequently,
230 * the callback management functions can be safely replaced with no-op macros.
232 # define CRYPTO_num_locks() (1)
233 # define CRYPTO_set_locking_callback(func)
234 # define CRYPTO_get_locking_callback() (NULL)
235 # define CRYPTO_set_add_lock_callback(func)
236 # define CRYPTO_get_add_lock_callback() (NULL)
239 * These defines where used in combination with the old locking callbacks,
240 * they are not called anymore, but old code that's not called might still
243 # define CRYPTO_LOCK 1
244 # define CRYPTO_UNLOCK 2
245 # define CRYPTO_READ 4
246 # define CRYPTO_WRITE 8
248 /* This structure is no longer used */
249 typedef struct crypto_threadid_st {
252 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
253 # define CRYPTO_THREADID_set_numeric(id, val)
254 # define CRYPTO_THREADID_set_pointer(id, ptr)
255 # define CRYPTO_THREADID_set_callback(threadid_func) (0)
256 # define CRYPTO_THREADID_get_callback() (NULL)
257 # define CRYPTO_THREADID_current(id)
258 # define CRYPTO_THREADID_cmp(a, b) (-1)
259 # define CRYPTO_THREADID_cpy(dest, src)
260 # define CRYPTO_THREADID_hash(id) (0UL)
262 # if !OPENSSL_API_1_0_0
263 # define CRYPTO_set_id_callback(func)
264 # define CRYPTO_get_id_callback() (NULL)
265 # define CRYPTO_thread_id() (0UL)
266 # endif /* OPENSSL_API_1_0_0 */
268 # define CRYPTO_set_dynlock_create_callback(dyn_create_function)
269 # define CRYPTO_set_dynlock_lock_callback(dyn_lock_function)
270 # define CRYPTO_set_dynlock_destroy_callback(dyn_destroy_function)
271 # define CRYPTO_get_dynlock_create_callback() (NULL)
272 # define CRYPTO_get_dynlock_lock_callback() (NULL)
273 # define CRYPTO_get_dynlock_destroy_callback() (NULL)
274 # endif /* OPENSSL_API_1_1_0 */
276 int CRYPTO_set_mem_functions(
277 void *(*m) (size_t, const char *, int),
278 void *(*r) (void *, size_t, const char *, int),
279 void (*f) (void *, const char *, int));
280 int CRYPTO_set_mem_debug(int flag);
281 void CRYPTO_get_mem_functions(
282 void *(**m) (size_t, const char *, int),
283 void *(**r) (void *, size_t, const char *, int),
284 void (**f) (void *, const char *, int));
286 void *CRYPTO_malloc(size_t num, const char *file, int line);
287 void *CRYPTO_zalloc(size_t num, const char *file, int line);
288 void *CRYPTO_memdup(const void *str, size_t siz, const char *file, int line);
289 char *CRYPTO_strdup(const char *str, const char *file, int line);
290 char *CRYPTO_strndup(const char *str, size_t s, const char *file, int line);
291 void CRYPTO_free(void *ptr, const char *file, int line);
292 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line);
293 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line);
294 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
295 const char *file, int line);
297 int CRYPTO_secure_malloc_init(size_t sz, int minsize);
298 int CRYPTO_secure_malloc_done(void);
299 void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
300 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
301 void CRYPTO_secure_free(void *ptr, const char *file, int line);
302 void CRYPTO_secure_clear_free(void *ptr, size_t num,
303 const char *file, int line);
304 int CRYPTO_secure_allocated(const void *ptr);
305 int CRYPTO_secure_malloc_initialized(void);
306 size_t CRYPTO_secure_actual_size(void *ptr);
307 size_t CRYPTO_secure_used(void);
309 void OPENSSL_cleanse(void *ptr, size_t len);
311 # ifndef OPENSSL_NO_CRYPTO_MDEBUG
312 # define OPENSSL_mem_debug_push(info) \
313 CRYPTO_mem_debug_push(info, OPENSSL_FILE, OPENSSL_LINE)
314 # define OPENSSL_mem_debug_pop() \
315 CRYPTO_mem_debug_pop()
316 int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
317 int CRYPTO_mem_debug_pop(void);
318 void CRYPTO_get_alloc_counts(int *mcount, int *rcount, int *fcount);
321 * Debugging functions (enabled by CRYPTO_set_mem_debug(1))
322 * The flag argument has the following significance:
323 * 0: called before the actual memory allocation has taken place
324 * 1: called after the actual memory allocation has taken place
326 void CRYPTO_mem_debug_malloc(void *addr, size_t num, int flag,
327 const char *file, int line);
328 void CRYPTO_mem_debug_realloc(void *addr1, void *addr2, size_t num, int flag,
329 const char *file, int line);
330 void CRYPTO_mem_debug_free(void *addr, int flag,
331 const char *file, int line);
333 int CRYPTO_mem_leaks_cb(int (*cb) (const char *str, size_t len, void *u),
335 # ifndef OPENSSL_NO_STDIO
336 int CRYPTO_mem_leaks_fp(FILE *);
338 int CRYPTO_mem_leaks(BIO *bio);
341 /* die if we have to */
342 ossl_noreturn void OPENSSL_die(const char *assertion, const char *file, int line);
343 # if !OPENSSL_API_1_1_0
344 # define OpenSSLDie(f,l,a) OPENSSL_die((a),(f),(l))
346 # define OPENSSL_assert(e) \
347 (void)((e) ? 0 : (OPENSSL_die("assertion failed: " #e, OPENSSL_FILE, OPENSSL_LINE), 1))
349 int OPENSSL_isservice(void);
352 int FIPS_mode_set(int r);
354 void OPENSSL_init(void);
355 # ifdef OPENSSL_SYS_UNIX
356 void OPENSSL_fork_prepare(void);
357 void OPENSSL_fork_parent(void);
358 void OPENSSL_fork_child(void);
361 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
362 int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
363 int OPENSSL_gmtime_diff(int *pday, int *psec,
364 const struct tm *from, const struct tm *to);
367 * CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal.
368 * It takes an amount of time dependent on |len|, but independent of the
369 * contents of |a| and |b|. Unlike memcmp, it cannot be used to put elements
370 * into a defined order as the return value when a != b is undefined, other
371 * than to be non-zero.
373 int CRYPTO_memcmp(const void * in_a, const void * in_b, size_t len);
375 /* Standard initialisation options */
376 # define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0x00000001L
377 # define OPENSSL_INIT_LOAD_CRYPTO_STRINGS 0x00000002L
378 # define OPENSSL_INIT_ADD_ALL_CIPHERS 0x00000004L
379 # define OPENSSL_INIT_ADD_ALL_DIGESTS 0x00000008L
380 # define OPENSSL_INIT_NO_ADD_ALL_CIPHERS 0x00000010L
381 # define OPENSSL_INIT_NO_ADD_ALL_DIGESTS 0x00000020L
382 # define OPENSSL_INIT_LOAD_CONFIG 0x00000040L
383 # define OPENSSL_INIT_NO_LOAD_CONFIG 0x00000080L
384 # define OPENSSL_INIT_ASYNC 0x00000100L
385 # define OPENSSL_INIT_ENGINE_RDRAND 0x00000200L
386 # define OPENSSL_INIT_ENGINE_DYNAMIC 0x00000400L
387 # define OPENSSL_INIT_ENGINE_OPENSSL 0x00000800L
388 # define OPENSSL_INIT_ENGINE_CRYPTODEV 0x00001000L
389 # define OPENSSL_INIT_ENGINE_CAPI 0x00002000L
390 # define OPENSSL_INIT_ENGINE_PADLOCK 0x00004000L
391 # define OPENSSL_INIT_ENGINE_AFALG 0x00008000L
392 /* OPENSSL_INIT_ZLIB 0x00010000L */
393 # define OPENSSL_INIT_ATFORK 0x00020000L
394 /* OPENSSL_INIT_BASE_ONLY 0x00040000L */
395 # define OPENSSL_INIT_NO_ATEXIT 0x00080000L
396 /* OPENSSL_INIT flag range 0x03f00000 reserved for OPENSSL_init_ssl() */
397 # define OPENSSL_INIT_NO_ADD_ALL_MACS 0x04000000L
398 # define OPENSSL_INIT_ADD_ALL_MACS 0x08000000L
399 /* FREE: 0x10000000L */
400 /* FREE: 0x20000000L */
401 /* FREE: 0x40000000L */
402 /* FREE: 0x80000000L */
403 /* Max OPENSSL_INIT flag value is 0x80000000 */
405 /* openssl and dasync not counted as builtin */
406 # define OPENSSL_INIT_ENGINE_ALL_BUILTIN \
407 (OPENSSL_INIT_ENGINE_RDRAND | OPENSSL_INIT_ENGINE_DYNAMIC \
408 | OPENSSL_INIT_ENGINE_CRYPTODEV | OPENSSL_INIT_ENGINE_CAPI | \
409 OPENSSL_INIT_ENGINE_PADLOCK)
412 /* Library initialisation functions */
413 void OPENSSL_cleanup(void);
414 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
415 int OPENSSL_atexit(void (*handler)(void));
416 void OPENSSL_thread_stop(void);
418 /* Low-level control of initialization */
419 OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void);
420 # ifndef OPENSSL_NO_STDIO
421 int OPENSSL_INIT_set_config_filename(OPENSSL_INIT_SETTINGS *settings,
422 const char *config_filename);
423 void OPENSSL_INIT_set_config_file_flags(OPENSSL_INIT_SETTINGS *settings,
424 unsigned long flags);
425 int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *settings,
426 const char *config_appname);
428 void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *settings);
430 # if defined(OPENSSL_THREADS) && !defined(CRYPTO_TDEBUG)
432 # if defined(BASETYPES) || defined(_WINDEF_H)
433 /* application has to include <windows.h> in order to use this */
434 typedef DWORD CRYPTO_THREAD_LOCAL;
435 typedef DWORD CRYPTO_THREAD_ID;
437 typedef LONG CRYPTO_ONCE;
438 # define CRYPTO_ONCE_STATIC_INIT 0
441 # include <pthread.h>
442 typedef pthread_once_t CRYPTO_ONCE;
443 typedef pthread_key_t CRYPTO_THREAD_LOCAL;
444 typedef pthread_t CRYPTO_THREAD_ID;
446 # define CRYPTO_ONCE_STATIC_INIT PTHREAD_ONCE_INIT
450 # if !defined(CRYPTO_ONCE_STATIC_INIT)
451 typedef unsigned int CRYPTO_ONCE;
452 typedef unsigned int CRYPTO_THREAD_LOCAL;
453 typedef unsigned int CRYPTO_THREAD_ID;
454 # define CRYPTO_ONCE_STATIC_INIT 0
457 int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void));
459 int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL *key, void (*cleanup)(void *));
460 void *CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL *key);
461 int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL *key, void *val);
462 int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key);
464 CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void);
465 int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b);
467 OPENSSL_CTX *OPENSSL_CTX_new(void);
468 void OPENSSL_CTX_free(OPENSSL_CTX *);