summaryrefslogtreecommitdiffstats
path: root/lib/libssl/man
diff options
context:
space:
mode:
authorschwarze <schwarze@openbsd.org>2019-03-18 18:31:15 +0000
committerschwarze <schwarze@openbsd.org>2019-03-18 18:31:15 +0000
commitdf6f350d85847cc5c0a27abc06351ad5151aef7e (patch)
tree77169cc9bf2650227d5c1fe3af2df8b131402470 /lib/libssl/man
parentadd a temporary addition to NAME for openrsync; ok deraadt (diff)
downloadwireguard-openbsd-df6f350d85847cc5c0a27abc06351ad5151aef7e.tar.xz
wireguard-openbsd-df6f350d85847cc5c0a27abc06351ad5151aef7e.zip
* note that the handshake must be completed first
* correct the description of "unknown" (the previous are both from OpenSSL 1.1.1, still under a free license) * add a comment saying that TLS1_get_version() and TLS1_get_client_version() are intentionally undocumented (reasons provided by jsing@)
Diffstat (limited to 'lib/libssl/man')
-rw-r--r--lib/libssl/man/SSL_get_version.319
1 files changed, 15 insertions, 4 deletions
diff --git a/lib/libssl/man/SSL_get_version.3 b/lib/libssl/man/SSL_get_version.3
index f8999d8695b..cc4297c5ba0 100644
--- a/lib/libssl/man/SSL_get_version.3
+++ b/lib/libssl/man/SSL_get_version.3
@@ -1,5 +1,6 @@
-.\" $OpenBSD: SSL_get_version.3,v 1.6 2019/01/21 12:35:33 schwarze Exp $
-.\" OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400
+.\" $OpenBSD: SSL_get_version.3,v 1.7 2019/03/18 18:31:15 schwarze Exp $
+.\" full merge up to: OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400
+.\" selective merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100
.\"
.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
.\" Copyright (c) 2001, 2005, 2014 The OpenSSL Project. All rights reserved.
@@ -48,12 +49,18 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: January 21 2019 $
+.Dd $Mdocdate: March 18 2019 $
.Dt SSL_GET_VERSION 3
.Os
.Sh NAME
.Nm SSL_get_version ,
.Nm SSL_version
+.\" The following are intentionally undocumented because
+.\" - the longer term plan is to remove them
+.\" - nothing appears to be using them in the wild
+.\" - and they have the wrong namespace prefix
+.\" Nm TLS1_get_version
+.\" Nm TLS1_get_client_version
.Nd get the protocol version of a connection
.Sh SYNOPSIS
.In openssl/ssl.h
@@ -68,6 +75,9 @@ returns the name of the protocol used for the connection
.Pp
.Fn SSL_version
returns an integer constant representing that protocol.
+.Pp
+These functions only return reliable results
+after the initial handshake has been completed.
.Sh RETURN VALUES
The following strings or integers can be returned:
.Bl -tag -width Ds
@@ -82,7 +92,8 @@ The connection uses the TLSv1.3 protocol.
.It Qo DTLSv1 Qc No or Dv DTLS1_VERSION
The connection uses the Datagram Transport Layer Security 1.0 protocol.
.It Qq unknown
-This indicates that no version has been set (no connection established).
+This indicates an unknown protocol version;
+it cannot currently happen with LibreSSL.
.El
.Sh SEE ALSO
.Xr ssl 3