mitmproxy

Coverage Status Supported Python versions

This repository contains the mitmproxy and pathod projects.

mitmproxy is an interactive, SSL/TLS-capable intercepting proxy with a console interface for HTTP/1, HTTP/2, and WebSockets.

mitmdump is the command-line version of mitmproxy. Think tcpdump for HTTP.

mitmweb is a web-based interface for mitmproxy.

pathoc and pathod are perverse HTTP client and server applications designed to let you craft almost any conceivable HTTP request, including ones that creatively violate the standards.

Documentation & Help

General information, tutorials, and precompiled binaries can be found on the mitmproxy website.

mitmproxy documentation stable StackOverflow: mitmproxy

Join our developer chat on Slack if you would like to contribute to mitmproxy itself.

Installation

The installation instructions are Contributing

As an open source project, mitmproxy welcomes contributions of all forms. If you would like to bring the project forward, please consider contributing in the following areas:

• Maintenance: We are incredibly thankful for individuals who are stepping up and helping with maintenance. This includes (but is not limited to) triaging issues, reviewing pull requests and picking up stale ones, helping out other users on good first contributions. If you intend to work on a larger contribution to the project, please come talk to us first.

Development Setup

To get started hacking on mitmproxy, please install a recent version of Python (we require at least 3.6). The following commands should work on your system:

python3 --version
python3 -m pip --help
python3 -m venv --help

If all of this run successfully, do the following:

git clone https://github.com/mitmproxy/mitmproxy.git
cd mitmproxy
./dev.sh # "powershell .\dev.ps1" on Windows

The dev script will create a

The main executables for the project - mitmdump, mitmproxy, mitmweb, pathod, and pathoc - 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:

. venv/bin/activate # "venv\Scripts\activate" on Windows
mitmdump --version

Testing

If you've followed the procedure above, you already have all the development requirements installed, and you can run the full test suite with tox -e py # runs Python tests tox -e lint # checks code style

For speedier testing, we recommend you run cd test/mitmproxy/addons pytest --cov mitmproxy.addons.anticache --cov-report term-missing --looponfail test_anticache.py

Pytest does not check the code style, so you want to run tox -e lint again before committing.

Documentation

The following tools are required to build the mitmproxy docs:

• modd
• cd docs yarn modd

  Code Style

  Keeping to a consistent code style throughout the project makes it easier to contribute and collaborate. Please stick to the guidelines in Google Style Guide unless there's a very good reason not to.

  This is automatically enforced on every PR. If we detect a linting error, the PR checks will fail and block merging. You can run our lint checks yourself with the following command:

  tox -e lint