aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man3
diff options
context:
space:
mode:
authorMatt Caswell <matt@openssl.org>2024-01-15 08:55:48 +0000
committerTomas Mraz <tomas@openssl.org>2024-01-18 11:18:09 +0100
commitead44e19fa3ff7d189876081880f1adb3dfdf30b (patch)
treeeb540b48f8b6aa68a2208f309dc5bd26d6f0d51c /doc/man3
parent3e938453be47751d50917e25b8f7334b482844b3 (diff)
downloadopenssl-ead44e19fa3ff7d189876081880f1adb3dfdf30b.tar.gz
Document SSL_R_UNEXPECTED_EOF_WHILE_READING
Also document that it is ok to use this for control flow decisions. Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/23304)
Diffstat (limited to 'doc/man3')
-rw-r--r--doc/man3/SSL_get_error.pod4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/man3/SSL_get_error.pod b/doc/man3/SSL_get_error.pod
index c3ab1741b1..a205d2ae1a 100644
--- a/doc/man3/SSL_get_error.pod
+++ b/doc/man3/SSL_get_error.pod
@@ -32,7 +32,9 @@ Some TLS implementations do not send a close_notify alert on shutdown.
On an unexpected EOF, versions before OpenSSL 3.0 returned
B<SSL_ERROR_SYSCALL>, nothing was added to the error stack, and errno was 0.
Since OpenSSL 3.0 the returned error is B<SSL_ERROR_SSL> with a meaningful
-error on the error stack.
+error on the error stack (SSL_R_UNEXPECTED_EOF_WHILE_READING). This error reason
+code may be used for control flow decisions (see the man page for
+L<ERR_GET_REASON(3)> for further details on this).
=head1 RETURN VALUES