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