[thirdparty/openssl.git] / include / openssl / err.h

/*
 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#ifndef OPENSSL_ERR_H
# define OPENSSL_ERR_H
# pragma once

# include <openssl/macros.h>
# ifndef OPENSSL_NO_DEPRECATED_3_0
#  define HEADER_ERR_H
# endif

# include <openssl/e_os2.h>

# ifndef OPENSSL_NO_STDIO
#  include <stdio.h>
#  include <stdlib.h>
# endif

# include <openssl/types.h>
# include <openssl/bio.h>
# include <openssl/lhash.h>

#ifdef  __cplusplus
extern "C" {
#endif

# ifndef OPENSSL_NO_DEPRECATED_3_0
#  ifndef OPENSSL_NO_FILENAMES
#   define ERR_PUT_error(l,f,r,fn,ln)      ERR_put_error(l,f,r,fn,ln)
#  else
#   define ERR_PUT_error(l,f,r,fn,ln)      ERR_put_error(l,f,r,NULL,0)
#  endif
# endif

# include <limits.h>
# include <errno.h>

# define ERR_TXT_MALLOCED        0x01
# define ERR_TXT_STRING          0x02

# if !defined(OPENSSL_NO_DEPRECATED_3_0) || defined(OSSL_FORCE_ERR_STATE)
#  define ERR_FLAG_MARK           0x01
#  define ERR_FLAG_CLEAR          0x02

#  define ERR_NUM_ERRORS  16
struct err_state_st {
    int err_flags[ERR_NUM_ERRORS];
    unsigned long err_buffer[ERR_NUM_ERRORS];
    char *err_data[ERR_NUM_ERRORS];
    size_t err_data_size[ERR_NUM_ERRORS];
    int err_data_flags[ERR_NUM_ERRORS];
    const char *err_file[ERR_NUM_ERRORS];
    int err_line[ERR_NUM_ERRORS];
    const char *err_func[ERR_NUM_ERRORS];
    int top, bottom;
};
# endif

/* library */
# define ERR_LIB_NONE            1
# define ERR_LIB_SYS             2
# define ERR_LIB_BN              3
# define ERR_LIB_RSA             4
# define ERR_LIB_DH              5
# define ERR_LIB_EVP             6
# define ERR_LIB_BUF             7
# define ERR_LIB_OBJ             8
# define ERR_LIB_PEM             9
# define ERR_LIB_DSA             10
# define ERR_LIB_X509            11
/* #define ERR_LIB_METH         12 */
# define ERR_LIB_ASN1            13
# define ERR_LIB_CONF            14
# define ERR_LIB_CRYPTO          15
# define ERR_LIB_EC              16
# define ERR_LIB_SSL             20
/* #define ERR_LIB_SSL23        21 */
/* #define ERR_LIB_SSL2         22 */
/* #define ERR_LIB_SSL3         23 */
/* #define ERR_LIB_RSAREF       30 */
/* #define ERR_LIB_PROXY        31 */
# define ERR_LIB_BIO             32
# define ERR_LIB_PKCS7           33
# define ERR_LIB_X509V3          34
# define ERR_LIB_PKCS12          35
# define ERR_LIB_RAND            36
# define ERR_LIB_DSO             37
# define ERR_LIB_ENGINE          38
# define ERR_LIB_OCSP            39
# define ERR_LIB_UI              40
# define ERR_LIB_COMP            41
# define ERR_LIB_ECDSA           42
# define ERR_LIB_ECDH            43
# define ERR_LIB_OSSL_STORE      44
# define ERR_LIB_FIPS            45
# define ERR_LIB_CMS             46
# define ERR_LIB_TS              47
# define ERR_LIB_HMAC            48
/* # define ERR_LIB_JPAKE       49 */
# define ERR_LIB_CT              50
# define ERR_LIB_ASYNC           51
# define ERR_LIB_KDF             52
# define ERR_LIB_SM2             53
# define ERR_LIB_ESS             54
# define ERR_LIB_PROP            55
# define ERR_LIB_CRMF            56
# define ERR_LIB_PROV            57
# define ERR_LIB_CMP             58
# define ERR_LIB_OSSL_ENCODER 59
# define ERR_LIB_OSSL_DECODER 60
# define ERR_LIB_HTTP            61

# define ERR_LIB_USER            128

# if 1 || !defined(OPENSSL_NO_DEPRECATED_3_0)
#  define ASN1err(f, r) ERR_raise_data(ERR_LIB_ASN1, (r), NULL)
#  define ASYNCerr(f, r) ERR_raise_data(ERR_LIB_ASYNC, (r), NULL)
#  define BIOerr(f, r) ERR_raise_data(ERR_LIB_BIO, (r), NULL)
#  define BNerr(f, r)  ERR_raise_data(ERR_LIB_BN, (r), NULL)
#  define BUFerr(f, r) ERR_raise_data(ERR_LIB_BUF, (r), NULL)
#  define CMPerr(f, r) ERR_raise_data(ERR_LIB_CMP, (r), NULL)
#  define CMSerr(f, r) ERR_raise_data(ERR_LIB_CMS, (r), NULL)
#  define COMPerr(f, r) ERR_raise_data(ERR_LIB_COMP, (r), NULL)
#  define CONFerr(f, r) ERR_raise_data(ERR_LIB_CONF, (r), NULL)
#  define CRMFerr(f, r) ERR_raise_data(ERR_LIB_CRMF, (r), NULL)
#  define CRYPTOerr(f, r) ERR_raise_data(ERR_LIB_CRYPTO, (r), NULL)
#  define CTerr(f, r) ERR_raise_data(ERR_LIB_CT, (r), NULL)
#  define DHerr(f, r)  ERR_raise_data(ERR_LIB_DH, (r), NULL)
#  define DSAerr(f, r) ERR_raise_data(ERR_LIB_DSA, (r), NULL)
#  define DSOerr(f, r) ERR_raise_data(ERR_LIB_DSO, (r), NULL)
#  define ECDHerr(f, r) ERR_raise_data(ERR_LIB_ECDH, (r), NULL)
#  define ECDSAerr(f, r) ERR_raise_data(ERR_LIB_ECDSA, (r), NULL)
#  define ECerr(f, r)  ERR_raise_data(ERR_LIB_EC, (r), NULL)
#  define ENGINEerr(f, r) ERR_raise_data(ERR_LIB_ENGINE, (r), NULL)
#  define ESSerr(f, r) ERR_raise_data(ERR_LIB_ESS, (r), NULL)
#  define EVPerr(f, r) ERR_raise_data(ERR_LIB_EVP, (r), NULL)
#  define FIPSerr(f, r) ERR_raise_data(ERR_LIB_FIPS, (r), NULL)
#  define HMACerr(f, r) ERR_raise_data(ERR_LIB_HMAC, (r), NULL)
#  define HTTPerr(f, r) ERR_raise_data(ERR_LIB_HTTP, (r), NULL)
#  define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
#  define OBJerr(f, r) ERR_raise_data(ERR_LIB_OBJ, (r), NULL)
#  define OCSPerr(f, r) ERR_raise_data(ERR_LIB_OCSP, (r), NULL)
#  define OSSL_STOREerr(f, r) ERR_raise_data(ERR_LIB_OSSL_STORE, (r), NULL)
#  define PEMerr(f, r) ERR_raise_data(ERR_LIB_PEM, (r), NULL)
#  define PKCS12err(f, r) ERR_raise_data(ERR_LIB_PKCS12, (r), NULL)
#  define PKCS7err(f, r) ERR_raise_data(ERR_LIB_PKCS7, (r), NULL)
#  define PROPerr(f, r) ERR_raise_data(ERR_LIB_PROP, (r), NULL)
#  define PROVerr(f, r) ERR_raise_data(ERR_LIB_PROV, (r), NULL)
#  define RANDerr(f, r) ERR_raise_data(ERR_LIB_RAND, (r), NULL)
#  define RSAerr(f, r) ERR_raise_data(ERR_LIB_RSA, (r), NULL)
#  define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
#  define SM2err(f, r) ERR_raise_data(ERR_LIB_SM2, (r), NULL)
#  define SSLerr(f, r) ERR_raise_data(ERR_LIB_SSL, (r), NULL)
#  define SYSerr(f, r) ERR_raise_data(ERR_LIB_SYS, (r), NULL)
#  define TSerr(f, r) ERR_raise_data(ERR_LIB_TS, (r), NULL)
#  define UIerr(f, r) ERR_raise_data(ERR_LIB_UI, (r), NULL)
#  define X509V3err(f, r) ERR_raise_data(ERR_LIB_X509V3, (r), NULL)
#  define X509err(f, r) ERR_raise_data(ERR_LIB_X509, (r), NULL)
# endif

/*-
 * The error code packs differently depending on if it records a system
 * error or an OpenSSL error.
 *
 * A system error packs like this (we follow POSIX and only allow positive
 * numbers that fit in an |int|):
 *
 * +-+-------------------------------------------------------------+
 * |1|                     system error number                     |
 * +-+-------------------------------------------------------------+
 *
 * An OpenSSL error packs like this:
 *
 * <---------------------------- 32 bits -------------------------->
 *    <--- 8 bits ---><------------------ 23 bits ----------------->
 * +-+---------------+---------------------------------------------+
 * |0|    library    |                    reason                   |
 * +-+---------------+---------------------------------------------+
 *
 * A few of the reason bits are reserved as flags with special meaning:
 *
 *                    <4 bits><-------------- 19 bits ------------->
 *                   +-------+-------------------------------------+
 *                   | rflags|                reason               |
 *                   +-------+-------------------------------------+
 *
 * We have the reason flags being part of the overall reason code for
 * backward compatibility reasons, i.e. how ERR_R_FATAL was implemented.
 */

/* Macros to help decode recorded system errors */
# define ERR_SYSTEM_FLAG                ((unsigned int)INT_MAX + 1)
# define ERR_SYSTEM_MASK                ((unsigned int)INT_MAX)

/* Macros to help decode recorded OpenSSL errors */
# define ERR_LIB_OFFSET                 23L
# define ERR_LIB_MASK                   0xFF
# define ERR_RFLAGS_OFFSET              19L
# define ERR_RFLAGS_MASK                0xF
# define ERR_REASON_MASK                0X7FFFFF

/*
 * Reason flags are defined pre-shifted to easily combine with the reason
 * number.
 */
# define ERR_RFLAG_FATAL                (0x1 << ERR_RFLAGS_OFFSET)

# define ERR_SYSTEM_ERROR(errcode)      (((errcode) & ERR_SYSTEM_FLAG) != 0)

static ossl_inline int ERR_GET_LIB(unsigned long errcode)
{
    if (ERR_SYSTEM_ERROR(errcode))
        return ERR_LIB_SYS;
    return (errcode >> ERR_LIB_OFFSET) & ERR_LIB_MASK;
}

static ossl_inline int ERR_GET_FUNC(unsigned long errcode ossl_unused)
{
    return 0;
}

static ossl_inline int ERR_GET_RFLAGS(unsigned long errcode)
{
    if (ERR_SYSTEM_ERROR(errcode))
        return 0;
    return errcode & (ERR_RFLAGS_MASK << ERR_RFLAGS_OFFSET);
}

static ossl_inline int ERR_GET_REASON(unsigned long errcode)
{
    if (ERR_SYSTEM_ERROR(errcode))
        return errcode & ERR_SYSTEM_MASK;
    return errcode & ERR_REASON_MASK;
}

static ossl_inline int ERR_FATAL_ERROR(unsigned long errcode)
{
    return (ERR_GET_RFLAGS(errcode) & ERR_RFLAG_FATAL) != 0;
}

/*
 * ERR_PACK is a helper macro to properly pack OpenSSL error codes and may
 * only be used for that purpose.  System errors are packed internally.
 * ERR_PACK takes reason flags and reason code combined in |reason|.
 * ERR_PACK ignores |func|, that parameter is just legacy from pre-3.0 OpenSSL.
 */
# define ERR_PACK(lib,func,reason)                                      \
    ( (((unsigned long)(lib)    & ERR_LIB_MASK   ) << ERR_LIB_OFFSET) | \
      (((unsigned long)(reason) & ERR_REASON_MASK)) )

# ifndef OPENSSL_NO_DEPRECATED_3_0
#  define SYS_F_FOPEN             0
#  define SYS_F_CONNECT           0
#  define SYS_F_GETSERVBYNAME     0
#  define SYS_F_SOCKET            0
#  define SYS_F_IOCTLSOCKET       0
#  define SYS_F_BIND              0
#  define SYS_F_LISTEN            0
#  define SYS_F_ACCEPT            0
#  define SYS_F_WSASTARTUP        0
#  define SYS_F_OPENDIR           0
#  define SYS_F_FREAD             0
#  define SYS_F_GETADDRINFO       0
#  define SYS_F_GETNAMEINFO       0
#  define SYS_F_SETSOCKOPT        0
#  define SYS_F_GETSOCKOPT        0
#  define SYS_F_GETSOCKNAME       0
#  define SYS_F_GETHOSTBYNAME     0
#  define SYS_F_FFLUSH            0
#  define SYS_F_OPEN              0
#  define SYS_F_CLOSE             0
#  define SYS_F_IOCTL             0
#  define SYS_F_STAT              0
#  define SYS_F_FCNTL             0
#  define SYS_F_FSTAT             0
#  define SYS_F_SENDFILE          0
# endif

/* "we came from here" global reason codes, range 1..63 */
# define ERR_R_SYS_LIB   ERR_LIB_SYS/* 2 */
# define ERR_R_BN_LIB    ERR_LIB_BN/* 3 */
# define ERR_R_RSA_LIB   ERR_LIB_RSA/* 4 */
# define ERR_R_DH_LIB    ERR_LIB_DH/* 5 */
# define ERR_R_EVP_LIB   ERR_LIB_EVP/* 6 */
# define ERR_R_BUF_LIB   ERR_LIB_BUF/* 7 */
# define ERR_R_OBJ_LIB   ERR_LIB_OBJ/* 8 */
# define ERR_R_PEM_LIB   ERR_LIB_PEM/* 9 */
# define ERR_R_DSA_LIB   ERR_LIB_DSA/* 10 */
# define ERR_R_X509_LIB  ERR_LIB_X509/* 11 */
# define ERR_R_ASN1_LIB  ERR_LIB_ASN1/* 13 */
# define ERR_R_EC_LIB    ERR_LIB_EC/* 16 */
# define ERR_R_BIO_LIB   ERR_LIB_BIO/* 32 */
# define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
# define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
# define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
# define ERR_R_UI_LIB    ERR_LIB_UI/* 40 */
# define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
# define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */

/*
 * global reason codes, range 64..99 (sub-system specific codes start at 100)
 *
 * ERR_R_FATAL had dual purposes in pre-3.0 OpenSSL, as a standalone reason
 * code as well as a fatal flag.  This is still possible to do, as 2**6 (64)
 * is present in the whole range of global reason codes.
 */
# define ERR_R_FATAL                             (64|ERR_RFLAG_FATAL)
# define ERR_R_MALLOC_FAILURE                    (65|ERR_RFLAG_FATAL)
# define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED       (66|ERR_RFLAG_FATAL)
# define ERR_R_PASSED_NULL_PARAMETER             (67|ERR_RFLAG_FATAL)
# define ERR_R_INTERNAL_ERROR                    (68|ERR_RFLAG_FATAL)
# define ERR_R_DISABLED                          (69|ERR_RFLAG_FATAL)
# define ERR_R_INIT_FAIL                         (70|ERR_RFLAG_FATAL)
# define ERR_R_PASSED_INVALID_ARGUMENT           (71)
# define ERR_R_OPERATION_FAIL                    (72|ERR_RFLAG_FATAL)
# define ERR_R_INVALID_PROVIDER_FUNCTIONS        (73|ERR_RFLAG_FATAL)
# define ERR_R_INTERRUPTED_OR_CANCELLED          (74)
# define ERR_R_NESTED_ASN1_ERROR                 (76)
# define ERR_R_MISSING_ASN1_EOS                  (77)

/*
 * 99 is the maximum possible ERR_R_... code, higher values are reserved for
 * the individual libraries
 */

typedef struct ERR_string_data_st {
    unsigned long error;
    const char *string;
} ERR_STRING_DATA;

DEFINE_LHASH_OF(ERR_STRING_DATA);

/* 12 lines and some on an 80 column terminal */
#define ERR_MAX_DATA_SIZE       1024

/* Building blocks */
void ERR_new(void);
void ERR_set_debug(const char *file, int line, const char *func);
void ERR_set_error(int lib, int reason, const char *fmt, ...);
void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);

/* Main error raising functions */
# define ERR_raise(lib, reason) ERR_raise_data((lib),(reason),NULL)
# define ERR_raise_data                                         \
    (ERR_new(),                                                 \
     ERR_set_debug(OPENSSL_FILE,OPENSSL_LINE,OPENSSL_FUNC),     \
     ERR_set_error)

# ifndef OPENSSL_NO_DEPRECATED_3_0
/* Backward compatibility */
#  define ERR_put_error(lib, func, reason, file, line)          \
    (ERR_new(),                                                 \
     ERR_set_debug((file), (line), OPENSSL_FUNC),               \
     ERR_set_error((lib), (reason), NULL))
# endif

void ERR_set_error_data(char *data, int flags);

unsigned long ERR_get_error(void);
/*
 * TODO(3.0) consider if the following three functions should be deprecated.
 * They all drop the error record from the error queue, so regardless of which
 * one is used, the rest of the information is lost, making them not so useful.
 * The recommendation should be to use the peek functions to extract all the
 * additional data.
 */
unsigned long ERR_get_error_line(const char **file, int *line);
unsigned long ERR_get_error_func(const char **func);
unsigned long ERR_get_error_data(const char **data, int *flags);
unsigned long ERR_get_error_all(const char **file, int *line,
                                const char **func,
                                const char **data, int *flags);
DEPRECATEDIN_3_0(unsigned long ERR_get_error_line_data(const char **file,
                                                     int *line,
                                                     const char **data,
                                                     int *flags))
unsigned long ERR_peek_error(void);
unsigned long ERR_peek_error_line(const char **file, int *line);
unsigned long ERR_peek_error_func(const char **func);
unsigned long ERR_peek_error_data(const char **data, int *flags);
unsigned long ERR_peek_error_all(const char **file, int *line,
                                 const char **func,
                                 const char **data, int *flags);
DEPRECATEDIN_3_0(unsigned long ERR_peek_error_line_data(const char **file,
                                                      int *line,
                                                      const char **data,
                                                      int *flags))
unsigned long ERR_peek_last_error(void);
unsigned long ERR_peek_last_error_line(const char **file, int *line);
unsigned long ERR_peek_last_error_func(const char **func);
unsigned long ERR_peek_last_error_data(const char **data, int *flags);
unsigned long ERR_peek_last_error_all(const char **file, int *line,
                                      const char **func,
                                      const char **data, int *flags);
DEPRECATEDIN_3_0(unsigned long ERR_peek_last_error_line_data(const char **file,
                                                           int *line,
                                                           const char **data,
                                                           int *flags))

void ERR_clear_error(void);

char *ERR_error_string(unsigned long e, char *buf);
void ERR_error_string_n(unsigned long e, char *buf, size_t len);
const char *ERR_lib_error_string(unsigned long e);
DEPRECATEDIN_3_0(const char *ERR_func_error_string(unsigned long e))
const char *ERR_reason_error_string(unsigned long e);

void ERR_print_errors_cb(int (*cb) (const char *str, size_t len, void *u),
                         void *u);
# ifndef OPENSSL_NO_STDIO
void ERR_print_errors_fp(FILE *fp);
# endif
void ERR_print_errors(BIO *bp);

void ERR_add_error_data(int num, ...);
void ERR_add_error_vdata(int num, va_list args);
void ERR_add_error_txt(const char *sepr, const char *txt);
void ERR_add_error_mem_bio(const char *sep, BIO *bio);

int ERR_load_strings(int lib, ERR_STRING_DATA *str);
int ERR_load_strings_const(const ERR_STRING_DATA *str);
int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
int ERR_load_ERR_strings(void);

#ifndef OPENSSL_NO_DEPRECATED_1_1_0
# define ERR_load_crypto_strings() \
    OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
# define ERR_free_strings() while(0) continue
#endif

DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
DEPRECATEDIN_3_0(ERR_STATE *ERR_get_state(void))

int ERR_get_next_error_library(void);

int ERR_set_mark(void);
int ERR_pop_to_mark(void);
int ERR_clear_last_mark(void);

#ifdef  __cplusplus
}
#endif

#endif
Commit	Line	Data
21dcbebc	1	/*
33388b44	2	* Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
48fc582f	3	*
48f4ad77	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
21dcbebc RS	5	* this file except in compliance with the License. You can obtain a copy
	6	* in the file LICENSE in the source distribution or at
	7	* https://www.openssl.org/source/license.html
48fc582f	8	*/
d02b48c6	9
ae4186b0 DMSP	10	#ifndef OPENSSL_ERR_H
ae4186b0 DMSP	11	# define OPENSSL_ERR_H
d86167ec DMSP	12	# pragma once
	13
	14	# include <openssl/macros.h>
936c2b9e	15	# ifndef OPENSSL_NO_DEPRECATED_3_0
d86167ec DMSP	16	# define HEADER_ERR_H
d86167ec DMSP	17	# endif
d02b48c6	18
0f113f3e	19	# include <openssl/e_os2.h>
08a54f6e	20
0f113f3e MC	21	# ifndef OPENSSL_NO_STDIO
	22	# include <stdio.h>
	23	# include <stdlib.h>
	24	# endif
0b86eb3e	25
50cd4768	26	# include <openssl/types.h>
a00ae6c4 RS	27	# include <openssl/bio.h>
a00ae6c4 RS	28	# include <openssl/lhash.h>
ef33b970	29
0f113f3e	30	#ifdef __cplusplus
82271cee RL	31	extern "C" {
	32	#endif
	33
936c2b9e	34	# ifndef OPENSSL_NO_DEPRECATED_3_0
06ff79bd	35	# ifndef OPENSSL_NO_FILENAMES
586dd674 RL	36	# define ERR_PUT_error(l,f,r,fn,ln) ERR_put_error(l,f,r,fn,ln)
	37	# else
	38	# define ERR_PUT_error(l,f,r,fn,ln) ERR_put_error(l,f,r,NULL,0)
	39	# endif
0f113f3e	40	# endif
d02b48c6	41
71f2994b	42	# include <limits.h>
0f113f3e	43	# include <errno.h>
d02b48c6	44
0f113f3e MC	45	# define ERR_TXT_MALLOCED 0x01
0f113f3e MC	46	# define ERR_TXT_STRING 0x02
58964a49	47
936c2b9e	48	# if !defined(OPENSSL_NO_DEPRECATED_3_0) \|\| defined(OSSL_FORCE_ERR_STATE)
14e275e8 RL	49	# define ERR_FLAG_MARK 0x01
14e275e8 RL	50	# define ERR_FLAG_CLEAR 0x02
54f64516	51
14e275e8 RL	52	# define ERR_NUM_ERRORS 16
14e275e8 RL	53	struct err_state_st {
0f113f3e MC	54	int err_flags[ERR_NUM_ERRORS];
	55	unsigned long err_buffer[ERR_NUM_ERRORS];
	56	char *err_data[ERR_NUM_ERRORS];
10f8b368	57	size_t err_data_size[ERR_NUM_ERRORS];
0f113f3e MC	58	int err_data_flags[ERR_NUM_ERRORS];
	59	const char *err_file[ERR_NUM_ERRORS];
	60	int err_line[ERR_NUM_ERRORS];
8a4dc425	61	const char *err_func[ERR_NUM_ERRORS];
0f113f3e	62	int top, bottom;
14e275e8 RL	63	};
14e275e8 RL	64	# endif
d02b48c6 RE	65
d02b48c6 RE	66	/* library */
0f113f3e MC	67	# define ERR_LIB_NONE 1
	68	# define ERR_LIB_SYS 2
	69	# define ERR_LIB_BN 3
	70	# define ERR_LIB_RSA 4
	71	# define ERR_LIB_DH 5
	72	# define ERR_LIB_EVP 6
	73	# define ERR_LIB_BUF 7
	74	# define ERR_LIB_OBJ 8
	75	# define ERR_LIB_PEM 9
	76	# define ERR_LIB_DSA 10
	77	# define ERR_LIB_X509 11
5277d7cb	78	/* #define ERR_LIB_METH 12 */
0f113f3e MC	79	# define ERR_LIB_ASN1 13
	80	# define ERR_LIB_CONF 14
	81	# define ERR_LIB_CRYPTO 15
	82	# define ERR_LIB_EC 16
	83	# define ERR_LIB_SSL 20
5277d7cb BM	84	/* #define ERR_LIB_SSL23 21 */
	85	/* #define ERR_LIB_SSL2 22 */
	86	/* #define ERR_LIB_SSL3 23 */
	87	/* #define ERR_LIB_RSAREF 30 */
	88	/* #define ERR_LIB_PROXY 31 */
0f113f3e MC	89	# define ERR_LIB_BIO 32
	90	# define ERR_LIB_PKCS7 33
	91	# define ERR_LIB_X509V3 34
	92	# define ERR_LIB_PKCS12 35
	93	# define ERR_LIB_RAND 36
	94	# define ERR_LIB_DSO 37
	95	# define ERR_LIB_ENGINE 38
	96	# define ERR_LIB_OCSP 39
	97	# define ERR_LIB_UI 40
	98	# define ERR_LIB_COMP 41
	99	# define ERR_LIB_ECDSA 42
	100	# define ERR_LIB_ECDH 43
71a5516d	101	# define ERR_LIB_OSSL_STORE 44
0f113f3e MC	102	# define ERR_LIB_FIPS 45
	103	# define ERR_LIB_CMS 46
	104	# define ERR_LIB_TS 47
	105	# define ERR_LIB_HMAC 48
31a51151	106	/* # define ERR_LIB_JPAKE 49 */
3149baf8	107	# define ERR_LIB_CT 50
079a1a90	108	# define ERR_LIB_ASYNC 51
7c6a0d90 RL	109	# define ERR_LIB_KDF 52
	110	# define ERR_LIB_SM2 53
	111	# define ERR_LIB_ESS 54
	112	# define ERR_LIB_PROP 55
	113	# define ERR_LIB_CRMF 56
	114	# define ERR_LIB_PROV 57
	115	# define ERR_LIB_CMP 58
ece9304c RL	116	# define ERR_LIB_OSSL_ENCODER 59
ece9304c RL	117	# define ERR_LIB_OSSL_DECODER 60
c3e4c1f3	118	# define ERR_LIB_HTTP 61
0f113f3e MC	119
	120	# define ERR_LIB_USER 128
	121
936c2b9e	122	# if 1 \|\| !defined(OPENSSL_NO_DEPRECATED_3_0)
f6aca23e RS	123	# define ASN1err(f, r) ERR_raise_data(ERR_LIB_ASN1, (r), NULL)
	124	# define ASYNCerr(f, r) ERR_raise_data(ERR_LIB_ASYNC, (r), NULL)
	125	# define BIOerr(f, r) ERR_raise_data(ERR_LIB_BIO, (r), NULL)
	126	# define BNerr(f, r) ERR_raise_data(ERR_LIB_BN, (r), NULL)
	127	# define BUFerr(f, r) ERR_raise_data(ERR_LIB_BUF, (r), NULL)
	128	# define CMPerr(f, r) ERR_raise_data(ERR_LIB_CMP, (r), NULL)
	129	# define CMSerr(f, r) ERR_raise_data(ERR_LIB_CMS, (r), NULL)
	130	# define COMPerr(f, r) ERR_raise_data(ERR_LIB_COMP, (r), NULL)
	131	# define CONFerr(f, r) ERR_raise_data(ERR_LIB_CONF, (r), NULL)
	132	# define CRMFerr(f, r) ERR_raise_data(ERR_LIB_CRMF, (r), NULL)
	133	# define CRYPTOerr(f, r) ERR_raise_data(ERR_LIB_CRYPTO, (r), NULL)
	134	# define CTerr(f, r) ERR_raise_data(ERR_LIB_CT, (r), NULL)
	135	# define DHerr(f, r) ERR_raise_data(ERR_LIB_DH, (r), NULL)
	136	# define DSAerr(f, r) ERR_raise_data(ERR_LIB_DSA, (r), NULL)
	137	# define DSOerr(f, r) ERR_raise_data(ERR_LIB_DSO, (r), NULL)
	138	# define ECDHerr(f, r) ERR_raise_data(ERR_LIB_ECDH, (r), NULL)
	139	# define ECDSAerr(f, r) ERR_raise_data(ERR_LIB_ECDSA, (r), NULL)
	140	# define ECerr(f, r) ERR_raise_data(ERR_LIB_EC, (r), NULL)
	141	# define ENGINEerr(f, r) ERR_raise_data(ERR_LIB_ENGINE, (r), NULL)
	142	# define ESSerr(f, r) ERR_raise_data(ERR_LIB_ESS, (r), NULL)
	143	# define EVPerr(f, r) ERR_raise_data(ERR_LIB_EVP, (r), NULL)
	144	# define FIPSerr(f, r) ERR_raise_data(ERR_LIB_FIPS, (r), NULL)
	145	# define HMACerr(f, r) ERR_raise_data(ERR_LIB_HMAC, (r), NULL)
29f178bd	146	# define HTTPerr(f, r) ERR_raise_data(ERR_LIB_HTTP, (r), NULL)
f6aca23e RS	147	# define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
	148	# define OBJerr(f, r) ERR_raise_data(ERR_LIB_OBJ, (r), NULL)
	149	# define OCSPerr(f, r) ERR_raise_data(ERR_LIB_OCSP, (r), NULL)
	150	# define OSSL_STOREerr(f, r) ERR_raise_data(ERR_LIB_OSSL_STORE, (r), NULL)
	151	# define PEMerr(f, r) ERR_raise_data(ERR_LIB_PEM, (r), NULL)
	152	# define PKCS12err(f, r) ERR_raise_data(ERR_LIB_PKCS12, (r), NULL)
	153	# define PKCS7err(f, r) ERR_raise_data(ERR_LIB_PKCS7, (r), NULL)
	154	# define PROPerr(f, r) ERR_raise_data(ERR_LIB_PROP, (r), NULL)
	155	# define PROVerr(f, r) ERR_raise_data(ERR_LIB_PROV, (r), NULL)
	156	# define RANDerr(f, r) ERR_raise_data(ERR_LIB_RAND, (r), NULL)
	157	# define RSAerr(f, r) ERR_raise_data(ERR_LIB_RSA, (r), NULL)
7c6a0d90	158	# define KDFerr(f, r) ERR_raise_data(ERR_LIB_KDF, (r), NULL)
f6aca23e RS	159	# define SM2err(f, r) ERR_raise_data(ERR_LIB_SM2, (r), NULL)
	160	# define SSLerr(f, r) ERR_raise_data(ERR_LIB_SSL, (r), NULL)
	161	# define SYSerr(f, r) ERR_raise_data(ERR_LIB_SYS, (r), NULL)
	162	# define TSerr(f, r) ERR_raise_data(ERR_LIB_TS, (r), NULL)
	163	# define UIerr(f, r) ERR_raise_data(ERR_LIB_UI, (r), NULL)
	164	# define X509V3err(f, r) ERR_raise_data(ERR_LIB_X509V3, (r), NULL)
	165	# define X509err(f, r) ERR_raise_data(ERR_LIB_X509, (r), NULL)
ed57f7f9	166	# endif
0f113f3e	167
71f2994b RL	168	/*-
	169	* The error code packs differently depending on if it records a system
	170	* error or an OpenSSL error.
163b2bcd	171	*
71f2994b RL	172	* A system error packs like this (we follow POSIX and only allow positive
71f2994b RL	173	* numbers that fit in an \|int\|):
163b2bcd	174	*
71f2994b RL	175	* +-+-------------------------------------------------------------+
	176	* \|1\| system error number \|
	177	* +-+-------------------------------------------------------------+
	178	*
	179	* An OpenSSL error packs like this:
	180	*
	181	* <---------------------------- 32 bits -------------------------->
	182	* <--- 8 bits ---><------------------ 23 bits ----------------->
	183	* +-+---------------+---------------------------------------------+
	184	* \|0\| library \| reason \|
	185	* +-+---------------+---------------------------------------------+
	186	*
	187	* A few of the reason bits are reserved as flags with special meaning:
163b2bcd	188	*
71f2994b RL	189	* <4 bits><-------------- 19 bits ------------->
	190	* +-------+-------------------------------------+
	191	* \| rflags\| reason \|
	192	* +-------+-------------------------------------+
163b2bcd	193	*
71f2994b RL	194	* We have the reason flags being part of the overall reason code for
71f2994b RL	195	* backward compatibility reasons, i.e. how ERR_R_FATAL was implemented.
163b2bcd	196	*/
71f2994b RL	197
	198	/* Macros to help decode recorded system errors */
	199	# define ERR_SYSTEM_FLAG ((unsigned int)INT_MAX + 1)
	200	# define ERR_SYSTEM_MASK ((unsigned int)INT_MAX)
	201
	202	/* Macros to help decode recorded OpenSSL errors */
	203	# define ERR_LIB_OFFSET 23L
	204	# define ERR_LIB_MASK 0xFF
	205	# define ERR_RFLAGS_OFFSET 19L
	206	# define ERR_RFLAGS_MASK 0xF
	207	# define ERR_REASON_MASK 0X7FFFFF
163b2bcd RL	208
	209	/*
	210	* Reason flags are defined pre-shifted to easily combine with the reason
	211	* number.
	212	*/
71f2994b RL	213	# define ERR_RFLAG_FATAL (0x1 << ERR_RFLAGS_OFFSET)
	214
	215	# define ERR_SYSTEM_ERROR(errcode) (((errcode) & ERR_SYSTEM_FLAG) != 0)
	216
	217	static ossl_inline int ERR_GET_LIB(unsigned long errcode)
	218	{
	219	if (ERR_SYSTEM_ERROR(errcode))
	220	return ERR_LIB_SYS;
	221	return (errcode >> ERR_LIB_OFFSET) & ERR_LIB_MASK;
	222	}
	223
c5b356d5	224	static ossl_inline int ERR_GET_FUNC(unsigned long errcode ossl_unused)
71f2994b RL	225	{
	226	return 0;
	227	}
	228
	229	static ossl_inline int ERR_GET_RFLAGS(unsigned long errcode)
	230	{
	231	if (ERR_SYSTEM_ERROR(errcode))
	232	return 0;
	233	return errcode & (ERR_RFLAGS_MASK << ERR_RFLAGS_OFFSET);
	234	}
	235
	236	static ossl_inline int ERR_GET_REASON(unsigned long errcode)
	237	{
	238	if (ERR_SYSTEM_ERROR(errcode))
	239	return errcode & ERR_SYSTEM_MASK;
	240	return errcode & ERR_REASON_MASK;
	241	}
	242
	243	static ossl_inline int ERR_FATAL_ERROR(unsigned long errcode)
	244	{
	245	return (ERR_GET_RFLAGS(errcode) & ERR_RFLAG_FATAL) != 0;
	246	}
	247
	248	/*
	249	* ERR_PACK is a helper macro to properly pack OpenSSL error codes and may
	250	* only be used for that purpose. System errors are packed internally.
	251	* ERR_PACK takes reason flags and reason code combined in \|reason\|.
	252	* ERR_PACK ignores \|func\|, that parameter is just legacy from pre-3.0 OpenSSL.
	253	*/
	254	# define ERR_PACK(lib,func,reason) \
	255	( (((unsigned long)(lib) & ERR_LIB_MASK ) << ERR_LIB_OFFSET) \| \
	256	(((unsigned long)(reason) & ERR_REASON_MASK)) )
5277d7cb	257
936c2b9e	258	# ifndef OPENSSL_NO_DEPRECATED_3_0
a80278b0 RS	259	# define SYS_F_FOPEN 0
	260	# define SYS_F_CONNECT 0
	261	# define SYS_F_GETSERVBYNAME 0
	262	# define SYS_F_SOCKET 0
	263	# define SYS_F_IOCTLSOCKET 0
	264	# define SYS_F_BIND 0
	265	# define SYS_F_LISTEN 0
	266	# define SYS_F_ACCEPT 0
	267	# define SYS_F_WSASTARTUP 0
	268	# define SYS_F_OPENDIR 0
	269	# define SYS_F_FREAD 0
	270	# define SYS_F_GETADDRINFO 0
	271	# define SYS_F_GETNAMEINFO 0
	272	# define SYS_F_SETSOCKOPT 0
	273	# define SYS_F_GETSOCKOPT 0
	274	# define SYS_F_GETSOCKNAME 0
	275	# define SYS_F_GETHOSTBYNAME 0
	276	# define SYS_F_FFLUSH 0
	277	# define SYS_F_OPEN 0
	278	# define SYS_F_CLOSE 0
	279	# define SYS_F_IOCTL 0
	280	# define SYS_F_STAT 0
	281	# define SYS_F_FCNTL 0
	282	# define SYS_F_FSTAT 0
	283	# define SYS_F_SENDFILE 0
	284	# endif
	285
163b2bcd	286	/* "we came from here" global reason codes, range 1..63 */
0f113f3e MC	287	# define ERR_R_SYS_LIB ERR_LIB_SYS/* 2 */
	288	# define ERR_R_BN_LIB ERR_LIB_BN/* 3 */
	289	# define ERR_R_RSA_LIB ERR_LIB_RSA/* 4 */
	290	# define ERR_R_DH_LIB ERR_LIB_DH/* 5 */
	291	# define ERR_R_EVP_LIB ERR_LIB_EVP/* 6 */
	292	# define ERR_R_BUF_LIB ERR_LIB_BUF/* 7 */
	293	# define ERR_R_OBJ_LIB ERR_LIB_OBJ/* 8 */
	294	# define ERR_R_PEM_LIB ERR_LIB_PEM/* 9 */
	295	# define ERR_R_DSA_LIB ERR_LIB_DSA/* 10 */
	296	# define ERR_R_X509_LIB ERR_LIB_X509/* 11 */
	297	# define ERR_R_ASN1_LIB ERR_LIB_ASN1/* 13 */
0f113f3e	298	# define ERR_R_EC_LIB ERR_LIB_EC/* 16 */
0f113f3e MC	299	# define ERR_R_BIO_LIB ERR_LIB_BIO/* 32 */
	300	# define ERR_R_PKCS7_LIB ERR_LIB_PKCS7/* 33 */
	301	# define ERR_R_X509V3_LIB ERR_LIB_X509V3/* 34 */
0f113f3e	302	# define ERR_R_ENGINE_LIB ERR_LIB_ENGINE/* 38 */
c785fd48	303	# define ERR_R_UI_LIB ERR_LIB_UI/* 40 */
0f113f3e	304	# define ERR_R_ECDSA_LIB ERR_LIB_ECDSA/* 42 */
71a5516d	305	# define ERR_R_OSSL_STORE_LIB ERR_LIB_OSSL_STORE/* 44 */
0f113f3e	306
163b2bcd RL	307	/*
	308	* global reason codes, range 64..99 (sub-system specific codes start at 100)
	309	*
	310	* ERR_R_FATAL had dual purposes in pre-3.0 OpenSSL, as a standalone reason
	311	* code as well as a fatal flag. This is still possible to do, as 2**6 (64)
	312	* is present in the whole range of global reason codes.
	313	*/
	314	# define ERR_R_FATAL (64\|ERR_RFLAG_FATAL)
	315	# define ERR_R_MALLOC_FAILURE (65\|ERR_RFLAG_FATAL)
	316	# define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (66\|ERR_RFLAG_FATAL)
	317	# define ERR_R_PASSED_NULL_PARAMETER (67\|ERR_RFLAG_FATAL)
	318	# define ERR_R_INTERNAL_ERROR (68\|ERR_RFLAG_FATAL)
	319	# define ERR_R_DISABLED (69\|ERR_RFLAG_FATAL)
	320	# define ERR_R_INIT_FAIL (70\|ERR_RFLAG_FATAL)
	321	# define ERR_R_PASSED_INVALID_ARGUMENT (71)
	322	# define ERR_R_OPERATION_FAIL (72\|ERR_RFLAG_FATAL)
	323	# define ERR_R_INVALID_PROVIDER_FUNCTIONS (73\|ERR_RFLAG_FATAL)
	324	# define ERR_R_INTERRUPTED_OR_CANCELLED (74)
	325	# define ERR_R_NESTED_ASN1_ERROR (76)
	326	# define ERR_R_MISSING_ASN1_EOS (77)
0f113f3e MC	327
	328	/*
	329	* 99 is the maximum possible ERR_R_... code, higher values are reserved for
	330	* the individual libraries
	331	*/
d02b48c6	332
0f113f3e MC	333	typedef struct ERR_string_data_st {
	334	unsigned long error;
	335	const char *string;
	336	} ERR_STRING_DATA;
d02b48c6	337
89d6aa10	338	DEFINE_LHASH_OF(ERR_STRING_DATA);
e6b5c341	339
7c0e20dc RL	340	/* 12 lines and some on an 80 column terminal */
	341	#define ERR_MAX_DATA_SIZE 1024
	342
	343	/* Building blocks */
	344	void ERR_new(void);
	345	void ERR_set_debug(const char file, int line, const char func);
	346	void ERR_set_error(int lib, int reason, const char *fmt, ...);
	347	void ERR_vset_error(int lib, int reason, const char *fmt, va_list args);
	348
ed57f7f9	349	/* Main error raising functions */
586dd674 RL	350	# define ERR_raise(lib, reason) ERR_raise_data((lib),(reason),NULL)
586dd674 RL	351	# define ERR_raise_data \
ed57f7f9	352	(ERR_new(), \
06ff79bd	353	ERR_set_debug(OPENSSL_FILE,OPENSSL_LINE,OPENSSL_FUNC), \
ed57f7f9 RL	354	ERR_set_error)
ed57f7f9 RL	355
936c2b9e	356	# ifndef OPENSSL_NO_DEPRECATED_3_0
add8c8e9	357	/* Backward compatibility */
586dd674	358	# define ERR_put_error(lib, func, reason, file, line) \
add8c8e9	359	(ERR_new(), \
06ff79bd	360	ERR_set_debug((file), (line), OPENSSL_FUNC), \
add8c8e9	361	ERR_set_error((lib), (reason), NULL))
586dd674	362	# endif
add8c8e9	363
0f113f3e	364	void ERR_set_error_data(char *data, int flags);
58964a49	365
a14e2d9d	366	unsigned long ERR_get_error(void);
b13342e9 RL	367	/*
	368	* TODO(3.0) consider if the following three functions should be deprecated.
	369	* They all drop the error record from the error queue, so regardless of which
	370	* one is used, the rest of the information is lost, making them not so useful.
	371	* The recommendation should be to use the peek functions to extract all the
	372	* additional data.
	373	*/
0f113f3e	374	unsigned long ERR_get_error_line(const char *file, int line);
b13342e9 RL	375	unsigned long ERR_get_error_func(const char **func);
	376	unsigned long ERR_get_error_data(const char *data, int flags);
	377	unsigned long ERR_get_error_all(const char *file, int line,
	378	const char **func,
	379	const char *data, int flags);
936c2b9e	380	DEPRECATEDIN_3_0(unsigned long ERR_get_error_line_data(const char **file,
b13342e9 RL	381	int *line,
	382	const char **data,
	383	int *flags))
a14e2d9d	384	unsigned long ERR_peek_error(void);
0f113f3e	385	unsigned long ERR_peek_error_line(const char *file, int line);
b13342e9 RL	386	unsigned long ERR_peek_error_func(const char **func);
	387	unsigned long ERR_peek_error_data(const char *data, int flags);
	388	unsigned long ERR_peek_error_all(const char *file, int line,
	389	const char **func,
	390	const char *data, int flags);
936c2b9e	391	DEPRECATEDIN_3_0(unsigned long ERR_peek_error_line_data(const char **file,
b13342e9 RL	392	int *line,
	393	const char **data,
	394	int *flags))
273db408	395	unsigned long ERR_peek_last_error(void);
0f113f3e	396	unsigned long ERR_peek_last_error_line(const char *file, int line);
b13342e9 RL	397	unsigned long ERR_peek_last_error_func(const char **func);
	398	unsigned long ERR_peek_last_error_data(const char *data, int flags);
	399	unsigned long ERR_peek_last_error_all(const char *file, int line,
	400	const char **func,
	401	const char *data, int flags);
936c2b9e	402	DEPRECATEDIN_3_0(unsigned long ERR_peek_last_error_line_data(const char **file,
b13342e9 RL	403	int *line,
	404	const char **data,
	405	int *flags))
	406
0f113f3e	407	void ERR_clear_error(void);
b13342e9	408
0f113f3e	409	char ERR_error_string(unsigned long e, char buf);
e5c84d51	410	void ERR_error_string_n(unsigned long e, char *buf, size_t len);
e778802f	411	const char *ERR_lib_error_string(unsigned long e);
936c2b9e	412	DEPRECATEDIN_3_0(const char *ERR_func_error_string(unsigned long e))
e778802f	413	const char *ERR_reason_error_string(unsigned long e);
b13342e9	414
0f113f3e MC	415	void ERR_print_errors_cb(int (cb) (const char str, size_t len, void *u),
	416	void *u);
	417	# ifndef OPENSSL_NO_STDIO
d02b48c6	418	void ERR_print_errors_fp(FILE *fp);
0f113f3e	419	# endif
d02b48c6	420	void ERR_print_errors(BIO *bp);
b13342e9	421
78c45722 DSH	422	void ERR_add_error_data(int num, ...);
78c45722 DSH	423	void ERR_add_error_vdata(int num, va_list args);
31b28ad9 DDO	424	void ERR_add_error_txt(const char sepr, const char txt);
31b28ad9 DDO	425	void ERR_add_error_mem_bio(const char sep, BIO bio);
b13342e9	426
52df25cf RS	427	int ERR_load_strings(int lib, ERR_STRING_DATA *str);
	428	int ERR_load_strings_const(const ERR_STRING_DATA *str);
	429	int ERR_unload_strings(int lib, ERR_STRING_DATA *str);
69588edb	430	int ERR_load_ERR_strings(void);
7b9f8f7f	431
00db8c60	432	#ifndef OPENSSL_NO_DEPRECATED_1_1_0
f672aee4 RS	433	# define ERR_load_crypto_strings() \
f672aee4 RS	434	OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
6457615a	435	# define ERR_free_strings() while(0) continue
f672aee4	436	#endif
7b9f8f7f	437
21e00174 RL	438	DEPRECATEDIN_1_1_0(void ERR_remove_thread_state(void *))
21e00174 RL	439	DEPRECATEDIN_1_0_0(void ERR_remove_state(unsigned long pid))
936c2b9e	440	DEPRECATEDIN_3_0(ERR_STATE *ERR_get_state(void))
d02b48c6	441
dcba2534	442	int ERR_get_next_error_library(void);
58964a49	443
54f64516 RL	444	int ERR_set_mark(void);
54f64516 RL	445	int ERR_pop_to_mark(void);
e1a4ff76	446	int ERR_clear_last_mark(void);
54f64516	447
0f113f3e	448	#ifdef __cplusplus
d02b48c6 RE	449	}
	450	#endif
	451
	452	#endif