233 lines
9.5 KiB
Diff
233 lines
9.5 KiB
Diff
From 3b51230764da595bb19e8d0962dd8c69ab40dfab Mon Sep 17 00:00:00 2001
|
|
From: lihan <lihan@apache.org>
|
|
Date: Fri, 10 Feb 2023 10:01:27 +0800
|
|
Subject: [PATCH] Fix BZ 66471 - JSessionId secure attribute missing with
|
|
RemoteIpFilter and X-Forwarded-Proto set to https
|
|
|
|
https://bz.apache.org/bugzilla/show_bug.cgi?id=66471
|
|
|
|
Origin: https://github.com/apache/tomcat/commit/3b51230764da595bb19e8d0962dd8c69ab40dfab
|
|
---
|
|
java/org/apache/catalina/Globals.java | 8 ++
|
|
.../apache/catalina/connector/Request.java | 14 +++
|
|
.../catalina/filters/RemoteIpFilter.java | 7 +-
|
|
.../catalina/filters/TestRemoteIpFilter.java | 96 ++++++++++++++-----
|
|
webapps/docs/changelog.xml | 5 +
|
|
5 files changed, 101 insertions(+), 29 deletions(-)
|
|
|
|
diff --git a/java/org/apache/catalina/Globals.java b/java/org/apache/catalina/Globals.java
|
|
index c19d69c..2e9a377 100644
|
|
--- a/java/org/apache/catalina/Globals.java
|
|
+++ b/java/org/apache/catalina/Globals.java
|
|
@@ -160,6 +160,14 @@ public final class Globals {
|
|
org.apache.coyote.Constants.SENDFILE_SUPPORTED_ATTR;
|
|
|
|
|
|
+ /**
|
|
+ * The request attribute that is set to the value of {@code Boolean.TRUE}
|
|
+ * if {@link org.apache.catalina.filters.RemoteIpFilter} determines
|
|
+ * that this request was submitted via a secure channel.
|
|
+ */
|
|
+ public static final String REMOTE_IP_FILTER_SECURE = "org.apache.catalina.filters.RemoteIpFilter.secure";
|
|
+
|
|
+
|
|
/**
|
|
* The request attribute that can be used by a servlet to pass
|
|
* to the connector the name of the file that is to be served
|
|
diff --git a/java/org/apache/catalina/connector/Request.java b/java/org/apache/catalina/connector/Request.java
|
|
index 94065ef..889d5e7 100644
|
|
--- a/java/org/apache/catalina/connector/Request.java
|
|
+++ b/java/org/apache/catalina/connector/Request.java
|
|
@@ -3501,6 +3501,20 @@ public class Request implements HttpServletRequest {
|
|
// NO-OP
|
|
}
|
|
});
|
|
+ specialAttributes.put(Globals.REMOTE_IP_FILTER_SECURE,
|
|
+ new SpecialAttributeAdapter() {
|
|
+ @Override
|
|
+ public Object get(Request request, String name) {
|
|
+ return Boolean.valueOf(request.isSecure());
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public void set(Request request, String name, Object value) {
|
|
+ if (value instanceof Boolean) {
|
|
+ request.setSecure(((Boolean) value).booleanValue());
|
|
+ }
|
|
+ }
|
|
+ });
|
|
specialAttributes.put(Globals.STREAM_ID,
|
|
new SpecialAttributeAdapter() {
|
|
@Override
|
|
diff --git a/java/org/apache/catalina/filters/RemoteIpFilter.java b/java/org/apache/catalina/filters/RemoteIpFilter.java
|
|
index b9f6655..e978cfb 100644
|
|
--- a/java/org/apache/catalina/filters/RemoteIpFilter.java
|
|
+++ b/java/org/apache/catalina/filters/RemoteIpFilter.java
|
|
@@ -577,11 +577,6 @@ public class RemoteIpFilter extends GenericFilter {
|
|
return serverPort;
|
|
}
|
|
|
|
- @Override
|
|
- public boolean isSecure() {
|
|
- return secure;
|
|
- }
|
|
-
|
|
public void removeHeader(String name) {
|
|
Map.Entry<String, List<String>> header = getHeaderEntry(name);
|
|
if (header != null) {
|
|
@@ -617,7 +612,7 @@ public class RemoteIpFilter extends GenericFilter {
|
|
}
|
|
|
|
public void setSecure(boolean secure) {
|
|
- this.secure = secure;
|
|
+ super.getRequest().setAttribute(Globals.REMOTE_IP_FILTER_SECURE, Boolean.valueOf(secure));
|
|
}
|
|
|
|
public void setServerPort(int serverPort) {
|
|
diff --git a/test/org/apache/catalina/filters/TestRemoteIpFilter.java b/test/org/apache/catalina/filters/TestRemoteIpFilter.java
|
|
index f7f2093..109fdd2 100644
|
|
--- a/test/org/apache/catalina/filters/TestRemoteIpFilter.java
|
|
+++ b/test/org/apache/catalina/filters/TestRemoteIpFilter.java
|
|
@@ -81,15 +81,21 @@ public class TestRemoteIpFilter extends TomcatBaseTest {
|
|
|
|
private static final long serialVersionUID = 1L;
|
|
|
|
- private transient HttpServletRequest request;
|
|
-
|
|
- public HttpServletRequest getRequest() {
|
|
- return request;
|
|
- }
|
|
+ public String remoteAddr;
|
|
+ public String remoteHost;
|
|
+ public String scheme;
|
|
+ public String serverName;
|
|
+ public int serverPort;
|
|
+ public boolean isSecure;
|
|
|
|
@Override
|
|
public void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
|
|
- this.request = request;
|
|
+ this.isSecure = request.isSecure();
|
|
+ this.remoteAddr = request.getRemoteAddr();
|
|
+ this.remoteHost = request.getRemoteHost();
|
|
+ this.scheme = request.getScheme();
|
|
+ this.serverName = request.getServerName();
|
|
+ this.serverPort = request.getServerPort();
|
|
PrintWriter writer = response.getWriter();
|
|
|
|
writer.println("request.remoteAddr=" + request.getRemoteAddr());
|
|
@@ -127,16 +133,6 @@ public class TestRemoteIpFilter extends TomcatBaseTest {
|
|
getCoyoteRequest().scheme().setString(scheme);
|
|
}
|
|
|
|
- @Override
|
|
- public void setAttribute(String name, Object value) {
|
|
- getCoyoteRequest().getAttributes().put(name, value);
|
|
- }
|
|
-
|
|
- @Override
|
|
- public Object getAttribute(String name) {
|
|
- return getCoyoteRequest().getAttributes().get(name);
|
|
- }
|
|
-
|
|
@Override
|
|
public String getServerName() {
|
|
return "localhost";
|
|
@@ -667,16 +663,70 @@ public class TestRemoteIpFilter extends TomcatBaseTest {
|
|
|
|
// VALIDATE
|
|
Assert.assertEquals(HttpURLConnection.HTTP_OK, httpURLConnection.getResponseCode());
|
|
- HttpServletRequest request = mockServlet.getRequest();
|
|
- Assert.assertNotNull(request);
|
|
|
|
// VALIDATE X-FORWARDED-FOR
|
|
- Assert.assertEquals(expectedRemoteAddr, request.getRemoteAddr());
|
|
- Assert.assertEquals(expectedRemoteAddr, request.getRemoteHost());
|
|
+ Assert.assertEquals(expectedRemoteAddr, mockServlet.remoteAddr);
|
|
+ Assert.assertEquals(expectedRemoteAddr, mockServlet.remoteHost);
|
|
|
|
// VALIDATE X-FORWARDED-PROTO
|
|
- Assert.assertTrue(request.isSecure());
|
|
- Assert.assertEquals("https", request.getScheme());
|
|
- Assert.assertEquals(443, request.getServerPort());
|
|
+ Assert.assertTrue(mockServlet.isSecure);
|
|
+ Assert.assertEquals("https", mockServlet.scheme);
|
|
+ Assert.assertEquals(443, mockServlet.serverPort);
|
|
+ }
|
|
+
|
|
+ @Test
|
|
+ public void testJSessionIdSecureAttributeMissing() throws Exception {
|
|
+
|
|
+ // mostly default configuration : enable "x-forwarded-proto"
|
|
+ Map<String, String> remoteIpFilterParameter = new HashMap<>();
|
|
+ remoteIpFilterParameter.put("protocolHeader", "x-forwarded-proto");
|
|
+
|
|
+ // SETUP
|
|
+ Tomcat tomcat = getTomcatInstance();
|
|
+ Context root = tomcat.addContext("", TEMP_DIR);
|
|
+
|
|
+ FilterDef filterDef = new FilterDef();
|
|
+ filterDef.getParameterMap().putAll(remoteIpFilterParameter);
|
|
+ filterDef.setFilterClass(RemoteIpFilter.class.getName());
|
|
+ filterDef.setFilterName(RemoteIpFilter.class.getName());
|
|
+
|
|
+ root.addFilterDef(filterDef);
|
|
+
|
|
+ FilterMap filterMap = new FilterMap();
|
|
+ filterMap.setFilterName(RemoteIpFilter.class.getName());
|
|
+ filterMap.addURLPatternDecoded("*");
|
|
+ root.addFilterMap(filterMap);
|
|
+
|
|
+ Bug66471Servlet bug66471Servlet = new Bug66471Servlet();
|
|
+
|
|
+ Tomcat.addServlet(root, bug66471Servlet.getClass().getName(), bug66471Servlet);
|
|
+ root.addServletMappingDecoded("/test", bug66471Servlet.getClass().getName());
|
|
+
|
|
+ getTomcatInstance().start();
|
|
+
|
|
+ Map<String, List<String>> resHeaders = new HashMap<>();
|
|
+ Map<String, List<String>> reqHeaders = new HashMap<>();
|
|
+ String expectedRemoteAddr = "my-remote-addr";
|
|
+ List<String> forwardedFor = new ArrayList<>(1);
|
|
+ forwardedFor.add(expectedRemoteAddr);
|
|
+ List<String> forwardedProto = new ArrayList<>(1);
|
|
+ forwardedProto.add("https");
|
|
+ reqHeaders.put("x-forwarded-for", forwardedFor);
|
|
+ reqHeaders.put("x-forwarded-proto", forwardedProto);
|
|
+
|
|
+ getUrl("http://localhost:" + tomcat.getConnector().getLocalPort() +
|
|
+ "/test", null, reqHeaders, resHeaders);
|
|
+ String setCookie = resHeaders.get("Set-Cookie").get(0);
|
|
+ Assert.assertTrue(setCookie.contains("Secure"));
|
|
+ Assert.assertTrue(bug66471Servlet.isSecure.booleanValue());
|
|
+ }
|
|
+ public static class Bug66471Servlet extends HttpServlet {
|
|
+ private static final long serialVersionUID = 1L;
|
|
+ public Boolean isSecure;
|
|
+ @Override
|
|
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
|
|
+ req.getSession();
|
|
+ isSecure = (Boolean) req.getAttribute(Globals.REMOTE_IP_FILTER_SECURE);
|
|
+ }
|
|
}
|
|
}
|
|
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
|
|
index 8837628..15be3ed 100644
|
|
--- a/webapps/docs/changelog.xml
|
|
+++ b/webapps/docs/changelog.xml
|
|
@@ -478,6 +478,11 @@
|
|
Improve handling of overflow in the UTF-8 decoder with supplementary
|
|
characters. (markt)
|
|
</fix>
|
|
+ <fix>
|
|
+ <bug>66471</bug>: Fix JSessionId secure attribute missing When
|
|
+ <code>RemoteIpFilter</code> determines that this request was submitted
|
|
+ via a secure channel. (lihan)
|
|
+ </fix>
|
|
</changelog>
|
|
</subsection>
|
|
<subsection name="Coyote">
|
|
--
|
|
2.33.0
|
|
|