secure/lib/libcrypto/man/SSL_get_error.3

   1 .\" Automatically generated by Pod::Man 4.09 (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 "2018-09-11" "1.1.1" "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_ex()\fR, \fISSL_read()\fR, \fISSL_peek_ex()\fR, \fISSL_peek()\fR, \fISSL_write_ex()\fR or
 151 \&\fISSL_write()\fR on \fBssl\fR.  The value returned by that \s-1TLS/SSL I/O\s0 function must be
 152 passed to \fISSL_get_error()\fR in parameter \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 peer has closed the connection for writing by sending the
 170 \&\*(L"close notify\*(R" alert.
 171 No more data can be read.
 172 Note that \fB\s-1SSL_ERROR_ZERO_RETURN\s0\fR does not necessarily
 173 indicate that the underlying transport has been closed.
 174 .IP "\s-1SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE\s0" 4
 175 .IX Item "SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE"
 176 The operation did not complete and can be retried later.
 177 .Sp
 178 \&\fB\s-1SSL_ERROR_WANT_READ\s0\fR is returned when the last operation was a read
 179 operation from a non-blocking \fB\s-1BIO\s0\fR.
 180 It means that not enough data was available at this time to complete the
 181 operation.
 182 If at a later time the underlying \fB\s-1BIO\s0\fR has data available for reading the same
 183 function can be called again.
 184 .Sp
 185 \&\fISSL_read()\fR and \fISSL_read_ex()\fR can also set \fB\s-1SSL_ERROR_WANT_READ\s0\fR when there is
 186 still unprocessed data available at either the \fB\s-1SSL\s0\fR or the \fB\s-1BIO\s0\fR layer, even
 187 for a blocking \fB\s-1BIO\s0\fR.
 188 See \fISSL_read\fR\|(3) for more information.
 189 .Sp
 190 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR is returned when the last operation was a write
 191 to a non-blocking \fB\s-1BIO\s0\fR and it was unable to sent all data to the \fB\s-1BIO\s0\fR.
 192 When the \fB\s-1BIO\s0\fR is writeable again, the same function can be called again.
 193 .Sp
 194 Note that the retry may again lead to an \fB\s-1SSL_ERROR_WANT_READ\s0\fR or
 195 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR condition.
 196 There is no fixed upper limit for the number of iterations that
 197 may be necessary until progress becomes visible at application
 198 protocol level.
 199 .Sp
 200 It is safe to call \fISSL_read()\fR or \fISSL_read_ex()\fR when more data is available
 201 even when the call that set this error was an \fISSL_write()\fR or \fISSL_write_ex()\fR.
 202 However if the call was an \fISSL_write()\fR or \fISSL_write_ex()\fR, it should be called
 203 again to continue sending the application data.
 204 .Sp
 205 For socket \fB\s-1BIO\s0\fRs (e.g. when \fISSL_set_fd()\fR was used), \fIselect()\fR or
 206 \&\fIpoll()\fR on the underlying socket can be used to find out when the
 207 \&\s-1TLS/SSL I/O\s0 function should be retried.
 208 .Sp
 209 Caveat: Any \s-1TLS/SSL I/O\s0 function can lead to either of
 210 \&\fB\s-1SSL_ERROR_WANT_READ\s0\fR and \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR.
 211 In particular,
 212 \&\fISSL_read_ex()\fR, \fISSL_read()\fR, \fISSL_peek_ex()\fR, or \fISSL_peek()\fR may want to write data
 213 and \fISSL_write()\fR or \fISSL_write_ex()\fR may want to read data.
 214 This is mainly because
 215 \&\s-1TLS/SSL\s0 handshakes may occur at any time during the protocol (initiated by
 216 either the client or the server); \fISSL_read_ex()\fR, \fISSL_read()\fR, \fISSL_peek_ex()\fR,
 217 \&\fISSL_peek()\fR, \fISSL_write_ex()\fR, and \fISSL_write()\fR will handle any pending handshakes.
 218 .IP "\s-1SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT\s0" 4
 219 .IX Item "SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT"
 220 The operation did not complete; the same \s-1TLS/SSL I/O\s0 function should be
 221 called again later. The underlying \s-1BIO\s0 was not connected yet to the peer
 222 and the call would block in \fIconnect()\fR/\fIaccept()\fR. The \s-1SSL\s0 function should be
 223 called again when the connection is established. These messages can only
 224 appear with a \fIBIO_s_connect()\fR or \fIBIO_s_accept()\fR \s-1BIO,\s0 respectively.
 225 In order to find out, when the connection has been successfully established,
 226 on many platforms \fIselect()\fR or \fIpoll()\fR for writing on the socket file descriptor
 227 can be used.
 228 .IP "\s-1SSL_ERROR_WANT_X509_LOOKUP\s0" 4
 229 .IX Item "SSL_ERROR_WANT_X509_LOOKUP"
 230 The operation did not complete because an application callback set by
 231 \&\fISSL_CTX_set_client_cert_cb()\fR has asked to be called again.
 232 The \s-1TLS/SSL I/O\s0 function should be called again later.
 233 Details depend on the application.
 234 .IP "\s-1SSL_ERROR_WANT_ASYNC\s0" 4
 235 .IX Item "SSL_ERROR_WANT_ASYNC"
 236 The operation did not complete because an asynchronous engine is still
 237 processing data. This will only occur if the mode has been set to \s-1SSL_MODE_ASYNC\s0
 238 using \fISSL_CTX_set_mode\fR\|(3) or \fISSL_set_mode\fR\|(3) and an asynchronous capable
 239 engine is being used. An application can determine whether the engine has
 240 completed its processing using \fIselect()\fR or \fIpoll()\fR on the asynchronous wait file
 241 descriptor. This file descriptor is available by calling
 242 \&\fISSL_get_all_async_fds\fR\|(3) or \fISSL_get_changed_async_fds\fR\|(3). The \s-1TLS/SSL I/O\s0
 243 function should be called again later. The function \fBmust\fR be called from the
 244 same thread that the original call was made from.
 245 .IP "\s-1SSL_ERROR_WANT_ASYNC_JOB\s0" 4
 246 .IX Item "SSL_ERROR_WANT_ASYNC_JOB"
 247 The asynchronous job could not be started because there were no async jobs
 248 available in the pool (see \fIASYNC_init_thread\fR\|(3)). This will only occur if the
 249 mode has been set to \s-1SSL_MODE_ASYNC\s0 using \fISSL_CTX_set_mode\fR\|(3) or
 250 \&\fISSL_set_mode\fR\|(3) and a maximum limit has been set on the async job pool
 251 through a call to \fIASYNC_init_thread\fR\|(3). The application should retry the
 252 operation after a currently executing asynchronous operation for the current
 253 thread has completed.
 254 .IP "\s-1SSL_ERROR_WANT_CLIENT_HELLO_CB\s0" 4
 255 .IX Item "SSL_ERROR_WANT_CLIENT_HELLO_CB"
 256 The operation did not complete because an application callback set by
 257 \&\fISSL_CTX_set_client_hello_cb()\fR has asked to be called again.
 258 The \s-1TLS/SSL I/O\s0 function should be called again later.
 259 Details depend on the application.
 260 .IP "\s-1SSL_ERROR_SYSCALL\s0" 4
 261 .IX Item "SSL_ERROR_SYSCALL"
 262 Some non-recoverable I/O error occurred.
 263 The OpenSSL error queue may contain more information on the error.
 264 For socket I/O on Unix systems, consult \fBerrno\fR for details.
 265 .Sp
 266 This value can also be returned for other errors, check the error queue for
 267 details.
 268 .IP "\s-1SSL_ERROR_SSL\s0" 4
 269 .IX Item "SSL_ERROR_SSL"
 270 A failure in the \s-1SSL\s0 library occurred, usually a protocol error.  The
 271 OpenSSL error queue contains more information on the error.
 272 .SH "SEE ALSO"
 273 .IX Header "SEE ALSO"
 274 \&\fIssl\fR\|(7)
 275 .SH "HISTORY"
 276 .IX Header "HISTORY"
 277 \&\s-1SSL_ERROR_WANT_ASYNC\s0 was added in OpenSSL 1.1.0.
 278 \&\s-1SSL_ERROR_WANT_CLIENT_HELLO_CB\s0 was added in OpenSSL 1.1.1.
 279 .SH "COPYRIGHT"
 280 .IX Header "COPYRIGHT"
 281 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 282 .PP
 283 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 284 this file except in compliance with the License.  You can obtain a copy
 285 in the file \s-1LICENSE\s0 in the source distribution or at
 286 <https://www.openssl.org/source/license.html>.