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