Deprecate ERR_get_state()
[openssl.git] / include / openssl / err.h
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef HEADER_ERR_H
11 # define HEADER_ERR_H
12
13 # include <openssl/e_os2.h>
14
15 # ifndef OPENSSL_NO_STDIO
16 #  include <stdio.h>
17 #  include <stdlib.h>
18 # endif
19
20 # include <openssl/ossl_typ.h>
21 # include <openssl/bio.h>
22 # include <openssl/lhash.h>
23
24 #ifdef  __cplusplus
25 extern "C" {
26 #endif
27
28 # if !OPENSSL_API_3
29 #  ifndef OPENSSL_NO_FILENAMES
30 #   define ERR_PUT_error(l,f,r,fn,ln)      ERR_put_error(l,f,r,fn,ln)
31 #  else
32 #   define ERR_PUT_error(l,f,r,fn,ln)      ERR_put_error(l,f,r,NULL,0)
33 #  endif
34 # endif
35
36 # include <errno.h>
37
38 # define ERR_TXT_MALLOCED        0x01
39 # define ERR_TXT_STRING          0x02
40
41 # if !OPENSSL_API_3 || defined(OSSL_FORCE_ERR_STATE)
42 #  define ERR_FLAG_MARK           0x01
43 #  define ERR_FLAG_CLEAR          0x02
44
45 #  define ERR_NUM_ERRORS  16
46 struct err_state_st {
47     int err_flags[ERR_NUM_ERRORS];
48     unsigned long err_buffer[ERR_NUM_ERRORS];
49     char *err_data[ERR_NUM_ERRORS];
50     size_t err_data_size[ERR_NUM_ERRORS];
51     int err_data_flags[ERR_NUM_ERRORS];
52     const char *err_file[ERR_NUM_ERRORS];
53     int err_line[ERR_NUM_ERRORS];
54     const char *err_func[ERR_NUM_ERRORS];
55     int top, bottom;
56 };
57 # endif
58
59 /* library */
60 # define ERR_LIB_NONE            1
61 # define ERR_LIB_SYS             2
62 # define ERR_LIB_BN              3
63 # define ERR_LIB_RSA             4
64 # define ERR_LIB_DH              5
65 # define ERR_LIB_EVP             6
66 # define ERR_LIB_BUF             7
67 # define ERR_LIB_OBJ             8
68 # define ERR_LIB_PEM             9
69 # define ERR_LIB_DSA             10
70 # define ERR_LIB_X509            11
71 /* #define ERR_LIB_METH         12 */
72 # define ERR_LIB_ASN1            13
73 # define ERR_LIB_CONF            14
74 # define ERR_LIB_CRYPTO          15
75 # define ERR_LIB_EC              16
76 # define ERR_LIB_SSL             20
77 /* #define ERR_LIB_SSL23        21 */
78 /* #define ERR_LIB_SSL2         22 */
79 /* #define ERR_LIB_SSL3         23 */
80 /* #define ERR_LIB_RSAREF       30 */
81 /* #define ERR_LIB_PROXY        31 */
82 # define ERR_LIB_BIO             32
83 # define ERR_LIB_PKCS7           33
84 # define ERR_LIB_X509V3          34
85 # define ERR_LIB_PKCS12          35
86 # define ERR_LIB_RAND            36
87 # define ERR_LIB_DSO             37
88 # define ERR_LIB_ENGINE          38
89 # define ERR_LIB_OCSP            39
90 # define ERR_LIB_UI              40
91 # define ERR_LIB_COMP            41
92 # define ERR_LIB_ECDSA           42
93 # define ERR_LIB_ECDH            43
94 # define ERR_LIB_OSSL_STORE      44
95 # define ERR_LIB_FIPS            45
96 # define ERR_LIB_CMS             46
97 # define ERR_LIB_TS              47
98 # define ERR_LIB_HMAC            48
99 /* # define ERR_LIB_JPAKE       49 */
100 # define ERR_LIB_CT              50
101 # define ERR_LIB_ASYNC           51
102 # define ERR_LIB_SM2             52
103 # define ERR_LIB_ESS             53
104 # define ERR_LIB_PROP            54
105 # define ERR_LIB_CRMF            55
106 # define ERR_LIB_PROV            56
107 # define ERR_LIB_CMP             57
108
109 # define ERR_LIB_USER            128
110
111 # if ! OPENSSL_API_3
112 #  define SYSerr(f,r)  ERR_raise(ERR_LIB_SYS,(r))
113 # endif
114 # define BNerr(f,r)   ERR_raise(ERR_LIB_BN,(r))
115 # define RSAerr(f,r)  ERR_raise(ERR_LIB_RSA,(r))
116 # define DHerr(f,r)   ERR_raise(ERR_LIB_DH,(r))
117 # define EVPerr(f,r)  ERR_raise(ERR_LIB_EVP,(r))
118 # define BUFerr(f,r)  ERR_raise(ERR_LIB_BUF,(r))
119 # define OBJerr(f,r)  ERR_raise(ERR_LIB_OBJ,(r))
120 # define PEMerr(f,r)  ERR_raise(ERR_LIB_PEM,(r))
121 # define DSAerr(f,r)  ERR_raise(ERR_LIB_DSA,(r))
122 # define X509err(f,r) ERR_raise(ERR_LIB_X509,(r))
123 # define ASN1err(f,r) ERR_raise(ERR_LIB_ASN1,(r))
124 # define CONFerr(f,r) ERR_raise(ERR_LIB_CONF,(r))
125 # define CRYPTOerr(f,r) ERR_raise(ERR_LIB_CRYPTO,(r))
126 # define ECerr(f,r)   ERR_raise(ERR_LIB_EC,(r))
127 # define SSLerr(f,r)  ERR_raise(ERR_LIB_SSL,(r))
128 # define BIOerr(f,r)  ERR_raise(ERR_LIB_BIO,(r))
129 # define PKCS7err(f,r) ERR_raise(ERR_LIB_PKCS7,(r))
130 # define X509V3err(f,r) ERR_raise(ERR_LIB_X509V3,(r))
131 # define PKCS12err(f,r) ERR_raise(ERR_LIB_PKCS12,(r))
132 # define RANDerr(f,r) ERR_raise(ERR_LIB_RAND,(r))
133 # define DSOerr(f,r) ERR_raise(ERR_LIB_DSO,(r))
134 # define ENGINEerr(f,r) ERR_raise(ERR_LIB_ENGINE,(r))
135 # define OCSPerr(f,r) ERR_raise(ERR_LIB_OCSP,(r))
136 # define UIerr(f,r) ERR_raise(ERR_LIB_UI,(r))
137 # define COMPerr(f,r) ERR_raise(ERR_LIB_COMP,(r))
138 # define ECDSAerr(f,r)  ERR_raise(ERR_LIB_ECDSA,(r))
139 # define ECDHerr(f,r)  ERR_raise(ERR_LIB_ECDH,(r))
140 # define OSSL_STOREerr(f,r) ERR_raise(ERR_LIB_OSSL_STORE,(r))
141 # define FIPSerr(f,r) ERR_raise(ERR_LIB_FIPS,(r))
142 # define CMSerr(f,r) ERR_raise(ERR_LIB_CMS,(r))
143 # define CRMFerr(f,r) ERR_raise(ERR_LIB_CRMF,(r))
144 # define CMPerr(f,r) ERR_raise(ERR_LIB_CMP,(r))
145 # define TSerr(f,r) ERR_raise(ERR_LIB_TS,(r))
146 # define HMACerr(f,r) ERR_raise(ERR_LIB_HMAC,(r))
147 # define CTerr(f,r) ERR_raise(ERR_LIB_CT,(r))
148 # define ASYNCerr(f,r) ERR_raise(ERR_LIB_ASYNC,(r))
149 # define SM2err(f,r) ERR_raise(ERR_LIB_SM2,(r))
150 # define ESSerr(f,r) ERR_raise(ERR_LIB_ESS,(r))
151 # define PROPerr(f,r) ERR_raise(ERR_LIB_PROP,(r))
152 # define PROVerr(f,r) ERR_raise(ERR_LIB_PROV,(r))
153
154 # define ERR_PACK(l,f,r) ( \
155         (((unsigned int)(l) & 0x0FF) << 24L) | \
156         (((unsigned int)(f) & 0xFFF) << 12L) | \
157         (((unsigned int)(r) & 0xFFF)       ) )
158 # define ERR_GET_LIB(l)          (int)(((l) >> 24L) & 0x0FFL)
159 # define ERR_GET_FUNC(l)         (int)(((l) >> 12L) & 0xFFFL)
160 # define ERR_GET_REASON(l)       (int)( (l)         & 0xFFFL)
161 # define ERR_FATAL_ERROR(l)      (int)( (l)         & ERR_R_FATAL)
162
163 # if !OPENSSL_API_3
164 #  define SYS_F_FOPEN             0
165 #  define SYS_F_CONNECT           0
166 #  define SYS_F_GETSERVBYNAME     0
167 #  define SYS_F_SOCKET            0
168 #  define SYS_F_IOCTLSOCKET       0
169 #  define SYS_F_BIND              0
170 #  define SYS_F_LISTEN            0
171 #  define SYS_F_ACCEPT            0
172 #  define SYS_F_WSASTARTUP        0
173 #  define SYS_F_OPENDIR           0
174 #  define SYS_F_FREAD             0
175 #  define SYS_F_GETADDRINFO       0
176 #  define SYS_F_GETNAMEINFO       0
177 #  define SYS_F_SETSOCKOPT        0
178 #  define SYS_F_GETSOCKOPT        0
179 #  define SYS_F_GETSOCKNAME       0
180 #  define SYS_F_GETHOSTBYNAME     0
181 #  define SYS_F_FFLUSH            0
182 #  define SYS_F_OPEN              0
183 #  define SYS_F_CLOSE             0
184 #  define SYS_F_IOCTL             0
185 #  define SYS_F_STAT              0
186 #  define SYS_F_FCNTL             0
187 #  define SYS_F_FSTAT             0
188 #  define SYS_F_SENDFILE          0
189 # endif
190
191 /* reasons */
192 # define ERR_R_SYS_LIB   ERR_LIB_SYS/* 2 */
193 # define ERR_R_BN_LIB    ERR_LIB_BN/* 3 */
194 # define ERR_R_RSA_LIB   ERR_LIB_RSA/* 4 */
195 # define ERR_R_DH_LIB    ERR_LIB_DH/* 5 */
196 # define ERR_R_EVP_LIB   ERR_LIB_EVP/* 6 */
197 # define ERR_R_BUF_LIB   ERR_LIB_BUF/* 7 */
198 # define ERR_R_OBJ_LIB   ERR_LIB_OBJ/* 8 */
199 # define ERR_R_PEM_LIB   ERR_LIB_PEM/* 9 */
200 # define ERR_R_DSA_LIB   ERR_LIB_DSA/* 10 */
201 # define ERR_R_X509_LIB  ERR_LIB_X509/* 11 */
202 # define ERR_R_ASN1_LIB  ERR_LIB_ASN1/* 13 */
203 # define ERR_R_EC_LIB    ERR_LIB_EC/* 16 */
204 # define ERR_R_BIO_LIB   ERR_LIB_BIO/* 32 */
205 # define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
206 # define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
207 # define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
208 # define ERR_R_UI_LIB    ERR_LIB_UI/* 40 */
209 # define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
210 # define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
211
212 # define ERR_R_NESTED_ASN1_ERROR                 58
213 # define ERR_R_MISSING_ASN1_EOS                  63
214
215 /* fatal error */
216 # define ERR_R_FATAL                             64
217 # define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
218 # define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
219 # define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
220 # define ERR_R_INTERNAL_ERROR                    (4|ERR_R_FATAL)
221 # define ERR_R_DISABLED                          (5|ERR_R_FATAL)
222 # define ERR_R_INIT_FAIL                         (6|ERR_R_FATAL)
223 # define ERR_R_PASSED_INVALID_ARGUMENT           (7)
224 # define ERR_R_OPERATION_FAIL                    (8|ERR_R_FATAL)
225
226 /*
227  * 99 is the maximum possible ERR_R_... code, higher values are reserved for
228  * the individual libraries
229  */
230
231 typedef struct ERR_string_data_st {
232     unsigned long error;
233     const char *string;
234 } ERR_STRING_DATA;
235
236 DEFINE_LHASH_OF(ERR_STRING_DATA);
237
238 /* 12 lines and some on an 80 column terminal */
239 #define ERR_MAX_DATA_SIZE       1024
240
241 /* Building blocks */
242 void ERR_new(void);
243 void ERR_set_debug(const char *file, int line, const char *func);
244 void ERR_set_error(int lib, int reason, const char *fmt, ...);
245 void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);
246
247 /* Main error raising functions */
248 # define ERR_raise(lib, reason) ERR_raise_data((lib),(reason),NULL)
249 # define ERR_raise_data                                         \
250     (ERR_new(),                                                 \
251      ERR_set_debug(OPENSSL_FILE,OPENSSL_LINE,OPENSSL_FUNC),     \
252      ERR_set_error)
253
254 # if !OPENSSL_API_3
255 /* Backward compatibility */
256 #  define ERR_put_error(lib, func, reason, file, line)          \
257     (ERR_new(),                                                 \
258      ERR_set_debug((file), (line), OPENSSL_FUNC),               \
259      ERR_set_error((lib), (reason), NULL))
260 # endif
261
262 void ERR_set_error_data(char *data, int flags);
263
264 unsigned long ERR_get_error(void);
265 /*
266  * TODO(3.0) consider if the following three functions should be deprecated.
267  * They all drop the error record from the error queue, so regardless of which
268  * one is used, the rest of the information is lost, making them not so useful.
269  * The recommendation should be to use the peek functions to extract all the
270  * additional data.
271  */
272 unsigned long ERR_get_error_line(const char **file, int *line);
273 unsigned long ERR_get_error_func(const char **func);
274 unsigned long ERR_get_error_data(const char **data, int *flags);
275 unsigned long ERR_get_error_all(const char **file, int *line,
276                                 const char **func,
277                                 const char **data, int *flags);
278 DEPRECATEDIN_3(unsigned long ERR_get_error_line_data(const char **file,
279                                                      int *line,
280                                                      const char **data,
281                                                      int *flags))
282 unsigned long ERR_peek_error(void);
283 unsigned long ERR_peek_error_line(const char **file, int *line);
284 unsigned long ERR_peek_error_func(const char **func);
285 unsigned long ERR_peek_error_data(const char **data, int *flags);
286 unsigned long ERR_peek_error_all(const char **file, int *line,
287                                  const char **func,
288                                  const char **data, int *flags);
289 DEPRECATEDIN_3(unsigned long ERR_peek_error_line_data(const char **file,
290                                                       int *line,
291                                                       const char **data,
292                                                       int *flags))
293 unsigned long ERR_peek_last_error(void);
294 unsigned long ERR_peek_last_error_line(const char **file, int *line);
295 unsigned long ERR_peek_last_error_func(const char **func);
296 unsigned long ERR_peek_last_error_data(const char **data, int *flags);
297 unsigned long ERR_peek_last_error_all(const char **file, int *line,
298                                       const char **func,
299                                       const char **data, int *flags);
300 DEPRECATEDIN_3(unsigned long ERR_peek_last_error_line_data(const char **file,
301                                                            int *line,
302                                                            const char **data,
303                                                            int *flags))
304
305 void ERR_clear_error(void);
306
307 char *ERR_error_string(unsigned long e, char *buf);
308 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
309 const char *ERR_lib_error_string(unsigned long e);
310 DEPRECATEDIN_3(const char *ERR_func_error_string(unsigned long e))
311 const char *ERR_reason_error_string(unsigned long e);
312
313 void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
314                          void *u);
315 # ifndef OPENSSL_NO_STDIO
316 void ERR_print_errors_fp(FILE *fp);
317 # endif
318 void ERR_print_errors(BIO *bp);
319
320 void ERR_add_error_data(int num, ...);
321 void ERR_add_error_vdata(int num, va_list args);
322
323 int ERR_load_strings(int lib, ERR_STRING_DATA *str);
324 int ERR_load_strings_const(const ERR_STRING_DATA *str);
325 int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
326 int ERR_load_ERR_strings(void);
327
328 #if !OPENSSL_API_1_1_0
329 # define ERR_load_crypto_strings() \
330     OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
331 # define ERR_free_strings() while(0) continue
332 #endif
333
334 DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
335 DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
336 DEPRECATEDIN_3(ERR_STATE *ERR_get_state(void))
337
338 int ERR_get_next_error_library(void);
339
340 int ERR_set_mark(void);
341 int ERR_pop_to_mark(void);
342 int ERR_clear_last_mark(void);
343
344 #ifdef  __cplusplus
345 }
346 #endif
347
348 #endif