summaryrefslogtreecommitdiffstats
path: root/Doc/library/ssl.rst
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2015-01-07 17:14:26 (GMT)
committerBenjamin Peterson <benjamin@python.org>2015-01-07 17:14:26 (GMT)
commit4cb17812d94c57868257743dc163b4c62a1de9d7 (patch)
treee24551431a302b33124962a68d6b9742de45510c /Doc/library/ssl.rst
parente5db863c224f32103760d1c745acf9b140a40902 (diff)
downloadcpython-4cb17812d94c57868257743dc163b4c62a1de9d7.zip
cpython-4cb17812d94c57868257743dc163b4c62a1de9d7.tar.gz
cpython-4cb17812d94c57868257743dc163b4c62a1de9d7.tar.bz2
expose the client's cipher suites from the handshake (closes #23186)
Diffstat (limited to 'Doc/library/ssl.rst')
-rw-r--r--Doc/library/ssl.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index dc2932a..d77c028 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -925,6 +925,17 @@ SSL sockets also have the following additional methods and attributes:
version of the SSL protocol that defines its use, and the number of secret
bits being used. If no connection has been established, returns ``None``.
+.. method:: SSLSocket.shared_ciphers()
+
+ Return the list of ciphers shared by the client during the handshake. Each
+ entry of the returned list is a three-value tuple containing the name of the
+ cipher, the version of the SSL protocol that defines its use, and the number
+ of secret bits the cipher uses. :meth:`~SSLSocket.shared_ciphers` returns
+ ``None`` if no connection has been established or the socket is a client
+ socket.
+
+ .. versionadded:: 3.5
+
.. method:: SSLSocket.compression()
Return the compression algorithm being used as a string, or ``None``
@@ -1784,6 +1795,7 @@ provided.
- :meth:`~SSLSocket.getpeercert`
- :meth:`~SSLSocket.selected_npn_protocol`
- :meth:`~SSLSocket.cipher`
+ - :meth:`~SSLSocket.shared_ciphers`
- :meth:`~SSLSocket.compression`
- :meth:`~SSLSocket.pending`
- :meth:`~SSLSocket.do_handshake`