161 lines
4.6 KiB
Groff
161 lines
4.6 KiB
Groff
.\" $OpenBSD: SSL_CTX_set_quiet_shutdown.3,v 1.6 2020/03/30 10:28:59 schwarze Exp $
|
|
.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
|
|
.\"
|
|
.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
|
|
.\" Copyright (c) 2001, 2005 The OpenSSL Project. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\"
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\"
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in
|
|
.\" the documentation and/or other materials provided with the
|
|
.\" distribution.
|
|
.\"
|
|
.\" 3. All advertising materials mentioning features or use of this
|
|
.\" software must display the following acknowledgment:
|
|
.\" "This product includes software developed by the OpenSSL Project
|
|
.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
|
|
.\"
|
|
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
|
|
.\" endorse or promote products derived from this software without
|
|
.\" prior written permission. For written permission, please contact
|
|
.\" openssl-core@openssl.org.
|
|
.\"
|
|
.\" 5. Products derived from this software may not be called "OpenSSL"
|
|
.\" nor may "OpenSSL" appear in their names without prior written
|
|
.\" permission of the OpenSSL Project.
|
|
.\"
|
|
.\" 6. Redistributions of any form whatsoever must retain the following
|
|
.\" acknowledgment:
|
|
.\" "This product includes software developed by the OpenSSL Project
|
|
.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
|
|
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
|
|
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd $Mdocdate: March 30 2020 $
|
|
.Dt SSL_CTX_SET_QUIET_SHUTDOWN 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm SSL_CTX_set_quiet_shutdown ,
|
|
.Nm SSL_CTX_get_quiet_shutdown ,
|
|
.Nm SSL_set_quiet_shutdown ,
|
|
.Nm SSL_get_quiet_shutdown
|
|
.Nd manipulate shutdown behaviour
|
|
.Sh SYNOPSIS
|
|
.In openssl/ssl.h
|
|
.Ft void
|
|
.Fn SSL_CTX_set_quiet_shutdown "SSL_CTX *ctx" "int mode"
|
|
.Ft int
|
|
.Fn SSL_CTX_get_quiet_shutdown "const SSL_CTX *ctx"
|
|
.Ft void
|
|
.Fn SSL_set_quiet_shutdown "SSL *ssl" "int mode"
|
|
.Ft int
|
|
.Fn SSL_get_quiet_shutdown "const SSL *ssl"
|
|
.Sh DESCRIPTION
|
|
.Fn SSL_CTX_set_quiet_shutdown
|
|
sets the
|
|
.Dq quiet shutdown
|
|
flag for
|
|
.Fa ctx
|
|
to be
|
|
.Fa mode .
|
|
.Vt SSL
|
|
objects created from
|
|
.Fa ctx
|
|
inherit the
|
|
.Fa mode
|
|
valid at the time
|
|
.Xr SSL_new 3
|
|
is called.
|
|
.Fa mode
|
|
may be 0 or 1.
|
|
.Pp
|
|
.Fn SSL_CTX_get_quiet_shutdown
|
|
returns the
|
|
.Dq quiet shutdown
|
|
setting of
|
|
.Fa ctx .
|
|
.Pp
|
|
.Fn SSL_set_quiet_shutdown
|
|
sets the
|
|
.Dq quiet shutdown
|
|
flag for
|
|
.Fa ssl
|
|
to be
|
|
.Fa mode .
|
|
The setting stays valid until
|
|
.Fa ssl
|
|
is removed with
|
|
.Xr SSL_free 3
|
|
or
|
|
.Fn SSL_set_quiet_shutdown
|
|
is called again.
|
|
It is not changed when
|
|
.Xr SSL_clear 3
|
|
is called.
|
|
.Fa mode
|
|
may be 0 or 1.
|
|
.Pp
|
|
.Fn SSL_get_quiet_shutdown
|
|
returns the
|
|
.Dq quiet shutdown
|
|
setting of
|
|
.Fa ssl .
|
|
.Pp
|
|
Normally when a SSL connection is finished, the parties must send out
|
|
.Dq close notify
|
|
alert messages using
|
|
.Xr SSL_shutdown 3
|
|
for a clean shutdown.
|
|
.Pp
|
|
When setting the
|
|
.Dq quiet shutdown
|
|
flag to 1,
|
|
.Xr SSL_shutdown 3
|
|
will set the internal flags to
|
|
.Dv SSL_SENT_SHUTDOWN Ns | Ns Dv SSL_RECEIVED_SHUTDOWN
|
|
.Po
|
|
.Xr SSL_shutdown 3
|
|
then behaves like
|
|
.Xr SSL_set_shutdown 3
|
|
called with
|
|
.Dv SSL_SENT_SHUTDOWN Ns | Ns Dv SSL_RECEIVED_SHUTDOWN
|
|
.Pc .
|
|
The session is thus considered to be shut down, but no
|
|
.Dq close notify
|
|
alert is sent to the peer.
|
|
This behaviour violates the TLS standard.
|
|
.Pp
|
|
The default is normal shutdown behaviour as described by the TLS standard.
|
|
.Sh RETURN VALUES
|
|
.Fn SSL_CTX_get_quiet_shutdown
|
|
and
|
|
.Fn SSL_get_quiet_shutdown
|
|
return the current setting.
|
|
.Sh SEE ALSO
|
|
.Xr ssl 3 ,
|
|
.Xr SSL_clear 3 ,
|
|
.Xr SSL_free 3 ,
|
|
.Xr SSL_new 3 ,
|
|
.Xr SSL_set_shutdown 3 ,
|
|
.Xr SSL_shutdown 3
|
|
.Sh HISTORY
|
|
These functions first appeared in SSLeay 0.8.1
|
|
and have been available since
|
|
.Ox 2.4 .
|