diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_get_error.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/SSL_get_error.3 | 28 |
1 files changed, 18 insertions, 10 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_get_error.3 b/secure/lib/libcrypto/man/man3/SSL_get_error.3 index 5d9a1b139cf2..35882750cd48 100644 --- a/secure/lib/libcrypto/man/man3/SSL_get_error.3 +++ b/secure/lib/libcrypto/man/man3/SSL_get_error.3 @@ -1,5 +1,5 @@ .\" -*- mode: troff; coding: utf-8 -*- -.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -52,10 +52,13 @@ . \} .\} .rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l .\" ======================================================================== .\" .IX Title "SSL_GET_ERROR 3ossl" -.TH SSL_GET_ERROR 3ossl 2025-09-30 3.5.4 OpenSSL +.TH SSL_GET_ERROR 3ossl 2026-04-07 3.5.6 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -78,11 +81,12 @@ statement) for a preceding call to \fBSSL_connect()\fR, \fBSSL_accept()\fR, \fBS function must be passed to \fBSSL_get_error()\fR in parameter \fBret\fR. .PP In addition to \fBssl\fR and \fBret\fR, \fBSSL_get_error()\fR inspects the -current thread's OpenSSL error queue. Thus, \fBSSL_get_error()\fR must be +current thread\*(Aqs OpenSSL error queue. Thus, \fBSSL_get_error()\fR must be used in the same thread that performed the TLS/SSL I/O operation, and no other OpenSSL function calls should appear in between. The current -thread's error queue must be empty before the TLS/SSL I/O operation is -attempted, or \fBSSL_get_error()\fR will not work reliably. +thread\*(Aqs error queue must be empty before the TLS/SSL I/O operation is +attempted, or \fBSSL_get_error()\fR will not work reliably. Emptying the +current thread\*(Aqs error queue is done with \fBERR_clear_error\fR\|(3). .SH NOTES .IX Header "NOTES" Some TLS implementations do not send a close_notify alert on shutdown. @@ -114,7 +118,7 @@ is set. See \fBSSL_CTX_set_options\fR\|(3) for more details. .IX Item "SSL_ERROR_WANT_READ, SSL_ERROR_WANT_WRITE" The operation did not complete and can be retried later. .Sp -For non-QUIC SSL objects, \fBSSL_ERROR_WANT_READ\fR is returned when the last +For non\-QUIC SSL objects, \fBSSL_ERROR_WANT_READ\fR is returned when the last operation was a read operation from a nonblocking \fBBIO\fR. It means that not enough data was available at this time to complete the operation. @@ -126,7 +130,7 @@ still unprocessed data available at either the \fBSSL\fR or the \fBBIO\fR layer, for a blocking \fBBIO\fR. See \fBSSL_read\fR\|(3) for more information. .Sp -For non-QUIC SSL objects, \fBSSL_ERROR_WANT_WRITE\fR is returned when the last +For non\-QUIC SSL objects, \fBSSL_ERROR_WANT_WRITE\fR is returned when the last operation was a write to a nonblocking \fBBIO\fR and it was unable to send all data to the \fBBIO\fR. When the \fBBIO\fR is writable again, the same function can be called again. @@ -210,7 +214,7 @@ The TLS/SSL I/O function should be called again later. Details depend on the application. .IP SSL_ERROR_SYSCALL 4 .IX Item "SSL_ERROR_SYSCALL" -Some non-recoverable, fatal I/O error occurred. The OpenSSL error queue may +Some non\-recoverable, fatal I/O error occurred. The OpenSSL error queue may contain more information on the error. For socket I/O on Unix systems, consult \&\fBerrno\fR for details. If this error occurs then no further I/O operations should be performed on the connection and \fBSSL_shutdown()\fR must not be called. @@ -219,13 +223,17 @@ This value can also be returned for other errors, check the error queue for details. .IP SSL_ERROR_SSL 4 .IX Item "SSL_ERROR_SSL" -A non-recoverable, fatal error in the SSL library occurred, usually a protocol +A non\-recoverable, fatal error in the SSL library occurred, usually a protocol error. The OpenSSL error queue contains more information on the error. If this error occurs then no further I/O operations should be performed on the connection and \fBSSL_shutdown()\fR must not be called. +.PP +The OpenSSL error queue can be inspected with the \fBERR\fR family of functions, +such as \fBERR_print_errors\fR\|(3) and \fBERR_peek_last_error_all\fR\|(3). .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fBssl\fR\|(7) +\&\fBssl\fR\|(7), +\&\fBERR_clear_error\fR\|(3), \fBERR_print_errors\fR\|(3), \fBERR_peek_last_error_all\fR\|(3) .SH HISTORY .IX Header "HISTORY" The SSL_ERROR_WANT_ASYNC error code was added in OpenSSL 1.1.0. |