aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2016-06-29 00:38:11 -0700
committerMaximilian Hils <git@maximilianhils.com>2016-06-29 00:38:11 -0700
commitac860c6fc018eb493d2b9a0bca79e7d6640625ff (patch)
tree51c6943af0320a8adc7a576a6332f55c72116e8b /docs
parentb7430c0775fd14df779b6d0a27f189d3bfbd8194 (diff)
downloadmitmproxy-ac860c6fc018eb493d2b9a0bca79e7d6640625ff.tar.gz
mitmproxy-ac860c6fc018eb493d2b9a0bca79e7d6640625ff.tar.bz2
mitmproxy-ac860c6fc018eb493d2b9a0bca79e7d6640625ff.zip
improve docs, fix #1290
Diffstat (limited to 'docs')
-rw-r--r--docs/features/passthrough.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/features/passthrough.rst b/docs/features/passthrough.rst
index ea628dad..10df49ad 100644
--- a/docs/features/passthrough.rst
+++ b/docs/features/passthrough.rst
@@ -10,7 +10,8 @@ mechanism:
mitmproxy's interception leads to errors. For example, the Twitter app, Windows Update or
the Apple App Store fail to work if mitmproxy is active.
- **Convenience:** You really don't care about some parts of the traffic and just want them to go
- away.
+ away. Note that mitmproxy's "Limit" option is often the better alternative here, as it is
+ not affected by the limitations listed below.
If you want to peek into (SSL-protected) non-HTTP connections, check out the :ref:`tcpproxy`
feature.
@@ -29,12 +30,15 @@ mitmproxy shortcut :kbd:`o` then :kbd:`I`
mitmproxy allows you to specify a regex which is matched against a ``host:port`` string
(e.g. "example.com:443") to determine hosts that should be excluded.
+Limitations
+-----------
+
There are two important quirks to consider:
- **In transparent mode, the ignore pattern is matched against the IP and ClientHello SNI host.** While we usually infer the
hostname from the Host header if the ``--host`` argument is passed to mitmproxy, we do not
have access to this information before the SSL handshake. If the client uses SNI however, then we treat the SNI host as an ignore target.
-- In regular mode, explicit HTTP requests are never ignored. [#explicithttp]_ The ignore pattern is
+- **In regular mode, explicit HTTP requests are never ignored.** [#explicithttp]_ The ignore pattern is
applied on CONNECT requests, which initiate HTTPS or clear-text WebSocket connections.
Tutorial
@@ -86,6 +90,7 @@ Here are some other examples for ignore patterns:
- :ref:`tcpproxy`
- :ref:`responsestreaming`
+ - mitmproxy's "Limit" feature
.. rubric:: Footnotes