Introducing option SSL_OP_IGNORE_UNEXPECTED_EOF
[openssl.git] / 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
87 will result in an error being generated.
88 The error can be ignored using the B<SSL_OP_IGNORE_UNEXPECTED_EOF>.
89 For more information see L<SSL_CTX_set_options(3)>.
90
91 =head2 First to close the connection
92
93 When the application is the first party to send the close_notify
94 alert, SSL_shutdown() will only send the alert and then set the
95 SSL_SENT_SHUTDOWN flag (so that the session is considered good and will
96 be kept in the cache).
97 If successful, SSL_shutdown() will return 0.
98
99 If a unidirectional shutdown is enough (the underlying connection shall be
100 closed anyway), this first successful call to SSL_shutdown() is sufficient.
101
102 In order to complete the bidirectional shutdown handshake, the peer needs
103 to send back a close_notify alert.
104 The SSL_RECEIVED_SHUTDOWN flag will be set after receiving and processing
105 it.
106
107 The peer is still allowed to send data after receiving the close_notify
108 event.
109 When it is done sending data, it will send the close_notify alert.
110 SSL_read() should be called until all data is received.
111 SSL_read() will indicate the end of the peer data by returning <= 0
112 and SSL_get_error() returning SSL_ERROR_ZERO_RETURN.
113
114 =head2 Peer closes the connection
115
116 If the peer already sent the close_notify alert B<and> it was
117 already processed implicitly inside another function
118 (L<SSL_read(3)>), the SSL_RECEIVED_SHUTDOWN flag is set.
119 SSL_read() will return <= 0 in that case, and SSL_get_error() will return
120 SSL_ERROR_ZERO_RETURN.
121 SSL_shutdown() will send the close_notify alert, set the SSL_SENT_SHUTDOWN
122 flag.
123 If successful, SSL_shutdown() will return 1.
124
125 Whether SSL_RECEIVED_SHUTDOWN is already set can be checked using the
126 SSL_get_shutdown() (see also L<SSL_set_shutdown(3)> call.
127
128 =head1 RETURN VALUES
129
130 The following return values can occur:
131
132 =over 4
133
134 =item Z<>0
135
136 The shutdown is not yet finished: the close_notify was sent but the peer
137 did not send it back yet.
138 Call SSL_read() to do a bidirectional shutdown.
139
140 Unlike most other function, returning 0 does not indicate an error.
141 L<SSL_get_error(3)> should not get called, it may misleadingly
142 indicate an error even though no error occurred.
143
144 =item Z<>1
145
146 The shutdown was successfully completed. The close_notify alert was sent
147 and the peer's close_notify alert was received.
148
149 =item E<lt>0
150
151 The shutdown was not successful.
152 Call L<SSL_get_error(3)> with the return value B<ret> to find out the reason.
153 It can occur if an action is needed to continue the operation for non-blocking
154 BIOs.
155
156 It can also occur when not all data was read using SSL_read().
157
158 =back
159
160 =head1 SEE ALSO
161
162 L<SSL_get_error(3)>, L<SSL_connect(3)>,
163 L<SSL_accept(3)>, L<SSL_set_shutdown(3)>,
164 L<SSL_CTX_set_quiet_shutdown(3)>, L<SSL_CTX_set_options(3)>
165 L<SSL_clear(3)>, L<SSL_free(3)>,
166 L<ssl(7)>, L<bio(7)>
167
168 =head1 COPYRIGHT
169
170 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
171
172 Licensed under the Apache License 2.0 (the "License").  You may not use
173 this file except in compliance with the License.  You can obtain a copy
174 in the file LICENSE in the source distribution or at
175 L<https://www.openssl.org/source/license.html>.
176
177 =cut