Transfer error redirection to fips.h, add OPENSSL_FIPSAPI to source files
[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  * 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
112 #ifndef HEADER_ERR_H
113 #define HEADER_ERR_H
114
115 #include <openssl/e_os2.h>
116
117 #ifndef OPENSSL_NO_FP_API
118 #include <stdio.h>
119 #include <stdlib.h>
120 #endif
121
122 #include <openssl/ossl_typ.h>
123 #ifndef OPENSSL_NO_BIO
124 #include <openssl/bio.h>
125 #endif
126 #ifndef OPENSSL_NO_LHASH
127 #include <openssl/lhash.h>
128 #endif
129
130 #ifdef  __cplusplus
131 extern "C" {
132 #endif
133
134 #ifndef OPENSSL_NO_ERR
135 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,d,e)
136 #else
137 #define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,NULL,0)
138 #endif
139
140 #ifdef OPENSSL_FIPS
141 void FIPS_set_error_callbacks(
142         void (*put_cb)(int lib, int func,int reason,const char *file,int line),
143         void (*add_cb)(int num, va_list args) );
144 #endif
145
146 #include <errno.h>
147
148 #define ERR_TXT_MALLOCED        0x01
149 #define ERR_TXT_STRING          0x02
150
151 #define ERR_FLAG_MARK           0x01
152
153 #define ERR_NUM_ERRORS  16
154 typedef struct err_state_st
155         {
156         CRYPTO_THREADID tid;
157         int err_flags[ERR_NUM_ERRORS];
158         unsigned long err_buffer[ERR_NUM_ERRORS];
159         char *err_data[ERR_NUM_ERRORS];
160         int err_data_flags[ERR_NUM_ERRORS];
161         const char *err_file[ERR_NUM_ERRORS];
162         int err_line[ERR_NUM_ERRORS];
163         int top,bottom;
164         } ERR_STATE;
165
166 /* library */
167 #define ERR_LIB_NONE            1
168 #define ERR_LIB_SYS             2
169 #define ERR_LIB_BN              3
170 #define ERR_LIB_RSA             4
171 #define ERR_LIB_DH              5
172 #define ERR_LIB_EVP             6
173 #define ERR_LIB_BUF             7
174 #define ERR_LIB_OBJ             8
175 #define ERR_LIB_PEM             9
176 #define ERR_LIB_DSA             10
177 #define ERR_LIB_X509            11
178 /* #define ERR_LIB_METH         12 */
179 #define ERR_LIB_ASN1            13
180 #define ERR_LIB_CONF            14
181 #define ERR_LIB_CRYPTO          15
182 #define ERR_LIB_EC              16
183 #define ERR_LIB_SSL             20
184 /* #define ERR_LIB_SSL23        21 */
185 /* #define ERR_LIB_SSL2         22 */
186 /* #define ERR_LIB_SSL3         23 */
187 /* #define ERR_LIB_RSAREF       30 */
188 /* #define ERR_LIB_PROXY        31 */
189 #define ERR_LIB_BIO             32
190 #define ERR_LIB_PKCS7           33
191 #define ERR_LIB_X509V3          34
192 #define ERR_LIB_PKCS12          35
193 #define ERR_LIB_RAND            36
194 #define ERR_LIB_DSO             37
195 #define ERR_LIB_ENGINE          38
196 #define ERR_LIB_OCSP            39
197 #define ERR_LIB_UI              40
198 #define ERR_LIB_COMP            41
199 #define ERR_LIB_ECDSA           42
200 #define ERR_LIB_ECDH            43
201 #define ERR_LIB_STORE           44
202 #define ERR_LIB_FIPS            45
203 #define ERR_LIB_CMS             46
204 #define ERR_LIB_TS              47
205 #define ERR_LIB_HMAC            48
206 #define ERR_LIB_JPAKE           49
207
208 #define ERR_LIB_USER            128
209
210 #define SYSerr(f,r)  ERR_PUT_error(ERR_LIB_SYS,(f),(r),__FILE__,__LINE__)
211 #define BNerr(f,r)   ERR_PUT_error(ERR_LIB_BN,(f),(r),__FILE__,__LINE__)
212 #define RSAerr(f,r)  ERR_PUT_error(ERR_LIB_RSA,(f),(r),__FILE__,__LINE__)
213 #define DHerr(f,r)   ERR_PUT_error(ERR_LIB_DH,(f),(r),__FILE__,__LINE__)
214 #define EVPerr(f,r)  ERR_PUT_error(ERR_LIB_EVP,(f),(r),__FILE__,__LINE__)
215 #define BUFerr(f,r)  ERR_PUT_error(ERR_LIB_BUF,(f),(r),__FILE__,__LINE__)
216 #define OBJerr(f,r)  ERR_PUT_error(ERR_LIB_OBJ,(f),(r),__FILE__,__LINE__)
217 #define PEMerr(f,r)  ERR_PUT_error(ERR_LIB_PEM,(f),(r),__FILE__,__LINE__)
218 #define DSAerr(f,r)  ERR_PUT_error(ERR_LIB_DSA,(f),(r),__FILE__,__LINE__)
219 #define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),__FILE__,__LINE__)
220 #define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),__FILE__,__LINE__)
221 #define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),__FILE__,__LINE__)
222 #define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),__FILE__,__LINE__)
223 #define ECerr(f,r)   ERR_PUT_error(ERR_LIB_EC,(f),(r),__FILE__,__LINE__)
224 #define SSLerr(f,r)  ERR_PUT_error(ERR_LIB_SSL,(f),(r),__FILE__,__LINE__)
225 #define BIOerr(f,r)  ERR_PUT_error(ERR_LIB_BIO,(f),(r),__FILE__,__LINE__)
226 #define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),__FILE__,__LINE__)
227 #define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),__FILE__,__LINE__)
228 #define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),__FILE__,__LINE__)
229 #define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),__FILE__,__LINE__)
230 #define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),__FILE__,__LINE__)
231 #define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),__FILE__,__LINE__)
232 #define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),__FILE__,__LINE__)
233 #define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),__FILE__,__LINE__)
234 #define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),__FILE__,__LINE__)
235 #define ECDSAerr(f,r)  ERR_PUT_error(ERR_LIB_ECDSA,(f),(r),__FILE__,__LINE__)
236 #define ECDHerr(f,r)  ERR_PUT_error(ERR_LIB_ECDH,(f),(r),__FILE__,__LINE__)
237 #define STOREerr(f,r) ERR_PUT_error(ERR_LIB_STORE,(f),(r),__FILE__,__LINE__)
238 #define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,(f),(r),__FILE__,__LINE__)
239 #define CMSerr(f,r) ERR_PUT_error(ERR_LIB_CMS,(f),(r),__FILE__,__LINE__)
240 #define TSerr(f,r) ERR_PUT_error(ERR_LIB_TS,(f),(r),__FILE__,__LINE__)
241 #define HMACerr(f,r) ERR_PUT_error(ERR_LIB_HMAC,(f),(r),__FILE__,__LINE__)
242 #define JPAKEerr(f,r) ERR_PUT_error(ERR_LIB_JPAKE,(f),(r),__FILE__,__LINE__)
243
244 /* Borland C seems too stupid to be able to shift and do longs in
245  * the pre-processor :-( */
246 #define ERR_PACK(l,f,r)         (((((unsigned long)l)&0xffL)*0x1000000)| \
247                                 ((((unsigned long)f)&0xfffL)*0x1000)| \
248                                 ((((unsigned long)r)&0xfffL)))
249 #define ERR_GET_LIB(l)          (int)((((unsigned long)l)>>24L)&0xffL)
250 #define ERR_GET_FUNC(l)         (int)((((unsigned long)l)>>12L)&0xfffL)
251 #define ERR_GET_REASON(l)       (int)((l)&0xfffL)
252 #define ERR_FATAL_ERROR(l)      (int)((l)&ERR_R_FATAL)
253
254
255 /* OS functions */
256 #define SYS_F_FOPEN             1
257 #define SYS_F_CONNECT           2
258 #define SYS_F_GETSERVBYNAME     3
259 #define SYS_F_SOCKET            4
260 #define SYS_F_IOCTLSOCKET       5
261 #define SYS_F_BIND              6
262 #define SYS_F_LISTEN            7
263 #define SYS_F_ACCEPT            8
264 #define SYS_F_WSASTARTUP        9 /* Winsock stuff */
265 #define SYS_F_OPENDIR           10
266 #define SYS_F_FREAD             11
267
268
269 /* reasons */
270 #define ERR_R_SYS_LIB   ERR_LIB_SYS       /* 2 */
271 #define ERR_R_BN_LIB    ERR_LIB_BN        /* 3 */
272 #define ERR_R_RSA_LIB   ERR_LIB_RSA       /* 4 */
273 #define ERR_R_DH_LIB    ERR_LIB_DH        /* 5 */
274 #define ERR_R_EVP_LIB   ERR_LIB_EVP       /* 6 */
275 #define ERR_R_BUF_LIB   ERR_LIB_BUF       /* 7 */
276 #define ERR_R_OBJ_LIB   ERR_LIB_OBJ       /* 8 */
277 #define ERR_R_PEM_LIB   ERR_LIB_PEM       /* 9 */
278 #define ERR_R_DSA_LIB   ERR_LIB_DSA      /* 10 */
279 #define ERR_R_X509_LIB  ERR_LIB_X509     /* 11 */
280 #define ERR_R_ASN1_LIB  ERR_LIB_ASN1     /* 13 */
281 #define ERR_R_CONF_LIB  ERR_LIB_CONF     /* 14 */
282 #define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO  /* 15 */
283 #define ERR_R_EC_LIB    ERR_LIB_EC       /* 16 */
284 #define ERR_R_SSL_LIB   ERR_LIB_SSL      /* 20 */
285 #define ERR_R_BIO_LIB   ERR_LIB_BIO      /* 32 */
286 #define ERR_R_PKCS7_LIB ERR_LIB_PKCS7    /* 33 */
287 #define ERR_R_X509V3_LIB ERR_LIB_X509V3  /* 34 */
288 #define ERR_R_PKCS12_LIB ERR_LIB_PKCS12  /* 35 */
289 #define ERR_R_RAND_LIB  ERR_LIB_RAND     /* 36 */
290 #define ERR_R_DSO_LIB   ERR_LIB_DSO      /* 37 */
291 #define ERR_R_ENGINE_LIB ERR_LIB_ENGINE  /* 38 */
292 #define ERR_R_OCSP_LIB  ERR_LIB_OCSP     /* 39 */
293 #define ERR_R_UI_LIB    ERR_LIB_UI       /* 40 */
294 #define ERR_R_COMP_LIB  ERR_LIB_COMP     /* 41 */
295 #define ERR_R_ECDSA_LIB ERR_LIB_ECDSA    /* 42 */
296 #define ERR_R_ECDH_LIB  ERR_LIB_ECDH     /* 43 */
297 #define ERR_R_STORE_LIB ERR_LIB_STORE    /* 44 */
298 #define ERR_R_TS_LIB    ERR_LIB_TS       /* 45 */
299
300 #define ERR_R_NESTED_ASN1_ERROR                 58
301 #define ERR_R_BAD_ASN1_OBJECT_HEADER            59
302 #define ERR_R_BAD_GET_ASN1_OBJECT_CALL          60
303 #define ERR_R_EXPECTING_AN_ASN1_SEQUENCE        61
304 #define ERR_R_ASN1_LENGTH_MISMATCH              62
305 #define ERR_R_MISSING_ASN1_EOS                  63
306
307 /* fatal error */
308 #define ERR_R_FATAL                             64
309 #define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
310 #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
311 #define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
312 #define ERR_R_INTERNAL_ERROR                    (4|ERR_R_FATAL)
313 #define ERR_R_DISABLED                          (5|ERR_R_FATAL)
314
315 /* 99 is the maximum possible ERR_R_... code, higher values
316  * are reserved for the individual libraries */
317
318
319 typedef struct ERR_string_data_st
320         {
321         unsigned long error;
322         const char *string;
323         } ERR_STRING_DATA;
324
325 void ERR_put_error(int lib, int func,int reason,const char *file,int line);
326 void ERR_set_error_data(char *data,int flags);
327
328 unsigned long ERR_get_error(void);
329 unsigned long ERR_get_error_line(const char **file,int *line);
330 unsigned long ERR_get_error_line_data(const char **file,int *line,
331                                       const char **data, int *flags);
332 unsigned long ERR_peek_error(void);
333 unsigned long ERR_peek_error_line(const char **file,int *line);
334 unsigned long ERR_peek_error_line_data(const char **file,int *line,
335                                        const char **data,int *flags);
336 unsigned long ERR_peek_last_error(void);
337 unsigned long ERR_peek_last_error_line(const char **file,int *line);
338 unsigned long ERR_peek_last_error_line_data(const char **file,int *line,
339                                        const char **data,int *flags);
340 void ERR_clear_error(void );
341 char *ERR_error_string(unsigned long e,char *buf);
342 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
343 const char *ERR_lib_error_string(unsigned long e);
344 const char *ERR_func_error_string(unsigned long e);
345 const char *ERR_reason_error_string(unsigned long e);
346 void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u),
347                          void *u);
348 #ifndef OPENSSL_NO_FP_API
349 void ERR_print_errors_fp(FILE *fp);
350 #endif
351 #ifndef OPENSSL_NO_BIO
352 void ERR_print_errors(BIO *bp);
353 #endif
354 void ERR_add_error_data(int num, ...);
355 void ERR_add_error_vdata(int num, va_list args);
356 void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
357 void ERR_unload_strings(int lib,ERR_STRING_DATA str[]);
358 void ERR_load_ERR_strings(void);
359 void ERR_load_crypto_strings(void);
360 void ERR_free_strings(void);
361
362 void ERR_remove_thread_state(const CRYPTO_THREADID *tid);
363 #ifndef OPENSSL_NO_DEPRECATED
364 void ERR_remove_state(unsigned long pid); /* if zero we look it up */
365 #endif
366 ERR_STATE *ERR_get_state(void);
367
368 #ifndef OPENSSL_NO_LHASH
369 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void);
370 LHASH_OF(ERR_STATE) *ERR_get_err_state_table(void);
371 void ERR_release_err_state_table(LHASH_OF(ERR_STATE) **hash);
372 #endif
373
374 int ERR_get_next_error_library(void);
375
376 int ERR_set_mark(void);
377 int ERR_pop_to_mark(void);
378
379 /* Already defined in ossl_typ.h */
380 /* typedef struct st_ERR_FNS ERR_FNS; */
381 /* An application can use this function and provide the return value to loaded
382  * modules that should use the application's ERR state/functionality */
383 const ERR_FNS *ERR_get_implementation(void);
384 /* A loaded module should call this function prior to any ERR operations using
385  * the application's "ERR_FNS". */
386 int ERR_set_implementation(const ERR_FNS *fns);
387
388 #ifdef  __cplusplus
389 }
390 #endif
391
392 #endif