Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libcrypto / man / err.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
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
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
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"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
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.\"
8b0cefbb
JR
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
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
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'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 112. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
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
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "err 3"
aac4ff6f 132.TH err 3 "2008-09-06" "0.9.8h" "OpenSSL"
984263bc
MD
133.SH "NAME"
134err \- error codes
135.SH "SYNOPSIS"
8b0cefbb 136.IX Header "SYNOPSIS"
984263bc
MD
137.Vb 1
138\& #include <openssl/err.h>
aac4ff6f
PA
139.Ve
140.PP
141.Vb 8
984263bc
MD
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);
aac4ff6f
PA
150.Ve
151.PP
152.Vb 3
984263bc
MD
153\& int ERR_GET_LIB(unsigned long e);
154\& int ERR_GET_FUNC(unsigned long e);
155\& int ERR_GET_REASON(unsigned long e);
aac4ff6f
PA
156.Ve
157.PP
158.Vb 1
984263bc 159\& void ERR_clear_error(void);
aac4ff6f
PA
160.Ve
161.PP
162.Vb 4
984263bc
MD
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);
aac4ff6f
PA
167.Ve
168.PP
169.Vb 2
984263bc
MD
170\& void ERR_print_errors(BIO *bp);
171\& void ERR_print_errors_fp(FILE *fp);
aac4ff6f
PA
172.Ve
173.PP
174.Vb 2
984263bc
MD
175\& void ERR_load_crypto_strings(void);
176\& void ERR_free_strings(void);
aac4ff6f
PA
177.Ve
178.PP
179.Vb 1
984263bc 180\& void ERR_remove_state(unsigned long pid);
aac4ff6f
PA
181.Ve
182.PP
183.Vb 3
984263bc
MD
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, ...);
aac4ff6f
PA
187.Ve
188.PP
189.Vb 3
984263bc
MD
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"
8b0cefbb 195.IX Header "DESCRIPTION"
984263bc
MD
196When a call to the OpenSSL library fails, this is usually signalled
197by the return value, and an error code is stored in an error queue
198associated with the current thread. The \fBerr\fR library provides
199functions to obtain these error codes and textual error messages.
200.PP
8b0cefbb 201The \fIERR_get_error\fR\|(3) manpage describes how to
984263bc
MD
202access error codes.
203.PP
204Error codes contain information about where the error occurred, and
8b0cefbb 205what went wrong. \s-1\fIERR_GET_LIB\s0\fR\|(3) describes how to
984263bc 206extract this information. A method to obtain human-readable error
8b0cefbb 207messages is described in \fIERR_error_string\fR\|(3).
984263bc 208.PP
8b0cefbb 209\&\fIERR_clear_error\fR\|(3) can be used to clear the
984263bc
MD
210error queue.
211.PP
8b0cefbb 212Note that \fIERR_remove_state\fR\|(3) should be used to
984263bc
MD
213avoid memory leaks when threads are terminated.
214.SH "ADDING NEW ERROR CODES TO OPENSSL"
8b0cefbb
JR
215.IX Header "ADDING NEW ERROR CODES TO OPENSSL"
216See \fIERR_put_error\fR\|(3) if you want to record error codes in the
984263bc
MD
217OpenSSL error system from within your application.
218.PP
219The remainder of this section is of interest only if you want to add
220new error codes to OpenSSL or add error codes from external libraries.
221.Sh "Reporting errors"
8b0cefbb 222.IX Subsection "Reporting errors"
984263bc
MD
223Each sub-library has a specific macro \fIXXXerr()\fR that is used to report
224errors. Its first argument is a function code \fB\s-1XXX_F_\s0...\fR, the second
225argument is a reason code \fB\s-1XXX_R_\s0...\fR. Function codes are derived
226from the function names; reason codes consist of textual error
227descriptions. For example, the function \fIssl23_read()\fR reports a
8b0cefbb 228\&\*(L"handshake failure\*(R" as follows:
984263bc
MD
229.PP
230.Vb 1
231\& SSLerr(SSL_F_SSL23_READ, SSL_R_SSL_HANDSHAKE_FAILURE);
232.Ve
8b0cefbb 233.PP
984263bc
MD
234Function and reason codes should consist of upper case characters,
235numbers and underscores only. The error file generation script translates
236function codes into function names by looking in the header files
237for an appropriate function name, if none is found it just uses
238the capitalized form such as \*(L"\s-1SSL23_READ\s0\*(R" in the above example.
239.PP
8b0cefbb 240The trailing section of a reason code (after the \*(L"_R_\*(R") is translated
984263bc
MD
241into lower case and underscores changed to spaces.
242.PP
243When you are using new function or reason codes, run \fBmake errors\fR.
244The necessary \fB#define\fRs will then automatically be added to the
aac4ff6f 245sub\-library's header file.
984263bc
MD
246.PP
247Although a library will normally report errors using its own specific
248XXXerr macro, another library's macro can be used. This is normally
249only done when a library wants to include \s-1ASN1\s0 code which must use
250the \fIASN1err()\fR macro.
251.Sh "Adding new libraries"
8b0cefbb 252.IX Subsection "Adding new libraries"
984263bc 253When adding a new sub-library to OpenSSL, assign it a library number
8b0cefbb 254\&\fB\s-1ERR_LIB_XXX\s0\fR, define a macro \fIXXXerr()\fR (both in \fBerr.h\fR), add its
984263bc 255name to \fBERR_str_libraries[]\fR (in \fBcrypto/err/err.c\fR), and add
8b0cefbb 256\&\f(CW\*(C`ERR_load_XXX_strings()\*(C'\fR to the \fIERR_load_crypto_strings()\fR function
984263bc
MD
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
8b0cefbb 262.PP
984263bc
MD
263to \fBcrypto/err/openssl.ec\fR, and add \fBxxx_err.c\fR to the Makefile.
264Running \fBmake errors\fR will then generate a file \fBxxx_err.c\fR, and
265add all error codes used in the library to \fBxxx.h\fR.
266.PP
267Additionally the library include file must have a certain form.
268Typically it will initially look like this:
269.PP
270.Vb 2
271\& #ifndef HEADER_XXX_H
272\& #define HEADER_XXX_H
aac4ff6f
PA
273.Ve
274.PP
275.Vb 3
276\& #ifdef __cplusplus
984263bc
MD
277\& extern "C" {
278\& #endif
aac4ff6f
PA
279.Ve
280.PP
281.Vb 1
984263bc 282\& /* Include files */
aac4ff6f
PA
283.Ve
284.PP
285.Vb 2
984263bc
MD
286\& #include <openssl/bio.h>
287\& #include <openssl/x509.h>
aac4ff6f
PA
288.Ve
289.PP
290.Vb 1
984263bc 291\& /* Macros, structures and function prototypes */
aac4ff6f
PA
292.Ve
293.PP
294.Vb 1
984263bc
MD
295\& /* BEGIN ERROR CODES */
296.Ve
8b0cefbb 297.PP
984263bc
MD
298The \fB\s-1BEGIN\s0 \s-1ERROR\s0 \s-1CODES\s0\fR sequence is used by the error code
299generation script as the point to place new error codes, any text
300after this point will be overwritten when \fBmake errors\fR is run.
301The closing #endif etc will be automatically added by the script.
302.PP
303The generated C error code file \fBxxx_err.c\fR will load the header
304files \fBstdio.h\fR, \fBopenssl/err.h\fR and \fBopenssl/xxx.h\fR so the
305header file must load any additional header files containing any
306definitions it uses.
307.SH "USING ERROR CODES IN EXTERNAL LIBRARIES"
8b0cefbb 308.IX Header "USING ERROR CODES IN EXTERNAL LIBRARIES"
984263bc
MD
309It is also possible to use OpenSSL's error code scheme in external
310libraries. The library needs to load its own codes and call the OpenSSL
311error code insertion script \fBmkerr.pl\fR explicitly to add codes to
312the header file and generate the C error code file. This will normally
8b0cefbb 313be done if the external library needs to generate new \s-1ASN1\s0 structures
984263bc
MD
314but it can also be used to add more general purpose error code handling.
315.PP
8b0cefbb 316\&\s-1TBA\s0 more details
984263bc 317.SH "INTERNALS"
8b0cefbb
JR
318.IX Header "INTERNALS"
319The error queues are stored in a hash table with one \fB\s-1ERR_STATE\s0\fR
984263bc 320entry for each pid. \fIERR_get_state()\fR returns the current thread's
8b0cefbb 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
984263bc
MD
322codes. When more error codes are added, the old ones are overwritten,
323on the assumption that the most recent errors are most important.
324.PP
325Error strings are also stored in hash table. The hash tables can
8b0cefbb
JR
326be obtained by calling ERR_get_err_state_table(void) and
327ERR_get_string_table(void) respectively.
984263bc 328.SH "SEE ALSO"
74dab6c2 329.IX Header "SEE ALSO"
8b0cefbb
JR
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)