secure/lib/libcrypto/man/err.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "err 3"
 132 .TH err 3 "2007-10-12" "0.9.8f" "OpenSSL"
 133 .SH "NAME"
 134 err \- error codes
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& #include <openssl/err.h>
 139 .Ve
 140 .PP
 141 .Vb 8
 142 \& unsigned long ERR_get_error(void);
 143 \& unsigned long ERR_peek_error(void);
 144 \& unsigned long ERR_get_error_line(const char **file, int *line);
 145 \& unsigned long ERR_peek_error_line(const char **file, int *line);
 146 \& unsigned long ERR_get_error_line_data(const char **file, int *line,
 147 \&         const char **data, int *flags);
 148 \& unsigned long ERR_peek_error_line_data(const char **file, int *line,
 149 \&         const char **data, int *flags);
 150 .Ve
 151 .PP
 152 .Vb 3
 153 \& int ERR_GET_LIB(unsigned long e);
 154 \& int ERR_GET_FUNC(unsigned long e);
 155 \& int ERR_GET_REASON(unsigned long e);
 156 .Ve
 157 .PP
 158 .Vb 1
 159 \& void ERR_clear_error(void);
 160 .Ve
 161 .PP
 162 .Vb 4
 163 \& char *ERR_error_string(unsigned long e, char *buf);
 164 \& const char *ERR_lib_error_string(unsigned long e);
 165 \& const char *ERR_func_error_string(unsigned long e);
 166 \& const char *ERR_reason_error_string(unsigned long e);
 167 .Ve
 168 .PP
 169 .Vb 2
 170 \& void ERR_print_errors(BIO *bp);
 171 \& void ERR_print_errors_fp(FILE *fp);
 172 .Ve
 173 .PP
 174 .Vb 2
 175 \& void ERR_load_crypto_strings(void);
 176 \& void ERR_free_strings(void);
 177 .Ve
 178 .PP
 179 .Vb 1
 180 \& void ERR_remove_state(unsigned long pid);
 181 .Ve
 182 .PP
 183 .Vb 3
 184 \& void ERR_put_error(int lib, int func, int reason, const char *file,
 185 \&         int line);
 186 \& void ERR_add_error_data(int num, ...);
 187 .Ve
 188 .PP
 189 .Vb 3
 190 \& void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
 191 \& unsigned long ERR_PACK(int lib, int func, int reason);
 192 \& int ERR_get_next_error_library(void);
 193 .Ve
 194 .SH "DESCRIPTION"
 195 .IX Header "DESCRIPTION"
 196 When a call to the OpenSSL library fails, this is usually signalled
 197 by the return value, and an error code is stored in an error queue
 198 associated with the current thread. The \fBerr\fR library provides
 199 functions to obtain these error codes and textual error messages.
 200 .PP
 201 The \fIERR_get_error\fR\|(3) manpage describes how to
 202 access error codes.
 203 .PP
 204 Error codes contain information about where the error occurred, and
 205 what went wrong. \s-1\fIERR_GET_LIB\s0\fR\|(3) describes how to
 206 extract this information. A method to obtain human-readable error
 207 messages is described in \fIERR_error_string\fR\|(3).
 208 .PP
 209 \&\fIERR_clear_error\fR\|(3) can be used to clear the
 210 error queue.
 211 .PP
 212 Note that \fIERR_remove_state\fR\|(3) should be used to
 213 avoid memory leaks when threads are terminated.
 214 .SH "ADDING NEW ERROR CODES TO OPENSSL"
 215 .IX Header "ADDING NEW ERROR CODES TO OPENSSL"
 216 See \fIERR_put_error\fR\|(3) if you want to record error codes in the
 217 OpenSSL error system from within your application.
 218 .PP
 219 The remainder of this section is of interest only if you want to add
 220 new error codes to OpenSSL or add error codes from external libraries.
 221 .Sh "Reporting errors"
 222 .IX Subsection "Reporting errors"
 223 Each sub-library has a specific macro \fIXXXerr()\fR that is used to report
 224 errors. Its first argument is a function code \fB\s-1XXX_F_\s0...\fR, the second
 225 argument is a reason code \fB\s-1XXX_R_\s0...\fR. Function codes are derived
 226 from the function names; reason codes consist of textual error
 227 descriptions. For example, the function \fIssl23_read()\fR reports a
 228 \&\*(L"handshake failure\*(R" as follows:
 229 .PP
 230 .Vb 1
 231 \& SSLerr(SSL_F_SSL23_READ, SSL_R_SSL_HANDSHAKE_FAILURE);
 232 .Ve
 233 .PP
 234 Function and reason codes should consist of upper case characters,
 235 numbers and underscores only. The error file generation script translates
 236 function codes into function names by looking in the header files
 237 for an appropriate function name, if none is found it just uses
 238 the capitalized form such as \*(L"\s-1SSL23_READ\s0\*(R" in the above example.
 239 .PP
 240 The trailing section of a reason code (after the \*(L"_R_\*(R") is translated
 241 into lower case and underscores changed to spaces.
 242 .PP
 243 When you are using new function or reason codes, run \fBmake errors\fR.
 244 The necessary \fB#define\fRs will then automatically be added to the
 245 sub\-library's header file.
 246 .PP
 247 Although a library will normally report errors using its own specific
 248 XXXerr macro, another library's macro can be used. This is normally
 249 only done when a library wants to include \s-1ASN1\s0 code which must use
 250 the \fIASN1err()\fR macro.
 251 .Sh "Adding new libraries"
 252 .IX Subsection "Adding new libraries"
 253 When adding a new sub-library to OpenSSL, assign it a library number
 254 \&\fB\s-1ERR_LIB_XXX\s0\fR, define a macro \fIXXXerr()\fR (both in \fBerr.h\fR), add its
 255 name to \fBERR_str_libraries[]\fR (in \fBcrypto/err/err.c\fR), and add
 256 \&\f(CW\*(C`ERR_load_XXX_strings()\*(C'\fR to the \fIERR_load_crypto_strings()\fR function
 257 (in \fBcrypto/err/err_all.c\fR). Finally, add an entry
 258 .PP
 259 .Vb 1
 260 \& L      XXX     xxx.h   xxx_err.c
 261 .Ve
 262 .PP
 263 to \fBcrypto/err/openssl.ec\fR, and add \fBxxx_err.c\fR to the Makefile.
 264 Running \fBmake errors\fR will then generate a file \fBxxx_err.c\fR, and
 265 add all error codes used in the library to \fBxxx.h\fR.
 266 .PP
 267 Additionally the library include file must have a certain form.
 268 Typically it will initially look like this:
 269 .PP
 270 .Vb 2
 271 \& #ifndef HEADER_XXX_H
 272 \& #define HEADER_XXX_H
 273 .Ve
 274 .PP
 275 .Vb 3
 276 \& #ifdef __cplusplus
 277 \& extern "C" {
 278 \& #endif
 279 .Ve
 280 .PP
 281 .Vb 1
 282 \& /* Include files */
 283 .Ve
 284 .PP
 285 .Vb 2
 286 \& #include <openssl/bio.h>
 287 \& #include <openssl/x509.h>
 288 .Ve
 289 .PP
 290 .Vb 1
 291 \& /* Macros, structures and function prototypes */
 292 .Ve
 293 .PP
 294 .Vb 1
 295 \& /* BEGIN ERROR CODES */
 296 .Ve
 297 .PP
 298 The \fB\s-1BEGIN\s0 \s-1ERROR\s0 \s-1CODES\s0\fR sequence is used by the error code
 299 generation script as the point to place new error codes, any text
 300 after this point will be overwritten when \fBmake errors\fR is run.
 301 The closing #endif etc will be automatically added by the script.
 302 .PP
 303 The generated C error code file \fBxxx_err.c\fR will load the header
 304 files \fBstdio.h\fR, \fBopenssl/err.h\fR and \fBopenssl/xxx.h\fR so the
 305 header file must load any additional header files containing any
 306 definitions it uses.
 307 .SH "USING ERROR CODES IN EXTERNAL LIBRARIES"
 308 .IX Header "USING ERROR CODES IN EXTERNAL LIBRARIES"
 309 It is also possible to use OpenSSL's error code scheme in external
 310 libraries. The library needs to load its own codes and call the OpenSSL
 311 error code insertion script \fBmkerr.pl\fR explicitly to add codes to
 312 the header file and generate the C error code file. This will normally
 313 be done if the external library needs to generate new \s-1ASN1\s0 structures
 314 but it can also be used to add more general purpose error code handling.
 315 .PP
 316 \&\s-1TBA\s0 more details
 317 .SH "INTERNALS"
 318 .IX Header "INTERNALS"
 319 The error queues are stored in a hash table with one \fB\s-1ERR_STATE\s0\fR
 320 entry for each pid. \fIERR_get_state()\fR returns the current thread's
 321 \&\fB\s-1ERR_STATE\s0\fR. An \fB\s-1ERR_STATE\s0\fR can hold up to \fB\s-1ERR_NUM_ERRORS\s0\fR error
 322 codes. When more error codes are added, the old ones are overwritten,
 323 on the assumption that the most recent errors are most important.
 324 .PP
 325 Error strings are also stored in hash table. The hash tables can
 326 be obtained by calling ERR_get_err_state_table(void) and
 327 ERR_get_string_table(void) respectively.
 328 .SH "SEE ALSO"
 329 .IX Header "SEE ALSO"
 330 \&\fICRYPTO_set_id_callback\fR\|(3),
 331 \&\fICRYPTO_set_locking_callback\fR\|(3),
 332 \&\fIERR_get_error\fR\|(3),
 333 \&\s-1\fIERR_GET_LIB\s0\fR\|(3),
 334 \&\fIERR_clear_error\fR\|(3),
 335 \&\fIERR_error_string\fR\|(3),
 336 \&\fIERR_print_errors\fR\|(3),
 337 \&\fIERR_load_crypto_strings\fR\|(3),
 338 \&\fIERR_remove_state\fR\|(3),
 339 \&\fIERR_put_error\fR\|(3),
 340 \&\fIERR_load_strings\fR\|(3),
 341 \&\fISSL_get_error\fR\|(3)