err.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. /* crypto/err/err.h */
  2. /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  3. * All rights reserved.
  4. *
  5. * This package is an SSL implementation written
  6. * by Eric Young (eay@cryptsoft.com).
  7. * The implementation was written so as to conform with Netscapes SSL.
  8. *
  9. * This library is free for commercial and non-commercial use as long as
  10. * the following conditions are aheared to. The following conditions
  11. * apply to all code found in this distribution, be it the RC4, RSA,
  12. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  13. * included with this distribution is covered by the same copyright terms
  14. * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15. *
  16. * Copyright remains Eric Young's, and as such any Copyright notices in
  17. * the code are not to be removed.
  18. * If this package is used in a product, Eric Young should be given attribution
  19. * as the author of the parts of the library used.
  20. * This can be in the form of a textual message at program startup or
  21. * in documentation (online or textual) provided with the package.
  22. *
  23. * Redistribution and use in source and binary forms, with or without
  24. * modification, are permitted provided that the following conditions
  25. * are met:
  26. * 1. Redistributions of source code must retain the copyright
  27. * notice, this list of conditions and the following disclaimer.
  28. * 2. Redistributions in binary form must reproduce the above copyright
  29. * notice, this list of conditions and the following disclaimer in the
  30. * documentation and/or other materials provided with the distribution.
  31. * 3. All advertising materials mentioning features or use of this software
  32. * must display the following acknowledgement:
  33. * "This product includes cryptographic software written by
  34. * Eric Young (eay@cryptsoft.com)"
  35. * The word 'cryptographic' can be left out if the rouines from the library
  36. * being used are not cryptographic related :-).
  37. * 4. If you include any Windows specific code (or a derivative thereof) from
  38. * the apps directory (application code) you must include an acknowledgement:
  39. * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40. *
  41. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51. * SUCH DAMAGE.
  52. *
  53. * The licence and distribution terms for any publically available version or
  54. * derivative of this code cannot be changed. i.e. this code cannot simply be
  55. * copied and put under another distribution licence
  56. * [including the GNU Public Licence.]
  57. */
  58. /* ====================================================================
  59. * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
  60. *
  61. * Redistribution and use in source and binary forms, with or without
  62. * modification, are permitted provided that the following conditions
  63. * are met:
  64. *
  65. * 1. Redistributions of source code must retain the above copyright
  66. * notice, this list of conditions and the following disclaimer.
  67. *
  68. * 2. Redistributions in binary form must reproduce the above copyright
  69. * notice, this list of conditions and the following disclaimer in
  70. * the documentation and/or other materials provided with the
  71. * distribution.
  72. *
  73. * 3. All advertising materials mentioning features or use of this
  74. * software must display the following acknowledgment:
  75. * "This product includes software developed by the OpenSSL Project
  76. * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77. *
  78. * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79. * endorse or promote products derived from this software without
  80. * prior written permission. For written permission, please contact
  81. * openssl-core@openssl.org.
  82. *
  83. * 5. Products derived from this software may not be called "OpenSSL"
  84. * nor may "OpenSSL" appear in their names without prior written
  85. * permission of the OpenSSL Project.
  86. *
  87. * 6. Redistributions of any form whatsoever must retain the following
  88. * acknowledgment:
  89. * "This product includes software developed by the OpenSSL Project
  90. * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91. *
  92. * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93. * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  100. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  101. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  102. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  103. * OF THE POSSIBILITY OF SUCH DAMAGE.
  104. * ====================================================================
  105. *
  106. * This product includes cryptographic software written by Eric Young
  107. * (eay@cryptsoft.com). This product includes software written by Tim
  108. * Hudson (tjh@cryptsoft.com).
  109. *
  110. */
  111. #ifndef HEADER_ERR_H
  112. #define HEADER_ERR_H
  113. #include <openssl/e_os2.h>
  114. #ifndef OPENSSL_NO_FP_API
  115. #include <stdio.h>
  116. #include <stdlib.h>
  117. #endif
  118. #include <openssl/ossl_typ.h>
  119. #ifndef OPENSSL_NO_BIO
  120. #include <openssl/bio.h>
  121. #endif
  122. #ifndef OPENSSL_NO_LHASH
  123. #include <openssl/lhash.h>
  124. #endif
  125. #ifdef __cplusplus
  126. extern "C" {
  127. #endif
  128. #ifndef OPENSSL_NO_ERR
  129. #define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,d,e)
  130. #else
  131. #define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,NULL,0)
  132. #endif
  133. #include <errno.h>
  134. #define ERR_TXT_MALLOCED 0x01
  135. #define ERR_TXT_STRING 0x02
  136. #define ERR_FLAG_MARK 0x01
  137. #define ERR_NUM_ERRORS 16
  138. typedef struct err_state_st
  139. {
  140. CRYPTO_THREADID tid;
  141. int err_flags[ERR_NUM_ERRORS];
  142. unsigned long err_buffer[ERR_NUM_ERRORS];
  143. char *err_data[ERR_NUM_ERRORS];
  144. int err_data_flags[ERR_NUM_ERRORS];
  145. const char *err_file[ERR_NUM_ERRORS];
  146. int err_line[ERR_NUM_ERRORS];
  147. int top,bottom;
  148. } ERR_STATE;
  149. /* library */
  150. #define ERR_LIB_NONE 1
  151. #define ERR_LIB_SYS 2
  152. #define ERR_LIB_BN 3
  153. #define ERR_LIB_RSA 4
  154. #define ERR_LIB_DH 5
  155. #define ERR_LIB_EVP 6
  156. #define ERR_LIB_BUF 7
  157. #define ERR_LIB_OBJ 8
  158. #define ERR_LIB_PEM 9
  159. #define ERR_LIB_DSA 10
  160. #define ERR_LIB_X509 11
  161. /* #define ERR_LIB_METH 12 */
  162. #define ERR_LIB_ASN1 13
  163. #define ERR_LIB_CONF 14
  164. #define ERR_LIB_CRYPTO 15
  165. #define ERR_LIB_EC 16
  166. #define ERR_LIB_SSL 20
  167. /* #define ERR_LIB_SSL23 21 */
  168. /* #define ERR_LIB_SSL2 22 */
  169. /* #define ERR_LIB_SSL3 23 */
  170. /* #define ERR_LIB_RSAREF 30 */
  171. /* #define ERR_LIB_PROXY 31 */
  172. #define ERR_LIB_BIO 32
  173. #define ERR_LIB_PKCS7 33
  174. #define ERR_LIB_X509V3 34
  175. #define ERR_LIB_PKCS12 35
  176. #define ERR_LIB_RAND 36
  177. #define ERR_LIB_DSO 37
  178. #define ERR_LIB_ENGINE 38
  179. #define ERR_LIB_OCSP 39
  180. #define ERR_LIB_UI 40
  181. #define ERR_LIB_COMP 41
  182. #define ERR_LIB_ECDSA 42
  183. #define ERR_LIB_ECDH 43
  184. #define ERR_LIB_STORE 44
  185. #define ERR_LIB_FIPS 45
  186. #define ERR_LIB_CMS 46
  187. #define ERR_LIB_TS 47
  188. #define ERR_LIB_HMAC 48
  189. #define ERR_LIB_JPAKE 49
  190. #define ERR_LIB_USER 128
  191. #define SYSerr(f,r) ERR_PUT_error(ERR_LIB_SYS,(f),(r),__FILE__,__LINE__)
  192. #define BNerr(f,r) ERR_PUT_error(ERR_LIB_BN,(f),(r),__FILE__,__LINE__)
  193. #define RSAerr(f,r) ERR_PUT_error(ERR_LIB_RSA,(f),(r),__FILE__,__LINE__)
  194. #define DHerr(f,r) ERR_PUT_error(ERR_LIB_DH,(f),(r),__FILE__,__LINE__)
  195. #define EVPerr(f,r) ERR_PUT_error(ERR_LIB_EVP,(f),(r),__FILE__,__LINE__)
  196. #define BUFerr(f,r) ERR_PUT_error(ERR_LIB_BUF,(f),(r),__FILE__,__LINE__)
  197. #define OBJerr(f,r) ERR_PUT_error(ERR_LIB_OBJ,(f),(r),__FILE__,__LINE__)
  198. #define PEMerr(f,r) ERR_PUT_error(ERR_LIB_PEM,(f),(r),__FILE__,__LINE__)
  199. #define DSAerr(f,r) ERR_PUT_error(ERR_LIB_DSA,(f),(r),__FILE__,__LINE__)
  200. #define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),__FILE__,__LINE__)
  201. #define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),__FILE__,__LINE__)
  202. #define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),__FILE__,__LINE__)
  203. #define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),__FILE__,__LINE__)
  204. #define ECerr(f,r) ERR_PUT_error(ERR_LIB_EC,(f),(r),__FILE__,__LINE__)
  205. #define SSLerr(f,r) ERR_PUT_error(ERR_LIB_SSL,(f),(r),__FILE__,__LINE__)
  206. #define BIOerr(f,r) ERR_PUT_error(ERR_LIB_BIO,(f),(r),__FILE__,__LINE__)
  207. #define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),__FILE__,__LINE__)
  208. #define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),__FILE__,__LINE__)
  209. #define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),__FILE__,__LINE__)
  210. #define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),__FILE__,__LINE__)
  211. #define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),__FILE__,__LINE__)
  212. #define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),__FILE__,__LINE__)
  213. #define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),__FILE__,__LINE__)
  214. #define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),__FILE__,__LINE__)
  215. #define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),__FILE__,__LINE__)
  216. #define ECDSAerr(f,r) ERR_PUT_error(ERR_LIB_ECDSA,(f),(r),__FILE__,__LINE__)
  217. #define ECDHerr(f,r) ERR_PUT_error(ERR_LIB_ECDH,(f),(r),__FILE__,__LINE__)
  218. #define STOREerr(f,r) ERR_PUT_error(ERR_LIB_STORE,(f),(r),__FILE__,__LINE__)
  219. #define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,(f),(r),__FILE__,__LINE__)
  220. #define CMSerr(f,r) ERR_PUT_error(ERR_LIB_CMS,(f),(r),__FILE__,__LINE__)
  221. #define TSerr(f,r) ERR_PUT_error(ERR_LIB_TS,(f),(r),__FILE__,__LINE__)
  222. #define HMACerr(f,r) ERR_PUT_error(ERR_LIB_HMAC,(f),(r),__FILE__,__LINE__)
  223. #define JPAKEerr(f,r) ERR_PUT_error(ERR_LIB_JPAKE,(f),(r),__FILE__,__LINE__)
  224. /* Borland C seems too stupid to be able to shift and do longs in
  225. * the pre-processor :-( */
  226. #define ERR_PACK(l,f,r) (((((unsigned long)l)&0xffL)*0x1000000)| \
  227. ((((unsigned long)f)&0xfffL)*0x1000)| \
  228. ((((unsigned long)r)&0xfffL)))
  229. #define ERR_GET_LIB(l) (int)((((unsigned long)l)>>24L)&0xffL)
  230. #define ERR_GET_FUNC(l) (int)((((unsigned long)l)>>12L)&0xfffL)
  231. #define ERR_GET_REASON(l) (int)((l)&0xfffL)
  232. #define ERR_FATAL_ERROR(l) (int)((l)&ERR_R_FATAL)
  233. /* OS functions */
  234. #define SYS_F_FOPEN 1
  235. #define SYS_F_CONNECT 2
  236. #define SYS_F_GETSERVBYNAME 3
  237. #define SYS_F_SOCKET 4
  238. #define SYS_F_IOCTLSOCKET 5
  239. #define SYS_F_BIND 6
  240. #define SYS_F_LISTEN 7
  241. #define SYS_F_ACCEPT 8
  242. #define SYS_F_WSASTARTUP 9 /* Winsock stuff */
  243. #define SYS_F_OPENDIR 10
  244. #define SYS_F_FREAD 11
  245. /* reasons */
  246. #define ERR_R_SYS_LIB ERR_LIB_SYS /* 2 */
  247. #define ERR_R_BN_LIB ERR_LIB_BN /* 3 */
  248. #define ERR_R_RSA_LIB ERR_LIB_RSA /* 4 */
  249. #define ERR_R_DH_LIB ERR_LIB_DH /* 5 */
  250. #define ERR_R_EVP_LIB ERR_LIB_EVP /* 6 */
  251. #define ERR_R_BUF_LIB ERR_LIB_BUF /* 7 */
  252. #define ERR_R_OBJ_LIB ERR_LIB_OBJ /* 8 */
  253. #define ERR_R_PEM_LIB ERR_LIB_PEM /* 9 */
  254. #define ERR_R_DSA_LIB ERR_LIB_DSA /* 10 */
  255. #define ERR_R_X509_LIB ERR_LIB_X509 /* 11 */
  256. #define ERR_R_ASN1_LIB ERR_LIB_ASN1 /* 13 */
  257. #define ERR_R_CONF_LIB ERR_LIB_CONF /* 14 */
  258. #define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO /* 15 */
  259. #define ERR_R_EC_LIB ERR_LIB_EC /* 16 */
  260. #define ERR_R_SSL_LIB ERR_LIB_SSL /* 20 */
  261. #define ERR_R_BIO_LIB ERR_LIB_BIO /* 32 */
  262. #define ERR_R_PKCS7_LIB ERR_LIB_PKCS7 /* 33 */
  263. #define ERR_R_X509V3_LIB ERR_LIB_X509V3 /* 34 */
  264. #define ERR_R_PKCS12_LIB ERR_LIB_PKCS12 /* 35 */
  265. #define ERR_R_RAND_LIB ERR_LIB_RAND /* 36 */
  266. #define ERR_R_DSO_LIB ERR_LIB_DSO /* 37 */
  267. #define ERR_R_ENGINE_LIB ERR_LIB_ENGINE /* 38 */
  268. #define ERR_R_OCSP_LIB ERR_LIB_OCSP /* 39 */
  269. #define ERR_R_UI_LIB ERR_LIB_UI /* 40 */
  270. #define ERR_R_COMP_LIB ERR_LIB_COMP /* 41 */
  271. #define ERR_R_ECDSA_LIB ERR_LIB_ECDSA /* 42 */
  272. #define ERR_R_ECDH_LIB ERR_LIB_ECDH /* 43 */
  273. #define ERR_R_STORE_LIB ERR_LIB_STORE /* 44 */
  274. #define ERR_R_TS_LIB ERR_LIB_TS /* 45 */
  275. #define ERR_R_NESTED_ASN1_ERROR 58
  276. #define ERR_R_BAD_ASN1_OBJECT_HEADER 59
  277. #define ERR_R_BAD_GET_ASN1_OBJECT_CALL 60
  278. #define ERR_R_EXPECTING_AN_ASN1_SEQUENCE 61
  279. #define ERR_R_ASN1_LENGTH_MISMATCH 62
  280. #define ERR_R_MISSING_ASN1_EOS 63
  281. /* fatal error */
  282. #define ERR_R_FATAL 64
  283. #define ERR_R_MALLOC_FAILURE (1|ERR_R_FATAL)
  284. #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2|ERR_R_FATAL)
  285. #define ERR_R_PASSED_NULL_PARAMETER (3|ERR_R_FATAL)
  286. #define ERR_R_INTERNAL_ERROR (4|ERR_R_FATAL)
  287. #define ERR_R_DISABLED (5|ERR_R_FATAL)
  288. /* 99 is the maximum possible ERR_R_... code, higher values
  289. * are reserved for the individual libraries */
  290. typedef struct ERR_string_data_st
  291. {
  292. unsigned long error;
  293. const char *string;
  294. } ERR_STRING_DATA;
  295. void ERR_put_error(int lib, int func,int reason,const char *file,int line);
  296. void ERR_set_error_data(char *data,int flags);
  297. unsigned long ERR_get_error(void);
  298. unsigned long ERR_get_error_line(const char **file,int *line);
  299. unsigned long ERR_get_error_line_data(const char **file,int *line,
  300. const char **data, int *flags);
  301. unsigned long ERR_peek_error(void);
  302. unsigned long ERR_peek_error_line(const char **file,int *line);
  303. unsigned long ERR_peek_error_line_data(const char **file,int *line,
  304. const char **data,int *flags);
  305. unsigned long ERR_peek_last_error(void);
  306. unsigned long ERR_peek_last_error_line(const char **file,int *line);
  307. unsigned long ERR_peek_last_error_line_data(const char **file,int *line,
  308. const char **data,int *flags);
  309. void ERR_clear_error(void );
  310. char *ERR_error_string(unsigned long e,char *buf);
  311. void ERR_error_string_n(unsigned long e, char *buf, size_t len);
  312. const char *ERR_lib_error_string(unsigned long e);
  313. const char *ERR_func_error_string(unsigned long e);
  314. const char *ERR_reason_error_string(unsigned long e);
  315. void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u),
  316. void *u);
  317. #ifndef OPENSSL_NO_FP_API
  318. void ERR_print_errors_fp(FILE *fp);
  319. #endif
  320. #ifndef OPENSSL_NO_BIO
  321. void ERR_print_errors(BIO *bp);
  322. #endif
  323. void ERR_add_error_data(int num, ...);
  324. void ERR_add_error_vdata(int num, va_list args);
  325. void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
  326. void ERR_unload_strings(int lib,ERR_STRING_DATA str[]);
  327. void ERR_load_ERR_strings(void);
  328. void ERR_load_crypto_strings(void);
  329. void ERR_free_strings(void);
  330. void ERR_remove_thread_state(const CRYPTO_THREADID *tid);
  331. #ifndef OPENSSL_NO_DEPRECATED
  332. void ERR_remove_state(unsigned long pid); /* if zero we look it up */
  333. #endif
  334. ERR_STATE *ERR_get_state(void);
  335. #ifndef OPENSSL_NO_LHASH
  336. LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void);
  337. LHASH_OF(ERR_STATE) *ERR_get_err_state_table(void);
  338. void ERR_release_err_state_table(LHASH_OF(ERR_STATE) **hash);
  339. #endif
  340. int ERR_get_next_error_library(void);
  341. int ERR_set_mark(void);
  342. int ERR_pop_to_mark(void);
  343. /* Already defined in ossl_typ.h */
  344. /* typedef struct st_ERR_FNS ERR_FNS; */
  345. /* An application can use this function and provide the return value to loaded
  346. * modules that should use the application's ERR state/functionality */
  347. const ERR_FNS *ERR_get_implementation(void);
  348. /* A loaded module should call this function prior to any ERR operations using
  349. * the application's "ERR_FNS". */
  350. int ERR_set_implementation(const ERR_FNS *fns);
  351. #ifdef __cplusplus
  352. }
  353. #endif
  354. #endif