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) 117extern "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. 147OPENSSL_EXPORT void ERR_load_BIO_strings(void); 148 149// ERR_load_ERR_strings does nothing. 150OPENSSL_EXPORT void ERR_load_ERR_strings(void); 151 152// ERR_load_crypto_strings does nothing. 153OPENSSL_EXPORT void ERR_load_crypto_strings(void); 154 155// ERR_free_strings does nothing. 156OPENSSL_EXPORT void ERR_free_strings(void); 157 158 159// Reading and formatting errors. 160 161// ERR_GET_LIB returns the library code for the error. This is one of 162// the |ERR_LIB_*| values. 163#define ERR_GET_LIB(packed_error) ((int)(((packed_error) >> 24) & 0xff)) 164 165// ERR_GET_REASON returns the reason code for the error. This is one of 166// library-specific |LIB_R_*| values where |LIB| is the library (see 167// |ERR_GET_LIB|). Note that reason codes are specific to the library. 168#define ERR_GET_REASON(packed_error) ((int)((packed_error) & 0xfff)) 169 170// ERR_get_error gets the packed error code for the least recent error and 171// removes that error from the queue. If there are no errors in the queue then 172// it returns zero. 173OPENSSL_EXPORT uint32_t ERR_get_error(void); 174 175// ERR_get_error_line acts like |ERR_get_error|, except that the file and line 176// number of the call that added the error are also returned. 177OPENSSL_EXPORT uint32_t ERR_get_error_line(const char **file, int *line); 178 179// ERR_FLAG_STRING means that the |data| member is a NUL-terminated string that 180// can be printed. This is always set if |data| is non-NULL. 181#define ERR_FLAG_STRING 1 182 183// ERR_get_error_line_data acts like |ERR_get_error_line|, but also returns the 184// error-specific data pointer and flags. The flags are a bitwise-OR of 185// |ERR_FLAG_*| values. The error-specific data is owned by the error queue 186// and the pointer becomes invalid after the next call that affects the same 187// thread's error queue. If |*flags| contains |ERR_FLAG_STRING| then |*data| is 188// human-readable. 189OPENSSL_EXPORT uint32_t ERR_get_error_line_data(const char **file, int *line, 190 const char **data, int *flags); 191 192// The "peek" functions act like the |ERR_get_error| functions, above, but they 193// do not remove the error from the queue. 194OPENSSL_EXPORT uint32_t ERR_peek_error(void); 195OPENSSL_EXPORT uint32_t ERR_peek_error_line(const char **file, int *line); 196OPENSSL_EXPORT uint32_t ERR_peek_error_line_data(const char **file, int *line, 197 const char **data, int *flags); 198 199// The "peek last" functions act like the "peek" functions, above, except that 200// they return the most recent error. 201OPENSSL_EXPORT uint32_t ERR_peek_last_error(void); 202OPENSSL_EXPORT uint32_t ERR_peek_last_error_line(const char **file, int *line); 203OPENSSL_EXPORT uint32_t ERR_peek_last_error_line_data(const char **file, 204 int *line, 205 const char **data, 206 int *flags); 207 208// ERR_error_string_n generates a human-readable string representing 209// |packed_error| and places it at |buf|. It writes at most |len| bytes 210// (including the terminating NUL) and truncates the string if necessary. If 211// |len| is greater than zero then |buf| is always NUL terminated. 212// 213// The string will have the following format: 214// 215// error:[error code]:[library name]:OPENSSL_internal:[reason string] 216// 217// error code is an 8 digit hexadecimal number; library name and reason string 218// are ASCII text. 219OPENSSL_EXPORT void ERR_error_string_n(uint32_t packed_error, char *buf, 220 size_t len); 221 222// ERR_lib_error_string returns a string representation of the library that 223// generated |packed_error|. 224OPENSSL_EXPORT const char *ERR_lib_error_string(uint32_t packed_error); 225 226// ERR_reason_error_string returns a string representation of the reason for 227// |packed_error|. 228OPENSSL_EXPORT const char *ERR_reason_error_string(uint32_t packed_error); 229 230// ERR_print_errors_callback_t is the type of a function used by 231// |ERR_print_errors_cb|. It takes a pointer to a human readable string (and 232// its length) that describes an entry in the error queue. The |ctx| argument 233// is an opaque pointer given to |ERR_print_errors_cb|. 234// 235// It should return one on success or zero on error, which will stop the 236// iteration over the error queue. 237typedef int (*ERR_print_errors_callback_t)(const char *str, size_t len, 238 void *ctx); 239 240// ERR_print_errors_cb clears the current thread's error queue, calling 241// |callback| with a string representation of each error, from the least recent 242// to the most recent error. 243// 244// The string will have the following format (which differs from 245// |ERR_error_string|): 246// 247// [thread id]:error:[error code]:[library name]:OPENSSL_internal:[reason string]:[file]:[line number]:[optional string data] 248// 249// The callback can return one to continue the iteration or zero to stop it. 250// The |ctx| argument is an opaque value that is passed through to the 251// callback. 252OPENSSL_EXPORT void ERR_print_errors_cb(ERR_print_errors_callback_t callback, 253 void *ctx); 254 255// ERR_print_errors_fp clears the current thread's error queue, printing each 256// error to |file|. See |ERR_print_errors_cb| for the format. 257OPENSSL_EXPORT void ERR_print_errors_fp(FILE *file); 258 259 260// Clearing errors. 261 262// ERR_clear_error clears the error queue for the current thread. 263OPENSSL_EXPORT void ERR_clear_error(void); 264 265// ERR_set_mark "marks" the most recent error for use with |ERR_pop_to_mark|. 266// It returns one if an error was marked and zero if there are no errors. 267OPENSSL_EXPORT int ERR_set_mark(void); 268 269// ERR_pop_to_mark removes errors from the most recent to the least recent 270// until (and not including) a "marked" error. It returns zero if no marked 271// error was found (and thus all errors were removed) and one otherwise. Errors 272// are marked using |ERR_set_mark|. 273OPENSSL_EXPORT int ERR_pop_to_mark(void); 274 275 276// Custom errors. 277 278// ERR_get_next_error_library returns a value suitable for passing as the 279// |library| argument to |ERR_put_error|. This is intended for code that wishes 280// to push its own, non-standard errors to the error queue. 281OPENSSL_EXPORT int ERR_get_next_error_library(void); 282 283 284// Built-in library and reason codes. 285 286// The following values are built-in library codes. 287enum { 288 ERR_LIB_NONE = 1, 289 ERR_LIB_SYS, 290 ERR_LIB_BN, 291 ERR_LIB_RSA, 292 ERR_LIB_DH, 293 ERR_LIB_EVP, 294 ERR_LIB_BUF, 295 ERR_LIB_OBJ, 296 ERR_LIB_PEM, 297 ERR_LIB_DSA, 298 ERR_LIB_X509, 299 ERR_LIB_ASN1, 300 ERR_LIB_CONF, 301 ERR_LIB_CRYPTO, 302 ERR_LIB_EC, 303 ERR_LIB_SSL, 304 ERR_LIB_BIO, 305 ERR_LIB_PKCS7, 306 ERR_LIB_PKCS8, 307 ERR_LIB_X509V3, 308 ERR_LIB_RAND, 309 ERR_LIB_ENGINE, 310 ERR_LIB_OCSP, 311 ERR_LIB_UI, 312 ERR_LIB_COMP, 313 ERR_LIB_ECDSA, 314 ERR_LIB_ECDH, 315 ERR_LIB_HMAC, 316 ERR_LIB_DIGEST, 317 ERR_LIB_CIPHER, 318 ERR_LIB_HKDF, 319 ERR_LIB_USER, 320 ERR_NUM_LIBS 321}; 322 323// The following reason codes used to denote an error occuring in another 324// library. They are sometimes used for a stack trace. 325#define ERR_R_SYS_LIB ERR_LIB_SYS 326#define ERR_R_BN_LIB ERR_LIB_BN 327#define ERR_R_RSA_LIB ERR_LIB_RSA 328#define ERR_R_DH_LIB ERR_LIB_DH 329#define ERR_R_EVP_LIB ERR_LIB_EVP 330#define ERR_R_BUF_LIB ERR_LIB_BUF 331#define ERR_R_OBJ_LIB ERR_LIB_OBJ 332#define ERR_R_PEM_LIB ERR_LIB_PEM 333#define ERR_R_DSA_LIB ERR_LIB_DSA 334#define ERR_R_X509_LIB ERR_LIB_X509 335#define ERR_R_ASN1_LIB ERR_LIB_ASN1 336#define ERR_R_CONF_LIB ERR_LIB_CONF 337#define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO 338#define ERR_R_EC_LIB ERR_LIB_EC 339#define ERR_R_SSL_LIB ERR_LIB_SSL 340#define ERR_R_BIO_LIB ERR_LIB_BIO 341#define ERR_R_PKCS7_LIB ERR_LIB_PKCS7 342#define ERR_R_PKCS8_LIB ERR_LIB_PKCS8 343#define ERR_R_X509V3_LIB ERR_LIB_X509V3 344#define ERR_R_RAND_LIB ERR_LIB_RAND 345#define ERR_R_DSO_LIB ERR_LIB_DSO 346#define ERR_R_ENGINE_LIB ERR_LIB_ENGINE 347#define ERR_R_OCSP_LIB ERR_LIB_OCSP 348#define ERR_R_UI_LIB ERR_LIB_UI 349#define ERR_R_COMP_LIB ERR_LIB_COMP 350#define ERR_R_ECDSA_LIB ERR_LIB_ECDSA 351#define ERR_R_ECDH_LIB ERR_LIB_ECDH 352#define ERR_R_STORE_LIB ERR_LIB_STORE 353#define ERR_R_FIPS_LIB ERR_LIB_FIPS 354#define ERR_R_CMS_LIB ERR_LIB_CMS 355#define ERR_R_TS_LIB ERR_LIB_TS 356#define ERR_R_HMAC_LIB ERR_LIB_HMAC 357#define ERR_R_JPAKE_LIB ERR_LIB_JPAKE 358#define ERR_R_USER_LIB ERR_LIB_USER 359#define ERR_R_DIGEST_LIB ERR_LIB_DIGEST 360#define ERR_R_CIPHER_LIB ERR_LIB_CIPHER 361#define ERR_R_HKDF_LIB ERR_LIB_HKDF 362 363// The following values are global reason codes. They may occur in any library. 364#define ERR_R_FATAL 64 365#define ERR_R_MALLOC_FAILURE (1 | ERR_R_FATAL) 366#define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2 | ERR_R_FATAL) 367#define ERR_R_PASSED_NULL_PARAMETER (3 | ERR_R_FATAL) 368#define ERR_R_INTERNAL_ERROR (4 | ERR_R_FATAL) 369#define ERR_R_OVERFLOW (5 | ERR_R_FATAL) 370 371 372// Deprecated functions. 373 374// ERR_remove_state calls |ERR_clear_error|. 375OPENSSL_EXPORT void ERR_remove_state(unsigned long pid); 376 377// ERR_remove_thread_state clears the error queue for the current thread if 378// |tid| is NULL. Otherwise it calls |assert(0)|, because it's no longer 379// possible to delete the error queue for other threads. 380// 381// Use |ERR_clear_error| instead. Note error queues are deleted automatically on 382// thread exit. You do not need to call this function to release memory. 383OPENSSL_EXPORT void ERR_remove_thread_state(const CRYPTO_THREADID *tid); 384 385// ERR_func_error_string returns the string "OPENSSL_internal". 386OPENSSL_EXPORT const char *ERR_func_error_string(uint32_t packed_error); 387 388// ERR_error_string behaves like |ERR_error_string_n| but |len| is implicitly 389// |ERR_ERROR_STRING_BUF_LEN| and it returns |buf|. If |buf| is NULL, the error 390// string is placed in a static buffer which is returned. (The static buffer may 391// be overridden by concurrent calls in other threads so this form should not be 392// used.) 393// 394// Use |ERR_error_string_n| instead. 395// 396// TODO(fork): remove this function. 397OPENSSL_EXPORT char *ERR_error_string(uint32_t packed_error, char *buf); 398#define ERR_ERROR_STRING_BUF_LEN 120 399 400// ERR_GET_FUNC returns zero. BoringSSL errors do not report a function code. 401#define ERR_GET_FUNC(packed_error) 0 402 403// ERR_TXT_STRING is provided for compatibility with code that assumes that 404// it's using OpenSSL. 405#define ERR_TXT_STRING ERR_FLAG_STRING 406 407 408// Private functions. 409 410// ERR_clear_system_error clears the system's error value (i.e. errno). 411OPENSSL_EXPORT void ERR_clear_system_error(void); 412 413// OPENSSL_PUT_ERROR is used by OpenSSL code to add an error to the error 414// queue. 415#define OPENSSL_PUT_ERROR(library, reason) \ 416 ERR_put_error(ERR_LIB_##library, 0, reason, __FILE__, __LINE__) 417 418// OPENSSL_PUT_SYSTEM_ERROR is used by OpenSSL code to add an error from the 419// operating system to the error queue. 420// TODO(fork): include errno. 421#define OPENSSL_PUT_SYSTEM_ERROR() \ 422 ERR_put_error(ERR_LIB_SYS, 0, 0, __FILE__, __LINE__); 423 424// ERR_put_error adds an error to the error queue, dropping the least recent 425// error if necessary for space reasons. 426OPENSSL_EXPORT void ERR_put_error(int library, int unused, int reason, 427 const char *file, unsigned line); 428 429// ERR_add_error_data takes a variable number (|count|) of const char* 430// pointers, concatenates them and sets the result as the data on the most 431// recent error. 432OPENSSL_EXPORT void ERR_add_error_data(unsigned count, ...); 433 434// ERR_add_error_dataf takes a printf-style format and arguments, and sets the 435// result as the data on the most recent error. 436OPENSSL_EXPORT void ERR_add_error_dataf(const char *format, ...) 437 OPENSSL_PRINTF_FORMAT_FUNC(1, 2); 438 439// ERR_NUM_ERRORS is one more than the limit of the number of errors in the 440// queue. 441#define ERR_NUM_ERRORS 16 442 443#define ERR_PACK(lib, reason) \ 444 (((((uint32_t)(lib)) & 0xff) << 24) | ((((uint32_t)(reason)) & 0xfff))) 445 446// OPENSSL_DECLARE_ERROR_REASON is used by util/make_errors.h (which generates 447// the error defines) to recognise that an additional reason value is needed. 448// This is needed when the reason value is used outside of an 449// |OPENSSL_PUT_ERROR| macro. The resulting define will be 450// ${lib}_R_${reason}. 451#define OPENSSL_DECLARE_ERROR_REASON(lib, reason) 452 453 454#if defined(__cplusplus) 455} // extern C 456#endif 457 458#endif // OPENSSL_HEADER_ERR_H 459