docs: update documentedlist, add filter table headers

This commit is contained in:
Maximilian Hils 2015-09-08 15:36:24 +02:00
parent c4286b15dc
commit c3ba98b681
3 changed files with 16 additions and 15 deletions

View File

@ -7,6 +7,7 @@ Many commands in :program:`mitmproxy` and :program:`mitmdump` take a filter expr
Filter expressions consist of the following operators: Filter expressions consist of the following operators:
.. documentedlist:: .. documentedlist::
:header: "Expression" "Description"
:listobject: libmproxy.filt.help :listobject: libmproxy.filt.help
- Regexes are Python-style - Regexes are Python-style

View File

@ -210,20 +210,20 @@ explicit HTTPS connections to establish the CN and SANs, and cope with SNI.
.. image:: schematics/how-mitmproxy-works-transparent-https.png .. image:: schematics/how-mitmproxy-works-transparent-https.png
:align: center :align: center
1. The client makes a connection to the server. 1. The client makes a connection to the server.
2. The router redirects the connection to mitmproxy, which is typically listening on a local port 2. The router redirects the connection to mitmproxy, which is typically listening on a local port
of the same host. Mitmproxy then consults the routing mechanism to establish what the original of the same host. Mitmproxy then consults the routing mechanism to establish what the original
destination was. destination was.
3. The client believes it's talking to the remote server, and initiates the SSL connection. 3. The client believes it's talking to the remote server, and initiates the SSL connection.
It uses SNI to indicate the hostname it is connecting to. It uses SNI to indicate the hostname it is connecting to.
4. Mitmproxy connects to the server, and establishes an SSL connection using the SNI hostname 4. Mitmproxy connects to the server, and establishes an SSL connection using the SNI hostname
indicated by the client. indicated by the client.
5. The server responds with the matching SSL certificate, which contains the CN and SAN values 5. The server responds with the matching SSL certificate, which contains the CN and SAN values
needed to generate the interception certificate. needed to generate the interception certificate.
6. Mitmproxy generates the interception cert, and continues the client SSL handshake paused in 6. Mitmproxy generates the interception cert, and continues the client SSL handshake paused in
step 3. step 3.
7. The client sends the request over the established SSL connection. 7. The client sends the request over the established SSL connection.
8. Mitmproxy passes the request on to the server over the SSL connection initiated in step 4. 8. Mitmproxy passes the request on to the server over the SSL connection initiated in step 4.
.. rubric:: Footnotes .. rubric:: Footnotes

View File

@ -43,7 +43,7 @@ dev_deps = {
"pathod>=%s, <%s" % (version.MINORVERSION, version.NEXT_MINORVERSION), "pathod>=%s, <%s" % (version.MINORVERSION, version.NEXT_MINORVERSION),
"sphinx>=1.3.1", "sphinx>=1.3.1",
"sphinx-autobuild>=0.5.2", "sphinx-autobuild>=0.5.2",
"sphinxcontrib-documentedlist>=0.1", "sphinxcontrib-documentedlist>=0.2",
} }
# Add *all* script dependencies to developer dependencies. # Add *all* script dependencies to developer dependencies.
for script_deps in scripts.values(): for script_deps in scripts.values():