secure/lib/libssl/man/SSL_get_error.3

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  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
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  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'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 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
 112 .    \" corrections for vroff
 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'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 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
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_get_error 3"
 132 .TH SSL_get_error 3 "2017-11-02" "1.0.2m" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 SSL_get_error \- obtain result code for TLS/SSL I/O operation
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& int SSL_get_error(const SSL *ssl, int ret);
 145 .Ve
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 \&\fISSL_get_error()\fR returns a result code (suitable for the C \*(L"switch\*(R"
 149 statement) for a preceding call to \fISSL_connect()\fR, \fISSL_accept()\fR, \fISSL_do_handshake()\fR,
 150 \&\fISSL_read()\fR, \fISSL_peek()\fR, or \fISSL_write()\fR on \fBssl\fR.  The value returned by
 151 that \s-1TLS/SSL I/O\s0 function must be passed to \fISSL_get_error()\fR in parameter
 152 \&\fBret\fR.
 153 .PP
 154 In addition to \fBssl\fR and \fBret\fR, \fISSL_get_error()\fR inspects the
 155 current thread's OpenSSL error queue.  Thus, \fISSL_get_error()\fR must be
 156 used in the same thread that performed the \s-1TLS/SSL I/O\s0 operation, and no
 157 other OpenSSL function calls should appear in between.  The current
 158 thread's error queue must be empty before the \s-1TLS/SSL I/O\s0 operation is
 159 attempted, or \fISSL_get_error()\fR will not work reliably.
 160 .SH "RETURN VALUES"
 161 .IX Header "RETURN VALUES"
 162 The following return values can currently occur:
 163 .IP "\s-1SSL_ERROR_NONE\s0" 4
 164 .IX Item "SSL_ERROR_NONE"
 165 The \s-1TLS/SSL I/O\s0 operation completed.  This result code is returned
 166 if and only if \fBret > 0\fR.
 167 .IP "\s-1SSL_ERROR_ZERO_RETURN\s0" 4
 168 .IX Item "SSL_ERROR_ZERO_RETURN"
 169 The \s-1TLS/SSL\s0 connection has been closed.
 170 If the protocol version is \s-1SSL 3.0\s0 or higher, this result code is returned only
 171 if a closure alert has occurred in the protocol, i.e. if the connection has been
 172 closed cleanly.
 173 Note that in this case \fB\s-1SSL_ERROR_ZERO_RETURN\s0\fR does not necessarily
 174 indicate that the underlying transport has been closed.
 175 .IP "\s-1SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE\s0" 4
 176 .IX Item "SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE"
 177 The operation did not complete; the same \s-1TLS/SSL I/O\s0 function should be
 178 called again later.  If, by then, the underlying \fB\s-1BIO\s0\fR has data
 179 available for reading (if the result code is \fB\s-1SSL_ERROR_WANT_READ\s0\fR)
 180 or allows writing data (\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR), then some \s-1TLS/SSL\s0
 181 protocol progress will take place, i.e. at least part of an \s-1TLS/SSL\s0
 182 record will be read or written.  Note that the retry may again lead to
 183 a \fB\s-1SSL_ERROR_WANT_READ\s0\fR or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR condition.
 184 There is no fixed upper limit for the number of iterations that
 185 may be necessary until progress becomes visible at application
 186 protocol level.
 187 .Sp
 188 For socket \fB\s-1BIO\s0\fRs (e.g. when \fISSL_set_fd()\fR was used), \fIselect()\fR or
 189 \&\fIpoll()\fR on the underlying socket can be used to find out when the
 190 \&\s-1TLS/SSL I/O\s0 function should be retried.
 191 .Sp
 192 Caveat: Any \s-1TLS/SSL I/O\s0 function can lead to either of
 193 \&\fB\s-1SSL_ERROR_WANT_READ\s0\fR and \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR.  In particular,
 194 \&\fISSL_read()\fR or \fISSL_peek()\fR may want to write data and \fISSL_write()\fR may want
 195 to read data.  This is mainly because \s-1TLS/SSL\s0 handshakes may occur at any
 196 time during the protocol (initiated by either the client or the server);
 197 \&\fISSL_read()\fR, \fISSL_peek()\fR, and \fISSL_write()\fR will handle any pending handshakes.
 198 .IP "\s-1SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT\s0" 4
 199 .IX Item "SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT"
 200 The operation did not complete; the same \s-1TLS/SSL I/O\s0 function should be
 201 called again later. The underlying \s-1BIO\s0 was not connected yet to the peer
 202 and the call would block in \fIconnect()\fR/\fIaccept()\fR. The \s-1SSL\s0 function should be
 203 called again when the connection is established. These messages can only
 204 appear with a \fIBIO_s_connect()\fR or \fIBIO_s_accept()\fR \s-1BIO,\s0 respectively.
 205 In order to find out, when the connection has been successfully established,
 206 on many platforms \fIselect()\fR or \fIpoll()\fR for writing on the socket file descriptor
 207 can be used.
 208 .IP "\s-1SSL_ERROR_WANT_X509_LOOKUP\s0" 4
 209 .IX Item "SSL_ERROR_WANT_X509_LOOKUP"
 210 The operation did not complete because an application callback set by
 211 \&\fISSL_CTX_set_client_cert_cb()\fR has asked to be called again.
 212 The \s-1TLS/SSL I/O\s0 function should be called again later.
 213 Details depend on the application.
 214 .IP "\s-1SSL_ERROR_SYSCALL\s0" 4
 215 .IX Item "SSL_ERROR_SYSCALL"
 216 Some non-recoverable I/O error occurred.
 217 The OpenSSL error queue may contain more information on the error.
 218 For socket I/O on Unix systems, consult \fBerrno\fR for details.
 219 .IP "\s-1SSL_ERROR_SSL\s0" 4
 220 .IX Item "SSL_ERROR_SSL"
 221 A failure in the \s-1SSL\s0 library occurred, usually a protocol error.  The
 222 OpenSSL error queue contains more information on the error.
 223 .SH "SEE ALSO"
 224 .IX Header "SEE ALSO"
 225 \&\fIssl\fR\|(3), \fIerr\fR\|(3)
 226 .SH "HISTORY"
 227 .IX Header "HISTORY"
 228 \&\fISSL_get_error()\fR was added in SSLeay 0.8.