diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_CTX_set_quiet_shutdown.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_CTX_set_quiet_shutdown.3 | 115 |
1 files changed, 0 insertions, 115 deletions
diff --git a/src/lib/libssl/doc/SSL_CTX_set_quiet_shutdown.3 b/src/lib/libssl/doc/SSL_CTX_set_quiet_shutdown.3 deleted file mode 100644 index 5cad447318..0000000000 --- a/src/lib/libssl/doc/SSL_CTX_set_quiet_shutdown.3 +++ /dev/null | |||
@@ -1,115 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_CTX_set_quiet_shutdown.3,v 1.3 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_CTX_SET_QUIET_SHUTDOWN 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_CTX_set_quiet_shutdown , | ||
9 | .Nm SSL_CTX_get_quiet_shutdown , | ||
10 | .Nm SSL_set_quiet_shutdown , | ||
11 | .Nm SSL_get_quiet_shutdown | ||
12 | .Nd manipulate shutdown behaviour | ||
13 | .Sh SYNOPSIS | ||
14 | .In openssl/ssl.h | ||
15 | .Ft void | ||
16 | .Fn SSL_CTX_set_quiet_shutdown "SSL_CTX *ctx" "int mode" | ||
17 | .Ft int | ||
18 | .Fn SSL_CTX_get_quiet_shutdown "const SSL_CTX *ctx" | ||
19 | .Ft void | ||
20 | .Fn SSL_set_quiet_shutdown "SSL *ssl" "int mode" | ||
21 | .Ft int | ||
22 | .Fn SSL_get_quiet_shutdown "const SSL *ssl" | ||
23 | .Sh DESCRIPTION | ||
24 | .Fn SSL_CTX_set_quiet_shutdown | ||
25 | sets the | ||
26 | .Dq quiet shutdown | ||
27 | flag for | ||
28 | .Fa ctx | ||
29 | to be | ||
30 | .Fa mode . | ||
31 | .Vt SSL | ||
32 | objects created from | ||
33 | .Fa ctx | ||
34 | inherit the | ||
35 | .Fa mode | ||
36 | valid at the time | ||
37 | .Xr SSL_new 3 | ||
38 | is called. | ||
39 | .Fa mode | ||
40 | may be 0 or 1. | ||
41 | .Pp | ||
42 | .Fn SSL_CTX_get_quiet_shutdown | ||
43 | returns the | ||
44 | .Dq quiet shutdown | ||
45 | setting of | ||
46 | .Fa ctx . | ||
47 | .Pp | ||
48 | .Fn SSL_set_quiet_shutdown | ||
49 | sets the | ||
50 | .Dq quiet shutdown | ||
51 | flag for | ||
52 | .Fa ssl | ||
53 | to be | ||
54 | .Fa mode . | ||
55 | The setting stays valid until | ||
56 | .Fa ssl | ||
57 | is removed with | ||
58 | .Xr SSL_free 3 | ||
59 | or | ||
60 | .Fn SSL_set_quiet_shutdown | ||
61 | is called again. | ||
62 | It is not changed when | ||
63 | .Xr SSL_clear 3 | ||
64 | is called. | ||
65 | .Fa mode | ||
66 | may be 0 or 1. | ||
67 | .Pp | ||
68 | .Fn SSL_get_quiet_shutdown | ||
69 | returns the | ||
70 | .Dq quiet shutdown | ||
71 | setting of | ||
72 | .Fa ssl . | ||
73 | .Sh NOTES | ||
74 | Normally when a SSL connection is finished, the parties must send out | ||
75 | .Dq close notify | ||
76 | alert messages using | ||
77 | .Xr SSL_shutdown 3 | ||
78 | for a clean shutdown. | ||
79 | .Pp | ||
80 | When setting the | ||
81 | .Dq quiet shutdown | ||
82 | flag to 1, | ||
83 | .Xr SSL_shutdown 3 | ||
84 | will set the internal flags to | ||
85 | .Dv SSL_SENT_SHUTDOWN Ns | Ns Dv SSL_RECEIVED_SHUTDOWN | ||
86 | .Po | ||
87 | .Xr SSL_shutdown 3 | ||
88 | then behaves like | ||
89 | .Xr SSL_set_shutdown 3 | ||
90 | called with | ||
91 | .Dv SSL_SENT_SHUTDOWN Ns | Ns Dv SSL_RECEIVED_SHUTDOWN | ||
92 | .Pc . | ||
93 | The session is thus considered to be shut down, but no | ||
94 | .Dq close notify | ||
95 | alert is sent to the peer. | ||
96 | This behaviour violates the TLS standard. | ||
97 | .Pp | ||
98 | The default is normal shutdown behaviour as described by the TLS standard. | ||
99 | .Sh RETURN VALUES | ||
100 | .Fn SSL_CTX_set_quiet_shutdown | ||
101 | and | ||
102 | .Fn SSL_set_quiet_shutdown | ||
103 | do not return diagnostic information. | ||
104 | .Pp | ||
105 | .Fn SSL_CTX_get_quiet_shutdown | ||
106 | and | ||
107 | .Fn SSL_get_quiet_shutdown | ||
108 | return the current setting. | ||
109 | .Sh SEE ALSO | ||
110 | .Xr ssl 3 , | ||
111 | .Xr SSL_clear 3 , | ||
112 | .Xr SSL_free 3 , | ||
113 | .Xr SSL_new 3 , | ||
114 | .Xr SSL_set_shutdown 3 , | ||
115 | .Xr SSL_shutdown 3 | ||