Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_set_quiet_shutdown.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_CTX_SET_QUIET_SHUTDOWN 3SSL"
58 .TH SSL_CTX_SET_QUIET_SHUTDOWN 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_CTX_set_quiet_shutdown, SSL_CTX_get_quiet_shutdown, SSL_set_quiet_shutdown,
65 SSL_get_quiet_shutdown \- manipulate shutdown behaviour
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ssl.h>
70 \&
71 \& void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
72 \& int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
73 \&
74 \& void SSL_set_quiet_shutdown(SSL *ssl, int mode);
75 \& int SSL_get_quiet_shutdown(const SSL *ssl);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBSSL_CTX_set_quiet_shutdown()\fR sets the "quiet shutdown" flag for \fBctx\fR to be
80 \&\fBmode\fR. SSL objects created from \fBctx\fR inherit the \fBmode\fR valid at the time
81 \&\fBSSL_new\fR\|(3) is called. \fBmode\fR may be 0 or 1.
82 .PP
83 \&\fBSSL_CTX_get_quiet_shutdown()\fR returns the "quiet shutdown" setting of \fBctx\fR.
84 .PP
85 \&\fBSSL_set_quiet_shutdown()\fR sets the "quiet shutdown" flag for \fBssl\fR to be
86 \&\fBmode\fR. The setting stays valid until \fBssl\fR is removed with
87 \&\fBSSL_free\fR\|(3) or \fBSSL_set_quiet_shutdown()\fR is called again.
88 It is not changed when \fBSSL_clear\fR\|(3) is called.
89 \&\fBmode\fR may be 0 or 1.
90 .PP
91 \&\fBSSL_get_quiet_shutdown()\fR returns the "quiet shutdown" setting of \fBssl\fR.
92 .PP
93 These functions are not supported for QUIC SSL objects. \fBSSL_set_quiet_shutdown()\fR
94 has no effect if called on a QUIC SSL object.
95 .SH NOTES
96 .IX Header "NOTES"
97 Normally when an SSL connection is finished, the parties must send out
98 close_notify alert messages using \fBSSL_shutdown\fR\|(3)
99 for a clean shutdown.
100 .PP
101 When setting the "quiet shutdown" flag to 1, \fBSSL_shutdown\fR\|(3)
102 will set the internal flags to SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN.
103 (\fBSSL_shutdown\fR\|(3) then behaves like
104 \&\fBSSL_set_shutdown\fR\|(3) called with
105 SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN.)
106 The session is thus considered to be shutdown, but no close_notify alert
107 is sent to the peer. This behaviour violates the TLS standard.
108 .PP
109 The default is normal shutdown behaviour as described by the TLS standard.
110 .SH "RETURN VALUES"
111 .IX Header "RETURN VALUES"
112 \&\fBSSL_CTX_set_quiet_shutdown()\fR and \fBSSL_set_quiet_shutdown()\fR do not return
113 diagnostic information.
114 .PP
115 \&\fBSSL_CTX_get_quiet_shutdown()\fR and \fBSSL_get_quiet_shutdown()\fR return the current
116 setting.
117 .SH "SEE ALSO"
118 .IX Header "SEE ALSO"
119 \&\fBssl\fR\|(7), \fBSSL_shutdown\fR\|(3),
120 \&\fBSSL_set_shutdown\fR\|(3), \fBSSL_new\fR\|(3),
121 \&\fBSSL_clear\fR\|(3), \fBSSL_free\fR\|(3)
122 .SH COPYRIGHT
123 .IX Header "COPYRIGHT"
124 Copyright 2001\-2023 The OpenSSL Project Authors. All Rights Reserved.
125 .PP
126 Licensed under the Apache License 2.0 (the "License"). You may not use
127 this file except in compliance with the License. You can obtain a copy
128 in the file LICENSE in the source distribution or at
129 <https://www.openssl.org/source/license.html>.