<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
<link href="01-bootstrap.min.css" type="text/css" rel="StyleSheet"/>
<link href="02-docstyle.css" type="text/css" rel="StyleSheet"/>
<link href="syntax.css" type="text/css" rel="StyleSheet"/>
<title>mitmproxy 0.9 - Introduction</title></head><body><div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="index.html">mitmproxy 0.9 docs</a>
</div><!--/.nav-collapse -->
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="span3">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="active"><a href="index.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li><a href="howmitmproxy.html">How mitmproxy works</a></li>
<li class="nav-header">Tools</li>
<li><a href="mitmproxy.html">mitmproxy</a></li>
<li><a href="mitmdump.html">mitmdump</a></li>
<li class="nav-header">Features</li>
<li><a href="features/anticache.html">Anticache</a></li>
<li><a href="features/clientreplay.html">Client-side replay</a></li>
<li><a href="features/filters.html">Filter expressions</a></li>
<li><a href="features/proxyauth.html">Proxy Authentication</a></li>
<li><a href="features/replacements.html">Replacements</a></li>
<li><a href="features/serverreplay.html">Server-side replay</a></li>
<li><a href="features/setheaders.html">Set Headers</a></li>
<li><a href="features/sticky.html">Sticky cookies and auth</a></li>
<li><a href="features/reverseproxy.html">Reverse proxy mode</a></li>
<li><a href="features/upstreamcerts.html">Upstream Certs</a></li>
<li class="nav-header">Installing Certificates</li>
<li><a href="ssl.html">Overview</a></li>
<li><a href="certinstall/firefox.html">Firefox</a></li>
<li><a href="certinstall/osx.html">OSX</a></li>
<li><a href="certinstall/windows7.html">Windows 7</a></li>
<li><a href="certinstall/ios.html">IOS</a></li>
<li><a href="certinstall/ios-simulator.html">IOS Simulator</a></li>
<li><a href="certinstall/android.html">Android</a></li>
<li class="nav-header">Transparent Proxying</li>
<li><a href="transparent.html">Overview</a></li>
<li><a href="transparent/linux.html">Linux</a></li>
<li><a href="transparent/osx.html">OSX</a></li>
<li class="nav-header">Tutorials</li>
<li><a href="tutorials/30second.html">Client playback: a 30 second example</a></li>
<li><a href="tutorials/gamecenter.html">Setting highscores on Apple's GameCenter</a></li>
<li class="nav-header">Scripting mitmproxy</li>
<li><a href="scripting/inlinescripts.html">Inline Scripts</a></li>
<li><a href="scripting/libmproxy.html">libmproxy</a></li>
<li class="nav-header">Hacking</li>
<li><a href="dev/testing.html">Testing</a></li>
</ul>
</div>
</div>
<div class="span9">
<div class="page-header">
<h1>Introduction</h1>
</div>
<p><strong>mitmproxy</strong> is an interactive, SSL-capable man-in-the-middle proxy for HTTP
with a console interface.</p>
<p><strong>mitmdump</strong> is the command-line version of mitmproxy. Think tcpdump for HTTP.</p>
<p><strong>libmproxy</strong> is the library that mitmproxy and mitmdump are built on.</p>
<p>Documentation, tutorials and distribution packages can be found on the
mitmproxy.org website:</p>
<p><a href="http://mitmproxy.org">mitmproxy.org</a>.</p>
<h2>Features</h2>
<ul>
<li>Intercept HTTP requests and responses and modify them on the fly.</li>
<li>Save complete HTTP conversations for later replay and analysis.</li>
<li>Replay the client-side of an HTTP conversations.</li>
<li>Replay HTTP responses of a previously recorded server.</li>
<li>Reverse proxy mode to forward traffic to a specified server.</li>
<li>Transparent proxy mode on OSX and Linux.</li>
<li>Make scripted changes to HTTP traffic using Python.</li>
<li>SSL certificates for interception are generated on the fly.</li>
<li>And much, much more.</li>
</ul>
<h2>Requirements</h2>
<ul>
<li><a href="http://www.python.org">Python</a> 2.7.x.</li>
<li><a href="http://pypi.python.org/pypi/netlib">netlib</a>, version matching mitmproxy.</li>
<li><a href="http://pypi.python.org/pypi/pyOpenSSL">PyOpenSSL</a> 0.13 or newer.</li>
<li><a href="http://pypi.python.org/pypi/pyasn1">pyasn1</a> 0.1.2 or newer.</li>
<li><a href="http://excess.org/urwid/">urwid</a> version 1.1 or newer.</li>
<li><a href="http://www.pythonware.com/products/pil/">PIL</a> version 1.1 or newer.</li>
<li><a href="http://lxml.de/">lxml</a> version 2.3 or newer.</li>
<li><a href="http://flask.pocoo.org/">flask</a> version 0.9 or newer.</li>
</ul>
<p>Optional, for extended content decoding:</p>
<ul>
<li><a href="http://www.pyamf.org/">PyAMF</a> version 0.6.1 or newer.</li>
<li><a href="https://code.google.com/p/protobuf/">protobuf</a> version 2.5.0 or newer.</li>
</ul>
<p><strong>mitmproxy</strong> is tested and developed on OSX, Linux and OpenBSD. Windows is not
officially supported at the moment.</p>
<h2>Hacking</h2>
<p>The following components are needed if you plan to hack on mitmproxy:</p>
<ul>
<li>The test suite uses the <a href="http://readthedocs.org/docs/nose/en/latest/">nose</a> unit testing
framework and requires <a href="http://pathod.org">pathod</a> and <a href="http://flask.pocoo.org/">flask</a>.</li>
<li>Rendering the documentation requires <a href="http://github.com/cortesi/countershape">countershape</a>.</li>
</ul>
<p>For convenience, all dependencies save countershape, can be installed from pypi to a virtualenv with 'pip install -r requirements.txt'.</p>
<p>Please ensure that all patches are accompanied by matching changes in the test
suite. The project maintains 100% test coverage.</p>
</div>
</div>
<hr>
<footer>
<p>© mitmproxy project, 2013</p>
</footer>
</div>
</body></html>
