Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-23 00:01:36 +00:00
Code Issues Projects Releases Wiki Activity
538 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%
4e1bbc1156
Go to file
Aldo Cortesi 4e1bbc1156 Doc spellcheck.
2012-04-04 16:05:18 +12:00
doc-src Doc spellcheck. 2012-04-04 16:05:18 +12:00
examples Add two more examples: dup_and_replay.py and modify_querystring.py 2012-02-23 15:43:04 +13:00
libmproxy Android configuration docs. 2012-04-04 15:58:46 +12: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 Serialize requestcount for ClientConnect objects. 2012-04-03 22:37:24 +12:00
.gitignore Simple record & playback functionality 2011-02-10 02:59:51 +01:00
CHANGELOG Draft 0.8 changelog. 2012-04-04 11:46:56 +12:00
CONTRIBUTORS Final prep for 0.7. 2012-02-27 21:51:52 +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 Refactor proxy.Server to fix a crash when replaying with -n 2012-04-02 13:24:51 +12:00
mitmproxy Refactor proxy.Server to fix a crash when replaying with -n 2012-04-02 13:24:51 +12:00
README.mkd Add PIL dependencies to READMEs. 2012-04-04 09:55:14 +12:00
README.txt Add PIL dependencies to READMEs. 2012-04-04 09:55:14 +12:00
setup.py Expand SSL cert support 2012-04-02 16:21:23 +12: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_.


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_

Source is hosted on github: 

`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_ 2.6.x or 2.7.x.
* PyOpenSSL_ 0.12 or newer.
* pyasn1_ 0.1.2 or newer.
* urwid_  version 0.9.8 or newer.
* PIL_  version 1.1 or newer.
* The test suite uses the pry_ unit testing
  library.
* Rendering the documentation requires 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.

.. _mitmproxy.org: http://mitmproxy.org
.. _github.com/cortesi/mitmproxy: http://github.com/cortesi/mitmproxy
.. _python: http://www.python.org
.. _PyOpenSSL: http://pypi.python.org/pypi/pyOpenSSL
.. _pyasn1: http://pypi.python.org/pypi/pyasn1
.. _PIL: http://www.pythonware.com/products/pil/
.. _urwid: http://excess.org/urwid/
.. _pry: http://github.com/cortesi/pry
.. _countershape: http://github.com/cortesi/countershape