aboutsummaryrefslogtreecommitdiffstats
path: root/doc-src
diff options
context:
space:
mode:
authorMarcelo Glezer <mg@tekii.com.ar>2015-03-02 14:37:30 -0300
committerMarcelo Glezer <mg@tekii.com.ar>2015-03-02 14:37:30 -0300
commit8008a4336d85f4d34bd9f192c5f3e510f4adf5cd (patch)
tree02240bbd5a5abcff275e2d841252c1b86a32f6eb /doc-src
parentbd6c3f64c1f3102a4e91d4a964757821773781e0 (diff)
parente65a8659f00fb949d15f9af9fefd72df48abe9af (diff)
downloadmitmproxy-8008a4336d85f4d34bd9f192c5f3e510f4adf5cd.tar.gz
mitmproxy-8008a4336d85f4d34bd9f192c5f3e510f4adf5cd.tar.bz2
mitmproxy-8008a4336d85f4d34bd9f192c5f3e510f4adf5cd.zip
Merge pull request #2 from mitmproxy/master
update to mitmproxy/master
Diffstat (limited to 'doc-src')
-rw-r--r--doc-src/_nav.html1
-rw-r--r--doc-src/dev/index.py1
-rw-r--r--doc-src/dev/sslkeylogfile.html8
-rw-r--r--doc-src/features/responsestreaming.html6
4 files changed, 15 insertions, 1 deletions
diff --git a/doc-src/_nav.html b/doc-src/_nav.html
index 6c3afbe1..69175c0c 100644
--- a/doc-src/_nav.html
+++ b/doc-src/_nav.html
@@ -56,4 +56,5 @@
<li class="nav-header">Hacking</li>
$!nav("dev/architecture.html", this, state)!$
$!nav("dev/testing.html", this, state)!$
+ $!nav("dev/sslkeylogfile.html", this, state)!$
</ul>
diff --git a/doc-src/dev/index.py b/doc-src/dev/index.py
index bb7872c7..0f2a6494 100644
--- a/doc-src/dev/index.py
+++ b/doc-src/dev/index.py
@@ -3,5 +3,6 @@ from countershape import Page
pages = [
Page("testing.html", "Testing"),
Page("architecture.html", "Architecture"),
+ Page("sslkeylogfile.html", "TLS Master Secrets"),
# Page("addingviews.html", "Writing Content Views"),
]
diff --git a/doc-src/dev/sslkeylogfile.html b/doc-src/dev/sslkeylogfile.html
new file mode 100644
index 00000000..1826fc2e
--- /dev/null
+++ b/doc-src/dev/sslkeylogfile.html
@@ -0,0 +1,8 @@
+The SSL master keys can be logged by mitmproxy so that external programs can decrypt TLS connections both from and to the proxy.
+Key logging is enabled by setting the environment variable <samp>SSLKEYLOGFILE</samp> so that it points to a writable
+text file. Recent versions of WireShark can use these log files to decrypt packets.
+You can specify the key file path in WireShark via<br>
+<samp>Edit → Preferences → Protocols → SSL → (Pre)-Master-Secret log filename</samp>.
+
+ Note that <samp>SSLKEYLOGFILE</samp> is respected by other programs as well, e.g. Firefox and Chrome.
+If this creates any issues, you can set <samp>MITMPROXY_SSLKEYLOGFILE</samp> alternatively. \ No newline at end of file
diff --git a/doc-src/features/responsestreaming.html b/doc-src/features/responsestreaming.html
index 47fafef7..6511e913 100644
--- a/doc-src/features/responsestreaming.html
+++ b/doc-src/features/responsestreaming.html
@@ -40,7 +40,6 @@ Responses that should be tagged for streaming by setting their respective .strea
$!example("examples/stream.py")!$
-
<h2>Implementation Details</h2>
When response streaming is enabled, portions of the code which would have otherwise performed changes
@@ -49,6 +48,11 @@ on the response body will see an empty response body instead (<code>libmproxy.pr
Streamed responses are usually sent in chunks of 4096 bytes. If the response is sent with a <code>Transfer-Encoding:
chunked</code> header, the response will be streamed one chunk at a time.
+<h2>Modifying streamed data</h2>
+If the <code>.stream</code> attribute is callable, .stream will work as a hook in chunk data processing.
+
+$!example("examples/stream_modify.py")!$
+
### See Also
- [Ignore Domains](@!urlTo("passthrough.html")!@)