~ubuntu-branches/ubuntu/quantal/mitmproxy/quantal

« back to all changes in this revision

Viewing changes to doc/mitmproxy.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Delafond
  • Date: 2012-02-13 11:46:52 UTC
  • Revision ID: package-import@ubuntu.com-20120213114652-ug49uqn1be6w80h9
Tags: upstream-0.6
Import upstream version 0.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta  content="text/html; charset=utf-8" http-equiv="Content-Type"/>
 
3
 
 
4
 
 
5
<link  href="01-reset-fonts-grids-base.css" type="text/css" rel="StyleSheet"/>
 
6
<link  href="02-docstyle.css" type="text/css" rel="StyleSheet"/>
 
7
<link  href="syntax.css" type="text/css" rel="StyleSheet"/>
 
8
<title>mitmproxy</title></head><body><div id="doc">
 
9
    <div style="" id="hd" class="doc">
 
10
                <div id="nav">
 
11
                        <a href="intro.html">prev</a>
 
12
 |
 
13
            <a href="index.html">index</a> |
 
14
                        <a href="mitmdump.html">next</a>
 
15
 
 
16
        </div>
 
17
 
 
18
        <h1><a href="index.html">mitmproxy 0.6 docs</a></h1>
 
19
    </div>
 
20
    <div id="bd">
 
21
        <div id="yui-main">
 
22
            <div style="" class="yui-b">
 
23
                <h1>mitmproxy</h1>
 
24
                <p><strong>mitmproxy</strong> is a console tool that allows interactive examination and
 
25
modification of HTTP traffic. The <em>?</em> shortcut key shows complete documentation
 
26
on <strong>mitmproxy</strong>'s functionality.</p>
 
27
 
 
28
<h2>The interface: connection list</h2>
 
29
 
 
30
<p><img src="screenshots/mitmproxy.png"/></p>
 
31
 
 
32
<p>The connection list shows an index of captured flows in chronological order.
 
33
So, in this case, we can we can see that we visited <strong>gmail.com</strong>, which then
 
34
returned a 301 redirect to mail.google.com.</p>
 
35
 
 
36
<p>The statusbar at the bottom tells us that there are 11 flows in the view, that
 
37
we are using the "pretty" view mode (more on that below), and that the proxy is
 
38
bound to port 8080 of all interfaces.</p>
 
39
 
 
40
<p>Also visible is the <strong>Event log</strong>, which can be toggled on and off with the <em>v</em>
 
41
keyboard shortcut. This displays events like client connection information,
 
42
errors, and script output.</p>
 
43
 
 
44
<h2>Example: Interception</h2>
 
45
 
 
46
<p><strong>mitmproxy</strong>'s interception functionality lets you pause an HTTP request or
 
47
response, inspect and modify it, and then accept it to send it on to the server
 
48
or client. </p>
 
49
 
 
50
<h3>1: Set an interception pattern</h3>
 
51
 
 
52
<p><img src="screenshots/intercept-filt.png"/></p>
 
53
 
 
54
<p>We press <em>i</em> to set an interception pattern. In this case, the <strong>~q</strong> filter
 
55
pattern tells <strong>mitmproxy</strong> to intercept all requests. For complete filter
 
56
syntax, see the <a href="filters.html">Filter expressions</a> section of this
 
57
document, or the built-in help function in <strong>mitmproxy</strong>.</p>
 
58
 
 
59
<h3>2: Intercepted connections are indicated with a red exclamation mark:</h3>
 
60
 
 
61
<p><img src="screenshots/intercept-mid.png"/></p>
 
62
 
 
63
<h3>3: You can now view and modify the request:</h3>
 
64
 
 
65
<p><img src="screenshots/intercept-options.png"/></p>
 
66
 
 
67
<p>In this case, we viewed the request by selecting it, pressed <em>e</em> for "edit"
 
68
and <em>m</em> for "method" to change the HTTP request method.</p>
 
69
 
 
70
<h3>4: Accept the intercept to continue</h3>
 
71
 
 
72
<p><img src="screenshots/intercept-result.png"/></p>
 
73
 
 
74
<p>Finally, we press <em>a</em> to accept the modified request, which is then sent on to
 
75
the server. In this case, we changed the request from an HTTP GET to to
 
76
OPTIONS, and Google's server has responded with a 405 "Method not allowed". </p>
 
77
 
 
78
            </div>
 
79
        </div>
 
80
    </div>
 
81
    <div style="" id="ft" class="doc">
 
82
        <p>© mitmproxy project, 2011</p>
 
83
    </div>
 
84
</div>
 
85
</body></html>
 
 
b'\\ No newline at end of file'