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