Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Retain brackets for IPV6 address in MockHttpServletRequest

Browse Source 
According to the Javadoc for ServletRequest's getServerName() method,
when the `Host` header is set, the server name is "the value of the
part before ':' in the Host header value ...". For a value representing
an IPV6 address such as `[::ffff:abcd:abcd]`, the enclosing square
brackets should therefore not be stripped from the enclosed IPV6
address.

However, the changes made in conjunction with gh-16704 introduced a
regression in Spring Framework 4.1 for the getServerName() method in
MockHttpServletRequest by stripping the enclosing brackets from the
IPV6 address in the `Host` header. Similarly, the changes made in
conjunction with gh-20686 introduced a regression in Spring Framework
4.3.13 and 5.0.2 in the getRequestURL() method in
MockHttpServletRequest by delegating to the getServerName() method
which strips the enclosing brackets.

This commit fixes the implementation of getServerName() so that the
enclosing brackets are no longer stripped from an IPV6 address in the
`Host` header. The implementation of getRequestURL() is therefore also
fixed.

In addition, in order to avoid a NullPointerException, the
implementations of getServerName() and getServerPort() now assert that
an IPV6 address present in the `Host` header correctly contains an
opening and closing bracket and throw an IllegalStateException if that
is not the case.

Closes gh-24916
This commit is contained in:
Sam Brannen
2020-04-17 15:01:35 +02:00
parent f929109415
commit f60bb825b0
3 changed files with 96 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
spring-test/src/main/java/org/springframework/mock/web/MockHttpServletRequest.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2020 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.
@@ -591,11 +591,14 @@ public class MockHttpServletRequest implements HttpServletRequest {
@Override
public String getServerName() {
String host = getHeader(HOST_HEADER);
String rawHostHeader = getHeader(HOST_HEADER);
String host = rawHostHeader;
if (host != null) {
host = host.trim();
if (host.startsWith("[")) {
host = host.substring(1, host.indexOf(']'));
int indexOfClosingBracket = host.indexOf(']');
Assert.state(indexOfClosingBracket > -1, "Invalid Host header: " + rawHostHeader);
host = host.substring(0, indexOfClosingBracket + 1);
}
else if (host.contains(":")) {
host = host.substring(0, host.indexOf(':'));
@@ -613,12 +616,15 @@ public class MockHttpServletRequest implements HttpServletRequest {
@Override
public int getServerPort() {
String host = getHeader(HOST_HEADER);
String rawHostHeader = getHeader(HOST_HEADER);
String host = rawHostHeader;
if (host != null) {
host = host.trim();
int idx;
if (host.startsWith("[")) {
idx = host.indexOf(':', host.indexOf(']'));
int indexOfClosingBracket = host.indexOf(']');
Assert.state(indexOfClosingBracket > -1, "Invalid Host header: " + rawHostHeader);
idx = host.indexOf(':', indexOfClosingBracket);
}
else {
idx = host.indexOf(':');

81
spring-test/src/test/java/org/springframework/mock/web/MockHttpServletRequestTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2020 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.
@@ -17,6 +17,7 @@
package org.springframework.mock.web;
import java.io.IOException;
import java.net.URL;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Arrays;
@@ -29,10 +30,13 @@ import java.util.Locale;
import java.util.Map;
import javax.servlet.http.Cookie;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.springframework.util.StreamUtils;
import static org.hamcrest.CoreMatchers.startsWith;
import static org.junit.Assert.*;
/**
@@ -54,6 +58,9 @@ public class MockHttpServletRequestTests {
private static final String IF_MODIFIED_SINCE = "If-Modified-Since";
private final MockHttpServletRequest request = new MockHttpServletRequest();
@Rule
public ExpectedException exception = ExpectedException.none();
@Test
@@ -289,16 +296,23 @@ public class MockHttpServletRequestTests {
@Test
public void getServerNameViaHostHeaderAsIpv6AddressWithoutPort() {
String ipv6Address = "[2001:db8:0:1]";
request.addHeader(HOST, ipv6Address);
assertEquals("2001:db8:0:1", request.getServerName());
String host = "[2001:db8:0:1]";
request.addHeader(HOST, host);
assertEquals(host, request.getServerName());
}
@Test
public void getServerNameViaHostHeaderAsIpv6AddressWithPort() {
String ipv6Address = "[2001:db8:0:1]:8081";
request.addHeader(HOST, ipv6Address);
assertEquals("2001:db8:0:1", request.getServerName());
request.addHeader(HOST, "[2001:db8:0:1]:8081");
assertEquals("[2001:db8:0:1]", request.getServerName());
}
@Test
public void getServerNameWithInvalidIpv6AddressViaHostHeader() {
request.addHeader(HOST, "[::ffff:abcd:abcd"); // missing closing bracket
exception.expect(IllegalStateException.class);
exception.expectMessage(startsWith("Invalid Host header: "));
request.getServerName();
}
@Test
@@ -312,6 +326,22 @@ public class MockHttpServletRequestTests {
assertEquals(8080, request.getServerPort());
}
@Test
public void getServerPortWithInvalidIpv6AddressViaHostHeader() {
request.addHeader(HOST, "[::ffff:abcd:abcd:8080"); // missing closing bracket
exception.expect(IllegalStateException.class);
exception.expectMessage(startsWith("Invalid Host header: "));
request.getServerPort();
}
@Test
public void getServerPortWithIpv6AddressAndInvalidPortViaHostHeader() {
request.addHeader(HOST, "[::ffff:abcd:abcd]:bogus"); // "bogus" is not a port number
exception.expect(NumberFormatException.class);
exception.expectMessage("bogus");
request.getServerPort();
}
@Test
public void getServerPortViaHostHeaderAsIpv6AddressWithoutPort() {
String testServer = "[2001:db8:0:1]";
@@ -376,6 +406,43 @@ public class MockHttpServletRequestTests {
assertEquals("http://" + testServer, requestURL.toString());
}
@Test
public void getRequestURLWithIpv6AddressViaServerNameWithoutPort() throws Exception {
request.setServerName("[::ffff:abcd:abcd]");
URL url = new java.net.URL(request.getRequestURL().toString());
assertEquals("http://[::ffff:abcd:abcd]", url.toString());
}
@Test
public void getRequestURLWithIpv6AddressViaServerNameWithPort() throws Exception {
request.setServerName("[::ffff:abcd:abcd]");
request.setServerPort(9999);
URL url = new java.net.URL(request.getRequestURL().toString());
assertEquals("http://[::ffff:abcd:abcd]:9999", url.toString());
}
@Test
public void getRequestURLWithInvalidIpv6AddressViaHostHeader() {
request.addHeader(HOST, "[::ffff:abcd:abcd"); // missing closing bracket
exception.expect(IllegalStateException.class);
exception.expectMessage(startsWith("Invalid Host header: "));
request.getRequestURL();
}
@Test
public void getRequestURLWithIpv6AddressViaHostHeaderWithoutPort() throws Exception {
request.addHeader(HOST, "[::ffff:abcd:abcd]");
URL url = new java.net.URL(request.getRequestURL().toString());
assertEquals("http://[::ffff:abcd:abcd]", url.toString());
}
@Test
public void getRequestURLWithIpv6AddressViaHostHeaderWithPort() throws Exception {
request.addHeader(HOST, "[::ffff:abcd:abcd]:9999");
URL url = new java.net.URL(request.getRequestURL().toString());
assertEquals("http://[::ffff:abcd:abcd]:9999", url.toString());
}
@Test
public void getRequestURLWithNullRequestUri() {
request.setRequestURI(null);

16
spring-web/src/test/java/org/springframework/mock/web/test/MockHttpServletRequest.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2020 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.
@@ -591,11 +591,14 @@ public class MockHttpServletRequest implements HttpServletRequest {
@Override
public String getServerName() {
String host = getHeader(HOST_HEADER);
String rawHostHeader = getHeader(HOST_HEADER);
String host = rawHostHeader;
if (host != null) {
host = host.trim();
if (host.startsWith("[")) {
host = host.substring(1, host.indexOf(']'));
int indexOfClosingBracket = host.indexOf(']');
Assert.state(indexOfClosingBracket > -1, "Invalid Host header: " + rawHostHeader);
host = host.substring(0, indexOfClosingBracket + 1);
}
else if (host.contains(":")) {
host = host.substring(0, host.indexOf(':'));
@@ -613,12 +616,15 @@ public class MockHttpServletRequest implements HttpServletRequest {
@Override
public int getServerPort() {
String host = getHeader(HOST_HEADER);
String rawHostHeader = getHeader(HOST_HEADER);
String host = rawHostHeader;
if (host != null) {
host = host.trim();
int idx;
if (host.startsWith("[")) {
idx = host.indexOf(':', host.indexOf(']'));
int indexOfClosingBracket = host.indexOf(']');
Assert.state(indexOfClosingBracket > -1, "Invalid Host header: " + rawHostHeader);
idx = host.indexOf(':', indexOfClosingBracket);
}
else {
idx = host.indexOf(':');