blob: 071c5ba33137baecc4f002606fe3507517dc2bc2 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* 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 <openssl/base.h>
113#include <openssl/thread.h>
114#include <openssl/lhash.h>
115
116#if defined(__cplusplus)
117extern "C" {
118#endif
119
120
121/* Error queue handling functions.
122 *
123 * Errors in OpenSSL are generally signalled 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) A function identifier and reason code.
130 * 3) The file and line number of the call that added the error.
131 * 4) A pointer to some error specific data, which may be NULL.
132 *
133 * The library identifier, function identifier and reason code are packed in a
134 * uint32_t and there exist various functions for unpacking it.
135 *
136 * The typical behaviour is that an error will occur deep in a call queue and
137 * that code will push an error onto the error queue. As the error queue
138 * unwinds, other functions will push their own errors. Thus, the "least
139 * recent" error is the most specific and the other errors will provide a
140 * backtrace of sorts. */
141
142
143/* Startup and shutdown. */
144
145/* ERR_load_crypto_strings initialises the error string hash with builtin
146 * values. If this is not called then the string forms of errors produced by
147 * the functions below will contain numeric identifiers rather than
148 * human-readable strings. */
David Benjaminc44d2f42014-08-20 16:24:00 -0400149OPENSSL_EXPORT void ERR_load_crypto_strings(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700150
151/* ERR_free_strings frees any internal error values that have been loaded. This
152 * should only be called at process shutdown. */
David Benjaminc44d2f42014-08-20 16:24:00 -0400153OPENSSL_EXPORT void ERR_free_strings(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700154
155
156/* Reading and formatting errors. */
157
158/* ERR_get_error gets the packed error code for the least recent error and
159 * removes that error from the queue. If there are no errors in the queue then
160 * it returns zero. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700161OPENSSL_EXPORT uint32_t ERR_get_error(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700162
163/* ERR_get_error_line acts like |ERR_get_error|, except that the file and line
164 * number of the call that added the error are also returned. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700165OPENSSL_EXPORT uint32_t ERR_get_error_line(const char **file, int *line);
Adam Langley95c29f32014-06-20 12:00:00 -0700166
167/* ERR_get_error_line_data acts like |ERR_get_error_line|, but also returns the
168 * error-specific data pointer and flags. The flags are a bitwise-OR of
Adam Langley5f1374e2014-10-01 15:21:01 -0700169 * |ERR_FLAG_*| values. The error-specific data is owned by the error queue
170 * and the pointer becomes invalid after the next call that affects the same
171 * thread's error queue. If |*flags| contains |ERR_FLAG_STRING| then |*data| is
172 * human-readable. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700173OPENSSL_EXPORT uint32_t ERR_get_error_line_data(const char **file, int *line,
Adam Langley5f1374e2014-10-01 15:21:01 -0700174 const char **data, int *flags);
Adam Langley95c29f32014-06-20 12:00:00 -0700175
176/* The "peek" functions act like the |ERR_get_error| functions, above, but they
177 * do not remove the error from the queue. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700178OPENSSL_EXPORT uint32_t ERR_peek_error(void);
179OPENSSL_EXPORT uint32_t ERR_peek_error_line(const char **file, int *line);
180OPENSSL_EXPORT uint32_t ERR_peek_error_line_data(const char **file, int *line,
181 const char **data, int *flags);
Adam Langley95c29f32014-06-20 12:00:00 -0700182
183/* The "peek last" functions act like the "peek" functions, above, except that
184 * they return the most recent error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700185OPENSSL_EXPORT uint32_t ERR_peek_last_error(void);
186OPENSSL_EXPORT uint32_t ERR_peek_last_error_line(const char **file, int *line);
187OPENSSL_EXPORT uint32_t
188 ERR_peek_last_error_line_data(const char **file, int *line,
189 const char **data, int *flags);
Adam Langley95c29f32014-06-20 12:00:00 -0700190
191/* ERR_error_string generates a human-readable string representing
192 * |packed_error|, places it at |buf| (which must be at least
193 * ERR_ERROR_STRING_BUF_LEN bytes long) and returns |buf|. If |buf| is NULL,
194 * the error string is placed in a static buffer which is returned. (The static
195 * buffer may be overridden by concurrent calls in other threads so this form
196 * is deprecated.)
197 *
198 * The string will have the following format:
199 *
200 * error:[error code]:[library name]:[function name]:[reason string]
201 *
202 * error code is an 8 digit hexadecimal number; library name, function name
203 * and reason string are ASCII text.
204 *
205 * TODO(fork): remove in favour of |ERR_error_string_n|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700206OPENSSL_EXPORT char *ERR_error_string(uint32_t packed_error, char *buf);
Adam Langley95c29f32014-06-20 12:00:00 -0700207#define ERR_ERROR_STRING_BUF_LEN 256
208
209/* ERR_error_string_n is a variant of |ERR_error_string| that writes at most
210 * len characters (including the terminating NUL) and truncates the string if
211 * necessary. If |len| is greater than zero then |buf| is always NUL
212 * terminated. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700213OPENSSL_EXPORT void ERR_error_string_n(uint32_t packed_error, char *buf,
214 size_t len);
Adam Langley95c29f32014-06-20 12:00:00 -0700215
216/* ERR_lib_error_string returns a string representation of the library that
217 * generated |packed_error|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700218OPENSSL_EXPORT const char *ERR_lib_error_string(uint32_t packed_error);
Adam Langley95c29f32014-06-20 12:00:00 -0700219
220/* ERR_func_error_string returns a string representation of the function that
221 * generated |packed_error|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700222OPENSSL_EXPORT const char *ERR_func_error_string(uint32_t packed_error);
Adam Langley95c29f32014-06-20 12:00:00 -0700223
224/* ERR_reason_error_string returns a string representation of the reason for
225 * |packed_error|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700226OPENSSL_EXPORT const char *ERR_reason_error_string(uint32_t packed_error);
Adam Langley95c29f32014-06-20 12:00:00 -0700227
228/* ERR_print_errors_callback_t is the type of a function used by
229 * |ERR_print_errors_cb|. It takes a pointer to a human readable string (and
230 * its length) that describes an entry in the error queue. The |ctx| argument
231 * is an opaque pointer given to |ERR_print_errors_cb|.
232 *
233 * It should return one on success or zero on error, which will stop the
234 * iteration over the error queue. */
235typedef int (*ERR_print_errors_callback_t)(const char *str, size_t len,
236 void *ctx);
237
238/* ERR_print_errors_cb calls |callback| with a string representation of each
239 * error in the current thread's error queue, from the least recent to the most
240 * recent error.
241 *
242 * The string will have the following format (which differs from
243 * |ERR_error_string|):
244 *
245 * [thread id]:error:[error code]:[library name]:[function name]:
246 * [reason string]:[file]:[line number]:[optional string data]
247 *
248 * (All in one line.)
249 *
250 * The callback can return one to continue the iteration or zero to stop it.
251 * The |ctx| argument is an opaque value that is passed through to the
252 * callback. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700253OPENSSL_EXPORT void ERR_print_errors_cb(ERR_print_errors_callback_t callback,
254 void *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700255
256
257/* Clearing errors. */
258
259/* ERR_clear_error clears the error queue for the current thread. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700260OPENSSL_EXPORT void ERR_clear_error(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700261
Adam Langley03d31ed2014-08-05 16:54:47 -0700262/* ERR_remove_thread_state deletes the error queue for the given thread. If
263 * |tid| is NULL then the error queue for the current thread is deleted. */
264OPENSSL_EXPORT void ERR_remove_thread_state(const CRYPTO_THREADID *tid);
265
Adam Langley95c29f32014-06-20 12:00:00 -0700266
Adam Langley40426672014-07-01 16:48:28 -0700267/* Custom errors. */
268
269/* ERR_get_next_error_library returns a value suitable for passing as the
270 * |library| argument to |ERR_put_error|. This is intended for code that wishes
271 * to push its own, non-standard errors to the error queue. */
David Benjaminc44d2f42014-08-20 16:24:00 -0400272OPENSSL_EXPORT int ERR_get_next_error_library(void);
Adam Langley40426672014-07-01 16:48:28 -0700273
274
Adam Langley95c29f32014-06-20 12:00:00 -0700275/* Private functions. */
276
277/* ERR_clear_system_error clears the system's error value (i.e. errno). */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700278OPENSSL_EXPORT void ERR_clear_system_error(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700279
280/* OPENSSL_PUT_ERROR is used by OpenSSL code to add an error to the error
281 * queue. */
282#define OPENSSL_PUT_ERROR(library, func, reason) \
283 ERR_put_error(ERR_LIB_##library, library##_F_##func, reason, __FILE__, \
284 __LINE__)
285
286/* OPENSSL_PUT_SYSTEM_ERROR is used by OpenSSL code to add an error from the
287 * operating system to the error queue. */
288/* TODO(fork): include errno. */
289#define OPENSSL_PUT_SYSTEM_ERROR(func) \
290 ERR_put_error(ERR_LIB_SYS, SYS_F_##func, 0, __FILE__, __LINE__);
291
292/* ERR_put_error adds an error to the error queue, dropping the least recent
293 * error if neccessary for space reasons. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700294OPENSSL_EXPORT void ERR_put_error(int library, int func, int reason,
295 const char *file, unsigned line);
Adam Langley95c29f32014-06-20 12:00:00 -0700296
297/* ERR_add_error_data takes a variable number (|count|) of const char*
298 * pointers, concatenates them and sets the result as the data on the most
299 * recent error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700300OPENSSL_EXPORT void ERR_add_error_data(unsigned count, ...);
Adam Langley95c29f32014-06-20 12:00:00 -0700301
302/* ERR_add_error_dataf takes a printf-style format and arguments, and sets the
303 * result as the data on the most recent error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700304OPENSSL_EXPORT void ERR_add_error_dataf(const char *format, ...);
Adam Langley95c29f32014-06-20 12:00:00 -0700305
306/* ERR_set_mark "marks" the most recent error for use with |ERR_pop_to_mark|.
307 * It returns one if an error was marked and zero if there are no errors. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700308OPENSSL_EXPORT int ERR_set_mark(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700309
310/* ERR_pop_to_mark removes errors from the most recent to the least recent
311 * until (and not including) a "marked" error. It returns zero if no marked
312 * error was found (and thus all errors were removed) and one otherwise. Errors
313 * are marked using |ERR_set_mark|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700314OPENSSL_EXPORT int ERR_pop_to_mark(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700315
316struct err_error_st {
317 /* file contains the filename where the error occured. */
318 const char *file;
319 /* data contains optional data. It must be freed with |OPENSSL_free| if
320 * |flags&ERR_FLAG_MALLOCED|. */
321 char *data;
322 /* packed contains the error library, function and reason, as packed by
323 * ERR_PACK. */
324 uint32_t packed;
325 /* line contains the line number where the error occured. */
326 uint16_t line;
327 /* flags contains a bitwise-OR of ERR_FLAG_* values. */
328 uint8_t flags;
329};
330
Adam Langley95c29f32014-06-20 12:00:00 -0700331/* ERR_FLAG_STRING means that the |data| member is a NUL-terminated string that
332 * can be printed. */
Adam Langley5f1374e2014-10-01 15:21:01 -0700333#define ERR_FLAG_STRING 1
Piotr Sikorac3e43172014-07-14 20:31:27 -0700334/* ERR_TXT_STRING is provided for compatibility with code that assumes that
335 * it's using OpenSSL. */
336#define ERR_TXT_STRING ERR_FLAG_STRING
Adam Langley95c29f32014-06-20 12:00:00 -0700337
338/* ERR_FLAG_PUBLIC_MASK is applied to the flags field before it is returned
339 * from functions like |ERR_get_error_line_data|. */
340#define ERR_FLAG_PUBLIC_MASK 0xf
341
342/* The following flag values are internal and are masked when flags are
343 * returned from functions like |ERR_get_error_line_data|. */
344
Adam Langley5f1374e2014-10-01 15:21:01 -0700345/* ERR_FLAG_MALLOCED means the the |data| member must be freed when no longer
346 * needed. */
347#define ERR_FLAG_MALLOCED 16
Adam Langley95c29f32014-06-20 12:00:00 -0700348/* ERR_FLAG_MARK is used to indicate a reversion point in the queue. See
349 * |ERR_pop_to_mark|. */
Adam Langley5f1374e2014-10-01 15:21:01 -0700350#define ERR_FLAG_MARK 32
Adam Langley95c29f32014-06-20 12:00:00 -0700351
352/* ERR_NUM_ERRORS is the limit of the number of errors in the queue. */
353#define ERR_NUM_ERRORS 16
354
355/* ERR_STATE contains the per-thread, error queue. */
356typedef struct err_state_st {
357 /* tid is the identifier of the thread that owns this queue. */
358 CRYPTO_THREADID tid;
359
360 /* errors contains the ERR_NUM_ERRORS most recent errors, organised as a ring
361 * buffer. */
362 struct err_error_st errors[ERR_NUM_ERRORS];
363 /* top contains the index one past the most recent error. If |top| equals
364 * |bottom| then the queue is empty. */
365 unsigned top;
366 /* bottom contains the index of the last error in the queue. */
367 unsigned bottom;
Adam Langley5f1374e2014-10-01 15:21:01 -0700368
369 /* to_free, if not NULL, contains a pointer owned by this structure that was
370 * previously a |data| pointer of one of the elements of |errors|. */
371 void *to_free;
Adam Langley95c29f32014-06-20 12:00:00 -0700372} ERR_STATE;
373
374enum {
375 ERR_LIB_NONE = 1,
376 ERR_LIB_SYS,
377 ERR_LIB_BN,
378 ERR_LIB_RSA,
379 ERR_LIB_DH,
380 ERR_LIB_EVP,
381 ERR_LIB_BUF,
382 ERR_LIB_OBJ,
383 ERR_LIB_PEM,
384 ERR_LIB_DSA,
385 ERR_LIB_X509,
386 ERR_LIB_ASN1,
387 ERR_LIB_CONF,
388 ERR_LIB_CRYPTO,
389 ERR_LIB_EC,
390 ERR_LIB_SSL,
391 ERR_LIB_BIO,
392 ERR_LIB_PKCS7,
393 ERR_LIB_PKCS8,
394 ERR_LIB_X509V3,
Adam Langley95c29f32014-06-20 12:00:00 -0700395 ERR_LIB_RAND,
396 ERR_LIB_ENGINE,
397 ERR_LIB_OCSP,
398 ERR_LIB_UI,
399 ERR_LIB_COMP,
400 ERR_LIB_ECDSA,
401 ERR_LIB_ECDH,
402 ERR_LIB_HMAC,
403 ERR_LIB_DIGEST,
404 ERR_LIB_CIPHER,
405 ERR_LIB_USER,
Nick Harper4685e872014-12-09 15:51:28 -0800406 ERR_LIB_HKDF,
Adam Langley95c29f32014-06-20 12:00:00 -0700407 ERR_NUM_LIBS
408};
409
410#define ERR_R_SYS_LIB ERR_LIB_SYS
411#define ERR_R_BN_LIB ERR_LIB_BN
412#define ERR_R_RSA_LIB ERR_LIB_RSA
413#define ERR_R_DH_LIB ERR_LIB_DH
414#define ERR_R_EVP_LIB ERR_LIB_EVP
415#define ERR_R_BUF_LIB ERR_LIB_BUF
416#define ERR_R_OBJ_LIB ERR_LIB_OBJ
417#define ERR_R_PEM_LIB ERR_LIB_PEM
418#define ERR_R_DSA_LIB ERR_LIB_DSA
419#define ERR_R_X509_LIB ERR_LIB_X509
420#define ERR_R_ASN1_LIB ERR_LIB_ASN1
421#define ERR_R_CONF_LIB ERR_LIB_CONF
422#define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO
423#define ERR_R_EC_LIB ERR_LIB_EC
424#define ERR_R_SSL_LIB ERR_LIB_SSL
425#define ERR_R_BIO_LIB ERR_LIB_BIO
426#define ERR_R_PKCS7_LIB ERR_LIB_PKCS7
427#define ERR_R_PKCS8_LIB ERR_LIB_PKCS8
428#define ERR_R_X509V3_LIB ERR_LIB_X509V3
Adam Langley95c29f32014-06-20 12:00:00 -0700429#define ERR_R_RAND_LIB ERR_LIB_RAND
430#define ERR_R_DSO_LIB ERR_LIB_DSO
431#define ERR_R_ENGINE_LIB ERR_LIB_ENGINE
432#define ERR_R_OCSP_LIB ERR_LIB_OCSP
433#define ERR_R_UI_LIB ERR_LIB_UI
434#define ERR_R_COMP_LIB ERR_LIB_COMP
435#define ERR_R_ECDSA_LIB ERR_LIB_ECDSA
436#define ERR_R_ECDH_LIB ERR_LIB_ECDH
437#define ERR_R_STORE_LIB ERR_LIB_STORE
438#define ERR_R_FIPS_LIB ERR_LIB_FIPS
439#define ERR_R_CMS_LIB ERR_LIB_CMS
440#define ERR_R_TS_LIB ERR_LIB_TS
441#define ERR_R_HMAC_LIB ERR_LIB_HMAC
442#define ERR_R_JPAKE_LIB ERR_LIB_JPAKE
443#define ERR_R_USER_LIB ERR_LIB_USER
444#define ERR_R_DIGEST_LIB ERR_LIB_DIGEST
445#define ERR_R_CIPHER_LIB ERR_LIB_CIPHER
Nick Harper4685e872014-12-09 15:51:28 -0800446#define ERR_R_HKDF_LIB ERR_LIB_HKDF
Adam Langley95c29f32014-06-20 12:00:00 -0700447
448/* Global reasons. */
449#define ERR_R_FATAL 64
450#define ERR_R_MALLOC_FAILURE (1 | ERR_R_FATAL)
451#define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2 | ERR_R_FATAL)
452#define ERR_R_PASSED_NULL_PARAMETER (3 | ERR_R_FATAL)
453#define ERR_R_INTERNAL_ERROR (4 | ERR_R_FATAL)
Adam Langley66014022014-08-13 10:31:04 -0700454#define ERR_R_OVERFLOW (5 | ERR_R_FATAL)
Adam Langley95c29f32014-06-20 12:00:00 -0700455
456/* System error functions */
457#define SYS_F_fopen 100
458#define SYS_F_fclose 101
459#define SYS_F_fread 102
460#define SYS_F_fwrite 103
461#define SYS_F_socket 104
462#define SYS_F_setsockopt 105
463#define SYS_F_connect 106
464#define SYS_F_getaddrinfo 107
465
466#define ERR_PACK(lib, func, reason) \
467 (((((uint32_t)lib) & 0xff) << 24) | ((((uint32_t)func) & 0xfff) << 12) | \
468 ((((uint32_t)reason) & 0xfff)))
469
David Benjaminc7dd5f32014-10-01 14:31:11 -0400470#define ERR_GET_LIB(packed_error) ((int)(((packed_error) >> 24) & 0xff))
471#define ERR_GET_FUNC(packed_error) ((int)(((packed_error) >> 12) & 0xfff))
472#define ERR_GET_REASON(packed_error) ((int)((packed_error) & 0xfff))
Adam Langley95c29f32014-06-20 12:00:00 -0700473
474/* ERR_STRING_DATA is the type of an lhash node that contains a mapping from a
475 * library, function or reason code to a string representation of it. */
476typedef struct err_string_data_st {
477 uint32_t error;
478 const char *string;
479} ERR_STRING_DATA;
480
481/* ERR_load_strings loads an array of ERR_STRING_DATA into the hash table. The
482 * array must be terminated by an entry with a NULL string. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700483OPENSSL_EXPORT void ERR_load_strings(const ERR_STRING_DATA *str);
Adam Langley95c29f32014-06-20 12:00:00 -0700484
485/* ERR_FNS_st is a structure of function pointers that contains the actual
486 * implementation of the error queue handling functions. */
487struct ERR_FNS_st {
488 void (*shutdown)(void);
489 ERR_STRING_DATA *(*get_item)(uint32_t packed_error);
490 ERR_STRING_DATA *(*set_item)(const ERR_STRING_DATA *);
491 ERR_STRING_DATA *(*del_item)(uint32_t packed_error);
492
493 /* get_state returns the ERR_STATE for the current thread. This function
494 * never returns NULL. */
495 ERR_STATE *(*get_state)(void);
Adam Langley40426672014-07-01 16:48:28 -0700496
Adam Langley03d31ed2014-08-05 16:54:47 -0700497 /* release_state returns the |ERR_STATE| for the given thread, or NULL if
498 * none exists. It the return value is not NULL, it also returns ownership of
499 * the |ERR_STATE| and deletes it from its data structures. */
500 ERR_STATE *(*release_state)(const CRYPTO_THREADID *tid);
501
Adam Langley40426672014-07-01 16:48:28 -0700502 /* get_next_library returns a unique value suitable for passing as the
503 * |library| to error calls. It will be distinct from all built-in library
504 * values. */
505 int (*get_next_library)(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700506};
507
508/* OPENSSL_DECLARE_ERROR_REASON is used by util/make_errors.h (which generates
509 * the error defines) to recognise that an additional reason value is needed.
510 * This is needed when the reason value is used outside of an
511 * |OPENSSL_PUT_ERROR| macro. The resulting define will be
512 * ${lib}_R_${reason}. */
513#define OPENSSL_DECLARE_ERROR_REASON(lib, reason)
514
515/* OPENSSL_DECLARE_ERROR_FUNCTION is used by util/make_errors.h (which
516 * generates the error * defines to recognise that an additional function value
517 * is needed. This is * needed when the function value is used outside of an
518 * |OPENSSL_PUT_ERROR| * macro. The resulting define will be
519 * ${lib}_F_${reason}. */
520#define OPENSSL_DECLARE_ERROR_FUNCTION(lib, function_name)
521
522/* ERR_load_BIO_strings does nothing.
523 *
524 * TODO(fork): remove. libjingle calls this. */
David Benjaminc44d2f42014-08-20 16:24:00 -0400525OPENSSL_EXPORT void ERR_load_BIO_strings(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700526
527
Adam Langley7cc3f992015-01-07 15:06:31 -0800528/* Android compatibility section.
529 *
530 * These functions are declared, temporarily, for Android because
531 * wpa_supplicant will take a little time to sync with upstream. Outside of
532 * Android they'll have no definition. */
533
534OPENSSL_EXPORT void ERR_remove_state(unsigned long pid);
535
536
Adam Langley95c29f32014-06-20 12:00:00 -0700537#if defined(__cplusplus)
538} /* extern C */
539#endif
540
541#endif /* OPENSSL_HEADER_ERR_H */