Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.96 KB

README.mkd

File metadata and controls

76 lines (50 loc) · 2.96 KB
Raw

Build Status Coverage Status

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.

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.

Installation

The recommended way to install mitmproxy is running pip install mitmproxy.
For convenience, we provide binary packages on mitmproxy.org.

Requirements

Optional packages for extended content decoding:

For convenience, all optional dependencies can be installed with pip install mitmproxy[contenviews]

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

The following components are needed if you plan to hack on mitmproxy:

  • The test suite requires the dev extra requirements listed in setup.py and pathod, version matching mitmproxy.
  • Rendering the documentation requires countershape.

For convenience, the following procedure is recommended to set up your environment:

$ git clone https://github.com/mitmproxy/mitmproxy.git
$ cd mitmproxy
$ pip install --src . -r requirements.txt

This installs the latest GitHub versions of mitmproxy, netlib and pathod into mitmproxy/. All other development dependencies save countershape are installed into their usual locations.

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