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_0_2p~67
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=85032506d6ac917130db3dfb7ecb76f4bfaa137e;p=oweals%2Fopenssl.git

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/6015)
---

diff --git a/doc/ssl/SSL_get_version.pod b/doc/ssl/SSL_get_version.pod
index 9ae6f25508..f0c696c90c 100644
--- a/doc/ssl/SSL_get_version.pod
+++ b/doc/ssl/SSL_get_version.pod
@@ -13,7 +13,9 @@ SSL_get_version - get the protocol version 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.
 
 =head1 RETURN VALUES
 
@@ -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