diff options
author | 2016-11-05 15:32:19 +0000 | |
---|---|---|
committer | 2016-11-05 15:32:19 +0000 | |
commit | f1a3c524c21bf4122aaccb0a497f91f0df230141 (patch) | |
tree | 410d9ce02e6c6d8375947f0b646e354e9e21b616 /lib/libssl/doc/SSL_set_shutdown.3 | |
parent | Check BIO_new*() for failure. (diff) | |
download | wireguard-openbsd-f1a3c524c21bf4122aaccb0a497f91f0df230141.tar.xz wireguard-openbsd-f1a3c524c21bf4122aaccb0a497f91f0df230141.zip |
move manual pages from doc/ to man/ for consistency with other
libraries, in particular considering that there are unrelated
files in doc/; requested by jsing@ and beck@
Diffstat (limited to 'lib/libssl/doc/SSL_set_shutdown.3')
-rw-r--r-- | lib/libssl/doc/SSL_set_shutdown.3 | 88 |
1 files changed, 0 insertions, 88 deletions
diff --git a/lib/libssl/doc/SSL_set_shutdown.3 b/lib/libssl/doc/SSL_set_shutdown.3 deleted file mode 100644 index 546b52dad56..00000000000 --- a/lib/libssl/doc/SSL_set_shutdown.3 +++ /dev/null @@ -1,88 +0,0 @@ -.\" -.\" $OpenBSD: SSL_set_shutdown.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ -.\" -.Dd $Mdocdate: December 2 2014 $ -.Dt SSL_SET_SHUTDOWN 3 -.Os -.Sh NAME -.Nm SSL_set_shutdown , -.Nm SSL_get_shutdown -.Nd manipulate shutdown state of an SSL connection -.Sh SYNOPSIS -.In openssl/ssl.h -.Ft void -.Fn SSL_set_shutdown "SSL *ssl" "int mode" -.Ft int -.Fn SSL_get_shutdown "const SSL *ssl" -.Sh DESCRIPTION -.Fn SSL_set_shutdown -sets the shutdown state of -.Fa ssl -to -.Fa mode . -.Pp -.Fn SSL_get_shutdown -returns the shutdown mode of -.Fa ssl . -.Sh NOTES -The shutdown state of an ssl connection is a bitmask of: -.Bl -tag -width Ds -.It 0 -No shutdown setting, yet. -.It Dv SSL_SENT_SHUTDOWN -A -.Dq close notify -shutdown alert was sent to the peer; the connection is being considered closed -and the session is closed and correct. -.It Dv SSL_RECEIVED_SHUTDOWN -A shutdown alert was received form the peer, either a normal -.Dq close notify -or a fatal error. -.El -.Pp -.Dv SSL_SENT_SHUTDOWN -and -.Dv SSL_RECEIVED_SHUTDOWN -can be set at the same time. -.Pp -The shutdown state of the connection is used to determine the state of the -.Fa ssl -session. -If the session is still open when -.Xr SSL_clear 3 -or -.Xr SSL_free 3 -is called, it is considered bad and removed according to RFC2246. -The actual condition for a correctly closed session is -.Dv SSL_SENT_SHUTDOWN -(according to the TLS RFC, it is acceptable to only send the -.Dq close notify -alert but to not wait for the peer's answer when the underlying connection is -closed). -.Fn SSL_set_shutdown -can be used to set this state without sending a close alert to the peer (see -.Xr SSL_shutdown 3 ) . -.Pp -If a -.Dq close notify -was received, -.Dv SSL_RECEIVED_SHUTDOWN -will be set, but to set -.Dv SSL_SENT_SHUTDOWN -the application must still call -.Xr SSL_shutdown 3 -or -.Fn SSL_set_shutdown -itself. -.Sh RETURN VALUES -.Fn SSL_set_shutdown -does not return diagnostic information. -.Pp -.Fn SSL_get_shutdown -returns the current setting. -.Sh SEE ALSO -.Xr ssl 3 , -.Xr SSL_clear 3 , -.Xr SSL_CTX_set_quiet_shutdown 3 , -.Xr SSL_free 3 , -.Xr SSL_shutdown 3 |