Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-22 07:08:10 +00:00
Code Issues Projects Releases Wiki Activity
451 Commits 1 Branch 67 Tags 50 MiB
Python 83.2%
TypeScript 10.2%
JavaScript 5.1%
Less 0.7%
HTML 0.4%
Other 0.3%
760d303dfa
Go to file
Aldo Cortesi 760d303dfa Add README.txt for PyPi. 
Yes, this means we now maintain two complete README files that are identical
except for markup. We distribute with only README.txt, so README.mkd can
actually move in to the documentation tree at some point.
2012-02-25 13:16:30 +13:00
doc-src Docs update for new commandline and shortcut functionality. Also, typo fix. 2012-02-24 13:56:34 +08:00
examples Add two more examples: dup_and_replay.py and modify_querystring.py 2012-02-23 15:43:04 +13:00
libmproxy Merge remote-tracking branch 'remotes/runeh/master' into runeh 2012-02-25 13:02:12 +13:00
scripts Add a script to generate a contributors list, and use it to make a CONTRIBUTORS file. 2011-03-19 20:34:53 +13:00
test Unit test++. 2012-02-25 12:19:54 +13:00
.gitignore Simple record & playback functionality 2011-02-10 02:59:51 +01:00
CHANGELOG Confirm when we clear a request body to add a form. 2012-02-23 16:27:08 +13:00
CONTRIBUTORS Start preparing for 0.7 2012-02-19 22:43:05 +13:00
LICENSE Add an "SSL exception" to the license. 2011-06-02 10:43:11 +12:00
MANIFEST.in Add README.txt for PyPi. 2012-02-25 13:16:30 +13:00
mitmdump Address an issue that allows a malicious client to place certificate files in arbitrary directories. 2012-01-21 14:26:36 +13:00
mitmproxy Refactor console. 2012-02-07 16:39:37 +13:00
README.mkd Add README.txt for PyPi. 2012-02-25 13:16:30 +13:00
README.txt Add README.txt for PyPi. 2012-02-25 13:16:30 +13:00
setup.py Add README.txt for PyPi. 2012-02-25 13:16:30 +13:00
todo Start preparing for 0.7 2012-02-19 22:43:05 +13:00

README.txt 

**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.

**mitmdump** is the command-line version of mitmproxy, with the same
functionality but without the user interface. Think tcpdump for HTTP.

Complete documentation and a set of practical tutorials is included in the
distribution package, and is also available at `mitmproxy.org
<http://mitmproxy.org>`_.


Features
--------

- Intercept HTTP requests and responses and modify them on the fly.
- Save complete HTTP conversations for later replay and analysis.
- Replay the client-side of an HTTP conversations.
- Replay HTTP responses of a previously recorded server.
- Reverse proxy mode to forward traffic to a specified server.
- Make scripted changes to HTTP traffic using Python. 
- SSL certificates for interception are generated on the fly.


Download
--------

Releases and rendered documentation can be found on the mitmproxy website:

`mitmproxy.org <http://mitmproxy.org>`_

Source is hosted on github: 

`github.com/cortesi/mitmproxy <http://github.com/cortesi/mitmproxy>`_


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


Requirements
------------

* `Python <http://www.python.org>`_ 2.6.x or 2.7.x.
* `openssl <http://www.openssl.org/>`_ - installed by default on most systems.
* `urwid <http://excess.org/urwid/>`_ version 0.9.8 or newer.
* The test suite uses the `pry <http://github.com/cortesi/pry>`_ unit testing
  library.
* Rendering the documentation requires `countershape <http://github.com/cortesi/countershape>`_.

**mitmproxy** is tested and developed on OSX, Linux and OpenBSD. 

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.