Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_CTX_set_quiet_shutdown (3openssl)

Name

SSL_CTX_set_quiet_shutdown - SSL_CTX_set_quiet_shutdown, SSL_CTX_get_quiet_shutdown, manipulate shutdown behaviour

Synopsis

#include <openssl/ssl.h>

void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);

void SSL_set_quiet_shutdown(SSL *ssl, int mode);
int SSL_get_quiet_shutdown(const SSL *ssl);

Description

OpenSSL                                   SSL_CTX_set_quiet_shutdown(3openssl)



NAME
       SSL_CTX_set_quiet_shutdown, SSL_CTX_get_quiet_shutdown,
       SSL_set_quiet_shutdown, SSL_get_quiet_shutdown - manipulate shutdown
       behaviour

SYNOPSIS
        #include <openssl/ssl.h>

        void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
        int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);

        void SSL_set_quiet_shutdown(SSL *ssl, int mode);
        int SSL_get_quiet_shutdown(const SSL *ssl);

DESCRIPTION
       SSL_CTX_set_quiet_shutdown() sets the "quiet shutdown" flag for ctx to
       be mode. SSL objects created from ctx inherit the mode valid at the
       time SSL_new(3) is called. mode may be 0 or 1.

       SSL_CTX_get_quiet_shutdown() returns the "quiet shutdown" setting of
       ctx.

       SSL_set_quiet_shutdown() sets the "quiet shutdown" flag for ssl to be
       mode. The setting stays valid until ssl is removed with SSL_free(3) or
       SSL_set_quiet_shutdown() is called again.  It is not changed when
       SSL_clear(3) is called.  mode may be 0 or 1.

       SSL_get_quiet_shutdown() returns the "quiet shutdown" setting of ssl.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

NOTES
       Normally when a SSL connection is finished, the parties must send out
       "close notify" alert messages using SSL_shutdown(3) for a clean
       shutdown.

       When setting the "quiet shutdown" flag to 1, SSL_shutdown(3) will set
       the internal flags to SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN.
       (SSL_shutdown(3) then behaves like SSL_set_shutdown(3) called with
       SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN.)  The session is thus
       considered to be shutdown, but no "close notify" alert is sent to the
       peer. This behaviour violates the TLS standard.

       The default is normal shutdown behaviour as described by the TLS
       standard.

       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.

RETURN VALUES
       SSL_CTX_set_quiet_shutdown() and SSL_set_quiet_shutdown() do not return
       diagnostic information.

       SSL_CTX_get_quiet_shutdown() and SSL_get_quiet_shutdown return the
       current setting.

SEE ALSO
       ssl(3), SSL_shutdown(3), SSL_set_shutdown(3), SSL_new(3), SSL_clear(3),
       SSL_free(3)




1.0.2ze                           2022-05-03
                                          SSL_CTX_set_quiet_shutdown(3openssl)