NetBSD/lib/libcrypto/man/openssl_err.3

.rn '' }`
'''
'''
.de Sh
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp
.if t .sp .5v
.if n .sp
..
.de Ip
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.de Vb
.ft CW
.nf
.ne \\$1
..
.de Ve
.ft R

.fi
..
'''
'''
'''     Set up \*(-- to give an unbreakable dash;
'''     string Tr holds user defined translation string.
'''     Bell System Logo is used as a dummy character.
'''
.tr \(*W-|\(bv\*(Tr
.ie n \{\
.ds -- \(*W-
.ds PI pi
.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.ds L" ""
.ds R" ""
'''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
'''   \*(L" and \*(R", except that they are used on ".xx" lines,
'''   such as .IP and .SH, which do another additional levels of
'''   double-quote interpretation
.ds M" """
.ds S" """
.ds N" """""
.ds T" """""
.ds L' '
.ds R' '
.ds M' '
.ds S' '
.ds N' '
.ds T' '
'br\}
.el\{\
.ds -- \(em\|
.tr \*(Tr
.ds L" ``
.ds R" ''
.ds M" ``
.ds S" ''
.ds N" ``
.ds T" ''
.ds L' `
.ds R' '
.ds M' `
.ds S' '
.ds N' `
.ds T' '
.ds PI \(*p
'br\}
.\"	If the F register is turned on, we'll generate
.\"	index entries out stderr for the following things:
.\"		TH	Title 
.\"		SH	Header
.\"		Sh	Subsection 
.\"		Ip	Item
.\"		X<>	Xref  (embedded
.\"	Of course, you have to process the output yourself
.\"	in some meaninful fashion.
.if \nF \{
.de IX
.tm Index:\\$1\t\\n%\t"\\$2"
..
.nr % 0
.rr F
.\}
.TH err 3 "0.9.5a" "22/Jul/2000" "OpenSSL"
.UC
.if n .hy 0
.if n .na
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.de CQ          \" put $1 in typewriter font
.ft CW
'if n "\c
'if t \\&\\$1\c
'if n \\&\\$1\c
'if n \&"
\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
'.ft R
..
.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
.	\" AM - accent mark definitions
.bd B 3
.	\" fudge factors for nroff and troff
.if n \{\
.	ds #H 0
.	ds #V .8m
.	ds #F .3m
.	ds #[ \f1
.	ds #] \fP
.\}
.if t \{\
.	ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.	ds #V .6m
.	ds #F 0
.	ds #[ \&
.	ds #] \&
.\}
.	\" simple accents for nroff and troff
.if n \{\
.	ds ' \&
.	ds ` \&
.	ds ^ \&
.	ds , \&
.	ds ~ ~
.	ds ? ?
.	ds ! !
.	ds /
.	ds q
.\}
.if t \{\
.	ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.	ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.	ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.	ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.	ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.	ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
.	ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
.	ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.	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'
.\}
.	\" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.ds oe o\h'-(\w'o'u*4/10)'e
.ds Oe O\h'-(\w'O'u*4/10)'E
.	\" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.	\" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.	ds : e
.	ds 8 ss
.	ds v \h'-1'\o'\(aa\(ga'
.	ds _ \h'-1'^
.	ds . \h'-1'.
.	ds 3 3
.	ds o a
.	ds d- d\h'-1'\(ga
.	ds D- D\h'-1'\(hy
.	ds th \o'bp'
.	ds Th \o'LP'
.	ds ae ae
.	ds Ae AE
.	ds oe oe
.	ds Oe OE
.\}
.rm #[ #] #H #V #F C
.SH "NAME"
err \- error codes
.SH "LIBRARY"
libcrypto, -lcrypto
.SH "SYNOPSIS"
.PP
.Vb 1
\& #include <openssl/err.h>
.Ve
.Vb 8
\& unsigned long ERR_get_error(void);
\& unsigned long ERR_peek_error(void);
\& unsigned long ERR_get_error_line(const char **file, int *line);
\& unsigned long ERR_peek_error_line(const char **file, int *line);
\& unsigned long ERR_get_error_line_data(const char **file, int *line,
\&         const char **data, int *flags);
\& unsigned long ERR_peek_error_line_data(const char **file, int *line,
\&         const char **data, int *flags);
.Ve
.Vb 3
\& int ERR_GET_LIB(unsigned long e);
\& int ERR_GET_FUNC(unsigned long e);
\& int ERR_GET_REASON(unsigned long e);
.Ve
.Vb 1
\& void ERR_clear_error(void);
.Ve
.Vb 4
\& char *ERR_error_string(unsigned long e, char *buf);
\& const char *ERR_lib_error_string(unsigned long e);
\& const char *ERR_func_error_string(unsigned long e);
\& const char *ERR_reason_error_string(unsigned long e);
.Ve
.Vb 2
\& void ERR_print_errors(BIO *bp);
\& void ERR_print_errors_fp(FILE *fp);
.Ve
.Vb 2
\& void ERR_load_crypto_strings(void);
\& void ERR_free_strings(void);
.Ve
.Vb 1
\& void ERR_remove_state(unsigned long pid);
.Ve
.Vb 3
\& void ERR_put_error(int lib, int func, int reason, const char *file,
\&         int line);
\& void ERR_add_error_data(int num, ...);
.Ve
.Vb 3
\& void ERR_load_strings(int lib,ERR_STRING_DATA str[]);
\& unsigned long ERR_PACK(int lib, int func, int reason);
\& int ERR_get_next_error_library(void);
.Ve
.SH "DESCRIPTION"
When a call to the OpenSSL library fails, this is usually signalled
by the return value, and an error code is stored in an error queue
associated with the current thread. The \fBerr\fR library provides
functions to obtain these error codes and textual error messages.
.PP
The the \fIERR_get_error(3)|ERR_get_error(3)\fR manpage manpage describes how to
access error codes.
.PP
Error codes contain information about where the error occurred, and
what went wrong. the \fIERR_GET_LIB(3)|ERR_GET_LIB(3)\fR manpage describes how to
extract this information. A method to obtain human-readable error
messages is described in the \fIERR_error_string(3)|ERR_error_string(3)\fR manpage.
.PP
the \fIERR_clear_error(3)|ERR_clear_error(3)\fR manpage can be used to clear the
error queue.
.PP
Note that the \fIERR_remove_state(3)|ERR_remove_state(3)\fR manpage should be used to
avoid memory leaks when threads are terminated.
.SH "ADDING NEW ERROR CODES TO OPENSSL"
See the \fIERR_put_error(3)\fR manpage if you want to record error codes in the
OpenSSL error system from within your application.
.PP
The remainder of this section is of interest only if you want to add
new error codes to OpenSSL or add error codes from external libraries.
.Sh "Reporting errors"
Each sub-library has a specific macro \fIXXXerr()\fR that is used to report
errors. Its first argument is a function code \fB\s-1XXX_F_\s0...\fR, the second
argument is a reason code \fB\s-1XXX_R_\s0...\fR. Function codes are derived
from the function names; reason codes consist of textual error
descriptions. For example, the function \fIssl23_read()\fR reports a
\*(L"handshake failure\*(R" as follows:
.PP
.Vb 1
\& SSLerr(SSL_F_SSL23_READ, SSL_R_SSL_HANDSHAKE_FAILURE);
.Ve
Function and reason codes should consist of upper case characters,
numbers and underscores only. The error file generation script translates
function codes into function names by looking in the header files
for an appropriate function name, if none is found it just uses
the capitalized form such as \*(L"\s-1SSL23_READ\s0\*(R" in the above example.
.PP
The trailing section of a reason code (after the \*(L"_R_") is translated
into lower case and underscores changed to spaces.
.PP
When you are using new function or reason codes, run \fBmake errors\fR.
The necessary \fB#define\fRs will then automatically be added to the
sub-library's header file.
.PP
Although a library will normally report errors using its own specific
XXXerr macro, another library's macro can be used. This is normally
only done when a library wants to include \s-1ASN1\s0 code which must use
the \fIASN1err()\fR macro.
.Sh "Adding new libraries"
When adding a new sub-library to OpenSSL, assign it a library number
\fB\s-1ERR_LIB_XXX\s0\fR, define a macro \fIXXXerr()\fR (both in \fBerr.h\fR), add its
name to \fBERR_str_libraries[]\fR (in \fBcrypto/err/err.c\fR), and add
\f(CWERR_load_XXX_strings()\fR to the \fIERR_load_crypto_strings()\fR function
(in \fBcrypto/err/err_all.c\fR). Finally, add an entry
.PP
.Vb 1
\& L      XXX     xxx.h   xxx_err.c
.Ve
to \fBcrypto/err/openssl.ec\fR, and add \fBxxx_err.c\fR to the Makefile.
Running \fBmake errors\fR will then generate a file \fBxxx_err.c\fR, and
add all error codes used in the library to \fBxxx.h\fR.
.PP
Additionally the library include file must have a certain form.
Typically it will initially look like this:
.PP
.Vb 2
\& #ifndef HEADER_XXX_H
\& #define HEADER_XXX_H
.Ve
.Vb 3
\& #ifdef __cplusplus
\& extern "C" {
\& #endif
.Ve
.Vb 1
\& /* Include files */
.Ve
.Vb 2
\& #include <openssl/bio.h>
\& #include <openssl/x509.h>
.Ve
.Vb 1
\& /* Macros, structures and function prototypes */
.Ve
.Vb 1
\& /* BEGIN ERROR CODES */
.Ve
The \fB\s-1BEGIN\s0 \s-1ERROR\s0 \s-1CODES\s0\fR sequence is used by the error code
generation script as the point to place new error codes, any text
after this point will be overwritten when \fBmake errors\fR is run.
The closing #endif etc will be automatically added by the script.
.PP
The generated C error code file \fBxxx_err.c\fR will load the header
files \fBstdio.h\fR, \fBopenssl/err.h\fR and \fBopenssl/xxx.h\fR so the
header file must load any additional header files containg any
definitions it uses.
.SH "USING ERROR CODES IN EXTERNAL LIBRARIES"
It is also possible to use OpenSSL's error code scheme in external
libraries. The library needs to load its own codes and call the OpenSSL
error code insertion script \fBmkerr.pl\fR explicitly to add codes to
the header file and generate the C error code file. This will normally
be done if the external library needs to generate new ASN1 structures
but it can also be used to add more general purpose error code handling.
.PP
TBA more details
.SH "INTERNALS"
The error queues are stored in a hash table with one \fBERR_STATE\fR
entry for each pid. \fIERR_get_state()\fR returns the current thread's
\fBERR_STATE\fR. An \fBERR_STATE\fR can hold up to \fBERR_NUM_ERRORS\fR error
codes. When more error codes are added, the old ones are overwritten,
on the assumption that the most recent errors are most important.
.PP
Error strings are also stored in hash table. The hash tables can
be obtained by calling \fIERR_get_err_state_table\fR\|(void) and
\fIERR_get_string_table\fR\|(void) respectively.
.SH "SEE ALSO"
the \fICRYPTO_set_id_callback(3)|CRYPTO_set_id_callback(3)\fR manpage,
the section on I<\fICRYPTO_set_locking_callback\fR\|(3)|<\fICRYPTO_set_locking_callback\fR\|(3)>,
the \fIERR_get_error(3)|ERR_get_error(3)\fR manpage,
the \fIERR_GET_LIB(3)|ERR_GET_LIB(3)\fR manpage,
the \fIERR_clear_error(3)|ERR_clear_error(3)\fR manpage,
the \fIERR_error_string(3)|ERR_error_string(3)\fR manpage,
the \fIERR_print_errors(3)|ERR_print_errors(3)\fR manpage,
the \fIERR_load_crypto_strings(3)|ERR_load_crypto_strings(3)\fR manpage,
the \fIERR_remove_state(3)|ERR_remove_state(3)\fR manpage,
the \fIERR_put_error(3)|ERR_put_error(3)\fR manpage,
the \fIERR_load_strings(3)|ERR_load_strings(3)\fR manpage,
the \fISSL_get_error(3)|SSL_get_error(3)\fR manpage

.rn }` ''
.IX Title "err 3"
.IX Name "err - error codes"

.IX Header "NAME"

.IX Header "SYNOPSIS"

.IX Header "DESCRIPTION"

.IX Header "ADDING NEW ERROR CODES TO OPENSSL"

.IX Subsection "Reporting errors"

.IX Subsection "Adding new libraries"

.IX Header "USING ERROR CODES IN EXTERNAL LIBRARIES"

.IX Header "INTERNALS"

.IX Header "SEE ALSO"