]> ruderich.org/simon Gitweb - tlsproxy/tlsproxy.git/commitdiff
README: Add information about -u option.
authorSimon Ruderich <simon@ruderich.org>
Tue, 15 Mar 2011 21:31:50 +0000 (22:31 +0100)
committerSimon Ruderich <simon@ruderich.org>
Tue, 15 Mar 2011 21:31:50 +0000 (22:31 +0100)
README

diff --git a/README b/README
index ebcb53fb201f0c111e20a2dc249d272e441f1f76..444bec794b59e0573ac4b69f8bc13cc26c665aa5 100644 (file)
--- a/README
+++ b/README
@@ -56,3 +56,31 @@ also easy to spot in the browser because it uses an invalid hostname
 
 If an internal error occurs before the TLS connection can be established a 503
 Forwarding failure is sent to the client (unencrypted).
+
+
+-u option
+~~~~~~~~~
+
+The '-u' option passes through connections for hostnames with no stored
+certificate (i.e. `certificate-*-server.pem` is missing or unreadable). In
+this case the normal CA chain in your browser lets you validate the server
+certificate. If the server certificate changes you're _not_ informed!
+
+This option is useful if you often visit websites using HTTPS but you don't
+use critical information (e.g. no passwords, etc.) on this website.
+
+For hostnames with a stored server certificate everything works as usual and a
+certificate change is detected.
+
+WARNING: The option might cause security problems if you're not careful:
+
+For example you normally visit https://example.org/ and store the server
+certificate in `certificate-example.org.server.pem`. Without '-u' everything
+is fine.
+
+But if you use '-u' and an attacker redirects you to e.g.
+https://www.example.org/ (or https://whatever.org/) (for example through a
+link on a different site) then the proxy just forwards the TLS connection
+(because it doesn't know the fingerprint for https://www.example.org/, that's
+how '-u' works) and you won't be aware that a different server certificate
+might be used!