X-Git-Url: https://code.wpia.club/?a=blobdiff_plain;f=lib%2Fopenssl%2Fdoc%2Fssl%2FSSL_shutdown.pod;h=e8ec4546a3c756447c06efbe9fdeb8371ace310a;hb=02ed66432c92de70694700164f986190aad3cbc5;hp=85d4a64b03f9edce603f593106af6abdac92dfc1;hpb=89016837dcbf2775cd15dc8cbaba00dc6379f86e;p=cassiopeia.git diff --git a/lib/openssl/doc/ssl/SSL_shutdown.pod b/lib/openssl/doc/ssl/SSL_shutdown.pod index 85d4a64..e8ec454 100644 --- a/lib/openssl/doc/ssl/SSL_shutdown.pod +++ b/lib/openssl/doc/ssl/SSL_shutdown.pod @@ -12,7 +12,7 @@ SSL_shutdown - shut down a TLS/SSL connection =head1 DESCRIPTION -SSL_shutdown() shuts down an active TLS/SSL connection. It sends the +SSL_shutdown() shuts down an active TLS/SSL connection. It sends the "close notify" shutdown alert to the peer. =head1 NOTES @@ -50,21 +50,19 @@ with 1. =item If the peer already sent the "close notify" alert B it was already processed implicitly inside another function -(L), the SSL_RECEIVED_SHUTDOWN flag is set. +(L), the SSL_RECEIVED_SHUTDOWN flag is set. SSL_shutdown() will send the "close notify" alert, set the SSL_SENT_SHUTDOWN flag and will immediately return with 1. Whether SSL_RECEIVED_SHUTDOWN is already set can be checked using the -SSL_get_shutdown() (see also L call. +SSL_get_shutdown() (see also L call. =back It is therefore recommended, to check the return value of SSL_shutdown() and call SSL_shutdown() again, if the bidirectional shutdown is not yet -complete (return value of the first call is 0). As the shutdown is not -specially handled in the SSLv2 protocol, SSL_shutdown() will succeed on -the first call. +complete (return value of the first call is 0). -The behaviour of SSL_shutdown() additionally depends on the underlying BIO. +The behaviour of SSL_shutdown() additionally depends on the underlying BIO. If the underlying BIO is B, SSL_shutdown() will only return once the handshake step has been finished or an error occurred. @@ -82,7 +80,7 @@ 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. +see L. When "quiet shutdown" is enabled, SSL_shutdown() will always succeed and return 1. @@ -96,7 +94,7 @@ The following return values can occur: The shutdown is not yet finished. Call SSL_shutdown() for a second time, if a bidirectional shutdown shall be performed. -The output of L may be misleading, as an +The output of L may be misleading, as an erroneous SSL_ERROR_SYSCALL may be flagged even though no error occurred. =item Z<>1 @@ -104,22 +102,31 @@ erroneous SSL_ERROR_SYSCALL may be flagged even though no error occurred. The shutdown was successfully completed. The "close notify" alert was sent and the peer's "close notify" alert was received. -=item -1 +=item E0 The shutdown was not successful because a fatal error occurred either at the protocol level or a connection failure occurred. It can also occur if action is need to continue the operation for non-blocking BIOs. -Call L with the return value B +Call L with the return value B to find out the reason. =back =head1 SEE ALSO -L, L, -L, L, -L, -L, L, -L, L +L, L, +L, L, +L, +L, L, +L, L + +=head1 COPYRIGHT + +Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. =cut