]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/err.h
Certificate Management Protocol (CMP, RFC 4210) extension to OpenSSL
[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
MC
28# ifndef OPENSSL_NO_ERR
29# define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,d,e)
30# else
31# define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,NULL,0)
32# endif
d02b48c6 33
0f113f3e 34# include <errno.h>
d02b48c6 35
0f113f3e
MC
36# define ERR_TXT_MALLOCED 0x01
37# define ERR_TXT_STRING 0x02
58964a49 38
0f113f3e 39# define ERR_FLAG_MARK 0x01
94dc53a3 40# define ERR_FLAG_CLEAR 0x02
54f64516 41
0f113f3e
MC
42# define ERR_NUM_ERRORS 16
43typedef struct err_state_st {
0f113f3e
MC
44 int err_flags[ERR_NUM_ERRORS];
45 unsigned long err_buffer[ERR_NUM_ERRORS];
46 char *err_data[ERR_NUM_ERRORS];
47 int err_data_flags[ERR_NUM_ERRORS];
48 const char *err_file[ERR_NUM_ERRORS];
49 int err_line[ERR_NUM_ERRORS];
50 int top, bottom;
51} ERR_STATE;
d02b48c6
RE
52
53/* library */
0f113f3e
MC
54# define ERR_LIB_NONE 1
55# define ERR_LIB_SYS 2
56# define ERR_LIB_BN 3
57# define ERR_LIB_RSA 4
58# define ERR_LIB_DH 5
59# define ERR_LIB_EVP 6
60# define ERR_LIB_BUF 7
61# define ERR_LIB_OBJ 8
62# define ERR_LIB_PEM 9
63# define ERR_LIB_DSA 10
64# define ERR_LIB_X509 11
5277d7cb 65/* #define ERR_LIB_METH 12 */
0f113f3e
MC
66# define ERR_LIB_ASN1 13
67# define ERR_LIB_CONF 14
68# define ERR_LIB_CRYPTO 15
69# define ERR_LIB_EC 16
70# define ERR_LIB_SSL 20
5277d7cb
BM
71/* #define ERR_LIB_SSL23 21 */
72/* #define ERR_LIB_SSL2 22 */
73/* #define ERR_LIB_SSL3 23 */
74/* #define ERR_LIB_RSAREF 30 */
75/* #define ERR_LIB_PROXY 31 */
0f113f3e
MC
76# define ERR_LIB_BIO 32
77# define ERR_LIB_PKCS7 33
78# define ERR_LIB_X509V3 34
79# define ERR_LIB_PKCS12 35
80# define ERR_LIB_RAND 36
81# define ERR_LIB_DSO 37
82# define ERR_LIB_ENGINE 38
83# define ERR_LIB_OCSP 39
84# define ERR_LIB_UI 40
85# define ERR_LIB_COMP 41
86# define ERR_LIB_ECDSA 42
87# define ERR_LIB_ECDH 43
71a5516d 88# define ERR_LIB_OSSL_STORE 44
0f113f3e
MC
89# define ERR_LIB_FIPS 45
90# define ERR_LIB_CMS 46
91# define ERR_LIB_TS 47
92# define ERR_LIB_HMAC 48
31a51151 93/* # define ERR_LIB_JPAKE 49 */
3149baf8 94# define ERR_LIB_CT 50
079a1a90 95# define ERR_LIB_ASYNC 51
3e30fa0a 96# define ERR_LIB_KDF 52
3d328a44 97# define ERR_LIB_SM2 53
e85d19c6 98# define ERR_LIB_ESS 54
1bdbdaff 99# define ERR_LIB_PROP 55
a61b7f2f 100# define ERR_LIB_CRMF 56
6caf7f3a 101# define ERR_LIB_PROV 57
8869ad4a 102# define ERR_LIB_CMP 58
0f113f3e
MC
103
104# define ERR_LIB_USER 128
105
3ba84717
DW
106# define SYSerr(f,r) ERR_PUT_error(ERR_LIB_SYS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
107# define BNerr(f,r) ERR_PUT_error(ERR_LIB_BN,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
108# define RSAerr(f,r) ERR_PUT_error(ERR_LIB_RSA,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
109# define DHerr(f,r) ERR_PUT_error(ERR_LIB_DH,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
110# define EVPerr(f,r) ERR_PUT_error(ERR_LIB_EVP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
111# define BUFerr(f,r) ERR_PUT_error(ERR_LIB_BUF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
112# define OBJerr(f,r) ERR_PUT_error(ERR_LIB_OBJ,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
113# define PEMerr(f,r) ERR_PUT_error(ERR_LIB_PEM,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
114# define DSAerr(f,r) ERR_PUT_error(ERR_LIB_DSA,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
115# define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
116# define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
117# define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
118# define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
119# define ECerr(f,r) ERR_PUT_error(ERR_LIB_EC,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
120# define SSLerr(f,r) ERR_PUT_error(ERR_LIB_SSL,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
121# define BIOerr(f,r) ERR_PUT_error(ERR_LIB_BIO,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
122# define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
123# define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
124# define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
125# define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
126# define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
127# define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
128# define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
129# define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
130# define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
131# define ECDSAerr(f,r) ERR_PUT_error(ERR_LIB_ECDSA,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
132# define ECDHerr(f,r) ERR_PUT_error(ERR_LIB_ECDH,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
71a5516d 133# define OSSL_STOREerr(f,r) ERR_PUT_error(ERR_LIB_OSSL_STORE,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
3ba84717
DW
134# define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
135# define CMSerr(f,r) ERR_PUT_error(ERR_LIB_CMS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
a61b7f2f 136# define CRMFerr(f,r) ERR_PUT_error(ERR_LIB_CRMF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
8869ad4a 137# define CMPerr(f,r) ERR_PUT_error(ERR_LIB_CMP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
3ba84717
DW
138# define TSerr(f,r) ERR_PUT_error(ERR_LIB_TS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
139# define HMACerr(f,r) ERR_PUT_error(ERR_LIB_HMAC,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
3ba84717
DW
140# define CTerr(f,r) ERR_PUT_error(ERR_LIB_CT,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
141# define ASYNCerr(f,r) ERR_PUT_error(ERR_LIB_ASYNC,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
3e30fa0a 142# define KDFerr(f,r) ERR_PUT_error(ERR_LIB_KDF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
3d328a44 143# define SM2err(f,r) ERR_PUT_error(ERR_LIB_SM2,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
e85d19c6 144# define ESSerr(f,r) ERR_PUT_error(ERR_LIB_ESS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
1bdbdaff 145# define PROPerr(f,r) ERR_PUT_error(ERR_LIB_PROP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
6caf7f3a 146# define PROVerr(f,r) ERR_PUT_error(ERR_LIB_PROV,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
0f113f3e 147
446dffa7
RS
148# define ERR_PACK(l,f,r) ( \
149 (((unsigned int)(l) & 0x0FF) << 24L) | \
150 (((unsigned int)(f) & 0xFFF) << 12L) | \
151 (((unsigned int)(r) & 0xFFF) ) )
152# define ERR_GET_LIB(l) (int)(((l) >> 24L) & 0x0FFL)
153# define ERR_GET_FUNC(l) (int)(((l) >> 12L) & 0xFFFL)
154# define ERR_GET_REASON(l) (int)( (l) & 0xFFFL)
036ba500 155# define ERR_FATAL_ERROR(l) (int)( (l) & ERR_R_FATAL)
5277d7cb 156
657e60fa 157/* OS functions */
0f113f3e
MC
158# define SYS_F_FOPEN 1
159# define SYS_F_CONNECT 2
160# define SYS_F_GETSERVBYNAME 3
161# define SYS_F_SOCKET 4
162# define SYS_F_IOCTLSOCKET 5
163# define SYS_F_BIND 6
164# define SYS_F_LISTEN 7
165# define SYS_F_ACCEPT 8
166# define SYS_F_WSASTARTUP 9/* Winsock stuff */
167# define SYS_F_OPENDIR 10
168# define SYS_F_FREAD 11
83be2778
RL
169# define SYS_F_GETADDRINFO 12
170# define SYS_F_GETNAMEINFO 13
d33b215b
RL
171# define SYS_F_SETSOCKOPT 14
172# define SYS_F_GETSOCKOPT 15
173# define SYS_F_GETSOCKNAME 16
c86d1f19 174# define SYS_F_GETHOSTBYNAME 17
595b2a42 175# define SYS_F_FFLUSH 18
619eb33a
RL
176# define SYS_F_OPEN 19
177# define SYS_F_CLOSE 20
178# define SYS_F_IOCTL 21
970f467a 179# define SYS_F_STAT 22
354ab365 180# define SYS_F_FCNTL 23
c7d5ea26 181# define SYS_F_FSTAT 24
7c3a7561 182# define SYS_F_SENDFILE 25
5277d7cb 183
d02b48c6 184/* reasons */
0f113f3e
MC
185# define ERR_R_SYS_LIB ERR_LIB_SYS/* 2 */
186# define ERR_R_BN_LIB ERR_LIB_BN/* 3 */
187# define ERR_R_RSA_LIB ERR_LIB_RSA/* 4 */
188# define ERR_R_DH_LIB ERR_LIB_DH/* 5 */
189# define ERR_R_EVP_LIB ERR_LIB_EVP/* 6 */
190# define ERR_R_BUF_LIB ERR_LIB_BUF/* 7 */
191# define ERR_R_OBJ_LIB ERR_LIB_OBJ/* 8 */
192# define ERR_R_PEM_LIB ERR_LIB_PEM/* 9 */
193# define ERR_R_DSA_LIB ERR_LIB_DSA/* 10 */
194# define ERR_R_X509_LIB ERR_LIB_X509/* 11 */
195# define ERR_R_ASN1_LIB ERR_LIB_ASN1/* 13 */
0f113f3e 196# define ERR_R_EC_LIB ERR_LIB_EC/* 16 */
0f113f3e
MC
197# define ERR_R_BIO_LIB ERR_LIB_BIO/* 32 */
198# define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
199# define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
0f113f3e 200# define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
c785fd48 201# define ERR_R_UI_LIB ERR_LIB_UI/* 40 */
0f113f3e 202# define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
71a5516d 203# define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
0f113f3e
MC
204
205# define ERR_R_NESTED_ASN1_ERROR 58
0f113f3e 206# define ERR_R_MISSING_ASN1_EOS 63
d02b48c6
RE
207
208/* fatal error */
0f113f3e
MC
209# define ERR_R_FATAL 64
210# define ERR_R_MALLOC_FAILURE (1|ERR_R_FATAL)
211# define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2|ERR_R_FATAL)
212# define ERR_R_PASSED_NULL_PARAMETER (3|ERR_R_FATAL)
213# define ERR_R_INTERNAL_ERROR (4|ERR_R_FATAL)
214# define ERR_R_DISABLED (5|ERR_R_FATAL)
302f7588 215# define ERR_R_INIT_FAIL (6|ERR_R_FATAL)
02e112a8 216# define ERR_R_PASSED_INVALID_ARGUMENT (7)
9a32dcf4 217# define ERR_R_OPERATION_FAIL (8|ERR_R_FATAL)
0f113f3e
MC
218
219/*
220 * 99 is the maximum possible ERR_R_... code, higher values are reserved for
221 * the individual libraries
222 */
d02b48c6 223
0f113f3e
MC
224typedef struct ERR_string_data_st {
225 unsigned long error;
226 const char *string;
227} ERR_STRING_DATA;
d02b48c6 228
89d6aa10 229DEFINE_LHASH_OF(ERR_STRING_DATA);
e6b5c341 230
0f113f3e
MC
231void ERR_put_error(int lib, int func, int reason, const char *file, int line);
232void ERR_set_error_data(char *data, int flags);
58964a49 233
a14e2d9d 234unsigned long ERR_get_error(void);
0f113f3e
MC
235unsigned long ERR_get_error_line(const char **file, int *line);
236unsigned long ERR_get_error_line_data(const char **file, int *line,
237 const char **data, int *flags);
a14e2d9d 238unsigned long ERR_peek_error(void);
0f113f3e
MC
239unsigned long ERR_peek_error_line(const char **file, int *line);
240unsigned long ERR_peek_error_line_data(const char **file, int *line,
241 const char **data, int *flags);
273db408 242unsigned long ERR_peek_last_error(void);
0f113f3e
MC
243unsigned long ERR_peek_last_error_line(const char **file, int *line);
244unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
245 const char **data, int *flags);
246void ERR_clear_error(void);
247char *ERR_error_string(unsigned long e, char *buf);
e5c84d51 248void ERR_error_string_n(unsigned long e, char *buf, size_t len);
e778802f
BL
249const char *ERR_lib_error_string(unsigned long e);
250const char *ERR_func_error_string(unsigned long e);
251const char *ERR_reason_error_string(unsigned long e);
0f113f3e
MC
252void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
253 void *u);
254# ifndef OPENSSL_NO_STDIO
d02b48c6 255void ERR_print_errors_fp(FILE *fp);
0f113f3e 256# endif
d02b48c6 257void ERR_print_errors(BIO *bp);
78c45722
DSH
258void ERR_add_error_data(int num, ...);
259void ERR_add_error_vdata(int num, va_list args);
52df25cf
RS
260int ERR_load_strings(int lib, ERR_STRING_DATA *str);
261int ERR_load_strings_const(const ERR_STRING_DATA *str);
262int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
69588edb 263int ERR_load_ERR_strings(void);
7b9f8f7f 264
fcd2d5a6 265#if !OPENSSL_API_1_1_0
f672aee4
RS
266# define ERR_load_crypto_strings() \
267 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
6457615a 268# define ERR_free_strings() while(0) continue
f672aee4 269#endif
7b9f8f7f 270
21e00174
RL
271DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
272DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
d02b48c6
RE
273ERR_STATE *ERR_get_state(void);
274
dcba2534 275int ERR_get_next_error_library(void);
58964a49 276
54f64516
RL
277int ERR_set_mark(void);
278int ERR_pop_to_mark(void);
e1a4ff76 279int ERR_clear_last_mark(void);
54f64516 280
0f113f3e 281#ifdef __cplusplus
d02b48c6
RE
282}
283#endif
284
285#endif