#include
unsigned long ERR_get_error(void); unsigned long ERR_peek_error(void); unsigned long ERR_get_error_line(const char **file, int *line); unsigned long ERR_peek_error_line(const char **file, int *line); unsigned long ERR_get_error_line_data(const char **file, int *line, const char **data, int *flags); unsigned long ERR_peek_error_line_data(const char **file, int *line, const char **data, int *flags);
int ERR_GET_LIB(unsigned long e); int ERR_GET_FUNC(unsigned long e); int ERR_GET_REASON(unsigned long e);
void ERR_clear_error(void);
char *ERR_error_string(unsigned long e, char *buf); const char *ERR_lib_error_string(unsigned long e); const char *ERR_func_error_string(unsigned long e); const char *ERR_reason_error_string(unsigned long e);
void ERR_print_errors(BIO *bp); void ERR_print_errors_fp(FILE *fp);
void ERR_load_crypto_strings(void); void ERR_free_strings(void);
void ERR_remove_state(unsigned long pid);
void ERR_put_error(int lib, int func, int reason, const char *file, int line); void ERR_add_error_data(int num, ...);
void ERR_load_strings(int lib,ERR_STRING_DATA str[]); unsigned long ERR_PACK(int lib, int func, int reason); int ERR_get_next_error_library(void);
The _E_R_R___g_e_t___e_r_r_o_r(3) manpage describes how to access error codes.
Error codes contain information about where the error occurred, and what went wrong. _E_R_R___G_E_T___L_I_B(3) describes how to extract this information. A method to obtain human-readable error messages is described in _E_R_R___e_r_r_o_r___s_t_r_i_n_g(3).
_E_R_R___c_l_e_a_r___e_r_r_o_r(3) can be used to clear the error queue.
Note that _E_R_R___r_e_m_o_v_e___s_t_a_t_e(3) should be used to avoid memory leaks when threads are terminated.
The remainder of this section is of interest only if you want to add
new error codes to OpenSSL or add error codes from external libraries.
RReeppoorrttiinngg eerrrroorrss
Each sub-library has a specific macro _X_X_X_e_r_r_(_) that is used to report errors. Its first argument is a function code XXXXXX__FF__......, the second argument is a reason code XXXXXX__RR__....... Function codes are derived from the function names; reason codes consist of textual error descriptions. For example, the function _s_s_l_2_3___r_e_a_d_(_) reports a "handshake failure" as follows:
SSLerr(SSL_F_SSL23_READ, SSL_R_SSL_HANDSHAKE_FAILURE);
Function and reason codes should consist of upper case characters, numbers and underscores only. The error file generation script translates function codes into function names by looking in the header files for an appropriate function name, if none is found it just uses the capitalized form such as "SSL23_READ" in the above example.
The trailing section of a reason code (after the "_R_") is translated into lower case and underscores changed to spaces.
When you are using new function or reason codes, run mmaakkee eerrrroorrss. The necessary ##ddeeffiinnees will then automatically be added to the sub-library's header file.
Although a library will normally report errors using its own specific
XXXerr macro, another library's macro can be used. This is normally
only done when a library wants to include ASN1 code which must use
the _A_S_N_1_e_r_r_(_) macro.
AAddddiinngg nneeww lliibbrraarriieess
When adding a new sub-library to OpenSSL, assign it a library number EERRRR__LLIIBB__XXXXXX, define a macro _X_X_X_e_r_r_(_) (both in eerrrr..hh), add its name to EERRRR__ssttrr__lliibbrraarriieess[[]] (in ccrryyppttoo//eerrrr//eerrrr..cc), and add "ERR_load_XXX_strings()" to the _E_R_R___l_o_a_d___c_r_y_p_t_o___s_t_r_i_n_g_s_(_) function (in ccrryyppttoo//eerrrr//eerrrr__aallll..cc). Finally, add an entry
L XXX xxx.h xxx_err.c
to ccrryyppttoo//eerrrr//ooppeennssssll..eecc, and add xxxxxx__eerrrr..cc to the Makefile. Running mmaakkee eerrrroorrss will then generate a file xxxxxx__eerrrr..cc, and add all error codes used in the library to xxxxxx..hh.
Additionally the library include file must have a certain form. Typically it will initially look like this:
#ifndef HEADER_XXX_H #define HEADER_XXX_H
#ifdef __cplusplus extern "C" { #endif
/* Include files */
#include#include
/* Macros, structures and function prototypes */
/* BEGIN ERROR CODES */
The BBEEGGIINN EERRRROORR CCOODDEESS sequence is used by the error code generation script as the point to place new error codes, any text after this point will be overwritten when mmaakkee eerrrroorrss is run. The closing #endif etc will be automatically added by the script.
The generated C error code file xxxxxx__eerrrr..cc will load the header files ssttddiioo..hh, ooppeennssssll//eerrrr..hh and ooppeennssssll//xxxxxx..hh so the header file must load any additional header files containing any definitions it uses.
TBA more details
Error strings are also stored in hash table. The hash tables can be obtained by calling ERR_get_err_state_table(void) and ERR_get_string_table(void) respectively.