aboutsummaryrefslogtreecommitdiffstats
path: root/doc-src
diff options
context:
space:
mode:
Diffstat (limited to 'doc-src')
-rw-r--r--doc-src/certinstall/chrome.html0
-rw-r--r--doc-src/certinstall/firefox.html15
-rw-r--r--doc-src/certinstall/ie.html0
-rw-r--r--doc-src/certinstall/index.py10
-rw-r--r--doc-src/certinstall/ios.html0
-rw-r--r--doc-src/certinstall/safari.html0
-rw-r--r--doc-src/certinstall/windows7.html0
-rw-r--r--doc-src/index.html33
-rw-r--r--doc-src/ssl.html71
9 files changed, 74 insertions, 55 deletions
diff --git a/doc-src/certinstall/chrome.html b/doc-src/certinstall/chrome.html
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/doc-src/certinstall/chrome.html
diff --git a/doc-src/certinstall/firefox.html b/doc-src/certinstall/firefox.html
new file mode 100644
index 00000000..f661a619
--- /dev/null
+++ b/doc-src/certinstall/firefox.html
@@ -0,0 +1,15 @@
+
+### 1: Open preferences, click on "Advanced", then select"Encryption":
+
+<img src="@!urlTo('firefox3.jpg')!@"/>
+
+### 2: Click "View Certificates", "Import", and select the certificate file:
+
+<img src="@!urlTo('firefox3-import.jpg')!@"/>
+
+### 3: Tick "Trust this CS to identify web sites", and click "Ok":
+
+<img src="@!urlTo('firefox3-trust.jpg')!@"/>
+
+You should now see the mitmproxy certificate listed in the Authorities tab.
+
diff --git a/doc-src/certinstall/ie.html b/doc-src/certinstall/ie.html
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/doc-src/certinstall/ie.html
diff --git a/doc-src/certinstall/index.py b/doc-src/certinstall/index.py
new file mode 100644
index 00000000..3dee24ec
--- /dev/null
+++ b/doc-src/certinstall/index.py
@@ -0,0 +1,10 @@
+from countershape import Page
+
+pages = [
+ Page("firefox.html", "Firefox"),
+ Page("chrome.html", "Chrome"),
+ Page("safari.html", "Safari"),
+ Page("ie.html", "Internet Explorer"),
+ Page("windows7.html", "Windows 7"),
+ Page("ios.html", "IOS"),
+]
diff --git a/doc-src/certinstall/ios.html b/doc-src/certinstall/ios.html
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/doc-src/certinstall/ios.html
diff --git a/doc-src/certinstall/safari.html b/doc-src/certinstall/safari.html
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/doc-src/certinstall/safari.html
diff --git a/doc-src/certinstall/windows7.html b/doc-src/certinstall/windows7.html
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/doc-src/certinstall/windows7.html
diff --git a/doc-src/index.html b/doc-src/index.html
index 49e7327f..8110bf79 100644
--- a/doc-src/index.html
+++ b/doc-src/index.html
@@ -1,25 +1,26 @@
* [Introduction](@!urlTo("intro.html")!@)
+* [mitmproxy](@!urlTo("/mitmproxy.html")!@)
+* [mitmdump](@!urlTo("/mitmdump.html")!@)
+* [Client script API](@!urlTo("scripts.html")!@)
+* [libmproxy](@!urlTo("library.html")!@)
+* [SSL](@!urlTo("/ssl.html")!@)
+ * Browser certificate installation:
+ * [Firefox](@!urlTo("certinstall/firefox.html")!@#firefox)
+ * [Chrome](@!urlTo("certinstall/chrome.html")!@#chrome)
+ * [Safari](@!urlTo("certinstall/safari.html")!@#safari)
+ * [Internet Explorer](@!urlTo("certinstall/ie.html")!@#ie)
+ * System-wide certificate installation:
+ * [Windows 7](@!urlTo("certinstall/windows7.html")!@#windows7)
+ * [iPhone/iPad](@!urlTo("certinstall/ios.html")!@#ios)
* Tutorials
* Client replay: a 30 second example
- * Scripting: On-the-fly modifications to HTTP conversations
- * Breaking iPhone apps for fun and profit
-* Reference
- * [mitmproxy - HTTP Swiss Army Knife](@!urlTo("/mitmproxy.html")!@)
- * [mitmdump - A tcpdump-like tool for HTTP](@!urlTo("/mitmdump.html")!@)
- * [Client scripts](@!urlTo("scripts.html")!@)
- * [libmproxy](@!urlTo("library.html")!@) - Using the mitmproxy library
-* Installing mitmproxy's SSL certificate
- * [Firefox](@!urlTo("ssl.html")!@#firefox)
- * [Chrome](@!urlTo("ssl.html")!@#chrome)
- * [Safari](@!urlTo("ssl.html")!@#safari)
- * [IE8](@!urlTo("ssl.html")!@#ie)
- * System-wide installation:
- * [Windows 7](@!urlTo("ssl.html")!@#windows7)
- * [iPhone/iPad](@!urlTo("ssl.html")!@#ios)
+ * Scripting: On-the-fly modifications to HTTP conversations [coming soon]
+ * Sticky cookies [coming soon]
+ * Breaking iPhone apps for fun and profit [coming soon]
* [FAQ](@!urlTo("faq.html")!@)
-* [administrivia](@!urlTo("admin.html")!@)
+* [Administrivia](@!urlTo("admin.html")!@)
diff --git a/doc-src/ssl.html b/doc-src/ssl.html
index 4fe1ee15..06d5a9d6 100644
--- a/doc-src/ssl.html
+++ b/doc-src/ssl.html
@@ -1,41 +1,34 @@
-# Browsers
-
-<a name="firefox"></a>
-## Firefox 3.x
-
-### 1: Open preferences, click on "Advanced", then select"Encryption":
-
-<img src="@!urlTo('firefox3.jpg')!@"/>
-
-### 2: Click "View Certificates", "Import", and select the certificate file:
-
-<img src="@!urlTo('firefox3-import.jpg')!@"/>
-
-### 3: Tick "Trust this CS to identify web sites", and click "Ok":
-
-<img src="@!urlTo('firefox3-trust.jpg')!@"/>
-
-You should now see the mitmproxy certificate listed in the Authorities tab.
-
-
-<a name="chrome"></a>
-## Chrome
-
-<a name="safari"></a>
-## Safari
-
-<a name="ie"></a>
-## Internet Explorer 8
-
-
-# Global installation
-
-<a name="windows"></a>
-## Windows 7
-
-<a name="ios"></a>
-## iPhone/iPad
-
-
+SSL
+===
+
+The first time __mitmproxy__ or __mitmdump__ is started, a dummy SSL
+certificate authority is generated (the default location is
+~/.mitmproxy/ca.pem). This dummy CA is used to generate dummy certificates for
+SSL interception on-the-fly. Since your browser won't trust the __mitmproxy__
+dummy CA out of the box (and rightly so), so you will see an SSL cert warning
+every time you visit a new SSL domain through __mitmproxy__. When you're
+testing a single site, just accepting the bogus SSL cert manually is not too
+much of a hassle, but there are a number of cases where you will want to
+configure your testing system or browser to trust __mitmproxy__:
+
+- If you are testing non-browser software that checks SSL cert validiy.
+- You are testing an app that makes non-interactive (JSONP, script src, etc.)
+requests to SSL resources. Another workaround in this case is to manually visit
+the page through the browser, and add a certificate exception.
+- You just don't want to deal with the hassle of continuously adding cert
+exceptions.
+
+
+Installing the mitmproxy CA
+===========================
+
+* Browser certificate installation:
+ * [Firefox](@!urlTo("certinstall/firefox.html")!@#firefox)
+ * [Chrome](@!urlTo("certinstall/chrome.html")!@#chrome)
+ * [Safari](@!urlTo("certinstall/safari.html")!@#safari)
+ * [Internet Explorer](@!urlTo("certinstall/ie.html")!@#ie)
+* System-wide certificate installation:
+ * [Windows 7](@!urlTo("certinstall/windows7.html")!@#windows7)
+ * [iPhone/iPad](@!urlTo("certinstall/ios.html")!@#ios)