diff --git a/.gitignore b/.gitignore index c88c25ceb..4c8c70a23 100644 --- a/.gitignore +++ b/.gitignore @@ -11,4 +11,4 @@ MANIFEST netlib venv .idea/ -pathod.egg-info/ \ No newline at end of file +pathod.egg-info/ diff --git a/libpathod/templates/about.html b/libpathod/templates/about.html index 9a695a6a8..340dc386a 100644 --- a/libpathod/templates/about.html +++ b/libpathod/templates/about.html @@ -1,30 +1,22 @@ -{% extends "frame.html" %} -{% block body %} - - +{% extends "frame.html" %} {% block body %}
-
-

- About -

-
-
-
-
-

pathod is developed by Aldo - Cortesi.

-
+
+

About

+
+
+
+
+

pathod is developed by Aldo Cortesi.

+
-
- +
+ +
-
- - {% endblock %} diff --git a/libpathod/templates/docframe.html b/libpathod/templates/docframe.html index f780f3798..4cbdeebce 100644 --- a/libpathod/templates/docframe.html +++ b/libpathod/templates/docframe.html @@ -1,26 +1,26 @@ {% extends "layout.html" %} {% macro subs(s) %} -{% if subsection == s %} class="active" {% endif %} + {% if subsection == s %} + class="active" + {% endif %} {% endmacro %} - -{% block content %} +{% block content %}
- {% block body %} - {% endblock %} + {% block body %} {% endblock %}
-{% endblock %} +{% endblock %} diff --git a/libpathod/templates/docs_lang.html b/libpathod/templates/docs_lang.html index ce778dc97..e3195939d 100644 --- a/libpathod/templates/docs_lang.html +++ b/libpathod/templates/docs_lang.html @@ -1,17 +1,15 @@ -{% extends "docframe.html" %} -{% block body %} - +{% extends "docframe.html" %} {% block body %}
-

+

Language Spec The mini-language at the heart of pathoc and pathod.

@@ -28,151 +26,171 @@
-

Features

+

Features

- -

OFFSET

+ +

OFFSET

-

Offsets are calculated relative to the base message, before any - injections or other transforms are applied. They have 3 flavors:

+

+ Offsets are calculated relative to the base message, before any injections or other transforms + are applied. They have 3 flavors: +

- + - -

VALUE

+ +

VALUE

-

Literals

+

Literals

-

Literal values are specified as a quoted strings:

+

Literal values are specified as a quoted strings:

- 
"foo"
+ 
"foo"
-

Either single or double quotes are accepted, and quotes can be escaped with - backslashes within the string:

+

+ Either single or double quotes are accepted, and quotes can be escaped with backslashes + within the string: +

- 
'fo\'o'
+ 
'fo\'o'
-

Literal values can contain Python-style backslash escape sequences:

+

Literal values can contain Python-style backslash escape sequences:

- 
'foo\r\nbar'
+ 
'foo\r\nbar'
+ +

Files

+ +

+ 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: +

+ + 
pathod -d ~/myassets
+ +

+ All paths are relative paths under this directory. File loads are indicated by starting + the value specifier with the left angle bracket: +

+ + 
<my/path
+ +

The path value can also be a quoted string, with the same syntax as literals:

+ + 
<"my/path"
-

Files

+

Generated values

-

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:

+

+ 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". +

- 
pathod -d ~/myassets
+

Here's a value specifier for generating 100 bytes: -

All paths are relative paths under this directory. File loads are indicated by - starting the value specifier with the left angle bracket: + 

@100
+

- 
<my/path

+

+ You can use standard suffixes to indicate larger values. Here, for instance, is a specifier + for generating 100 megabytes: +

-

The path value can also be a quoted string, with the same syntax as literals:

+ 
@100m
- 
<"my/path"
+

+ 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: +

+ + + + + + + + + + + + + + + + + + + + + + + +
b1024**0 (bytes)
k1024**1 (kilobytes)
m1024**2 (megabytes)
g1024**3 (gigabytes)
t1024**4 (terabytes)
-

Generated values

+

+ Data types are separated from the size specification by a comma. This specification generates + 100mb of ASCII: +

-

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".

+ 
@100m,ascii
-

Here's a value specifier for generating 100 bytes: +

Supported data types are:

- 
@100

- -

You can use standard suffixes to indicate larger values. Here, for instance, is - a specifier for generating 100 megabytes:

- - 
@100m
- -

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:

- - - - - - - - - - - - - - - - - - - - -
b 1024**0 (bytes)
k 1024**1 (kilobytes)
m 1024**2 (megabytes)
g 1024**3 (gigabytes)
t 1024**4 (terabytes)
- -

Data types are separated from the size specification by a comma. This - specification generates 100mb of ASCII:

- - 
@100m,ascii
- -

Supported data types are:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
asciiAll ASCII characters
ascii_lettersA-Za-z
ascii_lowercasea-z
ascii_uppercaseA-Z
bytesAll 256 byte values
digits0-9
hexdigits0-f
octdigits0-7
punctuation - 
!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~
-
whitespace - 
\t\n\x0b\x0c\r and space
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
asciiAll ASCII characters
ascii_lettersA-Za-z
ascii_lowercasea-z
ascii_uppercaseA-Z
bytesAll 256 byte values
digits0-9
hexdigits0-f
octdigits0-7
punctuation + 
!"#$%&\'()*+,-./:;
+                        <=>?@[\\]^_`{|}~
+
whitespace + 
\t\n\x0b\x0c\r and space
+
- {% endblock %} diff --git a/libpathod/templates/docs_lang_websockets.html b/libpathod/templates/docs_lang_websockets.html index 32bd71f97..682f4cc89 100644 --- a/libpathod/templates/docs_lang_websockets.html +++ b/libpathod/templates/docs_lang_websockets.html @@ -1,13 +1,13 @@ -
wf:[colon-separated list of features]

+
wf:[colon-separated list of features]
+

- + @@ -15,8 +15,8 @@ @@ -71,16 +70,15 @@ diff --git a/libpathod/templates/docs_libpathod.html b/libpathod/templates/docs_libpathod.html index 3e18c1d90..72b24e832 100644 --- a/libpathod/templates/docs_libpathod.html +++ b/libpathod/templates/docs_libpathod.html @@ -1,8 +1,6 @@ -{% extends "docframe.html" %} -{% block body %} - +{% extends "docframe.html" %} {% block body %}
-

+

libpathod Using pathod and pathoc in code.

@@ -10,18 +8,16 @@
- -

Behind the pathod and pathoc command-line tools lurks - libpathod, a powerful library for manipulating and serving HTTP - requests and responses. The canonical documentation for the library is - in the code, and can be accessed using pydoc.

- +

+ Behind the pathod and pathoc command-line tools lurks libpathod, a + powerful library for manipulating and serving HTTP requests and responses. + The canonical documentation for the library is in the code, and can be accessed + using pydoc. +

-

pathoc

- +

pathoc

{% include "libpathod_pathoc.html" %}
- -{% endblock %} +{% endblock %} diff --git a/libpathod/templates/docs_pathoc.html b/libpathod/templates/docs_pathoc.html index 760185304..e4c128730 100644 --- a/libpathod/templates/docs_pathoc.html +++ b/libpathod/templates/docs_pathoc.html @@ -1,191 +1,209 @@ -{% extends "docframe.html" %} -{% block body %} +{% extends "docframe.html" %} {% block body %}
-

+

pathoc A perverse HTTP client.

-

Pathoc is a perverse HTTP daemon designed to let you craft almost any -conceivable HTTP request, including ones that creatively violate the standards. -HTTP requests are specified using a small, terse -language, which pathod shares with its server-side twin pathod. To view pathoc's complete range of options, use -the command-line help:

+

+ Pathoc is a perverse HTTP daemon designed to let you craft almost any conceivable HTTP + request, including ones that creatively violate the standards. HTTP requests are specified + using a + small, terse language, which pathod shares with its server-side + twin pathod. To view pathoc's complete range of options, + use the command-line help: +

- 
pathoc --help
+
pathoc --help
-

Getting Started

+

Getting Started

The basic pattern for pathoc commands is as follows: 

pathoc hostname request [request ...]
-

That is, we specify the hostname to connect to, followed by one or more - requests. Lets start with a simple example:

+

+ That is, we specify the hostname to connect to, followed by one or more requests. Lets + start with a simple example: +

- 
> pathoc google.com get:/
-<< 301 Moved Permanently: 219 bytes
+ 
+        > pathoc google.com get:/ << 301 Moved Permanently: 219 bytes
+
-

Here, we make a GET request to the path / on port 80 of google.com. - Pathoc's output tells us that the server responded with a 301. We can tell - pathoc to connect using SSL, in which case the default port is changed to - 443 (you can over-ride the default port with the -p command-line - option):

- - 
> pathoc -s google.com get:/
-<< 301 Moved Permanently: 219 bytes
+

+ Here, we make a GET request to the path / on port 80 of google.com. Pathoc's output tells + us that the server responded with a 301. We can tell pathoc to connect using SSL, + in which case the default port is changed to 443 (you can over-ride the default + port with the -p command-line option): +

+ 
+        > pathoc -s google.com get:/ << 301 Moved Permanently: 219 bytes
+
-

Multiple Requests

+

Multiple Requests

-

There are two ways to tell pathoc to issue multiple requests. The first - is to specify them on the command-line, like so:

+

+ There are two ways to tell pathoc to issue multiple requests. The first is to specify + them on the command-line, like so: +

- 
> pathoc google.com get:/ get:/
-<< 301 Moved Permanently: 219 bytes
-<< 301 Moved Permanently: 219 bytes
+ 
+        > pathoc google.com get:/ get:/ << 301 Moved Permanently: 219 bytes <<
+        301 Moved Permanently: 219 bytes
+
-

In this case, pathoc issues the specified requests over the same TCP - connection - so in the above example only one connection is made to - google.com

+

+ In this case, pathoc issues the specified requests over the same TCP connection - so in + the above example only one connection is made to google.com +

-

The other way to issue multiple requets is to use the -n flag:

+

The other way to issue multiple requets is to use the -n flag:

- 
> pathoc -n 2 google.com get:/
-<< 301 Moved Permanently: 219 bytes
-<< 301 Moved Permanently: 219 bytes
+ 
+        > pathoc -n 2 google.com get:/ << 301 Moved Permanently: 219 bytes << 301
+        Moved Permanently: 219 bytes
+
-

The output is identical, but two separate TCP connections are made to - the upstream server. These two specification styles can be combined:

+

+ The output is identical, but two separate TCP connections are made to the upstream server. + These two specification styles can be combined: +

- 
> pathoc -n 2 google.com get:/ get:/
-<< 301 Moved Permanently: 219 bytes
-<< 301 Moved Permanently: 219 bytes
-<< 301 Moved Permanently: 219 bytes
-<< 301 Moved Permanently: 219 bytes
- -

Here, two distinct TCP connections are made, with two requests issued - over each.

+ 
+        > pathoc -n 2 google.com get:/ get:/ << 301 Moved Permanently: 219 bytes <<
+        301 Moved Permanently: 219 bytes << 301 Moved Permanently: 219 bytes <<
+        301 Moved Permanently: 219 bytes
+
+

Here, two distinct TCP connections are made, with two requests issued over each.

-

Basic Fuzzing

+

Basic Fuzzing

-

The combination of pathoc's powerful request specification language and - a few of its command-line options makes for quite a powerful basic fuzzer. - Here's an example:

+

+ The combination of pathoc's powerful request specification language and a few of its command-line + options makes for quite a powerful basic fuzzer. Here's an example: +

- 
> pathoc -e -I 200 -t 2 -n 1000 localhost get:/:b@10:ir,@1
+ 
+        > pathoc -e -I 200 -t 2 -n 1000 localhost get:/:b@10:ir,@1
+
-

The request specified here is a valid GET with a body consisting of 10 - random bytes, but with 1 random byte inserted in a random place. This could - be in the headers, in the initial request line, or in the body itself. - There are a few things to note here:

+

+ The request specified here is a valid GET with a body consisting of 10 random bytes, but + with 1 random byte inserted in a random place. This could be in the headers, in + the initial request line, or in the body itself. There are a few things to note + here: +

    +
  • + 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 + -t option comes in, which sets a timeout that causes pathoc to disconnect + after two seconds. +
    • -
  • 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 -t option comes in, which sets a timeout that causes - pathoc to disconnect after two seconds.
    • +
  • + The -n option tells pathoc to repeat the request 1000 times. +
    • -
  • The -n option tells pathoc to repeat the request 1000 - times.
    • - -
  • The -I option tells pathoc to ignore HTTP 200 response - codes. You can use this to fine-tune what pathoc considers to be an - exceptional condition, and therefore log-worthy.
    • - -
  • The -e 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
    • +
  • + The -I option tells pathoc to ignore HTTP 200 response codes. You can + use this to fine-tune what pathoc considers to be an exceptional condition, + and therefore log-worthy. +
    • +
  • + The -e 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. +
-
-
-

Interacting with Proxies

+

Interacting with Proxies

-

Pathoc has a reasonably sophisticated suite of features for interacting - with proxies. The proxy request syntax very closely mirrors that of - straight HTTP, which means that it is possible to make proxy-style requests - using pathoc without any additional syntax, by simply specifying a full URL - instead of a simple path::

+

+ Pathoc has a reasonably sophisticated suite of features for interacting with proxies. + The proxy request syntax very closely mirrors that of straight HTTP, which means + that it is possible to make proxy-style requests using pathoc without any additional + syntax, by simply specifying a full URL instead of a simple path: + 

> pathoc -p 8080 localhost "get:'http://google.com'"
-

Another common use case is to use an HTTP CONNECT request to probe - remote servers via a proxy. This is done with the -c command-line - option, which allows you to specify a remote host and port pair:

+

+ Another common use case is to use an HTTP CONNECT request to probe remote servers via + a proxy. This is done with the -c command-line option, which allows + you to specify a remote host and port pair: + 

> pathoc -c google.com:80 -p 8080 localhost get:/
-

Note that pathoc does not negotiate SSL without being explictly - instructed to do so. If you're making a CONNECT request to an SSL-protected - resource, you must also pass the -s flag:

+

+ Note that pathoc does not negotiate SSL without being explictly instructed + to do so. If you're making a CONNECT request to an SSL-protected resource, you + must also pass the -s flag: + 

> pathoc -sc google.com:443 -p 8080 localhost get:/
-
-

Embedded response specification

+

Embedded response specification

-

One interesting feature of the Request sppecification language is that - you can embed a response specifcation in it, which is then added to the - request path. Here's an example:

+

+ One interesting feature of the Request sppecification language is that you can embed a + response specifcation in it, which is then added to the request path. Here's an + example: +

- 
> pathoc localhost:9999 "get:/p/:s'401:ir,@1'"
+ 
> pathoc localhost:9999 "get:/p/:s'401:ir,@1'"
-

This crafts a request that connects to the pathod server, and which then - crafts a response that generates a 401, with one random byte embedded at a - random point. The response specification is parsed and expanded by pathoc, - so you see syntax errors immediately. This really becomes handy when - combined with the -e flag to show the expanded request: +

+ This crafts a request that connects to the pathod server, and which then crafts a response + that generates a 401, with one random byte embedded at a random point. The response + specification is parsed and expanded by pathoc, so you see syntax errors immediately. + This really becomes handy when combined with the -e flag to show + the expanded request: +

- 
> > 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
- -

Note that the embedded response has been resolved before 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.

+ 
+        > > 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
+

+ Note that the embedded response has been resolved before 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. +

- - - - - - - - {% endblock %} diff --git a/libpathod/templates/docs_pathod.html b/libpathod/templates/docs_pathod.html index 3ad4dac90..21e7919a5 100644 --- a/libpathod/templates/docs_pathod.html +++ b/libpathod/templates/docs_pathod.html @@ -1,131 +1,142 @@ -{% extends "docframe.html" %} -{% block body %} - +{% extends "docframe.html" %} {% block body %}
-

+

pathod A pathological web daemon.

-

Pathod is a pathological HTTP daemon designed to let you craft almost any -conceivable HTTP response, including ones that creatively violate the -standards. HTTP responses are specified using a small, -terse language, which pathod shares with its evil twin pathoc.

+

+ Pathod is a pathological HTTP daemon designed to let you craft almost any conceivable + HTTP response, including ones that creatively violate the standards. HTTP responses + are specified using a + small, terse language, which pathod shares with its evil + twin pathoc. +

-

Getting started

+

Getting started

-

To start playing with pathod, simply fire up the daemon:

+

To start playing with pathod, simply fire up the daemon:

-
./pathod
+ 
./pathod
-

By default, the service listens on port 9999 of localhost. Pathod's -documentation is self-hosting, and the pathod daemon exposes an interface that -lets you play with the specifciation language, preview what responses and -requests would look like on the wire, and view internal logs. To access all of -this, just fire up your browser, and point it to the following URL:

+

+ By default, the service listens on port 9999 of localhost. Pathod's documentation is self-hosting, + and the pathod daemon exposes an interface that lets you play with the specifciation + language, preview what responses and requests would look like on the wire, and + view internal logs. To access all of this, just fire up your browser, and point + it to the following URL: +

-
http://localhost:9999
+ 
http://localhost:9999
-

The default crafting anchor point is the path /p/. Anything after -this 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:

+

+ The default crafting anchor point is the path /p/. Anything after this + 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: +

-
http://localhost:9999/p/200:b@100
+ 
http://localhost:9999/p/200:b@100
-

See the language documentation to get (much) -fancier. The pathod daemon also takes a range of configuration options. To view -those, use the command-line help:

+

+ See the language documentation to get (much) fancier. + The pathod daemon also takes a range of configuration options. To view those, + use the command-line help: +

-
./pathod --help
+ 
./pathod --help
-

Acting as a proxy

+

Acting as a proxy

-

Pathod automatically responds to both straight HTTP and proxy requests. For -proxy requests, the upstream host is ignored, and the path portion of the URL -is used to match anchors. This lets you test software that supports a proxy -configuration by spoofing responses from upstream servers.

- -

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.

+

+ Pathod automatically responds to both straight HTTP and proxy requests. For proxy requests, + the upstream host is ignored, and the path portion of the URL is used to match + anchors. This lets you test software that supports a proxy configuration by spoofing + responses from upstream servers. +

+

+ 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. +

-

Anchors

+

Anchors

-

Anchors provide an alternative to specifying the response in the URL. -Instead, you attach a response to a pre-configured anchor point, specified with -a regex. When a URL matching the regex is requested, the specified response is -served.

+

+ Anchors provide an alternative to specifying the response in the URL. Instead, you attach + a response to a pre-configured anchor point, specified with a regex. When a URL + matching the regex is requested, the specified response is served. +

-
./pathod -a "/foo=200"
- -

Here, "/foo" is the regex specifying the anchor path, and the part after -the "=" is a response specifier.

+ 
./pathod -a "/foo=200"
+

+ Here, "/foo" is the regex specifying the anchor path, and the part after the "=" is a + response specifier. +

-

File Access

+

File Access

-

There are two operators in the language that -load contents from file - the + operator to load an entire request -specification from file, and the > value specifier. In pathod, both -of these operators are restricted to a directory specified at startup, or -disabled if no directory is specified:

- -
./pathod -d ~/staticdir"
- +

+ There are two operators in the language that load + contents from file - the + operator to load an entire request specification + from file, and the > value specifier. In pathod, both of these operators + are restricted to a directory specified at startup, or disabled if no directory + is specified:

+ 
./pathod -d ~/staticdir"
-

Internal Error Responses

+

Internal Error Responses

-

Pathod uses the non-standard 800 response code to indicate internal - errors, to distinguish them from crafted responses. For example, a request - to:

+

+ Pathod uses the non-standard 800 response code to indicate internal errors, to distinguish + them from crafted responses. For example, a request to: + 

http://localhost:9999/p/foo
-

... will return an 800 response because "foo" is not a valid page - specifier.

- +

+ ... will return an 800 response because "foo" is not a valid page specifier. +

-

API

+

API

-

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.

- +

+ 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. +

bVALUE - Set the frame payload. If a masking key is present, the - value is encoded automatically. + Set the frame payload. If a masking key is present, the value is encoded automatically.
cINTEGER - Set the op code. This can either be an integer from 0-15, or be - one of the following opcode names: text (the default), + Set the op code. This can either be an integer from 0-15, or be one of the following opcode + names: text (the default), continue, binary, close, ping, pong. @@ -47,17 +47,16 @@
kVALUE - Set the masking key. The resulting value must be exactly 4 - bytes long. The special form knone specifies that no key - should be set, even if the mask bit is on. + Set the masking key. The resulting value must be exactly 4 bytes long. The special form + knone specifies that no key should be set, even + if the mask bit is on.
lINTEGER - Set the payload length in the frame header, regardless of the - actual body length. + Set the payload length in the frame header, regardless of the actual body length.
pOFFSET,SECONDS - Pause for SECONDS seconds after OFFSET bytes. SECONDS can - be an integer or "f" to pause forever. + Pause for SECONDS seconds after OFFSET bytes. SECONDS can be an integer or "f" to pause + forever.
rVALUE - Set the raw frame payload. This disables masking, even if the - key is present. + Set the raw frame payload. This disables masking, even if the key is present.
- +
/api/clear_log @@ -147,18 +158,16 @@ disabled if no directory is specified:

/api/log 		- Returns the current log buffer. At the moment the buffer size is 500 entries - - when the log grows larger than this, older entries are discarded. The returned + Returns the current log buffer. At the moment the buffer size is 500 entries - when the + log grows larger than this, older entries are discarded. The returned data is a JSON dictionary, with the form: 
{ 'log': [ ENTRIES ] }
- You can preview the JSON data returned for a log entry through the built-in web - interface. + You can preview the JSON data returned for a log entry through the built-in web interface.
- {% endblock %} diff --git a/libpathod/templates/docs_test.html b/libpathod/templates/docs_test.html index 25205d41e..5db45f3fe 100644 --- a/libpathod/templates/docs_test.html +++ b/libpathod/templates/docs_test.html @@ -1,52 +1,50 @@ -{% extends "docframe.html" %} -{% block body %} +{% extends "docframe.html" %} {% block body %}
-

+

libpathod.test - Using pathod and pathoc in your unit tests. + Using libpathod in unit tests.

-
-
+

The libpathod.test module is a light, flexible testing layer 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. +

-

The libpathod.test module is a light, flexible testing layer - 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.

+

The canonical docs can be accessed using pydoc:

-

The canonical docs can be accessed using pydoc:

+
pydoc libpathod.test
- 
pydoc libpathod.test
- -

The remainder of this page demonstrates some common interaction - patterns using nose. These examples - are also applicable with only minor modification to most commonly used - Python testing engines.

+

+ The remainder of this page demonstrates some common interaction patterns using + nose. These examples are also applicable with only minor modification to most + commonly used Python testing engines. +

+
+
+

Context Manager

-
-

Context Manager

- {% include "examples_context.html" %} + {% include "examples_context.html" %} +
+ +
+
+

One instance per test

-
-
-
-

One instance per test

+ {% include "examples_setup.html" %} + - {% include "examples_setup.html" %} +
+
+

One instance per suite

-
-

One instance per suite

- {% include "examples_setupall.html" %} -
-
- - -{% endblock %} + {% include "examples_setupall.html" %} + +{% endblock %} diff --git a/libpathod/templates/download.html b/libpathod/templates/download.html index 2f6ed2873..02ae9d418 100644 --- a/libpathod/templates/download.html +++ b/libpathod/templates/download.html @@ -1,53 +1,37 @@ -{% extends "frame.html" %} -{% block body %} - +{% extends "frame.html" %} {% block body %}
-

- pip -

+

pip

The easiest way to install pathod is to use pip:

pip install pathod
-

This will automatically pull in all the dependencies, and you should be - good to go.

- +

This will automatically pull in all the dependencies, and you should be good to go.

-
-

- github -

+

github

-

You can find the project source on GitHub:

+

You can find the project source on GitHub:

- github.com/mitmproxy/pathod + github.com/mitmproxy/pathod
-

Please also use the github issue tracker to - report bugs.

+

Please also use the github issue tracker to report bugs.

-
-

- tarball -

+

tarball

- pathod-{{version}}.tar.gz + pathod-{{version}}.tar.gz
- - {% endblock %} diff --git a/libpathod/templates/examples_context.html b/libpathod/templates/examples_context.html index 39146d37a..afb3bd481 100644 --- a/libpathod/templates/examples_context.html +++ b/libpathod/templates/examples_context.html @@ -1,6 +1,7 @@ 
import requests
 from libpathod import test
 
+
 def test_simple():
     """
         Testing the requests module with
diff --git a/libpathod/templates/examples_setup.html b/libpathod/templates/examples_setup.html
index b80ad3796..c2da1cd15 100644
--- a/libpathod/templates/examples_setup.html
+++ b/libpathod/templates/examples_setup.html
@@ -1,12 +1,15 @@
 
import requests
 from libpathod import test
 
+
 class Test:
+
     """
         Testing the requests module with
         a pathod instance started for
         each test.
     """
+
     def setUp(self):
         self.d = test.Daemon()
 
diff --git a/libpathod/templates/examples_setupall.html b/libpathod/templates/examples_setupall.html
index b7f799753..629d11e0e 100644
--- a/libpathod/templates/examples_setupall.html
+++ b/libpathod/templates/examples_setupall.html
@@ -1,10 +1,12 @@
 
import requests
 from libpathod import test
 
+
 class Test:
+
     """
-        Testing the requests module with 
-        a single pathod instance started 
+        Testing the requests module with
+        a single pathod instance started
         for the test suite.
     """
     @classmethod
diff --git a/libpathod/templates/frame.html b/libpathod/templates/frame.html
index b5c5c67c8..4223458d5 100644
--- a/libpathod/templates/frame.html
+++ b/libpathod/templates/frame.html
@@ -1,9 +1,7 @@
-{% extends "layout.html" %}
-{% block content %}  
+{% extends "layout.html" %} {% block content %}
 

     

-        {% block body %}  
-        {% endblock %}  
+        {% block body %} {% endblock %}
     

 

-{% endblock %}  
+{% endblock %}
diff --git a/libpathod/templates/index.html b/libpathod/templates/index.html
index 06a42dec5..a85a40409 100644
--- a/libpathod/templates/index.html
+++ b/libpathod/templates/index.html
@@ -1,7 +1,4 @@
-{% extends "frame.html" %}
-{% block body %}
-
-
+{% extends "frame.html" %} {% block body %}
 

     

         
pathod: pathological HTTP

@@ -12,58 +9,52 @@
     

 

 
-
 

     

         

-            
 pathod 

+            
pathod

 
             
A pathological web daemon.

 
             {% include "response_previewform.html" %}
-
             

-
         

     

+
     

         

-            
 pathoc 

+            
pathoc

 
             
A perverse HTTP client.

 
             {% include "request_previewform.html" %}
-
         

     

 

 
 

-

-    
Install

-

-

-    

-        

-            
pip

+    

+        
Install

+    

+    

+        

+            

+                
pip

 
-            
pip install pathod

+                
pip install pathod

+            

+        

 
+        

+            

+                
source

+
+                
+            

         

     

-    

-        

-            
source

-
-            

-    

-

 

-
-
 {% endblock %}
diff --git a/libpathod/templates/layout.html b/libpathod/templates/layout.html
index 5278e5aa4..b405ec34f 100644
--- a/libpathod/templates/layout.html
+++ b/libpathod/templates/layout.html
@@ -1,6 +1,7 @@
 
 
-  
+
+
     
     pathod
     
@@ -14,60 +15,58 @@
     
     
     
     
     
-  
-
-  
+
 
+
     

-      

-        

-          
-            
-            
-            
-          
-          pathod
-          

-            
-          

+        

+            

+                
+                    
+                    
+                    
+                
+                pathod
+                

+                    
+                

+            

         

-      

     

 
     

-        {% block content %}
-        {% endblock %}
-      

-      

-        © Aldo Cortesi 2015
-        [served with pathod]
-      

+        {% block content %} {% endblock %}
+        

+        

+            © Aldo Cortesi 2015
+            [served with pathod]
+        

     

-  
-  
+
 
diff --git a/libpathod/templates/libpathod_pathoc.html b/libpathod/templates/libpathod_pathoc.html
index f2737c019..f5871b164 100644
--- a/libpathod/templates/libpathod_pathoc.html
+++ b/libpathod/templates/libpathod_pathoc.html
@@ -1,7 +1,8 @@
 
#!/usr/bin/env python
 from libpathod import pathoc
 
-p = pathoc.Pathoc("google.com", 80)
+p = pathoc.Pathoc(("google.com", 80))
 p.connect()
 print p.request("get:/")
+print p.request("get:/foo")
 

diff --git a/libpathod/templates/log.html b/libpathod/templates/log.html
index 19468d661..b0484cb8d 100644
--- a/libpathod/templates/log.html
+++ b/libpathod/templates/log.html
@@ -1,32 +1,31 @@
-{% extends "frame.html" %}
-{% block body %}  
-    

-         
-    

-    
 Logs 

-    

+{% extends "frame.html" %} {% block body %}
+

+    
+

 
-    
-        
-            
-                
-                
-                
-            
-        
-        
-            {% for i in log %}
-                
-                    {% if i["type"] == 'error' %}
-                        
-                    {% else %}
-                        
-                        
-                        
-                    {% endif %}
-                
-            {% endfor %}
-        
-    
idmethodpath
ERROR: {{ i["msg"] }}{{ i["id"] }}{{ i["request"]["method"] }}{{ i["request"]["path"] }}

-{% endblock %}  
+
Logs

+

 
+
+    
+        
+            
+            
+            
+        
+    
+    
+        {% for i in log %}
+        
+            {% if i["type"] == 'error' %}
+            
+            {% else %}
+            
+            
+            
+            {% endif %}
+        
+        {% endfor %}
+    
+
idmethodpath
ERROR: {{ i["msg"] }}{{ i["id"] }}{{ i["request"]["method"] }}{{ i["request"]["path"] }}

+{% endblock %}
diff --git a/libpathod/templates/onelog.html b/libpathod/templates/onelog.html
index a94f443ab..c222ad60e 100644
--- a/libpathod/templates/onelog.html
+++ b/libpathod/templates/onelog.html
@@ -1,10 +1,8 @@
-{% extends "frame.html" %}
-{% block body %}  
-    
 Log entry {{ lid }} 

-    

+{% extends "frame.html" %} {% block body %}
+
Log entry {{ lid }}

+

+
 
-{{ alog }}
+    {{ alog }}
 

-
-{% endblock %}  
-
+{% endblock %}
diff --git a/libpathod/templates/request_preview.html b/libpathod/templates/request_preview.html
index 2717a9b87..25d73679d 100644
--- a/libpathod/templates/request_preview.html
+++ b/libpathod/templates/request_preview.html
@@ -1,6 +1,4 @@
-{% extends "frame.html" %}
-{% block body %}  
-
+{% extends "frame.html" %} {% block body %}
 

     
pathoc preview

 

@@ -15,36 +13,32 @@
 

 
 {% if syntaxerror %}
-    

-        

-            Error:
-        

-        

-            
{{ syntaxerror }}

-            
{{ marked }}

-        

+

+    

+        Error:
     

+    

+        
{{ syntaxerror }}

+        
{{ marked }}

+    

+

 {% elif error %}
-    

-        

-            Error:
-        

-        

-            
{{ error }}

-        

+

+    

+        Error:
     

+    

+        
{{ error }}

+    

+

 {% else %}
-    

-        

-            Request:
-        

-        

-            
{{ output }}

-            
Note: pauses are skipped when generating previews!

-        

+

+    

+        Request:
     

-{% endif %}  
-
-{% endblock %}  
-
-
+    

+        
{{ output }}

+        
Note: pauses are skipped when generating previews!

+    

+

+{% endif %} {% endblock %}
diff --git a/libpathod/templates/request_previewform.html b/libpathod/templates/request_previewform.html
index d30837359..0c6755de4 100644
--- a/libpathod/templates/request_previewform.html
+++ b/libpathod/templates/request_previewform.html
@@ -1,23 +1,17 @@
 

-    
+    
     
 

 
 examples
 
 

-    
Check out the complete language docs. Here
-    are some examples to get you started:

+    
Check out the complete language docs. Here are some examples
+        to get you started:

 
     
-        
+        
@@ -39,7 +33,9 @@
                 
-                
+                
diff --git a/libpathod/templates/response_preview.html b/libpathod/templates/response_preview.html
index ce6a40988..bbce6d6ca 100644
--- a/libpathod/templates/response_preview.html
+++ b/libpathod/templates/response_preview.html
@@ -1,6 +1,4 @@
-{% extends "frame.html" %}
-{% block body %}  
-
+{% extends "frame.html" %} {% block body %}
 

     
pathod preview

 

@@ -15,34 +13,32 @@
 
 
 {% if syntaxerror %}
-    

-        

-            Error:
-        

-        

-            
{{ syntaxerror }}

-            
{{ marked }}

-        

+

+    

+        Error:
     

+    

+        
{{ syntaxerror }}

+        
{{ marked }}

+    

+

 {% elif error %}
-    

-        

-            Error:
-        

-        

-            
{{ error }}

-        

+

+    

+        Error:
     

+    

+        
{{ error }}

+    

+

 {% else %}
-    

-        

-            Response:
-        

-        

-            
{{ output }}

-            
Note: pauses are skipped when generating previews!

-        

+

+    

+        Response:
     

-{% endif %}  
-
-{% endblock %}  
+    

+        
{{ output }}

+        
Note: pauses are skipped when generating previews!

+    

+

+{% endif %} {% endblock %}
diff --git a/libpathod/templates/response_previewform.html b/libpathod/templates/response_previewform.html
index d91a2a675..51e178142 100644
--- a/libpathod/templates/response_previewform.html
+++ b/libpathod/templates/response_previewform.html
@@ -1,26 +1,18 @@
 

-    
-    
-    {% if not nocraft %}
-    go
-    {% endif %}
+    
+     {% if not nocraft %}
+    go {% endif %}
 
 
 examples
 
 

-    
Check out the complete language docs. Here
-    are some examples to get you started:

+    
Check out the complete language docs. Here are some examples
+        to get you started:

 
     

             

                 get:/
                 Get path /Drop the connection randomly
             

             

+                    
+                
                 
             

             

-        
+        
@@ -35,8 +27,8 @@
             
-                
+                
@@ -66,18 +58,20 @@
                 
-                
+                

             

                 200
                 A basic HTTP 200 response.

             

                 200:b@100100 random bytes as the body. A Content-Lenght header is
-                added, so the disconnect is no longer needed.100 random bytes as the body. A Content-Lenght header is added, so the
+                    disconnect is no longer needed.
             

             

                 200:b@100:h"Etag"="';drop table servers;"
                     200:b@100:h@1k,ascii_letters='foo'
                 100 ASCII bytes as the body, randomly generated 100k header name, with the value 'foo'.100 ASCII bytes as the body, randomly generated 100k header name, with
+                    the value 'foo'.
             

         
     

 

 
+{% if not nocraft %}
 
+{% endif %}