doc/man3/SSL_CTX_set_quiet_shutdown.pod

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