Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-27 02:24:18 +00:00
Code Issues Projects Releases Wiki Activity

prettify html docs

Browse Source
This commit is contained in:
Thomas Kriechbaumer 2015-06-22 15:12:20 +02:00
parent 5c0f0c2c22
commit 01f0982968
23 changed files with 641 additions and 656 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
libpathod/templates/about.html
View File

@ -1,30 +1,22 @@
{% extends "frame.html" %} {% extends "frame.html" %} {% block body %}
{% block body %}
<section> <section>
<div class="page-header"> <div class="page-header">
<h1> <h1>About</h1>
About </div>
</h1> <div class="row">
</div> <div class="span6">
<div class="row"> <div>
<div class="span6"> <p>pathod is developed by <a href="http://corte.si">Aldo Cortesi</a>.</p>
<div> </div>
<p>pathod is developed by <a href="http://corte.si">Aldo
Cortesi</a>.</p>
</div>
<div> <div>
<ul> <ul>
<li>email: <a href="mailto:aldo@corte.si">aldo@corte.si</a></li> <li>email: <a href="mailto:aldo@corte.si">aldo@corte.si</a></li>
<li>twitter: <a href="http://twitter.com/cortesi">@cortesi</a></li> <li>twitter: <a href="http://twitter.com/cortesi">@cortesi</a></li>
<li>github: <a href="https://github.com/cortesi">github.com/cortesi</a></li> <li>github: <a href="https://github.com/cortesi">github.com/cortesi</a></li>
</ul> </ul>
</div>
</div> </div>
</div> </div>
</div>
</section> </section>
{% endblock %} {% endblock %}

18
libpathod/templates/docframe.html
View File

@ -1,26 +1,26 @@
{% extends "layout.html" %} {% extends "layout.html" %}
{% macro subs(s) %} {% macro subs(s) %}
{% if subsection == s %} class="active" {% endif %} {% if subsection == s %}
class="active"
{% endif %}
{% endmacro %} {% endmacro %}
{% block content %} {% block content %}
<div class="row"> <div class="row">
<div class="span3"> <div class="span3">
<div class="well sidebar-nav"> <div class="well sidebar-nav">
<ul class="nav nav-list"> <ul class="nav nav-list">
<li {{subs("pathod")}}><a href="/docs/pathod">pathod</a></li> <li {{subs( "pathod")}}><a href="/docs/pathod">pathod</a></li>
<li {{subs("pathoc")}}><a href="/docs/pathoc">pathoc</a></li> <li {{subs( "pathoc")}}><a href="/docs/pathoc">pathoc</a></li>
<li {{subs("lang")}}><a href="/docs/language">language</a></li> <li {{subs( "lang")}}><a href="/docs/language">language</a></li>
<li {{subs("libpathod")}}><a href="/docs/libpathod">libpathod</a></li> <li {{subs( "libpathod")}}><a href="/docs/libpathod">libpathod</a></li>
<li {{subs("test")}}><a href="/docs/test">libpathod.test</a></li> <li {{subs( "test")}}><a href="/docs/test">libpathod.test</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div class="span9"> <div class="span9">
{% block body %} {% block body %} {% endblock %}
{% endblock %}
</div> </div>
</div> </div>
{% endblock %} {% endblock %}

274
libpathod/templates/docs_lang.html
View File

@ -1,17 +1,15 @@
{% extends "docframe.html" %} {% extends "docframe.html" %} {% block body %}
{% block body %}
<div class="page-header"> <div class="page-header">
<h1> <h1>
Language Spec Language Spec
<small>The mini-language at the heart of pathoc and pathod.</small> <small>The mini-language at the heart of pathoc and pathod.</small>
</h1> </h1>
</div> </div>
<ul class="nav nav-tabs"> <ul class="nav nav-tabs">
<li class="active" ><a href="#specifying_requests" data-toggle="tab">HTTP Requests</a></li> <li class="active"><a href="#specifying_requests" data-toggle="tab">HTTP Requests</a></li>
<li><a href="#specifying_responses" data-toggle="tab">HTTP Responses</a></li> <li><a href="#specifying_responses" data-toggle="tab">HTTP Responses</a></li>
<li><a href="#websockets" data-toggle="tab">Websocket Frames</a></li> <li><a href="#websockets" data-toggle="tab">Websocket Frames</a></li>
</ul> </ul>
<div class="tab-content"> <div class="tab-content">
@ -28,151 +26,171 @@
<section id="features"> <section id="features">
<div class="page-header"> <div class="page-header">
<h1>Features</h1> <h1>Features</h1>
</div> </div>
<a id="offsetspec"></a> <a id="offsetspec"></a>
<h2>OFFSET</h2> <h2>OFFSET</h2>
<p>Offsets are calculated relative to the base message, before any <p>
injections or other transforms are applied. They have 3 flavors:</p> Offsets are calculated relative to the base message, before any injections or other transforms
are applied. They have 3 flavors:
</p>
<ul> <ul>
<li>An integer byte offset </li> <li>An integer byte offset </li>
<li><b>r</b> for a random location</li> <li><b>r</b> for a random location</li>
<li><b>a</b> for the end of the message</li> <li><b>a</b> for the end of the message</li>
</ul> </ul>
<a id="valuespec"></a> <a id="valuespec"></a>
<h2>VALUE</h2> <h2>VALUE</h2>
<h3>Literals</h3> <h3>Literals</h3>
<p>Literal values are specified as a quoted strings: </p> <p>Literal values are specified as a quoted strings: </p>
<pre class="example">"foo"</pre> <pre class="example">"foo"</pre>
<p>Either single or double quotes are accepted, and quotes can be escaped with <p>
backslashes within the string:</p> Either single or double quotes are accepted, and quotes can be escaped with backslashes
within the string:
</p>
<pre class="example">'fo\'o'</pre> <pre class="example">'fo\'o'</pre>
<p>Literal values can contain Python-style backslash escape sequences:</p> <p>Literal values can contain Python-style backslash escape sequences:</p>
<pre class="example">'foo\r\nbar'</pre> <pre class="example">'foo\r\nbar'</pre>
<h3>Files</h3>
<p>
You can load a value from a specified file path. To do so, you have to specify a _staticdir_
option to pathod on the command-line, like so:
</p>
<pre class="example">pathod -d ~/myassets</pre>
<p>
All paths are relative paths under this directory. File loads are indicated by starting
the value specifier with the left angle bracket:
</p>
<pre class="example">&lt;my/path</pre>
<p>The path value can also be a quoted string, with the same syntax as literals:</p>
<pre class="example">&lt;"my/path"</pre>
<h3>Files</h3> <h3>Generated values</h3>
<p>You can load a value from a specified file path. To do so, you have to specify <p>
a _staticdir_ option to pathod on the command-line, like so: </p> An @-symbol lead-in specifies that generated data should be used. There are two components
to a generator specification - a size, and a data type. By default pathod assumes
a data type of "bytes".
</p>
<pre class="example">pathod -d ~/myassets</pre> <p>Here's a value specifier for generating 100 bytes:
<p>All paths are relative paths under this directory. File loads are indicated by <pre class="example">@100</pre>
starting the value specifier with the left angle bracket: </p>
<pre class="example">&lt;my/path</pre></p> <p>
You can use standard suffixes to indicate larger values. Here, for instance, is a specifier
for generating 100 megabytes:
</p>
<p>The path value can also be a quoted string, with the same syntax as literals:</p> <pre class="example">@100m</pre>
<pre class="example">&lt;"my/path"</pre> <p>
Data is generated and served efficiently - if you really want to send a terabyte of data
to a client, pathod can do it. The supported suffixes are:
</p>
<table class="table table-bordered">
<tbody>
<tr>
<td>b</td>
<td>1024**0 (bytes)</td>
</tr>
<tr>
<td>k</td>
<td>1024**1 (kilobytes)</td>
</tr>
<tr>
<td>m</td>
<td>1024**2 (megabytes)</td>
</tr>
<tr>
<td>g</td>
<td>1024**3 (gigabytes)</td>
</tr>
<tr>
<td>t</td>
<td>1024**4 (terabytes)</td>
</tr>
</tbody>
</table>
<h3>Generated values</h3> <p>
Data types are separated from the size specification by a comma. This specification generates
100mb of ASCII:
</p>
<p>An @-symbol lead-in specifies that generated data should be used. There are two <pre class="example">@100m,ascii</pre>
components to a generator specification - a size, and a data type. By default
pathod assumes a data type of "bytes". </p>
<p>Here's a value specifier for generating 100 bytes: <p>Supported data types are:</p>
<pre class="example">@100</pre></p> <table class="table table-bordered">
<tbody>
<p>You can use standard suffixes to indicate larger values. Here, for instance, is <tr>
a specifier for generating 100 megabytes:</p> <td>ascii</td>
<td>All ASCII characters</td>
<pre class="example">@100m</pre> </tr>
<tr>
<p>Data is generated and served efficiently - if you really want to send a <td>ascii_letters</td>
terabyte of data to a client, pathod can do it. The supported suffixes are:</p> <td>A-Za-z</td>
</tr>
<tr>
<table class="table table-bordered"> <td>ascii_lowercase</td>
<tbody > <td>a-z</td>
<tr> </tr>
<td>b</td> <td>1024**0 (bytes)</td> <tr>
</tr> <td>ascii_uppercase</td>
<tr> <td>A-Z</td>
<td>k</td> <td>1024**1 (kilobytes)</td> </tr>
</tr> <tr>
<tr> <td>bytes</td>
<td>m</td> <td>1024**2 (megabytes)</td> <td>All 256 byte values</td>
</tr> </tr>
<tr> <tr>
<td>g</td> <td>1024**3 (gigabytes)</td> <td>digits</td>
</tr> <td>0-9</td>
<tr> </tr>
<td>t</td> <td>1024**4 (terabytes)</td> <tr>
</tr> <td>hexdigits</td>
</tbody> <td>0-f</td>
</table> </tr>
<tr>
<p>Data types are separated from the size specification by a comma. This <td>octdigits</td>
specification generates 100mb of ASCII:</p> <td>0-7</td>
</tr>
<pre class="example">@100m,ascii</pre> <tr>
<td>punctuation</td>
<p>Supported data types are:</p> <td>
<pre>!"#$%&\'()*+,-./:;
<table class="table table-bordered"> <=>?@[\\]^_`{|}~</pre>
<tbody > </td>
<tr> </tr>
<td>ascii</td> <tr>
<td>All ASCII characters</td> <td>whitespace</td>
</tr> <td>
<tr> <pre>\t\n\x0b\x0c\r and space</pre>
<td>ascii_letters</td> </td>
<td>A-Za-z</td> </tr>
</tr> </tbody>
<tr> </table>
<td>ascii_lowercase</td>
<td>a-z</td>
</tr>
<tr>
<td>ascii_uppercase</td>
<td>A-Z</td>
</tr>
<tr>
<td>bytes</td>
<td>All 256 byte values</td>
</tr>
<tr>
<td>digits</td>
<td>0-9</td>
</tr>
<tr>
<td>hexdigits</td>
<td>0-f</td>
</tr>
<tr>
<td>octdigits</td>
<td>0-7</td>
</tr>
<tr>
<td>punctuation</td>
<td>
<pre>!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~</pre>
</td>
</tr>
<tr>
<td>whitespace</td>
<td>
<pre>\t\n\x0b\x0c\r and space</pre>
</td>
</tr>
</tbody>
</table>
</section> </section>
{% endblock %} {% endblock %}

28
libpathod/templates/docs_lang_websockets.html
View File

@ -1,13 +1,13 @@
<pre class="example">wf:[colon-separated list of features]</pre></p> <pre class="example">wf:[colon-separated list of features]</pre>
</p>
<table class="table table-bordered"> <table class="table table-bordered">
<tbody > <tbody>
<tr> <tr>
<td> b<a href="#valuespec">VALUE</a> </td> <td> b<a href="#valuespec">VALUE</a> </td>
<td> <td>
Set the frame payload. If a masking key is present, the Set the frame payload. If a masking key is present, the value is encoded automatically.
value is encoded automatically.
</td> </td>
</tr> </tr>
@ -15,8 +15,8 @@
<td> c<a href="#valuespec">INTEGER</a> </td> <td> c<a href="#valuespec">INTEGER</a> </td>
<td> <td>
Set the op code. This can either be an integer from 0-15, or be Set the op code. This can either be an integer from 0-15, or be one of the following opcode
one of the following opcode names: <b>text</b> (the default), names: <b>text</b> (the default),
<b>continue</b>, <b>binary</b>, <b>close</b>, <b>ping</b>, <b>continue</b>, <b>binary</b>, <b>close</b>, <b>ping</b>,
<b>pong</b>. <b>pong</b>.
@ -47,17 +47,16 @@
<tr> <tr>
<td> k<a href="#valuespec">VALUE</a> </td> <td> k<a href="#valuespec">VALUE</a> </td>
<td> <td>
Set the masking key. The resulting value must be exactly 4 Set the masking key. The resulting value must be exactly 4 bytes long. The special form
bytes long. The special form <b>knone</b> specifies that no key <b>knone</b> specifies that no key should be set, even
should be set, even if the mask bit is on. if the mask bit is on.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> l<a href="#valuespec">INTEGER</a> </td> <td> l<a href="#valuespec">INTEGER</a> </td>
<td> <td>
Set the payload length in the frame header, regardless of the Set the payload length in the frame header, regardless of the actual body length.
actual body length.
</td> </td>
</tr> </tr>
@ -71,16 +70,15 @@
<tr> <tr>
<td> p<a href="#offsetspec">OFFSET</a>,SECONDS </td> <td> p<a href="#offsetspec">OFFSET</a>,SECONDS </td>
<td> <td>
Pause for SECONDS seconds after OFFSET bytes. SECONDS can Pause for SECONDS seconds after OFFSET bytes. SECONDS can be an integer or "f" to pause
be an integer or "f" to pause forever. forever.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> r<a href="#valuespec">VALUE</a> </td> <td> r<a href="#valuespec">VALUE</a> </td>
<td> <td>
Set the raw frame payload. This disables masking, even if the Set the raw frame payload. This disables masking, even if the key is present.
key is present.
</td> </td>
</tr> </tr>

22
libpathod/templates/docs_libpathod.html
View File

@ -1,8 +1,6 @@
{% extends "docframe.html" %} {% extends "docframe.html" %} {% block body %}
{% block body %}
<div class="page-header"> <div class="page-header">
<h1> <h1>
libpathod libpathod
<small>Using pathod and pathoc in code.</small> <small>Using pathod and pathoc in code.</small>
</h1> </h1>
@ -10,18 +8,16 @@
<div class="row"> <div class="row">
<div class="span6"> <div class="span6">
<p>
<p> Behind the pathod and pathoc command-line tools lurks Behind the pathod and pathoc command-line tools lurks <b>libpathod</b>, a
<b>libpathod</b>, a powerful library for manipulating and serving HTTP powerful library for manipulating and serving HTTP requests and responses.
requests and responses. The canonical documentation for the library is The canonical documentation for the library is in the code, and can be accessed
in the code, and can be accessed using pydoc.</p> using pydoc.
</p>
</div> </div>
<div class="span6"> <div class="span6">
<h1> pathoc </h1> <h1>pathoc</h1>
{% include "libpathod_pathoc.html" %} {% include "libpathod_pathoc.html" %}
</div> </div>
</div> </div>
{% endblock %} {% endblock %}

248
libpathod/templates/docs_pathoc.html
View File

@ -1,191 +1,209 @@
{% extends "docframe.html" %} {% extends "docframe.html" %} {% block body %}
{% block body %}
<div class="page-header"> <div class="page-header">
<h1> <h1>
pathoc pathoc
<small>A perverse HTTP client.</small> <small>A perverse HTTP client.</small>
</h1> </h1>
</div> </div>
<p>Pathoc is a perverse HTTP daemon designed to let you craft almost any <p>
conceivable HTTP request, including ones that creatively violate the standards. Pathoc is a perverse HTTP daemon designed to let you craft almost any conceivable HTTP
HTTP requests are specified using a <a href="/docs/language">small, terse request, including ones that creatively violate the standards. HTTP requests are specified
language</a>, which pathod shares with its server-side twin <a using a
href="/docs/pathod">pathod</a>. To view pathoc's complete range of options, use <a href="/docs/language">small, terse language</a>, which pathod shares with its server-side
the command-line help:</p> twin <a href="/docs/pathod">pathod</a>. To view pathoc's complete range of options,
use the command-line help:
</p>
<pre class="terminal">pathoc --help</pre> <pre class="terminal">pathoc --help</pre>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Getting Started</h1> <h1>Getting Started</h1>
</div> </div>
<p>The basic pattern for pathoc commands is as follows: </p> <p>The basic pattern for pathoc commands is as follows: </p>
<pre class="terminal">pathoc hostname request [request ...]</pre> <pre class="terminal">pathoc hostname request [request ...]</pre>
<p>That is, we specify the hostname to connect to, followed by one or more <p>
requests. Lets start with a simple example:</p> That is, we specify the hostname to connect to, followed by one or more requests. Lets
start with a simple example:
</p>
<pre class="terminal">&gt; pathoc google.com get:/ <pre class="terminal">
&lt;&lt; 301 Moved Permanently: 219 bytes</pre> &gt; pathoc google.com get:/ &lt;&lt; 301 Moved Permanently: 219 bytes
</pre>
<p>Here, we make a GET request to the path / on port 80 of google.com. <p>
Pathoc's output tells us that the server responded with a 301. We can tell Here, we make a GET request to the path / on port 80 of google.com. Pathoc's output tells
pathoc to connect using SSL, in which case the default port is changed to us that the server responded with a 301. We can tell pathoc to connect using SSL,
443 (you can over-ride the default port with the <b>-p</b> command-line in which case the default port is changed to 443 (you can over-ride the default
option):</p> port with the <b>-p</b> command-line option):
</p>
<pre class="terminal">&gt; pathoc -s google.com get:/
&lt;&lt; 301 Moved Permanently: 219 bytes</pre>
<pre class="terminal">
&gt; pathoc -s google.com get:/ &lt;&lt; 301 Moved Permanently: 219 bytes
</pre>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Multiple Requests</h1> <h1>Multiple Requests</h1>
</div> </div>
<p>There are two ways to tell pathoc to issue multiple requests. The first <p>
is to specify them on the command-line, like so:</p> There are two ways to tell pathoc to issue multiple requests. The first is to specify
them on the command-line, like so:
</p>
<pre class="terminal">&gt; pathoc google.com get:/ get:/ <pre class="terminal">
&lt;&lt; 301 Moved Permanently: 219 bytes &gt; pathoc google.com get:/ get:/ &lt;&lt; 301 Moved Permanently: 219 bytes &lt;&lt;
&lt;&lt; 301 Moved Permanently: 219 bytes</pre> 301 Moved Permanently: 219 bytes
</pre>
<p> In this case, pathoc issues the specified requests over the same TCP <p>
connection - so in the above example only one connection is made to In this case, pathoc issues the specified requests over the same TCP connection - so in
google.com </p> the above example only one connection is made to google.com
</p>
<p> The other way to issue multiple requets is to use the <b>-n</b> flag:</p> <p>The other way to issue multiple requets is to use the <b>-n</b> flag:</p>
<pre class="terminal">&gt; pathoc -n 2 google.com get:/ <pre class="terminal">
&lt;&lt; 301 Moved Permanently: 219 bytes &gt; pathoc -n 2 google.com get:/ &lt;&lt; 301 Moved Permanently: 219 bytes &lt;&lt; 301
&lt;&lt; 301 Moved Permanently: 219 bytes</pre> Moved Permanently: 219 bytes
</pre>
<p> The output is identical, but two separate TCP connections are made to <p>
the upstream server. These two specification styles can be combined:</p> The output is identical, but two separate TCP connections are made to the upstream server.
These two specification styles can be combined:
</p>
<pre class="terminal">&gt; pathoc -n 2 google.com get:/ get:/ <pre class="terminal">
&lt;&lt; 301 Moved Permanently: 219 bytes &gt; pathoc -n 2 google.com get:/ get:/ &lt;&lt; 301 Moved Permanently: 219 bytes &lt;&lt;
&lt;&lt; 301 Moved Permanently: 219 bytes 301 Moved Permanently: 219 bytes &lt;&lt; 301 Moved Permanently: 219 bytes &lt;&lt;
&lt;&lt; 301 Moved Permanently: 219 bytes 301 Moved Permanently: 219 bytes
&lt;&lt; 301 Moved Permanently: 219 bytes</pre> </pre>
<p> Here, two distinct TCP connections are made, with two requests issued
over each. </p>
<p>Here, two distinct TCP connections are made, with two requests issued over each.</p>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Basic Fuzzing</h1> <h1>Basic Fuzzing</h1>
</div> </div>
<p>The combination of pathoc's powerful request specification language and <p>
a few of its command-line options makes for quite a powerful basic fuzzer. The combination of pathoc's powerful request specification language and a few of its command-line
Here's an example:</p> options makes for quite a powerful basic fuzzer. Here's an example:
</p>
<pre class="terminal">&gt; pathoc -e -I 200 -t 2 -n 1000 localhost get:/:b@10:ir,@1</pre> <pre class="terminal">
&gt; pathoc -e -I 200 -t 2 -n 1000 localhost get:/:b@10:ir,@1
</pre>
<p>The request specified here is a valid GET with a body consisting of 10 <p>
random bytes, but with 1 random byte inserted in a random place. This could The request specified here is a valid GET with a body consisting of 10 random bytes, but
be in the headers, in the initial request line, or in the body itself. with 1 random byte inserted in a random place. This could be in the headers, in
There are a few things to note here:<p> the initial request line, or in the body itself. There are a few things to note
here:
</p>
<ul> <ul>
<li>
Corrupting the request in this way will often make the server enter a state where it's
awaiting more input from the client. This is where the
<b>-t</b> option comes in, which sets a timeout that causes pathoc to disconnect
after two seconds.
</li>
<li> Corrupting the request in this way will often make the server <li>
enter a state where it's awaiting more input from the client. This is The <b>-n</b> option tells pathoc to repeat the request 1000 times.
where the <b>-t</b> option comes in, which sets a timeout that causes </li>
pathoc to disconnect after two seconds. </li>
<li> The <b>-n</b> option tells pathoc to repeat the request 1000 <li>
times.</li> The <b>-I</b> option tells pathoc to ignore HTTP 200 response codes. You can
use this to fine-tune what pathoc considers to be an exceptional condition,
<li> The <b>-I</b> option tells pathoc to ignore HTTP 200 response and therefore log-worthy.
codes. You can use this to fine-tune what pathoc considers to be an </li>
exceptional condition, and therefore log-worthy.</li>
<li> The <b>-e</b> option tells pathoc to print an explanation of each
logged request, in the form of an expanded pathoc specification with
all random portions and automatic header additions resolved. This lets
you precisely replay a request that triggered an error </li>
<li>
The <b>-e</b> option tells pathoc to print an explanation of each logged request,
in the form of an expanded pathoc specification with all random portions and
automatic header additions resolved. This lets you precisely replay a request
that triggered an error.
</li>
</ul> </ul>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Interacting with Proxies</h1> <h1>Interacting with Proxies</h1>
</div> </div>
<p>Pathoc has a reasonably sophisticated suite of features for interacting <p>
with proxies. The proxy request syntax very closely mirrors that of Pathoc has a reasonably sophisticated suite of features for interacting with proxies.
straight HTTP, which means that it is possible to make proxy-style requests The proxy request syntax very closely mirrors that of straight HTTP, which means
using pathoc without any additional syntax, by simply specifying a full URL that it is possible to make proxy-style requests using pathoc without any additional
instead of a simple path::</p> syntax, by simply specifying a full URL instead of a simple path:
</p>
<pre class="terminal">&gt; pathoc -p 8080 localhost "get:'http://google.com'"</pre> <pre class="terminal">&gt; pathoc -p 8080 localhost "get:'http://google.com'"</pre>
<p>Another common use case is to use an HTTP CONNECT request to probe <p>
remote servers via a proxy. This is done with the <b>-c</b> command-line Another common use case is to use an HTTP CONNECT request to probe remote servers via
option, which allows you to specify a remote host and port pair:</p> a proxy. This is done with the <b>-c</b> command-line option, which allows
you to specify a remote host and port pair:
</p>
<pre class="terminal">&gt; pathoc -c google.com:80 -p 8080 localhost get:/</pre> <pre class="terminal">&gt; pathoc -c google.com:80 -p 8080 localhost get:/</pre>
<p>Note that pathoc does <b>not</b> negotiate SSL without being explictly <p>
instructed to do so. If you're making a CONNECT request to an SSL-protected Note that pathoc does <b>not</b> negotiate SSL without being explictly instructed
resource, you must also pass the <b>-s</b> flag:</p> to do so. If you're making a CONNECT request to an SSL-protected resource, you
must also pass the <b>-s</b> flag:
</p>
<pre class="terminal">&gt; pathoc -sc google.com:443 -p 8080 localhost get:/</pre> <pre class="terminal">&gt; pathoc -sc google.com:443 -p 8080 localhost get:/</pre>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Embedded response specification</h1> <h1>Embedded response specification</h1>
</div> </div>
<p>One interesting feature of the Request sppecification language is that <p>
you can embed a response specifcation in it, which is then added to the One interesting feature of the Request sppecification language is that you can embed a
request path. Here's an example:</p> response specifcation in it, which is then added to the request path. Here's an
example:
</p>
<pre class="terminal">&gt; pathoc localhost:9999 "get:/p/:s'401:ir,@1'" </pre> <pre class="terminal">&gt; pathoc localhost:9999 "get:/p/:s'401:ir,@1'"</pre>
<p> This crafts a request that connects to the pathod server, and which then <p>
crafts a response that generates a 401, with one random byte embedded at a This crafts a request that connects to the pathod server, and which then crafts a response
random point. The response specification is parsed and expanded by pathoc, that generates a 401, with one random byte embedded at a random point. The response
so you see syntax errors immediately. This really becomes handy when specification is parsed and expanded by pathoc, so you see syntax errors immediately.
combined with the <b>-e</b> flag to show the expanded request: This really becomes handy when combined with the <b>-e</b> flag to show
the expanded request:
</p>
<pre class="terminal">&gt; > pathoc -e localhost:9999 "get:/p/:s'401:ir,@1'" <pre class="terminal">
>> Spec: get:/p/:s'401:i15,\'o\':h\'Content-Length\'=\'0\'':h'Content-Length'='0' &gt; > pathoc -e localhost:9999 "get:/p/:s'401:ir,@1'" >> Spec: get:/p/:s'401:i15,\'o\':h\'Content-Length\'=\'0\'':h'Content-Length'='0'
<< 401 Unoauthorized: 0 bytes </pre> << 401 Unoauthorized: 0 bytes </pre>
<p> Note that the embedded response has been resolved <i>before</i> being
sent to the server, so that "ir,@1" (embed a random byte at a random
location) has become "i15,\'o\'" (embed the character "o" at offset 15). You
now have a pathoc request specification that is precisely reproducable, even
with random components. This feature comes in terribly handy when testing a
proxy, since you can now drive the server repsonse completely from the
client, and have a complete log of reproducible requests to analyse
afterwards.</p>
<p>
Note that the embedded response has been resolved <i>before</i> being
sent to the server, so that "ir,@1" (embed a random byte at a random location)
has become "i15,\'o\'" (embed the character "o" at offset 15). You now
have a pathoc request specification that is precisely reproducable, even
with random components. This feature comes in terribly handy when testing
a proxy, since you can now drive the server repsonse completely from the
client, and have a complete log of reproducible requests to analyse afterwards.
</p>
</section> </section>
{% endblock %} {% endblock %}

153
libpathod/templates/docs_pathod.html
View File

@ -1,131 +1,142 @@
{% extends "docframe.html" %} {% extends "docframe.html" %} {% block body %}
{% block body %}
<div class="page-header"> <div class="page-header">
<h1> <h1>
pathod pathod
<small>A pathological web daemon.</small> <small>A pathological web daemon.</small>
</h1> </h1>
</div> </div>
<p>Pathod is a pathological HTTP daemon designed to let you craft almost any <p>
conceivable HTTP response, including ones that creatively violate the Pathod is a pathological HTTP daemon designed to let you craft almost any conceivable
standards. HTTP responses are specified using a <a href="/docs/language">small, HTTP response, including ones that creatively violate the standards. HTTP responses
terse language</a>, which pathod shares with its evil twin <a are specified using a
href="/docs/pathoc">pathoc</a>. </p> <a href="/docs/language">small, terse language</a>, which pathod shares with its evil
twin <a href="/docs/pathoc">pathoc</a>.
</p>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Getting started</h1> <h1>Getting started</h1>
</div> </div>
<p> To start playing with pathod, simply fire up the daemon: </p> <p>To start playing with pathod, simply fire up the daemon:</p>
<pre class="terminal">./pathod</pre> <pre class="terminal">./pathod</pre>
<p>By default, the service listens on port 9999 of localhost. Pathod's <p>
documentation is self-hosting, and the pathod daemon exposes an interface that By default, the service listens on port 9999 of localhost. Pathod's documentation is self-hosting,
lets you play with the specifciation language, preview what responses and and the pathod daemon exposes an interface that lets you play with the specifciation
requests would look like on the wire, and view internal logs. To access all of language, preview what responses and requests would look like on the wire, and
this, just fire up your browser, and point it to the following URL:</p> view internal logs. To access all of this, just fire up your browser, and point
it to the following URL:
</p>
<pre class="example">http://localhost:9999</pre> <pre class="example">http://localhost:9999</pre>
<p>The default crafting anchor point is the path <b>/p/</b>. Anything after <p>
this URL prefix is treated as a response specifier. So, hitting the following The default crafting anchor point is the path <b>/p/</b>. Anything after this
URL will generate an HTTP 200 response with 100 bytes of random data:</p> URL prefix is treated as a response specifier. So, hitting the following URL will
generate an HTTP 200 response with 100 bytes of random data:
</p>
<pre class="example">http://localhost:9999/p/200:b@100</pre> <pre class="example">http://localhost:9999/p/200:b@100</pre>
<p>See the <a href="/docs/language">language documentation</a> to get (much) <p>
fancier. The pathod daemon also takes a range of configuration options. To view See the <a href="/docs/language">language documentation</a> to get (much) fancier.
those, use the command-line help:</p> The pathod daemon also takes a range of configuration options. To view those,
use the command-line help:
</p>
<pre class="terminal">./pathod --help</pre> <pre class="terminal">./pathod --help</pre>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Acting as a proxy</h1> <h1>Acting as a proxy</h1>
</div> </div>
<p>Pathod automatically responds to both straight HTTP and proxy requests. For <p>
proxy requests, the upstream host is ignored, and the path portion of the URL Pathod automatically responds to both straight HTTP and proxy requests. For proxy requests,
is used to match anchors. This lets you test software that supports a proxy the upstream host is ignored, and the path portion of the URL is used to match
configuration by spoofing responses from upstream servers.</p> anchors. This lets you test software that supports a proxy configuration by spoofing
responses from upstream servers.
<p>By default, we treat all proxy CONNECT requests as HTTPS traffic, serving </p>
the response using either pathod's built-in certificates, or the cert/key pair
specified by the user. You can over-ride this behaviour if you're testing a
client that makes a non-SSL CONNECT request using the -C command-line
option.</p>
<p>
By default, we treat all proxy CONNECT requests as HTTPS traffic, serving the response
using either pathod's built-in certificates, or the cert/key pair specified by
the user. You can over-ride this behaviour if you're testing a client that makes
a non-SSL CONNECT request using the -C command-line option.
</p>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Anchors</h1> <h1>Anchors</h1>
</div> </div>
<p>Anchors provide an alternative to specifying the response in the URL. <p>
Instead, you attach a response to a pre-configured anchor point, specified with Anchors provide an alternative to specifying the response in the URL. Instead, you attach
a regex. When a URL matching the regex is requested, the specified response is a response to a pre-configured anchor point, specified with a regex. When a URL
served.</p> matching the regex is requested, the specified response is served.
</p>
<pre class="terminal">./pathod -a "/foo=200"</pre> <pre class="terminal">./pathod -a "/foo=200"</pre>
<p>Here, "/foo" is the regex specifying the anchor path, and the part after
the "=" is a response specifier.</p>
<p>
Here, "/foo" is the regex specifying the anchor path, and the part after the "=" is a
response specifier.
</p>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>File Access</h1> <h1>File Access</h1>
</div> </div>
<p>There are two operators in the <a href="/docs/language">language</a> that <p>
load contents from file - the <b>+</b> operator to load an entire request There are two operators in the <a href="/docs/language">language</a> that load
specification from file, and the <b>&gt;</b> value specifier. In pathod, both contents from file - the <b>+</b> operator to load an entire request specification
of these operators are restricted to a directory specified at startup, or from file, and the <b>&gt;</b> value specifier. In pathod, both of these operators
disabled if no directory is specified:</p> are restricted to a directory specified at startup, or disabled if no directory
is specified:</p>
<pre class="terminal">./pathod -d ~/staticdir"</pre> <pre class="terminal">./pathod -d ~/staticdir"</pre>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Internal Error Responses</h1> <h1>Internal Error Responses</h1>
</div> </div>
<p>Pathod uses the non-standard 800 response code to indicate internal <p>
errors, to distinguish them from crafted responses. For example, a request Pathod uses the non-standard 800 response code to indicate internal errors, to distinguish
to:</p> them from crafted responses. For example, a request to:
</p>
<pre class="example">http://localhost:9999/p/foo</pre> <pre class="example">http://localhost:9999/p/foo</pre>
<p>... will return an 800 response because "foo" is not a valid page <p>
specifier.</p> ... will return an 800 response because "foo" is not a valid page specifier.
</p>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>API</h1> <h1>API</h1>
</div> </div>
<p>pathod exposes a simple API, intended to make it possible to drive and <p>
inspect the daemon remotely for use in unit testing and the like. </p> pathod exposes a simple API, intended to make it possible to drive and inspect the daemon
remotely for use in unit testing and the like.
</p>
<table class="table table-bordered"> <table class="table table-bordered">
<tbody > <tbody>
<tr> <tr>
<td> <td>
/api/clear_log /api/clear_log
@ -147,18 +158,16 @@ disabled if no directory is specified:</p>
/api/log /api/log
</td> </td>
<td> <td>
Returns the current log buffer. At the moment the buffer size is 500 entries - Returns the current log buffer. At the moment the buffer size is 500 entries - when the
when the log grows larger than this, older entries are discarded. The returned log grows larger than this, older entries are discarded. The returned
data is a JSON dictionary, with the form: data is a JSON dictionary, with the form:
<pre>{ 'log': [ ENTRIES ] } </pre> <pre>{ 'log': [ ENTRIES ] } </pre>
You can preview the JSON data returned for a log entry through the built-in web You can preview the JSON data returned for a log entry through the built-in web interface.
interface.
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</section> </section>
{% endblock %} {% endblock %}

68
libpathod/templates/docs_test.html
View File

@ -1,52 +1,50 @@
{% extends "docframe.html" %} {% extends "docframe.html" %} {% block body %}
{% block body %}
<div class="page-header"> <div class="page-header">
<h1> <h1>
libpathod.test libpathod.test
<small>Using pathod and pathoc in your unit tests.</small> <small>Using libpathod in unit tests.</small>
</h1> </h1>
</div> </div>
<div class="row"> <p>The <b>libpathod.test</b> module is a light, flexible testing layer for HTTP clients.
<div class="span6"> It works by firing up a Pathod instance in a separate thread, letting you use Pathod's
full abilities to generate responses, and then query Pathod's internal logs to establish
what happened. All the mechanics of startup, shutdown, finding free ports and so forth
are taken care of for you.
</p>
<p> The <b>libpathod.test</b> module is a light, flexible testing layer <p>The canonical docs can be accessed using pydoc: </p>
for HTTP clients. It works by firing up a Pathod instance in a separate
thread, letting you use Pathod's full abilities to generate responses,
and then query Pathod's internal logs to establish what happened. All
the mechanics of startup, shutdown, finding free ports and so forth are
taken care of for you. </p>
<p> The canonical docs can be accessed using pydoc: </p> <pre class="terminal">pydoc libpathod.test</pre>
<pre class="terminal">pydoc libpathod.test</pre> <p>
The remainder of this page demonstrates some common interaction patterns using
<p> The remainder of this page demonstrates some common interaction <a
patterns using <a href="http://nose.readthedocs.org/en/latest/">nose</a>. These examples are also applicable with only minor modification to most
href="http://nose.readthedocs.org/en/latest/">nose</a>. These examples commonly used Python testing engines.
are also applicable with only minor modification to most commonly used </p>
Python testing engines.</p>
<section>
<div class="page-header">
<h1>Context Manager</h1>
</div> </div>
<div class="span6">
<h1> Context Manager </h1>
{% include "examples_context.html" %} {% include "examples_context.html" %}
</section>
<section>
<div class="page-header">
<h1>One instance per test</h1>
</div> </div>
</div>
<div class="row"> {% include "examples_setup.html" %}
<div class="span6"> </section>
<h1> One instance per test </h1>
{% include "examples_setup.html" %} <section>
<div class="page-header">
<h1>One instance per suite</h1>
</div> </div>
<div class="span6">
<h1> One instance per suite </h1>
{% include "examples_setupall.html" %}
</div>
</div>
{% include "examples_setupall.html" %}
</section>
{% endblock %} {% endblock %}

34
libpathod/templates/download.html
View File

@ -1,53 +1,37 @@
{% extends "frame.html" %} {% extends "frame.html" %} {% block body %}
{% block body %}
<section> <section>
<div class="page-header"> <div class="page-header">
<h1> <h1>pip</h1>
pip
</h1>
</div> </div>
<p>The easiest way to install pathod is to use pip:</p> <p>The easiest way to install pathod is to use pip:</p>
<pre>pip install pathod</pre> <pre>pip install pathod</pre>
<p> This will automatically pull in all the dependencies, and you should be <p>This will automatically pull in all the dependencies, and you should be good to go.</p>
good to go.</p>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1> <h1>github</h1>
github
</h1>
</div> </div>
<p> You can find the project source on GitHub: </p> <p>You can find the project source on GitHub:</p>
<div style="margin-top: 20px; margin-bottom: 20px"> <div style="margin-top: 20px; margin-bottom: 20px">
<a class="btn btn-primary btn-large" href="https://github.com/mitmproxy/pathod">github.com/mitmproxy/pathod</a> <a class="btn btn-primary btn-large" href="https://github.com/mitmproxy/pathod">github.com/mitmproxy/pathod</a>
</div> </div>
<p>Please also use the <a <p>Please also use the <a href="https://github.com/mitmproxy/pathod/issues">github issue tracker</a> to report bugs.</p>
href="https://github.com/mitmproxy/pathod/issues">github issue tracker</a> to
report bugs. </p>
</section> </section>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1> <h1>tarball</h1>
tarball
</h1>
</div> </div>
<div style="margin-top: 20px; margin-bottom: 20px"> <div style="margin-top: 20px; margin-bottom: 20px">
<a class="btn btn-primary btn-large" href="https://github.com/downloads/mitmproxy/pathod/pathod-{{version}}.tar.gz">pathod-{{version}}.tar.gz</a> <a class="btn btn-primary btn-large" href="https://github.com/downloads/mitmproxy/pathod/pathod-{{version}}.tar.gz">pathod-{{version}}.tar.gz</a>
</div> </div>
</section> </section>
{% endblock %} {% endblock %}

1
libpathod/templates/examples_context.html
View File

@ -1,6 +1,7 @@
<div class="highlight"><pre><span class="kn">import</span> <span class="nn">requests</span> <div class="highlight"><pre><span class="kn">import</span> <span class="nn">requests</span>
<span class="kn">from</span> <span class="nn">libpathod</span> <span class="kn">import</span> <span class="n">test</span> <span class="kn">from</span> <span class="nn">libpathod</span> <span class="kn">import</span> <span class="n">test</span>
<span class="k">def</span> <span class="nf">test_simple</span><span class="p">():</span> <span class="k">def</span> <span class="nf">test_simple</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span> <span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Testing the requests module with</span> <span class="sd"> Testing the requests module with</span>

3
libpathod/templates/examples_setup.html
View File

@ -1,12 +1,15 @@
<div class="highlight"><pre><span class="kn">import</span> <span class="nn">requests</span> <div class="highlight"><pre><span class="kn">import</span> <span class="nn">requests</span>
<span class="kn">from</span> <span class="nn">libpathod</span> <span class="kn">import</span> <span class="n">test</span> <span class="kn">from</span> <span class="nn">libpathod</span> <span class="kn">import</span> <span class="n">test</span>
<span class="k">class</span> <span class="nc">Test</span><span class="p">:</span> <span class="k">class</span> <span class="nc">Test</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span> <span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Testing the requests module with</span> <span class="sd"> Testing the requests module with</span>
<span class="sd"> a pathod instance started for</span> <span class="sd"> a pathod instance started for</span>
<span class="sd"> each test.</span> <span class="sd"> each test.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">d</span> <span class="o">=</span> <span class="n">test</span><span class="o">.</span><span class="n">Daemon</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">d</span> <span class="o">=</span> <span class="n">test</span><span class="o">.</span><span class="n">Daemon</span><span class="p">()</span>

6
libpathod/templates/examples_setupall.html
View File

@ -1,10 +1,12 @@
<div class="highlight"><pre><span class="kn">import</span> <span class="nn">requests</span> <div class="highlight"><pre><span class="kn">import</span> <span class="nn">requests</span>
<span class="kn">from</span> <span class="nn">libpathod</span> <span class="kn">import</span> <span class="n">test</span> <span class="kn">from</span> <span class="nn">libpathod</span> <span class="kn">import</span> <span class="n">test</span>
<span class="k">class</span> <span class="nc">Test</span><span class="p">:</span> <span class="k">class</span> <span class="nc">Test</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span> <span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Testing the requests module with </span> <span class="sd"> Testing the requests module with</span>
<span class="sd"> a single pathod instance started </span> <span class="sd"> a single pathod instance started</span>
<span class="sd"> for the test suite.</span> <span class="sd"> for the test suite.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="sd"> &quot;&quot;&quot;</span>
<span class="nd">@classmethod</span> <span class="nd">@classmethod</span>

6
libpathod/templates/frame.html
View File

@ -1,9 +1,7 @@
{% extends "layout.html" %} {% extends "layout.html" %} {% block content %}
{% block content %}
<div class="row"> <div class="row">
<div class="span12"> <div class="span12">
{% block body %} {% block body %} {% endblock %}
{% endblock %}
</div> </div>
</div> </div>
{% endblock %} {% endblock %}

55
libpathod/templates/index.html
View File

@ -1,7 +1,4 @@
{% extends "frame.html" %} {% extends "frame.html" %} {% block body %}
{% block body %}
<div class="masthead"> <div class="masthead">
<div class="container"> <div class="container">
<h1>pathod: pathological HTTP</h1> <h1>pathod: pathological HTTP</h1>
@ -12,58 +9,52 @@
</div> </div>
</div> </div>
<div class="row"> <div class="row">
<div class="span6"> <div class="span6">
<div> <div>
<h2> <a href="/docs/pathod">pathod</a> </h2> <h2><a href="/docs/pathod">pathod</a></h2>
<p>A pathological web daemon.</p> <p>A pathological web daemon.</p>
{% include "response_previewform.html" %} {% include "response_previewform.html" %}
<br> <br>
</div> </div>
</div> </div>
<div class="span6"> <div class="span6">
<div> <div>
<h2> <a href="/docs/pathoc">pathoc</a> </h2> <h2><a href="/docs/pathoc">pathoc</a></h2>
<p>A perverse HTTP client.</p> <p>A perverse HTTP client.</p>
{% include "request_previewform.html" %} {% include "request_previewform.html" %}
</div> </div>
</div> </div>
</div> </div>
<section> <section>
<div class="page-header"> <div class="page-header">
<h1>Install</h1> <h1>Install</h1>
</div> </div>
<div class="row"> <div class="row">
<div class="span6"> <div class="span6">
<div> <div>
<h2>pip</h2> <h2>pip</h2>
<pre>pip install pathod</pre> <pre>pip install pathod</pre>
</div>
</div>
<div class="span6">
<div>
<h2>source</h2>
<ul>
<li>Current release: <a href="http://mitmproxy.org/download/pathod-{{version}}.tar.gz">pathod {{version}}</a></li>
<li>GitHub: <a href="https://github.com/mitmproxy/pathod">github.com/mitmproxy/pathod</a></li>
</ul>
</div>
</div> </div>
</div> </div>
<div class="span6">
<div>
<h2>source</h2>
<ul>
<li>Current release: <a href="http://mitmproxy.org/download/pathod-{{version}}.tar.gz">pathod {{version}}</a></li>
<li>GitHub: <a href="https://github.com/mitmproxy/pathod">github.com/mitmproxy/pathod</a></li>
</li>
</div>
</div>
</div>
</section> </section>
{% endblock %} {% endblock %}

85
libpathod/templates/layout.html
View File

@ -1,6 +1,7 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<head>
<head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>pathod</title> <title>pathod</title>
<link href="/static/bootstrap.min.css" rel="stylesheet"> <link href="/static/bootstrap.min.css" rel="stylesheet">
@ -14,60 +15,58 @@
<meta name="description" content=""> <meta name="description" content="">
<meta name="author" content=""> <meta name="author" content="">
<style type="text/css"> <style type="text/css">
body { body {
padding-top: 60px; padding-top: 60px;
padding-bottom: 40px; padding-bottom: 40px;
} }
</style> </style>
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--> <![endif]-->
</head> </head>
<body>
<body>
<div class="navbar navbar-fixed-top"> <div class="navbar navbar-fixed-top">
<div class="navbar-inner"> <div class="navbar-inner">
<div class="container"> <div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> <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> <span class="icon-bar"></span>
<span class="icon-bar"></span> <span class="icon-bar"></span>
</a> </a>
<a class="brand" href="/index.html">pathod</a> <a class="brand" href="/index.html">pathod</a>
<div class="nav-collapse"> <div class="nav-collapse">
<ul class="nav"> <ul class="nav">
<li {% if section== "main" %} class="active" {% endif %}><a href="/">home</a></li> <li {% if section=="main" %} class="active" {% endif %}><a href="/">home</a></li>
{% if not noapi %} {% if not noapi %}
<li {% if section== "log" %} class="active" {% endif %}><a href="/log">log</a></li> <li {% if section=="log" %} class="active" {% endif %}><a href="/log">log</a></li>
{% endif %} {% endif %}
<li {% if section== "docs" %} class="active" {% endif %}><a href="/docs/pathod">docs</a></li> <li {% if section=="docs" %} class="active" {% endif %}><a href="/docs/pathod">docs</a></li>
<li {% if section== "about" %} class="active" {% endif %}><a href="/about">about</a></li> <li {% if section=="about" %} class="active" {% endif %}><a href="/about">about</a></li>
</ul> </ul>
</div> </div>
</div>
</div> </div>
</div>
</div> </div>
<div class="container"> <div class="container">
{% block content %} {% block content %} {% endblock %}
{% endblock %} <hr>
<hr> <footer>
<footer> <span>&copy; Aldo Cortesi 2015</span>
<span>&copy; Aldo Cortesi 2015</span> <span class="pull-right">[served with pathod]</span>
<span class="pull-right">[served with pathod]</span> </footer>
</footer>
</div> </div>
</body> </body>
<script> <script>
$(function(){ $(function() {
$.localScroll( $.localScroll({
{ duration: 300,
duration: 300, offset: {
offset: {top: -45} top: -45
} }
); });
}); });
</script> </script>
</html> </html>

3
libpathod/templates/libpathod_pathoc.html
View File

@ -1,7 +1,8 @@
<div class="highlight"><pre><span class="c">#!/usr/bin/env python</span> <div class="highlight"><pre><span class="c">#!/usr/bin/env python</span>
<span class="kn">from</span> <span class="nn">libpathod</span> <span class="kn">import</span> <span class="n">pathoc</span> <span class="kn">from</span> <span class="nn">libpathod</span> <span class="kn">import</span> <span class="n">pathoc</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">pathoc</span><span class="o">.</span><span class="n">Pathoc</span><span class="p">(</span><span class="s">&quot;google.com&quot;</span><span class="p">,</span> <span class="mi">80</span><span class="p">)</span> <span class="n">p</span> <span class="o">=</span> <span class="n">pathoc</span><span class="o">.</span><span class="n">Pathoc</span><span class="p">((</span><span class="s">&quot;google.com&quot;</span><span class="p">,</span> <span class="mi">80</span><span class="p">))</span>
<span class="n">p</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span> <span class="n">p</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
<span class="k">print</span> <span class="n">p</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s">&quot;get:/&quot;</span><span class="p">)</span> <span class="k">print</span> <span class="n">p</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s">&quot;get:/&quot;</span><span class="p">)</span>
<span class="k">print</span> <span class="n">p</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s">&quot;get:/foo&quot;</span><span class="p">)</span>
</pre></div> </pre></div>

59
libpathod/templates/log.html
View File

@ -1,32 +1,31 @@
{% extends "frame.html" %} {% extends "frame.html" %} {% block body %}
{% block body %} <form style="float: right" method="POST" action="/log/clear">
<form style="float: right" method="POST" action="/log/clear"> <button type="submit" class="btn">clear</button>
<button type="submit" class="btn">clear</button> </form>
</form>
<h1> Logs </h1>
<hr>
<table class="table table-striped table-condensed"> <h1>Logs</h1>
<thead> <hr>
<tr>
<th>id</th> <table class="table table-striped table-condensed">
<th>method</th> <thead>
<th>path</th> <tr>
</tr> <th>id</th>
</thead> <th>method</th>
<tbody> <th>path</th>
{% for i in log %} </tr>
<tr> </thead>
{% if i["type"] == 'error' %} <tbody>
<td colspan="3">ERROR: {{ i["msg"] }}</td> {% for i in log %}
{% else %} <tr>
<td>{{ i["id"] }}</td> {% if i["type"] == 'error' %}
<td>{{ i["request"]["method"] }}</td> <td colspan="3">ERROR: {{ i["msg"] }}</td>
<td><a href="/log/{{ i["id"] }}">{{ i["request"]["path"] }}</a></td> {% else %}
{% endif %} <td>{{ i["id"] }}</td>
</tr> <td>{{ i["request"]["method"] }}</td>
{% endfor %} <td><a href="/log/{{ i[" id "] }}">{{ i["request"]["path"] }}</a></td>
</tbody> {% endif %}
</table> </tr>
{% endfor %}
</tbody>
</table>
{% endblock %} {% endblock %}

12
libpathod/templates/onelog.html
View File

@ -1,10 +1,8 @@
{% extends "frame.html" %} {% extends "frame.html" %} {% block body %}
{% block body %} <h2>Log entry {{ lid }}</h2>
<h2> Log entry {{ lid }} </h2> <hr>
<hr>
<pre> <pre>
{{ alog }} {{ alog }}
</pre> </pre>
{% endblock %} {% endblock %}

56
libpathod/templates/request_preview.html
View File

@ -1,6 +1,4 @@
{% extends "frame.html" %} {% extends "frame.html" %} {% block body %}
{% block body %}
<div class="page-header"> <div class="page-header">
<h1>pathoc preview</h1> <h1>pathoc preview</h1>
</div> </div>
@ -15,36 +13,32 @@
</div> </div>
{% if syntaxerror %} {% if syntaxerror %}
<div class="row"> <div class="row">
<div class="span2 header"> <div class="span2 header">
Error: Error:
</div>
<div class="span10">
<p style="color: #ff0000">{{ syntaxerror }}</p>
<pre>{{ marked }}</pre>
</div>
</div> </div>
<div class="span10">
<p style="color: #ff0000">{{ syntaxerror }}</p>
<pre>{{ marked }}</pre>
</div>
</div>
{% elif error %} {% elif error %}
<div class="row"> <div class="row">
<div class="span2 header"> <div class="span2 header">
Error: Error:
</div>
<div class="span10">
<p style="color: #ff0000">{{ error }}</p>
</div>
</div> </div>
<div class="span10">
<p style="color: #ff0000">{{ error }}</p>
</div>
</div>
{% else %} {% else %}
<div class="row"> <div class="row">
<div class="span2 header"> <div class="span2 header">
Request: Request:
</div>
<div class="span10">
<pre>{{ output }}</pre>
<p>Note: pauses are skipped when generating previews!</p>
</div>
</div> </div>
{% endif %} <div class="span10">
<pre>{{ output }}</pre>
{% endblock %} <p>Note: pauses are skipped when generating previews!</p>
</div>
</div>
{% endif %} {% endblock %}

20
libpathod/templates/request_previewform.html
View File

@ -1,23 +1,17 @@
<form style="margin-bottom: 0" class="form-inline" method="GET" action="/request_preview"> <form style="margin-bottom: 0" class="form-inline" method="GET" action="/request_preview">
<input <input style="width: 18em" id="spec" name="spec" class="input-medium" value="{{spec}}"
style="width: 18em" placeholder="method:path:[features]">
id="spec"
name="spec"
class="input-medium"
value="{{spec}}"
placeholder="method:path:[features]"
>
<input type="submit" class="btn" value="preview"> <input type="submit" class="btn" value="preview">
</form> </form>
<a class="innerlink" data-toggle="collapse" data-target="#requestexamples">examples</a> <a class="innerlink" data-toggle="collapse" data-target="#requestexamples">examples</a>
<div id="requestexamples" class="collapse"> <div id="requestexamples" class="collapse">
<p>Check out the <a href="/docs/language">complete language docs</a>. Here <p>Check out the <a href="/docs/language">complete language docs</a>. Here are some examples
are some examples to get you started:</p> to get you started:</p>
<table class="table table-bordered"> <table class="table table-bordered">
<tbody > <tbody>
<tr> <tr>
<td><a href="/request_preview?spec=get:/">get:/</a></td> <td><a href="/request_preview?spec=get:/">get:/</a></td>
<td>Get path /</td> <td>Get path /</td>
@ -39,7 +33,9 @@
<td>Drop the connection randomly</td> <td>Drop the connection randomly</td>
</tr> </tr>
<tr> <tr>
<td><a href="/request_preview?spec="></a></td> <td>
<a href="/request_preview?spec="></a>
</td>
<td></td> <td></td>
</tr> </tr>
<tr> <tr>

54
libpathod/templates/response_preview.html
View File

@ -1,6 +1,4 @@
{% extends "frame.html" %} {% extends "frame.html" %} {% block body %}
{% block body %}
<div class="page-header"> <div class="page-header">
<h1>pathod preview</h1> <h1>pathod preview</h1>
</div> </div>
@ -15,34 +13,32 @@
</div> </div>
{% if syntaxerror %} {% if syntaxerror %}
<div class="row"> <div class="row">
<div class="span2 header"> <div class="span2 header">
Error: Error:
</div>
<div class="span10">
<p style="color: #ff0000">{{ syntaxerror }}</p>
<pre>{{ marked }}</pre>
</div>
</div> </div>
<div class="span10">
<p style="color: #ff0000">{{ syntaxerror }}</p>
<pre>{{ marked }}</pre>
</div>
</div>
{% elif error %} {% elif error %}
<div class="row"> <div class="row">
<div class="span2 header"> <div class="span2 header">
Error: Error:
</div>
<div class="span10">
<p style="color: #ff0000">{{ error }}</p>
</div>
</div> </div>
<div class="span10">
<p style="color: #ff0000">{{ error }}</p>
</div>
</div>
{% else %} {% else %}
<div class="row"> <div class="row">
<div class="span2 header"> <div class="span2 header">
Response: Response:
</div>
<div class="span10">
<pre>{{ output }}</pre>
<p>Note: pauses are skipped when generating previews!</p>
</div>
</div> </div>
{% endif %} <div class="span10">
<pre>{{ output }}</pre>
{% endblock %} <p>Note: pauses are skipped when generating previews!</p>
</div>
</div>
{% endif %} {% endblock %}

38
libpathod/templates/response_previewform.html
View File

@ -1,26 +1,18 @@
<form style="margin-bottom: 0" class="form-inline" method="GET" action="/response_preview"> <form style="margin-bottom: 0" class="form-inline" method="GET" action="/response_preview">
<input <input style="width: 18em" id="spec" name="spec" class="input-medium" value="{{spec}}"
style="width: 18em" placeholder="code:[features]">
id="spec" <input type="submit" class="btn" value="preview"> {% if not nocraft %}
name="spec" <a href="#" id="submitspec" class="btn">go</a> {% endif %}
class="input-medium"
value="{{spec}}"
placeholder="code:[features]"
>
<input type="submit" class="btn" value="preview">
{% if not nocraft %}
<a href="#" id="submitspec" class="btn">go</a>
{% endif %}
</form> </form>
<a class="innerlink" data-toggle="collapse" data-target="#responseexamples">examples</a> <a class="innerlink" data-toggle="collapse" data-target="#responseexamples">examples</a>
<div id="responseexamples" class="collapse"> <div id="responseexamples" class="collapse">
<p>Check out the <a href="/docs/language">complete language docs</a>. Here <p>Check out the <a href="/docs/language">complete language docs</a>. Here are some examples
are some examples to get you started:</p> to get you started:</p>
<table class="table table-bordered"> <table class="table table-bordered">
<tbody > <tbody>
<tr> <tr>
<td><a href="/response_preview?spec=200">200</a></td> <td><a href="/response_preview?spec=200">200</a></td>
<td>A basic HTTP 200 response.</td> <td>A basic HTTP 200 response.</td>
@ -35,8 +27,8 @@
</tr> </tr>
<tr> <tr>
<td><a href="/response_preview?spec=200:b@100">200:b@100</a></td> <td><a href="/response_preview?spec=200:b@100">200:b@100</a></td>
<td>100 random bytes as the body. A Content-Lenght header is <td>100 random bytes as the body. A Content-Lenght header is added, so the
added, so the disconnect is no longer needed.</td> disconnect is no longer needed.</td>
</tr> </tr>
<tr> <tr>
<td><a href='/response_preview?spec=200:b@100:h"Server"="&apos;;drop table servers;"'>200:b@100:h"Etag"="';drop table servers;"</a></td> <td><a href='/response_preview?spec=200:b@100:h"Server"="&apos;;drop table servers;"'>200:b@100:h"Etag"="';drop table servers;"</a></td>
@ -66,18 +58,20 @@
<td> <td>
<a href="/response_preview?spec=200:b@100:h@1k,ascii_letters='foo'">200:b@100:h@1k,ascii_letters='foo'</a> <a href="/response_preview?spec=200:b@100:h@1k,ascii_letters='foo'">200:b@100:h@1k,ascii_letters='foo'</a>
</td> </td>
<td>100 ASCII bytes as the body, randomly generated 100k header name, with the value 'foo'.</td> <td>100 ASCII bytes as the body, randomly generated 100k header name, with
the value 'foo'.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</div> </div>
{% if not nocraft %}
<script> <script>
$(function(){ $(function() {
{% if not nocraft %} $("#submitspec").click(function() {
$("#submitspec").click(function(){
document.location = "{{craftanchor}}" + $("#spec").val() document.location = "{{craftanchor}}" + $("#spec").val()
}); });
{% endif %}
}); });
</script> </script>
{% endif %}