aboutsummaryrefslogtreecommitdiffstats
path: root/doc-src/dev
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2015-09-07 10:30:40 +0200
committerMaximilian Hils <git@maximilianhils.com>2015-09-07 10:30:40 +0200
commit31ee4607c892f85c5d139e54acbc3ca4f9fb6bcb (patch)
tree873629c79b60b0ac0a7dbb458fe6ad82c2e042ef /doc-src/dev
parentb4013659a81a48908eb3e060f04143ba1f9689bb (diff)
downloadmitmproxy-31ee4607c892f85c5d139e54acbc3ca4f9fb6bcb.tar.gz
mitmproxy-31ee4607c892f85c5d139e54acbc3ca4f9fb6bcb.tar.bz2
mitmproxy-31ee4607c892f85c5d139e54acbc3ca4f9fb6bcb.zip
remove old docs
Diffstat (limited to 'doc-src/dev')
-rw-r--r--doc-src/dev/addingviews.html52
-rw-r--r--doc-src/dev/architecture.html8
-rw-r--r--doc-src/dev/index.py8
-rw-r--r--doc-src/dev/sslkeylogfile.html8
-rw-r--r--doc-src/dev/testing.html43
5 files changed, 0 insertions, 119 deletions
diff --git a/doc-src/dev/addingviews.html b/doc-src/dev/addingviews.html
deleted file mode 100644
index 12623a31..00000000
--- a/doc-src/dev/addingviews.html
+++ /dev/null
@@ -1,52 +0,0 @@
-As discussed in [the Flow View section of the mitmproxy
-overview](@!urlTo("mitmproxy.html")!@), mitmproxy allows you to inspect and
-manipulate flows. When inspecting a single flow, mitmproxy uses a number of
-heuristics to show a friendly view of various content types; if mitmproxy
-cannot show a friendly view, mitmproxy defaults to a __raw__ view.
-
-Each content type invokes a different flow viewer to parse the data and display
-the friendly view. Users can add custom content viewers by adding a view class
-to contentview.py, discussed below.
-
-## Adding a new View class to contentview.py
-
-The content viewers used by mitmproxy to present a friendly view of various
-content types are stored in contentview.py. Reviewing this file shows a number
-of classes named ViewSomeDataType, each with the properties: __name__,
-__prompt__, and __content\_types__ and a function named __\_\_call\_\___.
-
-Adding a new content viewer to parse a data type is as simple as writing a new
-View class. Your new content viewer View class should have the same properties
-as the other View classes: __name__, __prompt__, and __content\_types__ and a
-__\_\_call\_\___ function to parse the content of the request/response.
-
-* The __name__ property should be a string describing the contents and new content viewer;
-* The __prompt__ property should be a two item tuple:
-
- - __1__: A string that will be used to display the new content viewer's type; and
- - __2__: A one character string that will be the hotkey used to select the new content viewer from the Flow View screen;
-
-* The __content\_types__ property should be a list of strings of HTTP Content\-Types that the new content viewer can parse.
- * Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png".
-
-After defining the __name__, __prompt__, and __content\_types__ properties of
-the class, you should write the __\_\_call\_\___ function, which will parse the
-request/response data and provide a friendly view of the data. The
-__\_\_call\_\___ function should take the following arguments: __self__,
-__hdrs__, __content__, __limit__; __hdrs__ is a ODictCaseless object containing
-the headers of the request/response; __content__ is the content of the
-request/response, and __limit__ is an integer representing the amount of data
-to display in the view window.
-
-The __\_\_call\_\___ function returns two values: (1) a string describing the
-parsed data; and (2) the parsed data for friendly display. The parsed data to
-be displayed should be a list of strings formatted for display. You can use
-the __\_view\_text__ function in contentview.py to format text for display.
-Alternatively, you can display content as a series of key-value pairs; to do
-so, prepare a list of lists, where each list item is a two item list -- a key
-that describes the data, and then the data itself; after preparing the list of
-lists, use the __common.format\_keyvals__ function on it to prepare it as text
-for display.
-
-If the new content viewer fails or throws an exception, mitmproxy will default
-to a __raw__ view.
diff --git a/doc-src/dev/architecture.html b/doc-src/dev/architecture.html
deleted file mode 100644
index ae81b6c6..00000000
--- a/doc-src/dev/architecture.html
+++ /dev/null
@@ -1,8 +0,0 @@
-To give you a better understanding of how mitmproxy works, mitmproxy's
-high-level architecture is detailed in the following graphic:
-
-<img class="img-responsive" src="@!urlTo('schematics/architecture.png')!@">
-
-<a href="@!urlTo('schematics/architecture.pdf')!@">(architecture.pdf)</a>
-<p>Please don't refrain from asking any further
-questions on the mailing list, the IRC channel or the GitHub issue tracker.</p>
diff --git a/doc-src/dev/index.py b/doc-src/dev/index.py
deleted file mode 100644
index ddf100d0..00000000
--- a/doc-src/dev/index.py
+++ /dev/null
@@ -1,8 +0,0 @@
-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
deleted file mode 100644
index 1826fc2e..00000000
--- a/doc-src/dev/sslkeylogfile.html
+++ /dev/null
@@ -1,8 +0,0 @@
-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/dev/testing.html b/doc-src/dev/testing.html
deleted file mode 100644
index 4cee29e8..00000000
--- a/doc-src/dev/testing.html
+++ /dev/null
@@ -1,43 +0,0 @@
-
-All the mitmproxy projects strive to maintain 100% code coverage. In general,
-patches and pull requests will be declined unless they're accompanied by a
-suitable extension to the test suite.
-
-Our tests are written for the [nose](https://nose.readthedocs.org/en/latest/).
-At the point where you send your pull request, a command like this:
-
-<pre class="terminal">
-> nosetests --with-cov --cov-report term-missing ./test
-</pre>
-
-Should give output something like this:
-
-<pre class="terminal">
-> ---------- coverage: platform darwin, python 2.7.2-final-0 --
-> Name Stmts Miss Cover Missing
-> ----------------------------------------------------
-> libmproxy/__init__ 0 0 100%
-> libmproxy/app 4 0 100%
-> libmproxy/cmdline 100 0 100%
-> libmproxy/controller 69 0 100%
-> libmproxy/dump 150 0 100%
-> libmproxy/encoding 39 0 100%
-> libmproxy/filt 201 0 100%
-> libmproxy/flow 891 0 100%
-> libmproxy/proxy 427 0 100%
-> libmproxy/script 27 0 100%
-> libmproxy/utils 133 0 100%
-> libmproxy/version 4 0 100%
-> ----------------------------------------------------
-> TOTAL 2045 0 100%
-> ----------------------------------------------------
-> Ran 251 tests in 11.864s
-</pre>
-
-
-There are exceptions to the coverage requirement - for instance, much of the
-console interface code can't sensibly be unit tested. These portions are
-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.
-