You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by jd...@apache.org on 2010/11/28 19:41:39 UTC
svn commit: r1039920 - in /wicket/trunk/wicket/src:
main/java/org/apache/wicket/protocol/http/
main/java/org/apache/wicket/protocol/http/filter/
main/java/org/apache/wicket/protocol/http/servlet/
main/java/org/apache/wicket/util/tester/ test/java/org/a...
Author: jdonnerstag
Date: Sun Nov 28 18:41:38 2010
New Revision: 1039920
URL: http://svn.apache.org/viewvc?rev=1039920&view=rev
Log:
fixed WICKET-3015 add (even more) support for front-end proxies (schema, client ip, ...)
restructure. Didn't like the first draft too much
Issue: WICKET-3015
Added:
wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/AbstractRequestWrapperFactory.java
- copied, changed from r1039878, wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/filter/AbstractWicketFilterExtension.java
wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/IRequestWrapperFactory.java
- copied, changed from r1039878, wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/filter/IWicketFilterExtension.java
wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/SecuredRemoteAddressRequestWrapper.java
wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapper.java
- copied, changed from r1039878, wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequest.java
wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapperFactory.java
wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedRequestWrapperTest.java
- copied, changed from r1039878, wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedWicketFilterExtensionTest.java
Removed:
wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/filter/
wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequest.java
wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedWicketFilterExtensionTest.java
Modified:
wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java
wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WicketFilter.java
wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java
Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java?rev=1039920&r1=1039919&r2=1039920&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java Sun Nov 28 18:41:38 2010
@@ -146,7 +146,6 @@ public abstract class WebApplication ext
/** The WicketFilter that this application is attached to */
private WicketFilter wicketFilter;
-
/**
* Constructor. <strong>Use {@link #init()} for any configuration of your application instead of
* overriding the constructor.</strong>
Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WicketFilter.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WicketFilter.java?rev=1039920&r1=1039919&r2=1039920&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WicketFilter.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/WicketFilter.java Sun Nov 28 18:41:38 2010
@@ -17,7 +17,6 @@
package org.apache.wicket.protocol.http;
import java.io.IOException;
-import java.util.List;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
@@ -30,12 +29,10 @@ import javax.servlet.http.HttpServletRes
import org.apache.wicket.ThreadContext;
import org.apache.wicket.WicketRuntimeException;
-import org.apache.wicket.protocol.http.filter.IWicketFilterExtension;
import org.apache.wicket.request.cycle.RequestCycle;
import org.apache.wicket.request.http.WebRequest;
import org.apache.wicket.request.http.WebResponse;
import org.apache.wicket.util.file.WebXmlFile;
-import org.apache.wicket.util.lang.Generics;
import org.apache.wicket.util.string.Strings;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -79,8 +76,6 @@ public class WicketFilter implements Fil
// filterPath length without trailing "/"
private int filterPathLength = -1;
- private List<IWicketFilterExtension> filterChain;
-
/**
* @return The class loader
*/
@@ -102,15 +97,6 @@ public class WicketFilter implements Fil
boolean processRequest(ServletRequest request, final ServletResponse response,
final FilterChain chain) throws IOException, ServletException
{
- // Add request wrappers if needed
- if (filterChain != null)
- {
- for (IWicketFilterExtension filter : filterChain)
- {
- request = filter.getRequestWrapper(request);
- }
- }
-
// Assume we are able to handle the request
boolean res = true;
@@ -291,14 +277,6 @@ public class WicketFilter implements Fil
application.setName(filterConfig.getFilterName());
application.setWicketFilter(this);
- if (filterChain != null)
- {
- for (IWicketFilterExtension filter : filterChain)
- {
- filter.init(application, isServlet, filterConfig);
- }
- }
-
// Allow the filterPath to tbe preset via setFilterPath()
if (filterPath == null)
{
@@ -353,7 +331,7 @@ public class WicketFilter implements Fil
* Stub method that lets subclasses configure filter path from annotations.
*
* @param isServlet
- * @return
+ * @return Filter path from annotation
*/
protected String getFilterPathFromAnnotation(boolean isServlet)
{
@@ -566,18 +544,4 @@ public class WicketFilter implements Fil
}
this.filterPath = filterPath;
}
-
- /**
- * Sets the first element of the filter chain, which prepends Wicket's default processing
- *
- * @param filter
- */
- public final void addFilter(IWicketFilterExtension filter)
- {
- if (filterChain == null)
- {
- filterChain = Generics.newArrayList(2);
- }
- filterChain.add(filter);
- }
}
Copied: wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/AbstractRequestWrapperFactory.java (from r1039878, wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/filter/AbstractWicketFilterExtension.java)
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/AbstractRequestWrapperFactory.java?p2=wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/AbstractRequestWrapperFactory.java&p1=wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/filter/AbstractWicketFilterExtension.java&r1=1039878&r2=1039920&rev=1039920&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/filter/AbstractWicketFilterExtension.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/AbstractRequestWrapperFactory.java Sun Nov 28 18:41:38 2010
@@ -14,13 +14,12 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.wicket.protocol.http.filter;
+package org.apache.wicket.protocol.http.servlet;
import java.util.List;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
-import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import org.apache.wicket.util.lang.Generics;
@@ -31,10 +30,10 @@ import org.slf4j.LoggerFactory;
/**
* @author Juergen Donnerstag
*/
-public abstract class AbstractWicketFilterExtension implements IWicketFilterExtension
+public abstract class AbstractRequestWrapperFactory implements IRequestWrapperFactory
{
/** Logger */
- private static final Logger log = LoggerFactory.getLogger(AbstractWicketFilterExtension.class);
+ private static final Logger log = LoggerFactory.getLogger(AbstractRequestWrapperFactory.class);
/**
* {@link Pattern} for a comma delimited string that support whitespace characters
@@ -63,14 +62,14 @@ public abstract class AbstractWicketFilt
}
/**
- * @see org.apache.wicket.protocol.http.filter.IWicketFilterExtension#getRequestWrapper(javax.servlet.ServletRequest)
+ * @see org.apache.wicket.protocol.http.servlet.IRequestWrapperFactory#getWrapper(javax.servlet.HttpServletRequest)
*/
- public ServletRequest getRequestWrapper(final ServletRequest servletRequest)
+ public HttpServletRequest getWrapper(final HttpServletRequest servletRequest)
{
- ServletRequest xRequest = servletRequest;
- if (isEnabled() && (servletRequest instanceof HttpServletRequest))
+ HttpServletRequest xRequest = servletRequest;
+ if (isEnabled() && needsWrapper(servletRequest))
{
- return getHttpRequestWrapper((HttpServletRequest)servletRequest);
+ return newRequestWrapper(servletRequest);
}
return xRequest;
}
@@ -78,9 +77,16 @@ public abstract class AbstractWicketFilt
/**
*
* @param request
+ * @return True, if a wrapper is needed
+ */
+ abstract boolean needsWrapper(final HttpServletRequest request);
+
+ /**
+ *
+ * @param request
* @return Either the original request or a wrapper
*/
- abstract public HttpServletRequest getHttpRequestWrapper(HttpServletRequest request);
+ abstract public HttpServletRequest newRequestWrapper(HttpServletRequest request);
/**
* Convert a given comma delimited list of regular expressions into an array of compiled
Copied: wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/IRequestWrapperFactory.java (from r1039878, wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/filter/IWicketFilterExtension.java)
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/IRequestWrapperFactory.java?p2=wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/IRequestWrapperFactory.java&p1=wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/filter/IWicketFilterExtension.java&r1=1039878&r2=1039920&rev=1039920&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/filter/IWicketFilterExtension.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/IRequestWrapperFactory.java Sun Nov 28 18:41:38 2010
@@ -14,30 +14,30 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.wicket.protocol.http.filter;
+package org.apache.wicket.protocol.http.servlet;
import javax.servlet.FilterConfig;
-import javax.servlet.ServletException;
-import javax.servlet.ServletRequest;
+import javax.servlet.http.HttpServletRequest;
import org.apache.wicket.Application;
/**
- * Allows to pre-process requests
+ * Added to WicketFilter and allow to preprocess the request if needed. E.g. to replace the request
+ * object with a wrapper that manages XForwarded headers properly.
+ *
+ * @author Juergen Donnerstag
*/
-public interface IWicketFilterExtension
+public interface IRequestWrapperFactory
{
/**
- * Allows to return HttpServletRequestWrapper managed by Wicket
- *
* @param request
- * @return Either the original request or the wrapper
+ * @return Either the original request or a wrapper
*/
- ServletRequest getRequestWrapper(final ServletRequest request);
+ HttpServletRequest getWrapper(final HttpServletRequest request);
/**
* Servlets and Filters are treated essentially the same with Wicket. This is the entry point
- * for both of them.
+ * for both of them and allows to initialize the object.
*
* @see #init(FilterConfig)
*
@@ -45,7 +45,6 @@ public interface IWicketFilterExtension
* @param isServlet
* True if Servlet, false of Filter
* @param filterConfig
- * @throws ServletException
*/
void init(Application application, boolean isServlet, FilterConfig filterConfig);
}
\ No newline at end of file
Added: wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/SecuredRemoteAddressRequestWrapper.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/SecuredRemoteAddressRequestWrapper.java?rev=1039920&view=auto
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/SecuredRemoteAddressRequestWrapper.java (added)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/SecuredRemoteAddressRequestWrapper.java Sun Nov 28 18:41:38 2010
@@ -0,0 +1,208 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.wicket.protocol.http.servlet;
+
+import java.util.regex.Pattern;
+
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletRequest;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletRequestWrapper;
+
+import org.apache.wicket.Application;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * <p>
+ * Sets {@link RequestFacade#isSecure()} to <code>true</code> if
+ * {@link ServletRequest#getRemoteAddr()} matches one of the <code>securedRemoteAddresses</code> of
+ * this filter.
+ * </p>
+ * <p>
+ * This filter is often preceded by the {@link XForwardedWicketFilterExtension} to get the remote
+ * address of the client even if the request goes through load balancers (e.g. F5 Big IP, Nortel
+ * Alteon) or proxies (e.g. Apache mod_proxy_http)
+ * </p>
+ * <p>
+ * <strong>Configuration parameters:</strong>
+ * <table border="1">
+ * <tr>
+ * <th>XForwardedFilter property</th>
+ * <th>Description</th>
+ * <th>Format</th>
+ * <th>Default value</th>
+ * </tr>
+ * <tr>
+ * <td>securedRemoteAddresses</td>
+ * <td>IP addresses for which {@link ServletRequest#isSecure()} must return <code>true</code></td>
+ * <td>Comma delimited list of regular expressions (in the syntax supported by the
+ * {@link java.util.regex.Pattern} library)</td>
+ * <td>Class A, B and C <a href="http://en.wikipedia.org/wiki/Private_network">private network IP
+ * address blocks</a> : 10\.\d{1,3}\.\d{1,3}\.\d{1,3}, 192\.168\.\d{1,3}\.\d{1,3},
+ * 172\\.(?:1[6-9]|2\\d|3[0-1]).\\d{1,3}.\\d{1,3}, 169\.254\.\d{1,3}\.\d{1,3},
+ * 127\.\d{1,3}\.\d{1,3}\.\d{1,3}</td>
+ * </tr>
+ * </table>
+ * Note : the default configuration is can usually be used as internal servers are often trusted.
+ * </p>
+ * <p>
+ * <strong>Sample with secured remote addresses limited to 192.168.0.10 and 192.168.0.11</strong>
+ * </p>
+ * <p>
+ * SecuredRemoteAddressFilter configuration sample :
+ * </p>
+ *
+ * <code><pre>
+ * <filter>
+ * <filter-name>SecuredRemoteAddressFilter</filter-name>
+ * <filter-class>fr.xebia.servlet.filter.SecuredRemoteAddressFilter</filter-class>
+ * <init-param>
+ * <param-name>securedRemoteAddresses</param-name><param-value>192\.168\.0\.10, 192\.168\.0\.11</param-value>
+ * </init-param>
+ * </filter>
+ *
+ * <filter-mapping>
+ * <filter-name>SecuredRemoteAddressFilter</filter-name>
+ * <url-pattern>/*</url-pattern>
+ * <dispatcher>REQUEST</dispatcher>
+ * </filter-mapping></pre></code>
+ * <p>
+ * A request with <code>{@link ServletRequest#getRemoteAddr()} = 192.168.0.10 or 192.168.0.11</code>
+ * will be seen as <code>{@link ServletRequest#isSecure()} == true</code> even if
+ * <code>{@link HttpServletRequest#getScheme()} == "http"</code>.
+ * </p>
+ *
+ * @author <a href="mailto:cyrille@cyrilleleclerc.com">Cyrille Le Clerc</a>
+ * @author Juergen Donnerstag
+ */
+public class SecuredRemoteAddressRequestWrapper extends AbstractRequestWrapperFactory
+{
+ /** Logger */
+ private static final Logger log = LoggerFactory.getLogger(SecuredRemoteAddressRequestWrapper.class);
+
+ private final static String SECURED_REMOTE_ADDRESSES_PARAMETER = "securedRemoteAddresses";
+
+ /** */
+ public static class Config
+ {
+ /** @see #setSecuredRemoteAddresses(String) */
+ private Pattern[] securedRemoteAddresses = new Pattern[] {
+ Pattern.compile("10\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"),
+ Pattern.compile("192\\.168\\.\\d{1,3}\\.\\d{1,3}"),
+ Pattern.compile("172\\.(?:1[6-9]|2\\d|3[0-1]).\\d{1,3}.\\d{1,3}"),
+ Pattern.compile("169\\.254\\.\\d{1,3}\\.\\d{1,3}"),
+ Pattern.compile("127\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}") };
+
+ /**
+ * Comma delimited list of secured remote addresses. Expressed with regular expressions.
+ * <p>
+ * Default value : 10\.\d{1,3}\.\d{1,3}\.\d{1,3}, 192\.168\.\d{1,3}\.\d{1,3},
+ * 172\\.(?:1[6-9]|2\\d|3[0-1]).\\d{1,3}.\\d{1,3}, 169\.254\.\d{1,3}\.\d{1,3},
+ * 127\.\d{1,3}\.\d{1,3}\.\d{1,3}
+ *
+ * @param comaDelimitedSecuredRemoteAddresses
+ */
+ public void setSecuredRemoteAdresses(final String comaDelimitedSecuredRemoteAddresses)
+ {
+ securedRemoteAddresses = commaDelimitedListToPatternArray(comaDelimitedSecuredRemoteAddresses);
+ }
+ }
+
+ // Filter Config
+ private Config config = new Config();
+
+ /**
+ * @return SecuredRemoteAddress and XForwarded filter specific config
+ */
+ public final Config getConfig()
+ {
+ return config;
+ }
+
+ /**
+ * The Wicket application might want to provide its own config
+ *
+ * @param config
+ */
+ public final void setConfig(final Config config)
+ {
+ this.config = config;
+ }
+
+ /**
+ * @see org.apache.wicket.protocol.http.servlet.AbstractRequestWrapperFactory#getWrapper(javax.servlet.http.HttpServletRequest)
+ */
+ @Override
+ public HttpServletRequest getWrapper(final HttpServletRequest request)
+ {
+ HttpServletRequest xRequest = super.getWrapper(request);
+
+ if (log.isDebugEnabled())
+ {
+ log.debug("Incoming request uri=" + request.getRequestURI() + " with originalSecure='" +
+ request.isSecure() + "', remoteAddr='" + request.getRemoteAddr() +
+ "' will be seen with newSecure='" + request.isSecure() + "'");
+ }
+
+ return xRequest;
+ }
+
+ /**
+ *
+ * @param request
+ * @return True, if a wrapper is needed
+ */
+ @Override
+ public boolean needsWrapper(final HttpServletRequest request)
+ {
+ return !request.isSecure() &&
+ matchesOne(request.getRemoteAddr(), config.securedRemoteAddresses) == false;
+ }
+
+ /**
+ * If incoming remote address matches one of the declared IP pattern, wraps the incoming
+ * {@link HttpServletRequest} to override {@link HttpServletRequest#isSecure()} to set it to
+ * <code>true</code>.
+ */
+ @Override
+ public HttpServletRequest newRequestWrapper(final HttpServletRequest request)
+ {
+ return new HttpServletRequestWrapper(request)
+ {
+ @Override
+ public boolean isSecure()
+ {
+ return true;
+ }
+ };
+ }
+
+ /**
+ * @see org.apache.wicket.protocol.http.servlet.IRequestWrapperFactory#init(org.apache.wicket.Application,
+ * boolean, javax.servlet.FilterConfig)
+ */
+ public void init(final Application application, final boolean isServlet,
+ final FilterConfig filterConfig)
+ {
+ String comaDelimitedSecuredRemoteAddresses = filterConfig.getInitParameter(SECURED_REMOTE_ADDRESSES_PARAMETER);
+ if (comaDelimitedSecuredRemoteAddresses != null)
+ {
+ config.setSecuredRemoteAdresses(comaDelimitedSecuredRemoteAddresses);
+ }
+ }
+}
Copied: wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapper.java (from r1039878, wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequest.java)
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapper.java?p2=wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapper.java&p1=wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequest.java&r1=1039878&r2=1039920&rev=1039920&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequest.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapper.java Sun Nov 28 18:41:38 2010
@@ -35,7 +35,7 @@ import javax.servlet.http.HttpServletReq
*
* @author Juergen Donnerstag
*/
-public class XForwardedRequest extends HttpServletRequestWrapper
+public class XForwardedRequestWrapper extends HttpServletRequestWrapper
{
private final static ThreadLocal<SimpleDateFormat[]> threadLocalDateFormats = new ThreadLocal<SimpleDateFormat[]>()
{
@@ -67,7 +67,7 @@ public class XForwardedRequest extends H
* @param request
*/
@SuppressWarnings("unchecked")
- public XForwardedRequest(final HttpServletRequest request)
+ public XForwardedRequestWrapper(final HttpServletRequest request)
{
super(request);
Added: wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapperFactory.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapperFactory.java?rev=1039920&view=auto
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapperFactory.java (added)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/protocol/http/servlet/XForwardedRequestWrapperFactory.java Sun Nov 28 18:41:38 2010
@@ -0,0 +1,823 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.wicket.protocol.http.servlet;
+
+import java.util.LinkedList;
+import java.util.regex.Pattern;
+
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.http.HttpServletRequest;
+
+import org.apache.wicket.Application;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Servlet filter to integrate "X-Forwarded-For" and "X-Forwarded-Proto" HTTP headers. </p>
+ * <p>
+ * Most of the design of this Servlet Filter is a port of <a
+ * href="http://httpd.apache.org/docs/trunk/mod/mod_remoteip.html">mod_remoteip</a>, this servlet
+ * filter replaces the apparent client remote IP address and hostname for the request with the IP
+ * address list presented by a proxy or a load balancer via a request headers (e.g.
+ * "X-Forwarded-For").
+ * </p>
+ * <p>
+ * Another feature of this servlet filter is to replace the apparent scheme (http/https) and server
+ * port with the scheme presented by a proxy or a load balancer via a request header (e.g.
+ * "X-Forwarded-Proto").
+ * </p>
+ * <p>
+ * This servlet filter proceeds as follows:
+ * </p>
+ * <p>
+ * If the incoming <code>request.getRemoteAddr()</code> matches the servlet filter's list of
+ * internal proxies :
+ * <ul>
+ * <li>Loop on the comma delimited list of IPs and hostnames passed by the preceding load balancer
+ * or proxy in the given request's Http header named <code>$remoteIPHeader</code> (default value
+ * <code>x-forwarded-for</code>). Values are processed in right-to-left order.</li>
+ * <li>For each ip/host of the list:
+ * <ul>
+ * <li>if it matches the internal proxies list, the ip/host is swallowed</li>
+ * <li>if it matches the trusted proxies list, the ip/host is added to the created proxies header</li>
+ * <li>otherwise, the ip/host is declared to be the remote ip and looping is stopped.</li>
+ * </ul>
+ * </li>
+ * <li>If the request http header named <code>$protocolHeader</code> (e.g.
+ * <code>x-forwarded-for</code>) equals to the value of <code>protocolHeaderHttpsValue</code>
+ * configuration parameter (default <code>https</code>) then <code>request.isSecure = true</code>,
+ * <code>request.scheme = https</code> and <code>request.serverPort = 443</code>. Note that 443 can
+ * be overwritten with the <code>$httpsServerPort</code> configuration parameter.</li>
+ * </ul>
+ * </p>
+ * <p>
+ * <strong>Configuration parameters:</strong>
+ * <table border="1">
+ * <tr>
+ * <th>XForwardedFilter property</th>
+ * <th>Description</th>
+ * <th>Equivalent mod_remoteip directive</th>
+ * <th>Format</th>
+ * <th>Default Value</th>
+ * </tr>
+ * <tr>
+ * <td>remoteIPHeader</td>
+ * <td>Name of the Http Header read by this servlet filter that holds the list of traversed IP
+ * addresses starting from the requesting client</td>
+ * <td>RemoteIPHeader</td>
+ * <td>Compliant http header name</td>
+ * <td>x-forwarded-for</td>
+ * </tr>
+ * <tr>
+ * <td>allowedInternalProxies</td>
+ * <td>List of internal proxies ip adress. If they appear in the <code>remoteIpHeader</code> value,
+ * they will be trusted and will not appear in the <code>proxiesHeader</code> value</td>
+ * <td>RemoteIPInternalProxy</td>
+ * <td>Comma delimited list of regular expressions (in the syntax supported by the
+ * {@link java.util.regex.Pattern} library)</td>
+ * <td>10\.\d{1,3}\.\d{1,3}\.\d{1,3}, 192\.168\.\d{1,3}\.\d{1,3},
+ * 172\\.(?:1[6-9]|2\\d|3[0-1]).\\d{1,3}.\\d{1,3}, 169\.254\.\d{1,3}\.\d{1,3},
+ * 127\.\d{1,3}\.\d{1,3}\.\d{1,3} <br/>
+ * By default, 10/8, 192.168/16, 172.16/12, 169.254/16 and 127/8 are allowed</td>
+ * </tr>
+ * </tr>
+ * <tr>
+ * <td>proxiesHeader</td>
+ * <td>Name of the http header created by this servlet filter to hold the list of proxies that have
+ * been processed in the incoming <code>remoteIPHeader</code></td>
+ * <td>RemoteIPProxiesHeader</td>
+ * <td>Compliant http header name</td>
+ * <td>x-forwarded-by</td>
+ * </tr>
+ * <tr>
+ * <td>trustedProxies</td>
+ * <td>List of trusted proxies ip adress. If they appear in the <code>remoteIpHeader</code> value,
+ * they will be trusted and will appear in the <code>proxiesHeader</code> value</td>
+ * <td>RemoteIPTrustedProxy</td>
+ * <td>Comma delimited list of regular expressions (in the syntax supported by the
+ * {@link java.util.regex.Pattern} library)</td>
+ * <td> </td>
+ * </tr>
+ * <tr>
+ * <td>protocolHeader</td>
+ * <td>Name of the http header read by this servlet filter that holds the flag that this request</td>
+ * <td>N/A</td>
+ * <td>Compliant http header name like <code>X-Forwarded-Proto</code>, <code>X-Forwarded-Ssl</code>
+ * or <code>Front-End-Https</code></td>
+ * <td><code>null</code></td>
+ * </tr>
+ * <tr>
+ * <td>protocolHeaderHttpsValue</td>
+ * <td>Value of the <code>protocolHeader</code> to indicate that it is an Https request</td>
+ * <td>N/A</td>
+ * <td>String like <code>https</code> or <code>ON</code></td>
+ * <td><code>https</code></td>
+ * </tr>
+ * <tr>
+ * <tr>
+ * <td>httpServerPort</td>
+ * <td>Value returned by {@link ServletRequest#getServerPort()} when the <code>protocolHeader</code>
+ * indicates <code>http</code> protocol</td>
+ * <td>N/A</td>
+ * <td>integer</td>
+ * <td>80</td>
+ * </tr>
+ * <tr>
+ * <td>httpsServerPort</td>
+ * <td>Value returned by {@link ServletRequest#getServerPort()} when the <code>protocolHeader</code>
+ * indicates <code>https</code> protocol</td>
+ * <td>N/A</td>
+ * <td>integer</td>
+ * <td>443</td>
+ * </tr>
+ * </table>
+ * </p>
+ * <p>
+ * <p>
+ * <strong>Regular expression vs. IP address blocks:</strong> <code>mod_remoteip</code> allows to
+ * use address blocks (e.g. <code>192.168/16</code>) to configure <code>RemoteIPInternalProxy</code>
+ * and <code>RemoteIPTrustedProxy</code> ; as the JVM doesnt have a library similar to <a href=
+ * "http://apr.apache.org/docs/apr/1.3/group__apr__network__io.html#gb74d21b8898b7c40bf7fd07ad3eb993d"
+ * >apr_ipsubnet_test</a>.
+ * </p>
+ * <hr/>
+ * <p>
+ * <strong>Sample with internal proxies</strong>
+ * </p>
+ * <p>
+ * XForwardedFilter configuration:
+ * </p>
+ * <code><pre>
+ * <filter>
+ * <filter-name>XForwardedFilter</filter-name>
+ * <filter-class>fr.xebia.servlet.filter.XForwardedFilter</filter-class>
+ * <init-param>
+ * <param-name>allowedInternalProxies</param-name><param-value>192\.168\.0\.10, 192\.168\.0\.11</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>remoteIPHeader</param-name><param-value>x-forwarded-for</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>remoteIPProxiesHeader</param-name><param-value>x-forwarded-by</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>protocolHeader</param-name><param-value>x-forwarded-proto</param-value>
+ * </init-param>
+ * </filter>
+ *
+ * <filter-mapping>
+ * <filter-name>XForwardedFilter</filter-name>
+ * <url-pattern>/*</url-pattern>
+ * <dispatcher>REQUEST</dispatcher>
+ * </filter-mapping></pre></code>
+ * <p>
+ * Request values:
+ * <table border="1">
+ * <tr>
+ * <th>property</th>
+ * <th>Value Before XForwardedFilter</th>
+ * <th>Value After XForwardedFilter</th>
+ * </tr>
+ * <tr>
+ * <td>request.remoteAddr</td>
+ * <td>192.168.0.10</td>
+ * <td>140.211.11.130</td>
+ * </tr>
+ * <tr>
+ * <td>request.header['x-forwarded-for']</td>
+ * <td>140.211.11.130, 192.168.0.10</td>
+ * <td>null</td>
+ * </tr>
+ * <tr>
+ * <td>request.header['x-forwarded-by']</td>
+ * <td>null</td>
+ * <td>null</td>
+ * </tr>
+ * <tr>
+ * <td>request.header['x-forwarded-proto']</td>
+ * <td>https</td>
+ * <td>https</td>
+ * </tr>
+ * <tr>
+ * <td>request.scheme</td>
+ * <td>http</td>
+ * <td>https</td>
+ * </tr>
+ * <tr>
+ * <td>request.secure</td>
+ * <td>false</td>
+ * <td>true</td>
+ * </tr>
+ * <tr>
+ * <td>request.serverPort</td>
+ * <td>80</td>
+ * <td>443</td>
+ * </tr>
+ * </table>
+ * Note : <code>x-forwarded-by</code> header is null because only internal proxies as been traversed
+ * by the request. <code>x-forwarded-by</code> is null because all the proxies are trusted or
+ * internal.
+ * </p>
+ * <hr/>
+ * <p>
+ * <strong>Sample with trusted proxies</strong>
+ * </p>
+ * <p>
+ * XForwardedFilter configuration:
+ * </p>
+ * <code><pre>
+ * <filter>
+ * <filter-name>XForwardedFilter</filter-name>
+ * <filter-class>fr.xebia.servlet.filter.XForwardedFilter</filter-class>
+ * <init-param>
+ * <param-name>allowedInternalProxies</param-name><param-value>192\.168\.0\.10, 192\.168\.0\.11</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>remoteIPHeader</param-name><param-value>x-forwarded-for</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>remoteIPProxiesHeader</param-name><param-value>x-forwarded-by</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>trustedProxies</param-name><param-value>proxy1, proxy2</param-value>
+ * </init-param>
+ * </filter>
+ *
+ * <filter-mapping>
+ * <filter-name>XForwardedFilter</filter-name>
+ * <url-pattern>/*</url-pattern>
+ * <dispatcher>REQUEST</dispatcher>
+ * </filter-mapping></pre></code>
+ * <p>
+ * Request values:
+ * <table border="1">
+ * <tr>
+ * <th>property</th>
+ * <th>Value Before XForwardedFilter</th>
+ * <th>Value After XForwardedFilter</th>
+ * </tr>
+ * <tr>
+ * <td>request.remoteAddr</td>
+ * <td>192.168.0.10</td>
+ * <td>140.211.11.130</td>
+ * </tr>
+ * <tr>
+ * <td>request.header['x-forwarded-for']</td>
+ * <td>140.211.11.130, proxy1, proxy2</td>
+ * <td>null</td>
+ * </tr>
+ * <tr>
+ * <td>request.header['x-forwarded-by']</td>
+ * <td>null</td>
+ * <td>proxy1, proxy2</td>
+ * </tr>
+ * </table>
+ * Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that come in
+ * <code>x-forwarded-for</code> header, they both are migrated in <code>x-forwarded-by</code>
+ * header. <code>x-forwarded-by</code> is null because all the proxies are trusted or internal.
+ * </p>
+ * <hr/>
+ * <p>
+ * <strong>Sample with internal and trusted proxies</strong>
+ * </p>
+ * <p>
+ * XForwardedFilter configuration:
+ * </p>
+ * <code><pre>
+ * <filter>
+ * <filter-name>XForwardedFilter</filter-name>
+ * <filter-class>fr.xebia.servlet.filter.XForwardedFilter</filter-class>
+ * <init-param>
+ * <param-name>allowedInternalProxies</param-name><param-value>192\.168\.0\.10, 192\.168\.0\.11</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>remoteIPHeader</param-name><param-value>x-forwarded-for</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>remoteIPProxiesHeader</param-name><param-value>x-forwarded-by</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>trustedProxies</param-name><param-value>proxy1, proxy2</param-value>
+ * </init-param>
+ * </filter>
+ *
+ * <filter-mapping>
+ * <filter-name>XForwardedFilter</filter-name>
+ * <url-pattern>/*</url-pattern>
+ * <dispatcher>REQUEST</dispatcher>
+ * </filter-mapping></pre></code>
+ * <p>
+ * Request values:
+ * <table border="1">
+ * <tr>
+ * <th>property</th>
+ * <th>Value Before XForwardedFilter</th>
+ * <th>Value After XForwardedFilter</th>
+ * </tr>
+ * <tr>
+ * <td>request.remoteAddr</td>
+ * <td>192.168.0.10</td>
+ * <td>140.211.11.130</td>
+ * </tr>
+ * <tr>
+ * <td>request.header['x-forwarded-for']</td>
+ * <td>140.211.11.130, proxy1, proxy2, 192.168.0.10</td>
+ * <td>null</td>
+ * </tr>
+ * <tr>
+ * <td>request.header['x-forwarded-by']</td>
+ * <td>null</td>
+ * <td>proxy1, proxy2</td>
+ * </tr>
+ * </table>
+ * Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that come in
+ * <code>x-forwarded-for</code> header, they both are migrated in <code>x-forwarded-by</code>
+ * header. As <code>192.168.0.10</code> is an internal proxy, it does not appear in
+ * <code>x-forwarded-by</code>. <code>x-forwarded-by</code> is null because all the proxies are
+ * trusted or internal.
+ * </p>
+ * <hr/>
+ * <p>
+ * <strong>Sample with an untrusted proxy</strong>
+ * </p>
+ * <p>
+ * XForwardedFilter configuration:
+ * </p>
+ * <code><pre>
+ * <filter>
+ * <filter-name>XForwardedFilter</filter-name>
+ * <filter-class>fr.xebia.servlet.filter.XForwardedFilter</filter-class>
+ * <init-param>
+ * <param-name>allowedInternalProxies</param-name><param-value>192\.168\.0\.10, 192\.168\.0\.11</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>remoteIPHeader</param-name><param-value>x-forwarded-for</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>remoteIPProxiesHeader</param-name><param-value>x-forwarded-by</param-value>
+ * </init-param>
+ * <init-param>
+ * <param-name>trustedProxies</param-name><param-value>proxy1, proxy2</param-value>
+ * </init-param>
+ * </filter>
+ *
+ * <filter-mapping>
+ * <filter-name>XForwardedFilter</filter-name>
+ * <url-pattern>/*</url-pattern>
+ * <dispatcher>REQUEST</dispatcher>
+ * </filter-mapping></pre></code>
+ * <p>
+ * Request values:
+ * <table border="1">
+ * <tr>
+ * <th>property</th>
+ * <th>Value Before XForwardedFilter</th>
+ * <th>Value After XForwardedFilter</th>
+ * </tr>
+ * <tr>
+ * <td>request.remoteAddr</td>
+ * <td>192.168.0.10</td>
+ * <td>untrusted-proxy</td>
+ * </tr>
+ * <tr>
+ * <td>request.header['x-forwarded-for']</td>
+ * <td>140.211.11.130, untrusted-proxy, proxy1</td>
+ * <td>140.211.11.130</td>
+ * </tr>
+ * <tr>
+ * <td>request.header['x-forwarded-by']</td>
+ * <td>null</td>
+ * <td>proxy1</td>
+ * </tr>
+ * </table>
+ * Note : <code>x-forwarded-by</code> holds the trusted proxy <code>proxy1</code>.
+ * <code>x-forwarded-by</code> holds <code>140.211.11.130</code> because
+ * <code>untrusted-proxy</code> is not trusted and thus, we can not trust that
+ * <code>untrusted-proxy</code> is the actual remote ip. <code>request.remoteAddr</code> is
+ * <code>untrusted-proxy</code> that is an IP verified by <code>proxy1</code>.
+ * </p>
+ * <hr/>
+ *
+ * @author <a href="mailto:cyrille@cyrilleleclerc.com">Cyrille Le Clerc</a>
+ * @author Juergen Donnerstag
+ */
+public class XForwardedRequestWrapperFactory extends AbstractRequestWrapperFactory
+{
+ /** Logger */
+ private static final Logger log = LoggerFactory.getLogger(XForwardedRequestWrapperFactory.class);
+
+ protected static final String HTTP_SERVER_PORT_PARAMETER = "httpServerPort";
+
+ protected static final String HTTPS_SERVER_PORT_PARAMETER = "httpsServerPort";
+
+ protected static final String INTERNAL_PROXIES_PARAMETER = "allowedInternalProxies";
+
+ protected static final String PROTOCOL_HEADER_PARAMETER = "protocolHeader";
+
+ protected static final String PROTOCOL_HEADER_SSL_VALUE_PARAMETER = "protocolHeaderSslValue";
+
+ protected static final String PROXIES_HEADER_PARAMETER = "proxiesHeader";
+
+ protected static final String REMOTE_IP_HEADER_PARAMETER = "remoteIPHeader";
+
+ protected static final String TRUSTED_PROXIES_PARAMETER = "trustedProxies";
+
+ /**
+ * Filter Config
+ */
+ public static class Config
+ {
+ // Enable / disable xforwarded functionality
+ private boolean enabled = true;
+
+ /** @see #setHttpServerPort(int) */
+ private int httpServerPort = 80;
+
+ /** @see #setHttpsServerPort(int) */
+ private int httpsServerPort = 443;
+
+ /** @see #setProtocolHeader(String) */
+ private String protocolHeader = null;
+
+ /** @see #setProtocolHeaderSsl(String) */
+ private String protocolHeaderSslValue = "https";
+
+ /** @see #setProxiesHeader(String) */
+ private String proxiesHeader = "X-Forwarded-By";
+
+ /** @see #setRemoteIPHeader(String) */
+ private String remoteIPHeader = "X-Forwarded-For";
+
+ /** @see #setTrustedProxies(String) */
+ private Pattern[] trustedProxies = new Pattern[0];
+
+ /** @see #setInternalProxies(String) */
+ private Pattern[] allowedInternalProxies = new Pattern[] {
+ Pattern.compile("10\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"),
+ Pattern.compile("192\\.168\\.\\d{1,3}\\.\\d{1,3}"),
+ Pattern.compile("172\\.(?:1[6-9]|2\\d|3[0-1]).\\d{1,3}.\\d{1,3}"),
+ Pattern.compile("169\\.254\\.\\d{1,3}\\.\\d{1,3}"),
+ Pattern.compile("127\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}") };
+
+ /**
+ * Comma delimited list of internal proxies. Expressed with regular expressions.
+ * <p>
+ * Default value : 10\.\d{1,3}\.\d{1,3}\.\d{1,3}, 192\.168\.\d{1,3}\.\d{1,3},
+ * 172\\.(?:1[6-9]|2\\d|3[0-1]).\\d{1,3}.\\d{1,3}, 169\.254\.\d{1,3}\.\d{1,3},
+ * 127\.\d{1,3}\.\d{1,3}\.\d{1,3}
+ *
+ * @param allowedInternalProxies
+ */
+ public void setAllowedInternalProxies(final String allowedInternalProxies)
+ {
+ this.allowedInternalProxies = commaDelimitedListToPatternArray(allowedInternalProxies);
+ }
+
+ /**
+ * Server Port value if the {@link #protocolHeader} does not indicate HTTPS
+ * <p>
+ * Default value : 80
+ *
+ * @param httpServerPort
+ */
+ public void setHttpServerPort(final int httpServerPort)
+ {
+ this.httpServerPort = httpServerPort;
+ }
+
+ /**
+ * Server Port value if the {@link #protocolHeader} indicates HTTPS
+ * <p>
+ * Default value : 443
+ *
+ * @param httpsServerPort
+ */
+ public void setHttpsServerPort(final int httpsServerPort)
+ {
+ this.httpsServerPort = httpsServerPort;
+ }
+
+ /**
+ * Header that holds the incoming protocol, usally named <code>X-Forwarded-Proto</code>. If
+ * <code>null</code>, request.scheme and request.secure will not be modified.
+ * <p>
+ * Default value : <code>null</code>
+ *
+ * @param protocolHeader
+ */
+ public void setProtocolHeader(final String protocolHeader)
+ {
+ this.protocolHeader = protocolHeader;
+ }
+
+ /**
+ * Case insensitive value of the protocol header to indicate that the incoming http request
+ * uses SSL.
+ * <p>
+ * Default value : <code>HTTPS</code>
+ *
+ * @param protocolHeaderSslValue
+ */
+ public void setProtocolHeaderSslValue(final String protocolHeaderSslValue)
+ {
+ this.protocolHeaderSslValue = protocolHeaderSslValue;
+ }
+
+ /**
+ * The proxiesHeader directive specifies a header into which mod_remoteip will collect a
+ * list of all of the intermediate client IP addresses trusted to resolve the actual remote
+ * IP. Note that intermediate RemoteIPTrustedProxy addresses are recorded in this header,
+ * while any intermediate RemoteIPInternalProxy addresses are discarded.
+ * <p>
+ * Name of the http header that holds the list of trusted proxies that has been traversed by
+ * the http request.
+ * <p>
+ * The value of this header can be comma delimited.
+ * <p>
+ * Default value : <code>X-Forwarded-By</code>
+ *
+ * @param proxiesHeader
+ */
+ public void setProxiesHeader(final String proxiesHeader)
+ {
+ this.proxiesHeader = proxiesHeader;
+ }
+
+ /**
+ * Name of the http header from which the remote ip is extracted.
+ * <p>
+ * The value of this header can be comma delimited.
+ * <p>
+ * Default value : <code>X-Forwarded-For</code>
+ *
+ * @param remoteIPHeader
+ */
+ public void setRemoteIPHeader(final String remoteIPHeader)
+ {
+ this.remoteIPHeader = remoteIPHeader;
+ }
+
+ /**
+ * Comma delimited list of proxies that are trusted when they appear in the
+ * {@link #remoteIPHeader} header. Can be expressed as a regular expression.
+ * <p>
+ * Default value : empty list, no external proxy is trusted.
+ *
+ * @param trustedProxies
+ */
+ public void setTrustedProxies(final String trustedProxies)
+ {
+ this.trustedProxies = commaDelimitedListToPatternArray(trustedProxies);
+ }
+
+ /**
+ * Enable / disable XForwarded related processing
+ *
+ * @param enable
+ */
+ public void setEnabled(boolean enable)
+ {
+ enabled = enable;
+ }
+
+ /**
+ * @return True, if filter is active
+ */
+ public boolean isEnabled()
+ {
+ return enabled;
+ }
+ }
+
+ // Filter Config
+ private Config config = new Config();
+
+ /**
+ * @return XForwarded filter specific config
+ */
+ public final Config getConfig()
+ {
+ return config;
+ }
+
+ /**
+ * The Wicket application might want to provide its own config
+ *
+ * @param config
+ */
+ public final void setConfig(final Config config)
+ {
+ this.config = config;
+ }
+
+ /**
+ *
+ * @param request
+ * @return True, if a wrapper is needed
+ */
+ @Override
+ public boolean needsWrapper(final HttpServletRequest request)
+ {
+ boolean rtn = matchesOne(request.getRemoteAddr(), config.allowedInternalProxies);
+ if (rtn == false)
+ {
+ if (log.isDebugEnabled())
+ {
+ log.debug("Skip XForwardedFilter for request " + request.getRequestURI() +
+ " with remote address " + request.getRemoteAddr());
+ }
+ }
+ return rtn;
+ }
+
+ /**
+ *
+ * @param request
+ * @return Either the original request or the wrapper
+ */
+ @Override
+ public HttpServletRequest newRequestWrapper(final HttpServletRequest request)
+ {
+ String remoteIp = null;
+ // In java 6, proxiesHeaderValue should be declared as a java.util.Deque
+ LinkedList<String> proxiesHeaderValue = new LinkedList<String>();
+
+ String[] remoteIPHeaderValue = commaDelimitedListToStringArray(request.getHeader(config.remoteIPHeader));
+ int idx;
+ // loop on remoteIPHeaderValue to find the first trusted remote ip and to build the
+ // proxies chain
+ for (idx = remoteIPHeaderValue.length - 1; idx >= 0; idx--)
+ {
+ String currentRemoteIp = remoteIPHeaderValue[idx];
+ remoteIp = currentRemoteIp;
+ if (matchesOne(currentRemoteIp, config.allowedInternalProxies))
+ {
+ // do nothing, allowedInternalProxies IPs are not appended to the
+ }
+ else if (matchesOne(currentRemoteIp, config.trustedProxies))
+ {
+ proxiesHeaderValue.addFirst(currentRemoteIp);
+ }
+ else
+ {
+ idx--; // decrement idx because break statement doesn't do it
+ break;
+ }
+ }
+ // continue to loop on remoteIPHeaderValue to build the new value of the remoteIPHeader
+ LinkedList<String> newRemoteIpHeaderValue = new LinkedList<String>();
+ for (; idx >= 0; idx--)
+ {
+ String currentRemoteIp = remoteIPHeaderValue[idx];
+ newRemoteIpHeaderValue.addFirst(currentRemoteIp);
+ }
+
+ XForwardedRequestWrapper xRequest = new XForwardedRequestWrapper(request);
+ if (remoteIp != null)
+ {
+ xRequest.setRemoteAddr(remoteIp);
+ xRequest.setRemoteHost(remoteIp);
+
+ if (proxiesHeaderValue.size() == 0)
+ {
+ xRequest.removeHeader(config.proxiesHeader);
+ }
+ else
+ {
+ String commaDelimitedListOfProxies = listToCommaDelimitedString(proxiesHeaderValue);
+ xRequest.setHeader(config.proxiesHeader, commaDelimitedListOfProxies);
+ }
+ if (newRemoteIpHeaderValue.size() == 0)
+ {
+ xRequest.removeHeader(config.remoteIPHeader);
+ }
+ else
+ {
+ String commaDelimitedRemoteIpHeaderValue = listToCommaDelimitedString(newRemoteIpHeaderValue);
+ xRequest.setHeader(config.remoteIPHeader, commaDelimitedRemoteIpHeaderValue);
+ }
+ }
+
+ if (config.protocolHeader != null)
+ {
+ String protocolHeaderValue = request.getHeader(config.protocolHeader);
+ if (protocolHeaderValue == null)
+ {
+ // don't modify the secure,scheme and serverPort attributes of the request
+ }
+ else if (config.protocolHeaderSslValue.equalsIgnoreCase(protocolHeaderValue))
+ {
+ xRequest.setSecure(true);
+ xRequest.setScheme("https");
+ xRequest.setServerPort(config.httpsServerPort);
+ }
+ else
+ {
+ xRequest.setSecure(false);
+ xRequest.setScheme("http");
+ xRequest.setServerPort(config.httpServerPort);
+ }
+ }
+
+ if (log.isDebugEnabled())
+ {
+ log.debug("Incoming request " + request.getRequestURI() + " with originalRemoteAddr '" +
+ request.getRemoteAddr() + "', originalRemoteHost='" + request.getRemoteHost() +
+ "', originalSecure='" + request.isSecure() + "', originalScheme='" +
+ request.getScheme() + "', original[" + config.remoteIPHeader + "]='" +
+ request.getHeader(config.remoteIPHeader) + ", original[" + config.protocolHeader +
+ "]='" +
+ (config.protocolHeader == null ? null : request.getHeader(config.protocolHeader)) +
+ "' will be seen as newRemoteAddr='" + xRequest.getRemoteAddr() +
+ "', newRemoteHost='" + xRequest.getRemoteHost() + "', newScheme='" +
+ xRequest.getScheme() + "', newSecure='" + xRequest.isSecure() + "', new[" +
+ config.remoteIPHeader + "]='" + xRequest.getHeader(config.remoteIPHeader) +
+ ", new[" + config.proxiesHeader + "]='" + xRequest.getHeader(config.proxiesHeader) +
+ "'");
+ }
+ return xRequest;
+ }
+
+ /**
+ * Get xforwarded specific config from web.xml filter config
+ *
+ * @param isServlet
+ * @param filterConfig
+ * @throws ServletException
+ */
+ public void init(final Application application, final boolean isServlet,
+ final FilterConfig filterConfig)
+ {
+ if (filterConfig.getInitParameter(INTERNAL_PROXIES_PARAMETER) != null)
+ {
+ config.setAllowedInternalProxies(filterConfig.getInitParameter(INTERNAL_PROXIES_PARAMETER));
+ }
+
+ if (filterConfig.getInitParameter(PROTOCOL_HEADER_PARAMETER) != null)
+ {
+ config.setProtocolHeader(filterConfig.getInitParameter(PROTOCOL_HEADER_PARAMETER));
+ }
+
+ if (filterConfig.getInitParameter(PROTOCOL_HEADER_SSL_VALUE_PARAMETER) != null)
+ {
+ config.setProtocolHeaderSslValue(filterConfig.getInitParameter(PROTOCOL_HEADER_SSL_VALUE_PARAMETER));
+ }
+
+ if (filterConfig.getInitParameter(PROXIES_HEADER_PARAMETER) != null)
+ {
+ config.setProxiesHeader(filterConfig.getInitParameter(PROXIES_HEADER_PARAMETER));
+ }
+
+ if (filterConfig.getInitParameter(REMOTE_IP_HEADER_PARAMETER) != null)
+ {
+ config.setRemoteIPHeader(filterConfig.getInitParameter(REMOTE_IP_HEADER_PARAMETER));
+ }
+
+ if (filterConfig.getInitParameter(TRUSTED_PROXIES_PARAMETER) != null)
+ {
+ config.setTrustedProxies(filterConfig.getInitParameter(TRUSTED_PROXIES_PARAMETER));
+ }
+
+ if (filterConfig.getInitParameter(HTTP_SERVER_PORT_PARAMETER) != null)
+ {
+ try
+ {
+ config.setHttpServerPort(Integer.parseInt(filterConfig.getInitParameter(HTTP_SERVER_PORT_PARAMETER)));
+ }
+ catch (NumberFormatException e)
+ {
+ throw new NumberFormatException("Illegal " + HTTP_SERVER_PORT_PARAMETER + " : " +
+ e.getMessage());
+ }
+ }
+
+ if (filterConfig.getInitParameter(HTTPS_SERVER_PORT_PARAMETER) != null)
+ {
+ try
+ {
+ config.setHttpsServerPort(Integer.parseInt(filterConfig.getInitParameter(HTTPS_SERVER_PORT_PARAMETER)));
+ }
+ catch (NumberFormatException e)
+ {
+ throw new NumberFormatException("Illegal " + HTTPS_SERVER_PORT_PARAMETER + " : " +
+ e.getMessage());
+ }
+ }
+ }
+}
Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java?rev=1039920&r1=1039919&r2=1039920&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java Sun Nov 28 18:41:38 2010
@@ -205,7 +205,6 @@ public class WicketTester extends BaseWi
super(application, path);
}
-
/**
* Asserts that the Ajax location header is present.
*/
Copied: wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedRequestWrapperTest.java (from r1039878, wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedWicketFilterExtensionTest.java)
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedRequestWrapperTest.java?p2=wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedRequestWrapperTest.java&p1=wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedWicketFilterExtensionTest.java&r1=1039878&r2=1039920&rev=1039920&view=diff
==============================================================================
--- wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedWicketFilterExtensionTest.java (original)
+++ wicket/trunk/wicket/src/test/java/org/apache/wicket/protocol/http/XForwardedRequestWrapperTest.java Sun Nov 28 18:41:38 2010
@@ -19,32 +19,31 @@ package org.apache.wicket.protocol.http;
import javax.servlet.http.HttpServletRequest;
import org.apache.wicket.WicketTestCase;
-import org.apache.wicket.protocol.http.filter.XForwardedWicketFilterExtension;
import org.apache.wicket.protocol.http.mock.MockHttpServletRequest;
+import org.apache.wicket.protocol.http.servlet.XForwardedRequestWrapperFactory;
/**
*
* @author Juergen Donnerstag
*/
-public class XForwardedWicketFilterExtensionTest extends WicketTestCase
+public class XForwardedRequestWrapperTest extends WicketTestCase
{
MockHttpServletRequest request;
- XForwardedWicketFilterExtension filter;
+ XForwardedRequestWrapperFactory filter;
@Override
protected void setUp() throws Exception
{
super.setUp();
- filter = new XForwardedWicketFilterExtension();
- tester.getApplication().getWicketFilter().addFilter(filter);
+ filter = new XForwardedRequestWrapperFactory();
request = tester.getRequest();
}
/** */
public void test1()
{
- HttpServletRequest resp = (HttpServletRequest)filter.getRequestWrapper(request);
+ HttpServletRequest resp = filter.getWrapper(request);
assertEquals("127.0.0.1", resp.getRemoteAddr());
assertEquals(null, resp.getHeader("x-forwarded-for"));
assertEquals(null, resp.getHeader("x-forwarded-by"));
@@ -59,7 +58,7 @@ public class XForwardedWicketFilterExten
{
filter.getConfig().setProtocolHeader("x-forwarded-proto");
- HttpServletRequest resp = (HttpServletRequest)filter.getRequestWrapper(request);
+ HttpServletRequest resp = filter.getWrapper(request);
assertEquals("127.0.0.1", resp.getRemoteAddr());
assertEquals(null, resp.getHeader("x-forwarded-for"));
assertEquals(null, resp.getHeader("x-forwarded-by"));
@@ -87,7 +86,7 @@ public class XForwardedWicketFilterExten
request.setSecure(false);
request.setServerPort(80);
- HttpServletRequest resp = (HttpServletRequest)filter.getRequestWrapper(request);
+ HttpServletRequest resp = filter.getWrapper(request);
assertEquals("140.211.11.130", resp.getRemoteAddr());
assertEquals(null, resp.getHeader("x-forwarded-for"));
assertEquals(null, resp.getHeader("x-forwarded-by"));
@@ -110,7 +109,7 @@ public class XForwardedWicketFilterExten
request.setRemoteAddr("192.168.0.10");
request.addHeader("x-forwarded-for", "140.211.11.130, proxy1, proxy2");
- HttpServletRequest resp = (HttpServletRequest)filter.getRequestWrapper(request);
+ HttpServletRequest resp = filter.getWrapper(request);
assertEquals("140.211.11.130", resp.getRemoteAddr());
assertEquals(null, resp.getHeader("x-forwarded-for"));
assertEquals("proxy1, proxy2", resp.getHeader("x-forwarded-by"));
@@ -129,7 +128,7 @@ public class XForwardedWicketFilterExten
request.setRemoteAddr("192.168.0.10");
request.addHeader("x-forwarded-for", "140.211.11.130, proxy1, proxy2, 192.168.0.10");
- HttpServletRequest resp = (HttpServletRequest)filter.getRequestWrapper(request);
+ HttpServletRequest resp = filter.getWrapper(request);
assertEquals("140.211.11.130", resp.getRemoteAddr());
assertEquals(null, resp.getHeader("x-forwarded-for"));
assertEquals("proxy1, proxy2", resp.getHeader("x-forwarded-by"));
@@ -148,7 +147,7 @@ public class XForwardedWicketFilterExten
request.setRemoteAddr("192.168.0.10");
request.addHeader("x-forwarded-for", "140.211.11.130, untrusted-proxy, proxy1");
- HttpServletRequest resp = (HttpServletRequest)filter.getRequestWrapper(request);
+ HttpServletRequest resp = filter.getWrapper(request);
assertEquals("untrusted-proxy", resp.getRemoteAddr());
assertEquals("140.211.11.130", resp.getHeader("x-forwarded-for"));
assertEquals("proxy1", resp.getHeader("x-forwarded-by"));