summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBastiaan Bakker <bbakker@xebia.com>2020-06-11 15:13:09 +0200
committerGitHub <noreply@github.com>2020-06-11 17:13:09 +0400
commitb8733538ef3a258ee76329c3900acb9456fae98e (patch)
treee42f184f81e8ef5cfdf609797563a3a0152cd3f7 /docs
parent90cae5d12261da1da71effec099ae9817b270301 (diff)
downloadurllib3-b8733538ef3a258ee76329c3900acb9456fae98e.tar.gz
Feature/support env var sslkeylogfile (#1867)
Diffstat (limited to 'docs')
-rw-r--r--docs/advanced-usage.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/advanced-usage.rst b/docs/advanced-usage.rst
index 5bcc93ad..e36287a0 100644
--- a/docs/advanced-usage.rst
+++ b/docs/advanced-usage.rst
@@ -128,7 +128,7 @@ you're contacting.
When contacting a HTTP website through a HTTP or HTTPS proxy, the request will
be forwarded with the `absolute URI
-<https://tools.ietf.org/html/rfc7230#section-5.3.2>`_.
+<https://tools.ietf.org/html/rfc7230#section-5.3.2>`_.
When contacting a HTTPS website through a HTTP proxy, a TCP tunnel will be
established with a HTTP CONNECT. Afterward a TLS connection will be established
@@ -303,3 +303,16 @@ Here's an example using brotli encoding via the ``Accept-Encoding`` header::
>>> from urllib3 import PoolManager
>>> http = PoolManager()
>>> http.request('GET', 'https://www.google.com/', headers={'Accept-Encoding': 'br'})
+
+Decrypting captured TLS sessions with Wireshark
+-----------------------------------------------
+Python 3.8 and higher support logging of TLS pre-master secrets.
+With these secrets tools like `Wireshark <https://wireshark.org>`_ can decrypt captured
+network traffic.
+
+To enable this simply define environment variable `SSLKEYLOGFILE`:
+
+ export SSLKEYLOGFILE=/path/to/keylogfile.txt
+
+Then configure the key logfile in `Wireshark <https://wireshark.org>`_, see
+`Wireshark TLS Decryption <https://wiki.wireshark.org/TLS#TLS_Decryption>`_ for instructions.