$NetBSD: SSL_set_shutdown.3,v 1.25 2024/09/08 13:08:35 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "SSL_set_shutdown 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
SSL_set_shutdown, SSL_get_shutdown - manipulate shutdown state of an SSL connection Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& void SSL_set_shutdown(SSL *ssl, int mode); \& int SSL_get_shutdown(const SSL *ssl); .Ve Header "DESCRIPTION" \fBSSL_set_shutdown() sets the shutdown state of ssl to mode.

\fBSSL_get_shutdown() returns the shutdown mode of ssl.

Header "NOTES" The shutdown state of an ssl connection is a bit-mask of: No shutdown setting, yet. Item "SSL_SENT_SHUTDOWN" A close_notify shutdown alert was sent to the peer, the connection is being considered closed and the session is closed and correct. Item "SSL_RECEIVED_SHUTDOWN" A shutdown alert was received form the peer, either a normal close_notify or a fatal error.

SSL_SENT_SHUTDOWN and SSL_RECEIVED_SHUTDOWN can be set at the same time.

The shutdown state of the connection is used to determine the state of the ssl session. If the session is still open, when \fBSSL_clear\|(3) or SSL_free\|(3) is called, it is considered bad and removed according to RFC2246. The actual condition for a correctly closed session is SSL_SENT_SHUTDOWN (according to the TLS RFC, it is acceptable to only send the close_notify alert but to not wait for the peer's answer, when the underlying connection is closed). \fBSSL_set_shutdown() can be used to set this state without sending a close alert to the peer (see SSL_shutdown\|(3)).

If a close_notify was received, SSL_RECEIVED_SHUTDOWN will be set, for setting SSL_SENT_SHUTDOWN the application must however still call \fBSSL_shutdown\|(3) or SSL_set_shutdown() itself.

Header "RETURN VALUES" \fBSSL_set_shutdown() does not return diagnostic information.

\fBSSL_get_shutdown() returns the current setting.

Header "SEE ALSO" \fBssl\|(7), SSL_shutdown\|(3), \fBSSL_CTX_set_quiet_shutdown\|(3), \fBSSL_clear\|(3), SSL_free\|(3) Header "COPYRIGHT" Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.