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