err.h 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518
  1. /*
  2. * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
  3. *
  4. * Licensed under the Apache License 2.0 (the "License"). You may not use
  5. * this file except in compliance with the License. You can obtain a copy
  6. * in the file LICENSE in the source distribution or at
  7. * https://www.openssl.org/source/license.html
  8. */
  9. /* clang-format off */
  10. /* clang-format on */
  11. #ifndef OPENSSL_ERR_H
  12. #define OPENSSL_ERR_H
  13. #pragma once
  14. #include <openssl/macros.h>
  15. #ifndef OPENSSL_NO_DEPRECATED_3_0
  16. #define HEADER_ERR_H
  17. #endif
  18. #include <openssl/e_os2.h>
  19. #ifndef OPENSSL_NO_STDIO
  20. #include <stdio.h>
  21. #include <stdlib.h>
  22. #endif
  23. #include <openssl/types.h>
  24. #include <openssl/bio.h>
  25. #include <openssl/lhash.h>
  26. #include <openssl/cryptoerr_legacy.h>
  27. #ifdef __cplusplus
  28. extern "C" {
  29. #endif
  30. #ifndef OPENSSL_NO_DEPRECATED_3_0
  31. #ifndef OPENSSL_NO_FILENAMES
  32. #define ERR_PUT_error(l, f, r, fn, ln) ERR_put_error(l, f, r, fn, ln)
  33. #else
  34. #define ERR_PUT_error(l, f, r, fn, ln) ERR_put_error(l, f, r, NULL, 0)
  35. #endif
  36. #endif
  37. #include <limits.h>
  38. #include <errno.h>
  39. #define ERR_TXT_MALLOCED 0x01
  40. #define ERR_TXT_STRING 0x02
  41. #if !defined(OPENSSL_NO_DEPRECATED_3_0) || defined(OSSL_FORCE_ERR_STATE)
  42. #define ERR_FLAG_MARK 0x01
  43. #define ERR_FLAG_CLEAR 0x02
  44. #define ERR_NUM_ERRORS 16
  45. struct err_state_st {
  46. int err_flags[ERR_NUM_ERRORS];
  47. int err_marks[ERR_NUM_ERRORS];
  48. unsigned long err_buffer[ERR_NUM_ERRORS];
  49. char *err_data[ERR_NUM_ERRORS];
  50. size_t err_data_size[ERR_NUM_ERRORS];
  51. int err_data_flags[ERR_NUM_ERRORS];
  52. char *err_file[ERR_NUM_ERRORS];
  53. int err_line[ERR_NUM_ERRORS];
  54. char *err_func[ERR_NUM_ERRORS];
  55. int top, bottom;
  56. };
  57. #endif
  58. /* library */
  59. #define ERR_LIB_NONE 1
  60. #define ERR_LIB_SYS 2
  61. #define ERR_LIB_BN 3
  62. #define ERR_LIB_RSA 4
  63. #define ERR_LIB_DH 5
  64. #define ERR_LIB_EVP 6
  65. #define ERR_LIB_BUF 7
  66. #define ERR_LIB_OBJ 8
  67. #define ERR_LIB_PEM 9
  68. #define ERR_LIB_DSA 10
  69. #define ERR_LIB_X509 11
  70. /* #define ERR_LIB_METH 12 */
  71. #define ERR_LIB_ASN1 13
  72. #define ERR_LIB_CONF 14
  73. #define ERR_LIB_CRYPTO 15
  74. #define ERR_LIB_EC 16
  75. #define ERR_LIB_SSL 20
  76. /* #define ERR_LIB_SSL23 21 */
  77. /* #define ERR_LIB_SSL2 22 */
  78. /* #define ERR_LIB_SSL3 23 */
  79. /* #define ERR_LIB_RSAREF 30 */
  80. /* #define ERR_LIB_PROXY 31 */
  81. #define ERR_LIB_BIO 32
  82. #define ERR_LIB_PKCS7 33
  83. #define ERR_LIB_X509V3 34
  84. #define ERR_LIB_PKCS12 35
  85. #define ERR_LIB_RAND 36
  86. #define ERR_LIB_DSO 37
  87. #define ERR_LIB_ENGINE 38
  88. #define ERR_LIB_OCSP 39
  89. #define ERR_LIB_UI 40
  90. #define ERR_LIB_COMP 41
  91. #define ERR_LIB_ECDSA 42
  92. #define ERR_LIB_ECDH 43
  93. #define ERR_LIB_OSSL_STORE 44
  94. #define ERR_LIB_FIPS 45
  95. #define ERR_LIB_CMS 46
  96. #define ERR_LIB_TS 47
  97. #define ERR_LIB_HMAC 48
  98. /* # define ERR_LIB_JPAKE 49 */
  99. #define ERR_LIB_CT 50
  100. #define ERR_LIB_ASYNC 51
  101. #define ERR_LIB_KDF 52
  102. #define ERR_LIB_SM2 53
  103. #define ERR_LIB_ESS 54
  104. #define ERR_LIB_PROP 55
  105. #define ERR_LIB_CRMF 56
  106. #define ERR_LIB_PROV 57
  107. #define ERR_LIB_CMP 58
  108. #define ERR_LIB_OSSL_ENCODER 59
  109. #define ERR_LIB_OSSL_DECODER 60
  110. #define ERR_LIB_HTTP 61
  111. #define ERR_LIB_USER 128
  112. #ifndef OPENSSL_NO_DEPRECATED_3_0
  113. #define ASN1err(f, r) ERR_raise_data(ERR_LIB_ASN1, (r), NULL)
  114. #define ASYNCerr(f, r) ERR_raise_data(ERR_LIB_ASYNC, (r), NULL)
  115. #define BIOerr(f, r) ERR_raise_data(ERR_LIB_BIO, (r), NULL)
  116. #define BNerr(f, r) ERR_raise_data(ERR_LIB_BN, (r), NULL)
  117. #define BUFerr(f, r) ERR_raise_data(ERR_LIB_BUF, (r), NULL)
  118. #define CMPerr(f, r) ERR_raise_data(ERR_LIB_CMP, (r), NULL)
  119. #define CMSerr(f, r) ERR_raise_data(ERR_LIB_CMS, (r), NULL)
  120. #define COMPerr(f, r) ERR_raise_data(ERR_LIB_COMP, (r), NULL)
  121. #define CONFerr(f, r) ERR_raise_data(ERR_LIB_CONF, (r), NULL)
  122. #define CRMFerr(f, r) ERR_raise_data(ERR_LIB_CRMF, (r), NULL)
  123. #define CRYPTOerr(f, r) ERR_raise_data(ERR_LIB_CRYPTO, (r), NULL)
  124. #define CTerr(f, r) ERR_raise_data(ERR_LIB_CT, (r), NULL)
  125. #define DHerr(f, r) ERR_raise_data(ERR_LIB_DH, (r), NULL)
  126. #define DSAerr(f, r) ERR_raise_data(ERR_LIB_DSA, (r), NULL)
  127. #define DSOerr(f, r) ERR_raise_data(ERR_LIB_DSO, (r), NULL)
  128. #define ECDHerr(f, r) ERR_raise_data(ERR_LIB_ECDH, (r), NULL)
  129. #define ECDSAerr(f, r) ERR_raise_data(ERR_LIB_ECDSA, (r), NULL)
  130. #define ECerr(f, r) ERR_raise_data(ERR_LIB_EC, (r), NULL)
  131. #define ENGINEerr(f, r) ERR_raise_data(ERR_LIB_ENGINE, (r), NULL)
  132. #define ESSerr(f, r) ERR_raise_data(ERR_LIB_ESS, (r), NULL)
  133. #define EVPerr(f, r) ERR_raise_data(ERR_LIB_EVP, (r), NULL)
  134. #define FIPSerr(f, r) ERR_raise_data(ERR_LIB_FIPS, (r), NULL)
  135. #define HMACerr(f, r) ERR_raise_data(ERR_LIB_HMAC, (r), NULL)
  136. #define HTTPerr(f, r) ERR_raise_data(ERR_LIB_HTTP, (r), NULL)
  137. #define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
  138. #define OBJerr(f, r) ERR_raise_data(ERR_LIB_OBJ, (r), NULL)
  139. #define OCSPerr(f, r) ERR_raise_data(ERR_LIB_OCSP, (r), NULL)
  140. #define OSSL_STOREerr(f, r) ERR_raise_data(ERR_LIB_OSSL_STORE, (r), NULL)
  141. #define PEMerr(f, r) ERR_raise_data(ERR_LIB_PEM, (r), NULL)
  142. #define PKCS12err(f, r) ERR_raise_data(ERR_LIB_PKCS12, (r), NULL)
  143. #define PKCS7err(f, r) ERR_raise_data(ERR_LIB_PKCS7, (r), NULL)
  144. #define PROPerr(f, r) ERR_raise_data(ERR_LIB_PROP, (r), NULL)
  145. #define PROVerr(f, r) ERR_raise_data(ERR_LIB_PROV, (r), NULL)
  146. #define RANDerr(f, r) ERR_raise_data(ERR_LIB_RAND, (r), NULL)
  147. #define RSAerr(f, r) ERR_raise_data(ERR_LIB_RSA, (r), NULL)
  148. #define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
  149. #define SM2err(f, r) ERR_raise_data(ERR_LIB_SM2, (r), NULL)
  150. #define SSLerr(f, r) ERR_raise_data(ERR_LIB_SSL, (r), NULL)
  151. #define SYSerr(f, r) ERR_raise_data(ERR_LIB_SYS, (r), NULL)
  152. #define TSerr(f, r) ERR_raise_data(ERR_LIB_TS, (r), NULL)
  153. #define UIerr(f, r) ERR_raise_data(ERR_LIB_UI, (r), NULL)
  154. #define X509V3err(f, r) ERR_raise_data(ERR_LIB_X509V3, (r), NULL)
  155. #define X509err(f, r) ERR_raise_data(ERR_LIB_X509, (r), NULL)
  156. #endif
  157. /*-
  158. * The error code packs differently depending on if it records a system
  159. * error or an OpenSSL error.
  160. *
  161. * A system error packs like this (we follow POSIX and only allow positive
  162. * numbers that fit in an |int|):
  163. *
  164. * +-+-------------------------------------------------------------+
  165. * |1| system error number |
  166. * +-+-------------------------------------------------------------+
  167. *
  168. * An OpenSSL error packs like this:
  169. *
  170. * <---------------------------- 32 bits -------------------------->
  171. * <--- 8 bits ---><------------------ 23 bits ----------------->
  172. * +-+---------------+---------------------------------------------+
  173. * |0| library | reason |
  174. * +-+---------------+---------------------------------------------+
  175. *
  176. * A few of the reason bits are reserved as flags with special meaning:
  177. *
  178. * <5 bits-<>--------- 19 bits ----------------->
  179. * +-------+-+-----------------------------------+
  180. * | rflags| | reason |
  181. * +-------+-+-----------------------------------+
  182. * ^
  183. * |
  184. * ERR_RFLAG_FATAL = ERR_R_FATAL
  185. *
  186. * The reason flags are part of the overall reason code for practical
  187. * reasons, as they provide an easy way to place different types of
  188. * reason codes in different numeric ranges.
  189. *
  190. * The currently known reason flags are:
  191. *
  192. * ERR_RFLAG_FATAL Flags that the reason code is considered fatal.
  193. * For backward compatibility reasons, this flag
  194. * is also the code for ERR_R_FATAL (that reason
  195. * code served the dual purpose of flag and reason
  196. * code in one in pre-3.0 OpenSSL).
  197. * ERR_RFLAG_COMMON Flags that the reason code is common to all
  198. * libraries. All ERR_R_ macros must use this flag,
  199. * and no other _R_ macro is allowed to use it.
  200. */
  201. /* Macros to help decode recorded system errors */
  202. #define ERR_SYSTEM_FLAG ((unsigned int)INT_MAX + 1)
  203. #define ERR_SYSTEM_MASK ((unsigned int)INT_MAX)
  204. /*
  205. * Macros to help decode recorded OpenSSL errors
  206. * As expressed above, RFLAGS and REASON overlap by one bit to allow
  207. * ERR_R_FATAL to use ERR_RFLAG_FATAL as its reason code.
  208. */
  209. #define ERR_LIB_OFFSET 23L
  210. #define ERR_LIB_MASK 0xFF
  211. #define ERR_RFLAGS_OFFSET 18L
  212. #define ERR_RFLAGS_MASK 0x1F
  213. #define ERR_REASON_MASK 0X7FFFFF
  214. /*
  215. * Reason flags are defined pre-shifted to easily combine with the reason
  216. * number.
  217. */
  218. #define ERR_RFLAG_FATAL (0x1 << ERR_RFLAGS_OFFSET)
  219. #define ERR_RFLAG_COMMON (0x2 << ERR_RFLAGS_OFFSET)
  220. #define ERR_SYSTEM_ERROR(errcode) (((errcode) & ERR_SYSTEM_FLAG) != 0)
  221. static ossl_unused ossl_inline int ERR_GET_LIB(unsigned long errcode)
  222. {
  223. if (ERR_SYSTEM_ERROR(errcode))
  224. return ERR_LIB_SYS;
  225. return (errcode >> ERR_LIB_OFFSET) & ERR_LIB_MASK;
  226. }
  227. static ossl_unused ossl_inline int ERR_GET_RFLAGS(unsigned long errcode)
  228. {
  229. if (ERR_SYSTEM_ERROR(errcode))
  230. return 0;
  231. return errcode & (ERR_RFLAGS_MASK << ERR_RFLAGS_OFFSET);
  232. }
  233. static ossl_unused ossl_inline int ERR_GET_REASON(unsigned long errcode)
  234. {
  235. if (ERR_SYSTEM_ERROR(errcode))
  236. return errcode & ERR_SYSTEM_MASK;
  237. return errcode & ERR_REASON_MASK;
  238. }
  239. static ossl_unused ossl_inline int ERR_FATAL_ERROR(unsigned long errcode)
  240. {
  241. return (ERR_GET_RFLAGS(errcode) & ERR_RFLAG_FATAL) != 0;
  242. }
  243. static ossl_unused ossl_inline int ERR_COMMON_ERROR(unsigned long errcode)
  244. {
  245. return (ERR_GET_RFLAGS(errcode) & ERR_RFLAG_COMMON) != 0;
  246. }
  247. /*
  248. * ERR_PACK is a helper macro to properly pack OpenSSL error codes and may
  249. * only be used for that purpose. System errors are packed internally.
  250. * ERR_PACK takes reason flags and reason code combined in |reason|.
  251. * ERR_PACK ignores |func|, that parameter is just legacy from pre-3.0 OpenSSL.
  252. */
  253. #define ERR_PACK(lib, func, reason) \
  254. ((((unsigned long)(lib) & ERR_LIB_MASK) << ERR_LIB_OFFSET) | (((unsigned long)(reason) & ERR_REASON_MASK)))
  255. #ifndef OPENSSL_NO_DEPRECATED_3_0
  256. #define SYS_F_FOPEN 0
  257. #define SYS_F_CONNECT 0
  258. #define SYS_F_GETSERVBYNAME 0
  259. #define SYS_F_SOCKET 0
  260. #define SYS_F_IOCTLSOCKET 0
  261. #define SYS_F_BIND 0
  262. #define SYS_F_LISTEN 0
  263. #define SYS_F_ACCEPT 0
  264. #define SYS_F_WSASTARTUP 0
  265. #define SYS_F_OPENDIR 0
  266. #define SYS_F_FREAD 0
  267. #define SYS_F_GETADDRINFO 0
  268. #define SYS_F_GETNAMEINFO 0
  269. #define SYS_F_SETSOCKOPT 0
  270. #define SYS_F_GETSOCKOPT 0
  271. #define SYS_F_GETSOCKNAME 0
  272. #define SYS_F_GETHOSTBYNAME 0
  273. #define SYS_F_FFLUSH 0
  274. #define SYS_F_OPEN 0
  275. #define SYS_F_CLOSE 0
  276. #define SYS_F_IOCTL 0
  277. #define SYS_F_STAT 0
  278. #define SYS_F_FCNTL 0
  279. #define SYS_F_FSTAT 0
  280. #define SYS_F_SENDFILE 0
  281. #endif
  282. /*
  283. * All ERR_R_ codes must be combined with ERR_RFLAG_COMMON.
  284. */
  285. /* "we came from here" global reason codes, range 1..255 */
  286. #define ERR_R_SYS_LIB (ERR_LIB_SYS /* 2 */ | ERR_RFLAG_COMMON)
  287. #define ERR_R_BN_LIB (ERR_LIB_BN /* 3 */ | ERR_RFLAG_COMMON)
  288. #define ERR_R_RSA_LIB (ERR_LIB_RSA /* 4 */ | ERR_RFLAG_COMMON)
  289. #define ERR_R_DH_LIB (ERR_LIB_DH /* 5 */ | ERR_RFLAG_COMMON)
  290. #define ERR_R_EVP_LIB (ERR_LIB_EVP /* 6 */ | ERR_RFLAG_COMMON)
  291. #define ERR_R_BUF_LIB (ERR_LIB_BUF /* 7 */ | ERR_RFLAG_COMMON)
  292. #define ERR_R_OBJ_LIB (ERR_LIB_OBJ /* 8 */ | ERR_RFLAG_COMMON)
  293. #define ERR_R_PEM_LIB (ERR_LIB_PEM /* 9 */ | ERR_RFLAG_COMMON)
  294. #define ERR_R_DSA_LIB (ERR_LIB_DSA /* 10 */ | ERR_RFLAG_COMMON)
  295. #define ERR_R_X509_LIB (ERR_LIB_X509 /* 11 */ | ERR_RFLAG_COMMON)
  296. #define ERR_R_ASN1_LIB (ERR_LIB_ASN1 /* 13 */ | ERR_RFLAG_COMMON)
  297. #define ERR_R_CONF_LIB (ERR_LIB_CONF /* 14 */ | ERR_RFLAG_COMMON)
  298. #define ERR_R_CRYPTO_LIB (ERR_LIB_CRYPTO /* 15 */ | ERR_RFLAG_COMMON)
  299. #define ERR_R_EC_LIB (ERR_LIB_EC /* 16 */ | ERR_RFLAG_COMMON)
  300. #define ERR_R_SSL_LIB (ERR_LIB_SSL /* 20 */ | ERR_RFLAG_COMMON)
  301. #define ERR_R_BIO_LIB (ERR_LIB_BIO /* 32 */ | ERR_RFLAG_COMMON)
  302. #define ERR_R_PKCS7_LIB (ERR_LIB_PKCS7 /* 33 */ | ERR_RFLAG_COMMON)
  303. #define ERR_R_X509V3_LIB (ERR_LIB_X509V3 /* 34 */ | ERR_RFLAG_COMMON)
  304. #define ERR_R_PKCS12_LIB (ERR_LIB_PKCS12 /* 35 */ | ERR_RFLAG_COMMON)
  305. #define ERR_R_RAND_LIB (ERR_LIB_RAND /* 36 */ | ERR_RFLAG_COMMON)
  306. #define ERR_R_DSO_LIB (ERR_LIB_DSO /* 37 */ | ERR_RFLAG_COMMON)
  307. #define ERR_R_ENGINE_LIB (ERR_LIB_ENGINE /* 38 */ | ERR_RFLAG_COMMON)
  308. #define ERR_R_UI_LIB (ERR_LIB_UI /* 40 */ | ERR_RFLAG_COMMON)
  309. #define ERR_R_ECDSA_LIB (ERR_LIB_ECDSA /* 42 */ | ERR_RFLAG_COMMON)
  310. #define ERR_R_OSSL_STORE_LIB (ERR_LIB_OSSL_STORE /* 44 */ | ERR_RFLAG_COMMON)
  311. #define ERR_R_CMS_LIB (ERR_LIB_CMS /* 46 */ | ERR_RFLAG_COMMON)
  312. #define ERR_R_TS_LIB (ERR_LIB_TS /* 47 */ | ERR_RFLAG_COMMON)
  313. #define ERR_R_CT_LIB (ERR_LIB_CT /* 50 */ | ERR_RFLAG_COMMON)
  314. #define ERR_R_PROV_LIB (ERR_LIB_PROV /* 57 */ | ERR_RFLAG_COMMON)
  315. #define ERR_R_ESS_LIB (ERR_LIB_ESS /* 54 */ | ERR_RFLAG_COMMON)
  316. #define ERR_R_CMP_LIB (ERR_LIB_CMP /* 58 */ | ERR_RFLAG_COMMON)
  317. #define ERR_R_OSSL_ENCODER_LIB (ERR_LIB_OSSL_ENCODER /* 59 */ | ERR_RFLAG_COMMON)
  318. #define ERR_R_OSSL_DECODER_LIB (ERR_LIB_OSSL_DECODER /* 60 */ | ERR_RFLAG_COMMON)
  319. /* Other common error codes, range 256..2^ERR_RFLAGS_OFFSET-1 */
  320. #define ERR_R_FATAL (ERR_RFLAG_FATAL | ERR_RFLAG_COMMON)
  321. #define ERR_R_MALLOC_FAILURE (256 | ERR_R_FATAL)
  322. #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (257 | ERR_R_FATAL)
  323. #define ERR_R_PASSED_NULL_PARAMETER (258 | ERR_R_FATAL)
  324. #define ERR_R_INTERNAL_ERROR (259 | ERR_R_FATAL)
  325. #define ERR_R_DISABLED (260 | ERR_R_FATAL)
  326. #define ERR_R_INIT_FAIL (261 | ERR_R_FATAL)
  327. #define ERR_R_PASSED_INVALID_ARGUMENT (262 | ERR_RFLAG_COMMON)
  328. #define ERR_R_OPERATION_FAIL (263 | ERR_R_FATAL)
  329. #define ERR_R_INVALID_PROVIDER_FUNCTIONS (264 | ERR_R_FATAL)
  330. #define ERR_R_INTERRUPTED_OR_CANCELLED (265 | ERR_RFLAG_COMMON)
  331. #define ERR_R_NESTED_ASN1_ERROR (266 | ERR_RFLAG_COMMON)
  332. #define ERR_R_MISSING_ASN1_EOS (267 | ERR_RFLAG_COMMON)
  333. #define ERR_R_UNSUPPORTED (268 | ERR_RFLAG_COMMON)
  334. #define ERR_R_FETCH_FAILED (269 | ERR_RFLAG_COMMON)
  335. #define ERR_R_INVALID_PROPERTY_DEFINITION (270 | ERR_RFLAG_COMMON)
  336. #define ERR_R_UNABLE_TO_GET_READ_LOCK (271 | ERR_R_FATAL)
  337. #define ERR_R_UNABLE_TO_GET_WRITE_LOCK (272 | ERR_R_FATAL)
  338. typedef struct ERR_string_data_st {
  339. unsigned long error;
  340. const char *string;
  341. } ERR_STRING_DATA;
  342. /* clang-format off */
  343. DEFINE_LHASH_OF_INTERNAL(ERR_STRING_DATA);
  344. #define lh_ERR_STRING_DATA_new(hfn, cmp) ((LHASH_OF(ERR_STRING_DATA) *)OPENSSL_LH_set_thunks(OPENSSL_LH_new(ossl_check_ERR_STRING_DATA_lh_hashfunc_type(hfn), ossl_check_ERR_STRING_DATA_lh_compfunc_type(cmp)), lh_ERR_STRING_DATA_hash_thunk, lh_ERR_STRING_DATA_comp_thunk, lh_ERR_STRING_DATA_doall_thunk, lh_ERR_STRING_DATA_doall_arg_thunk))
  345. #define lh_ERR_STRING_DATA_free(lh) OPENSSL_LH_free(ossl_check_ERR_STRING_DATA_lh_type(lh))
  346. #define lh_ERR_STRING_DATA_flush(lh) OPENSSL_LH_flush(ossl_check_ERR_STRING_DATA_lh_type(lh))
  347. #define lh_ERR_STRING_DATA_insert(lh, ptr) ((ERR_STRING_DATA *)OPENSSL_LH_insert(ossl_check_ERR_STRING_DATA_lh_type(lh), ossl_check_ERR_STRING_DATA_lh_plain_type(ptr)))
  348. #define lh_ERR_STRING_DATA_delete(lh, ptr) ((ERR_STRING_DATA *)OPENSSL_LH_delete(ossl_check_ERR_STRING_DATA_lh_type(lh), ossl_check_const_ERR_STRING_DATA_lh_plain_type(ptr)))
  349. #define lh_ERR_STRING_DATA_retrieve(lh, ptr) ((ERR_STRING_DATA *)OPENSSL_LH_retrieve(ossl_check_ERR_STRING_DATA_lh_type(lh), ossl_check_const_ERR_STRING_DATA_lh_plain_type(ptr)))
  350. #define lh_ERR_STRING_DATA_error(lh) OPENSSL_LH_error(ossl_check_ERR_STRING_DATA_lh_type(lh))
  351. #define lh_ERR_STRING_DATA_num_items(lh) OPENSSL_LH_num_items(ossl_check_ERR_STRING_DATA_lh_type(lh))
  352. #define lh_ERR_STRING_DATA_node_stats_bio(lh, out) OPENSSL_LH_node_stats_bio(ossl_check_const_ERR_STRING_DATA_lh_type(lh), out)
  353. #define lh_ERR_STRING_DATA_node_usage_stats_bio(lh, out) OPENSSL_LH_node_usage_stats_bio(ossl_check_const_ERR_STRING_DATA_lh_type(lh), out)
  354. #define lh_ERR_STRING_DATA_stats_bio(lh, out) OPENSSL_LH_stats_bio(ossl_check_const_ERR_STRING_DATA_lh_type(lh), out)
  355. #define lh_ERR_STRING_DATA_get_down_load(lh) OPENSSL_LH_get_down_load(ossl_check_ERR_STRING_DATA_lh_type(lh))
  356. #define lh_ERR_STRING_DATA_set_down_load(lh, dl) OPENSSL_LH_set_down_load(ossl_check_ERR_STRING_DATA_lh_type(lh), dl)
  357. #define lh_ERR_STRING_DATA_doall(lh, dfn) OPENSSL_LH_doall(ossl_check_ERR_STRING_DATA_lh_type(lh), ossl_check_ERR_STRING_DATA_lh_doallfunc_type(dfn))
  358. /* clang-format on */
  359. /* 12 lines and some on an 80 column terminal */
  360. #define ERR_MAX_DATA_SIZE 1024
  361. /* Building blocks */
  362. void ERR_new(void);
  363. void ERR_set_debug(const char *file, int line, const char *func);
  364. void ERR_set_error(int lib, int reason, const char *fmt, ...);
  365. void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);
  366. /* Main error raising functions */
  367. #define ERR_raise(lib, reason) ERR_raise_data((lib), (reason), NULL)
  368. #define ERR_raise_data \
  369. (ERR_new(), \
  370. ERR_set_debug(OPENSSL_FILE, OPENSSL_LINE, OPENSSL_FUNC), \
  371. ERR_set_error)
  372. #ifndef OPENSSL_NO_DEPRECATED_3_0
  373. /* Backward compatibility */
  374. #define ERR_put_error(lib, func, reason, file, line) \
  375. (ERR_new(), \
  376. ERR_set_debug((file), (line), OPENSSL_FUNC), \
  377. ERR_set_error((lib), (reason), NULL))
  378. #endif
  379. void ERR_set_error_data(char *data, int flags);
  380. unsigned long ERR_get_error(void);
  381. unsigned long ERR_get_error_all(const char **file, int *line,
  382. const char **func,
  383. const char **data, int *flags);
  384. #ifndef OPENSSL_NO_DEPRECATED_3_0
  385. OSSL_DEPRECATEDIN_3_0
  386. unsigned long ERR_get_error_line(const char **file, int *line);
  387. OSSL_DEPRECATEDIN_3_0
  388. unsigned long ERR_get_error_line_data(const char **file, int *line,
  389. const char **data, int *flags);
  390. #endif
  391. unsigned long ERR_peek_error(void);
  392. unsigned long ERR_peek_error_line(const char **file, int *line);
  393. unsigned long ERR_peek_error_func(const char **func);
  394. unsigned long ERR_peek_error_data(const char **data, int *flags);
  395. unsigned long ERR_peek_error_all(const char **file, int *line,
  396. const char **func,
  397. const char **data, int *flags);
  398. #ifndef OPENSSL_NO_DEPRECATED_3_0
  399. OSSL_DEPRECATEDIN_3_0
  400. unsigned long ERR_peek_error_line_data(const char **file, int *line,
  401. const char **data, int *flags);
  402. #endif
  403. unsigned long ERR_peek_last_error(void);
  404. unsigned long ERR_peek_last_error_line(const char **file, int *line);
  405. unsigned long ERR_peek_last_error_func(const char **func);
  406. unsigned long ERR_peek_last_error_data(const char **data, int *flags);
  407. unsigned long ERR_peek_last_error_all(const char **file, int *line,
  408. const char **func,
  409. const char **data, int *flags);
  410. #ifndef OPENSSL_NO_DEPRECATED_3_0
  411. OSSL_DEPRECATEDIN_3_0
  412. unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
  413. const char **data, int *flags);
  414. #endif
  415. void ERR_clear_error(void);
  416. char *ERR_error_string(unsigned long e, char *buf);
  417. void ERR_error_string_n(unsigned long e, char *buf, size_t len);
  418. const char *ERR_lib_error_string(unsigned long e);
  419. #ifndef OPENSSL_NO_DEPRECATED_3_0
  420. OSSL_DEPRECATEDIN_3_0 const char *ERR_func_error_string(unsigned long e);
  421. #endif
  422. const char *ERR_reason_error_string(unsigned long e);
  423. void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u),
  424. void *u);
  425. #ifndef OPENSSL_NO_STDIO
  426. void ERR_print_errors_fp(FILE *fp);
  427. #endif
  428. void ERR_print_errors(BIO *bp);
  429. void ERR_add_error_data(int num, ...);
  430. void ERR_add_error_vdata(int num, va_list args);
  431. void ERR_add_error_txt(const char *sepr, const char *txt);
  432. void ERR_add_error_mem_bio(const char *sep, BIO *bio);
  433. int ERR_load_strings(int lib, ERR_STRING_DATA *str);
  434. int ERR_load_strings_const(const ERR_STRING_DATA *str);
  435. int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
  436. #ifndef OPENSSL_NO_DEPRECATED_1_1_0
  437. #define ERR_load_crypto_strings() \
  438. OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
  439. #define ERR_free_strings() \
  440. while (0) \
  441. continue
  442. #endif
  443. #ifndef OPENSSL_NO_DEPRECATED_1_1_0
  444. OSSL_DEPRECATEDIN_1_1_0 void ERR_remove_thread_state(void *);
  445. #endif
  446. #ifndef OPENSSL_NO_DEPRECATED_1_0_0
  447. OSSL_DEPRECATEDIN_1_0_0 void ERR_remove_state(unsigned long pid);
  448. #endif
  449. #ifndef OPENSSL_NO_DEPRECATED_3_0
  450. OSSL_DEPRECATEDIN_3_0 ERR_STATE *ERR_get_state(void);
  451. #endif
  452. int ERR_get_next_error_library(void);
  453. int ERR_set_mark(void);
  454. int ERR_pop_to_mark(void);
  455. int ERR_clear_last_mark(void);
  456. int ERR_count_to_mark(void);
  457. int ERR_pop(void);
  458. ERR_STATE *OSSL_ERR_STATE_new(void);
  459. void OSSL_ERR_STATE_save(ERR_STATE *es);
  460. void OSSL_ERR_STATE_save_to_mark(ERR_STATE *es);
  461. void OSSL_ERR_STATE_restore(const ERR_STATE *es);
  462. void OSSL_ERR_STATE_free(ERR_STATE *es);
  463. #ifdef __cplusplus
  464. }
  465. #endif
  466. #endif