secure/lib/libcrypto/man/man3/SSL_get_error.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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 .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 "2020-03-31" "1.1.1f" "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 \&\fBSSL_get_error()\fR returns a result code (suitable for the C \*(L"switch\*(R"
 153 statement) for a preceding call to \fBSSL_connect()\fR, \fBSSL_accept()\fR, \fBSSL_do_handshake()\fR,
 154 \&\fBSSL_read_ex()\fR, \fBSSL_read()\fR, \fBSSL_peek_ex()\fR, \fBSSL_peek()\fR, \fBSSL_shutdown()\fR,
 155 \&\fBSSL_write_ex()\fR or \fBSSL_write()\fR on \fBssl\fR.  The value returned by that \s-1TLS/SSL I/O\s0
 156 function must be passed to \fBSSL_get_error()\fR in parameter \fBret\fR.
 157 .PP
 158 In addition to \fBssl\fR and \fBret\fR, \fBSSL_get_error()\fR inspects the
 159 current thread's OpenSSL error queue.  Thus, \fBSSL_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 \fBSSL_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 peer has closed the connection for writing by sending the
 174 close_notify alert.
 175 No more data can be read.
 176 Note that \fB\s-1SSL_ERROR_ZERO_RETURN\s0\fR does not necessarily
 177 indicate that the underlying transport has been closed.
 178 .IP "\s-1SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE\s0" 4
 179 .IX Item "SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE"
 180 The operation did not complete and can be retried later.
 181 .Sp
 182 \&\fB\s-1SSL_ERROR_WANT_READ\s0\fR is returned when the last operation was a read
 183 operation from a non-blocking \fB\s-1BIO\s0\fR.
 184 It means that not enough data was available at this time to complete the
 185 operation.
 186 If at a later time the underlying \fB\s-1BIO\s0\fR has data available for reading the same
 187 function can be called again.
 188 .Sp
 189 \&\fBSSL_read()\fR and \fBSSL_read_ex()\fR can also set \fB\s-1SSL_ERROR_WANT_READ\s0\fR when there is
 190 still unprocessed data available at either the \fB\s-1SSL\s0\fR or the \fB\s-1BIO\s0\fR layer, even
 191 for a blocking \fB\s-1BIO\s0\fR.
 192 See \fBSSL_read\fR\|(3) for more information.
 193 .Sp
 194 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR is returned when the last operation was a write
 195 to a non-blocking \fB\s-1BIO\s0\fR and it was unable to sent all data to the \fB\s-1BIO\s0\fR.
 196 When the \fB\s-1BIO\s0\fR is writeable again, the same function can be called again.
 197 .Sp
 198 Note that the retry may again lead to an \fB\s-1SSL_ERROR_WANT_READ\s0\fR or
 199 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR condition.
 200 There is no fixed upper limit for the number of iterations that
 201 may be necessary until progress becomes visible at application
 202 protocol level.
 203 .Sp
 204 It is safe to call \fBSSL_read()\fR or \fBSSL_read_ex()\fR when more data is available
 205 even when the call that set this error was an \fBSSL_write()\fR or \fBSSL_write_ex()\fR.
 206 However if the call was an \fBSSL_write()\fR or \fBSSL_write_ex()\fR, it should be called
 207 again to continue sending the application data.
 208 .Sp
 209 For socket \fB\s-1BIO\s0\fRs (e.g. when \fBSSL_set_fd()\fR was used), \fBselect()\fR or
 210 \&\fBpoll()\fR on the underlying socket can be used to find out when the
 211 \&\s-1TLS/SSL I/O\s0 function should be retried.
 212 .Sp
 213 Caveat: Any \s-1TLS/SSL I/O\s0 function can lead to either of
 214 \&\fB\s-1SSL_ERROR_WANT_READ\s0\fR and \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR.
 215 In particular,
 216 \&\fBSSL_read_ex()\fR, \fBSSL_read()\fR, \fBSSL_peek_ex()\fR, or \fBSSL_peek()\fR may want to write data
 217 and \fBSSL_write()\fR or \fBSSL_write_ex()\fR may want to read data.
 218 This is mainly because
 219 \&\s-1TLS/SSL\s0 handshakes may occur at any time during the protocol (initiated by
 220 either the client or the server); \fBSSL_read_ex()\fR, \fBSSL_read()\fR, \fBSSL_peek_ex()\fR,
 221 \&\fBSSL_peek()\fR, \fBSSL_write_ex()\fR, and \fBSSL_write()\fR will handle any pending handshakes.
 222 .IP "\s-1SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT\s0" 4
 223 .IX Item "SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT"
 224 The operation did not complete; the same \s-1TLS/SSL I/O\s0 function should be
 225 called again later. The underlying \s-1BIO\s0 was not connected yet to the peer
 226 and the call would block in \fBconnect()\fR/\fBaccept()\fR. The \s-1SSL\s0 function should be
 227 called again when the connection is established. These messages can only
 228 appear with a \fBBIO_s_connect()\fR or \fBBIO_s_accept()\fR \s-1BIO,\s0 respectively.
 229 In order to find out, when the connection has been successfully established,
 230 on many platforms \fBselect()\fR or \fBpoll()\fR for writing on the socket file descriptor
 231 can be used.
 232 .IP "\s-1SSL_ERROR_WANT_X509_LOOKUP\s0" 4
 233 .IX Item "SSL_ERROR_WANT_X509_LOOKUP"
 234 The operation did not complete because an application callback set by
 235 \&\fBSSL_CTX_set_client_cert_cb()\fR has asked to be called again.
 236 The \s-1TLS/SSL I/O\s0 function should be called again later.
 237 Details depend on the application.
 238 .IP "\s-1SSL_ERROR_WANT_ASYNC\s0" 4
 239 .IX Item "SSL_ERROR_WANT_ASYNC"
 240 The operation did not complete because an asynchronous engine is still
 241 processing data. This will only occur if the mode has been set to \s-1SSL_MODE_ASYNC\s0
 242 using \fBSSL_CTX_set_mode\fR\|(3) or \fBSSL_set_mode\fR\|(3) and an asynchronous capable
 243 engine is being used. An application can determine whether the engine has
 244 completed its processing using \fBselect()\fR or \fBpoll()\fR on the asynchronous wait file
 245 descriptor. This file descriptor is available by calling
 246 \&\fBSSL_get_all_async_fds\fR\|(3) or \fBSSL_get_changed_async_fds\fR\|(3). The \s-1TLS/SSL I/O\s0
 247 function should be called again later. The function \fBmust\fR be called from the
 248 same thread that the original call was made from.
 249 .IP "\s-1SSL_ERROR_WANT_ASYNC_JOB\s0" 4
 250 .IX Item "SSL_ERROR_WANT_ASYNC_JOB"
 251 The asynchronous job could not be started because there were no async jobs
 252 available in the pool (see \fBASYNC_init_thread\fR\|(3)). This will only occur if the
 253 mode has been set to \s-1SSL_MODE_ASYNC\s0 using \fBSSL_CTX_set_mode\fR\|(3) or
 254 \&\fBSSL_set_mode\fR\|(3) and a maximum limit has been set on the async job pool
 255 through a call to \fBASYNC_init_thread\fR\|(3). The application should retry the
 256 operation after a currently executing asynchronous operation for the current
 257 thread has completed.
 258 .IP "\s-1SSL_ERROR_WANT_CLIENT_HELLO_CB\s0" 4
 259 .IX Item "SSL_ERROR_WANT_CLIENT_HELLO_CB"
 260 The operation did not complete because an application callback set by
 261 \&\fBSSL_CTX_set_client_hello_cb()\fR has asked to be called again.
 262 The \s-1TLS/SSL I/O\s0 function should be called again later.
 263 Details depend on the application.
 264 .IP "\s-1SSL_ERROR_SYSCALL\s0" 4
 265 .IX Item "SSL_ERROR_SYSCALL"
 266 Some non-recoverable, fatal I/O error occurred. The OpenSSL error queue may
 267 contain more information on the error. For socket I/O on Unix systems, consult
 268 \&\fBerrno\fR for details. If this error occurs then no further I/O operations should
 269 be performed on the connection and \fBSSL_shutdown()\fR must not be called.
 270 .Sp
 271 This value can also be returned for other errors, check the error queue for
 272 details.
 273 .IP "\s-1SSL_ERROR_SSL\s0" 4
 274 .IX Item "SSL_ERROR_SSL"
 275 A non-recoverable, fatal error in the \s-1SSL\s0 library occurred, usually a protocol
 276 error.  The OpenSSL error queue contains more information on the error. If this
 277 error occurs then no further I/O operations should be performed on the
 278 connection and \fBSSL_shutdown()\fR must not be called.
 279 .SH "BUGS"
 280 .IX Header "BUGS"
 281 The \fB\s-1SSL_ERROR_SYSCALL\s0\fR with \fBerrno\fR value of 0 indicates unexpected \s-1EOF\s0 from
 282 the peer. This will be properly reported as \fB\s-1SSL_ERROR_SSL\s0\fR with reason
 283 code \fB\s-1SSL_R_UNEXPECTED_EOF_WHILE_READING\s0\fR in the OpenSSL 3.0 release because
 284 it is truly a \s-1TLS\s0 protocol error to terminate the connection without
 285 a \fBSSL_shutdown()\fR.
 286 .PP
 287 The issue is kept unfixed in OpenSSL 1.1.1 releases because many applications
 288 which choose to ignore this protocol error depend on the existing way of
 289 reporting the error.
 290 .SH "SEE ALSO"
 291 .IX Header "SEE ALSO"
 292 \&\fBssl\fR\|(7)
 293 .SH "HISTORY"
 294 .IX Header "HISTORY"
 295 The \s-1SSL_ERROR_WANT_ASYNC\s0 error code was added in OpenSSL 1.1.0.
 296 The \s-1SSL_ERROR_WANT_CLIENT_HELLO_CB\s0 error code was added in OpenSSL 1.1.1.
 297 .SH "COPYRIGHT"
 298 .IX Header "COPYRIGHT"
 299 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
 300 .PP
 301 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 302 this file except in compliance with the License.  You can obtain a copy
 303 in the file \s-1LICENSE\s0 in the source distribution or at
 304 <https://www.openssl.org/source/license.html>.