]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/err/err.h
Make sure we get the definition of OPENSSL_NO_IDEA and IDEA_INT.
[thirdparty/openssl.git] / crypto / err / err.h
CommitLineData
d02b48c6 1/* crypto/err/err.h */
58964a49 2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6
RE
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
cf1b7d96 62#ifndef OPENSSL_NO_FP_API
0b86eb3e 63#include <stdio.h>
823d8a6e 64#include <stdlib.h>
0b86eb3e
BM
65#endif
66
cf1b7d96 67#ifndef OPENSSL_NO_BIO
ef33b970
RL
68#include <openssl/bio.h>
69#endif
cf1b7d96 70#ifndef OPENSSL_NO_LHASH
ef33b970
RL
71#include <openssl/lhash.h>
72#endif
73
82271cee
RL
74#ifdef __cplusplus
75extern "C" {
76#endif
77
cf1b7d96 78#ifndef OPENSSL_NO_ERR
d02b48c6
RE
79#define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,d,e)
80#else
81#define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,NULL,0)
82#endif
83
84#include <errno.h>
85
58964a49
RE
86#define ERR_TXT_MALLOCED 0x01
87#define ERR_TXT_STRING 0x02
88
89#define ERR_NUM_ERRORS 16
d02b48c6
RE
90typedef struct err_state_st
91 {
92 unsigned long pid;
93 unsigned long err_buffer[ERR_NUM_ERRORS];
58964a49
RE
94 char *err_data[ERR_NUM_ERRORS];
95 int err_data_flags[ERR_NUM_ERRORS];
e778802f 96 const char *err_file[ERR_NUM_ERRORS];
d02b48c6
RE
97 int err_line[ERR_NUM_ERRORS];
98 int top,bottom;
99 } ERR_STATE;
100
101/* library */
102#define ERR_LIB_NONE 1
103#define ERR_LIB_SYS 2
104#define ERR_LIB_BN 3
105#define ERR_LIB_RSA 4
106#define ERR_LIB_DH 5
107#define ERR_LIB_EVP 6
108#define ERR_LIB_BUF 7
109#define ERR_LIB_OBJ 8
110#define ERR_LIB_PEM 9
111#define ERR_LIB_DSA 10
112#define ERR_LIB_X509 11
5277d7cb 113/* #define ERR_LIB_METH 12 */
d02b48c6
RE
114#define ERR_LIB_ASN1 13
115#define ERR_LIB_CONF 14
58964a49 116#define ERR_LIB_CRYPTO 15
5277d7cb 117#define ERR_LIB_EC 16
d02b48c6 118#define ERR_LIB_SSL 20
5277d7cb
BM
119/* #define ERR_LIB_SSL23 21 */
120/* #define ERR_LIB_SSL2 22 */
121/* #define ERR_LIB_SSL3 23 */
122/* #define ERR_LIB_RSAREF 30 */
123/* #define ERR_LIB_PROXY 31 */
d02b48c6
RE
124#define ERR_LIB_BIO 32
125#define ERR_LIB_PKCS7 33
834eeef9 126#define ERR_LIB_X509V3 34
8d8c7266 127#define ERR_LIB_PKCS12 35
eb952088 128#define ERR_LIB_RAND 36
9ec0126e 129#define ERR_LIB_DSO 37
5270e702 130#define ERR_LIB_ENGINE 38
eb64730b 131#define ERR_LIB_OCSP 39
a63d5eaa 132#define ERR_LIB_UI 40
68809d39 133#define ERR_LIB_COMP 41
4d94ae00 134#define ERR_LIB_ECDSA 42
e172d60d 135#define ERR_LIB_ECDH 43
d02b48c6
RE
136
137#define ERR_LIB_USER 128
138
4de633dd
BM
139#define SYSerr(f,r) ERR_PUT_error(ERR_LIB_SYS,(f),(r),__FILE__,__LINE__)
140#define BNerr(f,r) ERR_PUT_error(ERR_LIB_BN,(f),(r),__FILE__,__LINE__)
141#define RSAerr(f,r) ERR_PUT_error(ERR_LIB_RSA,(f),(r),__FILE__,__LINE__)
142#define DHerr(f,r) ERR_PUT_error(ERR_LIB_DH,(f),(r),__FILE__,__LINE__)
143#define EVPerr(f,r) ERR_PUT_error(ERR_LIB_EVP,(f),(r),__FILE__,__LINE__)
144#define BUFerr(f,r) ERR_PUT_error(ERR_LIB_BUF,(f),(r),__FILE__,__LINE__)
145#define OBJerr(f,r) ERR_PUT_error(ERR_LIB_OBJ,(f),(r),__FILE__,__LINE__)
146#define PEMerr(f,r) ERR_PUT_error(ERR_LIB_PEM,(f),(r),__FILE__,__LINE__)
147#define DSAerr(f,r) ERR_PUT_error(ERR_LIB_DSA,(f),(r),__FILE__,__LINE__)
148#define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),__FILE__,__LINE__)
149#define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),__FILE__,__LINE__)
150#define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),__FILE__,__LINE__)
151#define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),__FILE__,__LINE__)
152#define ECerr(f,r) ERR_PUT_error(ERR_LIB_EC,(f),(r),__FILE__,__LINE__)
153#define SSLerr(f,r) ERR_PUT_error(ERR_LIB_SSL,(f),(r),__FILE__,__LINE__)
154#define BIOerr(f,r) ERR_PUT_error(ERR_LIB_BIO,(f),(r),__FILE__,__LINE__)
155#define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),__FILE__,__LINE__)
156#define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),__FILE__,__LINE__)
157#define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),__FILE__,__LINE__)
158#define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),__FILE__,__LINE__)
159#define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),__FILE__,__LINE__)
160#define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),__FILE__,__LINE__)
161#define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),__FILE__,__LINE__)
a63d5eaa 162#define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),__FILE__,__LINE__)
af9675e7 163#define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),__FILE__,__LINE__)
4d94ae00 164#define ECDSAerr(f,r) ERR_PUT_error(ERR_LIB_ECDSA,(f),(r),__FILE__,__LINE__)
e172d60d 165#define ECDHerr(f,r) ERR_PUT_error(ERR_LIB_ECDH,(f),(r),__FILE__,__LINE__)
d02b48c6
RE
166
167/* Borland C seems too stupid to be able to shift and do longs in
168 * the pre-processor :-( */
169#define ERR_PACK(l,f,r) (((((unsigned long)l)&0xffL)*0x1000000)| \
170 ((((unsigned long)f)&0xfffL)*0x1000)| \
171 ((((unsigned long)r)&0xfffL)))
172#define ERR_GET_LIB(l) (int)((((unsigned long)l)>>24L)&0xffL)
173#define ERR_GET_FUNC(l) (int)((((unsigned long)l)>>12L)&0xfffL)
174#define ERR_GET_REASON(l) (int)((l)&0xfffL)
175#define ERR_FATAL_ERROR(l) (int)((l)&ERR_R_FATAL)
176
5277d7cb 177
657e60fa 178/* OS functions */
d02b48c6
RE
179#define SYS_F_FOPEN 1
180#define SYS_F_CONNECT 2
181#define SYS_F_GETSERVBYNAME 3
182#define SYS_F_SOCKET 4
183#define SYS_F_IOCTLSOCKET 5
184#define SYS_F_BIND 6
185#define SYS_F_LISTEN 7
186#define SYS_F_ACCEPT 8
187#define SYS_F_WSASTARTUP 9 /* Winsock stuff */
a40f6dce 188#define SYS_F_OPENDIR 10
d15711ef 189#define SYS_F_FREAD 11
d02b48c6 190
5277d7cb 191
d02b48c6 192/* reasons */
5277d7cb
BM
193#define ERR_R_SYS_LIB ERR_LIB_SYS /* 2 */
194#define ERR_R_BN_LIB ERR_LIB_BN /* 3 */
195#define ERR_R_RSA_LIB ERR_LIB_RSA /* 4 */
196#define ERR_R_DH_LIB ERR_LIB_DH /* 5 */
197#define ERR_R_EVP_LIB ERR_LIB_EVP /* 6 */
198#define ERR_R_BUF_LIB ERR_LIB_BUF /* 7 */
199#define ERR_R_OBJ_LIB ERR_LIB_OBJ /* 8 */
200#define ERR_R_PEM_LIB ERR_LIB_PEM /* 9 */
201#define ERR_R_DSA_LIB ERR_LIB_DSA /* 10 */
202#define ERR_R_X509_LIB ERR_LIB_X509 /* 11 */
203#define ERR_R_ASN1_LIB ERR_LIB_ASN1 /* 13 */
204#define ERR_R_CONF_LIB ERR_LIB_CONF /* 14 */
205#define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO /* 15 */
206#define ERR_R_EC_LIB ERR_LIB_EC /* 16 */
207#define ERR_R_SSL_LIB ERR_LIB_SSL /* 20 */
208#define ERR_R_BIO_LIB ERR_LIB_BIO /* 32 */
209#define ERR_R_PKCS7_LIB ERR_LIB_PKCS7 /* 33 */
210#define ERR_R_X509V3_LIB ERR_LIB_X509V3 /* 34 */
211#define ERR_R_PKCS12_LIB ERR_LIB_PKCS12 /* 35 */
212#define ERR_R_RAND_LIB ERR_LIB_RAND /* 36 */
213#define ERR_R_DSO_LIB ERR_LIB_DSO /* 37 */
214#define ERR_R_ENGINE_LIB ERR_LIB_ENGINE /* 38 */
215#define ERR_R_OCSP_LIB ERR_LIB_OCSP /* 39 */
a63d5eaa 216#define ERR_R_UI_LIB ERR_LIB_UI /* 40 */
a92ae070 217#define ERR_R_COMP_LIB ERR_LIB_COMP /* 41 */
4d94ae00 218#define ERR_R_ECDSA_LIB ERR_LIB_ECDSA /* 42 */
e172d60d 219#define ERR_R_ECDH_LIB ERR_LIB_ECDH /* 43 */
5277d7cb
BM
220
221#define ERR_R_NESTED_ASN1_ERROR 58
222#define ERR_R_BAD_ASN1_OBJECT_HEADER 59
223#define ERR_R_BAD_GET_ASN1_OBJECT_CALL 60
224#define ERR_R_EXPECTING_AN_ASN1_SEQUENCE 61
225#define ERR_R_ASN1_LENGTH_MISMATCH 62
226#define ERR_R_MISSING_ASN1_EOS 63
d02b48c6
RE
227
228/* fatal error */
5277d7cb 229#define ERR_R_FATAL 64
d02b48c6
RE
230#define ERR_R_MALLOC_FAILURE (1|ERR_R_FATAL)
231#define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2|ERR_R_FATAL)
232#define ERR_R_PASSED_NULL_PARAMETER (3|ERR_R_FATAL)
5277d7cb 233#define ERR_R_INTERNAL_ERROR (4|ERR_R_FATAL)
819ff32d 234#define ERR_R_DISABLED (5|ERR_R_FATAL)
5277d7cb
BM
235
236/* 99 is the maximum possible ERR_R_... code, higher values
237 * are reserved for the individual libraries */
238
d02b48c6
RE
239
240typedef struct ERR_string_data_st
241 {
242 unsigned long error;
e778802f 243 const char *string;
d02b48c6
RE
244 } ERR_STRING_DATA;
245
e778802f 246void ERR_put_error(int lib, int func,int reason,const char *file,int line);
58964a49
RE
247void ERR_set_error_data(char *data,int flags);
248
a14e2d9d 249unsigned long ERR_get_error(void);
e778802f
BL
250unsigned long ERR_get_error_line(const char **file,int *line);
251unsigned long ERR_get_error_line_data(const char **file,int *line,
252 const char **data, int *flags);
a14e2d9d 253unsigned long ERR_peek_error(void);
e778802f
BL
254unsigned long ERR_peek_error_line(const char **file,int *line);
255unsigned long ERR_peek_error_line_data(const char **file,int *line,
256 const char **data,int *flags);
273db408
BM
257unsigned long ERR_peek_last_error(void);
258unsigned long ERR_peek_last_error_line(const char **file,int *line);
a14e2d9d
BM
259unsigned long ERR_peek_last_error_line_data(const char **file,int *line,
260 const char **data,int *flags);
d02b48c6
RE
261void ERR_clear_error(void );
262char *ERR_error_string(unsigned long e,char *buf);
e5c84d51 263void ERR_error_string_n(unsigned long e, char *buf, size_t len);
e778802f
BL
264const char *ERR_lib_error_string(unsigned long e);
265const char *ERR_func_error_string(unsigned long e);
266const char *ERR_reason_error_string(unsigned long e);
8ada6e77
RL
267void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u),
268 void *u);
cf1b7d96 269#ifndef OPENSSL_NO_FP_API
d02b48c6
RE
270void ERR_print_errors_fp(FILE *fp);
271#endif
cf1b7d96 272#ifndef OPENSSL_NO_BIO
d02b48c6 273void ERR_print_errors(BIO *bp);
4565c3e3 274void ERR_add_error_data(int num, ...);
d02b48c6
RE
275#endif
276void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
1738bb61 277void ERR_unload_strings(int lib,ERR_STRING_DATA str[]);
29a28ee5
BM
278void ERR_load_ERR_strings(void);
279void ERR_load_crypto_strings(void);
280void ERR_free_strings(void);
d02b48c6
RE
281
282void ERR_remove_state(unsigned long pid); /* if zero we look it up */
283ERR_STATE *ERR_get_state(void);
284
cf1b7d96 285#ifndef OPENSSL_NO_LHASH
dcba2534 286LHASH *ERR_get_string_table(void);
b9a20b50 287LHASH *ERR_get_err_state_table(void);
d02b48c6
RE
288#endif
289
dcba2534 290int ERR_get_next_error_library(void);
58964a49 291
566bdf2b
GT
292/* This opaque type encapsulates the low-level error-state functions */
293typedef struct st_ERR_FNS ERR_FNS;
294/* An application can use this function and provide the return value to loaded
295 * modules that should use the application's ERR state/functionality */
296const ERR_FNS *ERR_get_implementation(void);
297/* A loaded module should call this function prior to any ERR operations using
298 * the application's "ERR_FNS". */
299int ERR_set_implementation(const ERR_FNS *fns);
300
d02b48c6
RE
301#ifdef __cplusplus
302}
303#endif
304
305#endif