Update version docs
authorMatt Caswell <matt@openssl.org>
Thu, 19 Apr 2018 12:32:45 +0000 (13:32 +0100)
committerMatt Caswell <matt@openssl.org>
Fri, 27 Apr 2018 09:14:05 +0000 (10:14 +0100)
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)

doc/ssl/SSL_get_version.pod

index 9ae6f2550858a6677b9bd20a66d13e7678d5275d..f0c696c90c17e240b1a313dd451ef40e8406f1f7 100644 (file)
@@ -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