2011-08-04 22:23:32 +00:00
|
|
|
__mitmproxy__ is an SSL-capable man-in-the-middle proxy for HTTP. It provides a
|
|
|
|
|
console interface that allows traffic flows to be inspected and edited on the
|
|
|
|
|
fly.
|
2011-02-20 23:11:41 +00:00
|
|
|
|
2011-03-17 20:04:49 +00:00
|
|
|
__mitmdump__ is the command-line version of mitmproxy, with the same
|
2012-02-20 23:32:56 +00:00
|
|
|
functionality but without the user interface. Think tcpdump for HTTP.
|
2011-03-17 20:04:49 +00:00
|
|
|
|
2012-02-25 00:16:30 +00:00
|
|
|
Complete documentation and a set of practical tutorials is included in the
|
|
|
|
|
distribution package, and is also available at
|
|
|
|
|
[mitmproxy.org](http://mitmproxy.org).
|
2010-02-16 05:25:03 +00:00
|
|
|
|
|
|
|
|
|
2012-02-19 09:43:05 +00:00
|
|
|
Features
|
|
|
|
|
--------
|
2010-02-16 05:25:03 +00:00
|
|
|
|
2011-03-15 22:09:10 +00:00
|
|
|
- Intercept HTTP requests and responses and modify them on the fly.
|
|
|
|
|
- Save complete HTTP conversations for later replay and analysis.
|
2011-03-17 20:04:49 +00:00
|
|
|
- Replay the client-side of an HTTP conversations.
|
2011-03-18 22:26:51 +00:00
|
|
|
- Replay HTTP responses of a previously recorded server.
|
2012-02-20 23:32:56 +00:00
|
|
|
- Reverse proxy mode to forward traffic to a specified server.
|
2011-03-18 22:26:51 +00:00
|
|
|
- Make scripted changes to HTTP traffic using Python.
|
|
|
|
|
- SSL certificates for interception are generated on the fly.
|
2011-01-24 21:59:50 +00:00
|
|
|
|
|
|
|
|
|
2010-02-16 05:25:03 +00:00
|
|
|
Download
|
2011-03-19 06:47:19 +00:00
|
|
|
--------
|
2010-02-16 04:09:07 +00:00
|
|
|
|
2011-03-19 06:47:19 +00:00
|
|
|
Releases and rendered documentation can be found on the mitmproxy website:
|
2010-02-16 04:09:07 +00:00
|
|
|
|
2011-03-19 06:47:19 +00:00
|
|
|
[mitmproxy.org](http://mitmproxy.org)
|
|
|
|
|
|
|
|
|
|
Source is hosted on github:
|
|
|
|
|
|
|
|
|
|
[github.com/cortesi/mitmproxy](http://github.com/cortesi/mitmproxy)
|
2010-02-16 04:09:07 +00:00
|
|
|
|
|
|
|
|
|
2011-08-06 21:52:13 +00:00
|
|
|
Community
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Come join us in the #mitmproxy channel on the OFTC IRC network
|
|
|
|
|
(irc://irc.oftc.net:6667).
|
|
|
|
|
|
|
|
|
|
We also have a mailing list, hosted here:
|
|
|
|
|
|
|
|
|
|
http://groups.google.com/group/mitmproxy
|
|
|
|
|
|
|
|
|
|
|
2010-02-16 04:09:07 +00:00
|
|
|
Requirements
|
2011-03-19 06:47:19 +00:00
|
|
|
------------
|
2010-02-16 04:09:07 +00:00
|
|
|
|
2011-03-28 22:53:13 +00:00
|
|
|
* [Python](http://www.python.org) 2.6.x or 2.7.x.
|
2012-08-08 19:38:02 +00:00
|
|
|
* [PyOpenSSL](http://pypi.python.org/pypi/pyOpenSSL) 0.13 or newer.
|
2012-03-11 01:41:03 +00:00
|
|
|
* [pyasn1](http://pypi.python.org/pypi/pyasn1) 0.1.2 or newer.
|
2011-03-28 22:53:13 +00:00
|
|
|
* [urwid](http://excess.org/urwid/) version 0.9.8 or newer.
|
2012-04-03 21:55:14 +00:00
|
|
|
* [PIL](http://www.pythonware.com/products/pil/) version 1.1 or newer.
|
2012-04-09 03:15:41 +00:00
|
|
|
* [lxml](http://lxml.de/) version 2.3 or newer.
|
2012-07-15 20:42:07 +00:00
|
|
|
* [netlib](http://pypi.python.org/pypi/netlib) 0.1 or newer.
|
2012-04-09 03:15:41 +00:00
|
|
|
|
|
|
|
|
The following auxiliary components may be needed if you plan to hack on
|
|
|
|
|
mitmproxy:
|
|
|
|
|
|
2012-06-09 01:55:55 +00:00
|
|
|
* The test suite uses the [nose](http://readthedocs.org/docs/nose/en/latest/) unit testing
|
2012-07-15 20:42:16 +00:00
|
|
|
framework and requires [human_curl](https://github.com/Lispython/human_curl) and
|
|
|
|
|
[pathod](http://pypi.python.org/pypi/pathod).
|
2011-03-28 22:53:13 +00:00
|
|
|
* Rendering the documentation requires [countershape](http://github.com/cortesi/countershape).
|
|
|
|
|
|
2012-04-09 03:15:41 +00:00
|
|
|
__mitmproxy__ is tested and developed on OSX, Linux and OpenBSD. Windows is not
|
|
|
|
|
supported at the moment.
|
2010-02-16 04:09:07 +00:00
|
|
|
|
|
|
|
|
You should also make sure that your console environment is set up with the
|
|
|
|
|
following:
|
|
|
|
|
|
|
|
|
|
* EDITOR environment variable to determine the external editor.
|
|
|
|
|
* PAGER environment variable to determine the external pager.
|
|
|
|
|
* Appropriate entries in your mailcap files to determine external
|
|
|
|
|
viewers for request and response contents.
|
