diff options
| author | Matt Caswell <matt@openssl.org> | 2018-04-19 13:32:45 +0100 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2018-04-27 10:14:05 +0100 |
| commit | 85032506d6ac917130db3dfb7ecb76f4bfaa137e (patch) | |
| tree | bce6317b8e7b7200bbcc6da6ae045143558c03af /doc | |
| parent | ad2510836c8a5b03b4a63e276e370a64161cd6b8 (diff) | |
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)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ssl/SSL_get_version.pod | 6 |
1 files changed, 4 insertions, 2 deletions
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 |