diff options
author | Antoine Pitrou <solipsis@pitrou.net> | 2014-09-04 21:00:10 +0200 |
---|---|---|
committer | Antoine Pitrou <solipsis@pitrou.net> | 2014-09-04 21:00:10 +0200 |
commit | 04e292e789ced3557b5b21d3d6ee1fe9c3678ba4 (patch) | |
tree | eb0a6470a36ddb59e4683685c0b9f361ac8ef093 /Doc | |
parent | 65debf425fafc8b2ab711e903d484bf0e189fd40 (diff) | |
download | cpython-04e292e789ced3557b5b21d3d6ee1fe9c3678ba4.tar.gz |
Issue #20421: Add a .version() method to SSL sockets exposing the actual protocol version in use.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/ssl.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index d5328c3cf3..a0dffe0444 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -910,10 +910,10 @@ SSL sockets also have the following additional methods and attributes: .. method:: SSLSocket.selected_npn_protocol() - Returns the protocol that was selected during the TLS/SSL handshake. If - :meth:`SSLContext.set_npn_protocols` was not called, or if the other party - does not support NPN, or if the handshake has not yet happened, this will - return ``None``. + Returns the higher-level protocol that was selected during the TLS/SSL + handshake. If :meth:`SSLContext.set_npn_protocols` was not called, or + if the other party does not support NPN, or if the handshake has not yet + happened, this will return ``None``. .. versionadded:: 3.3 @@ -925,6 +925,16 @@ SSL sockets also have the following additional methods and attributes: returned socket should always be used for further communication with the other side of the connection, rather than the original socket. +.. method:: SSLSocket.version() + + Return the actual SSL protocol version negotiated by the connection + as a string, or ``None`` is no secure connection is established. + As of this writing, possible return values include ``"SSLv2"``, + ``"SSLv3"``, ``"TLSv1"``, ``"TLSv1.1"`` and ``"TLSv1.2"``. + Recent OpenSSL versions may define more return values. + + .. versionadded:: 3.5 + .. attribute:: SSLSocket.context The :class:`SSLContext` object this SSL socket is tied to. If the SSL |