commit
c761dc517b
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2012-2021 the original author or authors.
|
* Copyright 2012-2022 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -88,17 +88,37 @@ public class ServletWebServerFactoryAutoConfiguration {
|
||||||
return new TomcatServletWebServerFactoryCustomizer(serverProperties);
|
return new TomcatServletWebServerFactoryCustomizer(serverProperties);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Bean
|
@Configuration(proxyBeanMethods = false)
|
||||||
@ConditionalOnMissingFilterBean(ForwardedHeaderFilter.class)
|
|
||||||
@ConditionalOnProperty(value = "server.forward-headers-strategy", havingValue = "framework")
|
@ConditionalOnProperty(value = "server.forward-headers-strategy", havingValue = "framework")
|
||||||
public FilterRegistrationBean<ForwardedHeaderFilter> forwardedHeaderFilter() {
|
@ConditionalOnMissingFilterBean(ForwardedHeaderFilter.class)
|
||||||
|
static class ForwardedHeaderFilterConfiguration {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
@ConditionalOnClass(name = "org.apache.catalina.startup.Tomcat")
|
||||||
|
@ConditionalOnMissingFilterBean(ForwardedHeaderFilter.class)
|
||||||
|
ForwardedHeaderFilterCustomizer tomcatForwardedHeaderFilterCustomizer(ServerProperties serverProperties) {
|
||||||
|
return (filter) -> filter.setRelativeRedirects(serverProperties.getTomcat().isUseRelativeRedirects());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
FilterRegistrationBean<ForwardedHeaderFilter> forwardedHeaderFilter(
|
||||||
|
ObjectProvider<ForwardedHeaderFilterCustomizer> customizerProvider) {
|
||||||
ForwardedHeaderFilter filter = new ForwardedHeaderFilter();
|
ForwardedHeaderFilter filter = new ForwardedHeaderFilter();
|
||||||
|
customizerProvider.ifAvailable((customizer) -> customizer.customize(filter));
|
||||||
FilterRegistrationBean<ForwardedHeaderFilter> registration = new FilterRegistrationBean<>(filter);
|
FilterRegistrationBean<ForwardedHeaderFilter> registration = new FilterRegistrationBean<>(filter);
|
||||||
registration.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ASYNC, DispatcherType.ERROR);
|
registration.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ASYNC, DispatcherType.ERROR);
|
||||||
registration.setOrder(Ordered.HIGHEST_PRECEDENCE);
|
registration.setOrder(Ordered.HIGHEST_PRECEDENCE);
|
||||||
return registration;
|
return registration;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ForwardedHeaderFilterCustomizer {
|
||||||
|
|
||||||
|
void customize(ForwardedHeaderFilter filter);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Registers a {@link WebServerFactoryCustomizerBeanPostProcessor}. Registered via
|
* Registers a {@link WebServerFactoryCustomizerBeanPostProcessor}. Registered via
|
||||||
* {@link ImportBeanDefinitionRegistrar} for early registration.
|
* {@link ImportBeanDefinitionRegistrar} for early registration.
|
||||||
|
|
|
@ -354,6 +354,7 @@ class ServletWebServerFactoryAutoConfigurationTests {
|
||||||
assertThat(context).hasSingleBean(FilterRegistrationBean.class);
|
assertThat(context).hasSingleBean(FilterRegistrationBean.class);
|
||||||
Filter filter = context.getBean(FilterRegistrationBean.class).getFilter();
|
Filter filter = context.getBean(FilterRegistrationBean.class).getFilter();
|
||||||
assertThat(filter).isInstanceOf(ForwardedHeaderFilter.class);
|
assertThat(filter).isInstanceOf(ForwardedHeaderFilter.class);
|
||||||
|
assertThat(filter).extracting("relativeRedirects").isEqualTo(false);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -378,6 +379,48 @@ class ServletWebServerFactoryAutoConfigurationTests {
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void relativeRedirectsShouldBeEnabledWhenUsingTomcatContainerAndUseRelativeRedirects() {
|
||||||
|
WebApplicationContextRunner runner = new WebApplicationContextRunner(
|
||||||
|
AnnotationConfigServletWebServerApplicationContext::new)
|
||||||
|
.withConfiguration(AutoConfigurations.of(ServletWebServerFactoryAutoConfiguration.class))
|
||||||
|
.withPropertyValues("server.forward-headers-strategy=framework",
|
||||||
|
"server.tomcat.use-relative-redirects=true");
|
||||||
|
runner.run((context) -> {
|
||||||
|
Filter filter = context.getBean(FilterRegistrationBean.class).getFilter();
|
||||||
|
assertThat(filter).isInstanceOf(ForwardedHeaderFilter.class);
|
||||||
|
assertThat(filter).extracting("relativeRedirects").isEqualTo(true);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void relativeRedirectsShouldNotBeEnabledWhenUsingTomcatContainerAndNotUsingRelativeRedirects() {
|
||||||
|
WebApplicationContextRunner runner = new WebApplicationContextRunner(
|
||||||
|
AnnotationConfigServletWebServerApplicationContext::new)
|
||||||
|
.withConfiguration(AutoConfigurations.of(ServletWebServerFactoryAutoConfiguration.class))
|
||||||
|
.withPropertyValues("server.forward-headers-strategy=framework",
|
||||||
|
"server.tomcat.use-relative-redirects=false");
|
||||||
|
runner.run((context) -> {
|
||||||
|
Filter filter = context.getBean(FilterRegistrationBean.class).getFilter();
|
||||||
|
assertThat(filter).isInstanceOf(ForwardedHeaderFilter.class);
|
||||||
|
assertThat(filter).extracting("relativeRedirects").isEqualTo(false);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void relativeRedirectsShouldNotBeEnabledWhenNotUsingTomcatContainer() {
|
||||||
|
WebApplicationContextRunner runner = new WebApplicationContextRunner(
|
||||||
|
AnnotationConfigServletWebServerApplicationContext::new)
|
||||||
|
.withClassLoader(new FilteredClassLoader(Tomcat.class))
|
||||||
|
.withConfiguration(AutoConfigurations.of(ServletWebServerFactoryAutoConfiguration.class))
|
||||||
|
.withPropertyValues("server.forward-headers-strategy=framework");
|
||||||
|
runner.run((context) -> {
|
||||||
|
Filter filter = context.getBean(FilterRegistrationBean.class).getFilter();
|
||||||
|
assertThat(filter).isInstanceOf(ForwardedHeaderFilter.class);
|
||||||
|
assertThat(filter).extracting("relativeRedirects").isEqualTo(false);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
private ContextConsumer<AssertableWebApplicationContext> verifyContext() {
|
private ContextConsumer<AssertableWebApplicationContext> verifyContext() {
|
||||||
return this::verifyContext;
|
return this::verifyContext;
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue