docs: minor fixes

This commit is contained in:
Maximilian Hils
2015-09-07 10:52:18 +02:00
parent 31ee4607c8
commit c4286b15dc
31 changed files with 93 additions and 80 deletions

View File

@@ -11,4 +11,4 @@ high-level architecture is detailed in the following graphic:
:download:`architecture.pdf <../schematics/architecture.pdf>`
Please don't refrain from asking any further
questions on the mailing list, the Slack channel or the GitHub issue tracker.
questions on the mailing list, the Slack channel or the GitHub issue tracker.

View File

@@ -6,4 +6,4 @@ Exceptions
.. automodule:: libmproxy.exceptions
:show-inheritance:
:members:
:undoc-members:
:undoc-members:

View File

@@ -22,4 +22,4 @@ Models
:show-inheritance:
:members:
:special-members:
:no-undoc-members:
:no-undoc-members:

View File

@@ -12,4 +12,4 @@ Protocols
.. autoclass:: ServerConnectionMixin
:members:
.. autoexception:: Kill
.. autoexception:: Kill

View File

@@ -9,4 +9,4 @@ Proxy Server
.. autoclass:: DummyServer
.. autoclass:: ProxyConfig
.. autoclass:: RootContext
:members:
:members:

View File

@@ -3,12 +3,12 @@
TLS Master Secrets
==================
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
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
:envvar:`SSLKEYLOGFILE` 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
:samp:`Edit -> Preferences -> Protocols -> SSL -> (Pre)-Master-Secret log filename`.
Note that :envvar:`SSLKEYLOGFILE` is respected by other programs as well, e.g. Firefox and Chrome.
If this creates any issues, you can set :envvar:`MITMPROXY_SSLKEYLOGFILE` alternatively.
If this creates any issues, you can set :envvar:`MITMPROXY_SSLKEYLOGFILE` alternatively.

View File

@@ -43,4 +43,4 @@ excluded from coverage analysis either in the **.coveragerc** file, or using
**#pragma no-cover** directives. To keep our coverage analysis relevant, we use
these measures as sparingly as possible.
.. _nose: https://nose.readthedocs.org/en/latest/
.. _nose: https://nose.readthedocs.org/en/latest/