2012-02-08 10:14:12 +00:00
# Please note that the master branch of mitmproxy is currently under heavy development. Feel free to test things out, but you may want to use a release.
2012-02-08 10:12:04 +00:00
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
functionality but without the frills. Think tcpdump for HTTP.
2011-08-04 22:23:32 +00:00
Both tools are fully documentented in the commandline _--help_ flag, and, in
the case of __mitmproxy__ , a built-in help page accessible through the _?_
2011-03-17 20:04:49 +00:00
keyboard shortcut.
2010-02-16 05:25:03 +00:00
2011-03-15 22:09:10 +00:00
Capabilities
2011-03-19 06:47:19 +00:00
------------
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.
- 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.
2011-08-04 22:23:32 +00:00
* [openssl ](http://www.openssl.org/ ) - installed by default on most systems.
2011-03-28 22:53:13 +00:00
* [urwid ](http://excess.org/urwid/ ) version 0.9.8 or newer.
2010-02-16 04:09:07 +00:00
* The test suite uses the [pry ](http://github.com/cortesi/pry ) unit testing
library.
2011-03-28 22:53:13 +00:00
* Rendering the documentation requires [countershape ](http://github.com/cortesi/countershape ).
__mitmproxy__ is tested and developed on OSX, Linux and OpenBSD.
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.
