xref: /freebsd/secure/lib/libcrypto/man/man3/SSL_set_shutdown.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

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

\fBSSL_get_shutdown() returns the shutdown mode of ssl.

"NOTES"
Header "NOTES" The shutdown state of an ssl connection is a bit-mask of:
"0" 4
No shutdown setting, yet.
"\s-1SSL_SENT_SHUTDOWN\s0" 4
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.
"\s-1SSL_RECEIVED_SHUTDOWN\s0" 4
Item "SSL_RECEIVED_SHUTDOWN" A shutdown alert was received form the peer, either a normal close_notify or a fatal error.

\s-1SSL_SENT_SHUTDOWN\s0 and \s-1SSL_RECEIVED_SHUTDOWN\s0 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 \s-1RFC2246.\s0 The actual condition for a correctly closed session is \s-1SSL_SENT_SHUTDOWN\s0 (according to the \s-1TLS RFC,\s0 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, \s-1SSL_RECEIVED_SHUTDOWN\s0 will be set, for setting \s-1SSL_SENT_SHUTDOWN\s0 the application must however still call \fBSSL_shutdown\|(3) or SSL_set_shutdown() itself.

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

\fBSSL_get_shutdown() returns the current setting.

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

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