SSL_get_error.pod revision 344604
1=pod 2 3=head1 NAME 4 5SSL_get_error - obtain result code for TLS/SSL I/O operation 6 7=head1 SYNOPSIS 8 9 #include <openssl/ssl.h> 10 11 int SSL_get_error(const SSL *ssl, int ret); 12 13=head1 DESCRIPTION 14 15SSL_get_error() returns a result code (suitable for the C "switch" 16statement) for a preceding call to SSL_connect(), SSL_accept(), SSL_do_handshake(), 17SSL_read(), SSL_peek(), or SSL_write() on B<ssl>. The value returned by 18that TLS/SSL I/O function must be passed to SSL_get_error() in parameter 19B<ret>. 20 21In addition to B<ssl> and B<ret>, SSL_get_error() inspects the 22current thread's OpenSSL error queue. Thus, SSL_get_error() must be 23used in the same thread that performed the TLS/SSL I/O operation, and no 24other OpenSSL function calls should appear in between. The current 25thread's error queue must be empty before the TLS/SSL I/O operation is 26attempted, or SSL_get_error() will not work reliably. 27 28=head1 RETURN VALUES 29 30The following return values can currently occur: 31 32=over 4 33 34=item SSL_ERROR_NONE 35 36The TLS/SSL I/O operation completed. This result code is returned 37if and only if B<ret E<gt> 0>. 38 39=item SSL_ERROR_ZERO_RETURN 40 41The TLS/SSL connection has been closed. 42If the protocol version is SSL 3.0 or higher, this result code is returned only 43if a closure alert has occurred in the protocol, i.e. if the connection has been 44closed cleanly. 45Note that in this case B<SSL_ERROR_ZERO_RETURN> does not necessarily 46indicate that the underlying transport has been closed. 47 48 49=item SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE 50 51The operation did not complete; the same TLS/SSL I/O function should be 52called again later. If, by then, the underlying B<BIO> has data 53available for reading (if the result code is B<SSL_ERROR_WANT_READ>) 54or allows writing data (B<SSL_ERROR_WANT_WRITE>), then some TLS/SSL 55protocol progress will take place, i.e. at least part of an TLS/SSL 56record will be read or written. Note that the retry may again lead to 57a B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE> condition. 58There is no fixed upper limit for the number of iterations that 59may be necessary until progress becomes visible at application 60protocol level. 61 62For socket B<BIO>s (e.g. when SSL_set_fd() was used), select() or 63poll() on the underlying socket can be used to find out when the 64TLS/SSL I/O function should be retried. 65 66Caveat: Any TLS/SSL I/O function can lead to either of 67B<SSL_ERROR_WANT_READ> and B<SSL_ERROR_WANT_WRITE>. In particular, 68SSL_read() or SSL_peek() may want to write data and SSL_write() may want 69to read data. This is mainly because TLS/SSL handshakes may occur at any 70time during the protocol (initiated by either the client or the server); 71SSL_read(), SSL_peek(), and SSL_write() will handle any pending handshakes. 72 73=item SSL_ERROR_WANT_CONNECT, SSL_ERROR_WANT_ACCEPT 74 75The operation did not complete; the same TLS/SSL I/O function should be 76called again later. The underlying BIO was not connected yet to the peer 77and the call would block in connect()/accept(). The SSL function should be 78called again when the connection is established. These messages can only 79appear with a BIO_s_connect() or BIO_s_accept() BIO, respectively. 80In order to find out, when the connection has been successfully established, 81on many platforms select() or poll() for writing on the socket file descriptor 82can be used. 83 84=item SSL_ERROR_WANT_X509_LOOKUP 85 86The operation did not complete because an application callback set by 87SSL_CTX_set_client_cert_cb() has asked to be called again. 88The TLS/SSL I/O function should be called again later. 89Details depend on the application. 90 91=item SSL_ERROR_SYSCALL 92 93Some non-recoverable, fatal I/O error occurred. The OpenSSL error queue may 94contain more information on the error. For socket I/O on Unix systems, consult 95B<errno> for details. If this error occurs then no further I/O operations should 96be performed on the connection and SSL_shutdown() must not be called. 97 98=item SSL_ERROR_SSL 99 100A non-recoverable, fatal error in the SSL library occurred, usually a protocol 101error. The OpenSSL error queue contains more information on the error. If this 102error occurs then no further I/O operations should be performed on the 103connection and SSL_shutdown() must not be called. 104 105=back 106 107=head1 SEE ALSO 108 109L<ssl(3)|ssl(3)>, L<err(3)|err(3)> 110 111=head1 HISTORY 112 113SSL_get_error() was added in SSLeay 0.8. 114 115=cut 116