aboutsummaryrefslogtreecommitdiffstats
path: root/docs/transparent/openbsd.rst
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2018-02-22 17:21:34 +1300
committerAldo Cortesi <aldo@nullcube.com>2018-02-22 18:07:58 +1300
commit982508d30f887b4fe8b2a855792ae1e33f378222 (patch)
tree9d749a57929a950f0e177a9bf4d6cd7d9a88c16b /docs/transparent/openbsd.rst
parent1cacefa104626e4e0df5ffb2aa8b0c6f16b615b2 (diff)
downloadmitmproxy-982508d30f887b4fe8b2a855792ae1e33f378222.tar.gz
mitmproxy-982508d30f887b4fe8b2a855792ae1e33f378222.tar.bz2
mitmproxy-982508d30f887b4fe8b2a855792ae1e33f378222.zip
All new documentation
This patch does a lot. - Ditch sphinx in favor of hugo. This gives us complete control of the layout and presentation of our docs. Henceforth, docs will be hosted on our website rather than ReadTheDocs. - Create a simple, clean doc layout and theme. - Remove large parts of the documentaion. I've ditched anything that was a) woefully out of date, b) too detailed, or c) too hard to maintain in the long term. - Huge updates to the docs themselves: completely rewrite addons documentation, add docs for core concepts like commands and options, and revise and tweak a lot of the existing docs. With this patch, we're also changing the way we publish and maintain the docs. From now on, we don't publish docs for every release. Instead, the website will contain ONE set of docs for each major release. The online docs will be updated if needed as minor releases are made. Docs are free to improve during minor releases, but anything that changes behaviour sufficiently to require a doc change warrants a new major release. This also leaves us free to progressively update and improve docs out of step with our release cadence. With this new scheme, I feel CI over the docs is less important. I've removed it for now, but won't object if someone wants to add it back in.
Diffstat (limited to 'docs/transparent/openbsd.rst')
-rw-r--r--docs/transparent/openbsd.rst53
1 files changed, 0 insertions, 53 deletions
diff --git a/docs/transparent/openbsd.rst b/docs/transparent/openbsd.rst
deleted file mode 100644
index 3d315f7c..00000000
--- a/docs/transparent/openbsd.rst
+++ /dev/null
@@ -1,53 +0,0 @@
-.. _openbsd:
-
-OpenBSD
-=======
-
- 1. :ref:`Install the mitmproxy certificate on the test device <certinstall>`
-
- 2. Enable IP forwarding:
-
- >>> sudo sysctl -w net.inet.ip.forwarding=1
-
- 3. Place the following two lines in **/etc/pf.conf**:
-
- .. code-block:: none
-
- mitm_if = "re2"
- pass in quick proto tcp from $mitm_if to port { 80, 443 } divert-to 127.0.0.1 port 8080
-
- These rules tell pf to divert all traffic from ``$mitm_if`` destined for
- port 80 or 443 to the local mitmproxy instance running on port 8080. You
- should replace ``$mitm_if`` value with the interface on which your test
- device will appear.
-
- 4. Configure pf with the rules:
-
- >>> doas pfctl -f /etc/pf.conf
-
- 5. And now enable it:
-
- >>> doas pfctl -e
-
- 6. Fire up mitmproxy. You probably want a command like this:
-
- >>> mitmproxy -T --host
-
- The ``-T`` flag turns on transparent mode, and the ``--host``
- argument tells mitmproxy to use the value of the Host header for URL display.
-
- 7. Finally, configure your test device to use the host on which mitmproxy is
- running as the default gateway.
-
-.. note::
-
- Note that the **divert-to** rules in the pf.conf given above only apply to
- inbound traffic. **This means that they will NOT redirect traffic coming
- from the box running pf itself.** We can't distinguish between an outbound
- connection from a non-mitmproxy app, and an outbound connection from
- mitmproxy itself - if you want to intercept your traffic, you should use an
- external host to run mitmproxy. Nonetheless, pf is flexible to cater for a
- range of creative possibilities, like intercepting traffic emanating from
- VMs. See the **pf.conf** man page for more.
-
-.. _pf: http://man.openbsd.org/OpenBSD-current/man5/pf.conf.5