-sudo keytool -importcert -alias mitmproxy -storepass "password" \ --keystore /System/Library/Java/Support/CoreDeploy.bundle/Contents/Home/lib/security/cacerts \ --trustcacerts -file ~/.mitmproxy/mitmproxy-ca-cert.pem -

------BEGIN PRIVATE KEY----- -<private key> ------END PRIVATE KEY----- ------BEGIN CERTIFICATE----- -<cert> ------END CERTIFICATE----- ------BEGIN CERTIFICATE----- -<intermediary cert (optional)> ------END CERTIFICATE----- -

-> openssl genrsa -out cert.key 8192 -> openssl req -new -x509 -key cert.key -out cert.crt - (Specify the mitm domain as Common Name, e.g. *.google.com) -> cat cert.key cert.crt > cert.pem -> mitmproxy --cert=cert.pem -

+-----BEGIN PRIVATE KEY----- +<private key> +-----END PRIVATE KEY----- +-----BEGIN CERTIFICATE----- +<cert> +-----END CERTIFICATE----- +-----BEGIN CERTIFICATE----- +<intermediary cert (optional)> +-----END CERTIFICATE----- +

+> openssl genrsa -out cert.key 2048 +> openssl req -new -x509 -key cert.key -out cert.crt + (Specify the mitm domain as Common Name, e.g. *.google.com) +> cat cert.key cert.crt > cert.pem +> mitmproxy --cert=cert.pem +

-----BEGIN PRIVATE KEY----- @@ -88,26 +90,20 @@ this: For example, you can generate a certificate in this format using these instructions:

-> openssl genrsa -out cert.key 2048
-> openssl req -new -x509 -key cert.key -out cert.crt
+$ openssl genrsa -out cert.key 2048
+$ openssl req -new -x509 -key cert.key -out cert.crt
     (Specify the mitm domain as Common Name, e.g. *.google.com)
-> cat cert.key cert.crt > cert.pem
-> mitmproxy --cert=cert.pem
+$ cat cert.key cert.crt > cert.pem
+$ mitmproxy --cert=cert.pem

Using a client side certificate ------------------------------------ -You can use a client certificate by passing the --client-certs DIRECTORY option to mitmproxy. -If you visit example.org, mitmproxy looks for a file named example.org.pem in the specified directory -and uses this as the client cert. The certificate file needs to be in the PEM format and should contain -both the unencrypted private key as well as the certificate. +You can use a client certificate by passing the --client-certs DIRECTORY option to mitmproxy. If you visit example.org, mitmproxy looks for a file named example.org.pem in the specified directory and uses this as the client cert. The certificate file needs to be in the PEM format and should contain both the unencrypted private key as well as the certificate. Using a custom certificate authority ------------------------------------ -By default, mitmproxy will (generate and) use ~/.mitmproxy/mitmproxy-ca.pem as the default certificate -authority to generate certificates for all domains for which no custom certificate is provided (see above). -You can use your own certificate authority by passing the --confdir option to mitmproxy. -mitmproxy will then look for mitmproxy-ca.pem in the specified directory. If no such file exists, -it will be generated automatically. +By default, mitmproxy will (generate and) use ~/.mitmproxy/mitmproxy-ca.pem as the default certificate authority to generate certificates for all domains for which no custom certificate is provided (see above). You can use your own certificate authority by passing the --confdir option to mitmproxy. mitmproxy will then look for mitmproxy-ca.pem in the specified directory. If no such file exists, it will be generated automatically. + -- cgit v1.2.3 From 5ca85bc5f4accf701dc07b09744e51b2af4334a7 Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Fri, 10 Apr 2015 02:20:43 -0400 Subject: Minor reorg and add link for Chrome on Linux --- doc-src/certinstall/ssl.html | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'doc-src') diff --git a/doc-src/certinstall/ssl.html b/doc-src/certinstall/ssl.html index 8d27f0ef..e9b7df72 100644 --- a/doc-src/certinstall/ssl.html +++ b/doc-src/certinstall/ssl.html @@ -21,6 +21,11 @@ Most of the time you can easily install mitmproxy's CA certificate through the w iOS Simulator Java + + iOS + Android/Android Simulator + + Windows Mac OS X @@ -30,9 +35,9 @@ Most of the time you can easily install mitmproxy's CA certificate through the w Firefox - iOS - Android/Android Simulator + Chrome on Linux + More On mitmproxy Certificates -- cgit v1.2.3 From fb0e2bf1f98f824a8161f8434ec7cffc4255fea1 Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 11 Apr 2015 16:45:48 -0400 Subject: Cleaned up Ubuntu docs and added Windows installation information --- doc-src/install.html | 48 ++++++++++++++++++++++++++++------------ doc-src/winppythoninstaller.jpg | Bin 0 -> 46628 bytes 2 files changed, 34 insertions(+), 14 deletions(-) create mode 100644 doc-src/winppythoninstaller.jpg (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index 682e317e..2e9de63b 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -1,20 +1,19 @@ ## Installing from source -The preferred way to install mitmproxy - whether you're installing the latest -release or from source - is to use [pip](http://www.pip-installer.org/). If you -don't already have pip on your system, you can find installation instructions -[here](http://www.pip-installer.org/en/latest/installing.html). +The preferred way to install mitmproxy - whether you're installing the latest release or from source - is to use [pip](http://www.pip-installer.org/). If you don't already have pip on your system, you can find installation instructions [here](http://www.pip-installer.org/en/latest/installing.html). + +If you are looking for a more information on how to install mitmproxy directly from the master branch on GitHub, or are wanting to set up mitmproxy for developement purposes, see the Hacking section of the README on GitHub.

-pip install mitmproxy
+$ sudo pip install mitmproxy

If you also want to install the optional packages AMF, protobuf and CSS content views, do this:

-pip install "mitmproxy[contentviews]"
+$ sudo pip install "mitmproxy[contentviews]"

@@ -46,14 +45,35 @@ video/*; /usr/bin/open -Wn %s ## Ubuntu -On Ubuntu, you will need the following native packages to install mitmproxy -from source: +Ubuntu comes with Python but we need to install pip, python-dev and several libraries. This was tested on a fully patched installation of Ubuntu 14.04. + +

+$ sudo apt-get python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev
+
+$ sudo pip install mitmproxy
+

+ + +## Windows + +mitmweb and mitmdump are the only parts of mitmproxy that work on Windows. -- build-essential -- python-dev -- libffi-dev -- libssl-dev -- libxml2-dev -- libxslt1-dev +Install the latest version of Python 2 from the Python website. The Windows MSI installer is fairly straight forward and even includes pip as long as you are installing a version of Python 2 after 2.7.9. One option you should change during installation is "Add python.exe to Path". This will make it easier to run Python. +

+Now log out of Windows and back in to finish having Python added to your PATH. + +

+C:\> pip install mitmproxy
+

+ +From that point you just run mitmweb or mitmdump from the Command Prompt + +

+C:\> mitmweb
+

+or +

+C:\> mitmdump
+

diff --git a/doc-src/winppythoninstaller.jpg b/doc-src/winppythoninstaller.jpg new file mode 100644 index 00000000..0473c66a Binary files /dev/null and b/doc-src/winppythoninstaller.jpg differ -- cgit v1.2.3 From 1a5f0e944ee724d39d4814a8414b35f91cfcdf9a Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 11 Apr 2015 17:21:43 -0400 Subject: Fixed english and made each OS consistent --- doc-src/install.html | 18 ++++++------------ doc-src/winppythoninstaller.jpg | Bin 46628 -> 0 bytes 2 files changed, 6 insertions(+), 12 deletions(-) delete mode 100644 doc-src/winppythoninstaller.jpg (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index 2e9de63b..246b3c46 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -6,14 +6,14 @@ The preferred way to install mitmproxy - whether you're installing the latest re If you are looking for a more information on how to install mitmproxy directly from the master branch on GitHub, or are wanting to set up mitmproxy for developement purposes, see the Hacking section of the README on GitHub.

-$ sudo pip install mitmproxy
+$ pip install mitmproxy

If you also want to install the optional packages AMF, protobuf and CSS content views, do this:

-$ sudo pip install "mitmproxy[contentviews]"
+$ pip install "mitmproxy[contentviews]"

@@ -42,6 +42,7 @@ image/*; /usr/bin/open -Wn %s video/*; /usr/bin/open -Wn %s

application/*; /usr/bin/open -Wn %s -- cgit v1.2.3 From 3117dd77339334a7ee45bbd9707c1776f7436852 Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 11 Apr 2015 19:41:16 -0400 Subject: Removed mitmweb referrences and added On This Page section --- doc-src/install.html | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index e4193542..f2fd15ec 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -1,5 +1,11 @@ +## On This Page -## Installing from source +* [Installation From Source](#docSource) +* [Installation On Mac OS X](#docOSX) +* [Installation On Ubuntu](#docUbuntu) +* [Installation On Windows](#docWindows) + +## Installing From Source You can install mitmproxy with pip: @@ -16,8 +22,7 @@ $ pip install "mitmproxy[contentviews]" If you are looking for a more information on how to install mitmproxy directly from the master branch on GitHub, or are wanting to set up mitmproxy for developement purposes, see the Hacking section of the README on GitHub. - -## OSX +## Installation On Mac OS X The easiest way to get up and running on OSX is to download the pre-built binary packages from [mitmproxy.org](http://mitmproxy.org). If you still want to install using pip, there are a few things to keep in mind: @@ -33,9 +38,9 @@ image/*; /usr/bin/open -Wn %s video/*; /usr/bin/open -Wn %s

+$ sudo apt-get install python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev -- If you're running a Python interpreter installed with homebrew (or similar), you may have to install some dependencies by hand. -- Make sure that XCode is installed from the App Store, and that the command-line tools have been downloaded (XCode/Preferences/Downloads). +$ sudo pip install mitmproxy +

-$ sudo apt-get install python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev +If you would like to install mitmproxy directly from the master branch on GitHub or would like to get set up to contribute to the project, ithere are a few OS X specific things to keep in mind. -$ sudo pip install mitmproxy -

+$ openssl genrsa -out cert.key 2048 +$ openssl req -new -x509 -key cert.key -out cert.crt + (Specify the mitm domain as Common Name, e.g. *.google.com) +$ cat cert.key cert.crt > cert.pem +$ mitmproxy --cert=cert.pem +

-$ openssl genrsa -out cert.key 2048 -$ openssl req -new -x509 -key cert.key -out cert.crt - (Specify the mitm domain as Common Name, e.g. *.google.com) -$ cat cert.key cert.crt > cert.pem -$ mitmproxy --cert=cert.pem -

\# Listen for DNS requests on the internal network interface=eth1 \# Act as a DHCP server, assign IP addresses to clients @@ -30,15 +30,15 @@ This walkthrough illustrates how to set up transparent proxying with mitmproxy. dhcp-option=option:router,192.168.3.1 dhcp-option=option:dns-server,192.168.3.1

iptables -t nat -A PREROUTING -i eth1 -p tcp --dport 80 \ -j REDIRECT --to-port 8080 @@ -46,9 +46,8 @@ This walkthrough illustrates how to set up transparent proxying with mitmproxy. -j REDIRECT --to-port 8080

- +

+ $!navbar!$

- -

$!body!$

diff --git a/doc-src/mitmproxy-long.png b/doc-src/mitmproxy-long.png new file mode 100644 index 00000000..f9397d1e Binary files /dev/null and b/doc-src/mitmproxy-long.png differ -- cgit v1.2.3 From b91999507e662cbcce6c7968647d8cbac54fbcb5 Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Sat, 23 May 2015 12:36:52 +1200 Subject: Move websitelayout to website. --- doc-src/_websitelayout.html | 56 --------------------------------------------- doc-src/index.py | 3 +-- 2 files changed, 1 insertion(+), 58 deletions(-) delete mode 100644 doc-src/_websitelayout.html (limited to 'doc-src') diff --git a/doc-src/_websitelayout.html b/doc-src/_websitelayout.html deleted file mode 100644 index 5a7c01bb..00000000 --- a/doc-src/_websitelayout.html +++ /dev/null @@ -1,56 +0,0 @@ - - -

- $!navbar!$ -

- - $!body!$ -

- -

- diff --git a/doc-src/index.py b/doc-src/index.py index 52b9c31a..b049e3ce 100644 --- a/doc-src/index.py +++ b/doc-src/index.py @@ -15,10 +15,9 @@ ns.VERSION = version.VERSION if ns.options.website: ns.idxpath = "doc/index.html" - this.layout = countershape.Layout("_websitelayout.html") else: ns.idxpath = "index.html" - this.layout = countershape.Layout("_layout.html") +this.layout = countershape.Layout("_layout.html") ns.title = countershape.template.Template(None, "

@!this.title!@

") this.titlePrefix = "%s - " % version.NAMEVERSION -- cgit v1.2.3 From 0a812656617be313c6648918f9b4c52a2ddb59c4 Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Sun, 24 May 2015 13:16:49 +1200 Subject: docs: adjust for countershape changes --- doc-src/_layout.html | 88 ++++++++++++++++++++++++++++------------------------ doc-src/index.py | 7 +++-- 2 files changed, 52 insertions(+), 43 deletions(-) (limited to 'doc-src') diff --git a/doc-src/_layout.html b/doc-src/_layout.html index 0a12e25e..221da466 100644 --- a/doc-src/_layout.html +++ b/doc-src/_layout.html @@ -1,46 +1,54 @@ - -

- - -

- $!navbar!$ -

- -

+ +

+ + diff --git a/doc-src/index.py b/doc-src/index.py index b049e3ce..4fefc866 100644 --- a/doc-src/index.py +++ b/doc-src/index.py @@ -2,7 +2,7 @@ import os import sys import datetime import countershape -from countershape import Page, Directory, markup, model +from countershape import Page, Directory, markup import countershape.template MITMPROXY_SRC = os.path.abspath( @@ -17,7 +17,8 @@ if ns.options.website: ns.idxpath = "doc/index.html" else: ns.idxpath = "index.html" -this.layout = countershape.Layout("_layout.html") + +this.layout = countershape.layout.FileLayout("_layout.html") ns.title = countershape.template.Template(None, "

@!this.title!@

") this.titlePrefix = "%s - " % version.NAMEVERSION @@ -51,7 +52,7 @@ def nav(page, current, state): else: pre = "

mitmproxy-ca.pem	The private key and certificate in PEM format.
mitmproxy-ca-cert.pem	The certificate in PEM format. Use this to distribute to most - non-Windows platforms.
mitmproxy-ca-cert.p12	The certificate in PKCS12 format. For use on Windows.
mitmproxy-ca-cert.cer	Same file as .pem, but with an extension expected by some Android - devices.

mitmproxy-ca.pem	The private key and certificate in PEM format.
mitmproxy-ca-cert.pem	The certificate in PEM format. Use this to distribute to most + non-Windows platforms.
mitmproxy-ca-cert.p12	The certificate in PKCS12 format. For use on Windows.
mitmproxy-ca-cert.cer	Same file as .pem, but with an extension expected by some Android + devices.

mitmproxy-ca.pem	The private key and certificate in PEM format.
mitmproxy-ca-cert.pem	The certificate in PEM format. Use this to distribute to most + non-Windows platforms.
mitmproxy-ca-cert.p12	The certificate in PKCS12 format. For use on Windows.
mitmproxy-ca-cert.cer	Same file as .pem, but with an extension expected by some Android + devices.

mitmproxy-ca.pem	The private key and certificate in PEM format.
mitmproxy-ca-cert.pem	The certificate in PEM format. Use this to distribute to most - non-Windows platforms.
mitmproxy-ca-cert.p12	The certificate in PKCS12 format. For use on Windows.
mitmproxy-ca-cert.cer	Same file as .pem, but with an extension expected by some Android - devices.

@!this.title!@

@!this.title!@

@!this.title!@

@!this.title!@

@!this.title!@

@!this.title!@

@!this.title!@

@!this.title!@

Regular Proxy

Common Configurations

@!this.title!@

iOS Simulator	Java
Windows	Mac OS X
Ubuntu/Debian	Firefox
iOS	Android/Android Simulator