aboutsummaryrefslogtreecommitdiffstats
path: root/docs/protocols/tcpproxy.rst
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@corte.si>2017-12-15 09:49:24 +1300
committerGitHub <noreply@github.com>2017-12-15 09:49:24 +1300
commitdfcf62ff2b5a6c53ad027ea721431450169ab3ea (patch)
tree7c7c26809906f29ba95fed0c4436c9e20e868673 /docs/protocols/tcpproxy.rst
parentd9848a8bc1b6a3ea7741c657133f09e969052e02 (diff)
parentf5fafbfcb56bbc3fb7cca7ed32dd7b3b41c39e83 (diff)
downloadmitmproxy-dfcf62ff2b5a6c53ad027ea721431450169ab3ea.tar.gz
mitmproxy-dfcf62ff2b5a6c53ad027ea721431450169ab3ea.tar.bz2
mitmproxy-dfcf62ff2b5a6c53ad027ea721431450169ab3ea.zip
Merge pull request #2545 from mitmproxy/wsproto
Replace our WebSocket stack with wsproto
Diffstat (limited to 'docs/protocols/tcpproxy.rst')
-rw-r--r--docs/protocols/tcpproxy.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/protocols/tcpproxy.rst b/docs/protocols/tcpproxy.rst
new file mode 100644
index 00000000..77248573
--- /dev/null
+++ b/docs/protocols/tcpproxy.rst
@@ -0,0 +1,31 @@
+.. _tcp_proxy:
+
+TCP Proxy / Fallback
+====================
+
+In case mitmproxy does not handle a specific protocol, you can exempt
+hostnames from processing, so that mitmproxy acts as a generic TCP forwarder.
+This feature is closely related to the :ref:`passthrough` functionality,
+but differs in two important aspects:
+
+- The raw TCP messages are printed to the event log.
+- SSL connections will be intercepted.
+
+Please note that message interception or modification are not possible yet.
+If you are not interested in the raw TCP messages, you should use the ignore domains feature.
+
+How it works
+------------
+
+================== ======================
+command-line ``--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.
+
+.. seealso::
+
+ - :ref:`passthrough`
+ - :ref:`streaming`