/src/boringssl/include/openssl/err.h
Line | Count | Source (jump to first uncovered line) |
1 | | /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) |
2 | | * All rights reserved. |
3 | | * |
4 | | * This package is an SSL implementation written |
5 | | * by Eric Young (eay@cryptsoft.com). |
6 | | * The implementation was written so as to conform with Netscapes SSL. |
7 | | * |
8 | | * This library is free for commercial and non-commercial use as long as |
9 | | * the following conditions are aheared to. The following conditions |
10 | | * apply to all code found in this distribution, be it the RC4, RSA, |
11 | | * lhash, DES, etc., code; not just the SSL code. The SSL documentation |
12 | | * included with this distribution is covered by the same copyright terms |
13 | | * except that the holder is Tim Hudson (tjh@cryptsoft.com). |
14 | | * |
15 | | * Copyright remains Eric Young's, and as such any Copyright notices in |
16 | | * the code are not to be removed. |
17 | | * If this package is used in a product, Eric Young should be given attribution |
18 | | * as the author of the parts of the library used. |
19 | | * This can be in the form of a textual message at program startup or |
20 | | * in documentation (online or textual) provided with the package. |
21 | | * |
22 | | * Redistribution and use in source and binary forms, with or without |
23 | | * modification, are permitted provided that the following conditions |
24 | | * are met: |
25 | | * 1. Redistributions of source code must retain the copyright |
26 | | * notice, this list of conditions and the following disclaimer. |
27 | | * 2. Redistributions in binary form must reproduce the above copyright |
28 | | * notice, this list of conditions and the following disclaimer in the |
29 | | * documentation and/or other materials provided with the distribution. |
30 | | * 3. All advertising materials mentioning features or use of this software |
31 | | * must display the following acknowledgement: |
32 | | * "This product includes cryptographic software written by |
33 | | * Eric Young (eay@cryptsoft.com)" |
34 | | * The word 'cryptographic' can be left out if the rouines from the library |
35 | | * being used are not cryptographic related :-). |
36 | | * 4. If you include any Windows specific code (or a derivative thereof) from |
37 | | * the apps directory (application code) you must include an acknowledgement: |
38 | | * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" |
39 | | * |
40 | | * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND |
41 | | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
42 | | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
43 | | * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
44 | | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
45 | | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
46 | | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
47 | | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
48 | | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
49 | | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
50 | | * SUCH DAMAGE. |
51 | | * |
52 | | * The licence and distribution terms for any publically available version or |
53 | | * derivative of this code cannot be changed. i.e. this code cannot simply be |
54 | | * copied and put under another distribution licence |
55 | | * [including the GNU Public Licence.] |
56 | | */ |
57 | | /* ==================================================================== |
58 | | * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved. |
59 | | * |
60 | | * Redistribution and use in source and binary forms, with or without |
61 | | * modification, are permitted provided that the following conditions |
62 | | * are met: |
63 | | * |
64 | | * 1. Redistributions of source code must retain the above copyright |
65 | | * notice, this list of conditions and the following disclaimer. |
66 | | * |
67 | | * 2. Redistributions in binary form must reproduce the above copyright |
68 | | * notice, this list of conditions and the following disclaimer in |
69 | | * the documentation and/or other materials provided with the |
70 | | * distribution. |
71 | | * |
72 | | * 3. All advertising materials mentioning features or use of this |
73 | | * software must display the following acknowledgment: |
74 | | * "This product includes software developed by the OpenSSL Project |
75 | | * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" |
76 | | * |
77 | | * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to |
78 | | * endorse or promote products derived from this software without |
79 | | * prior written permission. For written permission, please contact |
80 | | * openssl-core@openssl.org. |
81 | | * |
82 | | * 5. Products derived from this software may not be called "OpenSSL" |
83 | | * nor may "OpenSSL" appear in their names without prior written |
84 | | * permission of the OpenSSL Project. |
85 | | * |
86 | | * 6. Redistributions of any form whatsoever must retain the following |
87 | | * acknowledgment: |
88 | | * "This product includes software developed by the OpenSSL Project |
89 | | * for use in the OpenSSL Toolkit (http://www.openssl.org/)" |
90 | | * |
91 | | * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY |
92 | | * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
93 | | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
94 | | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR |
95 | | * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
96 | | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
97 | | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
98 | | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
99 | | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
100 | | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
101 | | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
102 | | * OF THE POSSIBILITY OF SUCH DAMAGE. |
103 | | * ==================================================================== |
104 | | * |
105 | | * This product includes cryptographic software written by Eric Young |
106 | | * (eay@cryptsoft.com). This product includes software written by Tim |
107 | | * Hudson (tjh@cryptsoft.com). */ |
108 | | |
109 | | #ifndef OPENSSL_HEADER_ERR_H |
110 | | #define OPENSSL_HEADER_ERR_H |
111 | | |
112 | | #include <stdio.h> |
113 | | |
114 | | #include <openssl/base.h> |
115 | | |
116 | | #if defined(__cplusplus) |
117 | | extern "C" { |
118 | | #endif |
119 | | |
120 | | |
121 | | // Error queue handling functions. |
122 | | // |
123 | | // Errors in OpenSSL are generally signaled by the return value of a function. |
124 | | // When a function fails it may add an entry to a per-thread error queue, |
125 | | // which is managed by the functions in this header. |
126 | | // |
127 | | // Each error contains: |
128 | | // 1) The library (i.e. ec, pem, rsa) which created it. |
129 | | // 2) The file and line number of the call that added the error. |
130 | | // 3) A pointer to some error specific data, which may be NULL. |
131 | | // |
132 | | // The library identifier and reason code are packed in a uint32_t and there |
133 | | // exist various functions for unpacking it. |
134 | | // |
135 | | // The typical behaviour is that an error will occur deep in a call queue and |
136 | | // that code will push an error onto the error queue. As the error queue |
137 | | // unwinds, other functions will push their own errors. Thus, the "least |
138 | | // recent" error is the most specific and the other errors will provide a |
139 | | // backtrace of sorts. |
140 | | |
141 | | |
142 | | // Startup and shutdown. |
143 | | |
144 | | // ERR_load_BIO_strings does nothing. |
145 | | // |
146 | | // TODO(fork): remove. libjingle calls this. |
147 | | OPENSSL_EXPORT void ERR_load_BIO_strings(void); |
148 | | |
149 | | // ERR_load_ERR_strings does nothing. |
150 | | OPENSSL_EXPORT void ERR_load_ERR_strings(void); |
151 | | |
152 | | // ERR_load_crypto_strings does nothing. |
153 | | OPENSSL_EXPORT void ERR_load_crypto_strings(void); |
154 | | |
155 | | // ERR_load_RAND_strings does nothing. |
156 | | OPENSSL_EXPORT void ERR_load_RAND_strings(void); |
157 | | |
158 | | // ERR_free_strings does nothing. |
159 | | OPENSSL_EXPORT void ERR_free_strings(void); |
160 | | |
161 | | |
162 | | // Reading and formatting errors. |
163 | | |
164 | | // ERR_GET_LIB returns the library code for the error. This is one of |
165 | | // the |ERR_LIB_*| values. |
166 | 0 | OPENSSL_INLINE int ERR_GET_LIB(uint32_t packed_error) { |
167 | 0 | return (int)((packed_error >> 24) & 0xff); |
168 | 0 | } Unexecuted instantiation: ERR_GET_LIB Unexecuted instantiation: a_int.c:ERR_GET_LIB Unexecuted instantiation: asn1_lib.c:ERR_GET_LIB Unexecuted instantiation: bcm.c:ERR_GET_LIB Unexecuted instantiation: cbb.c:ERR_GET_LIB Unexecuted instantiation: cbs.c:ERR_GET_LIB Unexecuted instantiation: convert.c:ERR_GET_LIB Unexecuted instantiation: digest_extra.c:ERR_GET_LIB Unexecuted instantiation: dsa.c:ERR_GET_LIB Unexecuted instantiation: dsa_asn1.c:ERR_GET_LIB Unexecuted instantiation: e_aesctrhmac.c:ERR_GET_LIB Unexecuted instantiation: e_aesgcmsiv.c:ERR_GET_LIB Unexecuted instantiation: e_chacha20poly1305.c:ERR_GET_LIB Unexecuted instantiation: e_tls.c:ERR_GET_LIB Unexecuted instantiation: ecdh_extra.c:ERR_GET_LIB Unexecuted instantiation: ecdsa_asn1.c:ERR_GET_LIB Unexecuted instantiation: engine.c:ERR_GET_LIB Unexecuted instantiation: err_data.c:ERR_GET_LIB Unexecuted instantiation: evp.c:ERR_GET_LIB Unexecuted instantiation: evp_ctx.c:ERR_GET_LIB Unexecuted instantiation: ex_data.c:ERR_GET_LIB Unexecuted instantiation: file.c:ERR_GET_LIB Unexecuted instantiation: mem.c:ERR_GET_LIB Unexecuted instantiation: obj.c:ERR_GET_LIB Unexecuted instantiation: p_dh_asn1.c:ERR_GET_LIB Unexecuted instantiation: p_dsa_asn1.c:ERR_GET_LIB Unexecuted instantiation: p_ec.c:ERR_GET_LIB Unexecuted instantiation: p_ec_asn1.c:ERR_GET_LIB Unexecuted instantiation: p_ed25519.c:ERR_GET_LIB Unexecuted instantiation: p_ed25519_asn1.c:ERR_GET_LIB Unexecuted instantiation: p_hkdf.c:ERR_GET_LIB Unexecuted instantiation: p_rsa.c:ERR_GET_LIB Unexecuted instantiation: p_rsa_asn1.c:ERR_GET_LIB Unexecuted instantiation: p_x25519.c:ERR_GET_LIB Unexecuted instantiation: p_x25519_asn1.c:ERR_GET_LIB Unexecuted instantiation: posix_time.c:ERR_GET_LIB Unexecuted instantiation: rsa_asn1.c:ERR_GET_LIB Unexecuted instantiation: rsa_crypt.c:ERR_GET_LIB Unexecuted instantiation: scrypt.c:ERR_GET_LIB Unexecuted instantiation: stack.c:ERR_GET_LIB Unexecuted instantiation: tasn_typ.c:ERR_GET_LIB Unexecuted instantiation: a_bitstr.c:ERR_GET_LIB Unexecuted instantiation: a_object.c:ERR_GET_LIB Unexecuted instantiation: bio.c:ERR_GET_LIB Unexecuted instantiation: bn_asn1.c:ERR_GET_LIB Unexecuted instantiation: ec_asn1.c:ERR_GET_LIB Unexecuted instantiation: p_dh.c:ERR_GET_LIB Unexecuted instantiation: tasn_dec.c:ERR_GET_LIB Unexecuted instantiation: tasn_enc.c:ERR_GET_LIB Unexecuted instantiation: tasn_fre.c:ERR_GET_LIB Unexecuted instantiation: tasn_new.c:ERR_GET_LIB Unexecuted instantiation: tasn_utl.c:ERR_GET_LIB Unexecuted instantiation: a_type.c:ERR_GET_LIB |
169 | | |
170 | | // ERR_GET_REASON returns the reason code for the error. This is one of |
171 | | // library-specific |LIB_R_*| values where |LIB| is the library (see |
172 | | // |ERR_GET_LIB|). Note that reason codes are specific to the library. |
173 | 0 | OPENSSL_INLINE int ERR_GET_REASON(uint32_t packed_error) { |
174 | 0 | return (int)(packed_error & 0xfff); |
175 | 0 | } Unexecuted instantiation: ERR_GET_REASON Unexecuted instantiation: a_int.c:ERR_GET_REASON Unexecuted instantiation: asn1_lib.c:ERR_GET_REASON Unexecuted instantiation: bcm.c:ERR_GET_REASON Unexecuted instantiation: cbb.c:ERR_GET_REASON Unexecuted instantiation: cbs.c:ERR_GET_REASON Unexecuted instantiation: convert.c:ERR_GET_REASON Unexecuted instantiation: digest_extra.c:ERR_GET_REASON Unexecuted instantiation: dsa.c:ERR_GET_REASON Unexecuted instantiation: dsa_asn1.c:ERR_GET_REASON Unexecuted instantiation: e_aesctrhmac.c:ERR_GET_REASON Unexecuted instantiation: e_aesgcmsiv.c:ERR_GET_REASON Unexecuted instantiation: e_chacha20poly1305.c:ERR_GET_REASON Unexecuted instantiation: e_tls.c:ERR_GET_REASON Unexecuted instantiation: ecdh_extra.c:ERR_GET_REASON Unexecuted instantiation: ecdsa_asn1.c:ERR_GET_REASON Unexecuted instantiation: engine.c:ERR_GET_REASON Unexecuted instantiation: err_data.c:ERR_GET_REASON Unexecuted instantiation: evp.c:ERR_GET_REASON Unexecuted instantiation: evp_ctx.c:ERR_GET_REASON Unexecuted instantiation: ex_data.c:ERR_GET_REASON Unexecuted instantiation: file.c:ERR_GET_REASON Unexecuted instantiation: mem.c:ERR_GET_REASON Unexecuted instantiation: obj.c:ERR_GET_REASON Unexecuted instantiation: p_dh_asn1.c:ERR_GET_REASON Unexecuted instantiation: p_dsa_asn1.c:ERR_GET_REASON Unexecuted instantiation: p_ec.c:ERR_GET_REASON Unexecuted instantiation: p_ec_asn1.c:ERR_GET_REASON Unexecuted instantiation: p_ed25519.c:ERR_GET_REASON Unexecuted instantiation: p_ed25519_asn1.c:ERR_GET_REASON Unexecuted instantiation: p_hkdf.c:ERR_GET_REASON Unexecuted instantiation: p_rsa.c:ERR_GET_REASON Unexecuted instantiation: p_rsa_asn1.c:ERR_GET_REASON Unexecuted instantiation: p_x25519.c:ERR_GET_REASON Unexecuted instantiation: p_x25519_asn1.c:ERR_GET_REASON Unexecuted instantiation: posix_time.c:ERR_GET_REASON Unexecuted instantiation: rsa_asn1.c:ERR_GET_REASON Unexecuted instantiation: rsa_crypt.c:ERR_GET_REASON Unexecuted instantiation: scrypt.c:ERR_GET_REASON Unexecuted instantiation: stack.c:ERR_GET_REASON Unexecuted instantiation: tasn_typ.c:ERR_GET_REASON Unexecuted instantiation: a_bitstr.c:ERR_GET_REASON Unexecuted instantiation: a_object.c:ERR_GET_REASON Unexecuted instantiation: bio.c:ERR_GET_REASON Unexecuted instantiation: bn_asn1.c:ERR_GET_REASON Unexecuted instantiation: ec_asn1.c:ERR_GET_REASON Unexecuted instantiation: p_dh.c:ERR_GET_REASON Unexecuted instantiation: tasn_dec.c:ERR_GET_REASON Unexecuted instantiation: tasn_enc.c:ERR_GET_REASON Unexecuted instantiation: tasn_fre.c:ERR_GET_REASON Unexecuted instantiation: tasn_new.c:ERR_GET_REASON Unexecuted instantiation: tasn_utl.c:ERR_GET_REASON Unexecuted instantiation: a_type.c:ERR_GET_REASON |
176 | | |
177 | | // ERR_get_error gets the packed error code for the least recent error and |
178 | | // removes that error from the queue. If there are no errors in the queue then |
179 | | // it returns zero. |
180 | | OPENSSL_EXPORT uint32_t ERR_get_error(void); |
181 | | |
182 | | // ERR_get_error_line acts like |ERR_get_error|, except that the file and line |
183 | | // number of the call that added the error are also returned. |
184 | | OPENSSL_EXPORT uint32_t ERR_get_error_line(const char **file, int *line); |
185 | | |
186 | | // ERR_FLAG_STRING means that the |data| member is a NUL-terminated string that |
187 | | // can be printed. This is always set if |data| is non-NULL. |
188 | 0 | #define ERR_FLAG_STRING 1 |
189 | | |
190 | | // ERR_FLAG_MALLOCED is passed into |ERR_set_error_data| to indicate that |data| |
191 | | // was allocated with |OPENSSL_malloc|. |
192 | | // |
193 | | // It is, separately, returned in |*flags| from |ERR_get_error_line_data| to |
194 | | // indicate that |*data| has a non-static lifetime, but this lifetime is still |
195 | | // managed by the library. The caller must not call |OPENSSL_free| or |free| on |
196 | | // |data|. |
197 | 0 | #define ERR_FLAG_MALLOCED 2 |
198 | | |
199 | | // ERR_get_error_line_data acts like |ERR_get_error_line|, but also returns the |
200 | | // error-specific data pointer and flags. The flags are a bitwise-OR of |
201 | | // |ERR_FLAG_*| values. The error-specific data is owned by the error queue |
202 | | // and the pointer becomes invalid after the next call that affects the same |
203 | | // thread's error queue. If |*flags| contains |ERR_FLAG_STRING| then |*data| is |
204 | | // human-readable. |
205 | | OPENSSL_EXPORT uint32_t ERR_get_error_line_data(const char **file, int *line, |
206 | | const char **data, int *flags); |
207 | | |
208 | | // The "peek" functions act like the |ERR_get_error| functions, above, but they |
209 | | // do not remove the error from the queue. |
210 | | OPENSSL_EXPORT uint32_t ERR_peek_error(void); |
211 | | OPENSSL_EXPORT uint32_t ERR_peek_error_line(const char **file, int *line); |
212 | | OPENSSL_EXPORT uint32_t ERR_peek_error_line_data(const char **file, int *line, |
213 | | const char **data, int *flags); |
214 | | |
215 | | // The "peek last" functions act like the "peek" functions, above, except that |
216 | | // they return the most recent error. |
217 | | OPENSSL_EXPORT uint32_t ERR_peek_last_error(void); |
218 | | OPENSSL_EXPORT uint32_t ERR_peek_last_error_line(const char **file, int *line); |
219 | | OPENSSL_EXPORT uint32_t ERR_peek_last_error_line_data(const char **file, |
220 | | int *line, |
221 | | const char **data, |
222 | | int *flags); |
223 | | |
224 | | // ERR_error_string_n generates a human-readable string representing |
225 | | // |packed_error|, places it at |buf|, and returns |buf|. It writes at most |
226 | | // |len| bytes (including the terminating NUL) and truncates the string if |
227 | | // necessary. If |len| is greater than zero then |buf| is always NUL terminated. |
228 | | // |
229 | | // The string will have the following format: |
230 | | // |
231 | | // error:[error code]:[library name]:OPENSSL_internal:[reason string] |
232 | | // |
233 | | // error code is an 8 digit hexadecimal number; library name and reason string |
234 | | // are ASCII text. |
235 | | OPENSSL_EXPORT char *ERR_error_string_n(uint32_t packed_error, char *buf, |
236 | | size_t len); |
237 | | |
238 | | // ERR_lib_error_string returns a string representation of the library that |
239 | | // generated |packed_error|, or a placeholder string is the library is |
240 | | // unrecognized. |
241 | | OPENSSL_EXPORT const char *ERR_lib_error_string(uint32_t packed_error); |
242 | | |
243 | | // ERR_reason_error_string returns a string representation of the reason for |
244 | | // |packed_error|, or a placeholder string if the reason is unrecognized. |
245 | | OPENSSL_EXPORT const char *ERR_reason_error_string(uint32_t packed_error); |
246 | | |
247 | | // ERR_lib_symbol_name returns the symbol name of library that generated |
248 | | // |packed_error|, or NULL if unrecognized. For example, an error from |
249 | | // |ERR_LIB_EVP| would return "EVP". |
250 | | OPENSSL_EXPORT const char *ERR_lib_symbol_name(uint32_t packed_error); |
251 | | |
252 | | // ERR_reason_symbol_name returns the symbol name of the reason for |
253 | | // |packed_error|, or NULL if unrecognized. For example, |ERR_R_INTERNAL_ERROR| |
254 | | // would return "INTERNAL_ERROR". |
255 | | // |
256 | | // Errors from the |ERR_LIB_SYS| library are typically |errno| values and will |
257 | | // return NULL. User-defined errors will also return NULL. |
258 | | OPENSSL_EXPORT const char *ERR_reason_symbol_name(uint32_t packed_error); |
259 | | |
260 | | // ERR_print_errors_callback_t is the type of a function used by |
261 | | // |ERR_print_errors_cb|. It takes a pointer to a human readable string (and |
262 | | // its length) that describes an entry in the error queue. The |ctx| argument |
263 | | // is an opaque pointer given to |ERR_print_errors_cb|. |
264 | | // |
265 | | // It should return one on success or zero on error, which will stop the |
266 | | // iteration over the error queue. |
267 | | typedef int (*ERR_print_errors_callback_t)(const char *str, size_t len, |
268 | | void *ctx); |
269 | | |
270 | | // ERR_print_errors_cb clears the current thread's error queue, calling |
271 | | // |callback| with a string representation of each error, from the least recent |
272 | | // to the most recent error. |
273 | | // |
274 | | // The string will have the following format (which differs from |
275 | | // |ERR_error_string|): |
276 | | // |
277 | | // [thread id]:error:[error code]:[library name]:OPENSSL_internal:[reason string]:[file]:[line number]:[optional string data] |
278 | | // |
279 | | // The callback can return one to continue the iteration or zero to stop it. |
280 | | // The |ctx| argument is an opaque value that is passed through to the |
281 | | // callback. |
282 | | OPENSSL_EXPORT void ERR_print_errors_cb(ERR_print_errors_callback_t callback, |
283 | | void *ctx); |
284 | | |
285 | | // ERR_print_errors_fp clears the current thread's error queue, printing each |
286 | | // error to |file|. See |ERR_print_errors_cb| for the format. |
287 | | OPENSSL_EXPORT void ERR_print_errors_fp(FILE *file); |
288 | | |
289 | | |
290 | | // Clearing errors. |
291 | | |
292 | | // ERR_clear_error clears the error queue for the current thread. |
293 | | OPENSSL_EXPORT void ERR_clear_error(void); |
294 | | |
295 | | // ERR_set_mark "marks" the most recent error for use with |ERR_pop_to_mark|. |
296 | | // It returns one if an error was marked and zero if there are no errors. |
297 | | OPENSSL_EXPORT int ERR_set_mark(void); |
298 | | |
299 | | // ERR_pop_to_mark removes errors from the most recent to the least recent |
300 | | // until (and not including) a "marked" error. It returns zero if no marked |
301 | | // error was found (and thus all errors were removed) and one otherwise. Errors |
302 | | // are marked using |ERR_set_mark|. |
303 | | OPENSSL_EXPORT int ERR_pop_to_mark(void); |
304 | | |
305 | | |
306 | | // Custom errors. |
307 | | |
308 | | // ERR_get_next_error_library returns a value suitable for passing as the |
309 | | // |library| argument to |ERR_put_error|. This is intended for code that wishes |
310 | | // to push its own, non-standard errors to the error queue. |
311 | | OPENSSL_EXPORT int ERR_get_next_error_library(void); |
312 | | |
313 | | |
314 | | // Built-in library and reason codes. |
315 | | |
316 | | // The following values are built-in library codes. |
317 | | enum { |
318 | | ERR_LIB_NONE = 1, |
319 | | ERR_LIB_SYS, |
320 | | ERR_LIB_BN, |
321 | | ERR_LIB_RSA, |
322 | | ERR_LIB_DH, |
323 | | ERR_LIB_EVP, |
324 | | ERR_LIB_BUF, |
325 | | ERR_LIB_OBJ, |
326 | | ERR_LIB_PEM, |
327 | | ERR_LIB_DSA, |
328 | | ERR_LIB_X509, |
329 | | ERR_LIB_ASN1, |
330 | | ERR_LIB_CONF, |
331 | | ERR_LIB_CRYPTO, |
332 | | ERR_LIB_EC, |
333 | | ERR_LIB_SSL, |
334 | | ERR_LIB_BIO, |
335 | | ERR_LIB_PKCS7, |
336 | | ERR_LIB_PKCS8, |
337 | | ERR_LIB_X509V3, |
338 | | ERR_LIB_RAND, |
339 | | ERR_LIB_ENGINE, |
340 | | ERR_LIB_OCSP, |
341 | | ERR_LIB_UI, |
342 | | ERR_LIB_COMP, |
343 | | ERR_LIB_ECDSA, |
344 | | ERR_LIB_ECDH, |
345 | | ERR_LIB_HMAC, |
346 | | ERR_LIB_DIGEST, |
347 | | ERR_LIB_CIPHER, |
348 | | ERR_LIB_HKDF, |
349 | | ERR_LIB_TRUST_TOKEN, |
350 | | ERR_LIB_USER, |
351 | | ERR_NUM_LIBS |
352 | | }; |
353 | | |
354 | | // The following reason codes used to denote an error occuring in another |
355 | | // library. They are sometimes used for a stack trace. |
356 | | #define ERR_R_SYS_LIB ERR_LIB_SYS |
357 | | #define ERR_R_BN_LIB ERR_LIB_BN |
358 | | #define ERR_R_RSA_LIB ERR_LIB_RSA |
359 | | #define ERR_R_DH_LIB ERR_LIB_DH |
360 | | #define ERR_R_EVP_LIB ERR_LIB_EVP |
361 | | #define ERR_R_BUF_LIB ERR_LIB_BUF |
362 | | #define ERR_R_OBJ_LIB ERR_LIB_OBJ |
363 | | #define ERR_R_PEM_LIB ERR_LIB_PEM |
364 | | #define ERR_R_DSA_LIB ERR_LIB_DSA |
365 | | #define ERR_R_X509_LIB ERR_LIB_X509 |
366 | | #define ERR_R_ASN1_LIB ERR_LIB_ASN1 |
367 | | #define ERR_R_CONF_LIB ERR_LIB_CONF |
368 | | #define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO |
369 | | #define ERR_R_EC_LIB ERR_LIB_EC |
370 | | #define ERR_R_SSL_LIB ERR_LIB_SSL |
371 | | #define ERR_R_BIO_LIB ERR_LIB_BIO |
372 | | #define ERR_R_PKCS7_LIB ERR_LIB_PKCS7 |
373 | | #define ERR_R_PKCS8_LIB ERR_LIB_PKCS8 |
374 | | #define ERR_R_X509V3_LIB ERR_LIB_X509V3 |
375 | | #define ERR_R_RAND_LIB ERR_LIB_RAND |
376 | | #define ERR_R_DSO_LIB ERR_LIB_DSO |
377 | | #define ERR_R_ENGINE_LIB ERR_LIB_ENGINE |
378 | | #define ERR_R_OCSP_LIB ERR_LIB_OCSP |
379 | | #define ERR_R_UI_LIB ERR_LIB_UI |
380 | | #define ERR_R_COMP_LIB ERR_LIB_COMP |
381 | | #define ERR_R_ECDSA_LIB ERR_LIB_ECDSA |
382 | | #define ERR_R_ECDH_LIB ERR_LIB_ECDH |
383 | | #define ERR_R_STORE_LIB ERR_LIB_STORE |
384 | | #define ERR_R_FIPS_LIB ERR_LIB_FIPS |
385 | | #define ERR_R_CMS_LIB ERR_LIB_CMS |
386 | | #define ERR_R_TS_LIB ERR_LIB_TS |
387 | | #define ERR_R_HMAC_LIB ERR_LIB_HMAC |
388 | | #define ERR_R_JPAKE_LIB ERR_LIB_JPAKE |
389 | | #define ERR_R_USER_LIB ERR_LIB_USER |
390 | | #define ERR_R_DIGEST_LIB ERR_LIB_DIGEST |
391 | | #define ERR_R_CIPHER_LIB ERR_LIB_CIPHER |
392 | | #define ERR_R_HKDF_LIB ERR_LIB_HKDF |
393 | | #define ERR_R_TRUST_TOKEN_LIB ERR_LIB_TRUST_TOKEN |
394 | | |
395 | | // The following values are global reason codes. They may occur in any library. |
396 | 0 | #define ERR_R_FATAL 64 |
397 | 0 | #define ERR_R_MALLOC_FAILURE (1 | ERR_R_FATAL) |
398 | 0 | #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2 | ERR_R_FATAL) |
399 | 0 | #define ERR_R_PASSED_NULL_PARAMETER (3 | ERR_R_FATAL) |
400 | 0 | #define ERR_R_INTERNAL_ERROR (4 | ERR_R_FATAL) |
401 | 0 | #define ERR_R_OVERFLOW (5 | ERR_R_FATAL) |
402 | | |
403 | | |
404 | | // Deprecated functions. |
405 | | |
406 | | // ERR_remove_state calls |ERR_clear_error|. |
407 | | OPENSSL_EXPORT void ERR_remove_state(unsigned long pid); |
408 | | |
409 | | // ERR_remove_thread_state clears the error queue for the current thread if |
410 | | // |tid| is NULL. Otherwise it calls |assert(0)|, because it's no longer |
411 | | // possible to delete the error queue for other threads. |
412 | | // |
413 | | // Use |ERR_clear_error| instead. Note error queues are deleted automatically on |
414 | | // thread exit. You do not need to call this function to release memory. |
415 | | OPENSSL_EXPORT void ERR_remove_thread_state(const CRYPTO_THREADID *tid); |
416 | | |
417 | | // ERR_func_error_string returns the string "OPENSSL_internal". |
418 | | OPENSSL_EXPORT const char *ERR_func_error_string(uint32_t packed_error); |
419 | | |
420 | | // ERR_error_string behaves like |ERR_error_string_n| but |len| is implicitly |
421 | | // |ERR_ERROR_STRING_BUF_LEN|. |
422 | | // |
423 | | // Additionally, if |buf| is NULL, the error string is placed in a static buffer |
424 | | // which is returned. This is not thread-safe and only exists for backwards |
425 | | // compatibility with legacy callers. The static buffer will be overridden by |
426 | | // calls in other threads. |
427 | | // |
428 | | // Use |ERR_error_string_n| instead. |
429 | | // |
430 | | // TODO(fork): remove this function. |
431 | | OPENSSL_EXPORT char *ERR_error_string(uint32_t packed_error, char *buf); |
432 | 0 | #define ERR_ERROR_STRING_BUF_LEN 120 |
433 | | |
434 | | // ERR_GET_FUNC returns zero. BoringSSL errors do not report a function code. |
435 | 0 | OPENSSL_INLINE int ERR_GET_FUNC(uint32_t packed_error) { |
436 | 0 | (void)packed_error; |
437 | 0 | return 0; |
438 | 0 | } Unexecuted instantiation: ERR_GET_FUNC Unexecuted instantiation: a_int.c:ERR_GET_FUNC Unexecuted instantiation: asn1_lib.c:ERR_GET_FUNC Unexecuted instantiation: bcm.c:ERR_GET_FUNC Unexecuted instantiation: cbb.c:ERR_GET_FUNC Unexecuted instantiation: cbs.c:ERR_GET_FUNC Unexecuted instantiation: convert.c:ERR_GET_FUNC Unexecuted instantiation: digest_extra.c:ERR_GET_FUNC Unexecuted instantiation: dsa.c:ERR_GET_FUNC Unexecuted instantiation: dsa_asn1.c:ERR_GET_FUNC Unexecuted instantiation: e_aesctrhmac.c:ERR_GET_FUNC Unexecuted instantiation: e_aesgcmsiv.c:ERR_GET_FUNC Unexecuted instantiation: e_chacha20poly1305.c:ERR_GET_FUNC Unexecuted instantiation: e_tls.c:ERR_GET_FUNC Unexecuted instantiation: ecdh_extra.c:ERR_GET_FUNC Unexecuted instantiation: ecdsa_asn1.c:ERR_GET_FUNC Unexecuted instantiation: engine.c:ERR_GET_FUNC Unexecuted instantiation: err.c:ERR_GET_FUNC Unexecuted instantiation: err_data.c:ERR_GET_FUNC Unexecuted instantiation: evp.c:ERR_GET_FUNC Unexecuted instantiation: evp_ctx.c:ERR_GET_FUNC Unexecuted instantiation: ex_data.c:ERR_GET_FUNC Unexecuted instantiation: file.c:ERR_GET_FUNC Unexecuted instantiation: mem.c:ERR_GET_FUNC Unexecuted instantiation: obj.c:ERR_GET_FUNC Unexecuted instantiation: p_dh_asn1.c:ERR_GET_FUNC Unexecuted instantiation: p_dsa_asn1.c:ERR_GET_FUNC Unexecuted instantiation: p_ec.c:ERR_GET_FUNC Unexecuted instantiation: p_ec_asn1.c:ERR_GET_FUNC Unexecuted instantiation: p_ed25519.c:ERR_GET_FUNC Unexecuted instantiation: p_ed25519_asn1.c:ERR_GET_FUNC Unexecuted instantiation: p_hkdf.c:ERR_GET_FUNC Unexecuted instantiation: p_rsa.c:ERR_GET_FUNC Unexecuted instantiation: p_rsa_asn1.c:ERR_GET_FUNC Unexecuted instantiation: p_x25519.c:ERR_GET_FUNC Unexecuted instantiation: p_x25519_asn1.c:ERR_GET_FUNC Unexecuted instantiation: posix_time.c:ERR_GET_FUNC Unexecuted instantiation: rsa_asn1.c:ERR_GET_FUNC Unexecuted instantiation: rsa_crypt.c:ERR_GET_FUNC Unexecuted instantiation: scrypt.c:ERR_GET_FUNC Unexecuted instantiation: stack.c:ERR_GET_FUNC Unexecuted instantiation: tasn_typ.c:ERR_GET_FUNC Unexecuted instantiation: a_bitstr.c:ERR_GET_FUNC Unexecuted instantiation: a_object.c:ERR_GET_FUNC Unexecuted instantiation: bio.c:ERR_GET_FUNC Unexecuted instantiation: bn_asn1.c:ERR_GET_FUNC Unexecuted instantiation: ec_asn1.c:ERR_GET_FUNC Unexecuted instantiation: p_dh.c:ERR_GET_FUNC Unexecuted instantiation: tasn_dec.c:ERR_GET_FUNC Unexecuted instantiation: tasn_enc.c:ERR_GET_FUNC Unexecuted instantiation: tasn_fre.c:ERR_GET_FUNC Unexecuted instantiation: tasn_new.c:ERR_GET_FUNC Unexecuted instantiation: tasn_utl.c:ERR_GET_FUNC Unexecuted instantiation: a_type.c:ERR_GET_FUNC |
439 | | |
440 | | // ERR_TXT_* are provided for compatibility with code that assumes that it's |
441 | | // using OpenSSL. |
442 | | #define ERR_TXT_STRING ERR_FLAG_STRING |
443 | | #define ERR_TXT_MALLOCED ERR_FLAG_MALLOCED |
444 | | |
445 | | |
446 | | // Private functions. |
447 | | |
448 | | // ERR_clear_system_error clears the system's error value (i.e. errno). |
449 | | OPENSSL_EXPORT void ERR_clear_system_error(void); |
450 | | |
451 | | // OPENSSL_PUT_ERROR is used by OpenSSL code to add an error to the error |
452 | | // queue. |
453 | | #define OPENSSL_PUT_ERROR(library, reason) \ |
454 | 5.18k | ERR_put_error(ERR_LIB_##library, 0, reason, __FILE__, __LINE__) |
455 | | |
456 | | // OPENSSL_PUT_SYSTEM_ERROR is used by OpenSSL code to add an error from the |
457 | | // operating system to the error queue. |
458 | | // TODO(fork): include errno. |
459 | | #define OPENSSL_PUT_SYSTEM_ERROR() \ |
460 | 0 | ERR_put_error(ERR_LIB_SYS, 0, 0, __FILE__, __LINE__); |
461 | | |
462 | | // ERR_put_error adds an error to the error queue, dropping the least recent |
463 | | // error if necessary for space reasons. |
464 | | OPENSSL_EXPORT void ERR_put_error(int library, int unused, int reason, |
465 | | const char *file, unsigned line); |
466 | | |
467 | | // ERR_add_error_data takes a variable number (|count|) of const char* |
468 | | // pointers, concatenates them and sets the result as the data on the most |
469 | | // recent error. |
470 | | OPENSSL_EXPORT void ERR_add_error_data(unsigned count, ...); |
471 | | |
472 | | // ERR_add_error_dataf takes a printf-style format and arguments, and sets the |
473 | | // result as the data on the most recent error. |
474 | | OPENSSL_EXPORT void ERR_add_error_dataf(const char *format, ...) |
475 | | OPENSSL_PRINTF_FORMAT_FUNC(1, 2); |
476 | | |
477 | | // ERR_set_error_data sets the data on the most recent error to |data|, which |
478 | | // must be a NUL-terminated string. |flags| must contain |ERR_FLAG_STRING|. If |
479 | | // |flags| contains |ERR_FLAG_MALLOCED|, this function takes ownership of |
480 | | // |data|, which must have been allocated with |OPENSSL_malloc|. Otherwise, it |
481 | | // saves a copy of |data|. |
482 | | // |
483 | | // Note this differs from OpenSSL which, when |ERR_FLAG_MALLOCED| is unset, |
484 | | // saves the pointer as-is and requires it remain valid for the lifetime of the |
485 | | // address space. |
486 | | OPENSSL_EXPORT void ERR_set_error_data(char *data, int flags); |
487 | | |
488 | | // ERR_NUM_ERRORS is one more than the limit of the number of errors in the |
489 | | // queue. |
490 | 10.4k | #define ERR_NUM_ERRORS 16 |
491 | | |
492 | | #define ERR_PACK(lib, reason) \ |
493 | 5.18k | (((((uint32_t)(lib)) & 0xff) << 24) | ((((uint32_t)(reason)) & 0xfff))) |
494 | | |
495 | | // OPENSSL_DECLARE_ERROR_REASON is used by util/make_errors.h (which generates |
496 | | // the error defines) to recognise that an additional reason value is needed. |
497 | | // This is needed when the reason value is used outside of an |
498 | | // |OPENSSL_PUT_ERROR| macro. The resulting define will be |
499 | | // ${lib}_R_${reason}. |
500 | | #define OPENSSL_DECLARE_ERROR_REASON(lib, reason) |
501 | | |
502 | | |
503 | | #if defined(__cplusplus) |
504 | | } // extern C |
505 | | #endif |
506 | | |
507 | | #endif // OPENSSL_HEADER_ERR_H |