summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authortb <>2021-04-15 16:13:22 +0000
committertb <>2021-04-15 16:13:22 +0000
commitb2be6cbf1a3943747b1a702732eba2d909d56c23 (patch)
treeba77cc0a4f519c0715c8a72e562f291252a5f85c /src/lib
parent906867a7f88a888f986169775a5186de23cf5b27 (diff)
downloadopenbsd-b2be6cbf1a3943747b1a702732eba2d909d56c23.tar.gz
openbsd-b2be6cbf1a3943747b1a702732eba2d909d56c23.tar.bz2
openbsd-b2be6cbf1a3943747b1a702732eba2d909d56c23.zip
Merge documentation for SSL_is_dtls() from OpenSSL
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libssl/man/SSL_get_version.326
1 files changed, 21 insertions, 5 deletions
diff --git a/src/lib/libssl/man/SSL_get_version.3 b/src/lib/libssl/man/SSL_get_version.3
index 7935b75f92..a6cefb055b 100644
--- a/src/lib/libssl/man/SSL_get_version.3
+++ b/src/lib/libssl/man/SSL_get_version.3
@@ -1,5 +1,5 @@
1.\" $OpenBSD: SSL_get_version.3,v 1.8 2021/03/31 18:03:13 tb Exp $ 1.\" $OpenBSD: SSL_get_version.3,v 1.9 2021/04/15 16:13:22 tb Exp $
2.\" full merge up to: OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400 2.\" full merge up to: OpenSSL e417070c Jun 8 11:37:06 2016 -0400
3.\" selective merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100 3.\" selective merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100
4.\" 4.\"
5.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. 5.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
@@ -49,11 +49,12 @@
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\" 51.\"
52.Dd $Mdocdate: March 31 2021 $ 52.Dd $Mdocdate: April 15 2021 $
53.Dt SSL_GET_VERSION 3 53.Dt SSL_GET_VERSION 3
54.Os 54.Os
55.Sh NAME 55.Sh NAME
56.Nm SSL_get_version , 56.Nm SSL_get_version ,
57.Nm SSL_is_dtls ,
57.Nm SSL_version 58.Nm SSL_version
58.\" The following are intentionally undocumented because 59.\" The following are intentionally undocumented because
59.\" - the longer term plan is to remove them 60.\" - the longer term plan is to remove them
@@ -61,25 +62,33 @@
61.\" - and they have the wrong namespace prefix 62.\" - and they have the wrong namespace prefix
62.\" Nm TLS1_get_version 63.\" Nm TLS1_get_version
63.\" Nm TLS1_get_client_version 64.\" Nm TLS1_get_client_version
64.Nd get the protocol version of a connection 65.Nd get the protocol information of a connection
65.Sh SYNOPSIS 66.Sh SYNOPSIS
66.In openssl/ssl.h 67.In openssl/ssl.h
67.Ft const char * 68.Ft const char *
68.Fn SSL_get_version "const SSL *ssl" 69.Fn SSL_get_version "const SSL *ssl"
69.Ft int 70.Ft int
71.Fn SSL_is_dtls "const SSL *ssl"
72.Ft int
70.Fn SSL_version "const SSL *ssl" 73.Fn SSL_version "const SSL *ssl"
71.Sh DESCRIPTION 74.Sh DESCRIPTION
72.Fn SSL_get_version 75.Fn SSL_get_version
73returns the name of the protocol used for the connection 76returns the name of the protocol used for the connection
74.Fa ssl . 77.Fa ssl .
75.Pp 78.Pp
79.Fn SSL_is_dtls
80returns 1 if the connection is using DTLS, 0 if not.
81.Pp
76.Fn SSL_version 82.Fn SSL_version
77returns an integer constant representing that protocol. 83returns an integer constant representing that protocol.
78.Pp 84.Pp
79These functions only return reliable results 85These functions only return reliable results
80after the initial handshake has been completed. 86after the initial handshake has been completed.
81.Sh RETURN VALUES 87.Sh RETURN VALUES
82The following strings or integers can be returned: 88The following strings or integers can be returned by
89.Fn SSL_get_version
90and
91.Fn SSL_version :
83.Bl -tag -width Ds 92.Bl -tag -width Ds
84.It Qo TLSv1 Qc No or Dv TLS1_VERSION 93.It Qo TLSv1 Qc No or Dv TLS1_VERSION
85The connection uses the TLSv1.0 protocol. 94The connection uses the TLSv1.0 protocol.
@@ -97,6 +106,9 @@ The connection uses the Datagram Transport Layer Security 1.2 protocol.
97This indicates an unknown protocol version; 106This indicates an unknown protocol version;
98it cannot currently happen with LibreSSL. 107it cannot currently happen with LibreSSL.
99.El 108.El
109.Pp
110.Fn SSL_is_dtls
111returns 1 if the connection uses DTLS, 0 if not.
100.Sh SEE ALSO 112.Sh SEE ALSO
101.Xr ssl 3 113.Xr ssl 3
102.Sh HISTORY 114.Sh HISTORY
@@ -105,3 +117,7 @@ and
105.Fn SSL_version 117.Fn SSL_version
106first appeared in SSLeay 0.8.0 and have been available since 118first appeared in SSLeay 0.8.0 and have been available since
107.Ox 2.4 . 119.Ox 2.4 .
120.Pp
121.Fn SSL_is_dtls
122first appeared in OpenSSL 1.1.0 and has been available since
123.Ox 6.9 .