15bafbff43788bf057a4782c12b6e98644656d54
[openssl.git] / crypto / err / err.h
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 #ifndef HEADER_ERR_H
60 #define HEADER_ERR_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 #ifndef NO_FP_API
67 #include <stdio.h>
68 #endif
69
70 /* The following is a bit of a trick to help the object files only contain
71  * the 'name of the file' string once.  Since 'err.h' is protected by the
72  * HEADER_ERR_H stuff, this should be included only once per file. */
73
74 #define ERR_file_name   __FILE__
75
76 #ifndef NO_ERR
77 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,d,e)
78 #else
79 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,NULL,0)
80 #endif
81
82 #include <errno.h>
83
84 #define ERR_TXT_MALLOCED        0x01
85 #define ERR_TXT_STRING          0x02
86
87 #define ERR_NUM_ERRORS  16
88 typedef struct err_state_st
89         {
90         unsigned long pid;
91         unsigned long err_buffer[ERR_NUM_ERRORS];
92         char *err_data[ERR_NUM_ERRORS];
93         int err_data_flags[ERR_NUM_ERRORS];
94         const char *err_file[ERR_NUM_ERRORS];
95         int err_line[ERR_NUM_ERRORS];
96         int top,bottom;
97         } ERR_STATE;
98
99 /* library */
100 #define ERR_LIB_NONE            1
101 #define ERR_LIB_SYS             2
102 #define ERR_LIB_BN              3
103 #define ERR_LIB_RSA             4
104 #define ERR_LIB_DH              5
105 #define ERR_LIB_EVP             6
106 #define ERR_LIB_BUF             7
107 #define ERR_LIB_OBJ             8
108 #define ERR_LIB_PEM             9
109 #define ERR_LIB_DSA             10
110 #define ERR_LIB_X509            11
111 #define ERR_LIB_METH            12
112 #define ERR_LIB_ASN1            13
113 #define ERR_LIB_CONF            14
114 #define ERR_LIB_CRYPTO          15
115 #define ERR_LIB_SSL             20
116 #define ERR_LIB_SSL23           21
117 #define ERR_LIB_SSL2            22
118 #define ERR_LIB_SSL3            23
119 #define ERR_LIB_RSAREF          30
120 #define ERR_LIB_PROXY           31
121 #define ERR_LIB_BIO             32
122 #define ERR_LIB_PKCS7           33
123 #define ERR_LIB_X509V3          34
124 #define ERR_LIB_PKCS12          35
125 #define ERR_LIB_RAND            36
126
127 #define ERR_LIB_USER            128
128
129 #define SYSerr(f,r)  ERR_PUT_error(ERR_LIB_SYS,(f),(r),ERR_file_name,__LINE__)
130 #define BNerr(f,r)   ERR_PUT_error(ERR_LIB_BN,(f),(r),ERR_file_name,__LINE__)
131 #define RSAerr(f,r)  ERR_PUT_error(ERR_LIB_RSA,(f),(r),ERR_file_name,__LINE__)
132 #define DHerr(f,r)   ERR_PUT_error(ERR_LIB_DH,(f),(r),ERR_file_name,__LINE__)
133 #define EVPerr(f,r)  ERR_PUT_error(ERR_LIB_EVP,(f),(r),ERR_file_name,__LINE__)
134 #define BUFerr(f,r)  ERR_PUT_error(ERR_LIB_BUF,(f),(r),ERR_file_name,__LINE__)
135 #define BIOerr(f,r)  ERR_PUT_error(ERR_LIB_BIO,(f),(r),ERR_file_name,__LINE__)
136 #define OBJerr(f,r)  ERR_PUT_error(ERR_LIB_OBJ,(f),(r),ERR_file_name,__LINE__)
137 #define PEMerr(f,r)  ERR_PUT_error(ERR_LIB_PEM,(f),(r),ERR_file_name,__LINE__)
138 #define DSAerr(f,r)  ERR_PUT_error(ERR_LIB_DSA,(f),(r),ERR_file_name,__LINE__)
139 #define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),ERR_file_name,__LINE__)
140 #define METHerr(f,r) ERR_PUT_error(ERR_LIB_METH,(f),(r),ERR_file_name,__LINE__)
141 #define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),ERR_file_name,__LINE__)
142 #define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),ERR_file_name,__LINE__)
143 #define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),ERR_file_name,__LINE__)
144 #define SSLerr(f,r)  ERR_PUT_error(ERR_LIB_SSL,(f),(r),ERR_file_name,__LINE__)
145 #define SSL23err(f,r) ERR_PUT_error(ERR_LIB_SSL23,(f),(r),ERR_file_name,__LINE__)
146 #define SSL2err(f,r) ERR_PUT_error(ERR_LIB_SSL2,(f),(r),ERR_file_name,__LINE__)
147 #define SSL3err(f,r) ERR_PUT_error(ERR_LIB_SSL3,(f),(r),ERR_file_name,__LINE__)
148 #define RSAREFerr(f,r) ERR_PUT_error(ERR_LIB_RSAREF,(f),(r),ERR_file_name,__LINE__)
149 #define PROXYerr(f,r) ERR_PUT_error(ERR_LIB_PROXY,(f),(r),ERR_file_name,__LINE__)
150 #define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),ERR_file_name,__LINE__)
151 #define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),ERR_file_name,__LINE__)
152 #define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),ERR_file_name,__LINE__)
153 #define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),ERR_file_name,__LINE__)
154
155 /* Borland C seems too stupid to be able to shift and do longs in
156  * the pre-processor :-( */
157 #define ERR_PACK(l,f,r)         (((((unsigned long)l)&0xffL)*0x1000000)| \
158                                 ((((unsigned long)f)&0xfffL)*0x1000)| \
159                                 ((((unsigned long)r)&0xfffL)))
160 #define ERR_GET_LIB(l)          (int)((((unsigned long)l)>>24L)&0xffL)
161 #define ERR_GET_FUNC(l)         (int)((((unsigned long)l)>>12L)&0xfffL)
162 #define ERR_GET_REASON(l)       (int)((l)&0xfffL)
163 #define ERR_FATAL_ERROR(l)      (int)((l)&ERR_R_FATAL)
164
165 /* OS functions */
166 #define SYS_F_FOPEN             1
167 #define SYS_F_CONNECT           2
168 #define SYS_F_GETSERVBYNAME     3
169 #define SYS_F_SOCKET            4
170 #define SYS_F_IOCTLSOCKET       5
171 #define SYS_F_BIND              6
172 #define SYS_F_LISTEN            7
173 #define SYS_F_ACCEPT            8
174 #define SYS_F_WSASTARTUP        9 /* Winsock stuff */
175 #define SYS_F_OPENDIR           10
176
177 #define ERR_R_FATAL             32      
178 /* reasons */
179 #define ERR_R_SYS_LIB   ERR_LIB_SYS
180 #define ERR_R_BN_LIB    ERR_LIB_BN
181 #define ERR_R_RSA_LIB   ERR_LIB_RSA
182 #define ERR_R_DSA_LIB   ERR_LIB_DSA
183 #define ERR_R_DH_LIB    ERR_LIB_DH
184 #define ERR_R_EVP_LIB   ERR_LIB_EVP
185 #define ERR_R_BUF_LIB   ERR_LIB_BUF
186 #define ERR_R_BIO_LIB   ERR_LIB_BIO
187 #define ERR_R_OBJ_LIB   ERR_LIB_OBJ
188 #define ERR_R_PEM_LIB   ERR_LIB_PEM
189 #define ERR_R_X509_LIB  ERR_LIB_X509
190 #define ERR_R_METH_LIB  ERR_LIB_METH
191 #define ERR_R_ASN1_LIB  ERR_LIB_ASN1
192 #define ERR_R_CONF_LIB  ERR_LIB_CONF
193 #define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO
194 #define ERR_R_SSL_LIB   ERR_LIB_SSL
195 #define ERR_R_SSL23_LIB ERR_LIB_SSL23
196 #define ERR_R_SSL2_LIB  ERR_LIB_SSL2
197 #define ERR_R_SSL3_LIB  ERR_LIB_SSL3
198 #define ERR_R_PROXY_LIB ERR_LIB_PROXY
199 #define ERR_R_BIO_LIB   ERR_LIB_BIO
200 #define ERR_R_PKCS7_LIB ERR_LIB_PKCS7
201 #define ERR_R_PKCS12_LIB ERR_LIB_PKCS12
202
203 /* fatal error */
204 #define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
205 #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
206 #define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
207 #define ERR_R_NESTED_ASN1_ERROR                 (4)
208 #define ERR_R_BAD_ASN1_OBJECT_HEADER            (5)
209 #define ERR_R_BAD_GET_ASN1_OBJECT_CALL          (6)
210 #define ERR_R_EXPECTING_AN_ASN1_SEQUENCE        (7)
211 #define ERR_R_ASN1_LENGTH_MISMATCH              (8)
212 #define ERR_R_MISSING_ASN1_EOS                  (9)
213
214 typedef struct ERR_string_data_st
215         {
216         unsigned long error;
217         const char *string;
218         } ERR_STRING_DATA;
219
220 void ERR_put_error(int lib, int func,int reason,const char *file,int line);
221 void ERR_set_error_data(char *data,int flags);
222
223 unsigned long ERR_get_error(void );
224 unsigned long ERR_get_error_line(const char **file,int *line);
225 unsigned long ERR_get_error_line_data(const char **file,int *line,
226                                       const char **data, int *flags);
227 unsigned long ERR_peek_error(void );
228 unsigned long ERR_peek_error_line(const char **file,int *line);
229 unsigned long ERR_peek_error_line_data(const char **file,int *line,
230                                        const char **data,int *flags);
231 void ERR_clear_error(void );
232 char *ERR_error_string(unsigned long e,char *buf);
233 const char *ERR_lib_error_string(unsigned long e);
234 const char *ERR_func_error_string(unsigned long e);
235 const char *ERR_reason_error_string(unsigned long e);
236 #ifndef NO_FP_API
237 void ERR_print_errors_fp(FILE *fp);
238 #endif
239 #ifdef HEADER_BIO_H
240 void ERR_print_errors(BIO *bp);
241 void ERR_add_error_data(int num, ...);
242 #endif
243 void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
244 void ERR_load_ERR_strings(void);
245 void ERR_load_crypto_strings(void);
246 void ERR_free_strings(void);
247
248 void ERR_remove_state(unsigned long pid); /* if zero we look it up */
249 ERR_STATE *ERR_get_state(void);
250
251 #ifdef HEADER_LHASH_H
252 LHASH *ERR_get_string_table(void );
253 LHASH *ERR_get_err_state_table(void );
254 #else
255 char *ERR_get_string_table(void );
256 char *ERR_get_err_state_table(void );
257 #endif
258
259 int ERR_get_next_error_library(void );
260
261 #ifdef  __cplusplus
262 }
263 #endif
264
265 #endif