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
  26  char *ERR_error_string(unsigned long e, char *buf);
  27  const char *ERR_lib_error_string(unsigned long e);
  28  const char *ERR_func_error_string(unsigned long e);
  29  const char *ERR_reason_error_string(unsigned long e);
  30
  31  void ERR_print_errors(BIO *bp);
  32  void ERR_print_errors_fp(FILE *fp);
  33
  34  void ERR_load_crypto_strings(void);
  35  void ERR_free_strings(void);
  36
  37  void ERR_remove_state(unsigned long pid);
  38
  39  void ERR_put_error(int lib, int func, int reason, const char *file,
  40          int line);
  41  void ERR_add_error_data(int num, ...);
  42
  43  void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
  44  unsigned long ERR_PACK(int lib, int func, int reason);
  45  int ERR_get_next_error_library(void);
  46
  47 =head1 DESCRIPTION
  48
  49 When a call to the OpenSSL library fails, this is usually signalled
  50 by the return value, and an error code is stored in an error queue
  51 associated with the current thread. The B<err> library provides
  52 functions to obtain these error codes and textual error messages.
  53
  54 The L<ERR_get_error(3)|ERR_get_error(3)> manpage describes how to
  55 access error codes.
  56
  57 Error codes contain information about where the error occurred, and
  58 what went wrong. L<ERR_GET_LIB(3)|ERR_GET_LIB(3)> describes how to
  59 extract this information. A method to obtain human-readable error
  60 messages is described in L<ERR_error_string(3)|ERR_error_string(3)>.
  61
  62 L<ERR_clear_error(3)|ERR_clear_error(3)> can be used to clear the
  63 error queue.
  64
  65 Note that L<ERR_remove_state(3)|ERR_remove_state(3)> should be used to
  66 avoid memory leaks when threads are terminated.
  67
  68 =head1 ADDING NEW ERROR CODES TO OPENSSL
  69
  70 See L<ERR_put_error(3)> if you want to record error codes in the
  71 OpenSSL error system from within your application.
  72
  73 The remainder of this section is of interest only if you want to add
  74 new functionality to OpenSSL.
  75
  76 =head2 Reporting errors
  77
  78 Each sub-library has a specific macro XXXerr() that is used to report
  79 errors. Its first argument is a function code B<XXX_F_...>, the second
  80 argument is a reason code B<XXX_R_...>. Function codes are derived
  81 from the function names; reason codes consist of textual error
  82 descriptions. For example, the function ssl23_read() reports a
  83 "handshake failure" as follows:
  84
  85  SSLerr(SSL_F_SSL23_READ, SSL_R_SSL_HANDSHAKE_FAILURE);
  86
  87 When you are using new function or reason codes, run B<make errors>.
  88 The necessary B<#define>s will then automatically be added to the
  89 sub-library's header file.
  90
  91 =head2 Adding new libraries
  92
  93 When adding a new sub-library to OpenSSL, assign it a library number
  94 B<ERR_LIB_XXX>, define a macro XXXerr() (both in B<err.h>), add its
  95 name to B<ERR_str_libraries[]> (in B<crypto/err/err.c>), and add
  96 C<ERR_load_XXX_strings()> to the ERR_load_crypto_strings() function
  97 (in B<crypto/err/err_all.c>). Finally, add an entry
  98
  99  L      XXX     xxx.h   xxx_err.c
 100
 101 to B<crypto/err/openssl.ec>, and add B<xxx_err.c> to the Makefile.
 102 Running B<make errors> will then generate a file B<xxx_err.c>, and
 103 add all error codes used in the library to B<xxx.h>.
 104
 105 =head1 INTERNALS
 106
 107 The error queues are stored in a hash table with one B<ERR_STATE>
 108 entry for each pid. ERR_get_state() returns the current thread's
 109 B<ERR_STATE>. An B<ERR_STATE> can hold up to B<ERR_NUM_ERRORS> error
 110 codes. When more error codes are added, the old ones are overwritten,
 111 on the assumption that the most recent errors are most important.
 112
 113 Error strings are also stored in hash table. The hash tables can
 114 be obtained by calling ERR_get_err_state_table(void) and
 115 ERR_get_string_table(void) respectively.
 116
 117 =head1 SEE ALSO
 118
 119 L<ERR_get_error(3)|ERR_get_error(3)>,
 120 L<ERR_GET_LIB(3)|ERR_GET_LIB(3)>,
 121 L<ERR_clear_error(3)|ERR_clear_error(3)>,
 122 L<ERR_error_string(3)|ERR_error_string(3)>,
 123 L<ERR_print_errors(3)|ERR_print_errors(3)>,
 124 L<ERR_load_crypto_strings(3)|ERR_load_crypto_strings(3)>,
 125 L<ERR_remove_state(3)|ERR_remove_state(3)>,
 126 L<ERR_put_error(3)|ERR_put_error(3)>,
 127 L<ERR_load_strings(3)|ERR_load_strings(3)>,
 128 L<SSL_get_error(3)|SSL_get_error(3)>
 129
 130 =cut