doc/crypto/err.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 err - error codes
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/err.h>
  10
  11  unsigned long ERR_get_error(void);
  12  unsigned long ERR_peek_error(void);
  13  unsigned long ERR_get_error_line(const char **file, int *line);
  14  unsigned long ERR_peek_error_line(const char **file, int *line);
  15  unsigned long ERR_get_error_line_data(const char **file, int *line,
  16          const char **data, int *flags);
  17  unsigned long ERR_peek_error_line_data(const char **file, int *line,
  18          const char **data, int *flags);
  19
  20  int ERR_GET_LIB(unsigned long e);
  21  int ERR_GET_FUNC(unsigned long e);
  22  int ERR_GET_REASON(unsigned long e);
  23
  24  void ERR_clear_error(void);
  25  void ERR_remove_thread_state(const CRYPTO_THREADID *tid);
  26
  27  char *ERR_error_string(unsigned long e, char *buf);
  28  const char *ERR_lib_error_string(unsigned long e);
  29  const char *ERR_func_error_string(unsigned long e);
  30  const char *ERR_reason_error_string(unsigned long e);
  31
  32  void ERR_print_errors(BIO *bp);
  33  void ERR_print_errors_fp(FILE *fp);
  34
  35  void ERR_load_crypto_strings(void);
  36  void ERR_free_strings(void);
  37
  38  void ERR_put_error(int lib, int func, int reason, const char *file,
  39          int line);
  40  void ERR_add_error_data(int num, ...);
  41
  42  void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
  43  unsigned long ERR_PACK(int lib, int func, int reason);
  44  int ERR_get_next_error_library(void);
  45
  46 Deprecated:
  47
  48  #if OPENSSL_API_COMPAT < 0x10000000L
  49  void ERR_remove_state(unsigned long pid);
  50  #endif
  51
  52 =head1 DESCRIPTION
  53
  54 When a call to the OpenSSL library fails, this is usually signaled
  55 by the return value, and an error code is stored in an error queue
  56 associated with the current thread. The B<err> library provides
  57 functions to obtain these error codes and textual error messages.
  58
  59 The L<ERR_get_error(3)> manpage describes how to
  60 access error codes.
  61
  62 Error codes contain information about where the error occurred, and
  63 what went wrong. L<ERR_GET_LIB(3)> describes how to
  64 extract this information. A method to obtain human-readable error
  65 messages is described in L<ERR_error_string(3)>.
  66
  67 L<ERR_clear_error(3)> can be used to clear the
  68 error queue.
  69
  70 Note that L<ERR_remove_thread_state(3)> should be used to
  71 avoid memory leaks when threads are terminated.
  72
  73 =head1 ADDING NEW ERROR CODES TO OPENSSL
  74
  75 See L<ERR_put_error(3)> if you want to record error codes in the
  76 OpenSSL error system from within your application.
  77
  78 The remainder of this section is of interest only if you want to add
  79 new error codes to OpenSSL or add error codes from external libraries.
  80
  81 =head2 Reporting errors
  82
  83 Each sub-library has a specific macro XXXerr() that is used to report
  84 errors. Its first argument is a function code B<XXX_F_...>, the second
  85 argument is a reason code B<XXX_R_...>. Function codes are derived
  86 from the function names; reason codes consist of textual error
  87 descriptions. For example, the function ssl3_read_bytes() reports a
  88 "handshake failure" as follows:
  89
  90  SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
  91
  92 Function and reason codes should consist of upper case characters,
  93 numbers and underscores only. The error file generation script translates
  94 function codes into function names by looking in the header files
  95 for an appropriate function name, if none is found it just uses
  96 the capitalized form such as "SSL3_READ_BYTES" in the above example.
  97
  98 The trailing section of a reason code (after the "_R_") is translated
  99 into lower case and underscores changed to spaces.
 100
 101 When you are using new function or reason codes, run B<make errors>.
 102 The necessary B<#define>s will then automatically be added to the
 103 sub-library's header file.
 104
 105 Although a library will normally report errors using its own specific
 106 XXXerr macro, another library's macro can be used. This is normally
 107 only done when a library wants to include ASN1 code which must use
 108 the ASN1err() macro.
 109
 110 =head2 Adding new libraries
 111
 112 When adding a new sub-library to OpenSSL, assign it a library number
 113 B<ERR_LIB_XXX>, define a macro XXXerr() (both in B<err.h>), add its
 114 name to B<ERR_str_libraries[]> (in B<crypto/err/err.c>), and add
 115 C<ERR_load_XXX_strings()> to the ERR_load_crypto_strings() function
 116 (in B<crypto/err/err_all.c>). Finally, add an entry
 117
 118  L      XXX     xxx.h   xxx_err.c
 119
 120 to B<crypto/err/openssl.ec>, and add B<xxx_err.c> to the Makefile.
 121 Running B<make errors> will then generate a file B<xxx_err.c>, and
 122 add all error codes used in the library to B<xxx.h>.
 123
 124 Additionally the library include file must have a certain form.
 125 Typically it will initially look like this:
 126
 127  #ifndef HEADER_XXX_H
 128  #define HEADER_XXX_H
 129
 130  #ifdef __cplusplus
 131  extern "C" {
 132  #endif
 133
 134  /* Include files */
 135
 136  #include <openssl/bio.h>
 137  #include <openssl/x509.h>
 138
 139  /* Macros, structures and function prototypes */
 140
 141
 142  /* BEGIN ERROR CODES */
 143
 144 The B<BEGIN ERROR CODES> sequence is used by the error code
 145 generation script as the point to place new error codes, any text
 146 after this point will be overwritten when B<make errors> is run.
 147 The closing #endif etc will be automatically added by the script.
 148
 149 The generated C error code file B<xxx_err.c> will load the header
 150 files B<stdio.h>, B<openssl/err.h> and B<openssl/xxx.h> so the
 151 header file must load any additional header files containing any
 152 definitions it uses.
 153
 154 =head1 USING ERROR CODES IN EXTERNAL LIBRARIES
 155
 156 It is also possible to use OpenSSL's error code scheme in external
 157 libraries. The library needs to load its own codes and call the OpenSSL
 158 error code insertion script B<mkerr.pl> explicitly to add codes to
 159 the header file and generate the C error code file. This will normally
 160 be done if the external library needs to generate new ASN1 structures
 161 but it can also be used to add more general purpose error code handling.
 162
 163 TBA more details
 164
 165 =head1 INTERNALS
 166
 167 The error queues are stored in a hash table with one B<ERR_STATE>
 168 entry for each pid. ERR_get_state() returns the current thread's
 169 B<ERR_STATE>. An B<ERR_STATE> can hold up to B<ERR_NUM_ERRORS> error
 170 codes. When more error codes are added, the old ones are overwritten,
 171 on the assumption that the most recent errors are most important.
 172
 173 Error strings are also stored in hash table. The hash tables can
 174 be obtained by calling ERR_get_err_state_table(void) and
 175 ERR_get_string_table(void) respectively.
 176
 177 =head1 SEE ALSO
 178
 179 L<CRYPTO_set_locking_callback(3)>,
 180 L<ERR_get_error(3)>,
 181 L<ERR_GET_LIB(3)>,
 182 L<ERR_clear_error(3)>,
 183 L<ERR_error_string(3)>,
 184 L<ERR_print_errors(3)>,
 185 L<ERR_load_crypto_strings(3)>,
 186 L<ERR_remove_thread_state(3)>,
 187 L<ERR_put_error(3)>,
 188 L<ERR_load_strings(3)>,
 189 L<SSL_get_error(3)>
 190
 191 =cut