add pyinstaller specfile

.appveyor.yml

@@ -1,29 +0,0 @@
-version: '{build}'
-shallow_clone: true
-environment:
-  matrix:
-    - PYTHON: "C:\\Python27"
-  PATH: "C:\\Python27;C:\\Python27\\Scripts;%PATH%"
-  PYINSTALLER_VERSION: "git+https://github.com/pyinstaller/pyinstaller.git"
-install:
-  - "pip install --src .. -r requirements.txt"
-  - "python -c \"from OpenSSL import SSL; print(SSL.SSLeay_version(SSL.SSLEAY_VERSION))\""
-build: off  # Not a C# project
-test_script:
-  - "py.test -n 4"
-after_test:
-  - |
-    git clone https://github.com/mitmproxy/release.git ..\release
-    pip install -e ..\release
-    python ..\release\rtool.py -p mitmproxy bdist
-  - ps: Get-ChildItem ..\release\dist\*.zip | ForEach { Push-AppveyorArtifact $_.FullName -FileName $_.Name }
-deploy:
-- provider: FTP
-  host: 46.101.230.67:2222
-  protocol: sftp
-  username: travis
-  password:
-    secure: +Ousom/XDCLx9+bUjr1mRKepgIzLdqP+clMpoAiPXUysZCDGxODD/7ij4z8GJ3AF
-  folder: snapshots
-  on:
-    branch: master

.coveragerc

@@ -1,11 +1,6 @@
-[run]
+[rum]
 branch = True
 
 [report]
-show_missing = True
+omit = *contrib*, *tnetstring*, *platform*, *console*
 include = *libmproxy*
-exclude_lines =
-    pragma: nocover
-    pragma: no cover
-    raise NotImplementedError()
-omit = *contrib*, *tnetstring*, *platform*, *console*, *main.py

.dockerignore

@@ -1 +0,0 @@
-.git

.env

@@ -1,6 +0,0 @@
-DIR="$( dirname "${BASH_SOURCE[0]}" )"
-ACTIVATE_DIR="$(if [ -f "$DIR/../venv.mitmproxy/bin/activate" ]; then echo 'bin'; else echo 'Scripts'; fi;)"
-if [ -z "$VIRTUAL_ENV" ] && [ -f "$DIR/../venv.mitmproxy/$ACTIVATE_DIR/activate" ]; then
-    echo "Activating mitmproxy virtualenv..."
-    source "$DIR/../venv.mitmproxy/$ACTIVATE_DIR/activate"
-fi

.gitattributes

@@ -1,2 +0,0 @@
-libmproxy/web/static/**/* -diff
-web/src/js/filt/filt.js -diff

.gitignore

@@ -1,28 +1,15 @@
-.DS_Store
 MANIFEST
 /build
 /dist
 /tmp
 /doc
 /venv
-/libmproxy/gui
-/release/build
 *.py[cdo]
 *.swp
 *.swo
-mitmproxy.egg-info/
 mitmproxyc
 mitmdumpc
 .coverage
 .idea
 netlib
-pathod
 libpathod
-.cache/
-
-# UI
-
-node_modules
-bower_components
-*.compiled.js
-*.map

.gitmodules

@@ -0,0 +1,21 @@
+[submodule "libmproxy/gui/dgrid"]
+	path = libmproxy/gui/dgrid
+	url = https://github.com/mhils/dgrid.git
+[submodule "libmproxy/gui/dojo"]
+	path = libmproxy/gui/dojo
+	url = https://github.com/dojo/dojo.git
+[submodule "libmproxy/gui/dijit"]
+	path = libmproxy/gui/dijit
+	url = https://github.com/dojo/dijit.git
+[submodule "libmproxy/gui/dojox"]
+	path = libmproxy/gui/dojox
+	url = https://github.com/dojo/dojox.git
+[submodule "libmproxy/gui/put-selector"]
+	path = libmproxy/gui/put-selector
+	url = https://github.com/kriszyp/put-selector
+[submodule "libmproxy/gui/xstyle"]
+	path = libmproxy/gui/xstyle
+	url = https://github.com/kriszyp/xstyle.git
+[submodule "libmproxy/gui/util"]
+	path = libmproxy/gui/util
+	url = https://github.com/dojo/util.git

.landscape.yml

@@ -1,16 +0,0 @@
-max-line-length: 120
-pylint:
-  options:
-    dummy-variables-rgx: _$|.+_$|dummy_.+
-
-  disable:
-    - missing-docstring
-    - protected-access
-    - too-few-public-methods
-    - too-many-arguments
-    - too-many-instance-attributes
-    - too-many-locals
-    - too-many-public-methods
-    - too-many-return-statements
-    - too-many-statements
-    - unpacking-non-sequence

.travis.yml

@@ -1,95 +1,15 @@
-sudo: false
 language: python
-
-matrix:
-  fast_finish: true
-  include:
-    - python: 2.7
-    - language: generic
-      os: osx
-      osx_image: xcode7.1
-    - python: 2.7
-      env: OPENSSL=1.0.2
-      addons:
-        apt:
-          sources:
-            # Debian sid currently holds OpenSSL 1.0.2
-            # change this with future releases!
-            - debian-sid
-          packages:
-            - libssl-dev
-    - python: 2.7
-      env: DOCS=1
-      script: 'cd docs && make html'
-    - python: pypy
-    - python: pypy
-      env: OPENSSL=1.0.2
-      addons:
-        apt:
-          sources:
-            # Debian sid currently holds OpenSSL 1.0.2
-            # change this with future releases!
-            - debian-sid
-          packages:
-            - libssl-dev
-  allow_failures:
-    # We allow pypy to fail until Travis fixes their infrastructure to a pypy
-    # with a recent enought CFFI library to run cryptography 1.0+.
-    - python: pypy
-
-install:
-  - |
-    if [[ $TRAVIS_OS_NAME == "osx" ]]
-    then
-      brew update || brew update # try again if it fails
-      brew outdated openssl || brew upgrade openssl
-      brew install python
-    fi
-  - "pip install --src .. -r requirements.txt"
-
-before_script:
-  - "openssl version -a"
-
-script:
-  - "py.test -n 4 --cov libmproxy"
-
-after_success:
-  - coveralls
-  - |
-    if [[ $TRAVIS_OS_NAME == "osx" && $TRAVIS_BRANCH == "master" && $TRAVIS_PULL_REQUEST == "false" ]]
-    then
-        brew install curl --with-libssh2
-        git clone https://github.com/mitmproxy/release.git ../release
-        pip install -e ../release
-        python ../release/rtool.py -p mitmproxy bdist
-        for f in ../release/dist/*
-        do
-          $(brew --prefix curl)/bin/curl -u $SNAPSHOT_AUTH --hostpubmd5 $SNAPSHOT_PUBKEY --retry 5 -T $f sftp://$SNAPSHOT_HOST/
-        done
-    fi
-
-notifications:
-  irc:
-    channels:
-      - "irc.oftc.net#mitmproxy"
-    on_success: change
-    on_failure: always
-  slack:
-    rooms:
-      - mitmproxy:YaDGC9Gt9TEM7o8zkC2OLNsu
-    on_success: change
-    on_failure: always
-
-# exclude cryptography from cache
-# it depends on libssl-dev version
-# which needs to be compiled specifically to each version
-before_cache:
-  - pip uninstall -y cryptography
-
-cache:
-  directories:
-    - $HOME/.cache/pip
-    - /home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages
-    - /home/travis/virtualenv/python2.7.9/bin
-    - /home/travis/virtualenv/pypy-2.5.0/site-packages
-    - /home/travis/virtualenv/pypy-2.5.0/bin
+python:
+  - "2.7"
+# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
+install: 
+  - "pip install coveralls --use-mirrors"
+  - "pip install nose-cov --use-mirrors"
+  - "pip install -r requirements.txt --use-mirrors"
+  - "pip install --upgrade git+https://github.com/mitmproxy/netlib.git"
+  - "pip install --upgrade git+https://github.com/mitmproxy/pathod.git"
+# command to run tests, e.g. python setup.py test
+script: 
+  - "nosetests --with-cov --cov-report term-missing"
+after_success: 
+  - coveralls

CHANGELOG

@@ -1,216 +1,7 @@
-6 November 2015: mitmproxy 0.14
-
-    * Statistics: 399 commits, 13 contributors, 79 closed issues, 37 closed
-      PRs, 103 days
-
-    * Docs: Greatly updated docs now hosted on ReadTheDocs!
-      http://docs.mitmproxy.org
-
-    * Docs: Fixed Typos, updated URLs etc. (Nick Badger, Ben Lerner, Choongwoo
-      Han, onlywade, Jurriaan Bremer)
-
-    * mitmdump: Colorized TTY output
-
-    * mitmdump: Use mitmproxy's content views for human-readable output (Chris
-      Czub)
-
-    * mitmproxy and mitmdump: Support for displaying UTF8 contents
-
-    * mitmproxy: add command line switch to disable mouse interaction (Timothy
-      Elliott)
-
-    * mitmproxy: bug fixes (Choongwoo Han, sethp-jive, FreeArtMan)
-
-    * mitmweb: bug fixes (Colin Bendell)
-
-    * libmproxy: Add ability to fall back to TCP passthrough for non-HTTP
-      connections.
-
-    * libmproxy: Avoid double-connect in case of TLS Server Name Indication.
-      This yields a massive speedup for TLS handshakes.
-
-    * libmproxy: Prevent unneccessary upstream connections (macmantrl)
-
-    * Inline Scripts: New API for HTTP Headers:
-      http://docs.mitmproxy.org/en/latest/dev/models.html#netlib.http.Headers
-
-    * Inline Scripts: Properly handle exceptions in `done` hook
-
-    * Inline Scripts: Allow relative imports, provide `__file__`
-
-    * Examples: Add probabilistic TLS passthrough as an inline script
-
-    * netlib: Refactored HTTP protocol handling code
-
-    * netlib: ALPN support
-
-    * netlib: fixed a bug in the optional certificate verification.
-
-    * netlib: Initial Python 3.5 support (this is the first prerequisite for
-      3.x support in mitmproxy)
-
-
-24 July 2015: mitmproxy 0.13
-
-    * Upstream certificate validation. See the --verify-upstream-cert,
-      --upstream-trusted-cadir and --upstream-trusted-ca parameters. Thanks to
-      Kyle Morton (github.com/kyle-m) for his work on this.
-
-    * Add HTTP transparent proxy mode. This uses the host headers from HTTP
-      traffic (rather than SNI and IP address information from the OS) to
-      implement perform transparent proxying. Thanks to github.com/ijiro123 for
-      this feature.
-
-    * Add ~src and ~dst REGEX filters, allowing matching on source and
-      destination addresses in the form of <IP>:<Port>
-
-    * mitmproxy console: change g/G keyboard shortcuts to match less. Thanks to
-      Jose Luis Honorato (github.com/jlhonora).
-
-    * mitmproxy console: Flow marking and unmarking. Marked flows are not
-      deleted when the flow list is cleared. Thanks to Jake Drahos
-      (github.com/drahosj).
-
-    * mitmproxy console: add marking of flows
-
-    * Remove the certforward feature. It was added to allow exploitation of
-      #gotofail, which is no longer a common vulnerability. Permitting this
-      hugely increased the complexity of packaging and distributing mitmproxy.
-
-
-
-
-3 June 2015: mitmproxy 0.12.1
-
-    * mitmproxy console: mouse interaction - scroll in the flow list, click on
-      flow to view, click to switch between tabs.
-
-    * Update our crypto defaults: SHA256, 2048 bit RSA, 4096 bit DH parameters.
-
-    * BUGFIX: crash under some circumstances when copying to clipboard.
-
-    * BUGFIX: occasional crash when deleting flows.
-
-
-18 May 2015: mitmproxy 0.12
-
-    * mitmproxy console: Significant revamp of the UI. The major changes are
-      listed below, and in addition almost every aspect of the UI has
-      been tweaked, and performance has improved significantly.
-
-    * mitmproxy console: A new options screen has been created ("o" shortcut),
-      and many options that were previously manipulated directly via a
-      keybinding have been moved there.
-
-    * mitmproxy console: Big improvement in palettes. This includes improvements
-      to all colour schemes. Palettes now set the terminal background colour by
-      default, and a new --palette-transparent option has been added to disable
-      this.
-
-    * mitmproxy console: g/G shortcuts throughout mitmproxy console to jump
-      to the beginning/end of the current view.
-
-    * mitmproxy console: switch  palettes on the fly from the options screen.
-
-    * mitmproxy console: A cookie editor has been added for mitmproxy console
-      at long last.
-
-    * mitmproxy console: Various components of requests and responses can be
-      copied to the clipboard from mitmproxy - thanks to @marceloglezer.
-
-    * Support for creating new requests from scratch in mitmproxy console (@marceloglezer).
-
-    * SSLKEYLOGFILE environment variable to specify a logging location for TLS
-      master keys. This can be used with tools like Wireshark to allow TLS
-      decoding.
-
-    * Server facing SSL cipher suite specification (thanks to Jim Shaver).
-
-    * Official support for transparent proxying on FreeBSD - thanks to Mike C
-      (http://github.com/mike-pt).
-
-    * Many other small bugfixes and improvemenets throughout the project.
-
-
-29 Dec 2014: mitmproxy 0.11.2:
-
-    * Configuration files - mitmproxy.conf, mitmdump.conf, common.conf in the
-      .mitmproxy directory.
-    * Better handling of servers that reject connections that are not SNI.
-    * Many other small bugfixes and improvements.
-
-
-15 November 2014: mitmproxy 0.11.1:
-
-    * Bug fixes: connection leaks some crashes
-
-
-7 November 2014: mitmproxy 0.11:
-
-    * Performance improvements for mitmproxy console
-
-    * SOCKS5 proxy mode allows mitmproxy to act as a SOCKS5 proxy server
-
-    * Data streaming for response bodies exceeding a threshold
-      (bradpeabody@gmail.com)
-
-    * Ignore hosts or IP addresses, forwarding both HTTP and HTTPS traffic
-      untouched
-
-    * Finer-grained control of traffic replay, including options to ignore
-      contents or parameters when matching flows (marcelo.glezer@gmail.com)
-
-    * Pass arguments to inline scripts
-
-    * Configurable size limit on HTTP request and response bodies
-
-    * Per-domain specification of interception certificates and keys (see
-      --cert option)
-
-    * Certificate forwarding, relaying upstream SSL certificates verbatim (see
-      --cert-forward)
-
-    * Search and highlighting for HTTP request and response bodies in
-      mitmproxy console (pedro@worcel.com)
-
-    * Transparent proxy support on Windows
-
-    * Improved error messages and logging
-
-    * Support for FreeBSD in transparent mode, using pf (zbrdge@gmail.com)
-
-    * Content view mode for WBXML (davidshaw835@air-watch.com)
-
-    * Better documentation, with a new section on proxy modes
-
-    * Generic TCP proxy mode
-
-    * Countless bugfixes and other small improvements
-
-
-
-28 January 2014: mitmproxy 0.10:
-
-    * Support for multiple scripts and multiple script arguments
-
-    * Easy certificate install through the in-proxy web app, which is now
-      enabled by default
-
-    * Forward proxy mode, that forwards proxy requests to an upstream HTTP server
-
-    * Reverse proxy now works with SSL
-
-    * Search within a request/response using the "/" and "n" shortcut keys
-
-    * A view that beatifies CSS files if cssutils is available
-
-    * Bug fix, documentation improvements, and more.
-
-
 25 August 2013: mitmproxy 0.9.2:
 
     * Improvements to the mitmproxywrapper.py helper script for OSX.
-
+    
     * Don't take minor version into account when checking for serialized file
       compatibility.
 
@@ -224,38 +15,38 @@
       valid IDNA-encoded names.
 
     * Display transfer rates for responses in the flow list.
-
+    
     * Many other small bugfixes and improvements.
-
+    
 
 
 
 16 June 2013: mitmproxy 0.9.1:
 
     * Use "correct" case for Content-Type headers added by mitmproxy.
-
-    * Make UTF environment detection more robust.
+    
+    * Make UTF environment detection more robust. 
 
     * Improved MIME-type detection for viewers.
-
+    
     * Always read files in binary mode (Windows compatibility fix).
-
+    
     * Some developer documentation.
-
+    
 
 15 May 2013: mitmproxy 0.9:
 
     * Upstream certs mode is now the default.
 
     * Add a WSGI container that lets you host in-proxy web applications.
-
+    
     * Full transparent proxy support for Linux and OSX.
-
+    
     * Introduce netlib, a common codebase for mitmproxy and pathod
       (http://github.com/cortesi/netlib).
 
     * Full support for SNI.
-
+    
     * Color palettes for mitmproxy, tailored for light and dark terminal
       backgrounds.
 
@@ -266,12 +57,12 @@
       match asset flows (js, images, css).
 
     * Follow mode in mitmproxy ("F" shortcut) to "tail" flows as they arrive.
-
+    
     * --dummy-certs option to specify and preserve the dummy certificate
       directory.
 
     * Server replay from the current captured buffer.
-
+    
     * Huge improvements in content views. We now have viewers for AMF, HTML,
       JSON, Javascript, images, XML, URL-encoded forms, as well as hexadecimal
       and raw views.
@@ -280,7 +71,7 @@
       on flows, based on a matching pattern.
 
     * A graphical editor for path components in mitmproxy.
-
+    
     * A small set of standard user-agent strings, which can be used easily in
       the header editor.
 

CONTRIBUTING.md

@@ -1,39 +0,0 @@
-# Contributing
-
-Thank you for your interest in contributing to mitmproxy!
-
-# Bug Reports
-
-Bug Reports are very welcome - please file them on the GitHub [issue tracker](https://github.com/mitmproxy/mitmproxy/issues). 
-You can use the following template to structure your report:
-
-```
-##### Steps to reproduce the problem:
-1.
-2.
-3.
-
-##### What is the expected behavior?
-
-
-##### What went wrong?
-
-
-##### Any other comments?
-
-
----
-mitmproxy version:
-Operating System:
-```
-
-# Feature Requests
-
-We're happy to hear what you'd like to see in mitmproxy. Please file feature requests on the GitHub [issue tracker](https://github.com/mitmproxy/mitmproxy/issues). 
-
-# Patches
-
-We're always happy to accept patches. Please submit them in the form of pull requests to the main [mitmproxy repository](https://github.com/mitmproxy/mitmproxy/).  
-If you're working on something cool, please do not hesistate and get in touch!
-
-Instructions for setting up a development environment can be found in the [README](README.rst).  

CONTRIBUTORS

@@ -1,107 +1,42 @@
-  1124	Aldo Cortesi
-   810	Maximilian Hils
-    80	Marcelo Glezer
-    48	Thomas Kriechbaumer
-    28	Jim Shaver
+   801	Aldo Cortesi
     18	Henrik Nordstrom
     13	Thomas Roth
-    12	Pedro Worcel
-    11	Jake Drahos
-    11	Justus Wingert
+    13	Maximilian Hils
     11	Stephen Altamirano
     10	András Veres-Szentkirályi
-     9	Chris Czub
-     9	Legend Tang
      8	Jason A. Novak
      8	Rouli
      7	Alexis Hildebrandt
-     5	Brad Peabody
-     5	Choongwoo Han
-     5	Matthias Urlichs
-     5	Tomaz Muraus
-     5	elitest
-     5	iroiro123
-     4	Bryan Bishop
      4	Marc Liyanage
-     4	Matthew Shao
      4	Valtteri Virtanen
-     4	Wade 524
-     4	Youhei Sakurai
-     4	root
+     4	Bryan Bishop
      3	Chris Neasbitt
-     3	David Weinstein
-     3	Eli Shvartsman
      3	Kyle Manna
-     3	Zack B
-     2	Bennett Blodinger
-     2	Colin Bendell
-     2	Heikki Hannikainen
-     2	Jaime Soriano Pastor
      2	Jim Lloyd
-     2	Krzysztof Bielicki
-     2	Mark E. Haase
+     2	Matthias Urlichs
      2	Michael Frister
-     2	Nick Badger
-     2	Rob Wills
-     2	Terry Long
-     2	Wade Catron
      2	alts
-     2	isra17
+     2	Rob Wills
      2	israel
-     1	Andy Smith
-     1	Ben Lerner
-     1	Dan Wilbraham
-     1	David Dworken
-     1	David Shaw
-     1	Doug Lethin
-     1	Eric Entzel
-     1	Felix Wolfsteller
-     1	FreeArtMan
-     1	Gabriel Kirkpatrick
-     1	Henrik Nordström
-     1	Ivaylo Popov
-     1	JC
-     1	Jakub Nawalaniec
-     1	James Billingham
-     1	Jean Regisser
-     1	Kit Randel
-     1	Kyle Morton
-     1	Lucas Cimon
-     1	Mathieu Mitchell
-     1	Michael Bisbjerg
-     1	Mike C
-     1	Mikhail Korobov
-     1	Nick HS
-     1	Nick Raptis
-     1	Nicolas Esteves
+     2	Mark E. Haase
+     2	Heikki Hannikainen
      1	Oleksandr Sheremet
      1	Paul
-     1	Rich Somerfield
      1	Rory McCann
      1	Rune Halvorsen
-     1	Ryo Onodera
      1	Sahn Lam
-     1	Seppo Yli-Olli
-     1	Sergey Chipiga
-     1	Steve Phillips
-     1	Steven Van Acker
-     1	Suyash
-     1	Tarashish Mishra
-     1	TearsDontFalls
-     1	Timothy Elliott
+     1	Felix Wolfsteller
+     1	Eric Entzel
      1	Ulrich Petri
-     1	Vyacheslav Bakhmutov
+     1	Andy Smith
      1	Yuangxuan Wang
      1	capt8bit
-     1	davidpshaw
-     1	deployable
-     1	gecko655
-     1	jlhonora
-     1	joebowbeer
      1	meeee
-     1	michaeljau
-     1	peralta
+     1	Jakub Nawalaniec
+     1	Kit Randel
      1	phil plante
-     1	sentient07
-     1	sethp-jive
-     1	vzvu3k6k
+     1	Ivaylo Popov
+     1	Mathieu Mitchell
+     1	Henrik Nordström
+     1	Michael Bisbjerg
+     1	Nicolas Esteves

Dockerfile

@@ -1,4 +0,0 @@
-FROM mitmproxy/base:latest-onbuild
-EXPOSE 8080
-EXPOSE 8081
-VOLUME /certs

MANIFEST.in

@@ -1,7 +1,11 @@
-include mitmproxy mitmdump mitmweb
-include LICENSE CHANGELOG CONTRIBUTORS CONTRIBUTING.md README.rst
-graft examples
-graft test
-prune test/tools
-graft libmproxy
-recursive-exclude * *.pyc *.pyo *.swo *.swp
+include LICENSE
+include CHANGELOG
+include CONTRIBUTORS
+include README.txt
+include setup.py
+exclude README.mkd
+recursive-include examples *
+recursive-include doc *
+recursive-include test *
+recursive-include libmproxy/resources *
+recursive-exclude test *.swo *.swp *.pyc

README.mkd

@@ -0,0 +1,64 @@
+[![Build Status](https://travis-ci.org/mitmproxy/mitmproxy.png)](https://travis-ci.org/mitmproxy/mitmproxy) [![Coverage Status](https://coveralls.io/repos/mitmproxy/mitmproxy/badge.png)](https://coveralls.io/r/mitmproxy/mitmproxy)
+
+__mitmproxy__ is an interactive, SSL-capable man-in-the-middle proxy for HTTP
+with a console interface.
+
+__mitmdump__ is the command-line version of mitmproxy. Think tcpdump for HTTP.
+
+__libmproxy__ is the library that mitmproxy and mitmdump are built on.
+
+Documentation, tutorials and distribution packages can be found on the
+mitmproxy.org website:
+
+[mitmproxy.org](http://mitmproxy.org).
+
+
+Features
+--------
+
+- Intercept HTTP requests and responses and modify them on the fly.
+- Save complete HTTP conversations for later replay and analysis.
+- Replay the client-side of an HTTP conversations.
+- Replay HTTP responses of a previously recorded server.
+- Reverse proxy mode to forward traffic to a specified server.
+- Transparent proxy mode on OSX and Linux.
+- Make scripted changes to HTTP traffic using Python.
+- SSL certificates for interception are generated on the fly.
+- And much, much more.
+
+
+Requirements
+------------
+
+* [Python](http://www.python.org) 2.7.x.
+* [netlib](http://pypi.python.org/pypi/netlib), version matching mitmproxy.
+* [PyOpenSSL](http://pypi.python.org/pypi/pyOpenSSL) 0.13 or newer.
+* [pyasn1](http://pypi.python.org/pypi/pyasn1) 0.1.2 or newer.
+* [urwid](http://excess.org/urwid/) version 1.1 or newer.
+* [PIL](http://www.pythonware.com/products/pil/) version 1.1 or newer.
+* [lxml](http://lxml.de/) version 2.3 or newer.
+* [flask](http://flask.pocoo.org/) version 0.9 or newer.
+
+Optional, for extended content decoding:
+
+* [PyAMF](http://www.pyamf.org/) version 0.6.1 or newer.
+* [protobuf](https://code.google.com/p/protobuf/) version 2.5.0 or newer.
+
+__mitmproxy__ is tested and developed on OSX, Linux and OpenBSD. Windows is not
+officially supported at the moment.
+
+
+Hacking
+-------
+
+The following components are needed if you plan to hack on mitmproxy:
+
+* The test suite uses the [nose](http://readthedocs.org/docs/nose/en/latest/) unit testing
+  framework and requires [pathod](http://pathod.org) and [flask](http://flask.pocoo.org/).
+* Rendering the documentation requires [countershape](http://github.com/cortesi/countershape).
+
+For convenience, all dependencies save countershape, can be installed from pypi to a virtualenv with 'pip install -r requirements.txt'.
+
+Please ensure that all patches are accompanied by matching changes in the test
+suite. The project maintains 100% test coverage.
+

README.rst

@@ -1,157 +0,0 @@
-|travis| |coveralls| |downloads| |latest-release| |python-versions|
-
-``mitmproxy`` is an interactive, SSL-capable man-in-the-middle proxy for HTTP
-with a console interface.
-
-``mitmdump`` is the command-line version of mitmproxy. Think tcpdump for HTTP.
-
-``libmproxy`` is the library that mitmproxy and mitmdump are built on.
-
-Documentation & Help
---------------------
-
-Documentation, tutorials and distribution packages can be found on the
-mitmproxy website.
-
-|site|
-
-Installation Instructions are available in the docs.
-
-|docs|
-
-You can join our developer chat on Slack.
-
-|slack|
-
-Features
---------
-
-- Intercept HTTP requests and responses and modify them on the fly.
-- Save complete HTTP conversations for later replay and analysis.
-- Replay the client-side of an HTTP conversations.
-- Replay HTTP responses of a previously recorded server.
-- Reverse proxy mode to forward traffic to a specified server.
-- Transparent proxy mode on OSX and Linux.
-- Make scripted changes to HTTP traffic using Python.
-- SSL certificates for interception are generated on the fly.
-- And much, much more.
-
-``mitmproxy`` is tested and developed on OSX, Linux and OpenBSD.
-On Windows, only mitmdump is supported, which does not have a graphical user interface.
-
-
-
-Hacking
--------
-
-To get started hacking on mitmproxy, make sure you have Python_ 2.7.x. with
-virtualenv_ installed (you can find installation instructions for virtualenv here_).
-Then do the following:
-
-.. code-block:: text
-
-    git clone https://github.com/mitmproxy/mitmproxy.git
-    git clone https://github.com/mitmproxy/netlib.git
-    git clone https://github.com/mitmproxy/pathod.git
-    cd mitmproxy
-    ./dev
-
-
-The *dev* script will create a virtualenv environment in a directory called
-"venv.mitmproxy", and install all of mitmproxy's development requirements, plus
-all optional modules. The primary mitmproxy components - mitmproxy, netlib and
-pathod - are all installed "editable", so any changes to the source in the git
-checkouts will be reflected live in the virtualenv.
-
-To confirm that you're up and running, activate the virtualenv, and run the
-mitmproxy test suite:
-
-.. code-block:: text
-
-    . ../venv.mitmproxy/bin/activate # ..\venv.mitmproxy\Scripts\activate.bat on Windows
-    py.test -n 4 --cov libmproxy
-
-Note that the main executables for the project - ``mitmdump``, ``mitmproxy`` and
-``mitmweb`` - are all created within the virtualenv. After activating the
-virtualenv, they will be on your $PATH, and you can run them like any other
-command:
-
-.. code-block:: text
-
-    mitmdump --version
-
-For convenience, the project includes an autoenv_ file (`.env`_) that
-auto-activates the virtualenv when you cd into the mitmproxy directory.
-
-
-Testing
--------
-
-If you've followed the procedure above, you already have all the development
-requirements installed, and you can simply run the test suite:
-
-.. code-block:: text
-
-    py.test -n 4 --cov libmproxy
-
-Please ensure that all patches are accompanied by matching changes in the test
-suite. The project maintains 100% test coverage.
-
-
-Docs
-----
-
-The mitmproxy documentation is build using Sphinx_, which is installed automatically if you set up a development
-environment as described above.
-After installation, you can render the documentation like this:
-
-.. code-block:: text
-
-    cd docs
-    make clean
-    make html
-    make livehtml
-
-The last command invokes `sphinx-autobuild`_, which watches the Sphinx directory and rebuilds
-the documentation when a change is detected.
-
-
-.. |site| image:: https://img.shields.io/badge/https%3A%2F%2F-mitmproxy.org-blue.svg
-    :target: https://mitmproxy.org/
-    :alt: mitmproxy.org
-
-.. |docs| image:: https://readthedocs.org/projects/mitmproxy/badge/
-    :target: http://docs.mitmproxy.org/en/latest/
-    :alt: Documentation
-
-.. |slack| image:: http://slack.mitmproxy.org/badge.svg
-    :target: http://slack.mitmproxy.org/
-    :alt: Slack Developer Chat
-
-.. |travis| image:: https://img.shields.io/travis/mitmproxy/mitmproxy/master.svg
-    :target: https://travis-ci.org/mitmproxy/mitmproxy
-    :alt: Build Status
-
-.. |coveralls| image:: https://img.shields.io/coveralls/mitmproxy/mitmproxy/master.svg
-    :target: https://coveralls.io/r/mitmproxy/mitmproxy
-    :alt: Coverage Status
-
-.. |downloads| image:: https://img.shields.io/pypi/dm/mitmproxy.svg?color=orange
-    :target: https://pypi.python.org/pypi/mitmproxy
-    :alt: Downloads
-
-.. |latest-release| image:: https://img.shields.io/pypi/v/mitmproxy.svg
-    :target: https://pypi.python.org/pypi/mitmproxy
-    :alt: Latest Version
-
-.. |python-versions| image:: https://img.shields.io/pypi/pyversions/mitmproxy.svg
-    :target: https://pypi.python.org/pypi/mitmproxy
-    :alt: Supported Python versions
-
-.. _Python: https://www.python.org/
-.. _virtualenv: https://virtualenv.pypa.io/en/latest/
-.. _here: https://virtualenv.pypa.io/en/latest/installation.html
-.. _autoenv: https://github.com/kennethreitz/autoenv
-.. _.env: https://github.com/mitmproxy/mitmproxy/blob/master/.env
-.. _Sphinx: http://sphinx-doc.org/
-.. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild

README.txt

@@ -0,0 +1,11 @@
+**mitmproxy** is an interactive, SSL-capable man-in-the-middle proxy for HTTP
+with a console interface.
+
+**mitmdump** is the command-line version of mitmproxy. Think tcpdump for HTTP.
+
+**libmproxy** is the library that mitmproxy and mitmdump are built on.
+
+Complete documentation and a set of practical tutorials is included in the
+distribution package, and is also available at mitmproxy.org_.
+
+.. _mitmproxy.org: http://mitmproxy.org

dev

@@ -1,12 +0,0 @@
-#!/bin/bash
-set -e
-VENV=../venv.mitmproxy
-
-python -m virtualenv $VENV --always-copy
-. $VENV/bin/activate
-pip install --src .. -r requirements.txt
-
-echo ""
-echo "* Created virtualenv environment in $VENV."
-echo "* Installed all dependencies into the virtualenv."
-echo "* You can now activate the virtualenv: \`. $VENV/bin/activate\`"

dev.bat

@@ -1,14 +0,0 @@
-@echo off
-set VENV=..\venv.mitmproxy
-
-virtualenv %VENV% --always-copy
-if %errorlevel% neq 0 exit /b %errorlevel%
-call %VENV%\Scripts\activate.bat
-if %errorlevel% neq 0 exit /b %errorlevel%
-pip install --src .. -r requirements.txt
-if %errorlevel% neq 0 exit /b %errorlevel%
-
-echo.
-echo * Created virtualenv environment in %VENV%.
-echo * Installed all dependencies into the virtualenv.
-echo * Activated virtualenv environment.

doc-src/02-docstyle.css

@@ -0,0 +1,12 @@
+body {
+    padding-top: 60px;
+    padding-bottom: 40px;
+}
+
+.tablenum {
+    font-weight: bold;
+} 
+
+.nowrap {
+     white-space: nowrap;
+}

doc-src/_layout.html

@@ -0,0 +1,82 @@
+<div class="navbar navbar-fixed-top">
+  <div class="navbar-inner">
+    <div class="container">
+      <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </a>
+      <a class="brand" href="@!urlTo(idxpath)!@">mitmproxy 0.9 docs</a>
+      </div><!--/.nav-collapse -->
+    </div>
+  </div>
+</div>
+
+<div class="container">
+  <div class="row">
+    <div class="span3">
+      <div class="well sidebar-nav">
+        <ul class="nav nav-list">
+            $!nav(idxpath, this, state)!$
+            $!nav("install.html", this, state)!$
+            $!nav("howmitmproxy.html", this, state)!$
+
+            <li class="nav-header">Tools</li>
+                $!nav("mitmproxy.html", this, state)!$
+                $!nav("mitmdump.html", this, state)!$
+
+            <li class="nav-header">Features</li>
+                $!nav("anticache.html", this, state)!$
+                $!nav("clientreplay.html", this, state)!$
+                $!nav("filters.html", this, state)!$
+                $!nav("proxyauth.html", this, state)!$
+                $!nav("replacements.html", this, state)!$
+                $!nav("serverreplay.html", this, state)!$
+                $!nav("setheaders.html", this, state)!$
+                $!nav("sticky.html", this, state)!$
+                $!nav("reverseproxy.html", this, state)!$
+                $!nav("upstreamcerts.html", this, state)!$
+
+            <li class="nav-header">Installing Certificates</li>
+                $!nav("ssl.html", this, state)!$
+                $!nav("certinstall/firefox.html", this, state)!$
+                $!nav("certinstall/osx.html", this, state)!$
+                $!nav("certinstall/windows7.html", this, state)!$
+                $!nav("certinstall/ios.html", this, state)!$
+                $!nav("certinstall/ios-simulator.html", this, state)!$
+                $!nav("certinstall/android.html", this, state)!$
+
+            <li class="nav-header">Transparent Proxying</li>
+                $!nav("transparent.html", this, state)!$
+                $!nav("transparent/linux.html", this, state)!$
+                $!nav("transparent/osx.html", this, state)!$
+
+             <li class="nav-header">Tutorials</li>
+                $!nav("tutorials/30second.html", this, state)!$
+                $!nav("tutorials/gamecenter.html", this, state)!$
+
+            <li class="nav-header">Scripting mitmproxy</li>
+                $!nav("scripting/inlinescripts.html", this, state)!$
+                $!nav("scripting/libmproxy.html", this, state)!$
+
+            <li class="nav-header">Hacking</li>
+                $!nav("dev/testing.html", this, state)!$
+
+        </ul>
+      </div>
+    </div>
+
+    <div class="span9">
+        <div class="page-header">
+        <h1>@!this.title!@</h1>
+        </div>
+        $!body!$
+    </div>
+  </div>
+
+  <hr>
+
+  <footer>
+    <p>@!copyright!@</p>
+  </footer>
+</div>

doc-src/_websitelayout.html

@@ -0,0 +1,86 @@
+<div class="navbar navbar-fixed-top">
+  <div class="navbar-inner">
+    <div class="container">
+      <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </a>
+      <a class="brand" href="@!urlTo("/index.html")!@">mitmproxy</a>
+      <div class="nav">
+        <ul class="nav">
+          <li $!'class="active"' if this.match("/index.html", True) else ""!$> <a href="@!top!@/index.html">home</a> </li>
+          <li $!'class="active"' if this.under("/doc") else ""!$><a href="@!top!@/doc/index.html">docs</a></li>
+          <li $!'class="active"' if this.under("/about.html") else ""!$><a href="@!top!@/about.html">about</a></li>
+        </ul>
+      </div>
+    </div>
+  </div>
+</div>
+
+<div class="container">
+  <div class="row">
+
+    <div class="span3">
+      <div class="well sidebar-nav">
+        <ul class="nav nav-list">
+            $!nav(idxpath, this, state)!$
+            $!nav("install.html", this, state)!$
+            $!nav("howmitmproxy.html", this, state)!$
+
+            <li class="nav-header">Tools</li>
+                $!nav("mitmproxy.html", this, state)!$
+                $!nav("mitmdump.html", this, state)!$
+
+            <li class="nav-header">Features</li>
+                $!nav("anticache.html", this, state)!$
+                $!nav("clientreplay.html", this, state)!$
+                $!nav("filters.html", this, state)!$
+                $!nav("proxyauth.html", this, state)!$
+                $!nav("replacements.html", this, state)!$
+                $!nav("serverreplay.html", this, state)!$
+                $!nav("setheaders.html", this, state)!$
+                $!nav("sticky.html", this, state)!$
+                $!nav("reverseproxy.html", this, state)!$
+                $!nav("upstreamcerts.html", this, state)!$
+
+            <li class="nav-header">SSL interception</li>
+                $!nav("ssl.html", this, state)!$
+                $!nav("certinstall/firefox.html", this, state)!$
+                $!nav("certinstall/osx.html", this, state)!$
+                $!nav("certinstall/windows7.html", this, state)!$
+                $!nav("certinstall/ios.html", this, state)!$
+                $!nav("certinstall/android.html", this, state)!$
+
+            <li class="nav-header">Transparent Proxying</li>
+                $!nav("transparent.html", this, state)!$
+                $!nav("transparent/linux.html", this, state)!$
+                $!nav("transparent/osx.html", this, state)!$
+
+             <li class="nav-header">Tutorials</li>
+                $!nav("tutorials/30second.html", this, state)!$
+                $!nav("tutorials/gamecenter.html", this, state)!$
+
+            <li class="nav-header">Scripting mitmproxy</li>
+                $!nav("scripting/inlinescripts.html", this, state)!$
+                $!nav("scripting/libmproxy.html", this, state)!$
+
+            <li class="nav-header">Hacking</li>
+                $!nav("dev/testing.html", this, state)!$
+        </ul>
+      </div>
+    </div>
+    <div class="span9">
+        <div class="page-header">
+        <h1>@!this.title!@</h1>
+        </div>
+        $!body!$
+    </div>
+  </div>
+
+  <hr>
+
+  <footer>
+    <p>@!copyright!@</p>
+  </footer>
+</div>

doc-src/certinstall/android.html

@@ -0,0 +1,46 @@
+
+The proxy situation on Android is [an
+embarrasment](http://code.google.com/p/android/issues/detail?id=1273).  It's
+scarcely credible, but Android didn't have a global proxy setting at all until
+quite recently, and it's still not supported on many common Android versions.
+In the meantime the app ecosystem has grown used to life without this basic
+necessity, and many apps merrily ignore it even if it's there. This situation
+is improving, but in many circumstances using [transparent
+mode](@!urlTo("transparent.html")!@) is mandatory for testing Android apps.
+
+We used an Asus Transformer Prime TF201 with Android 4.0.3 in the examples
+below - your device may differ, but the broad process should be similar. 
+
+
+## Getting the certificate onto the device
+
+First we need to get the __mitmproxy-ca-cert.cer__ file into the
+__/sdcard/Downloads__ folder on the device. There are a number of ways to do
+this. If you have the Android Developer Tools installed, you can use [__adb
+push__](http://developer.android.com/tools/help/adb.html) to accomplish this.
+Depending on your device, you could also transfer the file using external media
+like an SD Card. In this example, we're using wget from within a terminal
+emulator  to transfer the certificate from a local HTTP server: 
+
+<img src="android-shellwgetmitmproxyca.png"/>
+
+
+## Installing the certificate
+
+Once we have the certificate on the local disk, we need to import it into the
+list of trusted CAs. Go to Settings -&gt; Security -&gt; Credential Storage,
+and select "Install from storage":
+
+<img src="android-settingssecuritymenu.png"/>
+
+The certificate in /sdcard/Downloads is automatically located and offered for
+installation. Installing the cert will delete the download file from the local
+disk:
+
+<img src="android-settingssecurityinstallca.png"/>
+
+Afterwards, you should see the certificate listed in the Trusted Credentials
+store:
+
+<img src="android-settingssecurityuserinstalledca.png"/>
+

doc-src/certinstall/firefox.html

@@ -0,0 +1,23 @@
+
+How to install the __mitmproxy__ certificate authority in Firefox:
+
+<ol class="tlist">
+    <li> If needed, copy the ~/.mitmproxy/mitmproxy-ca-cert.pem file to the target. </li>
+
+    <li>Open preferences, click on "Advanced", then select"Encryption":
+        <img src="@!urlTo('firefox3.jpg')!@"/>
+    </li>
+
+    <li> Click "View Certificates", "Import", and select the certificate file: 
+        <img src="@!urlTo('firefox3-import.jpg')!@"/>
+    </li>
+
+    <li>Tick "Trust this CS to identify web sites", and click "Ok":
+        <img src="@!urlTo('firefox3-trust.jpg')!@"/>
+    </li>
+
+    <li> You should now see the mitmproxy certificate listed in the Authorities
+    tab.</li>
+
+</ol>
+

doc-src/certinstall/index.py

@@ -0,0 +1,10 @@
+from countershape import Page
+
+pages = [
+    Page("firefox.html", "Firefox"),
+    Page("osx.html", "OSX"),
+    Page("windows7.html", "Windows 7"),
+    Page("ios.html", "IOS"),
+    Page("ios-simulator.html", "IOS Simulator"),
+    Page("android.html", "Android"),
+]

doc-src/certinstall/ios-simulator.html

@@ -0,0 +1,23 @@
+
+How to install the __mitmproxy__ certificate authority in the IOS simulator:
+
+<ol class="tlist">
+
+    <li> First, check out the <a
+    href="https://github.com/ADVTOOLS/ADVTrustStore">ADVTrustStore</a> tool
+    from github.</li>
+
+    <li> Now, run the following command:
+
+    <pre class="terminal">./iosCertTrustManager.py -a ~/.mitmproxy/mitmproxy-ca-cert.pem</pre>
+
+    </li>
+
+</ol>
+
+
+Note that although the IOS simulator has its own certificate store, it shares
+the proxy settings of the host operating system. You will therefore to have
+configure your OSX host's proxy settings to use the mitmproxy instance you want
+to test with.
+

doc-src/certinstall/ios.html

@@ -0,0 +1,21 @@
+
+How to install the __mitmproxy__ certificate authority on IOS devices:
+
+<ol class="tlist">
+    <li>Set up the Mail app on the device to receive email.</li>
+
+    <li>Mail the mitmproxy-ca-cert.pem file to the device, and tap on the attachment.</li>
+
+    <li>You will be prompted to install a profile. Click "Install":
+
+    <img src="@!urlTo('ios-profile.png')!@"/></li>
+
+    <li>Accept the warning by clicking "Install" again:
+
+    <img src="@!urlTo('ios-warning.png')!@"/></li>
+
+    <li>The certificate should now be trusted:
+
+    <img src="@!urlTo('ios-installed.png')!@"/></li>
+
+</ol>

doc-src/certinstall/osx.html

@@ -0,0 +1,16 @@
+
+How to install the __mitmproxy__ certificate authority in OSX:
+
+<ol class="tlist">
+
+    <li>Open Finder, and double-click on the mitmproxy-ca-cert.pem file.</li>
+
+    <li>You will be prompted to add the certificate. Click "Always Trust": 
+
+        <img src="@!urlTo('osx-addcert-alwaystrust.png')!@"/>
+    </li>
+
+    <li> You may be prompted for your password. You should now see the
+    mitmproxy cert listed under "Certificates".</li>
+</ol>
+

doc-src/certinstall/windows7.html

@@ -0,0 +1,32 @@
+
+How to install the __mitmproxy__ certificate authority in Windows 7:
+
+<ol class="tlist">
+
+    <li> Copy the ~/.mitmproxy/mitmproxy-ca-cert.p12 file to the target system. </li>
+
+    <li> 
+        Double-click the certificate file. You should see a certificate import wizard: 
+
+        <img src="@!urlTo('win7-wizard.png')!@"/>
+    </li>
+
+    <li> 
+        Click "Next" until you're prompted for the certificate store:
+
+        <img src="@!urlTo('win7-certstore.png')!@"/>
+
+    </li>
+
+
+    <li> 
+        <p>Select "Place all certificates in the following store", and select "Trusted Root Certification Authorities":</p>
+
+        <img src="@!urlTo('win7-certstore-trustedroot.png')!@"/>
+
+    </li>
+
+    <li> Click "Next" and "Finish". </li>
+
+</ol>
+

doc-src/dev/index.py

@@ -0,0 +1,6 @@
+from countershape import Page
+
+pages = [
+     Page("testing.html", "Testing"),
+#    Page("addingviews.html", "Writing Content Views"),
+]

doc-src/dev/testing.html

@@ -0,0 +1,43 @@
+
+All the mitmproxy projects strive to maintain 100% code coverage. In general,
+patches and pull requests will be declined unless they're accompanied by a
+suitable extension to the test suite. 
+
+Our tests are written for the [nose](https://nose.readthedocs.org/en/latest/).
+At the point where you send your pull request, a command like this:
+
+<pre class="terminal">
+> nosetests --with-cov --cov-report term-missing ./test
+</pre>
+
+Should give output something like this:
+
+<pre class="terminal">
+> ---------- coverage: platform darwin, python 2.7.2-final-0 --
+> Name                   Stmts   Miss  Cover   Missing
+> ----------------------------------------------------
+> libmproxy/__init__         0      0   100%
+> libmproxy/app              4      0   100%
+> libmproxy/cmdline        100      0   100%
+> libmproxy/controller      69      0   100%
+> libmproxy/dump           150      0   100%
+> libmproxy/encoding        39      0   100%
+> libmproxy/filt           201      0   100%
+> libmproxy/flow           891      0   100%
+> libmproxy/proxy          427      0   100%
+> libmproxy/script          27      0   100%
+> libmproxy/utils          133      0   100%
+> libmproxy/version          4      0   100%
+> ----------------------------------------------------
+> TOTAL                   2045      0   100%
+> ----------------------------------------------------
+> Ran 251 tests in 11.864s
+</pre>
+
+
+There are exceptions to the coverage requirement - for instance, much of the
+console interface code can't sensibly be unit tested. These portions are
+excluded from coverage analysis either in the **.coveragerc** file, or using
+**#pragma no-cover** directives. To keep our coverage analysis relevant, we use
+these measures as sparingly as possible.
+

doc-src/features/anticache.html

@@ -0,0 +1,18 @@
+
+When the __anticache__ option is passed to mitmproxy, it removes headers
+(__if-none-match__ and __if-modified-since__) that might elicit a
+304-not-modified response from the server. This is useful when you want to make
+sure you capture an HTTP exchange in its totality. It's also often used during
+[client replay](@!urlTo("clientreplay.html")!@), when you want to make sure the
+server responds with complete data.
+
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th> <td>--anticache</td>
+        </tr>
+        <tr>
+            <th>mitmproxy shortcut</th> <td><b>o</b> then <b>a</b></td>
+        </tr>
+    </tbody>
+</table>

doc-src/features/clientreplay.html

@@ -1,7 +1,3 @@
-.. _clientreplay:
-
-Client-side replay
-==================
 
 Client-side replay does what it says on the tin: you provide a previously saved
 HTTP conversation, and mitmproxy replays the client requests one by one. Note
@@ -10,9 +6,17 @@ before starting the next request. This might differ from the recorded
 conversation, where requests may have been made concurrently.
 
 You may want to use client-side replay in conjunction with the
-:ref:`anticache` option, to make sure the server responds with complete data.
+[anticache](@!urlTo("anticache.html")!@) option, to make sure the server
+responds with complete data. 
 
-================== =================
-command-line       :option:`-c path`
-mitmproxy shortcut :kbd:`c`
-================== =================
+
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th> <td>-c path</td>
+        </tr>
+        <tr>
+            <th>mitmproxy shortcut</th> <td><b>c</b></td>
+        </tr>
+    </tbody>
+</table>

doc-src/features/filters.html

@@ -1,39 +1,36 @@
-.. _filters:
 
-Filter expressions
-==================
-
-Many commands in :program:`mitmproxy` and :program:`mitmdump` take a filter expression.
+Many commands in __mitmproxy__ and __mitmdump__ take a filter expression.
 Filter expressions consist of the following operators:
 
-.. documentedlist::
-    :header: "Expression" "Description"
-    :listobject: libmproxy.filt.help
+<table class="table">
+    <tbody>
+    <!--(for i in filt_help)-->
+        <tr>
+            <td class="filt_cmd">@!i[0]!@</td>
+            <td class="filt_help">@!i[1]!@</td>
+        </tr>
+    <!--(end)-->
+    </tbody>
+</table>
 
 - Regexes are Python-style
 - Regexes can be specified as quoted strings
 - Header matching (~h, ~hq, ~hs) is against a string of the form "name: value".
 - Strings with no operators are matched against the request URL.
-- The default binary operator is &.
+- The default binary operator is &amp;.
 
 Examples
---------
+========
 
 URL containing "google.com":
 
-.. code-block:: none
-
     google\.com
 
 Requests whose body contains the string "test":
 
-.. code-block:: none
-
     ~q ~b test
 
 Anything but requests with a text/html content type:
 
-.. code-block:: none
-
-    !(~q & ~t "text/html")
+    !(~q & ~t \"text/html\")
 

doc-src/features/index.py

@@ -0,0 +1,14 @@
+from countershape import Page
+
+pages = [
+    Page("anticache.html", "Anticache"),
+    Page("clientreplay.html", "Client-side replay"),
+    Page("filters.html", "Filter expressions"),
+    Page("setheaders.html", "Set Headers"),
+    Page("serverreplay.html", "Server-side replay"),
+    Page("sticky.html", "Sticky cookies and auth"),
+    Page("proxyauth.html", "Proxy Authentication"),
+    Page("replacements.html", "Replacements"),
+    Page("reverseproxy.html", "Reverse proxy mode"),
+    Page("upstreamcerts.html", "Upstream Certs"),
+]

doc-src/features/proxyauth.html

@@ -0,0 +1,26 @@
+
+Asks the user for authentication before they are permitted to use the proxy.
+Authentication headers are stripped from the flows, so they are not passed to
+upstream servers. For now, only HTTP Basic authentication is supported. The
+proxy auth options are ignored if the proxy is in transparent or reverse proxy
+mode.
+
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th>
+            <td>
+                <ul>
+                    <li>--nonanonymous</li>
+
+                    <li>--singleuser USER</li>
+
+                    <li>--htpasswd PATH</li>
+                </ul>
+            </td>
+        </tr>
+    </tbody>
+</table>
+
+
+

doc-src/features/replacements.html

@@ -1,8 +1,3 @@
-.. _replacements:
-
-Replacements
-============
-
 Mitmproxy lets you specify an arbitrary number of patterns that define text
 replacements within flows. Each pattern has 3 components: a filter that defines
 which flows a replacement applies to, a regular expression that defines what
@@ -14,59 +9,66 @@ replace hook is triggered on server response, the replacement is only run on
 the Response object leaving the Request intact. You control whether the hook
 triggers on the request, response or both using the filter pattern. If you need
 finer-grained control than this, it's simple to create a script using the
-replacement API on Flow components.
+replacement API on Flow components. 
 
 Replacement hooks are extremely handy in interactive testing of applications.
 For instance you can use a replace hook to replace the text "XSS" with a
 complicated XSS exploit, and then "inject" the exploit simply by interacting
 with the application through the browser. When used with tools like Firebug and
 mitmproxy's own interception abilities, replacement hooks can be an amazingly
-flexible and powerful feature.
+flexible and powerful feature. 
 
 
-On the command-line
--------------------
+## On the command-line
 
 The replacement hook command-line options use a compact syntax to make it easy
 to specify all three components at once. The general form is as follows:
 
-.. code-block:: none
-
     /patt/regex/replacement
 
-Here, **patt** is a mitmproxy filter expression, **regex** is a valid Python
-regular expression, and **replacement** is a string literal. The first
-character in the expression (``/`` in this case) defines what the separation
+Here, __patt__ is a mitmproxy filter expression, __regex__ is a valid Python
+regular expression, and __replacement__ is a string literal. The first
+character in the expression (__/__ in this case) defines what the separation
 character is. Here's an example of a valid expression that replaces "foo" with
 "bar" in all requests:
 
-.. code-block:: none
-
     :~q:foo:bar
 
 In practice, it's pretty common for the replacement literal to be long and
 complex. For instance, it might be an XSS exploit that weighs in at hundreds or
 thousands of characters. To cope with this, there's a variation of the
 replacement hook specifier that lets you load the replacement text from a file.
-So, you might start **mitmdump** as follows:
+So, you might start __mitmdump__ as follows:
 
->>> mitmdump --replace-from-file :~q:foo:~/xss-exploit
+<pre class="terminal">
+mitmdump --replace-from-file :~q:foo:~/xss-exploit
+</pre>
 
-This will load the replacement text from the file ``~/xss-exploit``.
+This will load the replacement text from the file __~/xss-exploit__.
 
-Both the :option:`--replace` and :option:`--replace-from-file` flags can be passed multiple
+Both the _--replace_ and _--replace-from-file_ flags can be passed multiple
 times.
 
 
-Interactively
--------------
+## Interactively
 
-The :kbd:`R` shortcut key in the mitmproxy options menu (:kbd:`o`) lets you add and edit
-replacement hooks using a built-in editor. The context-sensitive help (:kbd:`?`) has
-complete usage information.
+The _R_ shortcut key in mitmproxy lets you add and edit replacement hooks using
+a built-in editor. The context-sensitive help (_h_) has complete usage
+information.
 
-================== =============================
-command-line       :option:`--replace`,
-                   :option:`--replace-from-file`
-mitmproxy shortcut :kbd:`o` then :kbd:`R`
-================== =============================
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th>
+            <td>
+                <ul>
+                    <li>--replace</li>
+                    <li>--replace-from-file</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <th>mitmproxy shortcut</th> <td><b>R</b></td>
+        </tr>
+    </tbody>
+</table>

doc-src/features/reverseproxy.html

@@ -0,0 +1,17 @@
+
+In reverse proxy mode, mitmproxy acts as a standard HTTP server and forwards
+all requests to the specified upstream server. Note that the displayed URL for
+flows in this mode will use the value of the __Host__ header field from the
+request, not the reverse proxy server.
+
+
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th> <td>-P http[s]://hostname[:port]</td>
+        </tr>
+        <tr>
+            <th>mitmproxy shortcut</th> <td><b>P</b></td>
+        </tr>
+    </tbody>
+</table>

doc-src/features/serverreplay.html

@@ -1,7 +1,6 @@
-.. _serverreplay:
 
-Server-side replay
-==================
+- command-line: _-S path_ 
+- mitmproxy shortcut: _S_
 
 Server-side replay lets us replay server responses from a saved HTTP
 conversation.
@@ -9,12 +8,12 @@ conversation.
 Matching requests with responses
 --------------------------------
 
-By default, :program:`mitmproxy` excludes request headers when matching incoming
+By default, __mitmproxy__ excludes request headers when matching incoming
 requests with responses from the replay file. This works in most circumstances,
 and makes it possible to replay server responses in situations where request
-headers would naturally vary, e.g. using a different user agent.
-The :option:`--rheader headername` command-line option allows you to override
-this behaviour by specifying individual headers that should be included in matching.
+headers would naturally vary, e.g. using a different user agent. The _--rheader
+headername_ command-line option allows you to override this behaviour by
+specifying individual headers that should be included in matching.
 
 
 Response refreshing
@@ -23,17 +22,14 @@ Response refreshing
 Simply replaying server responses without modification will often result in
 unexpected behaviour. For example cookie timeouts that were in the future at
 the time a conversation was recorded might be in the past at the time it is
-replayed. By default, :program:`mitmproxy` refreshes server responses before sending
-them to the client. The **date**, **expires** and **last-modified** headers are
+replayed. By default, __mitmproxy__ refreshes server responses before sending
+them to the client. The __date__, __expires__ and __last-modified__ headers are
 all updated to have the same relative time offset as they had at the time of
 recording. So, if they were in the past at the time of recording, they will be
 in the past at the time of replay, and vice versa. Cookie expiry times are
 updated in a similar way.
 
-You can turn off response refreshing using the :option:`--norefresh` argument, or using
-the :kbd:`o` options shortcut within :program:`mitmproxy`.
+You can turn off response refreshing using the _--norefresh_ argument, or using
+the _o_ options shortcut within __mitmproxy__.
+
 
-================== =================
-command-line       :option:`-S path`
-mitmproxy shortcut :kbd:`S`
-================== =================

doc-src/features/setheaders.html

@@ -0,0 +1,18 @@
+
+This feature lets you specify a set of headers to be added to requests or
+responses, based on a filter pattern. You can specify these either on the
+command-line, or through an interactive editor in mitmproxy.
+
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th>
+            <td>
+                --setheader PATTERN
+            </td>
+        </tr>
+        <tr>
+            <th>mitmproxy shortcut</th> <td><b>H</b></td>
+        </tr>
+    </tbody>
+</table>

doc-src/features/sticky.html

@@ -0,0 +1,60 @@
+
+## Sticky cookies
+
+When the sticky cookie option is set, __mitmproxy__ will add the cookie most
+recently set by the server to any cookie-less request. Consider a service that
+sets a cookie to track the session after authentication. Using sticky cookies,
+you can fire up mitmproxy, and authenticate to a service as you usually would
+using a browser. After authentication, you can request authenticated resources
+through mitmproxy as if they were unauthenticated, because mitmproxy will
+automatically add the session tracking cookie to requests. Among other things,
+this lets you script interactions with authenticated resources (using tools
+like wget or curl) without having to worry about authentication. 
+
+Sticky cookies are especially powerful when used in conjunction with [client
+replay](@!urlTo("clientreplay.html")!@) - you can record the authentication
+process once, and simply replay it on startup every time you need to interact
+with the secured resources.
+
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th>
+            <td>
+                <ul>
+                    <li>-t FILTER</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <th>mitmproxy shortcut</th> <td><b>t</b></td>
+        </tr>
+    </tbody>
+</table>
+
+
+## Sticky auth
+
+The sticky auth option is analogous to the sticky cookie option, in that HTTP
+__Authorization__ headers are simply replayed to the server once they have been
+seen. This is enough to allow you to access a server resource using HTTP Basic
+authentication through the proxy. Note that __mitmproxy__ doesn't (yet) support
+replay of HTTP Digest authentication. 
+
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th>
+            <td>
+                <ul>
+                    <li>-u FILTER</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <th>mitmproxy shortcut</th> <td><b>u</b></td>
+        </tr>
+    </tbody>
+</table>
+
+

doc-src/features/upstreamcerts.html

@@ -1,12 +1,7 @@
-.. _upstreamcerts:
-
-Upstream Certificates
-=====================
-
 When mitmproxy receives a connection destined for an SSL-protected service, it
 freezes the connection before reading its request data, and makes a connection
 to the upstream server to "sniff" the contents of its SSL certificate. The
-information gained - the **Common Name** and **Subject Alternative Names** - is
+information gained - the __Common Name__ and __Subject Alternative Names__ - is
 then used to generate the interception certificate, which is sent to the client
 so the connection can continue.
 
@@ -17,7 +12,10 @@ certs in transparent mode.
 
 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`
-================== =============================
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th> <td>--no-upstream-cert</td>
+        </tr>
+    </tbody>
+</table>

doc-src/howmitmproxy.html

@@ -0,0 +1,360 @@
+
+
+Mitmproxy is an enormously flexible tool. Knowing exactly how the proxying
+process works will help you deploy it creatively, and take into account its
+fundamental assumptions and how to work around them. This document explains
+mitmproxy's proxy mechanism in detail, starting with the simplest unencrypted
+explicit proxying, and working up to the most complicated interaction -
+transparent proxying of SSL-protected traffic[^ssl] in the presence of
+[SNI](http://en.wikipedia.org/wiki/Server_Name_Indication).
+
+
+<div class="page-header">
+    <h1>Explicit HTTP</h1>
+</div>
+
+Configuring the client to use mitmproxy as an explicit proxy is the simplest
+and most reliable way to intercept traffic. The proxy protocol is codified in
+the [HTTP RFC](http://www.ietf.org/rfc/rfc2068.txt), so the behaviour of both
+the client and the server is well defined, and usually reliable. In the
+simplest possible interaction with mitmproxy, a client connects directly to the
+proxy, and makes a request that looks like this:
+
+<pre>GET http://example.com/index.html HTTP/1.1</pre>
+
+This is a proxy GET request - an extended form of the vanilla HTTP GET request
+that includes a schema and host specification, and it includes all the
+information mitmproxy needs to proceed.
+
+<img src="explicit.png"/>
+
+<table class="table">
+    <tbody>
+        <tr>
+
+            <td><b>1</b></td>
+
+            <td>The client connects to the proxy and makes a request.</td>
+
+        </tr>
+
+        <tr>
+
+            <td><b>2</b></td>
+
+            <td>Mitmproxy connects to the upstream server and simply forwards
+            the request on.</td>
+
+        </tr>
+    </tbody>
+</table>
+
+
+<div class="page-header">
+    <h1>Explicit HTTPS</h1>
+</div>
+
+The process for an explicitly proxied HTTPS connection is quite different. The
+client connects to the proxy and makes a request that looks like this:
+
+<pre>CONNECT example.com:443 HTTP/1.1</pre>
+
+A conventional proxy can neither view nor manipulate an SSL-encrypted data
+stream, so a CONNECT request simply asks the proxy to open a pipe between the
+client and server. The proxy here is just a facilitator - it blindly forwards
+data in both directions without knowing anything about the contents. The
+negotiation of the SSL connection happens over this pipe, and the subsequent
+flow of requests and responses are completely opaque to the proxy.
+
+## The MITM in mitmproxy
+
+This is where mitmproxy's fundamental trick comes into play. The MITM in its
+name stands for Man-In-The-Middle - a reference to the process we use to
+intercept and interfere with these theoretically opaque data streams. The basic
+idea is to pretend to be the server to the client, and pretend to be the client
+to the server, while we sit in the middle decoding traffic from both sides. The
+tricky part is that the [Certificate
+Authority](http://en.wikipedia.org/wiki/Certificate_authority) system is
+designed to prevent exactly this attack, by allowing a trusted third-party to
+cryptographically sign a server's SSL certificates to verify that they are
+legit. If this signature doesn't match or is from a non-trusted party, a secure
+client will simply drop the connection and refuse to proceed. Despite the many
+shortcomings of the CA system as it exists today, this is usually fatal to
+attempts to MITM an SSL connection for analysis. Our answer to this conundrum
+is to become a trusted Certificate Authority ourselves. Mitmproxy includes a
+full CA implementation that generates interception certificates on the fly. To
+get the client to trust these certificates, we [register mitmproxy as a trusted
+CA with the device manually](@!urlTo("ssl.html")!@).
+
+## Complication 1: What's the remote hostname?
+
+To proceed with this plan, we need to know the domain name to use in the
+interception certificate - the client will verify that the certificate is for
+the domain it's connecting to, and abort if this is not the case. At first
+blush, it seems that the CONNECT request above gives us all we need - in this
+example, both of these values are "example.com".  But what if the client had
+initiated the connection as follows:
+
+<pre>CONNECT 10.1.1.1:443 HTTP/1.1</pre>
+
+Using the IP address is perfectly legitimate because it gives us enough
+information to initiate the pipe, even though it doesn't reveal the remote
+hostname.
+
+Mitmproxy has a cunning mechanism that smooths this over - [upstream
+certificate sniffing](@!urlTo("features/upstreamcerts.html")!@). As soon as we
+see the CONNECT request, we pause the client part of the conversation, and
+initiate a simultaneous connection to the server. We complete the SSL handshake
+with the server, and inspect the certificates it used. Now, we use the Common
+Name in the upstream SSL certificates to generate the dummy certificate for the
+client. Voila, we have the correct hostname to present to the client, even if
+it was never specified.
+
+
+## Complication 2: Subject Alternative Name
+
+Enter the next complication. Sometimes, the certificate Common Name is not, in
+fact, the hostname that the client is connecting to. This is because of the
+optional [Subject Alternative
+Name](http://en.wikipedia.org/wiki/SubjectAltName) field in the SSL certificate
+that allows an arbitrary number of alternative domains to be specified. If the
+expected domain matches any of these, the client will proceed, even though the
+domain doesn't match the certificate Common Name. The answer here is simple:
+when extract the CN from the upstream cert, we also extract the SANs, and add
+them to the generated dummy certificate.
+
+
+## Complication 3: Server Name Indication
+
+One of the big limitations of vanilla SSL is that each certificate requires its
+own IP address. This means that you couldn't do virtual hosting where multiple
+domains with independent certificates share the same IP address. In a world
+with a rapidly shrinking IPv4 address pool this is a problem, and we have a
+solution in the form of the [Server Name
+Indication](http://en.wikipedia.org/wiki/Server_Name_Indication) extension to
+the SSL and TLS protocols. This lets the client specify the remote server name
+at the start of the SSL handshake, which then lets the server select the right
+certificate to complete the process.
+
+SNI breaks our upstream certificate sniffing process, because when we connect
+without using SNI, we get served a default certificate that may have nothing to
+do with the certificate expected by the client. The solution is another tricky
+complication to the client connection process. After the client connects, we
+allow the SSL handshake to continue until just _after_ the SNI value has been
+passed to us. Now we can pause the conversation, and initiate an upstream
+connection using the correct SNI value, which then serves us the correct
+upstream certificate, from which we can extract the expected CN and SANs.
+
+There's another wrinkle here. Due to a limitation of the SSL library mitmproxy
+uses, we can't detect that a connection _hasn't_ sent an SNI request until it's
+too late for upstream certificate sniffing. In practice, we therefore make a
+vanilla SSL connection upstream to sniff non-SNI certificates, and then discard
+the connection if the client sends an SNI notification. If you're watching your
+traffic with a packet sniffer, you'll see two connections to the server when an
+SNI request is made, the first of which is immediately closed after the SSL
+handshake. Luckily, this is almost never an issue in practice.
+
+## Putting it all together
+
+Lets put all of this together into the complete explicitly proxied HTTPS flow.
+
+<img src="explicit_https.png"/>
+
+<table class="table">
+    <tbody>
+        <tr>
+            <td><b>1</b></td>
+            <td>The client makes a connection to mitmproxy, and issues an HTTP
+            CONNECT request.</td>
+        </tr>
+        <tr>
+            <td><b>2</b></td>
+
+            <td>Mitmproxy responds with a 200 Connection Established, as if it
+            has set up the CONNECT pipe.</td>
+        </tr>
+        <tr>
+            <td><b>3</b></td>
+
+            <td>The client believes it's talking to the remote server, and
+            initiates the SSL connection. It uses SNI to indicate the hostname
+            it is connecting to.</td>
+        </tr>
+
+        <tr>
+            <td><b>4</b></td>
+
+            <td>Mitmproxy connects to the server, and establishes an SSL
+            connection using the SNI hostname indicated by the client.</td>
+
+        </tr>
+        <tr>
+            <td><b>5</b></td>
+
+            <td>The server responds with the matching SSL certificate, which
+            contains the CN and SAN values needed to generate the interception
+            certificate.</td>
+        </tr>
+        <tr>
+            <td><b>6</b></td>
+
+            <td>Mitmproxy generates the interception cert, and continues the
+            client SSL handshake paused in step 3.</td>
+        </tr>
+        <tr>
+            <td><b>7</b></td>
+
+            <td>The client sends the request over the established SSL
+            connection.</td>
+        </tr>
+        <tr>
+            <td><b>7</b></td>
+
+            <td>Mitmproxy passes the request on to the server over the SSL
+            connection initiated in step 4.</td>
+        </tr>
+    </tbody>
+</table>
+
+
+<div class="page-header">
+    <h1>Transparent HTTP</h1>
+</div>
+
+When a transparent proxy is used, the HTTP/S connection is redirected into a
+proxy at the network layer, without any client configuration being required.
+This makes transparent proxying ideal for those situations where you can't
+change client behaviour - proxy-oblivious Android applications being a common
+example.
+
+To achieve this, we need to introduce two extra components. The first is a
+redirection mechanism that transparently reroutes a TCP connection destined for
+a server on the Internet to a listening proxy server. This usually takes the
+form of a firewall on the same host as the proxy server -
+[iptables](http://www.netfilter.org/) on Linux or
+[pf](http://en.wikipedia.org/wiki/PF_\(firewall\)) on OSX. Once the client has
+initiated the connection, it makes a vanilla HTTP request, which might look
+something like this:
+
+<pre>GET /index.html HTTP/1.1</pre>
+
+Note that this request differs from the explicit proxy variation, in that it
+omits the scheme and hostname. How, then, do we know which upstream host to
+forward the request to? The routing mechanism that has performed the
+redirection keeps track of the original destination for us.  Each routing
+mechanism has a different way of exposing this data, so this introduces the
+second component required for working transparent proxying: a host module that
+knows how to retrieve the original destination address from the router. In
+mitmproxy, this takes the form of a built-in set of
+[modules](https://github.com/mitmproxy/mitmproxy/tree/master/libmproxy/platform)
+that know how to talk to each platform's redirection mechanism.  Once we have
+this information, the process is fairly straight-forward.
+
+<img src="transparent.png"/>
+
+
+<table class="table">
+    <tbody>
+        <tr>
+            <td><b>1</b></td>
+            <td>The client makes a connection to the server.</td>
+        </tr>
+        <tr>
+            <td><b>2</b></td>
+
+            <td>The router redirects the connection to mitmproxy, which is
+            typically listening on a local port of the same host. Mitmproxy
+            then consults the routing mechanism to establish what the original
+            destination was.</td>
+        </tr>
+        <tr>
+            <td><b>3</b></td>
+
+            <td>Now, we simply read the client's request...</td>
+        </tr>
+
+        <tr>
+            <td><b>4</b></td>
+
+            <td>... and forward it upstream.</td>
+
+        </tr>
+    </tbody>
+</table>
+
+<div class="page-header">
+    <h1>Transparent HTTPS</h1>
+</div>
+
+The first step is to determine whether we should treat an incoming connection
+as HTTPS. The mechanism for doing this is simple - we use the routing mechanism
+to find out what the original destination port is. By default, we treat all
+traffic destined for ports 443 and 8443 as SSL.
+
+From here, the process is a merger of the methods we've described for
+transparently proxying HTTP, and explicitly proxying HTTPS. We use the routing
+mechanism to establish the upstream server address, and then proceed as for
+explicit HTTPS connections to establish the CN and SANs, and cope with SNI.
+
+<img src="transparent_https.png"/>
+
+
+<table class="table">
+    <tbody>
+        <tr>
+            <td><b>1</b></td>
+            <td>The client makes a connection to the server.</td>
+        </tr>
+        <tr>
+            <td><b>2</b></td>
+
+            <td>The router redirects the connection to mitmproxy, which is
+            typically listening on a local port of the same host. Mitmproxy
+            then consults the routing mechanism to establish what the original
+            destination was.</td>
+        </tr>
+        <tr>
+            <td><b>3</b></td>
+
+            <td>The client believes it's talking to the remote server, and
+            initiates the SSL connection. It uses SNI to indicate the hostname
+            it is connecting to.</td>
+        </tr>
+
+        <tr>
+            <td><b>4</b></td>
+
+            <td>Mitmproxy connects to the server, and establishes an SSL
+            connection using the SNI hostname indicated by the client.</td>
+
+        </tr>
+        <tr>
+            <td><b>5</b></td>
+
+            <td>The server responds with the matching SSL certificate, which
+            contains the CN and SAN values needed to generate the interception
+            certificate.</td>
+        </tr>
+        <tr>
+            <td><b>6</b></td>
+
+            <td>Mitmproxy generates the interception cert, and continues the
+            client SSL handshake paused in step 3.</td>
+        </tr>
+        <tr>
+            <td><b>7</b></td>
+
+            <td>The client sends the request over the established SSL
+            connection.</td>
+        </tr>
+        <tr>
+            <td><b>7</b></td>
+
+            <td>Mitmproxy passes the request on to the server over the SSL
+            connection initiated in step 4.</td>
+        </tr>
+    </tbody>
+</table>
+
+
+[^ssl]: I use "SSL" to refer to both SSL and TLS in the generic sense, unless otherwise specified.

doc-src/index.html

@@ -0,0 +1,4 @@
+
+@!index_contents!@
+
+

doc-src/index.py

@@ -0,0 +1,86 @@
+import os, sys
+import countershape
+from countershape import Page, Directory, PythonModule, markup, model
+import countershape.template
+sys.path.insert(0, "..")
+from libmproxy import filt
+
+MITMPROXY_SRC = "~/mitmproxy/mitmproxy"
+
+if ns.options.website:
+    ns.idxpath = "doc/index.html"
+    this.layout = countershape.Layout("_websitelayout.html")
+else:
+    ns.idxpath = "index.html"
+    this.layout = countershape.Layout("_layout.html")
+
+
+ns.title = countershape.template.Template(None, "<h1>@!this.title!@</h1>")
+this.titlePrefix = "mitmproxy 0.9 - "
+this.markup = markup.Markdown(extras=["footnotes"])
+
+ns.docMaintainer = "Aldo Cortesi"
+ns.docMaintainerEmail = "aldo@corte.si"
+ns.copyright = u"\u00a9 mitmproxy project, 2013"
+
+def mpath(p):
+    p = os.path.join(MITMPROXY_SRC, p)
+    return os.path.expanduser(p)
+
+ns.index_contents = file(mpath("README.mkd")).read()
+
+def example(s):
+    d = file(mpath(s)).read().rstrip()
+    extemp = """<div class="example">%s<div class="example_legend">(%s)</div></div>"""
+    return extemp%(countershape.template.Syntax("py")(d), s)
+ns.example = example
+
+
+filt_help = []
+for i in filt.filt_unary:
+    filt_help.append(
+        ("~%s"%i.code, i.help)
+    )
+for i in filt.filt_rex:
+    filt_help.append(
+        ("~%s regex"%i.code, i.help)
+    )
+for i in filt.filt_int:
+    filt_help.append(
+        ("~%s int"%i.code, i.help)
+    )
+filt_help.sort()
+filt_help.extend(
+    [
+        ("!", "unary not"),
+        ("&", "and"),
+        ("|", "or"),
+        ("(...)", "grouping"),
+    ]
+)
+ns.filt_help = filt_help
+
+
+def nav(page, current, state):
+    if current.match(page, False):
+        pre = '<li class="active">'
+    else:
+        pre = "<li>"
+    p = state.application.getPage(page)
+    return pre + '<a href="%s">%s</a></li>'%(model.UrlTo(page), p.title)
+ns.nav = nav
+
+pages = [
+    Page("index.html", "Introduction"),
+    Page("install.html", "Installation"),
+    Page("mitmproxy.html", "mitmproxy"),
+    Page("mitmdump.html", "mitmdump"),
+    Page("howmitmproxy.html", "How mitmproxy works"),
+
+    Page("ssl.html", "Overview"),
+    Directory("certinstall"),
+    Directory("scripting"),
+    Directory("tutorials"),
+    Page("transparent.html", "Overview"),
+    Directory("transparent"),
+]

doc-src/install.html

@@ -0,0 +1,52 @@
+
+The preferred way to install mitmproxy - whether you're installing the latest
+release or from source - is to use [pip](http://www.pip-installer.org/). If you
+don't already have pip on your system, you can find installation instructions
+[here](http://www.pip-installer.org/en/latest/installing.html).
+
+
+## Installing the latest release
+
+A single command will download and install the latest release of mitmproxy,
+along with all its dependencies:
+
+<pre class="terminal">
+pip install mitmproxy
+</pre>
+
+
+## Installing from source
+
+When installing from source, the easiest method is still to use pip. In this
+case run:
+    
+<pre class="terminal">
+pip install /path/to/source
+</pre>
+
+Note that if you're installing current git master, you will also have to
+install the current git master of [netlib](http://github.com/mitmproxy/netlib) by
+hand.
+
+## OSX
+
+- If you're running a Python interpreter installed with homebrew (or similar),
+you may have to install some dependencies by hand. 
+- Make sure that XCode is installed from the App Store, and that the
+command-line tools have been downloaded (XCode/Preferences/Downloads).
+- Now use __pip__ to do the installation, as above.
+
+There are a few bits of customization you might want to do to make mitmproxy
+comfortable to use on OSX. The default color scheme is optimized for a dark
+background terminal, but you can select a palette for a light terminal
+background with the --palette option. You can use the OSX <b>open</b> program
+to create a simple and effective <b>~/.mailcap</b> file to view request and
+response bodies:
+
+<pre class="terminal">
+application/*; /usr/bin/open -Wn %s
+audio/*; /usr/bin/open -Wn %s
+image/*; /usr/bin/open -Wn %s
+video/*; /usr/bin/open -Wn %s
+</pre>
+

doc-src/mitmdump.html

@@ -0,0 +1,68 @@
+
+__mitmdump__ is the command-line companion to mitmproxy. It provides
+tcpdump-like functionality to let you view, record, and programmatically
+transform HTTP traffic. See the _--help_ flag output for complete
+documentation.
+
+
+
+# Examples
+
+
+## Saving traffic
+
+<pre class="terminal">
+> mitmdump -w outfile
+</pre>
+
+Start up mitmdump in proxy mode, and write all traffic to __outfile__. 
+
+
+## Filtering saved traffic
+
+<pre class="terminal">
+> mitmdump -nr infile -w outfile "~m post"
+</pre>
+
+Start mitmdump without binding to the proxy port (_-n_), read all flows from
+infile, apply the specified filter expression (only match POSTs), and write to
+outfile.
+
+
+## Client replay
+
+<pre class="terminal">
+> mitmdump -nc outfile
+</pre>
+
+Start mitmdump without binding to the proxy port (_-n_), then replay all
+requests from outfile (_-c filename_). Flags combine in the obvious way, so
+you can replay requests from one file, and write the resulting flows to
+another:
+
+<pre class="terminal">
+> mitmdump -nc srcfile -w dstfile
+</pre>
+
+See the [Client-side Replay](@!urlTo("clientreplay.html")!@) section for more information.
+
+
+## Running a script
+
+<pre class="terminal">
+> mitmdump -s examples/add_header.py
+</pre>
+
+This runs the __add_header.py__ example script, which simply adds a new header
+to all responses.
+
+
+## Scripted data transformation
+
+<pre class="terminal">
+> mitmdump -ns examples/add_header.py -r srcfile -w dstfile
+</pre>
+
+This command loads flows from __srcfile__, transforms it according to the
+specified script, then writes it back to __dstfile__.
+

doc-src/mitmproxy.html

@@ -0,0 +1,115 @@
+
+__mitmproxy__ is a console tool that allows interactive examination and
+modification of HTTP traffic. It differs from mitmdump in that all flows are
+kept in memory, which means that it's intended for taking and manipulating
+small-ish samples. Use the _?_ shortcut key to view, context-sensitive
+documentation from any __mitmproxy__ screen.
+
+## Flow list
+
+The flow list shows an index of captured flows in chronological order. 
+
+<img src="@!urlTo("screenshots/mitmproxy.png")!@"/>
+
+- __1__: A GET request, returning a 302 Redirect response.
+- __2__: A GET request, returning 16.75kb of text/html data.
+- __3__: A replayed request. 
+- __4__: Intercepted flows are indicated with orange text. The user may edit
+these flows, and then accept them (using the _a_ key) to continue. In this
+case, the request has been intercepted on the way to the server.
+- __5__: A response intercepted from the server on the way to the client.
+- __6__: The event log can be toggled on and off using the _e_ shortcut key. This
+pane shows events and errors that may not result in a flow that shows up in the
+flow pane.
+- __7__: Flow count.
+- __8__: Various information on mitmproxy's state. In this case, we have an
+interception pattern set to ".*".
+- __9__: Bind address indicator - mitmproxy is listening on port 8080 of all
+interfaces.
+
+
+## Flow view
+
+The __Flow View__ lets you inspect and manipulate a single flow:
+
+<img src="@!urlTo("screenshots/mitmproxy-flowview.png")!@"/>
+
+- __1__: Flow summary.
+- __2__: The Request/Response tabs, showing you which part of the flow you are
+currently viewing. In the example above, we're viewing the Response. Hit _tab_
+to switch between the Response and the Request.
+- __3__: Headers.
+- __4__: Body.
+- __5__: View Mode indicator. In this case, we're viewing the body in __hex__
+mode. The other available modes are __pretty__, which uses a number of
+heuristics to show you a friendly view of various content types, and __raw__,
+which shows you exactly what's there without any changes. You can change modes
+using the _m_ key.
+
+
+
+## Grid Editor
+
+Much of the data that we'd like to interact with in mitmproxy is structured.
+For instance, headers, queries and form data can all be thought of as a list of
+key/value pairs. Mitmproxy has a built-in editor that lays this type of data
+out in a grid for easy manipulation. 
+
+At the moment, the Grid Editor is used in four parts of mitmproxy:
+
+- Editing request or response headers (_e_ for edit, then _h_ for headers in flow view) 
+- Editing a query string (_e_ for edit, then _q_ for query in flow view)
+- Editing a URL-encoded form (_e_ for edit, then _f_ for form in flow view)
+- Editing replacement patterns (_R_ globally)
+
+If there is is no data, an empty editor will be started to let you add some.
+Here is the editor showing the headers from a request:
+
+<img src="@!urlTo("screenshots/mitmproxy-kveditor.png")!@"/>
+
+To edit, navigate to the key or value you want to modify using the arrow or vi
+navigation keys, and press enter. The background color will change to show that
+you are in edit mode for the specified field:
+
+<img src="@!urlTo("screenshots/mitmproxy-kveditor-editmode.png")!@"/>
+
+Modify the field as desired, then press escape to exit edit mode when you're
+done. You can also add a row (_a_ key), delete a row (_d_ key), spawn an
+external editor on a field (_e_ key). Be sure to consult the context-sensitive
+help (_?_ key) for more.
+
+
+# Example: Interception
+
+__mitmproxy__'s interception functionality lets you pause an HTTP request or
+response, inspect and modify it, and then accept it to send it on to the server
+or client. 
+
+
+### 1: Set an interception pattern
+
+<img src="@!urlTo('mitmproxy-intercept-filt.png')!@"/>
+
+We press _i_ to set an interception pattern. In this case, the __~q__ filter
+pattern tells __mitmproxy__ to intercept all requests. For complete filter
+syntax, see the [Filter expressions](@!urlTo("filters.html")!@) section of this
+document, or the built-in help function in __mitmproxy__.
+
+### 2: Intercepted connections are indicated with orange text:
+
+<img src="@!urlTo('mitmproxy-intercept-mid.png')!@"/>
+
+### 3: You can now view and modify the request:
+
+<img src="@!urlTo('mitmproxy-intercept-options.png')!@"/>
+
+In this case, we viewed the request by selecting it, pressed _e_ for "edit"
+and _m_ for "method" to change the HTTP request method.
+
+### 4: Accept the intercept to continue:
+
+<img src="@!urlTo('mitmproxy-intercept-result.png')!@"/>
+
+Finally, we press _a_ to accept the modified request, which is then sent on to
+the server. In this case, we changed the request from an HTTP GET to
+OPTIONS, and Google's server has responded with a 405 "Method not allowed". 

doc-src/scripting/index.py

@@ -0,0 +1,6 @@
+from countershape import Page
+
+pages = [
+    Page("inlinescripts.html", "Inline Scripts"),
+    Page("libmproxy.html", "libmproxy"),
+]

doc-src/scripting/inlinescripts.html

@@ -0,0 +1,137 @@
+__mitmproxy__ has a powerful scripting API that allows you to modify flows
+on-the-fly or rewrite previously saved flows locally. 
+
+The mitmproxy scripting API is event driven - a script is simply a Python
+module that exposes a set of event methods. Here's a complete mitmproxy script
+that adds a new header to every HTTP response before it is returned to the
+client:
+
+$!example("examples/add_header.py")!$
+
+The first argument to each event method is an instance of ScriptContext that
+lets the script interact with the global mitmproxy state. The __response__
+event also gets an instance of Flow, which we can use to manipulate the
+response itself.
+
+We can now run this script using mitmdump or mitmproxy as follows:
+
+<pre class="terminal">
+> mitmdump -s add_header.py
+</pre>
+
+The new header will be added to all responses passing through the proxy.
+
+
+
+## Events
+
+### start(ScriptContext, argv)
+
+Called once on startup, before any other events.
+
+
+### clientconnect(ScriptContext, ClientConnect)
+
+Called when a client initiates a connection to the proxy. Note that
+a connection can correspond to multiple HTTP requests.
+
+
+### request(ScriptContext, Flow)
+
+Called when a client request has been received. The __Flow__ object is
+guaranteed to have a non-None __request__ attribute.
+
+
+### response(ScriptContext, Flow)
+
+Called when a server response has been received. The __Flow__ object is
+guaranteed to have non-None __request__ and __response__ attributes.
+
+
+### error(ScriptContext, Flow)
+
+Called when a flow error has occurred, e.g. invalid server responses, or
+interrupted connections. This is distinct from a valid server HTTP error
+response, which is simply a response with an HTTP error code. The __Flow__
+object is guaranteed to have non-None __request__ and __error__ attributes.
+
+
+### clientdisconnect(ScriptContext, ClientDisconnect)
+
+Called when a client disconnects from the proxy.
+
+### done(ScriptContext)
+
+Called once on script shutdown, after any other events.
+
+
+## API
+
+The main classes you will deal with in writing mitmproxy scripts are:
+
+<table class="table">
+    <tr>
+        <th>libmproxy.flow.ClientConnection</th>
+        <td>Describes a client connection.</td>
+    </tr>
+    <tr>
+        <th>libmproxy.flow.ClientDisconnection</th>
+        <td>Describes a client disconnection.</td>
+    </tr>
+    <tr>
+        <th>libmproxy.flow.Error</th>
+        <td>A communications error.</td>
+    </tr>
+    <tr>
+        <th>libmproxy.flow.Flow</th>
+        <td>A collection of objects representing a single HTTP transaction.</td>
+    </tr>
+    <tr>
+        <th>libmproxy.flow.Headers</th>
+        <td>HTTP headers for a request or response.</td>
+    </tr>
+    <tr>
+        <th>libmproxy.flow.ODict</th>
+
+        <td>A dictionary-like object for managing sets of key/value data. There
+        is also a variant called CaselessODict that ignores key case for some
+        calls (used mainly for headers).</td>
+    </tr>
+    <tr>
+        <th>libmproxy.flow.Response</th>
+        <td>An HTTP response.</td>
+    </tr>
+    <tr>
+        <th>libmproxy.flow.Request</th>
+        <td>An HTTP request.</td>
+    </tr>
+    <tr>
+        <th>libmproxy.flow.ScriptContext</th>
+        <td> A handle for interacting with mitmproxy's from within scripts.  </td>
+    </tr>
+    <tr>
+        <th>libmproxy.certutils.SSLCert</th>
+        <td>Exposes information SSL certificates.</td>
+    </tr>
+</table>
+
+The canonical API documentation is the code. You can view the API documentation
+using pydoc (which is installed with Python by default), like this:
+
+<pre class="terminal">
+> pydoc libmproxy.flow.Request
+</pre>
+
+
+## Running scripts on saved flows
+
+Sometimes, we want to run a script on __Flow__ objects that are already
+complete.  This happens when you start a script, and then load a saved set of
+flows from a file (see the "scripted data transformation" example on the
+[mitmdump](@!urlTo("mitmdump.html")!@) page). It also happens when you run a
+one-shot script on a single flow through the _|_ (pipe) shortcut in mitmproxy.
+
+In this case, there are no client connections, and the events are run in the
+following order: __start__, __request__, __response__, __error__, __done__.  If
+the flow doesn't have a __response__ or __error__ associated with it, the
+matching event will be skipped. 

doc-src/scripting/libmproxy.html

@@ -0,0 +1,12 @@
+
+All of mitmproxy's basic functionality is exposed through the __libmproxy__
+library. The example below shows a simple implementation of the "sticky cookie"
+functionality included in the interactive mitmproxy program. Traffic is
+monitored for __cookie__ and __set-cookie__ headers, and requests are rewritten
+to include a previously seen cookie if they don't already have one. In effect,
+this lets you log in to a site using your browser, and then make subsequent
+requests using a tool like __curl__, which will then seem to be part of the
+authenticated session.
+
+$!example("examples/stickycookies")!$
+

doc-src/ssl.html

@@ -0,0 +1,46 @@
+
+The first time __mitmproxy__ or __mitmdump__ is run, a set of certificate files
+for the mitmproxy Certificate Authority are created in the config directory
+(~/.mitmproxy by default). The files are as follows: 
+
+<table class="table">
+    <tr>
+        <td class="nowrap">mitmproxy-ca.pem</td>
+        <td>The private key and certificate in PEM format.</td>
+    </tr>
+    <tr>
+        <td class="nowrap">mitmproxy-ca-cert.pem</td>
+        <td>The certificate in PEM format. Use this to distribute to most
+        non-Windows platforms.</td>
+    </tr>
+    <tr>
+        <td class="nowrap">mitmproxy-ca-cert.p12</td>
+        <td>The certificate in PKCS12 format. For use on Windows.</td>
+    </tr>
+    <tr>
+        <td class="nowrap">mitmproxy-ca-cert.cer</td>
+        <td>Same file as .pem, but with an extension expected by some Android
+        devices.</td>
+    </tr>
+</table>
+    
+This CA is used for on-the-fly generation of dummy certificates for SSL
+interception. Since your browser won't trust the __mitmproxy__ CA out of the
+box (and rightly so), you will see an SSL cert warning every time you visit a
+new SSL domain through __mitmproxy__. When you're testing a single site through
+a browser, just accepting the bogus SSL cert manually is not too much trouble,
+but there are a many circumstances where you will want to configure your
+testing system or browser to trust the __mitmproxy__ CA as a signing root
+authority.
+
+
+Installing the mitmproxy CA
+---------------------------
+
+* [Firefox](@!urlTo("certinstall/firefox.html")!@)
+* [OSX](@!urlTo("certinstall/osx.html")!@)
+* [Windows 7](@!urlTo("certinstall/windows7.html")!@)
+* [iPhone/iPad](@!urlTo("certinstall/ios.html")!@)
+* [IOS Simulator](@!urlTo("certinstall/ios-simulator.html")!@)
+* [Android](@!urlTo("certinstall/android.html")!@)
+

doc-src/syntax.css

@@ -0,0 +1,120 @@
+.highlight  { background: #f8f8f8; }
+.highlight .c { color: #408080; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #008000; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
+.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
+.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #808080 } /* Generic.Output */
+.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0040D0 } /* Generic.Traceback */
+.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+.highlight .kp { color: #008000 } /* Keyword.Pseudo */
+.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #B00040 } /* Keyword.Type */
+.highlight .m { color: #666666 } /* Literal.Number */
+.highlight .s { color: #BA2121 } /* Literal.String */
+.highlight .na { color: #7D9029 } /* Name.Attribute */
+.highlight .nb { color: #008000 } /* Name.Builtin */
+.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.highlight .no { color: #880000 } /* Name.Constant */
+.highlight .nd { color: #AA22FF } /* Name.Decorator */
+.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #0000FF } /* Name.Function */
+.highlight .nl { color: #A0A000 } /* Name.Label */
+.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #19177C } /* Name.Variable */
+.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #666666 } /* Literal.Number.Float */
+.highlight .mh { color: #666666 } /* Literal.Number.Hex */
+.highlight .mi { color: #666666 } /* Literal.Number.Integer */
+.highlight .mo { color: #666666 } /* Literal.Number.Oct */
+.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
+.highlight .sc { color: #BA2121 } /* Literal.String.Char */
+.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
+.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
+.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
+.highlight .sx { color: #008000 } /* Literal.String.Other */
+.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
+.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
+.highlight .ss { color: #19177C } /* Literal.String.Symbol */
+.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #19177C } /* Name.Variable.Class */
+.highlight .vg { color: #19177C } /* Name.Variable.Global */
+.highlight .vi { color: #19177C } /* Name.Variable.Instance */
+.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
+.grokdoc  { background: #f8f8f8; }
+.grokdoc .c { color: #408080; font-style: italic } /* Comment */
+.grokdoc .err { border: 1px solid #FF0000 } /* Error */
+.grokdoc .k { color: #008000; font-weight: bold } /* Keyword */
+.grokdoc .o { color: #666666 } /* Operator */
+.grokdoc .cm { color: #408080; font-style: italic } /* Comment.Multiline */
+.grokdoc .cp { color: #BC7A00 } /* Comment.Preproc */
+.grokdoc .c1 { color: #408080; font-style: italic } /* Comment.Single */
+.grokdoc .cs { color: #408080; font-style: italic } /* Comment.Special */
+.grokdoc .gd { color: #A00000 } /* Generic.Deleted */
+.grokdoc .ge { font-style: italic } /* Generic.Emph */
+.grokdoc .gr { color: #FF0000 } /* Generic.Error */
+.grokdoc .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.grokdoc .gi { color: #00A000 } /* Generic.Inserted */
+.grokdoc .go { color: #808080 } /* Generic.Output */
+.grokdoc .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+.grokdoc .gs { font-weight: bold } /* Generic.Strong */
+.grokdoc .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.grokdoc .gt { color: #0040D0 } /* Generic.Traceback */
+.grokdoc .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+.grokdoc .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+.grokdoc .kp { color: #008000 } /* Keyword.Pseudo */
+.grokdoc .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+.grokdoc .kt { color: #B00040 } /* Keyword.Type */
+.grokdoc .m { color: #666666 } /* Literal.Number */
+.grokdoc .s { color: #BA2121 } /* Literal.String */
+.grokdoc .na { color: #7D9029 } /* Name.Attribute */
+.grokdoc .nb { color: #008000 } /* Name.Builtin */
+.grokdoc .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.grokdoc .no { color: #880000 } /* Name.Constant */
+.grokdoc .nd { color: #AA22FF } /* Name.Decorator */
+.grokdoc .ni { color: #999999; font-weight: bold } /* Name.Entity */
+.grokdoc .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
+.grokdoc .nf { color: #0000FF } /* Name.Function */
+.grokdoc .nl { color: #A0A000 } /* Name.Label */
+.grokdoc .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.grokdoc .nt { color: #008000; font-weight: bold } /* Name.Tag */
+.grokdoc .nv { color: #19177C } /* Name.Variable */
+.grokdoc .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.grokdoc .w { color: #bbbbbb } /* Text.Whitespace */
+.grokdoc .mf { color: #666666 } /* Literal.Number.Float */
+.grokdoc .mh { color: #666666 } /* Literal.Number.Hex */
+.grokdoc .mi { color: #666666 } /* Literal.Number.Integer */
+.grokdoc .mo { color: #666666 } /* Literal.Number.Oct */
+.grokdoc .sb { color: #BA2121 } /* Literal.String.Backtick */
+.grokdoc .sc { color: #BA2121 } /* Literal.String.Char */
+.grokdoc .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.grokdoc .s2 { color: #BA2121 } /* Literal.String.Double */
+.grokdoc .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
+.grokdoc .sh { color: #BA2121 } /* Literal.String.Heredoc */
+.grokdoc .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
+.grokdoc .sx { color: #008000 } /* Literal.String.Other */
+.grokdoc .sr { color: #BB6688 } /* Literal.String.Regex */
+.grokdoc .s1 { color: #BA2121 } /* Literal.String.Single */
+.grokdoc .ss { color: #19177C } /* Literal.String.Symbol */
+.grokdoc .bp { color: #008000 } /* Name.Builtin.Pseudo */
+.grokdoc .vc { color: #19177C } /* Name.Variable.Class */
+.grokdoc .vg { color: #19177C } /* Name.Variable.Global */
+.grokdoc .vi { color: #19177C } /* Name.Variable.Instance */
+.grokdoc .il { color: #666666 } /* Literal.Number.Integer.Long */

doc-src/transparent.html

@@ -1,7 +1,3 @@
-.. _transparent:
-
-Transparent Proxying
-====================
 
 When a transparent proxy is used, traffic is redirected into a proxy at the
 network layer, without any client configuration being required. This makes
@@ -11,14 +7,13 @@ behaviour - proxy-oblivious Android applications being a common example.
 To set up transparent proxying, we need two new components. The first is a
 redirection mechanism that transparently reroutes a TCP connection destined for
 a server on the Internet to a listening proxy server. This usually takes the
-form of a firewall on the same host as the proxy server - iptables_ on Linux
-or pf_ on OSX. When the proxy receives a redirected connection, it sees a vanilla
-HTTP request, without a host specification. This is where the second new component
-comes in - a host module that allows us to query the redirector for the original
-destination of the TCP connection.
+form of a firewall on the same host as the proxy server -
+[iptables](http://www.netfilter.org/) on Linux or
+[pf](http://en.wikipedia.org/wiki/PF_\(firewall\)) on OSX. When the proxy
+receives a redirected connection, it sees a vanilla HTTP request, without a
+host specification. This is where the second new component comes in - a host
+module that allows us to query the redirector for the original destination of
+the TCP connection.
 
 At the moment, mitmproxy supports transparent proxying on OSX Lion and above,
 and all current flavors of Linux.
-
-.. _iptables: http://www.netfilter.org/
-.. _pf: https://en.wikipedia.org/wiki/PF_\(firewall\)

doc-src/transparent/index.py

@@ -0,0 +1,6 @@
+from countershape import Page
+
+pages = [
+    Page("osx.html", "OSX"),
+    Page("linux.html", "Linux"),
+]

doc-src/transparent/linux.html

@@ -0,0 +1,40 @@
+On Linux, mitmproxy integrates with the iptables redirection mechanism to
+achieve transparent mode.
+
+<ol class="tlist">
+
+    <li> <a href="@!urlTo("ssl.html")!@">Install the mitmproxy
+    certificates on the test device</a>. </li>
+
+    <li> Enable IP forwarding:
+
+    <pre class="terminal">sysctl -w net.ipv4.ip_forward=1</pre>
+
+    You may also want to consider enabling this permanently in
+    <b>/etc/sysctl.conf</b>.
+
+    </li>
+
+    <li> Create an iptables ruleset that redirects the desired traffic to the
+    mitmproxy port. Details will differ according to your setup, but the
+    ruleset should look something like this:
+
+<pre class="terminal">iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 8080
+iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 443 -j REDIRECT --to-port 8080</pre>
+    
+    </li>
+
+    <li> Fire up mitmproxy. You probably want a command like this:
+
+        <pre class="terminal">mitmproxy -T --host</pre>
+
+        The <b>-T</b> flag turns on transparent mode, and the <b>--host</b>
+        argument tells mitmproxy to use the value of the Host header for URL
+        display.
+
+    </li>
+
+    <li> Finally, configure your test device to use the host on which mitmproxy is
+    running as the default gateway.</li>
+
+</ol>

doc-src/transparent/osx.html

@@ -0,0 +1,69 @@
+
+
+OSX Lion integrated the [pf](http://www.openbsd.org/faq/pf/) packet filter from
+the OpenBSD project, which mitmproxy uses to implement transparent mode on OSX.
+Note that this means we don't support transparent mode for earlier versions of
+OSX.
+
+<ol class="tlist">
+
+    <li> <a href="@!urlTo("ssl.html")!@">Install the mitmproxy
+    certificates on the test device</a>. </li>
+
+    <li> Enable IP forwarding:
+
+    <pre class="terminal">sudo sysctl -w net.inet.ip.forwarding=1</pre>
+    </li>
+
+    <li>  Place the following two lines in a file called, say, <b>pf.conf</b>:
+
+<pre class="terminal">rdr on en2 inet proto tcp to any port 80 -&gt; 127.0.0.1 port 8080
+rdr on en2 inet proto tcp to any port 443 -&gt; 127.0.0.1 port 8080
+</pre>
+
+        These rules tell pf to redirect all traffic destined for port 80 or 443
+        to the local mitmproxy instance running on port 8080. You should
+        replace <b>en2</b> with the interface on which your test device will
+        appear.
+
+    </li>
+
+    <li> Configure pf with the rules:
+
+        <pre class="terminal">sudo pfctl -f pf.conf</pre>
+
+    </li>
+
+    <li> And now enable it:
+
+        <pre class="terminal">sudo pfctl -e</pre>
+
+    </li>
+
+    <li> Configure sudoers to allow mitmproxy to access pfctl. Edit the file
+    <b>/etc/sudoers</b> on your system as root. Add the following line to the end
+    of the file:
+
+    <pre>ALL ALL=NOPASSWD: /sbin/pfctl -s state</pre>
+
+    Note that this allows any user on the system to run the command
+    "/sbin/pfctl -s state" as root without a password. This only allows
+    inspection of the state table, so should not be an undue security risk. If
+    you're special feel free to tighten the restriction up to the user running
+    mitmproxy.</li>
+
+    <li> Fire up mitmproxy. You probably want a command like this:
+
+        <pre class="terminal">mitmproxy -T --host</pre>
+
+        The <b>-T</b> flag turns on transparent mode, and the <b>--host</b>
+        argument tells mitmproxy to use the value of the Host header for URL
+        display.
+
+    </li>
+
+    <li> Finally, configure your test device to use the host on which mitmproxy is
+    running as the default gateway.</li>
+
+
+</ol>

doc-src/tutorials/30second.html

@@ -1,50 +1,48 @@
-.. _30second:
-
-Client playback: a 30 second example
-====================================
 
 My local cafe is serviced by a rickety and unreliable wireless network,
 generously sponsored with ratepayers' money by our city council. After
 connecting, you  are redirected to an SSL-protected page that prompts you for a
 username and password. Once you've entered your details, you are free to enjoy
 the intermittent dropouts, treacle-like speeds and incorrectly configured
-transparent proxy.
+transparent proxy. 
 
 I tend to automate this kind of thing at the first opportunity, on the theory
 that time spent now will be more than made up in the long run. In this case, I
-might use Firebug_ to ferret out the form post
+might use [Firebug](http://getfirebug.com/) to ferret out the form post
 parameters and target URL, then fire up an editor to write a little script
-using Python's urllib_ to simulate a submission.
-That's a lot of futzing about. With mitmproxy we can do the job
+using Python's [urllib](http://docs.python.org/library/urllib.html) to simulate
+a submission. That's a lot of futzing about. With mitmproxy we can do the job
 in literally 30 seconds, without having to worry about any of the details.
 Here's how.
 
-1. Run mitmdump to record our HTTP conversation to a file.
-----------------------------------------------------------
+## 1. Run mitmdump to record our HTTP conversation to a file.
 
->>> mitmdump -w wireless-login
+<pre class="terminal">
+> mitmdump -w wireless-login
+</pre>
 
-2. Point your browser at the mitmdump instance.
------------------------------------------------
+## 2. Point your browser at the mitmdump instance. 
 
-I use a tiny Firefox addon called `Toggle Proxy`_ to switch quickly to and from mitmproxy.
-I'm assuming you've already :ref:`configured
+I use a tiny Firefox addon called [Toggle
+Proxy](https://addons.mozilla.org/en-us/firefox/addon/toggle-proxy-51740/) to
+switch quickly to and from mitmproxy. I'm assuming you've already [configured
 your browser with mitmproxy's SSL certificate
-authority <certinstall>`.
+authority](http://mitmproxy.org/doc/ssl.html).
+
+## 3. Log in as usual. 
 
-3. Log in as usual.
--------------------
 
 And that's it! You now have a serialized version of the login process in the
 file wireless-login, and you can replay it at any time like this:
 
->>> mitmdump -c wireless-login
+<pre class="terminal">
+> mitmdump -c wireless-login
+</pre>
 
-Embellishments
---------------
+## Embellishments
 
 We're really done at this point, but there are a couple of embellishments we
-could make if we wanted. I use wicd_ to
+could make if we wanted. I use [wicd](http://wicd.sourceforge.net/) to
 automatically join wireless networks I frequent, and it lets me specify a
 command to run after connecting. I used the client replay command above and
 voila! - totally hands-free wireless network startup.
@@ -54,13 +52,10 @@ forth. These add only a few moments to the time it takes to replay, but they're
 not really needed and I somehow feel compelled to trim them anyway. So, we fire up
 the mitmproxy console tool on our serialized conversation, like so:
 
->>> mitmproxy -r wireless-login
+<pre class="terminal">
+> mitmproxy -r wireless-login
+</pre>
 
-We can now go through and manually delete (using the :kbd:`d` keyboard shortcut)
-everything we want to trim. When we're done, we use :kbd:`w` to save the
+We can now go through and manually delete (using the __d__ keyboard shortcut)
+everything we want to trim. When we're done, we use __w__ to save the
 conversation back to the file.
-
-.. _Firebug: https://getfirebug.com/
-.. _urllib: https://docs.python.org/library/urllib.html
-.. _Toggle Proxy: https://addons.mozilla.org/en-us/firefox/addon/toggle-proxy-51740/
-.. _wicd: https://launchpad.net/wicd

doc-src/tutorials/gamecenter.html

@@ -0,0 +1,122 @@
+
+## The setup
+
+In this tutorial, I'm going to show you how simple it is to creatively
+interfere with Apple Game Center traffic using mitmproxy. To set things up, I
+registered my mitmproxy CA certificate with my iPhone - there's a [step by step
+set of instructions](@!urlTo("certinstall/ios.html")!@) elsewhere in this manual. I then
+started mitmproxy on my desktop, and configured the iPhone to use it as a
+proxy. 
+
+
+## Taking a look at the Game Center traffic
+
+Lets take a first look at the Game Center traffic. The game I'll use in this
+tutorial is [Super Mega
+Worm](http://itunes.apple.com/us/app/super-mega-worm/id388541990?mt=8) - a
+great little retro-apocalyptic sidescroller for the iPhone: 
+
+<center>
+    <img src="@!urlTo("tutorials/supermega.png")!@"/>
+</center>
+
+After finishing a game (take your time), watch the traffic flowing through
+mitmproxy:
+
+<center>
+    <img src="@!urlTo("tutorials/one.png")!@"/>
+</center>
+
+We see a bunch of things we might expect - initialisation, the retrieval of
+leaderboards and so forth. Then, right at the end, there's a POST to this
+tantalising URL:
+
+<pre>
+https://service.gc.apple.com/WebObjects/GKGameStatsService.woa/wa/submitScore
+</pre>
+
+The contents of the submission are particularly interesting:
+
+<!--(block|syntax("xml"))-->
+<plist version="1.0">
+  <dict>
+    <key>scores</key>
+    <array>
+      <dict>
+        <key>category</key>
+        <string>SMW_Adv_USA1</string>
+        <key>context</key>
+        <integer>0</integer>
+        <key>score-value</key>
+        <integer>0</integer>
+        <key>timestamp</key>
+        <integer>1363515361321</integer>
+      </dict>
+    </array>
+  </dict>
+</plist>
+<!--(end)-->
+
+This is a [property list](http://en.wikipedia.org/wiki/Property_list),
+containing an identifier for the game, a score (55, in this case), and a
+timestamp. Looks pretty simple to mess with.
+
+
+## Modifying and replaying the score submission
+
+Lets edit the score submission. First, select it in mitmproxy, then press
+__enter__ to view it. Make sure you're viewing the request, not the response -
+you can use __tab__ to flick between the two. Now press __e__ for edit. You'll
+be prompted for the part of the request you want to change - press __b__ for
+body.  Your preferred editor (taken from the EDITOR environment variable) will
+now fire up. Lets bump the score up to something a bit more ambitious:
+
+<!--(block|syntax("xml"))-->
+<plist version="1.0">
+  <dict>
+    <key>scores</key>
+    <array>
+      <dict>
+        <key>category</key>
+        <string>SMW_Adv_USA1</string>
+        <key>context</key>
+        <integer>0</integer>
+        <key>score-value</key>
+        <integer>2200272667</integer>
+        <key>timestamp</key>
+        <integer>1363515361321</integer>
+      </dict>
+    </array>
+  </dict>
+</plist>
+<!--(end)-->
+
+Save the file and exit your editor. 
+
+The final step is to replay this modified request. Simply press __r__ for
+replay.
+
+## The glorious result and some intrigue
+
+<center>
+    <img src="@!urlTo("tutorials/leaderboard.png")!@"/>
+</center>
+
+And that's it - according to the records, I am the greatest Super Mega Worm
+player of all time. 
+
+There's a curious addendum to this tale. When I first wrote this tutorial, all
+the top competitors' scores were the same: 2,147,483,647 (this is no longer the
+case, beacause there are now so many fellow cheaters using this tutorial). If
+you think that number seems familiar, you're right: it's 2^31-1, the maximum
+value you can fit into a signed 32-bit int. Now let me tell you another
+peculiar thing about Super Mega Worm - at the end of every game, it submits
+your highest previous score to the Game Center, not your current score.  This
+means that it stores your highscore somewhere, and I'm guessing that it reads
+that stored score back into a signed integer. So, if you _were_ to cheat by the
+relatively pedestrian means of modifying the saved score on your jailbroken
+phone, then 2^31-1 might well be the maximum score you could get. Then again,
+if the game itself stores its score in a signed 32-bit int, you could get the
+same score through perfect play, effectively beating the game. So, which is it
+in this case? I'll leave that for you to decide.
+

doc-src/tutorials/index.py

@@ -0,0 +1,6 @@
+from countershape import Page
+
+pages = [
+    Page("30second.html", "Client playback: a 30 second example"),
+    Page("gamecenter.html", "Setting highscores on Apple's GameCenter"),
+]