Changes between Version 6 and Version 7 of PermRedirectPlugin

Timestamp:

Nov 20, 2012, 2:59:54 PM (11 years ago)

Author:

ejucovy

Comment:

note about apache NE

PermRedirectPlugin

@@ -12 +12 @@
 These features are independent of one another -- you can install the plugin to provide either feature, or both.
 
-== Bugs/Feature Requests == 
-
-Existing bugs and feature requests for PermRedirectPlugin are 
-[report:9?COMPONENT=PermRedirectPlugin here].
-
-If you have any issues, create a 
-[http://trac-hacks.org/newticket?component=PermRedirectPlugin&owner=ejucovy new ticket].
-
-== Download ==
-
-Download the zipped source from [download:permredirectplugin here].
-
-== Source ==
-
-You can check out PermRedirectPlugin from [http://trac-hacks.org/svn/permredirectplugin here] using Subversion, or [source:permredirectplugin browse the source] with Trac.
-
-== Example ==
+== Usage ==
 
 To enable:
@@ -54 +38 @@
 }}}
 
+== HTTPS Only ==
+
+The plugin provides a feature to ensure that all requests to the login page occur over HTTPS, which can be enabled per the "usage" section above.  This will intercept all requests to http://hostname.com/login and redirect them to https://hostname.com/login instead.  In order for this feature to work, you must configure your web server to accept HTTPS requests on port 443.  This feature will only work if your web server is serving HTTP requests on port 80 and HTTPS requests on port 443; no other configurations are currently supported.  Also, '''this feature should only be enabled if you are using AccountManager to handle login.'''  If your site's login occurs in the web server (e.g. Apache authentication) then this feature will not be able to secure your login handler.
+
+It is also possible to implement a similar feature without this plugin at all, using RewriteRules in your Apache configuration.  This alternative approach must be used if you are handling login through the Apache web server.  Your Apache configuration would include lines like:
+{{{
+# Redirect all login pages to https
+RewriteCond %{HTTPS} off
+RewriteRule ^/([^/]+)/login$ https://%{HTTP_HOST}:443/$1/login [L, NE]
+}}}
+
+For more details, see the various example configurations posted in comments at http://trac.edgewall.org/ticket/4733
+
+== Frequently Asked Questions ==
+
+ * After logging in, Trac always loads the home page, instead of the page the user came from.  On the login page, the `?referer` query string is double-quoted (double-encoded), and looks like `?referer=http%253A%252F%252Fthe_host%252Fthe_project%252Ftimeline` (with the "%" in "%3A" re-quoted to create "%253A") instead of `?http%3A%2F%2Fthe_host%2Fthe_project%252Ftimeline`.
+
+This is caused by a faulty Apache configuration.  You are probably using a `RewriteRule` to redirect login over HTTPS.  You must use the `[NE]` (no-escape) flag on your `RewriteRule` to prevent double-quoting.  For more information, see http://trac-hacks.org/ticket/2210#comment:36
+
+== Bugs/Feature Requests == 
+
+Existing bugs and feature requests for PermRedirectPlugin are 
+[report:9?COMPONENT=PermRedirectPlugin here].
+
+If you have any issues, create a 
+[http://trac-hacks.org/newticket?component=PermRedirectPlugin&owner=ejucovy new ticket].
+
+== Download ==
+
+Download the zipped source from [download:permredirectplugin here].
+
+== Source ==
+
+You can check out PermRedirectPlugin from [http://trac-hacks.org/svn/permredirectplugin here] using Subversion, or [source:permredirectplugin browse the source] with Trac.
+
 == Recent Changes ==