]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/err.h
Deprecate XXXerr() macros
[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 28# if !OPENSSL_API_3
06ff79bd 29# ifndef OPENSSL_NO_FILENAMES
586dd674
RL
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
14e275e8
RL
41# if !OPENSSL_API_3 || defined(OSSL_FORCE_ERR_STATE)
42# define ERR_FLAG_MARK 0x01
43# define ERR_FLAG_CLEAR 0x02
54f64516 44
14e275e8
RL
45# define ERR_NUM_ERRORS 16
46struct err_state_st {
0f113f3e
MC
47 int err_flags[ERR_NUM_ERRORS];
48 unsigned long err_buffer[ERR_NUM_ERRORS];
49 char *err_data[ERR_NUM_ERRORS];
10f8b368 50 size_t err_data_size[ERR_NUM_ERRORS];
0f113f3e
MC
51 int err_data_flags[ERR_NUM_ERRORS];
52 const char *err_file[ERR_NUM_ERRORS];
53 int err_line[ERR_NUM_ERRORS];
8a4dc425 54 const char *err_func[ERR_NUM_ERRORS];
0f113f3e 55 int top, bottom;
14e275e8
RL
56};
57# endif
d02b48c6
RE
58
59/* library */
0f113f3e
MC
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
5277d7cb 71/* #define ERR_LIB_METH 12 */
0f113f3e
MC
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
5277d7cb
BM
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 */
0f113f3e
MC
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
71a5516d 94# define ERR_LIB_OSSL_STORE 44
0f113f3e
MC
95# define ERR_LIB_FIPS 45
96# define ERR_LIB_CMS 46
97# define ERR_LIB_TS 47
98# define ERR_LIB_HMAC 48
31a51151 99/* # define ERR_LIB_JPAKE 49 */
3149baf8 100# define ERR_LIB_CT 50
079a1a90 101# define ERR_LIB_ASYNC 51
fe6ec26b
P
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
0f113f3e
MC
108
109# define ERR_LIB_USER 128
110
f6aca23e
RS
111# if 1 || !OPENSSL_API_3
112# define ASN1err(f, r) ERR_raise_data(ERR_LIB_ASN1, (r), NULL)
113# define ASYNCerr(f, r) ERR_raise_data(ERR_LIB_ASYNC, (r), NULL)
114# define BIOerr(f, r) ERR_raise_data(ERR_LIB_BIO, (r), NULL)
115# define BNerr(f, r) ERR_raise_data(ERR_LIB_BN, (r), NULL)
116# define BUFerr(f, r) ERR_raise_data(ERR_LIB_BUF, (r), NULL)
117# define CMPerr(f, r) ERR_raise_data(ERR_LIB_CMP, (r), NULL)
118# define CMSerr(f, r) ERR_raise_data(ERR_LIB_CMS, (r), NULL)
119# define COMPerr(f, r) ERR_raise_data(ERR_LIB_COMP, (r), NULL)
120# define CONFerr(f, r) ERR_raise_data(ERR_LIB_CONF, (r), NULL)
121# define CRMFerr(f, r) ERR_raise_data(ERR_LIB_CRMF, (r), NULL)
122# define CRYPTOerr(f, r) ERR_raise_data(ERR_LIB_CRYPTO, (r), NULL)
123# define CTerr(f, r) ERR_raise_data(ERR_LIB_CT, (r), NULL)
124# define DHerr(f, r) ERR_raise_data(ERR_LIB_DH, (r), NULL)
125# define DSAerr(f, r) ERR_raise_data(ERR_LIB_DSA, (r), NULL)
126# define DSOerr(f, r) ERR_raise_data(ERR_LIB_DSO, (r), NULL)
127# define ECDHerr(f, r) ERR_raise_data(ERR_LIB_ECDH, (r), NULL)
128# define ECDSAerr(f, r) ERR_raise_data(ERR_LIB_ECDSA, (r), NULL)
129# define ECerr(f, r) ERR_raise_data(ERR_LIB_EC, (r), NULL)
130# define ENGINEerr(f, r) ERR_raise_data(ERR_LIB_ENGINE, (r), NULL)
131# define ESSerr(f, r) ERR_raise_data(ERR_LIB_ESS, (r), NULL)
132# define EVPerr(f, r) ERR_raise_data(ERR_LIB_EVP, (r), NULL)
133# define FIPSerr(f, r) ERR_raise_data(ERR_LIB_FIPS, (r), NULL)
134# define HMACerr(f, r) ERR_raise_data(ERR_LIB_HMAC, (r), NULL)
135# define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
136# define OBJerr(f, r) ERR_raise_data(ERR_LIB_OBJ, (r), NULL)
137# define OCSPerr(f, r) ERR_raise_data(ERR_LIB_OCSP, (r), NULL)
138# define OSSL_STOREerr(f, r) ERR_raise_data(ERR_LIB_OSSL_STORE, (r), NULL)
139# define PEMerr(f, r) ERR_raise_data(ERR_LIB_PEM, (r), NULL)
140# define PKCS12err(f, r) ERR_raise_data(ERR_LIB_PKCS12, (r), NULL)
141# define PKCS7err(f, r) ERR_raise_data(ERR_LIB_PKCS7, (r), NULL)
142# define PROPerr(f, r) ERR_raise_data(ERR_LIB_PROP, (r), NULL)
143# define PROVerr(f, r) ERR_raise_data(ERR_LIB_PROV, (r), NULL)
144# define RANDerr(f, r) ERR_raise_data(ERR_LIB_RAND, (r), NULL)
145# define RSAerr(f, r) ERR_raise_data(ERR_LIB_RSA, (r), NULL)
146# define SM2err(f, r) ERR_raise_data(ERR_LIB_SM2, (r), NULL)
147# define SSLerr(f, r) ERR_raise_data(ERR_LIB_SSL, (r), NULL)
148# define SYSerr(f, r) ERR_raise_data(ERR_LIB_SYS, (r), NULL)
149# define TSerr(f, r) ERR_raise_data(ERR_LIB_TS, (r), NULL)
150# define UIerr(f, r) ERR_raise_data(ERR_LIB_UI, (r), NULL)
151# define X509V3err(f, r) ERR_raise_data(ERR_LIB_X509V3, (r), NULL)
152# define X509err(f, r) ERR_raise_data(ERR_LIB_X509, (r), NULL)
ed57f7f9 153# endif
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
ed57f7f9 248/* Main error raising functions */
586dd674
RL
249# define ERR_raise(lib, reason) ERR_raise_data((lib),(reason),NULL)
250# define ERR_raise_data \
ed57f7f9 251 (ERR_new(), \
06ff79bd 252 ERR_set_debug(OPENSSL_FILE,OPENSSL_LINE,OPENSSL_FUNC), \
ed57f7f9
RL
253 ERR_set_error)
254
586dd674 255# if !OPENSSL_API_3
add8c8e9 256/* Backward compatibility */
586dd674 257# define ERR_put_error(lib, func, reason, file, line) \
add8c8e9 258 (ERR_new(), \
06ff79bd 259 ERR_set_debug((file), (line), OPENSSL_FUNC), \
add8c8e9 260 ERR_set_error((lib), (reason), NULL))
586dd674 261# endif
add8c8e9 262
0f113f3e 263void ERR_set_error_data(char *data, int flags);
58964a49 264
a14e2d9d 265unsigned long ERR_get_error(void);
b13342e9
RL
266/*
267 * TODO(3.0) consider if the following three functions should be deprecated.
268 * They all drop the error record from the error queue, so regardless of which
269 * one is used, the rest of the information is lost, making them not so useful.
270 * The recommendation should be to use the peek functions to extract all the
271 * additional data.
272 */
0f113f3e 273unsigned long ERR_get_error_line(const char **file, int *line);
b13342e9
RL
274unsigned long ERR_get_error_func(const char **func);
275unsigned long ERR_get_error_data(const char **data, int *flags);
276unsigned long ERR_get_error_all(const char **file, int *line,
277 const char **func,
278 const char **data, int *flags);
279DEPRECATEDIN_3(unsigned long ERR_get_error_line_data(const char **file,
280 int *line,
281 const char **data,
282 int *flags))
a14e2d9d 283unsigned long ERR_peek_error(void);
0f113f3e 284unsigned long ERR_peek_error_line(const char **file, int *line);
b13342e9
RL
285unsigned long ERR_peek_error_func(const char **func);
286unsigned long ERR_peek_error_data(const char **data, int *flags);
287unsigned long ERR_peek_error_all(const char **file, int *line,
288 const char **func,
289 const char **data, int *flags);
290DEPRECATEDIN_3(unsigned long ERR_peek_error_line_data(const char **file,
291 int *line,
292 const char **data,
293 int *flags))
273db408 294unsigned long ERR_peek_last_error(void);
0f113f3e 295unsigned long ERR_peek_last_error_line(const char **file, int *line);
b13342e9
RL
296unsigned long ERR_peek_last_error_func(const char **func);
297unsigned long ERR_peek_last_error_data(const char **data, int *flags);
298unsigned long ERR_peek_last_error_all(const char **file, int *line,
299 const char **func,
300 const char **data, int *flags);
301DEPRECATEDIN_3(unsigned long ERR_peek_last_error_line_data(const char **file,
302 int *line,
303 const char **data,
304 int *flags))
305
0f113f3e 306void ERR_clear_error(void);
b13342e9 307
0f113f3e 308char *ERR_error_string(unsigned long e, char *buf);
e5c84d51 309void ERR_error_string_n(unsigned long e, char *buf, size_t len);
e778802f 310const char *ERR_lib_error_string(unsigned long e);
b13342e9 311DEPRECATEDIN_3(const char *ERR_func_error_string(unsigned long e))
e778802f 312const char *ERR_reason_error_string(unsigned long e);
b13342e9 313
0f113f3e
MC
314void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
315 void *u);
316# ifndef OPENSSL_NO_STDIO
d02b48c6 317void ERR_print_errors_fp(FILE *fp);
0f113f3e 318# endif
d02b48c6 319void ERR_print_errors(BIO *bp);
b13342e9 320
78c45722
DSH
321void ERR_add_error_data(int num, ...);
322void ERR_add_error_vdata(int num, va_list args);
b13342e9 323
52df25cf
RS
324int ERR_load_strings(int lib, ERR_STRING_DATA *str);
325int ERR_load_strings_const(const ERR_STRING_DATA *str);
326int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
69588edb 327int ERR_load_ERR_strings(void);
7b9f8f7f 328
fcd2d5a6 329#if !OPENSSL_API_1_1_0
f672aee4
RS
330# define ERR_load_crypto_strings() \
331 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
6457615a 332# define ERR_free_strings() while(0) continue
f672aee4 333#endif
7b9f8f7f 334
21e00174
RL
335DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
336DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
e5d4233f 337DEPRECATEDIN_3(ERR_STATE *ERR_get_state(void))
d02b48c6 338
dcba2534 339int ERR_get_next_error_library(void);
58964a49 340
54f64516
RL
341int ERR_set_mark(void);
342int ERR_pop_to_mark(void);
e1a4ff76 343int ERR_clear_last_mark(void);
54f64516 344
0f113f3e 345#ifdef __cplusplus
d02b48c6
RE
346}
347#endif
348
349#endif