doc/man3/SSL_shutdown.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_shutdown - shut down a TLS/SSL connection
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  int SSL_shutdown(SSL *ssl);
  12
  13 =head1 DESCRIPTION
  14
  15 SSL_shutdown() shuts down an active TLS/SSL connection. It sends the
  16 close_notify shutdown alert to the peer.
  17
  18 SSL_shutdown() tries to send the close_notify shutdown alert to the peer.
  19 Whether the operation succeeds or not, the SSL_SENT_SHUTDOWN flag is set and
  20 a currently open session is considered closed and good and will be kept in the
  21 session cache for further reuse.
  22
  23 Note that SSL_shutdown() must not be called if a previous fatal error has
  24 occurred on a connection i.e. if SSL_get_error() has returned SSL_ERROR_SYSCALL
  25 or SSL_ERROR_SSL.
  26
  27 The shutdown procedure consists of two steps: sending of the close_notify
  28 shutdown alert, and reception of the peer's close_notify shutdown alert.
  29 The order of those two steps depends on the application.
  30
  31 It is acceptable for an application to only send its shutdown alert and
  32 then close the underlying connection without waiting for the peer's response.
  33 This way resources can be saved, as the process can already terminate or
  34 serve another connection.
  35 This should only be done when it is known that the other side will not send more
  36 data, otherwise there is a risk of a truncation attack.
  37
  38 When a client only writes and never reads from the connection, and the server
  39 has sent a session ticket to establish a session, the client might not be able
  40 to resume the session because it did not received and process the session ticket
  41 from the server.
  42 In case the application wants to be able to resume the session, it is recommended to
  43 do a complete shutdown procedure (bidirectional close_notify alerts).
  44
  45 When the underlying connection shall be used for more communications, the
  46 complete shutdown procedure must be performed, so that the peers stay
  47 synchronized.
  48
  49 SSL_shutdown() only closes the write direction.
  50 It is not possible to call SSL_write() after calling SSL_shutdown().
  51 The read direction is closed by the peer.
  52
  53 The behaviour of SSL_shutdown() additionally depends on the underlying BIO.
  54 If the underlying BIO is B<blocking>, SSL_shutdown() will only return once the
  55 handshake step has been finished or an error occurred.
  56
  57 If the underlying BIO is B<non-blocking>, SSL_shutdown() will also return
  58 when the underlying BIO could not satisfy the needs of SSL_shutdown()
  59 to continue the handshake. In this case a call to SSL_get_error() with the
  60 return value of SSL_shutdown() will yield B<SSL_ERROR_WANT_READ> or
  61 B<SSL_ERROR_WANT_WRITE>. The calling process then must repeat the call after
  62 taking appropriate action to satisfy the needs of SSL_shutdown().
  63 The action depends on the underlying BIO. When using a non-blocking socket,
  64 nothing is to be done, but select() can be used to check for the required
  65 condition. When using a buffering BIO, like a BIO pair, data must be written
  66 into or retrieved out of the BIO before being able to continue.
  67
  68 After SSL_shutdown() returned 0, it is possible to call SSL_shutdown() again
  69 to wait for the peer's close_notify alert.
  70 SSL_shutdown() will return 1 in that case.
  71 However, it is recommended to wait for it using SSL_read() instead.
  72
  73 SSL_shutdown() can be modified to only set the connection to "shutdown"
  74 state but not actually send the close_notify alert messages,
  75 see L<SSL_CTX_set_quiet_shutdown(3)>.
  76 When "quiet shutdown" is enabled, SSL_shutdown() will always succeed
  77 and return 1.
  78 Note that this is not standard compliant behaviour.
  79 It should only be done when the peer has a way to make sure all
  80 data has been received and doesn't wait for the close_notify alert
  81 message, otherwise an unexpected EOF will be reported.
  82
  83 There are implementations that do not send the required close_notify alert.
  84 If there is a need to communicate with such an implementation, and it's clear
  85 that all data has been received, do not wait for the peer's close_notify alert.
  86 Waiting for the close_notify alert when the peer just closes the connection will
  87 result in an error being generated.
  88
  89 =head2 First to close the connection
  90
  91 When the application is the first party to send the close_notify
  92 alert, SSL_shutdown() will only send the alert and then set the
  93 SSL_SENT_SHUTDOWN flag (so that the session is considered good and will
  94 be kept in the cache).
  95 If successful, SSL_shutdown() will return 0.
  96
  97 If a unidirectional shutdown is enough (the underlying connection shall be
  98 closed anyway), this first successful call to SSL_shutdown() is sufficient.
  99
 100 In order to complete the bidirectional shutdown handshake, the peer needs
 101 to send back a close_notify alert.
 102 The SSL_RECEIVED_SHUTDOWN flag will be set after receiving and processing
 103 it.
 104
 105 The peer is still allowed to send data after receiving the close_notify
 106 event.
 107 When it is done sending data, it will send the close_notify alert.
 108 SSL_read() should be called until all data is received.
 109 SSL_read() will indicate the end of the peer data by returning <= 0
 110 and SSL_get_error() returning SSL_ERROR_ZERO_RETURN.
 111
 112 =head2 Peer closes the connection
 113
 114 If the peer already sent the close_notify alert B<and> it was
 115 already processed implicitly inside another function
 116 (L<SSL_read(3)>), the SSL_RECEIVED_SHUTDOWN flag is set.
 117 SSL_read() will return <= 0 in that case, and SSL_get_error() will return
 118 SSL_ERROR_ZERO_RETURN.
 119 SSL_shutdown() will send the close_notify alert, set the SSL_SENT_SHUTDOWN
 120 flag.
 121 If successful, SSL_shutdown() will return 1.
 122
 123 Whether SSL_RECEIVED_SHUTDOWN is already set can be checked using the
 124 SSL_get_shutdown() (see also L<SSL_set_shutdown(3)> call.
 125
 126 =head1 RETURN VALUES
 127
 128 The following return values can occur:
 129
 130 =over 4
 131
 132 =item Z<>0
 133
 134 The shutdown is not yet finished: the close_notify was sent but the peer
 135 did not send it back yet.
 136 Call SSL_read() to do a bidirectional shutdown.
 137
 138 Unlike most other function, returning 0 does not indicate an error.
 139 L<SSL_get_error(3)> should not get called, it may misleadingly
 140 indicate an error even though no error occurred.
 141
 142 =item Z<>1
 143
 144 The shutdown was successfully completed. The close_notify alert was sent
 145 and the peer's close_notify alert was received.
 146
 147 =item E<lt>0
 148
 149 The shutdown was not successful.
 150 Call L<SSL_get_error(3)> with the return value B<ret> to find out the reason.
 151 It can occur if an action is needed to continue the operation for non-blocking
 152 BIOs.
 153
 154 It can also occur when not all data was read using SSL_read().
 155
 156 =back
 157
 158 =head1 SEE ALSO
 159
 160 L<SSL_get_error(3)>, L<SSL_connect(3)>,
 161 L<SSL_accept(3)>, L<SSL_set_shutdown(3)>,
 162 L<SSL_CTX_set_quiet_shutdown(3)>,
 163 L<SSL_clear(3)>, L<SSL_free(3)>,
 164 L<ssl(7)>, L<bio(7)>
 165
 166 =head1 COPYRIGHT
 167
 168 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 169
 170 Licensed under the Apache License 2.0 (the "License").  You may not use
 171 this file except in compliance with the License.  You can obtain a copy
 172 in the file LICENSE in the source distribution or at
 173 L<https://www.openssl.org/source/license.html>.
 174
 175 =cut