1=pod
2
3=head1 NAME
4
5SSL_CTX_set_quiet_shutdown, SSL_CTX_get_quiet_shutdown, SSL_set_quiet_shutdown,
6SSL_get_quiet_shutdown - manipulate shutdown behaviour
7
8=head1 SYNOPSIS
9
10 #include <openssl/ssl.h>
11
12 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
13 int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
14
15 void SSL_set_quiet_shutdown(SSL *ssl, int mode);
16 int SSL_get_quiet_shutdown(const SSL *ssl);
17
18=head1 DESCRIPTION
19
20SSL_CTX_set_quiet_shutdown() sets the "quiet shutdown" flag for B<ctx> to be
21B<mode>. SSL objects created from B<ctx> inherit the B<mode> valid at the time
22L<SSL_new(3)> is called. B<mode> may be 0 or 1.
23
24SSL_CTX_get_quiet_shutdown() returns the "quiet shutdown" setting of B<ctx>.
25
26SSL_set_quiet_shutdown() sets the "quiet shutdown" flag for B<ssl> to be
27B<mode>. The setting stays valid until B<ssl> is removed with
28L<SSL_free(3)> or SSL_set_quiet_shutdown() is called again.
29It is not changed when L<SSL_clear(3)> is called.
30B<mode> may be 0 or 1.
31
32SSL_get_quiet_shutdown() returns the "quiet shutdown" setting of B<ssl>.
33
34These functions are not supported for QUIC SSL objects. SSL_set_quiet_shutdown()
35has no effect if called on a QUIC SSL object.
36
37=head1 NOTES
38
39Normally when an SSL connection is finished, the parties must send out
40close_notify alert messages using L<SSL_shutdown(3)>
41for a clean shutdown.
42
43When setting the "quiet shutdown" flag to 1, L<SSL_shutdown(3)>
44will set the internal flags to SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN.
45(L<SSL_shutdown(3)> then behaves like
46L<SSL_set_shutdown(3)> called with
47SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN.)
48The session is thus considered to be shutdown, but no close_notify alert
49is sent to the peer. This behaviour violates the TLS standard.
50
51The default is normal shutdown behaviour as described by the TLS standard.
52
53=head1 RETURN VALUES
54
55SSL_CTX_set_quiet_shutdown() and SSL_set_quiet_shutdown() do not return
56diagnostic information.
57
58SSL_CTX_get_quiet_shutdown() and SSL_get_quiet_shutdown() return the current
59setting.
60
61=head1 SEE ALSO
62
63L<ssl(7)>, L<SSL_shutdown(3)>,
64L<SSL_set_shutdown(3)>, L<SSL_new(3)>,
65L<SSL_clear(3)>, L<SSL_free(3)>
66
67=head1 COPYRIGHT
68
69Copyright 2001-2023 The OpenSSL Project Authors. All Rights Reserved.
70
71Licensed under the Apache License 2.0 (the "License").  You may not use
72this file except in compliance with the License.  You can obtain a copy
73in the file LICENSE in the source distribution or at
74L<https://www.openssl.org/source/license.html>.
75
76=cut
77