root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Harmonize default for server.tomcat.use-relative-redirects 

Prior to this commit, the property was a Boolean with a null default.
If it was explicitly set by the user, a context customizer would use
that value to set it on the context. However, if it was not set, the default
wouldn't be tomcat's default but `false` because it was explicitly set to
`false` in `TomcatServletWebServerFactory`. This commit defaults the property
itself to `false` so that the default is more obvious to the user.

Fixes gh-20796
This commit is contained in:
Madhura Bhave 2020-05-06 15:50:07 -07:00
parent 386d678d99
commit f29bce657e
4 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java
View File

@ -380,7 +380,7 @@ public class ServerProperties {
* Whether HTTP 1.1 and later location headers generated by a call to sendRedirect * Whether HTTP 1.1 and later location headers generated by a call to sendRedirect
* will use relative or absolute redirects. * will use relative or absolute redirects.
*/ */
private Boolean useRelativeRedirects; private boolean useRelativeRedirects;
/** /**
* Character encoding to use to decode the URI. * Character encoding to use to decode the URI.
@ -537,14 +537,19 @@ public class ServerProperties {
this.redirectContextRoot = redirectContextRoot; this.redirectContextRoot = redirectContextRoot;
} }
public Boolean getUseRelativeRedirects() { public boolean getUseRelativeRedirects() {
return this.useRelativeRedirects; return this.useRelativeRedirects;
} }
public void setUseRelativeRedirects(Boolean useRelativeRedirects) { public void setUseRelativeRedirects(boolean useRelativeRedirects) {
this.useRelativeRedirects = useRelativeRedirects; this.useRelativeRedirects = useRelativeRedirects;
} }
@Deprecated
public void setUseRelativeRedirects(Boolean useRelativeRedirects) {
this.useRelativeRedirects = (useRelativeRedirects != null) ? useRelativeRedirects : false;
}
public String getRemoteIpHeader() { public String getRemoteIpHeader() {
return this.remoteIpHeader; return this.remoteIpHeader;
} }

4
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/TomcatServletWebServerFactoryCustomizer.java
View File

@ -54,9 +54,7 @@ public class TomcatServletWebServerFactoryCustomizer
if (tomcatProperties.getRedirectContextRoot() != null) { if (tomcatProperties.getRedirectContextRoot() != null) {
customizeRedirectContextRoot(factory, tomcatProperties.getRedirectContextRoot()); customizeRedirectContextRoot(factory, tomcatProperties.getRedirectContextRoot());
} }
if (tomcatProperties.getUseRelativeRedirects() != null) { customizeUseRelativeRedirects(factory, tomcatProperties.getUseRelativeRedirects());
customizeUseRelativeRedirects(factory, tomcatProperties.getUseRelativeRedirects());
}
factory.setDisableMBeanRegistry(!tomcatProperties.getMbeanregistry().isEnabled()); factory.setDisableMBeanRegistry(!tomcatProperties.getMbeanregistry().isEnabled());
} }

7
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/ServerPropertiesTests.java
View File

@ -131,6 +131,7 @@ class ServerPropertiesTests {
map.put("server.tomcat.background-processor-delay", "10"); map.put("server.tomcat.background-processor-delay", "10");
map.put("server.tomcat.relaxed-path-chars", "|,<"); map.put("server.tomcat.relaxed-path-chars", "|,<");
map.put("server.tomcat.relaxed-query-chars", "^ , | "); map.put("server.tomcat.relaxed-query-chars", "^ , | ");
map.put("server.tomcat.use-relative-redirects", "true");
bind(map); bind(map);
ServerProperties.Tomcat tomcat = this.properties.getTomcat(); ServerProperties.Tomcat tomcat = this.properties.getTomcat();
Accesslog accesslog = tomcat.getAccesslog(); Accesslog accesslog = tomcat.getAccesslog();
@ -152,6 +153,7 @@ class ServerPropertiesTests {
assertThat(tomcat.getBackgroundProcessorDelay()).isEqualTo(Duration.ofSeconds(10)); assertThat(tomcat.getBackgroundProcessorDelay()).isEqualTo(Duration.ofSeconds(10));
assertThat(tomcat.getRelaxedPathChars()).containsExactly('|', '<'); assertThat(tomcat.getRelaxedPathChars()).containsExactly('|', '<');
assertThat(tomcat.getRelaxedQueryChars()).containsExactly('^', '|'); assertThat(tomcat.getRelaxedQueryChars()).containsExactly('^', '|');
assertThat(tomcat.getUseRelativeRedirects()).isTrue();
} }
@Test @Test
@ -347,6 +349,11 @@ class ServerPropertiesTests {
.isEqualTo(new RemoteIpValve().getInternalProxies()); .isEqualTo(new RemoteIpValve().getInternalProxies());
} }
@Test
void tomcatUseRelativeRedirectsDefaultsToFalse() {
assertThat(this.properties.getTomcat().getUseRelativeRedirects()).isFalse();
}
@Test @Test
void jettyMaxHttpFormPostSizeMatchesDefault() throws Exception { void jettyMaxHttpFormPostSizeMatchesDefault() throws Exception {
JettyServletWebServerFactory jettyFactory = new JettyServletWebServerFactory(0); JettyServletWebServerFactory jettyFactory = new JettyServletWebServerFactory(0);

1
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/embedded/tomcat/TomcatServletWebServerFactory.java
View File

@ -214,7 +214,6 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto
: ClassUtils.getDefaultClassLoader()); : ClassUtils.getDefaultClassLoader());
resetDefaultLocaleMapping(context); resetDefaultLocaleMapping(context);
addLocaleMappings(context); addLocaleMappings(context);
context.setUseRelativeRedirects(false);
try { try {
context.setCreateUploadTargets(true); context.setCreateUploadTargets(true);
} }