Add DisableUrlRewritingFilter

Closes gh-11084

web/src/main/java/org/springframework/security/web/session/DisableEncodeUrlFilter.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2002-2022 the original author or authors.
+ *
+ * Licensed 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
+ *
+ *      https://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.springframework.security.web.session;
+
+import java.io.IOException;
+
+import javax.servlet.FilterChain;
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpServletResponseWrapper;
+
+import org.springframework.web.filter.OncePerRequestFilter;
+
+/**
+ * Disables encoding URLs using the {@link HttpServletResponse} to prevent including the
+ * session id in URLs which is not considered URL because the session id can be leaked in
+ * things like HTTP access logs.
+ *
+ * @author Rob Winch
+ * @since 5.7
+ */
+public class DisableEncodeUrlFilter extends OncePerRequestFilter {
+
+	@Override
+	protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
+			throws ServletException, IOException {
+		filterChain.doFilter(request, new DisableEncodeUrlResponseWrapper(response));
+	}
+
+	/**
+	 * Disables URL rewriting for the {@link HttpServletResponse} to prevent including the
+	 * session id in URLs which is not considered URL because the session id can be leaked
+	 * in things like HTTP access logs.
+	 *
+	 * @author Rob Winch
+	 * @since 5.7
+	 */
+	private static final class DisableEncodeUrlResponseWrapper extends HttpServletResponseWrapper {
+
+		/**
+		 * Constructs a response adaptor wrapping the given response.
+		 * @param response the {@link HttpServletResponse} to be wrapped.
+		 * @throws IllegalArgumentException if the response is null
+		 */
+		private DisableEncodeUrlResponseWrapper(HttpServletResponse response) {
+			super(response);
+		}
+
+		@Override
+		public String encodeRedirectUrl(String url) {
+			return url;
+		}
+
+		@Override
+		public String encodeRedirectURL(String url) {
+			return url;
+		}
+
+		@Override
+		public String encodeUrl(String url) {
+			return url;
+		}
+
+		@Override
+		public String encodeURL(String url) {
+			return url;
+		}
+
+	}
+
+}

web/src/test/java/org/springframework/security/web/session/DisableEncodeUrlFilterTests.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2002-2022 the original author or authors.
+ *
+ * Licensed 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
+ *
+ *      https://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.springframework.security.web.session;
+
+import java.util.function.Consumer;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import static org.mockito.Mockito.verifyNoInteractions;
+
+/**
+ * @author Rob Winch
+ */
+@ExtendWith(MockitoExtension.class)
+class DisableEncodeUrlFilterTests {
+
+	@Mock
+	private HttpServletRequest request;
+
+	@Mock
+	private HttpServletResponse response;
+
+	private DisableEncodeUrlFilter filter = new DisableEncodeUrlFilter();
+
+	@Test
+	void doFilterDisablesEncodeURL() throws Exception {
+		verifyDoFilterDoesNotInteractWithResponse((httpResponse) -> httpResponse.encodeURL("/"));
+	}
+
+	@Test
+	void doFilterDisablesEncodeUrl() throws Exception {
+		verifyDoFilterDoesNotInteractWithResponse((httpResponse) -> httpResponse.encodeUrl("/"));
+	}
+
+	@Test
+	void doFilterDisablesEncodeRedirectURL() throws Exception {
+		verifyDoFilterDoesNotInteractWithResponse((httpResponse) -> httpResponse.encodeRedirectURL("/"));
+	}
+
+	@Test
+	void doFilterDisablesEncodeRedirectUrl() throws Exception {
+		verifyDoFilterDoesNotInteractWithResponse((httpResponse) -> httpResponse.encodeRedirectUrl("/"));
+	}
+
+	private void verifyDoFilterDoesNotInteractWithResponse(Consumer<HttpServletResponse> toInvoke) throws Exception {
+		this.filter.doFilter(this.request, this.response, (request, response) -> {
+			HttpServletResponse httpResponse = (HttpServletResponse) response;
+			toInvoke.accept(httpResponse);
+		});
+		verifyNoInteractions(this.response);
+	}
+
+}