crypto.h 17 KB

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