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