diff options
| author | Aldo Cortesi <aldo@nullcube.com> | 2011-02-02 10:25:40 +1300 |
|---|---|---|
| committer | Aldo Cortesi <aldo@nullcube.com> | 2011-02-02 10:25:40 +1300 |
| commit | 8d37ff81e6e256180fdb8e266df4f861e8593c82 (patch) | |
| tree | 063db6581e375932c399d35a504f5a2574ecf173 /README | |
| parent | df9d8832fbe881ab02fcebb0917f393b78455180 (diff) | |
| download | mitmproxy-8d37ff81e6e256180fdb8e266df4f861e8593c82.tar.gz mitmproxy-8d37ff81e6e256180fdb8e266df4f861e8593c82.tar.bz2 mitmproxy-8d37ff81e6e256180fdb8e266df4f861e8593c82.zip | |
README -> README.mkd
Diffstat (limited to 'README')
| -rw-r--r-- | README | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/README b/README deleted file mode 100644 index aab92877..00000000 --- a/README +++ /dev/null @@ -1,60 +0,0 @@ -__mitmproxy__ is an interactive SSL-capable intercepting HTTP proxy. It lets -you to observe, modify and replay requests and responses on the fly. The -underlying library that mitmproxy is built on can also be used to do these -things programmatically. - -By default, mitmproxy starts up with a mutt-like interactive curses interface - -the built-in help page (which you can view by pressing "?") will tell you -everything you need to know. Note that requests and responses are stored -in-memory until you delete them, so leaving mitmproxy running indefinitely or -requesting very large amounts of data through it is a bad idea. - -SSL ---- - -The first time mitmproxy is started, it will generate a bogus SSL certificate -(the default location is ~/.mitmproxy/cert.pem). This certificate will be used -for the browser-side of intercepted traffic. Because it won't match any domain -you visit, and won't verify against any certificate authority, you will have to -add an exception for each site you visit. SSL requests are intercepted by -simply assuming that all CONNECT requests are https. The connection from the -browser is wrapped in SSL, and we read the request by pretending to be the -connecting server. We then open an SSL request to the destination server, and -replay the request. - - -Documentation -------------- - -A rendered version of the docs for the latest release can be found here: - -http://corte.si/projects - - -Download --------- - -Releases can be found here: http://corte.si/projects - -Source is hosted here: http://github.com/cortesi/mitmproxy - - -Requirements ------------- - -* A recent [Python](http://www.python.org) interpreter. -* 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. -* The test suite uses the [pry](http://github.com/cortesi/pry) unit testing - library. - -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. - - |