]> git.ipfire.org Git - thirdparty/openssl.git/blob - include/openssl/err.h
projects / thirdparty / openssl.git / blob
? search:


7aac9b88d4a48741b93bd75fbb7bddaa48662195
[thirdparty/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 # ifndef OPENSSL_NO_ERR
29 # define ERR_PUT_error(l,f,r,fn,ln) ERR_put_error(l,f,r,fn,ln)
30 # define ERR_PUT_func_error(l,f,r,fn,ln) ERR_put_func_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 # define ERR_PUT_func_error(l,f,r,fn,ln) ERR_put_func_error(l,f,r,NULL,0)
34 # endif
35
36 # include <errno.h>
37
38 # define ERR_TXT_MALLOCED 0x01
39 # define ERR_TXT_STRING 0x02
40
41 # define ERR_FLAG_MARK 0x01
42 # define ERR_FLAG_CLEAR 0x02
43
44 # define ERR_NUM_ERRORS 16
45 typedef struct err_state_st {
46 int err_flags[ERR_NUM_ERRORS];
47 unsigned long err_buffer[ERR_NUM_ERRORS];
48 char *err_data[ERR_NUM_ERRORS];
49 size_t err_data_size[ERR_NUM_ERRORS];
50 int err_data_flags[ERR_NUM_ERRORS];
51 const char *err_file[ERR_NUM_ERRORS];
52 int err_line[ERR_NUM_ERRORS];
53 const char *err_func[ERR_NUM_ERRORS];
54 int top, bottom;
55 } ERR_STATE;
56
57 /* library */
58 # define ERR_LIB_NONE 1
59 # define ERR_LIB_SYS 2
60 # define ERR_LIB_BN 3
61 # define ERR_LIB_RSA 4
62 # define ERR_LIB_DH 5
63 # define ERR_LIB_EVP 6
64 # define ERR_LIB_BUF 7
65 # define ERR_LIB_OBJ 8
66 # define ERR_LIB_PEM 9
67 # define ERR_LIB_DSA 10
68 # define ERR_LIB_X509 11
69 /* #define ERR_LIB_METH 12 */
70 # define ERR_LIB_ASN1 13
71 # define ERR_LIB_CONF 14
72 # define ERR_LIB_CRYPTO 15
73 # define ERR_LIB_EC 16
74 # define ERR_LIB_SSL 20
75 /* #define ERR_LIB_SSL23 21 */
76 /* #define ERR_LIB_SSL2 22 */
77 /* #define ERR_LIB_SSL3 23 */
78 /* #define ERR_LIB_RSAREF 30 */
79 /* #define ERR_LIB_PROXY 31 */
80 # define ERR_LIB_BIO 32
81 # define ERR_LIB_PKCS7 33
82 # define ERR_LIB_X509V3 34
83 # define ERR_LIB_PKCS12 35
84 # define ERR_LIB_RAND 36
85 # define ERR_LIB_DSO 37
86 # define ERR_LIB_ENGINE 38
87 # define ERR_LIB_OCSP 39
88 # define ERR_LIB_UI 40
89 # define ERR_LIB_COMP 41
90 # define ERR_LIB_ECDSA 42
91 # define ERR_LIB_ECDH 43
92 # define ERR_LIB_OSSL_STORE 44
93 # define ERR_LIB_FIPS 45
94 # define ERR_LIB_CMS 46
95 # define ERR_LIB_TS 47
96 # define ERR_LIB_HMAC 48
97 /* # define ERR_LIB_JPAKE 49 */
98 # define ERR_LIB_CT 50
99 # define ERR_LIB_ASYNC 51
100 # define ERR_LIB_KDF 52
101 # define ERR_LIB_SM2 53
102 # define ERR_LIB_ESS 54
103 # define ERR_LIB_PROP 55
104 # define ERR_LIB_CRMF 56
105 # define ERR_LIB_PROV 57
106 # define ERR_LIB_CMP 58
107
108 # define ERR_LIB_USER 128
109
110 # if ! OPENSSL_API_3
111 # define SYSerr(f,r) ERR_raise(ERR_LIB_SYS,(r))
112 # endif
113 # define FUNCerr(f,r) ERR_raise_data(ERR_LIB_SYS,(r),"calling function %s",(f))
114 # define BNerr(f,r) ERR_raise(ERR_LIB_RSA,(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 KDFerr(f,r) ERR_raise(ERR_LIB_KDF,(r))
150 # define SM2err(f,r) ERR_raise(ERR_LIB_SM2,(r))
151 # define ESSerr(f,r) ERR_raise(ERR_LIB_ESS,(r))
152 # define PROPerr(f,r) ERR_raise(ERR_LIB_PROP,(r))
153 # define PROVerr(f,r) ERR_raise(ERR_LIB_PROV,(r))
154
155 # define ERR_PACK(l,f,r) ( \
156 (((unsigned int)(l) & 0x0FF) << 24L) | \
157 (((unsigned int)(f) & 0xFFF) << 12L) | \
158 (((unsigned int)(r) & 0xFFF) ) )
159 # define ERR_GET_LIB(l) (int)(((l) >> 24L) & 0x0FFL)
160 # define ERR_GET_FUNC(l) (int)(((l) >> 12L) & 0xFFFL)
161 # define ERR_GET_REASON(l) (int)( (l) & 0xFFFL)
162 # define ERR_FATAL_ERROR(l) (int)( (l) & ERR_R_FATAL)
163
164 # if !OPENSSL_API_3
165 # define SYS_F_FOPEN 0
166 # define SYS_F_CONNECT 0
167 # define SYS_F_GETSERVBYNAME 0
168 # define SYS_F_SOCKET 0
169 # define SYS_F_IOCTLSOCKET 0
170 # define SYS_F_BIND 0
171 # define SYS_F_LISTEN 0
172 # define SYS_F_ACCEPT 0
173 # define SYS_F_WSASTARTUP 0
174 # define SYS_F_OPENDIR 0
175 # define SYS_F_FREAD 0
176 # define SYS_F_GETADDRINFO 0
177 # define SYS_F_GETNAMEINFO 0
178 # define SYS_F_SETSOCKOPT 0
179 # define SYS_F_GETSOCKOPT 0
180 # define SYS_F_GETSOCKNAME 0
181 # define SYS_F_GETHOSTBYNAME 0
182 # define SYS_F_FFLUSH 0
183 # define SYS_F_OPEN 0
184 # define SYS_F_CLOSE 0
185 # define SYS_F_IOCTL 0
186 # define SYS_F_STAT 0
187 # define SYS_F_FCNTL 0
188 # define SYS_F_FSTAT 0
189 # define SYS_F_SENDFILE 0
190 # endif
191
192 /* reasons */
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_EC_LIB ERR_LIB_EC/* 16 */
205 # define ERR_R_BIO_LIB ERR_LIB_BIO/* 32 */
206 # define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
207 # define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
208 # define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
209 # define ERR_R_UI_LIB ERR_LIB_UI/* 40 */
210 # define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
211 # define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
212
213 # define ERR_R_NESTED_ASN1_ERROR 58
214 # define ERR_R_MISSING_ASN1_EOS 63
215
216 /* fatal error */
217 # define ERR_R_FATAL 64
218 # define ERR_R_MALLOC_FAILURE (1|ERR_R_FATAL)
219 # define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2|ERR_R_FATAL)
220 # define ERR_R_PASSED_NULL_PARAMETER (3|ERR_R_FATAL)
221 # define ERR_R_INTERNAL_ERROR (4|ERR_R_FATAL)
222 # define ERR_R_DISABLED (5|ERR_R_FATAL)
223 # define ERR_R_INIT_FAIL (6|ERR_R_FATAL)
224 # define ERR_R_PASSED_INVALID_ARGUMENT (7)
225 # define ERR_R_OPERATION_FAIL (8|ERR_R_FATAL)
226
227 /*
228 * 99 is the maximum possible ERR_R_... code, higher values are reserved for
229 * the individual libraries
230 */
231
232 typedef struct ERR_string_data_st {
233 unsigned long error;
234 const char *string;
235 } ERR_STRING_DATA;
236
237 DEFINE_LHASH_OF(ERR_STRING_DATA);
238
239 /* 12 lines and some on an 80 column terminal */
240 #define ERR_MAX_DATA_SIZE 1024
241
242 /* Building blocks */
243 void ERR_new(void);
244 void ERR_set_debug(const char *file, int line, const char *func);
245 void ERR_set_error(int lib, int reason, const char *fmt, ...);
246 void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);
247
248 /* Main error raising functions */
249 #define ERR_raise(lib, reason) ERR_raise_data((lib),(reason),NULL)
250 #define ERR_raise_data \
251 (ERR_new(), \
252 ERR_set_debug(OPENSSL_FILE,OPENSSL_LINE,OPENSSL_FUNC), \
253 ERR_set_error)
254
255 void ERR_put_error(int lib, int func, int reason, const char *file, int line);
256 void ERR_put_func_error(int lib, const char *func, int reason,
257 const char *file, int line);
258 void ERR_set_error_data(char *data, int flags);
259
260 unsigned long ERR_get_error(void);
261 unsigned long ERR_get_error_line(const char **file, int *line);
262 unsigned long ERR_get_error_line_data(const char **file, int *line,
263 const char **data, int *flags);
264 unsigned long ERR_peek_error(void);
265 unsigned long ERR_peek_error_line(const char **file, int *line);
266 unsigned long ERR_peek_error_line_data(const char **file, int *line,
267 const char **data, int *flags);
268 unsigned long ERR_peek_last_error(void);
269 unsigned long ERR_peek_last_error_line(const char **file, int *line);
270 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
271 const char **data, int *flags);
272 void ERR_clear_error(void);
273 char *ERR_error_string(unsigned long e, char *buf);
274 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
275 const char *ERR_lib_error_string(unsigned long e);
276 const char *ERR_func_error_string(unsigned long e);
277 const char *ERR_reason_error_string(unsigned long e);
278 void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
279 void *u);
280 # ifndef OPENSSL_NO_STDIO
281 void ERR_print_errors_fp(FILE *fp);
282 # endif
283 void ERR_print_errors(BIO *bp);
284 void ERR_add_error_data(int num, ...);
285 void ERR_add_error_vdata(int num, va_list args);
286 int ERR_load_strings(int lib, ERR_STRING_DATA *str);
287 int ERR_load_strings_const(const ERR_STRING_DATA *str);
288 int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
289 int ERR_load_ERR_strings(void);
290
291 #if !OPENSSL_API_1_1_0
292 # define ERR_load_crypto_strings() \
293 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
294 # define ERR_free_strings() while(0) continue
295 #endif
296
297 DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
298 DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
299 ERR_STATE *ERR_get_state(void);
300
301 int ERR_get_next_error_library(void);
302
303 int ERR_set_mark(void);
304 int ERR_pop_to_mark(void);
305 int ERR_clear_last_mark(void);
306
307 #ifdef __cplusplus
308 }
309 #endif
310
311 #endif
A mirror of the official openssl repository