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