Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An interactive SSL-capable intercepting HTTP proxy for penetration testers and software developers
JavaScript Python CSS HTML Other
Failed to load latest commit information.
doc-src Update docs to reflect current shortcut keys for features which have …
examples attach application protocol to connection
libmproxy fix tests
release update build script
test fix tests
web fix #615
.appveyor.yml add appveyor
.coveragerc Exclude main.py from coverage analysis
.dockerignore initial add of docker mitmproxy
.env improve autoenv script
.gitattributes web: filtering
.gitignore We're not ready for ES6
.landscape.yml synchronize metadata files across projects
.travis.yml Travis to Slack
CHANGELOG Changelog for v0.13
CONTRIBUTING.md Create CONTRIBUTING.md
CONTRIBUTORS bump version
Dockerfile match name of automated build base img
LICENSE GPLv3 -> MIT
MANIFEST.in Add netlib and libpathod as excludes in MANIFEST.in
README.mkd make build script amazing
README.txt Docs and Readme
dev merged with upstream changes in dev
dev.bat Merge branch 'master' into hardfailvenv
mitmdump Add coding style check, reformat.
mitmproxy Add coding style check, reformat.
mitmweb Super-basic outline for web io loop
requirements.txt Updated setup.py and moved requirements to examples section. Included…
setup.cfg fix pep8 config
setup.py make build script amazing

README.mkd

Build Status Code Health Coverage Status Downloads Latest Version Supported 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, tutorials and distribution packages can be found on the mitmproxy.org website:
mitmproxy.org.

Installation Instructions are available at mitmproxy.org/doc/install.html.

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:

$ 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
$ source ./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:

$ source ../venv.mitmproxy/bin/activate # ..\venv.mitmproxy\Scripts\activate.bat on Windows
$ nosetests ./test

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:

$ 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:

nosetests ./test

Please ensure that all patches are accompanied by matching changes in the test suite. The project maintains 100% test coverage.

Docs

Rendering the documentation requires countershape. After installation, you can render the documentation to the doc like this:

cshape doc-src doc

Something went wrong with that request. Please try again.