secure/lib/libssl/man/SSL_get_error.3

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_get_error 3"
 136 .TH SSL_get_error 3 "2015-06-12" "1.0.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SSL_get_error \- obtain result code for TLS/SSL I/O operation
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_get_error(const SSL *ssl, int ret);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fISSL_get_error()\fR returns a result code (suitable for the C \*(L"switch\*(R"
 153 statement) for a preceding call to \fISSL_connect()\fR, \fISSL_accept()\fR, \fISSL_do_handshake()\fR,
 154 \&\fISSL_read()\fR, \fISSL_peek()\fR, or \fISSL_write()\fR on \fBssl\fR.  The value returned by
 155 that \s-1TLS/SSL I/O\s0 function must be passed to \fISSL_get_error()\fR in parameter
 156 \&\fBret\fR.
 157 .PP
 158 In addition to \fBssl\fR and \fBret\fR, \fISSL_get_error()\fR inspects the
 159 current thread's OpenSSL error queue.  Thus, \fISSL_get_error()\fR must be
 160 used in the same thread that performed the \s-1TLS/SSL I/O\s0 operation, and no
 161 other OpenSSL function calls should appear in between.  The current
 162 thread's error queue must be empty before the \s-1TLS/SSL I/O\s0 operation is
 163 attempted, or \fISSL_get_error()\fR will not work reliably.
 164 .SH "RETURN VALUES"
 165 .IX Header "RETURN VALUES"
 166 The following return values can currently occur:
 167 .IP "\s-1SSL_ERROR_NONE\s0" 4
 168 .IX Item "SSL_ERROR_NONE"
 169 The \s-1TLS/SSL I/O\s0 operation completed.  This result code is returned
 170 if and only if \fBret > 0\fR.
 171 .IP "\s-1SSL_ERROR_ZERO_RETURN\s0" 4
 172 .IX Item "SSL_ERROR_ZERO_RETURN"
 173 The \s-1TLS/SSL\s0 connection has been closed.  If the protocol version is \s-1SSL 3.0\s0
 174 or \s-1TLS 1.0,\s0 this result code is returned only if a closure
 175 alert has occurred in the protocol, i.e. if the connection has been
 176 closed cleanly. Note that in this case \fB\s-1SSL_ERROR_ZERO_RETURN\s0\fR
 177 does not necessarily indicate that the underlying transport
 178 has been closed.
 179 .IP "\s-1SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE\s0" 4
 180 .IX Item "SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE"
 181 The operation did not complete; the same \s-1TLS/SSL I/O\s0 function should be
 182 called again later.  If, by then, the underlying \fB\s-1BIO\s0\fR has data
 183 available for reading (if the result code is \fB\s-1SSL_ERROR_WANT_READ\s0\fR)
 184 or allows writing data (\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR), then some \s-1TLS/SSL\s0
 185 protocol progress will take place, i.e. at least part of an \s-1TLS/SSL\s0
 186 record will be read or written.  Note that the retry may again lead to
 187 a \fB\s-1SSL_ERROR_WANT_READ\s0\fR or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR condition.
 188 There is no fixed upper limit for the number of iterations that
 189 may be necessary until progress becomes visible at application
 190 protocol level.
 191 .Sp
 192 For socket \fB\s-1BIO\s0\fRs (e.g. when \fISSL_set_fd()\fR was used), \fIselect()\fR or
 193 \&\fIpoll()\fR on the underlying socket can be used to find out when the
 194 \&\s-1TLS/SSL I/O\s0 function should be retried.
 195 .Sp
 196 Caveat: Any \s-1TLS/SSL I/O\s0 function can lead to either of
 197 \&\fB\s-1SSL_ERROR_WANT_READ\s0\fR and \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR.  In particular,
 198 \&\fISSL_read()\fR or \fISSL_peek()\fR may want to write data and \fISSL_write()\fR may want
 199 to read data.  This is mainly because \s-1TLS/SSL\s0 handshakes may occur at any
 200 time during the protocol (initiated by either the client or the server);
 201 \&\fISSL_read()\fR, \fISSL_peek()\fR, and \fISSL_write()\fR will handle any pending handshakes.
 202 .IP "\s-1SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT\s0" 4
 203 .IX Item "SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT"
 204 The operation did not complete; the same \s-1TLS/SSL I/O\s0 function should be
 205 called again later. The underlying \s-1BIO\s0 was not connected yet to the peer
 206 and the call would block in \fIconnect()\fR/\fIaccept()\fR. The \s-1SSL\s0 function should be
 207 called again when the connection is established. These messages can only
 208 appear with a \fIBIO_s_connect()\fR or \fIBIO_s_accept()\fR \s-1BIO,\s0 respectively.
 209 In order to find out, when the connection has been successfully established,
 210 on many platforms \fIselect()\fR or \fIpoll()\fR for writing on the socket file descriptor
 211 can be used.
 212 .IP "\s-1SSL_ERROR_WANT_X509_LOOKUP\s0" 4
 213 .IX Item "SSL_ERROR_WANT_X509_LOOKUP"
 214 The operation did not complete because an application callback set by
 215 \&\fISSL_CTX_set_client_cert_cb()\fR has asked to be called again.
 216 The \s-1TLS/SSL I/O\s0 function should be called again later.
 217 Details depend on the application.
 218 .IP "\s-1SSL_ERROR_SYSCALL\s0" 4
 219 .IX Item "SSL_ERROR_SYSCALL"
 220 Some I/O error occurred.  The OpenSSL error queue may contain more
 221 information on the error.  If the error queue is empty
 222 (i.e. \fIERR_get_error()\fR returns 0), \fBret\fR can be used to find out more
 223 about the error: If \fBret == 0\fR, an \s-1EOF\s0 was observed that violates
 224 the protocol.  If \fBret == \-1\fR, the underlying \fB\s-1BIO\s0\fR reported an
 225 I/O error (for socket I/O on Unix systems, consult \fBerrno\fR for details).
 226 .IP "\s-1SSL_ERROR_SSL\s0" 4
 227 .IX Item "SSL_ERROR_SSL"
 228 A failure in the \s-1SSL\s0 library occurred, usually a protocol error.  The
 229 OpenSSL error queue contains more information on the error.
 230 .SH "SEE ALSO"
 231 .IX Header "SEE ALSO"
 232 \&\fIssl\fR\|(3), \fIerr\fR\|(3)
 233 .SH "HISTORY"
 234 .IX Header "HISTORY"
 235 \&\fISSL_get_error()\fR was added in SSLeay 0.8.