]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/err.h
include/openssl/macros.h: Remove the PEDANTIC OPENSSL_FUNC definition
[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
586dd674
RL
28# if !OPENSSL_API_3
29# ifndef OPENSSL_NO_ERR
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
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
fe6ec26b
P
100# define ERR_LIB_SM2 52
101# define ERR_LIB_ESS 53
102# define ERR_LIB_PROP 54
103# define ERR_LIB_CRMF 55
104# define ERR_LIB_PROV 56
105# define ERR_LIB_CMP 57
0f113f3e
MC
106
107# define ERR_LIB_USER 128
108
46160e6f 109# if ! OPENSSL_API_3
ed57f7f9
RL
110# define SYSerr(f,r) ERR_raise(ERR_LIB_SYS,(r))
111# endif
c50fd0f9 112# define BNerr(f,r) ERR_raise(ERR_LIB_BN,(r))
ed57f7f9
RL
113# define RSAerr(f,r) ERR_raise(ERR_LIB_RSA,(r))
114# define DHerr(f,r) ERR_raise(ERR_LIB_DH,(r))
115# define EVPerr(f,r) ERR_raise(ERR_LIB_EVP,(r))
116# define BUFerr(f,r) ERR_raise(ERR_LIB_BUF,(r))
117# define OBJerr(f,r) ERR_raise(ERR_LIB_OBJ,(r))
118# define PEMerr(f,r) ERR_raise(ERR_LIB_PEM,(r))
119# define DSAerr(f,r) ERR_raise(ERR_LIB_DSA,(r))
120# define X509err(f,r) ERR_raise(ERR_LIB_X509,(r))
121# define ASN1err(f,r) ERR_raise(ERR_LIB_ASN1,(r))
122# define CONFerr(f,r) ERR_raise(ERR_LIB_CONF,(r))
123# define CRYPTOerr(f,r) ERR_raise(ERR_LIB_CRYPTO,(r))
124# define ECerr(f,r) ERR_raise(ERR_LIB_EC,(r))
125# define SSLerr(f,r) ERR_raise(ERR_LIB_SSL,(r))
126# define BIOerr(f,r) ERR_raise(ERR_LIB_BIO,(r))
127# define PKCS7err(f,r) ERR_raise(ERR_LIB_PKCS7,(r))
128# define X509V3err(f,r) ERR_raise(ERR_LIB_X509V3,(r))
129# define PKCS12err(f,r) ERR_raise(ERR_LIB_PKCS12,(r))
130# define RANDerr(f,r) ERR_raise(ERR_LIB_RAND,(r))
131# define DSOerr(f,r) ERR_raise(ERR_LIB_DSO,(r))
132# define ENGINEerr(f,r) ERR_raise(ERR_LIB_ENGINE,(r))
133# define OCSPerr(f,r) ERR_raise(ERR_LIB_OCSP,(r))
134# define UIerr(f,r) ERR_raise(ERR_LIB_UI,(r))
135# define COMPerr(f,r) ERR_raise(ERR_LIB_COMP,(r))
136# define ECDSAerr(f,r) ERR_raise(ERR_LIB_ECDSA,(r))
137# define ECDHerr(f,r) ERR_raise(ERR_LIB_ECDH,(r))
138# define OSSL_STOREerr(f,r) ERR_raise(ERR_LIB_OSSL_STORE,(r))
139# define FIPSerr(f,r) ERR_raise(ERR_LIB_FIPS,(r))
140# define CMSerr(f,r) ERR_raise(ERR_LIB_CMS,(r))
141# define CRMFerr(f,r) ERR_raise(ERR_LIB_CRMF,(r))
142# define CMPerr(f,r) ERR_raise(ERR_LIB_CMP,(r))
143# define TSerr(f,r) ERR_raise(ERR_LIB_TS,(r))
144# define HMACerr(f,r) ERR_raise(ERR_LIB_HMAC,(r))
145# define CTerr(f,r) ERR_raise(ERR_LIB_CT,(r))
146# define ASYNCerr(f,r) ERR_raise(ERR_LIB_ASYNC,(r))
ed57f7f9
RL
147# define SM2err(f,r) ERR_raise(ERR_LIB_SM2,(r))
148# define ESSerr(f,r) ERR_raise(ERR_LIB_ESS,(r))
149# define PROPerr(f,r) ERR_raise(ERR_LIB_PROP,(r))
150# define PROVerr(f,r) ERR_raise(ERR_LIB_PROV,(r))
0f113f3e 151
446dffa7
RS
152# define ERR_PACK(l,f,r) ( \
153 (((unsigned int)(l) & 0x0FF) << 24L) | \
154 (((unsigned int)(f) & 0xFFF) << 12L) | \
155 (((unsigned int)(r) & 0xFFF) ) )
156# define ERR_GET_LIB(l) (int)(((l) >> 24L) & 0x0FFL)
157# define ERR_GET_FUNC(l) (int)(((l) >> 12L) & 0xFFFL)
158# define ERR_GET_REASON(l) (int)( (l) & 0xFFFL)
036ba500 159# define ERR_FATAL_ERROR(l) (int)( (l) & ERR_R_FATAL)
5277d7cb 160
a80278b0
RS
161# if !OPENSSL_API_3
162# define SYS_F_FOPEN 0
163# define SYS_F_CONNECT 0
164# define SYS_F_GETSERVBYNAME 0
165# define SYS_F_SOCKET 0
166# define SYS_F_IOCTLSOCKET 0
167# define SYS_F_BIND 0
168# define SYS_F_LISTEN 0
169# define SYS_F_ACCEPT 0
170# define SYS_F_WSASTARTUP 0
171# define SYS_F_OPENDIR 0
172# define SYS_F_FREAD 0
173# define SYS_F_GETADDRINFO 0
174# define SYS_F_GETNAMEINFO 0
175# define SYS_F_SETSOCKOPT 0
176# define SYS_F_GETSOCKOPT 0
177# define SYS_F_GETSOCKNAME 0
178# define SYS_F_GETHOSTBYNAME 0
179# define SYS_F_FFLUSH 0
180# define SYS_F_OPEN 0
181# define SYS_F_CLOSE 0
182# define SYS_F_IOCTL 0
183# define SYS_F_STAT 0
184# define SYS_F_FCNTL 0
185# define SYS_F_FSTAT 0
186# define SYS_F_SENDFILE 0
187# endif
188
d02b48c6 189/* reasons */
0f113f3e
MC
190# define ERR_R_SYS_LIB ERR_LIB_SYS/* 2 */
191# define ERR_R_BN_LIB ERR_LIB_BN/* 3 */
192# define ERR_R_RSA_LIB ERR_LIB_RSA/* 4 */
193# define ERR_R_DH_LIB ERR_LIB_DH/* 5 */
194# define ERR_R_EVP_LIB ERR_LIB_EVP/* 6 */
195# define ERR_R_BUF_LIB ERR_LIB_BUF/* 7 */
196# define ERR_R_OBJ_LIB ERR_LIB_OBJ/* 8 */
197# define ERR_R_PEM_LIB ERR_LIB_PEM/* 9 */
198# define ERR_R_DSA_LIB ERR_LIB_DSA/* 10 */
199# define ERR_R_X509_LIB ERR_LIB_X509/* 11 */
200# define ERR_R_ASN1_LIB ERR_LIB_ASN1/* 13 */
0f113f3e 201# define ERR_R_EC_LIB ERR_LIB_EC/* 16 */
0f113f3e
MC
202# define ERR_R_BIO_LIB ERR_LIB_BIO/* 32 */
203# define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
204# define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
0f113f3e 205# define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
c785fd48 206# define ERR_R_UI_LIB ERR_LIB_UI/* 40 */
0f113f3e 207# define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
71a5516d 208# define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
0f113f3e
MC
209
210# define ERR_R_NESTED_ASN1_ERROR 58
0f113f3e 211# define ERR_R_MISSING_ASN1_EOS 63
d02b48c6
RE
212
213/* fatal error */
0f113f3e
MC
214# define ERR_R_FATAL 64
215# define ERR_R_MALLOC_FAILURE (1|ERR_R_FATAL)
216# define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2|ERR_R_FATAL)
217# define ERR_R_PASSED_NULL_PARAMETER (3|ERR_R_FATAL)
218# define ERR_R_INTERNAL_ERROR (4|ERR_R_FATAL)
219# define ERR_R_DISABLED (5|ERR_R_FATAL)
302f7588 220# define ERR_R_INIT_FAIL (6|ERR_R_FATAL)
02e112a8 221# define ERR_R_PASSED_INVALID_ARGUMENT (7)
9a32dcf4 222# define ERR_R_OPERATION_FAIL (8|ERR_R_FATAL)
0f113f3e
MC
223
224/*
225 * 99 is the maximum possible ERR_R_... code, higher values are reserved for
226 * the individual libraries
227 */
d02b48c6 228
0f113f3e
MC
229typedef struct ERR_string_data_st {
230 unsigned long error;
231 const char *string;
232} ERR_STRING_DATA;
d02b48c6 233
89d6aa10 234DEFINE_LHASH_OF(ERR_STRING_DATA);
e6b5c341 235
7c0e20dc
RL
236/* 12 lines and some on an 80 column terminal */
237#define ERR_MAX_DATA_SIZE 1024
238
239/* Building blocks */
240void ERR_new(void);
241void ERR_set_debug(const char *file, int line, const char *func);
242void ERR_set_error(int lib, int reason, const char *fmt, ...);
243void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);
244
586dd674
RL
245# ifndef OPENSSL_NO_ERR
246# define ERR_DBG_FILE OPENSSL_FILE
247# define ERR_DBG_LINE OPENSSL_LINE
248# define ERR_DBG_FUNC OPENSSL_FUNC
249# else
250# define ERR_DBG_FILE NULL
251# define ERR_DBG_LINE 0
252# define ERR_DBG_FUNC NULL
253# endif
254
ed57f7f9 255/* Main error raising functions */
586dd674
RL
256# define ERR_raise(lib, reason) ERR_raise_data((lib),(reason),NULL)
257# define ERR_raise_data \
ed57f7f9 258 (ERR_new(), \
586dd674 259 ERR_set_debug(ERR_DBG_FILE,ERR_DBG_LINE,ERR_DBG_FUNC), \
ed57f7f9
RL
260 ERR_set_error)
261
586dd674 262# if !OPENSSL_API_3
add8c8e9 263/* Backward compatibility */
586dd674 264# define ERR_put_error(lib, func, reason, file, line) \
add8c8e9
RL
265 (ERR_new(), \
266 ERR_set_debug((file), (line), NULL), \
267 ERR_set_error((lib), (reason), NULL))
586dd674 268# endif
add8c8e9 269
0f113f3e 270void ERR_set_error_data(char *data, int flags);
58964a49 271
a14e2d9d 272unsigned long ERR_get_error(void);
0f113f3e
MC
273unsigned long ERR_get_error_line(const char **file, int *line);
274unsigned long ERR_get_error_line_data(const char **file, int *line,
275 const char **data, int *flags);
a14e2d9d 276unsigned long ERR_peek_error(void);
0f113f3e
MC
277unsigned long ERR_peek_error_line(const char **file, int *line);
278unsigned long ERR_peek_error_line_data(const char **file, int *line,
279 const char **data, int *flags);
273db408 280unsigned long ERR_peek_last_error(void);
0f113f3e
MC
281unsigned long ERR_peek_last_error_line(const char **file, int *line);
282unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
283 const char **data, int *flags);
284void ERR_clear_error(void);
285char *ERR_error_string(unsigned long e, char *buf);
e5c84d51 286void ERR_error_string_n(unsigned long e, char *buf, size_t len);
e778802f
BL
287const char *ERR_lib_error_string(unsigned long e);
288const char *ERR_func_error_string(unsigned long e);
289const char *ERR_reason_error_string(unsigned long e);
0f113f3e
MC
290void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
291 void *u);
292# ifndef OPENSSL_NO_STDIO
d02b48c6 293void ERR_print_errors_fp(FILE *fp);
0f113f3e 294# endif
d02b48c6 295void ERR_print_errors(BIO *bp);
78c45722
DSH
296void ERR_add_error_data(int num, ...);
297void ERR_add_error_vdata(int num, va_list args);
52df25cf
RS
298int ERR_load_strings(int lib, ERR_STRING_DATA *str);
299int ERR_load_strings_const(const ERR_STRING_DATA *str);
300int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
69588edb 301int ERR_load_ERR_strings(void);
7b9f8f7f 302
fcd2d5a6 303#if !OPENSSL_API_1_1_0
f672aee4
RS
304# define ERR_load_crypto_strings() \
305 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
6457615a 306# define ERR_free_strings() while(0) continue
f672aee4 307#endif
7b9f8f7f 308
21e00174
RL
309DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
310DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
d02b48c6
RE
311ERR_STATE *ERR_get_state(void);
312
dcba2534 313int ERR_get_next_error_library(void);
58964a49 314
54f64516
RL
315int ERR_set_mark(void);
316int ERR_pop_to_mark(void);
e1a4ff76 317int ERR_clear_last_mark(void);
54f64516 318
0f113f3e 319#ifdef __cplusplus
d02b48c6
RE
320}
321#endif
322
323#endif