]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/err.h
ERR: Add new building blocks for reporting errors
[thirdparty/openssl.git] / include / openssl / err.h
CommitLineData
21dcbebc 1/*
b0edda11 2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
48fc582f 3 *
48f4ad77 4 * Licensed under the Apache License 2.0 (the "License"). You may not use
21dcbebc
RS
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
48fc582f 8 */
d02b48c6
RE
9
10#ifndef HEADER_ERR_H
0f113f3e 11# define HEADER_ERR_H
d02b48c6 12
0f113f3e 13# include <openssl/e_os2.h>
08a54f6e 14
0f113f3e
MC
15# ifndef OPENSSL_NO_STDIO
16# include <stdio.h>
17# include <stdlib.h>
18# endif
0b86eb3e 19
0f113f3e 20# include <openssl/ossl_typ.h>
a00ae6c4
RS
21# include <openssl/bio.h>
22# include <openssl/lhash.h>
ef33b970 23
0f113f3e 24#ifdef __cplusplus
82271cee
RL
25extern "C" {
26#endif
27
0f113f3e 28# ifndef OPENSSL_NO_ERR
56c3a135
RS
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)
0f113f3e 31# else
56c3a135
RS
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)
0f113f3e 34# endif
d02b48c6 35
0f113f3e 36# include <errno.h>
d02b48c6 37
0f113f3e
MC
38# define ERR_TXT_MALLOCED 0x01
39# define ERR_TXT_STRING 0x02
58964a49 40
0f113f3e 41# define ERR_FLAG_MARK 0x01
94dc53a3 42# define ERR_FLAG_CLEAR 0x02
54f64516 43
0f113f3e
MC
44# define ERR_NUM_ERRORS 16
45typedef struct err_state_st {
0f113f3e
MC
46 int err_flags[ERR_NUM_ERRORS];
47 unsigned long err_buffer[ERR_NUM_ERRORS];
48 char *err_data[ERR_NUM_ERRORS];
10f8b368 49 size_t err_data_size[ERR_NUM_ERRORS];
0f113f3e
MC
50 int err_data_flags[ERR_NUM_ERRORS];
51 const char *err_file[ERR_NUM_ERRORS];
52 int err_line[ERR_NUM_ERRORS];
8a4dc425 53 const char *err_func[ERR_NUM_ERRORS];
0f113f3e
MC
54 int top, bottom;
55} ERR_STATE;
d02b48c6
RE
56
57/* library */
0f113f3e
MC
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
5277d7cb 69/* #define ERR_LIB_METH 12 */
0f113f3e
MC
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
5277d7cb
BM
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 */
0f113f3e
MC
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
71a5516d 92# define ERR_LIB_OSSL_STORE 44
0f113f3e
MC
93# define ERR_LIB_FIPS 45
94# define ERR_LIB_CMS 46
95# define ERR_LIB_TS 47
96# define ERR_LIB_HMAC 48
31a51151 97/* # define ERR_LIB_JPAKE 49 */
3149baf8 98# define ERR_LIB_CT 50
079a1a90 99# define ERR_LIB_ASYNC 51
3e30fa0a 100# define ERR_LIB_KDF 52
3d328a44 101# define ERR_LIB_SM2 53
e85d19c6 102# define ERR_LIB_ESS 54
1bdbdaff 103# define ERR_LIB_PROP 55
a61b7f2f 104# define ERR_LIB_CRMF 56
6caf7f3a 105# define ERR_LIB_PROV 57
8869ad4a 106# define ERR_LIB_CMP 58
0f113f3e
MC
107
108# define ERR_LIB_USER 128
109
46160e6f
RS
110# if ! OPENSSL_API_3
111# define SYSerr(f,r) ERR_PUT_error(ERR_LIB_SYS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
112#endif
113# define FUNCerr(f,r) ERR_PUT_func_error(ERR_LIB_SYS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
aac96e27
RS
114# define BNerr(f,r) ERR_PUT_error(ERR_LIB_BN,0,(r),OPENSSL_FILE,OPENSSL_LINE)
115# define RSAerr(f,r) ERR_PUT_error(ERR_LIB_RSA,0,(r),OPENSSL_FILE,OPENSSL_LINE)
116# define DHerr(f,r) ERR_PUT_error(ERR_LIB_DH,0,(r),OPENSSL_FILE,OPENSSL_LINE)
117# define EVPerr(f,r) ERR_PUT_error(ERR_LIB_EVP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
118# define BUFerr(f,r) ERR_PUT_error(ERR_LIB_BUF,0,(r),OPENSSL_FILE,OPENSSL_LINE)
119# define OBJerr(f,r) ERR_PUT_error(ERR_LIB_OBJ,0,(r),OPENSSL_FILE,OPENSSL_LINE)
120# define PEMerr(f,r) ERR_PUT_error(ERR_LIB_PEM,0,(r),OPENSSL_FILE,OPENSSL_LINE)
121# define DSAerr(f,r) ERR_PUT_error(ERR_LIB_DSA,0,(r),OPENSSL_FILE,OPENSSL_LINE)
122# define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,0,(r),OPENSSL_FILE,OPENSSL_LINE)
123# define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,0,(r),OPENSSL_FILE,OPENSSL_LINE)
124# define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,0,(r),OPENSSL_FILE,OPENSSL_LINE)
125# define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,0,(r),OPENSSL_FILE,OPENSSL_LINE)
126# define ECerr(f,r) ERR_PUT_error(ERR_LIB_EC,0,(r),OPENSSL_FILE,OPENSSL_LINE)
127# define SSLerr(f,r) ERR_PUT_error(ERR_LIB_SSL,0,(r),OPENSSL_FILE,OPENSSL_LINE)
128# define BIOerr(f,r) ERR_PUT_error(ERR_LIB_BIO,0,(r),OPENSSL_FILE,OPENSSL_LINE)
129# define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,0,(r),OPENSSL_FILE,OPENSSL_LINE)
130# define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,0,(r),OPENSSL_FILE,OPENSSL_LINE)
131# define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,0,(r),OPENSSL_FILE,OPENSSL_LINE)
132# define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,0,(r),OPENSSL_FILE,OPENSSL_LINE)
133# define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,0,(r),OPENSSL_FILE,OPENSSL_LINE)
134# define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,0,(r),OPENSSL_FILE,OPENSSL_LINE)
135# define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
136# define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,0,(r),OPENSSL_FILE,OPENSSL_LINE)
137# define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
138# define ECDSAerr(f,r) ERR_PUT_error(ERR_LIB_ECDSA,0,(r),OPENSSL_FILE,OPENSSL_LINE)
139# define ECDHerr(f,r) ERR_PUT_error(ERR_LIB_ECDH,0,(r),OPENSSL_FILE,OPENSSL_LINE)
140# define OSSL_STOREerr(f,r) ERR_PUT_error(ERR_LIB_OSSL_STORE,0,(r),OPENSSL_FILE,OPENSSL_LINE)
141# define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
142# define CMSerr(f,r) ERR_PUT_error(ERR_LIB_CMS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
143# define CRMFerr(f,r) ERR_PUT_error(ERR_LIB_CRMF,0,(r),OPENSSL_FILE,OPENSSL_LINE)
144# define CMPerr(f,r) ERR_PUT_error(ERR_LIB_CMP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
145# define TSerr(f,r) ERR_PUT_error(ERR_LIB_TS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
146# define HMACerr(f,r) ERR_PUT_error(ERR_LIB_HMAC,0,(r),OPENSSL_FILE,OPENSSL_LINE)
147# define CTerr(f,r) ERR_PUT_error(ERR_LIB_CT,0,(r),OPENSSL_FILE,OPENSSL_LINE)
148# define ASYNCerr(f,r) ERR_PUT_error(ERR_LIB_ASYNC,0,(r),OPENSSL_FILE,OPENSSL_LINE)
149# define KDFerr(f,r) ERR_PUT_error(ERR_LIB_KDF,0,(r),OPENSSL_FILE,OPENSSL_LINE)
150# define SM2err(f,r) ERR_PUT_error(ERR_LIB_SM2,0,(r),OPENSSL_FILE,OPENSSL_LINE)
151# define ESSerr(f,r) ERR_PUT_error(ERR_LIB_ESS,0,(r),OPENSSL_FILE,OPENSSL_LINE)
152# define PROPerr(f,r) ERR_PUT_error(ERR_LIB_PROP,0,(r),OPENSSL_FILE,OPENSSL_LINE)
153# define PROVerr(f,r) ERR_PUT_error(ERR_LIB_PROV,0,(r),OPENSSL_FILE,OPENSSL_LINE)
0f113f3e 154
446dffa7
RS
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)
036ba500 162# define ERR_FATAL_ERROR(l) (int)( (l) & ERR_R_FATAL)
5277d7cb 163
a80278b0
RS
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
d02b48c6 192/* reasons */
0f113f3e
MC
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 */
0f113f3e 204# define ERR_R_EC_LIB ERR_LIB_EC/* 16 */
0f113f3e
MC
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 */
0f113f3e 208# define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
c785fd48 209# define ERR_R_UI_LIB ERR_LIB_UI/* 40 */
0f113f3e 210# define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
71a5516d 211# define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
0f113f3e
MC
212
213# define ERR_R_NESTED_ASN1_ERROR 58
0f113f3e 214# define ERR_R_MISSING_ASN1_EOS 63
d02b48c6
RE
215
216/* fatal error */
0f113f3e
MC
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)
302f7588 223# define ERR_R_INIT_FAIL (6|ERR_R_FATAL)
02e112a8 224# define ERR_R_PASSED_INVALID_ARGUMENT (7)
9a32dcf4 225# define ERR_R_OPERATION_FAIL (8|ERR_R_FATAL)
0f113f3e
MC
226
227/*
228 * 99 is the maximum possible ERR_R_... code, higher values are reserved for
229 * the individual libraries
230 */
d02b48c6 231
0f113f3e
MC
232typedef struct ERR_string_data_st {
233 unsigned long error;
234 const char *string;
235} ERR_STRING_DATA;
d02b48c6 236
89d6aa10 237DEFINE_LHASH_OF(ERR_STRING_DATA);
e6b5c341 238
7c0e20dc
RL
239/* 12 lines and some on an 80 column terminal */
240#define ERR_MAX_DATA_SIZE 1024
241
242/* Building blocks */
243void ERR_new(void);
244void ERR_set_debug(const char *file, int line, const char *func);
245void ERR_set_error(int lib, int reason, const char *fmt, ...);
246void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);
247
0f113f3e 248void ERR_put_error(int lib, int func, int reason, const char *file, int line);
56c3a135
RS
249void ERR_put_func_error(int lib, const char *func, int reason,
250 const char *file, int line);
0f113f3e 251void ERR_set_error_data(char *data, int flags);
58964a49 252
a14e2d9d 253unsigned long ERR_get_error(void);
0f113f3e
MC
254unsigned long ERR_get_error_line(const char **file, int *line);
255unsigned long ERR_get_error_line_data(const char **file, int *line,
256 const char **data, int *flags);
a14e2d9d 257unsigned long ERR_peek_error(void);
0f113f3e
MC
258unsigned long ERR_peek_error_line(const char **file, int *line);
259unsigned long ERR_peek_error_line_data(const char **file, int *line,
260 const char **data, int *flags);
273db408 261unsigned long ERR_peek_last_error(void);
0f113f3e
MC
262unsigned long ERR_peek_last_error_line(const char **file, int *line);
263unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
264 const char **data, int *flags);
265void ERR_clear_error(void);
266char *ERR_error_string(unsigned long e, char *buf);
e5c84d51 267void ERR_error_string_n(unsigned long e, char *buf, size_t len);
e778802f
BL
268const char *ERR_lib_error_string(unsigned long e);
269const char *ERR_func_error_string(unsigned long e);
270const char *ERR_reason_error_string(unsigned long e);
0f113f3e
MC
271void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
272 void *u);
273# ifndef OPENSSL_NO_STDIO
d02b48c6 274void ERR_print_errors_fp(FILE *fp);
0f113f3e 275# endif
d02b48c6 276void ERR_print_errors(BIO *bp);
78c45722
DSH
277void ERR_add_error_data(int num, ...);
278void ERR_add_error_vdata(int num, va_list args);
52df25cf
RS
279int ERR_load_strings(int lib, ERR_STRING_DATA *str);
280int ERR_load_strings_const(const ERR_STRING_DATA *str);
281int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
69588edb 282int ERR_load_ERR_strings(void);
7b9f8f7f 283
fcd2d5a6 284#if !OPENSSL_API_1_1_0
f672aee4
RS
285# define ERR_load_crypto_strings() \
286 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
6457615a 287# define ERR_free_strings() while(0) continue
f672aee4 288#endif
7b9f8f7f 289
21e00174
RL
290DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
291DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
d02b48c6
RE
292ERR_STATE *ERR_get_state(void);
293
dcba2534 294int ERR_get_next_error_library(void);
58964a49 295
54f64516
RL
296int ERR_set_mark(void);
297int ERR_pop_to_mark(void);
e1a4ff76 298int ERR_clear_last_mark(void);
54f64516 299
0f113f3e 300#ifdef __cplusplus
d02b48c6
RE
301}
302#endif
303
304#endif