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