diff options
| author | Tomas Mraz <tomas@openssl.org> | 2023-10-17 10:00:58 +0200 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2023-10-20 16:29:28 +0100 |
| commit | 7757f5ef731ad4e8d6c0f59ef752e4f726ba4f90 (patch) | |
| tree | bac56bfc65b11b4d72cff176130d95fa780fa2d8 /doc | |
| parent | 8e520d2714abf4c6254ceec24b57f238433541ee (diff) | |
QUIC: Add handling of SSL_get_shutdown()
Return SSL_SENT_SHUTDOWN and SSL_RECEIVED_SHUTDOWN with semantics
similar to TLS connections.
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22408)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/SSL_CTX_set_quiet_shutdown.pod | 5 | ||||
| -rw-r--r-- | doc/man3/SSL_set_shutdown.pod | 12 |
2 files changed, 13 insertions, 4 deletions
diff --git a/doc/man3/SSL_CTX_set_quiet_shutdown.pod b/doc/man3/SSL_CTX_set_quiet_shutdown.pod index b7c2a32069..4894e2f5d2 100644 --- a/doc/man3/SSL_CTX_set_quiet_shutdown.pod +++ b/doc/man3/SSL_CTX_set_quiet_shutdown.pod @@ -2,7 +2,8 @@ =head1 NAME -SSL_CTX_set_quiet_shutdown, SSL_CTX_get_quiet_shutdown, SSL_set_quiet_shutdown, SSL_get_quiet_shutdown - manipulate shutdown behaviour +SSL_CTX_set_quiet_shutdown, SSL_CTX_get_quiet_shutdown, SSL_set_quiet_shutdown, +SSL_get_quiet_shutdown - manipulate shutdown behaviour =head1 SYNOPSIS @@ -54,7 +55,7 @@ The default is normal shutdown behaviour as described by the TLS standard. SSL_CTX_set_quiet_shutdown() and SSL_set_quiet_shutdown() do not return diagnostic information. -SSL_CTX_get_quiet_shutdown() and SSL_get_quiet_shutdown return the current +SSL_CTX_get_quiet_shutdown() and SSL_get_quiet_shutdown() return the current setting. =head1 SEE ALSO diff --git a/doc/man3/SSL_set_shutdown.pod b/doc/man3/SSL_set_shutdown.pod index c3b613a247..9a7eb463a8 100644 --- a/doc/man3/SSL_set_shutdown.pod +++ b/doc/man3/SSL_set_shutdown.pod @@ -57,13 +57,21 @@ If a close_notify was received, SSL_RECEIVED_SHUTDOWN will be set, for setting SSL_SENT_SHUTDOWN the application must however still call L<SSL_shutdown(3)> or SSL_set_shutdown() itself. -These functions are not supported for QUIC SSL objects. +SSL_set_shutdown() is not supported for QUIC SSL objects. =head1 RETURN VALUES SSL_set_shutdown() does not return diagnostic information. -SSL_get_shutdown() returns the current setting. +SSL_get_shutdown() returns the current shutdown state as set or based +on the actual connection state. + +SSL_get_shutdown() returns 0 if called on a QUIC stream SSL object. If it +is called on a QUIC connection SSL object, it returns a value with +SSL_SENT_SHUTDOWN set if CONNECTION_CLOSE has been sent to the peer and +it returns a value with SSL_RECEIVED_SHUTDOWN set if CONNECTION_CLOSE +has been received from the peer or the QUIC connection is fully terminated +for other reasons. =head1 SEE ALSO |