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