From: Lutz Jänicke Date: Fri, 17 Aug 2001 15:09:31 +0000 (+0000) Subject: SSL_shutdown() has even more properties... X-Git-Tag: OpenSSL_0_9_6c~147^2~2 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=cdd7c3ce92007145c0cfef886f4c1eb814af1c21;p=oweals%2Fopenssl.git SSL_shutdown() has even more properties... --- diff --git a/doc/ssl/SSL_CTX_set_quiet_shutdown.pod b/doc/ssl/SSL_CTX_set_quiet_shutdown.pod new file mode 100644 index 0000000000..1d0526d59a --- /dev/null +++ b/doc/ssl/SSL_CTX_set_quiet_shutdown.pod @@ -0,0 +1,63 @@ +=pod + +=head1 NAME + +SSL_CTX_set_quiet_shutdown, SSL_CTX_get_quiet_shutdown, SSL_set_quiet_shutdown, SSL_get_quiet_shutdown - manipulate shutdown behaviour + +=head1 SYNOPSIS + + #include + + void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode); + int SSL_CTX_get_quiet_shutdown(SSL_CTX *ctx); + + void SSL_set_quiet_shutdown(SSL *ssl, int mode); + int SSL_get_quiet_shutdown(SSL *ssl); + +=head1 DESCRIPTION + +SSL_CTX_set_quiet_shutdown() sets the "quiet shutdown" flag for B to be +B. SSL objects created from B inherit the B valid at the time +L is called. B may be 0 or 1. + +SSL_CTX_get_quiet_shutdown() returns the "quiet shutdown" setting of B. + +SSL_set_quiet_shutdown() sets the "quiet shutdown" flag for B to be +B. The setting stays valid until B is removed with +L or SSL_set_quiet_shutdown() is called again. +It is not changed when L is called. +B may be 0 or 1. + +SSL_get_quiet_shutdown() returns the "quiet shutdown" setting of B. + +=head1 NOTES + +Normally when a SSL connection is finished, the parties must send out +"close notify" alert messages using L +for a clean shutdown. + +When setting the "quiet shutdown" flag to 1, L +will set the internal flags to SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN. +(L then behaves like +L called with +SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN.) +The session is thus considered to be shutdown, but no "close notify" alert +is sent to the peer. This behaviour violates the TLS standard. + +The default is normal shutdown behaviour as described by the TLS standard. + +=head1 RETURN VALUES + +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 +setting. + +=head1 SEE ALSO + +L, L, +L, L, +L, L + +=cut diff --git a/doc/ssl/SSL_set_shutdown.pod b/doc/ssl/SSL_set_shutdown.pod index 6b196c1f15..119bb83c55 100644 --- a/doc/ssl/SSL_set_shutdown.pod +++ b/doc/ssl/SSL_set_shutdown.pod @@ -63,6 +63,7 @@ SSL_get_shutdown() returns the current setting. =head1 SEE ALSO L, L, +L, L, L =cut diff --git a/doc/ssl/SSL_shutdown.pod b/doc/ssl/SSL_shutdown.pod index 3dcd0ddf45..e205eac309 100644 --- a/doc/ssl/SSL_shutdown.pod +++ b/doc/ssl/SSL_shutdown.pod @@ -77,6 +77,12 @@ nothing is to be done, but select() can be used to check for the required condition. When using a buffering BIO, like a BIO pair, data must be written into or retrieved out of the BIO before being able to continue. +SSL_shutdown() can be modified to only set the connection to "shutdown" +state but not actually send the "close notify" alert messages, +see L. +When "quiet shutdown" is enabled, SSL_shutdown() will always succeed +and return 1. + =head1 RETURN VALUES The following return values can occur: @@ -109,6 +115,7 @@ to find out the reason. L, L, L, L, +L, L, L, L, L diff --git a/doc/ssl/ssl.pod b/doc/ssl/ssl.pod index eb2c44aaee..7577a9820b 100644 --- a/doc/ssl/ssl.pod +++ b/doc/ssl/ssl.pod @@ -667,6 +667,7 @@ L, L, L, L, +L, L, L, L,