<!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-reset-fonts-grids-base.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>libmproxy: mitmproxy as a library</title></head><body><div id="doc">
<div style="" id="hd" class="doc">
<div id="nav">
<a href="certinstall/android.html">prev</a>
|
<a href="index.html">index</a> |
<a href="tutorials/30second.html">next</a>
</div>
<h1><a href="index.html">mitmproxy 0.9 docs</a></h1>
</div>
<div id="bd">
<div id="yui-main">
<div style="" class="yui-b">
<h1>libmproxy: mitmproxy as a library</h1>
<p>All of mitmproxy's basic functionality is exposed through the <strong>libmproxy</strong>
library. The example below shows a simple implementation of the "sticky cookie"
functionality included in the interactive mitmproxy program. Traffic is
monitored for <strong>cookie</strong> and <strong>set-cookie</strong> headers, and requests are rewritten
to include a previously seen cookie if they don't already have one. In effect,
this lets you log in to a site using your browser, and then make subsequent
requests using a tool like <strong>curl</strong>, which will then seem to be part of the
authenticated session.</p>
<div class="example"><div class="highlight"><pre><span class="c">#!/usr/bin/env python</span>
<span class="sd">"""</span>
<span class="sd"> This example builds on mitmproxy's base proxying infrastructure to</span>
<span class="sd"> implement functionality similar to the "sticky cookies" option. This is at</span>
<span class="sd"> a lower level than the Flow mechanism, so we're dealing directly with</span>
<span class="sd"> request and response objects.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">libmproxy</span> <span class="kn">import</span> <span class="n">controller</span><span class="p">,</span> <span class="n">proxy</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="k">class</span> <span class="nc">StickyMaster</span><span class="p">(</span><span class="n">controller</span><span class="o">.</span><span class="n">Master</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">server</span><span class="p">):</span>
<span class="n">controller</span><span class="o">.</span><span class="n">Master</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">server</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stickyhosts</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">controller</span><span class="o">.</span><span class="n">Master</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">KeyboardInterrupt</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">shutdown</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">handle_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
<span class="n">hid</span> <span class="o">=</span> <span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">host</span><span class="p">,</span> <span class="n">msg</span><span class="o">.</span><span class="n">port</span><span class="p">)</span>
<span class="k">if</span> <span class="n">msg</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">"cookie"</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stickyhosts</span><span class="p">[</span><span class="n">hid</span><span class="p">]</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">"cookie"</span><span class="p">]</span>
<span class="k">elif</span> <span class="n">hid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">stickyhosts</span><span class="p">:</span>
<span class="n">msg</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">"cookie"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stickyhosts</span><span class="p">[</span><span class="n">hid</span><span class="p">]</span>
<span class="n">msg</span><span class="o">.</span><span class="n">_ack</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">handle_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
<span class="n">hid</span> <span class="o">=</span> <span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">host</span><span class="p">,</span> <span class="n">msg</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">port</span><span class="p">)</span>
<span class="k">if</span> <span class="n">msg</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">"set-cookie"</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stickyhosts</span><span class="p">[</span><span class="n">hid</span><span class="p">]</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">"set-cookie"</span><span class="p">]</span>
<span class="n">msg</span><span class="o">.</span><span class="n">_ack</span><span class="p">()</span>
<span class="n">config</span> <span class="o">=</span> <span class="n">proxy</span><span class="o">.</span><span class="n">ProxyConfig</span><span class="p">(</span>
<span class="n">cacert</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s">"~/.mitmproxy/mitmproxy-ca.pem"</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">server</span> <span class="o">=</span> <span class="n">proxy</span><span class="o">.</span><span class="n">ProxyServer</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="mi">8080</span><span class="p">)</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">StickyMaster</span><span class="p">(</span><span class="n">server</span><span class="p">)</span>
<span class="n">m</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
</pre></div>
<div class="example_legend">(examples/stickycookies)</div></div>
</div>
</div>
</div>
<div style="" id="ft" class="doc">
<p>© mitmproxy project, 2012</p>
</div>
</div>
</body></html>
