Add the STORE module
[openssl.git] / include / openssl / err.h
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
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
8  */
9
10 #ifndef HEADER_ERR_H
11 # define HEADER_ERR_H
12
13 # include <openssl/e_os2.h>
14
15 # ifndef OPENSSL_NO_STDIO
16 #  include <stdio.h>
17 #  include <stdlib.h>
18 # endif
19
20 # include <openssl/ossl_typ.h>
21 # include <openssl/bio.h>
22 # include <openssl/lhash.h>
23
24 #ifdef  __cplusplus
25 extern "C" {
26 #endif
27
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
33
34 # include <errno.h>
35
36 # define ERR_TXT_MALLOCED        0x01
37 # define ERR_TXT_STRING          0x02
38
39 # define ERR_FLAG_MARK           0x01
40
41 # define ERR_NUM_ERRORS  16
42 typedef struct err_state_st {
43     int err_flags[ERR_NUM_ERRORS];
44     unsigned long err_buffer[ERR_NUM_ERRORS];
45     char *err_data[ERR_NUM_ERRORS];
46     int err_data_flags[ERR_NUM_ERRORS];
47     const char *err_file[ERR_NUM_ERRORS];
48     int err_line[ERR_NUM_ERRORS];
49     int top, bottom;
50 } ERR_STATE;
51
52 /* library */
53 # define ERR_LIB_NONE            1
54 # define ERR_LIB_SYS             2
55 # define ERR_LIB_BN              3
56 # define ERR_LIB_RSA             4
57 # define ERR_LIB_DH              5
58 # define ERR_LIB_EVP             6
59 # define ERR_LIB_BUF             7
60 # define ERR_LIB_OBJ             8
61 # define ERR_LIB_PEM             9
62 # define ERR_LIB_DSA             10
63 # define ERR_LIB_X509            11
64 /* #define ERR_LIB_METH         12 */
65 # define ERR_LIB_ASN1            13
66 # define ERR_LIB_CONF            14
67 # define ERR_LIB_CRYPTO          15
68 # define ERR_LIB_EC              16
69 # define ERR_LIB_SSL             20
70 /* #define ERR_LIB_SSL23        21 */
71 /* #define ERR_LIB_SSL2         22 */
72 /* #define ERR_LIB_SSL3         23 */
73 /* #define ERR_LIB_RSAREF       30 */
74 /* #define ERR_LIB_PROXY        31 */
75 # define ERR_LIB_BIO             32
76 # define ERR_LIB_PKCS7           33
77 # define ERR_LIB_X509V3          34
78 # define ERR_LIB_PKCS12          35
79 # define ERR_LIB_RAND            36
80 # define ERR_LIB_DSO             37
81 # define ERR_LIB_ENGINE          38
82 # define ERR_LIB_OCSP            39
83 # define ERR_LIB_UI              40
84 # define ERR_LIB_COMP            41
85 # define ERR_LIB_ECDSA           42
86 # define ERR_LIB_ECDH            43
87 # define ERR_LIB_OSSL_STORE      44
88 # define ERR_LIB_FIPS            45
89 # define ERR_LIB_CMS             46
90 # define ERR_LIB_TS              47
91 # define ERR_LIB_HMAC            48
92 /* # define ERR_LIB_JPAKE       49 */
93 # define ERR_LIB_CT              50
94 # define ERR_LIB_ASYNC           51
95 # define ERR_LIB_KDF             52
96
97 # define ERR_LIB_USER            128
98
99 # define SYSerr(f,r)  ERR_PUT_error(ERR_LIB_SYS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
100 # define BNerr(f,r)   ERR_PUT_error(ERR_LIB_BN,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
101 # define RSAerr(f,r)  ERR_PUT_error(ERR_LIB_RSA,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
102 # define DHerr(f,r)   ERR_PUT_error(ERR_LIB_DH,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
103 # define EVPerr(f,r)  ERR_PUT_error(ERR_LIB_EVP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
104 # define BUFerr(f,r)  ERR_PUT_error(ERR_LIB_BUF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
105 # define OBJerr(f,r)  ERR_PUT_error(ERR_LIB_OBJ,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
106 # define PEMerr(f,r)  ERR_PUT_error(ERR_LIB_PEM,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
107 # define DSAerr(f,r)  ERR_PUT_error(ERR_LIB_DSA,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
108 # define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
109 # define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
110 # define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
111 # define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
112 # define ECerr(f,r)   ERR_PUT_error(ERR_LIB_EC,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
113 # define SSLerr(f,r)  ERR_PUT_error(ERR_LIB_SSL,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
114 # define BIOerr(f,r)  ERR_PUT_error(ERR_LIB_BIO,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
115 # define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
116 # define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
117 # define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
118 # define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
119 # define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
120 # define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
121 # define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
122 # define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
123 # define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
124 # define ECDSAerr(f,r)  ERR_PUT_error(ERR_LIB_ECDSA,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
125 # define ECDHerr(f,r)  ERR_PUT_error(ERR_LIB_ECDH,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
126 # define OSSL_STOREerr(f,r) ERR_PUT_error(ERR_LIB_OSSL_STORE,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
127 # define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
128 # define CMSerr(f,r) ERR_PUT_error(ERR_LIB_CMS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
129 # define TSerr(f,r) ERR_PUT_error(ERR_LIB_TS,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
130 # define HMACerr(f,r) ERR_PUT_error(ERR_LIB_HMAC,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
131 # define CTerr(f,r) ERR_PUT_error(ERR_LIB_CT,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
132 # define ASYNCerr(f,r) ERR_PUT_error(ERR_LIB_ASYNC,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
133 # define KDFerr(f,r) ERR_PUT_error(ERR_LIB_KDF,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
134 # define OSSL_STOREerr(f,r) ERR_PUT_error(ERR_LIB_OSSL_STORE,(f),(r),OPENSSL_FILE,OPENSSL_LINE)
135
136 # define ERR_PACK(l,f,r) ( \
137         (((unsigned int)(l) & 0x0FF) << 24L) | \
138         (((unsigned int)(f) & 0xFFF) << 12L) | \
139         (((unsigned int)(r) & 0xFFF)       ) )
140 # define ERR_GET_LIB(l)          (int)(((l) >> 24L) & 0x0FFL)
141 # define ERR_GET_FUNC(l)         (int)(((l) >> 12L) & 0xFFFL)
142 # define ERR_GET_REASON(l)       (int)( (l)         & 0xFFFL)
143 # define ERR_FATAL_ERROR(l)      (int)( (l)         & ERR_R_FATAL)
144
145 /* OS functions */
146 # define SYS_F_FOPEN             1
147 # define SYS_F_CONNECT           2
148 # define SYS_F_GETSERVBYNAME     3
149 # define SYS_F_SOCKET            4
150 # define SYS_F_IOCTLSOCKET       5
151 # define SYS_F_BIND              6
152 # define SYS_F_LISTEN            7
153 # define SYS_F_ACCEPT            8
154 # define SYS_F_WSASTARTUP        9/* Winsock stuff */
155 # define SYS_F_OPENDIR           10
156 # define SYS_F_FREAD             11
157 # define SYS_F_GETADDRINFO       12
158 # define SYS_F_GETNAMEINFO       13
159 # define SYS_F_SETSOCKOPT        14
160 # define SYS_F_GETSOCKOPT        15
161 # define SYS_F_GETSOCKNAME       16
162 # define SYS_F_GETHOSTBYNAME     17
163 # define SYS_F_FFLUSH            18
164 # define SYS_F_OPEN              19
165 # define SYS_F_CLOSE             20
166 # define SYS_F_IOCTL             21
167
168 /* reasons */
169 # define ERR_R_SYS_LIB   ERR_LIB_SYS/* 2 */
170 # define ERR_R_BN_LIB    ERR_LIB_BN/* 3 */
171 # define ERR_R_RSA_LIB   ERR_LIB_RSA/* 4 */
172 # define ERR_R_DH_LIB    ERR_LIB_DH/* 5 */
173 # define ERR_R_EVP_LIB   ERR_LIB_EVP/* 6 */
174 # define ERR_R_BUF_LIB   ERR_LIB_BUF/* 7 */
175 # define ERR_R_OBJ_LIB   ERR_LIB_OBJ/* 8 */
176 # define ERR_R_PEM_LIB   ERR_LIB_PEM/* 9 */
177 # define ERR_R_DSA_LIB   ERR_LIB_DSA/* 10 */
178 # define ERR_R_X509_LIB  ERR_LIB_X509/* 11 */
179 # define ERR_R_ASN1_LIB  ERR_LIB_ASN1/* 13 */
180 # define ERR_R_EC_LIB    ERR_LIB_EC/* 16 */
181 # define ERR_R_BIO_LIB   ERR_LIB_BIO/* 32 */
182 # define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
183 # define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
184 # define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
185 # define ERR_R_UI_LIB    ERR_LIB_UI/* 40 */
186 # define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
187 # define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
188
189 # define ERR_R_NESTED_ASN1_ERROR                 58
190 # define ERR_R_MISSING_ASN1_EOS                  63
191
192 /* fatal error */
193 # define ERR_R_FATAL                             64
194 # define ERR_R_MALLOC_FAILURE                    (1|ERR_R_FATAL)
195 # define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (2|ERR_R_FATAL)
196 # define ERR_R_PASSED_NULL_PARAMETER             (3|ERR_R_FATAL)
197 # define ERR_R_INTERNAL_ERROR                    (4|ERR_R_FATAL)
198 # define ERR_R_DISABLED                          (5|ERR_R_FATAL)
199 # define ERR_R_INIT_FAIL                         (6|ERR_R_FATAL)
200 # define ERR_R_PASSED_INVALID_ARGUMENT           (7)
201 # define ERR_R_OPERATION_FAIL                    (8|ERR_R_FATAL)
202
203 /*
204  * 99 is the maximum possible ERR_R_... code, higher values are reserved for
205  * the individual libraries
206  */
207
208 typedef struct ERR_string_data_st {
209     unsigned long error;
210     const char *string;
211 } ERR_STRING_DATA;
212
213 DEFINE_LHASH_OF(ERR_STRING_DATA);
214
215 void ERR_put_error(int lib, int func, int reason, const char *file, int line);
216 void ERR_set_error_data(char *data, int flags);
217
218 unsigned long ERR_get_error(void);
219 unsigned long ERR_get_error_line(const char **file, int *line);
220 unsigned long ERR_get_error_line_data(const char **file, int *line,
221                                       const char **data, int *flags);
222 unsigned long ERR_peek_error(void);
223 unsigned long ERR_peek_error_line(const char **file, int *line);
224 unsigned long ERR_peek_error_line_data(const char **file, int *line,
225                                        const char **data, int *flags);
226 unsigned long ERR_peek_last_error(void);
227 unsigned long ERR_peek_last_error_line(const char **file, int *line);
228 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
229                                             const char **data, int *flags);
230 void ERR_clear_error(void);
231 char *ERR_error_string(unsigned long e, char *buf);
232 void ERR_error_string_n(unsigned long e, char *buf, size_t len);
233 const char *ERR_lib_error_string(unsigned long e);
234 const char *ERR_func_error_string(unsigned long e);
235 const char *ERR_reason_error_string(unsigned long e);
236 void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
237                          void *u);
238 # ifndef OPENSSL_NO_STDIO
239 void ERR_print_errors_fp(FILE *fp);
240 # endif
241 void ERR_print_errors(BIO *bp);
242 void ERR_add_error_data(int num, ...);
243 void ERR_add_error_vdata(int num, va_list args);
244 int ERR_load_strings(int lib, ERR_STRING_DATA *str);
245 int ERR_load_strings_const(const ERR_STRING_DATA *str);
246 int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
247 int ERR_load_ERR_strings(void);
248
249 #if OPENSSL_API_COMPAT < 0x10100000L
250 # define ERR_load_crypto_strings() \
251     OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
252 # define ERR_free_strings() while(0) continue
253 #endif
254
255 DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
256 DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
257 ERR_STATE *ERR_get_state(void);
258
259 int ERR_get_next_error_library(void);
260
261 int ERR_set_mark(void);
262 int ERR_pop_to_mark(void);
263
264 #ifdef  __cplusplus
265 }
266 #endif
267
268 #endif