From 7cf9740fd439ff0ae8880aeeadb5e5c11ab51b88 Mon Sep 17 00:00:00 2001
From: Luke Taylor <luke.taylor@springsource.com>
Date: Fri, 17 Dec 2010 17:09:20 +0000
Subject: [PATCH] SEC-1638: Added an example configuration to the Javadoc for
 ChannelProcessingFilter and a pointer from the reference manual.

---
 docs/manual/src/docbook/namespace-config.xml  |  6 ++-
 .../channel/ChannelProcessingFilter.java      | 45 ++++++++++++++++---
 2 files changed, 45 insertions(+), 6 deletions(-)

diff --git a/docs/manual/src/docbook/namespace-config.xml b/docs/manual/src/docbook/namespace-config.xml
index ab4c93c775..c232a93b22 100644
--- a/docs/manual/src/docbook/namespace-config.xml
+++ b/docs/manual/src/docbook/namespace-config.xml
@@ -454,7 +454,11 @@
   </http>]]>
         </programlisting>With this configuration in place, if a user attempts to access
                 anything matching the "/secure/**" pattern using HTTP, they will first be redirected
-                to an HTTPS URL. The available options are "http", "https" or "any". Using the value
+                to an HTTPS URL
+                <footnote><para>For more details on how channel-processing is implemented, see the Javadoc
+                 for <classname>ChannelProcessingFilter</classname> and related classes.
+                </para></footnote>.
+                The available options are "http", "https" or "any". Using the value
                 "any" means that either HTTP or HTTPS can be used. </para>
             <para>If your application uses non-standard ports for HTTP and/or HTTPS, you can specify
                 a list of port mappings as follows: <programlisting><![CDATA[
diff --git a/web/src/main/java/org/springframework/security/web/access/channel/ChannelProcessingFilter.java b/web/src/main/java/org/springframework/security/web/access/channel/ChannelProcessingFilter.java
index 98330c21bb..983ce37724 100644
--- a/web/src/main/java/org/springframework/security/web/access/channel/ChannelProcessingFilter.java
+++ b/web/src/main/java/org/springframework/security/web/access/channel/ChannelProcessingFilter.java
@@ -36,11 +36,46 @@ import org.springframework.web.filter.GenericFilterBean;
 
 /**
  * Ensures a web request is delivered over the required channel.
- * <p>Internally uses a {@link FilterInvocation} to represent the request, so that the
- * <code>FilterInvocation</code>-related property editors and lookup classes can be used.</p>
- * <p>Delegates the actual channel security decisions and necessary actions to the configured
- * {@link ChannelDecisionManager}. If a response is committed by the <code>ChannelDecisionManager</code>,
- * the filter chain will not proceed.</p>
+ * <p>
+ * Internally uses a {@link FilterInvocation} to represent the request, allowing a
+ * {@code FilterInvocationSecurityMetadataSource} to be used to lookup the attributes which apply.
+ * <p>
+ * Delegates the actual channel security decisions and necessary actions to the configured
+ * {@link ChannelDecisionManager}. If a response is committed by the {@code ChannelDecisionManager},
+ * the filter chain will not proceed.
+ * <p>
+ * The most common usage is to ensure that a request takes place over HTTPS, where the
+ * {@link ChannelDecisionManagerImpl} is configured with a {@link SecureChannelProcessor} and an
+ * {@link InsecureChannelProcessor}. A typical configuration would be
+ * <pre>
+ *
+&lt;bean id="channelProcessingFilter" class="org.springframework.security.web.access.channel.ChannelProcessingFilter">
+  &lt;property name="channelDecisionManager" ref="channelDecisionManager"/>
+  &lt;property name="securityMetadataSource">
+    &lt;security:filter-security-metadata-source path-type="regex">
+      &lt;security:intercept-url pattern="\A/secure/.*\Z" access="REQUIRES_SECURE_CHANNEL"/>
+      &lt;security:intercept-url pattern="\A/login.jsp.*\Z" access="REQUIRES_SECURE_CHANNEL"/>
+      &lt;security:intercept-url pattern="\A/.*\Z" access="ANY_CHANNEL"/>
+    &lt;/security:filter-security-metadata-source>
+  &lt;/property>
+&lt;/bean>
+
+&lt;bean id="channelDecisionManager" class="org.springframework.security.web.access.channel.ChannelDecisionManagerImpl">
+  &lt;property name="channelProcessors">
+    &lt;list>
+    &lt;ref bean="secureChannelProcessor"/>
+    &lt;ref bean="insecureChannelProcessor"/>
+    &lt;/list>
+  &lt;/property>
+&lt;/bean>
+
+&lt;bean id="secureChannelProcessor"
+  class="org.springframework.security.web.access.channel.SecureChannelProcessor"/>
+&lt;bean id="insecureChannelProcessor"
+  class="org.springframework.security.web.access.channel.InsecureChannelProcessor"/>
+
+ * </pre>
+ * which would force the login form and any access to the {@code /secure} path to be made over HTTPS.
  *
  * @author Ben Alex
  */