diff options
Diffstat (limited to 'docs/features')
| -rw-r--r-- | docs/features/anticache.rst | 2 | ||||
| -rw-r--r-- | docs/features/clientreplay.rst | 2 | ||||
| -rw-r--r-- | docs/features/passthrough.rst | 11 | ||||
| -rw-r--r-- | docs/features/proxyauth.rst | 2 | ||||
| -rw-r--r-- | docs/features/responsestreaming.rst | 11 | ||||
| -rw-r--r-- | docs/features/reverseproxy.rst | 3 | ||||
| -rw-r--r-- | docs/features/serverreplay.rst | 2 | ||||
| -rw-r--r-- | docs/features/setheaders.rst | 2 | ||||
| -rw-r--r-- | docs/features/socksproxy.rst | 2 | ||||
| -rw-r--r-- | docs/features/sticky.rst | 2 | ||||
| -rw-r--r-- | docs/features/tcpproxy.rst | 3 | ||||
| -rw-r--r-- | docs/features/upstreamcerts.rst | 2 |
12 files changed, 25 insertions, 19 deletions
diff --git a/docs/features/anticache.rst b/docs/features/anticache.rst index 5244587a..65d22bab 100644 --- a/docs/features/anticache.rst +++ b/docs/features/anticache.rst @@ -12,4 +12,4 @@ sure you capture an HTTP exchange in its totality. It's also often used during ================== ====================== command-line :option:`--anticache` mitmproxy shortcut :kbd:`o` then :kbd:`a` -================== ======================
\ No newline at end of file +================== ====================== diff --git a/docs/features/clientreplay.rst b/docs/features/clientreplay.rst index b8ca989e..b0eb6792 100644 --- a/docs/features/clientreplay.rst +++ b/docs/features/clientreplay.rst @@ -15,4 +15,4 @@ You may want to use client-side replay in conjunction with the ================== ================= command-line :option:`-c path` mitmproxy shortcut :kbd:`c` -================== =================
\ No newline at end of file +================== ================= diff --git a/docs/features/passthrough.rst b/docs/features/passthrough.rst index 83374955..80521393 100644 --- a/docs/features/passthrough.rst +++ b/docs/features/passthrough.rst @@ -3,14 +3,17 @@ Ignore Domains ============== -There are two main reasons why you may want to exempt some traffic from mitmproxy's interception mechanism: +There are two main reasons why you may want to exempt some traffic from mitmproxy's interception +mechanism: - **Certificate pinning:** Some traffic is is protected using `Certificate Pinning`_ and 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. +- **Convenience:** You really don't care about some parts of the traffic and just want them to go + away. -If you want to peek into (SSL-protected) non-HTTP connections, check out the :ref:`tcpproxy` feature. +If you want to peek into (SSL-protected) non-HTTP connections, check out the :ref:`tcpproxy` +feature. If you want to ignore traffic from mitmproxy's processing because of large response bodies, take a look at the :ref:`responsestreaming` feature. @@ -91,4 +94,4 @@ Here are some other examples for ignore patterns: ``GET http://example.com/`` request may be followed by a ``GET http://evil.com/`` request on the same connection. If we start to ignore the connection after the first request, we would miss the relevant second one. -.. _Certificate Pinning: https://security.stackexchange.com/questions/29988/what-is-certificate-pinning
\ No newline at end of file +.. _Certificate Pinning: https://security.stackexchange.com/questions/29988/what-is-certificate-pinning diff --git a/docs/features/proxyauth.rst b/docs/features/proxyauth.rst index edc428a7..bfd32fbd 100644 --- a/docs/features/proxyauth.rst +++ b/docs/features/proxyauth.rst @@ -14,4 +14,4 @@ mode. command-line :option:`--nonanonymous`, :option:`--singleuser USER`, :option:`--htpasswd PATH` -================== =============================
\ No newline at end of file +================== ============================= diff --git a/docs/features/responsestreaming.rst b/docs/features/responsestreaming.rst index 50fd0614..af3d889a 100644 --- a/docs/features/responsestreaming.rst +++ b/docs/features/responsestreaming.rst @@ -47,9 +47,9 @@ Responses that should be tagged for streaming by setting their ``.stream`` attri Implementation Details ---------------------- -When response streaming is enabled, portions of the code which would have otherwise performed changes -on the response body will see an empty response body instead (:py:data:`netlib.http.CONTENT_MISSING`). -Any modifications will be ignored. +When response streaming is enabled, portions of the code which would have otherwise performed +changes on the response body will see an empty response body instead +(:py:data:`netlib.http.CONTENT_MISSING`). Any modifications will be ignored. Streamed responses are usually sent in chunks of 4096 bytes. If the response is sent with a ``Transfer-Encoding: chunked`` header, the response will be streamed one chunk at a time. @@ -57,7 +57,8 @@ Streamed responses are usually sent in chunks of 4096 bytes. If the response is Modifying streamed data ----------------------- -If the ``.stream`` attribute is callable, ``.stream`` will wrap the generator that yields all chunks. +If the ``.stream`` attribute is callable, ``.stream`` will wrap the generator that yields all +chunks. .. literalinclude:: ../../examples/stream_modify.py :caption: examples/stream_modify.py @@ -65,4 +66,4 @@ If the ``.stream`` attribute is callable, ``.stream`` will wrap the generator th .. seealso:: - - :ref:`passthrough`
\ No newline at end of file + - :ref:`passthrough` diff --git a/docs/features/reverseproxy.rst b/docs/features/reverseproxy.rst index 87a598ff..77e9327c 100644 --- a/docs/features/reverseproxy.rst +++ b/docs/features/reverseproxy.rst @@ -51,6 +51,7 @@ There are two ways to solve this: 1. Modify the hosts file of your OS so that "example.com" resolves to your proxy's IP. Then, access example.com directly. Make sure that your proxy can still resolve the original IP or specify an IP in mitmproxy. -2. Use mitmproxy's :ref:`setheaders` feature to rewrite the host header: ``--setheader :~q:Host:example.com``. +2. Use mitmproxy's :ref:`setheaders` feature to rewrite the host header: + ``--setheader :~q:Host:example.com``. However, keep in mind that absolute URLs within the returned document or HTTP redirects will cause the client application to bypass the proxy. diff --git a/docs/features/serverreplay.rst b/docs/features/serverreplay.rst index 3b4af4e8..261a1bd6 100644 --- a/docs/features/serverreplay.rst +++ b/docs/features/serverreplay.rst @@ -36,4 +36,4 @@ the :kbd:`o` options shortcut within :program:`mitmproxy`. ================== ================= command-line :option:`-S path` mitmproxy shortcut :kbd:`S` -================== =================
\ No newline at end of file +================== ================= diff --git a/docs/features/setheaders.rst b/docs/features/setheaders.rst index f118e6f8..cbc8b6a5 100644 --- a/docs/features/setheaders.rst +++ b/docs/features/setheaders.rst @@ -16,4 +16,4 @@ Example: Set the **Host** header to "example.com" for all requests. ================== ============================= command-line :option:`--setheader PATTERN` mitmproxy shortcut :kbd:`o` then :kbd:`H` -================== =============================
\ No newline at end of file +================== ============================= diff --git a/docs/features/socksproxy.rst b/docs/features/socksproxy.rst index fb9117f2..76d4cda9 100644 --- a/docs/features/socksproxy.rst +++ b/docs/features/socksproxy.rst @@ -7,4 +7,4 @@ In this mode, mitmproxy acts as a SOCKS5 proxy server. ================== ================= command-line :option:`--socks` -================== =================
\ No newline at end of file +================== ================= diff --git a/docs/features/sticky.rst b/docs/features/sticky.rst index e155fb9b..a79cbe8d 100644 --- a/docs/features/sticky.rst +++ b/docs/features/sticky.rst @@ -38,4 +38,4 @@ replay of HTTP Digest authentication. ================== ====================== command-line :option:`-u FILTER` mitmproxy shortcut :kbd:`o` then :kbd:`A` -================== ======================
\ No newline at end of file +================== ====================== diff --git a/docs/features/tcpproxy.rst b/docs/features/tcpproxy.rst index 53df8ed6..fd0746a2 100644 --- a/docs/features/tcpproxy.rst +++ b/docs/features/tcpproxy.rst @@ -22,7 +22,8 @@ command-line :option:`--tcp HOST` mitmproxy shortcut :kbd:`o` then :kbd:`T` ================== ====================== -For a detailed description how the hostname pattern works, please look at the :ref:`passthrough` feature. +For a detailed description how the hostname pattern works, please look at the :ref:`passthrough` +feature. .. seealso:: diff --git a/docs/features/upstreamcerts.rst b/docs/features/upstreamcerts.rst index 84cfb84e..c687aec7 100644 --- a/docs/features/upstreamcerts.rst +++ b/docs/features/upstreamcerts.rst @@ -20,4 +20,4 @@ Upstream cert sniffing is on by default, and can optionally be turned off. ================== ============================= command-line :option:`--no-upstream-cert` mitmproxy shortcut :kbd:`o` then :kbd:`U` -================== =============================
\ No newline at end of file +================== ============================= |