<!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>Introduction</title></head><body><div class="navbar">
<div class="navbar-inner">
<div class="container-fluid">
<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-fluid">
<div class="row-fluid">
<div class="span3">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="active"><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li><a href="mitmproxy.html">mitmproxy</a></li>
<li><a href="mitmdump.html">mitmdump</a></li>
<li><a href="faq.html">FAQ</a></li>
<li class="nav-header">Features</li>
<li><a href="clientreplay.html">Client-side replay</a></li>
<li><a href="serverreplay.html">Server-side replay</a></li>
<li><a href="sticky.html">Sticky cookies and auth</a></li>
<li><a href="reverseproxy.html">Reverse proxy mode</a></li>
<li><a href="upstreamcerts.html">Upstream Certs</a></li>
<li><a href="replacements.html">Replacements</a></li>
<li><a href="anticache.html">Anticache</a></li>
<li><a href="filters.html">Filter expressions</a></li>
<li class="nav-header">SSL interception</li>
<li><a href="ssl.html">SSL 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/android.html">Android</a></li>
<li class="nav-header">Transparent Proxying</li>
<li><a href="transparent.html">Transparent 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>
</ul>
</div>
</div>
<div class="span9">
<h1>Introduction</h1>
<p><strong>mitmproxy</strong> 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.</p>
<p><strong>mitmdump</strong> is the command-line version of mitmproxy, with the same
functionality but without the user interface. Think tcpdump for HTTP.</p>
<p>Complete documentation and a set of practical tutorials is included in the
distribution package, and is also available at
<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>Make scripted changes to HTTP traffic using Python.</li>
<li>SSL certificates for interception are generated on the fly.</li>
</ul>
<h2>Download</h2>
<p>Releases and rendered documentation can be found on the mitmproxy website:</p>
<p><a href="http://mitmproxy.org">mitmproxy.org</a></p>
<p>Source is hosted on github:</p>
<p><a href="http://github.com/cortesi/mitmproxy">github.com/cortesi/mitmproxy</a></p>
<h2>Community</h2>
<p>Come join us in the #mitmproxy channel on the OFTC IRC network
(irc://irc.oftc.net:6667).</p>
<p>We also have a mailing list, hosted here:</p>
<pre><code>http://groups.google.com/group/mitmproxy
</code></pre>
<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/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 0.9.8 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://pypi.python.org/pypi/netlib">netlib</a> 0.1 or newer.</li>
</ul>
<p>The following auxiliary components may be 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="https://github.com/Lispython/human_curl">human_curl</a> and
<a href="http://pypi.python.org/pypi/pathod">pathod</a>.</li>
<li>Rendering the documentation requires <a href="http://github.com/cortesi/countershape">countershape</a>.</li>
</ul>
<p><strong>mitmproxy</strong> is tested and developed on OSX, Linux and OpenBSD. Windows is not
supported at the moment.</p>
<p>You should also make sure that your console environment is set up with the
following:</p>
<ul>
<li>EDITOR environment variable to determine the external editor.</li>
<li>PAGER environment variable to determine the external pager.</li>
<li>Appropriate entries in your mailcap files to determine external
viewers for request and response contents.</li>
</ul>
</div>
</div><!--/row-->
<hr>
<footer>
<p>© mitmproxy project, 2012</p>
</footer>
</div><!--/.fluid-container-->
</body></html>
