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