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