mitmproxy/README.mkd

50 lines
1.8 KiB
Markdown
Raw Normal View History

__mitmproxy__ is an SSL-capable, intercepting HTTP proxy. 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.
Both tools are fully documentented in the commandline __--help__ flag, and, in
the case of __mitmproxy__, a built-in help page accessible through the __?__
keyboard shortcut.
2010-02-16 05:25:03 +00:00
2011-03-15 22:09:10 +00:00
Capabilities
============
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-15 22:09:10 +00:00
========
2010-02-16 04:09:07 +00:00
2011-02-20 23:11:41 +00:00
Releases can be found here: http://corte.si/projects.html
2010-02-16 04:09:07 +00:00
Source is hosted here: http://github.com/cortesi/mitmproxy
Requirements
2011-03-15 22:09:10 +00:00
============
2010-02-16 04:09:07 +00:00
2010-02-24 17:32:59 +00:00
* A recent [Python](http://www.python.org) interpreter.
2010-02-16 05:25:03 +00:00
* SSL certificates are generated using [openssl](http://www.openssl.org/)
* The curses interface relies on version 0.9.8 or newer of the
[urwid](http://excess.org/urwid/) library.
2010-02-16 04:09:07 +00:00
* The test suite uses the [pry](http://github.com/cortesi/pry) unit testing
library.
* mitmproxy is tested and developed on OSX, Linux and OpenBSD. You may be able
to get it running using Cygwin on Windows, but don't count on it.
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.