From: Matt Caswell <matt@openssl.org>
Date: Thu, 19 Apr 2018 12:32:45 +0000 (+0100)
Subject: Update version docs
X-Git-Tag: OpenSSL_1_1_0i~142
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9737a38f34b49487223625a77860e957095cae13;p=openssl

Update version docs

Make it clear that you should not attempt to get the version before the
first handshake is complete.

Fixes #2893

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/6014)
---

diff --git a/doc/ssl/SSL_get_version.pod b/doc/ssl/SSL_get_version.pod
index 23b6497d4f..3c2f825000 100644
--- a/doc/ssl/SSL_get_version.pod
+++ b/doc/ssl/SSL_get_version.pod
@@ -15,7 +15,9 @@ SSL_get_version, SSL_is_dtls - get the protocol information of a connection
 =head1 DESCRIPTION
 
 SSL_get_version() returns the name of the protocol used for the
-connection B<ssl>.
+connection B<ssl>. It should only be called after the initial handshake has been
+completed. Prior to that the results returned from this function may be
+unreliable.
 
 SSL_is_dtls() returns one if the connection is using DTLS, zero if not.
 
@@ -43,7 +45,7 @@ The connection uses the TLSv1.2 protocol.
 
 =item unknown
 
-This indicates that no version has been set (no connection established).
+This indicates an unknown protocol version.
 
 =back