Merge pull request #244 from elitest/session-tls-version

Add support for querying the negotiated TLS version

1 files changed, 15 insertions, 0 deletions

diff --git a/doc/api/ssl.rst b/doc/api/ssl.rst
index 2929305..89ae6a1 100644
--- a/doc/api/ssl.rst
+++ b/doc/api/ssl.rst
@@ -598,6 +598,21 @@ Connection objects have the following methods:
     but not it returns the entire list in one go.
 
 
+.. py:method:: Connection.get_protocol_version()
+
+    Retrieve the version of the SSL or TLS protocol used by the Connection.
+    For example, it will return ``0x769`` for connections made over TLS
+    version 1.
+
+
+.. py:method:: Connection.get_protocol_version_name()
+
+    Retrieve the version of the SSL or TLS protocol used by the Connection as
+    a unicode string. For example, it will return ``TLSv1`` for connections
+    made over TLS version 1, or ``Unknown`` for connections that were not 
+    successfully established.
+
+
 .. py:method:: Connection.get_client_ca_list()
 
     Retrieve the list of preferred client certificate issuers sent by the server