Deprecate ERR_free_strings() and make it a no-op
[openssl.git] / include / openssl / err.h
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57 /* ====================================================================
58  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  *    notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  *    notice, this list of conditions and the following disclaimer in
69  *    the documentation and/or other materials provided with the
70  *    distribution.
71  *
72  * 3. All advertising materials mentioning features or use of this
73  *    software must display the following acknowledgment:
74  *    "This product includes software developed by the OpenSSL Project
75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76  *
77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78  *    endorse or promote products derived from this software without
79  *    prior written permission. For written permission, please contact
80  *    openssl-core@openssl.org.
81  *
82  * 5. Products derived from this software may not be called "OpenSSL"
83  *    nor may "OpenSSL" appear in their names without prior written
84  *    permission of the OpenSSL Project.
85  *
86  * 6. Redistributions of any form whatsoever must retain the following
87  *    acknowledgment:
88  *    "This product includes software developed by the OpenSSL Project
89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90  *
91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102  * OF THE POSSIBILITY OF SUCH DAMAGE.
103  * ====================================================================
104  *
105  * This product includes cryptographic software written by Eric Young
106  * (eay@cryptsoft.com).  This product includes software written by Tim
107  * Hudson (tjh@cryptsoft.com).
108  *
109  */
110
111 #ifndef HEADER_ERR_H
112 # define HEADER_ERR_H
113
114 # include <openssl/e_os2.h>
115
116 # ifndef OPENSSL_NO_STDIO
117 #  include <stdio.h>
118 #  include <stdlib.h>
119 # endif
120
121 # include <openssl/ossl_typ.h>
122 # include <openssl/bio.h>
123 # include <openssl/lhash.h>
124
125 #ifdef  __cplusplus
126 extern "C" {
127 #endif
128
129 # ifndef OPENSSL_NO_ERR
130 #  define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,d,e)
131 # else
132 #  define ERR_PUT_error(a,b,c,d,e)        ERR_put_error(a,b,c,NULL,0)
133 # endif
134
135 # include <errno.h>
136
137 # define ERR_TXT_MALLOCED        0x01
138 # define ERR_TXT_STRING          0x02
139
140 # define ERR_FLAG_MARK           0x01
141
142 # define ERR_NUM_ERRORS  16
143 typedef struct err_state_st {
144     int err_flags[ERR_NUM_ERRORS];
145     unsigned long err_buffer[ERR_NUM_ERRORS];
146     char *err_data[ERR_NUM_ERRORS];
147     int err_data_flags[ERR_NUM_ERRORS];
148     const char *err_file[ERR_NUM_ERRORS];
149     int err_line[ERR_NUM_ERRORS];
150     int top, bottom;
151 } ERR_STATE;
152
153 /* library */
154 # define ERR_LIB_NONE            1
155 # define ERR_LIB_SYS             2
156 # define ERR_LIB_BN              3
157 # define ERR_LIB_RSA             4
158 # define ERR_LIB_DH              5
159 # define ERR_LIB_EVP             6
160 # define ERR_LIB_BUF             7
161 # define ERR_LIB_OBJ             8
162 # define ERR_LIB_PEM             9
163 # define ERR_LIB_DSA             10
164 # define ERR_LIB_X509            11
165 /* #define ERR_LIB_METH         12 */
166 # define ERR_LIB_ASN1            13
167 # define ERR_LIB_CONF            14
168 # define ERR_LIB_CRYPTO          15
169 # define ERR_LIB_EC              16
170 # define ERR_LIB_SSL             20
171 /* #define ERR_LIB_SSL23        21 */
172 /* #define ERR_LIB_SSL2         22 */
173 /* #define ERR_LIB_SSL3         23 */
174 /* #define ERR_LIB_RSAREF       30 */
175 /* #define ERR_LIB_PROXY        31 */
176 # define ERR_LIB_BIO             32
177 # define ERR_LIB_PKCS7           33
178 # define ERR_LIB_X509V3          34
179 # define ERR_LIB_PKCS12          35
180 # define ERR_LIB_RAND            36
181 # define ERR_LIB_DSO             37
182 # define ERR_LIB_ENGINE          38
183 # define ERR_LIB_OCSP            39
184 # define ERR_LIB_UI              40
185 # define ERR_LIB_COMP            41
186 # define ERR_LIB_ECDSA           42
187 # define ERR_LIB_ECDH            43
188 # define ERR_LIB_STORE           44
189 # define ERR_LIB_FIPS            45
190 # define ERR_LIB_CMS             46
191 # define ERR_LIB_TS              47
192 # define ERR_LIB_HMAC            48
193 # define ERR_LIB_JPAKE           49
194 # define ERR_LIB_CT              50
195 # define ERR_LIB_ASYNC           51
196 # define ERR_LIB_KDF             52
197
198 # define ERR_LIB_USER            128
199
200 # define SYSerr(f,r)  ERR_PUT_error(ERR_LIB_SYS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
201 # define BNerr(f,r)   ERR_PUT_error(ERR_LIB_BN,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
202 # define RSAerr(f,r)  ERR_PUT_error(ERR_LIB_RSA,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
203 # define DHerr(f,r)   ERR_PUT_error(ERR_LIB_DH,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
204 # define EVPerr(f,r)  ERR_PUT_error(ERR_LIB_EVP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
205 # define BUFerr(f,r)  ERR_PUT_error(ERR_LIB_BUF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
206 # define OBJerr(f,r)  ERR_PUT_error(ERR_LIB_OBJ,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
207 # define PEMerr(f,r)  ERR_PUT_error(ERR_LIB_PEM,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
208 # define DSAerr(f,r)  ERR_PUT_error(ERR_LIB_DSA,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
209 # define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
210 # define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
211 # define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
212 # define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
213 # define ECerr(f,r)   ERR_PUT_error(ERR_LIB_EC,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
214 # define SSLerr(f,r)  ERR_PUT_error(ERR_LIB_SSL,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
215 # define BIOerr(f,r)  ERR_PUT_error(ERR_LIB_BIO,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
216 # define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
217 # define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
218 # define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
219 # define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
220 # define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
221 # define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
222 # define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
223 # define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
224 # define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
225 # define ECDSAerr(f,r)  ERR_PUT_error(ERR_LIB_ECDSA,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
226 # define ECDHerr(f,r)  ERR_PUT_error(ERR_LIB_ECDH,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
227 # define STOREerr(f,r) ERR_PUT_error(ERR_LIB_STORE,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
228 # define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
229 # define CMSerr(f,r) ERR_PUT_error(ERR_LIB_CMS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
230 # define TSerr(f,r) ERR_PUT_error(ERR_LIB_TS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
231 # define HMACerr(f,r) ERR_PUT_error(ERR_LIB_HMAC,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
232 # define JPAKEerr(f,r) ERR_PUT_error(ERR_LIB_JPAKE,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
233 # define CTerr(f,r) ERR_PUT_error(ERR_LIB_CT,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
234 # define ASYNCerr(f,r) ERR_PUT_error(ERR_LIB_ASYNC,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
235 # define KDFerr(f,r) ERR_PUT_error(ERR_LIB_KDF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
236
237 # define ERR_PACK(l,f,r) \
238     ( (((l) & 0x0FF) << 24L) | (((f) & 0xFFF) << 12L) | ((r) & 0xFFF) )
239 # define ERR_GET_LIB(l)          (int)((((unsigned long)l)>>24L)&0xffL)
240 # define ERR_GET_FUNC(l)         (int)((((unsigned long)l)>>12L)&0xfffL)
241 # define ERR_GET_REASON(l)       (int)((l)&0xfffL)
242 # define ERR_FATAL_ERROR(l)      (int)((l)&ERR_R_FATAL)
243
244 /* OS functions */
245 # define SYS_F_FOPEN             1
246 # define SYS_F_CONNECT           2
247 # define SYS_F_GETSERVBYNAME     3
248 # define SYS_F_SOCKET            4
249 # define SYS_F_IOCTLSOCKET       5
250 # define SYS_F_BIND              6
251 # define SYS_F_LISTEN            7
252 # define SYS_F_ACCEPT            8
253 # define SYS_F_WSASTARTUP        9/* Winsock stuff */
254 # define SYS_F_OPENDIR           10
255 # define SYS_F_FREAD             11
256 # define SYS_F_GETADDRINFO       12
257 # define SYS_F_GETNAMEINFO       13
258 # define SYS_F_SETSOCKOPT        14
259 # define SYS_F_GETSOCKOPT        15
260 # define SYS_F_GETSOCKNAME       16
261 # define SYS_F_GETHOSTBYNAME     17
262
263 /* reasons */
264 # define ERR_R_SYS_LIB   ERR_LIB_SYS/* 2 */
265 # define ERR_R_BN_LIB    ERR_LIB_BN/* 3 */
266 # define ERR_R_RSA_LIB   ERR_LIB_RSA/* 4 */
267 # define ERR_R_DH_LIB    ERR_LIB_DH/* 5 */
268 # define ERR_R_EVP_LIB   ERR_LIB_EVP/* 6 */
269 # define ERR_R_BUF_LIB   ERR_LIB_BUF/* 7 */
270 # define ERR_R_OBJ_LIB   ERR_LIB_OBJ/* 8 */
271 # define ERR_R_PEM_LIB   ERR_LIB_PEM/* 9 */
272 # define ERR_R_DSA_LIB   ERR_LIB_DSA/* 10 */
273 # define ERR_R_X509_LIB  ERR_LIB_X509/* 11 */
274 # define ERR_R_ASN1_LIB  ERR_LIB_ASN1/* 13 */
275 # define ERR_R_CONF_LIB  ERR_LIB_CONF/* 14 */
276 # define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO/* 15 */
277 # define ERR_R_EC_LIB    ERR_LIB_EC/* 16 */
278 # define ERR_R_SSL_LIB   ERR_LIB_SSL/* 20 */
279 # define ERR_R_BIO_LIB   ERR_LIB_BIO/* 32 */
280 # define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
281 # define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
282 # define ERR_R_PKCS12_LIB ERR_LIB_PKCS12/* 35 */
283 # define ERR_R_RAND_LIB  ERR_LIB_RAND/* 36 */
284 # define ERR_R_DSO_LIB   ERR_LIB_DSO/* 37 */
285 # define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
286 # define ERR_R_OCSP_LIB  ERR_LIB_OCSP/* 39 */
287 # define ERR_R_UI_LIB    ERR_LIB_UI/* 40 */
288 # define ERR_R_COMP_LIB  ERR_LIB_COMP/* 41 */
289 # define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
290 # define ERR_R_ECDH_LIB  ERR_LIB_ECDH/* 43 */
291 # define ERR_R_STORE_LIB ERR_LIB_STORE/* 44 */
292 # define ERR_R_TS_LIB    ERR_LIB_TS/* 45 */
293
294 # define ERR_R_NESTED_ASN1_ERROR                 58
295 # define ERR_R_BAD_ASN1_OBJECT_HEADER            59
296 # define ERR_R_BAD_GET_ASN1_OBJECT_CALL          60
297 # define ERR_R_EXPECTING_AN_ASN1_SEQUENCE        61
298 # define ERR_R_ASN1_LENGTH_MISMATCH              62
299 # define ERR_R_MISSING_ASN1_EOS                  63
300
301 /* fatal error */
302 # define ERR_R_FATAL                             64
303 # define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
304 # define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
305 # define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
306 # define ERR_R_INTERNAL_ERROR                    (4|ERR_R_FATAL)
307 # define ERR_R_DISABLED                          (5|ERR_R_FATAL)
308 # define ERR_R_INIT_FAIL                         (6|ERR_R_FATAL)
309 # define ERR_R_PASSED_INVALID_ARGUMENT           (7) 
310
311 /*
312  * 99 is the maximum possible ERR_R_... code, higher values are reserved for
313  * the individual libraries
314  */
315
316 typedef struct ERR_string_data_st {
317     unsigned long error;
318     const char *string;
319 } ERR_STRING_DATA;
320
321 DEFINE_LHASH_OF(ERR_STRING_DATA);
322
323 void ERR_put_error(int lib, int func, int reason, const char *file, int line);
324 void ERR_set_error_data(char *data, int flags);
325
326 unsigned long ERR_get_error(void);
327 unsigned long ERR_get_error_line(const char **file, int *line);
328 unsigned long ERR_get_error_line_data(const char **file, int *line,
329                                       const char **data, int *flags);
330 unsigned long ERR_peek_error(void);
331 unsigned long ERR_peek_error_line(const char **file, int *line);
332 unsigned long ERR_peek_error_line_data(const char **file, int *line,
333                                        const char **data, int *flags);
334 unsigned long ERR_peek_last_error(void);
335 unsigned long ERR_peek_last_error_line(const char **file, int *line);
336 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
337                                             const char **data, int *flags);
338 void ERR_clear_error(void);
339 char *ERR_error_string(unsigned long e, char *buf);
340 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
341 const char *ERR_lib_error_string(unsigned long e);
342 const char *ERR_func_error_string(unsigned long e);
343 const char *ERR_reason_error_string(unsigned long e);
344 void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
345                          void *u);
346 # ifndef OPENSSL_NO_STDIO
347 void ERR_print_errors_fp(FILE *fp);
348 # endif
349 void ERR_print_errors(BIO *bp);
350 void ERR_add_error_data(int num, ...);
351 void ERR_add_error_vdata(int num, va_list args);
352 void ERR_load_strings(int lib, ERR_STRING_DATA str[]);
353 void ERR_unload_strings(int lib, ERR_STRING_DATA str[]);
354 void ERR_load_ERR_strings(void);
355
356 #if OPENSSL_API_COMPAT < 0x10100000L
357 # define ERR_load_crypto_strings() \
358     OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
359 # define ERR_free_strings()
360 #endif
361
362 void ERR_remove_thread_state(void);
363 DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid)) /* if zero we
364                                                               * look it up */
365 ERR_STATE *ERR_get_state(void);
366
367 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void);
368
369 int ERR_get_next_error_library(void);
370
371 int ERR_set_mark(void);
372 int ERR_pop_to_mark(void);
373
374 #ifdef  __cplusplus
375 }
376 #endif
377
378 #endif