14c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 24c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * All rights reserved. 34c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 44c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * This package is an SSL implementation written 54c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * by Eric Young (eay@cryptsoft.com). 64c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The implementation was written so as to conform with Netscapes SSL. 74c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 84c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * This library is free for commercial and non-commercial use as long as 94c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the following conditions are aheared to. The following conditions 104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * apply to all code found in this distribution, be it the RC4, RSA, 114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * lhash, DES, etc., code; not just the SSL code. The SSL documentation 124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * included with this distribution is covered by the same copyright terms 134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * except that the holder is Tim Hudson (tjh@cryptsoft.com). 144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Copyright remains Eric Young's, and as such any Copyright notices in 164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the code are not to be removed. 174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * If this package is used in a product, Eric Young should be given attribution 184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * as the author of the parts of the library used. 194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * This can be in the form of a textual message at program startup or 204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * in documentation (online or textual) provided with the package. 214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Redistribution and use in source and binary forms, with or without 234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * modification, are permitted provided that the following conditions 244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * are met: 254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1. Redistributions of source code must retain the copyright 264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * notice, this list of conditions and the following disclaimer. 274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2. Redistributions in binary form must reproduce the above copyright 284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * notice, this list of conditions and the following disclaimer in the 294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * documentation and/or other materials provided with the distribution. 304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3. All advertising materials mentioning features or use of this software 314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * must display the following acknowledgement: 324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * "This product includes cryptographic software written by 334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Eric Young (eay@cryptsoft.com)" 344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The word 'cryptographic' can be left out if the rouines from the library 354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * being used are not cryptographic related :-). 364c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4. If you include any Windows specific code (or a derivative thereof) from 374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the apps directory (application code) you must include an acknowledgement: 384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * SUCH DAMAGE. 514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The licence and distribution terms for any publically available version or 534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * derivative of this code cannot be changed. i.e. this code cannot simply be 544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * copied and put under another distribution licence 554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * [including the GNU Public Licence.] 564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley */ 574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ==================================================================== 584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved. 594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Redistribution and use in source and binary forms, with or without 614c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * modification, are permitted provided that the following conditions 624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * are met: 634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1. Redistributions of source code must retain the above copyright 654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * notice, this list of conditions and the following disclaimer. 664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2. Redistributions in binary form must reproduce the above copyright 684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * notice, this list of conditions and the following disclaimer in 694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the documentation and/or other materials provided with the 704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * distribution. 714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3. All advertising materials mentioning features or use of this 734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * software must display the following acknowledgment: 744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * "This product includes software developed by the OpenSSL Project 754c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * endorse or promote products derived from this software without 794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * prior written permission. For written permission, please contact 804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * openssl-core@openssl.org. 814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 5. Products derived from this software may not be called "OpenSSL" 834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * nor may "OpenSSL" appear in their names without prior written 844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * permission of the OpenSSL Project. 854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 6. Redistributions of any form whatsoever must retain the following 874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * acknowledgment: 884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * "This product includes software developed by the OpenSSL Project 894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * for use in the OpenSSL Toolkit (http://www.openssl.org/)" 904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 1004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 1014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 1024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * OF THE POSSIBILITY OF SUCH DAMAGE. 1034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ==================================================================== 1044c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * This product includes cryptographic software written by Eric Young 1064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * (eay@cryptsoft.com). This product includes software written by Tim 1074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Hudson (tjh@cryptsoft.com). */ 1084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#ifndef OPENSSL_HEADER_ERR_H 1104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define OPENSSL_HEADER_ERR_H 1114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#include <openssl/base.h> 1134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#include <openssl/thread.h> 1144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#include <openssl/lhash.h> 1154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#if defined(__cplusplus) 1174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleyextern "C" { 1184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#endif 1194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Error queue handling functions. 1224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Errors in OpenSSL are generally signalled by the return value of a function. 1244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * When a function fails it may add an entry to a per-thread error queue, 1254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * which is managed by the functions in this header. 1264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Each error contains: 1284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1) The library (i.e. ec, pem, rsa) which created it. 1294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2) A function identifier and reason code. 1304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3) The file and line number of the call that added the error. 1314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4) A pointer to some error specific data, which may be NULL. 1324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The library identifier, function identifier and reason code are packed in a 1344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * uint32_t and there exist various functions for unpacking it. 1354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1364c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The typical behaviour is that an error will occur deep in a call queue and 1374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * that code will push an error onto the error queue. As the error queue 1384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * unwinds, other functions will push their own errors. Thus, the "least 1394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * recent" error is the most specific and the other errors will provide a 1404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * backtrace of sorts. */ 1414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Startup and shutdown. */ 1444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_load_crypto_strings initialises the error string hash with builtin 1464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * values. If this is not called then the string forms of errors produced by 1474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the functions below will contain numeric identifiers rather than 1484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * human-readable strings. */ 149c44d2f4cb8a892a603edbbe710fa82bcd30f9cb5David BenjaminOPENSSL_EXPORT void ERR_load_crypto_strings(void); 1504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_free_strings frees any internal error values that have been loaded. This 1524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * should only be called at process shutdown. */ 153c44d2f4cb8a892a603edbbe710fa82bcd30f9cb5David BenjaminOPENSSL_EXPORT void ERR_free_strings(void); 1544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Reading and formatting errors. */ 1574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_get_error gets the packed error code for the least recent error and 1594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * removes that error from the queue. If there are no errors in the queue then 1604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * it returns zero. */ 161eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT uint32_t ERR_get_error(void); 1624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_get_error_line acts like |ERR_get_error|, except that the file and line 1644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * number of the call that added the error are also returned. */ 165eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT uint32_t ERR_get_error_line(const char **file, int *line); 1664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_get_error_line_data acts like |ERR_get_error_line|, but also returns the 1684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * error-specific data pointer and flags. The flags are a bitwise-OR of 1694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |ERR_FLAG_*| values. */ 170eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT uint32_t ERR_get_error_line_data(const char **file, int *line, 171eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley char **data, int *flags); 1724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* The "peek" functions act like the |ERR_get_error| functions, above, but they 1744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * do not remove the error from the queue. */ 175eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT uint32_t ERR_peek_error(void); 176eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT uint32_t ERR_peek_error_line(const char **file, int *line); 177eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT uint32_t ERR_peek_error_line_data(const char **file, int *line, 178eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley const char **data, int *flags); 1794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* The "peek last" functions act like the "peek" functions, above, except that 1814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * they return the most recent error. */ 182eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT uint32_t ERR_peek_last_error(void); 183eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT uint32_t ERR_peek_last_error_line(const char **file, int *line); 184eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT uint32_t 185eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley ERR_peek_last_error_line_data(const char **file, int *line, 186eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley const char **data, int *flags); 1874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_error_string generates a human-readable string representing 1894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |packed_error|, places it at |buf| (which must be at least 1904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ERR_ERROR_STRING_BUF_LEN bytes long) and returns |buf|. If |buf| is NULL, 1914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the error string is placed in a static buffer which is returned. (The static 1924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * buffer may be overridden by concurrent calls in other threads so this form 1934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * is deprecated.) 1944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The string will have the following format: 1964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * error:[error code]:[library name]:[function name]:[reason string] 1984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * error code is an 8 digit hexadecimal number; library name, function name 2004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * and reason string are ASCII text. 2014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * TODO(fork): remove in favour of |ERR_error_string_n|. */ 203eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT char *ERR_error_string(uint32_t packed_error, char *buf); 2044c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_ERROR_STRING_BUF_LEN 256 2054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_error_string_n is a variant of |ERR_error_string| that writes at most 2074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * len characters (including the terminating NUL) and truncates the string if 2084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * necessary. If |len| is greater than zero then |buf| is always NUL 2094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * terminated. */ 210eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void ERR_error_string_n(uint32_t packed_error, char *buf, 211eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley size_t len); 2124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_lib_error_string returns a string representation of the library that 2144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * generated |packed_error|. */ 215eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const char *ERR_lib_error_string(uint32_t packed_error); 2164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_func_error_string returns a string representation of the function that 2184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * generated |packed_error|. */ 219eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const char *ERR_func_error_string(uint32_t packed_error); 2204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_reason_error_string returns a string representation of the reason for 2224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |packed_error|. */ 223eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const char *ERR_reason_error_string(uint32_t packed_error); 2244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_print_errors_callback_t is the type of a function used by 2264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |ERR_print_errors_cb|. It takes a pointer to a human readable string (and 2274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * its length) that describes an entry in the error queue. The |ctx| argument 2284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * is an opaque pointer given to |ERR_print_errors_cb|. 2294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It should return one on success or zero on error, which will stop the 2314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * iteration over the error queue. */ 2324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleytypedef int (*ERR_print_errors_callback_t)(const char *str, size_t len, 2334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley void *ctx); 2344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_print_errors_cb calls |callback| with a string representation of each 2364c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * error in the current thread's error queue, from the least recent to the most 2374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * recent error. 2384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The string will have the following format (which differs from 2404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |ERR_error_string|): 2414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * [thread id]:error:[error code]:[library name]:[function name]: 2434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * [reason string]:[file]:[line number]:[optional string data] 2444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * (All in one line.) 2464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The callback can return one to continue the iteration or zero to stop it. 2484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The |ctx| argument is an opaque value that is passed through to the 2494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * callback. */ 250eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void ERR_print_errors_cb(ERR_print_errors_callback_t callback, 251eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley void *ctx); 2524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Clearing errors. */ 2554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_clear_error clears the error queue for the current thread. */ 257eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void ERR_clear_error(void); 2584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 25903d31ed3e49a71e9ea09232d817cb1200b7a9149Adam Langley/* ERR_remove_thread_state deletes the error queue for the given thread. If 26003d31ed3e49a71e9ea09232d817cb1200b7a9149Adam Langley * |tid| is NULL then the error queue for the current thread is deleted. */ 26103d31ed3e49a71e9ea09232d817cb1200b7a9149Adam LangleyOPENSSL_EXPORT void ERR_remove_thread_state(const CRYPTO_THREADID *tid); 26203d31ed3e49a71e9ea09232d817cb1200b7a9149Adam Langley 2634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Custom errors. */ 2654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_get_next_error_library returns a value suitable for passing as the 2674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |library| argument to |ERR_put_error|. This is intended for code that wishes 2684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * to push its own, non-standard errors to the error queue. */ 269c44d2f4cb8a892a603edbbe710fa82bcd30f9cb5David BenjaminOPENSSL_EXPORT int ERR_get_next_error_library(void); 2704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Private functions. */ 2734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_clear_system_error clears the system's error value (i.e. errno). */ 275eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void ERR_clear_system_error(void); 2764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* OPENSSL_PUT_ERROR is used by OpenSSL code to add an error to the error 2784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * queue. */ 2794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define OPENSSL_PUT_ERROR(library, func, reason) \ 2804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_put_error(ERR_LIB_##library, library##_F_##func, reason, __FILE__, \ 2814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley __LINE__) 2824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* OPENSSL_PUT_SYSTEM_ERROR is used by OpenSSL code to add an error from the 2844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * operating system to the error queue. */ 2854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* TODO(fork): include errno. */ 2864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define OPENSSL_PUT_SYSTEM_ERROR(func) \ 2874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_put_error(ERR_LIB_SYS, SYS_F_##func, 0, __FILE__, __LINE__); 2884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_put_error adds an error to the error queue, dropping the least recent 2904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * error if neccessary for space reasons. */ 291eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void ERR_put_error(int library, int func, int reason, 292eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley const char *file, unsigned line); 2934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_add_error_data takes a variable number (|count|) of const char* 2954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * pointers, concatenates them and sets the result as the data on the most 2964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * recent error. */ 297eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void ERR_add_error_data(unsigned count, ...); 2984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_add_error_dataf takes a printf-style format and arguments, and sets the 3004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * result as the data on the most recent error. */ 301eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void ERR_add_error_dataf(const char *format, ...); 3024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_set_mark "marks" the most recent error for use with |ERR_pop_to_mark|. 3044c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It returns one if an error was marked and zero if there are no errors. */ 305eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int ERR_set_mark(void); 3064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_pop_to_mark removes errors from the most recent to the least recent 3084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * until (and not including) a "marked" error. It returns zero if no marked 3094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * error was found (and thus all errors were removed) and one otherwise. Errors 3104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * are marked using |ERR_set_mark|. */ 311eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int ERR_pop_to_mark(void); 3124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleystruct err_error_st { 3144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* file contains the filename where the error occured. */ 3154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley const char *file; 3164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* data contains optional data. It must be freed with |OPENSSL_free| if 3174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |flags&ERR_FLAG_MALLOCED|. */ 3184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley char *data; 3194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* packed contains the error library, function and reason, as packed by 3204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ERR_PACK. */ 3214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley uint32_t packed; 3224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* line contains the line number where the error occured. */ 3234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley uint16_t line; 3244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* flags contains a bitwise-OR of ERR_FLAG_* values. */ 3254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley uint8_t flags; 3264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley}; 3274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_FLAG_MALLOCED means the the |data| member must be freed when no longer 3294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * needed. */ 3304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_FLAG_MALLOCED 1 3314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_FLAG_STRING means that the |data| member is a NUL-terminated string that 3324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * can be printed. */ 3334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_FLAG_STRING 2 334c3e431762aea5cc2f739bb7fbcf0cb55c4f831a3Piotr Sikora/* ERR_TXT_STRING is provided for compatibility with code that assumes that 335c3e431762aea5cc2f739bb7fbcf0cb55c4f831a3Piotr Sikora * it's using OpenSSL. */ 336c3e431762aea5cc2f739bb7fbcf0cb55c4f831a3Piotr Sikora#define ERR_TXT_STRING ERR_FLAG_STRING 3374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_FLAG_PUBLIC_MASK is applied to the flags field before it is returned 3394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * from functions like |ERR_get_error_line_data|. */ 3404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_FLAG_PUBLIC_MASK 0xf 3414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* The following flag values are internal and are masked when flags are 3434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * returned from functions like |ERR_get_error_line_data|. */ 3444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_FLAG_MARK is used to indicate a reversion point in the queue. See 3464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |ERR_pop_to_mark|. */ 3474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_FLAG_MARK 16 3484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_NUM_ERRORS is the limit of the number of errors in the queue. */ 3504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_NUM_ERRORS 16 3514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_STATE contains the per-thread, error queue. */ 3534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleytypedef struct err_state_st { 3544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* tid is the identifier of the thread that owns this queue. */ 3554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley CRYPTO_THREADID tid; 3564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* errors contains the ERR_NUM_ERRORS most recent errors, organised as a ring 3584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * buffer. */ 3594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley struct err_error_st errors[ERR_NUM_ERRORS]; 3604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* top contains the index one past the most recent error. If |top| equals 3614c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |bottom| then the queue is empty. */ 3624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley unsigned top; 3634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* bottom contains the index of the last error in the queue. */ 3644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley unsigned bottom; 3654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley} ERR_STATE; 3664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleyenum { 3684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_NONE = 1, 3694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_SYS, 3704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_BN, 3714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_RSA, 3724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_DH, 3734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_EVP, 3744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_BUF, 3754c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_OBJ, 3764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_PEM, 3774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_DSA, 3784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_X509, 3794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_ASN1, 3804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_CONF, 3814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_CRYPTO, 3824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_EC, 3834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_SSL, 3844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_BIO, 3854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_PKCS7, 3864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_PKCS8, 3874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_X509V3, 3884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_PKCS12, 3894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_RAND, 3904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_ENGINE, 3914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_OCSP, 3924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_UI, 3934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_COMP, 3944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_ECDSA, 3954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_ECDH, 3964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_HMAC, 3974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_DIGEST, 3984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_CIPHER, 3994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_LIB_USER, 4004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_NUM_LIBS 4014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley}; 4024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_SYS_LIB ERR_LIB_SYS 4044c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_BN_LIB ERR_LIB_BN 4054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_RSA_LIB ERR_LIB_RSA 4064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_DH_LIB ERR_LIB_DH 4074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_EVP_LIB ERR_LIB_EVP 4084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_BUF_LIB ERR_LIB_BUF 4094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_OBJ_LIB ERR_LIB_OBJ 4104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_PEM_LIB ERR_LIB_PEM 4114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_DSA_LIB ERR_LIB_DSA 4124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_X509_LIB ERR_LIB_X509 4134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_ASN1_LIB ERR_LIB_ASN1 4144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_CONF_LIB ERR_LIB_CONF 4154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO 4164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_EC_LIB ERR_LIB_EC 4174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_SSL_LIB ERR_LIB_SSL 4184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_BIO_LIB ERR_LIB_BIO 4194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_PKCS7_LIB ERR_LIB_PKCS7 4204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_PKCS8_LIB ERR_LIB_PKCS8 4214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_X509V3_LIB ERR_LIB_X509V3 4224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_PKCS12_LIB ERR_LIB_PKCS12 4234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_RAND_LIB ERR_LIB_RAND 4244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_DSO_LIB ERR_LIB_DSO 4254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_ENGINE_LIB ERR_LIB_ENGINE 4264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_OCSP_LIB ERR_LIB_OCSP 4274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_UI_LIB ERR_LIB_UI 4284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_COMP_LIB ERR_LIB_COMP 4294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_ECDSA_LIB ERR_LIB_ECDSA 4304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_ECDH_LIB ERR_LIB_ECDH 4314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_STORE_LIB ERR_LIB_STORE 4324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_FIPS_LIB ERR_LIB_FIPS 4334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_CMS_LIB ERR_LIB_CMS 4344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_TS_LIB ERR_LIB_TS 4354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_HMAC_LIB ERR_LIB_HMAC 4364c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_JPAKE_LIB ERR_LIB_JPAKE 4374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_USER_LIB ERR_LIB_USER 4384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_DIGEST_LIB ERR_LIB_DIGEST 4394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_CIPHER_LIB ERR_LIB_CIPHER 4404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Global reasons. */ 4424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_FATAL 64 4434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_MALLOC_FAILURE (1 | ERR_R_FATAL) 4444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2 | ERR_R_FATAL) 4454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_PASSED_NULL_PARAMETER (3 | ERR_R_FATAL) 4464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_R_INTERNAL_ERROR (4 | ERR_R_FATAL) 447660140206ed32aa217ba3f299debae8d9ac472ecAdam Langley#define ERR_R_OVERFLOW (5 | ERR_R_FATAL) 4484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* System error functions */ 4504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define SYS_F_fopen 100 4514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define SYS_F_fclose 101 4524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define SYS_F_fread 102 4534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define SYS_F_fwrite 103 4544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define SYS_F_socket 104 4554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define SYS_F_setsockopt 105 4564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define SYS_F_connect 106 4574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define SYS_F_getaddrinfo 107 4584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_PACK(lib, func, reason) \ 4604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley (((((uint32_t)lib) & 0xff) << 24) | ((((uint32_t)func) & 0xfff) << 12) | \ 4614c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ((((uint32_t)reason) & 0xfff))) 4624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_GET_LIB(packed_error) (((packed_error) >> 24) & 0xff) 4644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_GET_FUNC(packed_error) (((packed_error) >> 12) & 0xfff) 4654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define ERR_GET_REASON(packed_error) ((packed_error) & 0xfff) 4664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_STRING_DATA is the type of an lhash node that contains a mapping from a 4684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * library, function or reason code to a string representation of it. */ 4694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleytypedef struct err_string_data_st { 4704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley uint32_t error; 4714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley const char *string; 4724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley} ERR_STRING_DATA; 4734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_load_strings loads an array of ERR_STRING_DATA into the hash table. The 4754c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * array must be terminated by an entry with a NULL string. */ 476eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void ERR_load_strings(const ERR_STRING_DATA *str); 4774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_FNS_st is a structure of function pointers that contains the actual 4794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * implementation of the error queue handling functions. */ 4804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleystruct ERR_FNS_st { 4814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley void (*shutdown)(void); 4824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_STRING_DATA *(*get_item)(uint32_t packed_error); 4834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_STRING_DATA *(*set_item)(const ERR_STRING_DATA *); 4844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_STRING_DATA *(*del_item)(uint32_t packed_error); 4854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* get_state returns the ERR_STATE for the current thread. This function 4874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * never returns NULL. */ 4884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley ERR_STATE *(*get_state)(void); 4894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 49003d31ed3e49a71e9ea09232d817cb1200b7a9149Adam Langley /* release_state returns the |ERR_STATE| for the given thread, or NULL if 49103d31ed3e49a71e9ea09232d817cb1200b7a9149Adam Langley * none exists. It the return value is not NULL, it also returns ownership of 49203d31ed3e49a71e9ea09232d817cb1200b7a9149Adam Langley * the |ERR_STATE| and deletes it from its data structures. */ 49303d31ed3e49a71e9ea09232d817cb1200b7a9149Adam Langley ERR_STATE *(*release_state)(const CRYPTO_THREADID *tid); 49403d31ed3e49a71e9ea09232d817cb1200b7a9149Adam Langley 4954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* get_next_library returns a unique value suitable for passing as the 4964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |library| to error calls. It will be distinct from all built-in library 4974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * values. */ 4984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int (*get_next_library)(void); 4994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley}; 5004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* OPENSSL_DECLARE_ERROR_REASON is used by util/make_errors.h (which generates 5024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the error defines) to recognise that an additional reason value is needed. 5034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * This is needed when the reason value is used outside of an 5044c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |OPENSSL_PUT_ERROR| macro. The resulting define will be 5054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ${lib}_R_${reason}. */ 5064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define OPENSSL_DECLARE_ERROR_REASON(lib, reason) 5074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* OPENSSL_DECLARE_ERROR_FUNCTION is used by util/make_errors.h (which 5094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * generates the error * defines to recognise that an additional function value 5104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * is needed. This is * needed when the function value is used outside of an 5114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |OPENSSL_PUT_ERROR| * macro. The resulting define will be 5124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ${lib}_F_${reason}. */ 5134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define OPENSSL_DECLARE_ERROR_FUNCTION(lib, function_name) 5144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* ERR_load_BIO_strings does nothing. 5164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 5174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * TODO(fork): remove. libjingle calls this. */ 518c44d2f4cb8a892a603edbbe710fa82bcd30f9cb5David BenjaminOPENSSL_EXPORT void ERR_load_BIO_strings(void); 5194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#if defined(__cplusplus) 5224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley} /* extern C */ 5234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#endif 5244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#endif /* OPENSSL_HEADER_ERR_H */ 526