SpringCloud/spring-cloud-gateway
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Moves x-forwarded filter properties to correct namespace.

Browse Source 
From spring.cloud.gateway.x-forwarded to spring.cloud.gateway.mvc.x-forwarded-request-headers-filter. Deprecates the later.

The XForwardedRequestHeadersFilter bean is conditional on the x-forwarded-request-headers-filter.enabled property.

Fixes gh-3238
This commit is contained in:
sgibb
2024-03-11 15:32:58 -04:00
parent b6fc8aa190
commit 67b612d4af
3 changed files with 233 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
spring-cloud-gateway-server-mvc/src/main/java/org/springframework/cloud/gateway/server/mvc/GatewayServerMvcAutoConfiguration.java
View File

@@ -40,6 +40,7 @@ import org.springframework.cloud.gateway.server.mvc.filter.RemoveHopByHopRespons
import org.springframework.cloud.gateway.server.mvc.filter.TransferEncodingNormalizationRequestHeadersFilter;
import org.springframework.cloud.gateway.server.mvc.filter.WeightCalculatorFilter;
import org.springframework.cloud.gateway.server.mvc.filter.XForwardedRequestHeadersFilter;
import org.springframework.cloud.gateway.server.mvc.filter.XForwardedRequestHeadersFilterProperties;
import org.springframework.cloud.gateway.server.mvc.handler.ProxyExchange;
import org.springframework.cloud.gateway.server.mvc.handler.ProxyExchangeHandlerFunction;
import org.springframework.cloud.gateway.server.mvc.handler.RestClientProxyExchange;
@@ -169,8 +170,16 @@ public class GatewayServerMvcAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public XForwardedRequestHeadersFilter xForwardedRequestHeadersFilter() {
return new XForwardedRequestHeadersFilter();
@ConditionalOnProperty(prefix = XForwardedRequestHeadersFilterProperties.PREFIX, name = ".enabled",
matchIfMissing = true)
public XForwardedRequestHeadersFilter xForwardedRequestHeadersFilter(
XForwardedRequestHeadersFilterProperties props) {
return new XForwardedRequestHeadersFilter(props);
}
@Bean
public XForwardedRequestHeadersFilterProperties xForwardedRequestHeadersFilterProperties() {
return new XForwardedRequestHeadersFilterProperties();
}
}

60
spring-cloud-gateway-server-mvc/src/main/java/org/springframework/cloud/gateway/server/mvc/filter/XForwardedRequestHeadersFilter.java
View File

@@ -23,12 +23,16 @@ import java.util.List;
import java.util.Map;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
import org.springframework.boot.context.properties.PropertyMapper;
import org.springframework.core.Ordered;
import org.springframework.http.HttpHeaders;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.function.ServerRequest;
import static org.springframework.cloud.gateway.server.mvc.filter.XForwardedRequestHeadersFilterProperties.PREFIX;
@ConfigurationProperties("spring.cloud.gateway.x-forwarded")
public class XForwardedRequestHeadersFilter implements HttpHeadersFilter.RequestHttpHeadersFilter, Ordered {
@@ -95,55 +99,97 @@ public class XForwardedRequestHeadersFilter implements HttpHeadersFilter.Request
/** If appending X-Forwarded-Prefix as a list is enabled. */
private boolean prefixAppend = true;
@Deprecated
public XForwardedRequestHeadersFilter() {
this(new XForwardedRequestHeadersFilterProperties());
}
public XForwardedRequestHeadersFilter(XForwardedRequestHeadersFilterProperties props) {
// TODO: remove individual properties in 4.2.0
// this.properties = properties;
PropertyMapper map = PropertyMapper.get();
map.from(props::getOrder).to(this::setOrder);
map.from(props::isEnabled).to(this::setEnabled);
map.from(props::isForEnabled).to(this::setForEnabled);
map.from(props::isHostEnabled).to(this::setHostEnabled);
map.from(props::isPortEnabled).to(this::setPortEnabled);
map.from(props::isProtoEnabled).to(this::setProtoEnabled);
map.from(props::isPrefixEnabled).to(this::setPrefixEnabled);
map.from(props::isForAppend).to(this::setForAppend);
map.from(props::isHostAppend).to(this::setHostAppend);
map.from(props::isPortAppend).to(this::setPortAppend);
map.from(props::isProtoAppend).to(this::setProtoAppend);
map.from(props::isPrefixAppend).to(this::setPrefixAppend);
}
@DeprecatedConfigurationProperty(replacement = PREFIX + ".order")
@Override
public int getOrder() {
return this.order;
}
@Deprecated
public void setOrder(int order) {
this.order = order;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".enabled")
public boolean isEnabled() {
return enabled;
}
@Deprecated
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".for-enabled")
public boolean isForEnabled() {
return forEnabled;
}
@Deprecated
public void setForEnabled(boolean forEnabled) {
this.forEnabled = forEnabled;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".host-enabled")
public boolean isHostEnabled() {
return hostEnabled;
}
@Deprecated
public void setHostEnabled(boolean hostEnabled) {
this.hostEnabled = hostEnabled;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".port-enabled")
public boolean isPortEnabled() {
return portEnabled;
}
@Deprecated
public void setPortEnabled(boolean portEnabled) {
this.portEnabled = portEnabled;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".proto-enabled")
public boolean isProtoEnabled() {
return protoEnabled;
}
@Deprecated
public void setProtoEnabled(boolean protoEnabled) {
this.protoEnabled = protoEnabled;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".prefix-enabled")
public boolean isPrefixEnabled() {
return prefixEnabled;
}
@@ -152,30 +198,41 @@ public class XForwardedRequestHeadersFilter implements HttpHeadersFilter.Request
this.prefixEnabled = prefixEnabled;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".for-append")
public boolean isForAppend() {
return forAppend;
}
@Deprecated
public void setForAppend(boolean forAppend) {
this.forAppend = forAppend;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".host-append")
public boolean isHostAppend() {
return hostAppend;
}
@Deprecated
public void setHostAppend(boolean hostAppend) {
this.hostAppend = hostAppend;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".port-append")
public boolean isPortAppend() {
return portAppend;
}
@Deprecated
public void setPortAppend(boolean portAppend) {
this.portAppend = portAppend;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".proto-append")
public boolean isProtoAppend() {
return protoAppend;
}
@@ -184,10 +241,13 @@ public class XForwardedRequestHeadersFilter implements HttpHeadersFilter.Request
this.protoAppend = protoAppend;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = PREFIX + ".prefix-append")
public boolean isPrefixAppend() {
return prefixAppend;
}
@Deprecated
public void setPrefixAppend(boolean prefixAppend) {
this.prefixAppend = prefixAppend;
}

162
spring-cloud-gateway-server-mvc/src/main/java/org/springframework/cloud/gateway/server/mvc/filter/XForwardedRequestHeadersFilterProperties.java Normal file
View File

@@ -0,0 +1,162 @@
/*
* Copyright 2013-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.
* 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.cloud.gateway.server.mvc.filter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.cloud.gateway.server.mvc.config.GatewayMvcProperties;
@ConfigurationProperties(XForwardedRequestHeadersFilterProperties.PREFIX)
public class XForwardedRequestHeadersFilterProperties {
/**
* XForwardedRequestHeadersFilterProperties prefix.
*/
public static final String PREFIX = GatewayMvcProperties.PREFIX + ".x-forwarded-request-headers-filter";
/** The order of the XForwardedHeadersFilter. */
private int order = 0;
/** If the XForwardedHeadersFilter is enabled. */
private boolean enabled = true;
/** If X-Forwarded-For is enabled. */
private boolean forEnabled = true;
/** If X-Forwarded-Host is enabled. */
private boolean hostEnabled = true;
/** If X-Forwarded-Port is enabled. */
private boolean portEnabled = true;
/** If X-Forwarded-Proto is enabled. */
private boolean protoEnabled = true;
/** If X-Forwarded-Prefix is enabled. */
private boolean prefixEnabled = true;
/** If appending X-Forwarded-For as a list is enabled. */
private boolean forAppend = true;
/** If appending X-Forwarded-Host as a list is enabled. */
private boolean hostAppend = true;
/** If appending X-Forwarded-Port as a list is enabled. */
private boolean portAppend = true;
/** If appending X-Forwarded-Proto as a list is enabled. */
private boolean protoAppend = true;
/** If appending X-Forwarded-Prefix as a list is enabled. */
private boolean prefixAppend = true;
public int getOrder() {
return this.order;
}
public void setOrder(int order) {
this.order = order;
}
public boolean isEnabled() {
return enabled;
}
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
public boolean isForEnabled() {
return forEnabled;
}
public void setForEnabled(boolean forEnabled) {
this.forEnabled = forEnabled;
}
public boolean isHostEnabled() {
return hostEnabled;
}
public void setHostEnabled(boolean hostEnabled) {
this.hostEnabled = hostEnabled;
}
public boolean isPortEnabled() {
return portEnabled;
}
public void setPortEnabled(boolean portEnabled) {
this.portEnabled = portEnabled;
}
public boolean isProtoEnabled() {
return protoEnabled;
}
public void setProtoEnabled(boolean protoEnabled) {
this.protoEnabled = protoEnabled;
}
public boolean isPrefixEnabled() {
return prefixEnabled;
}
public void setPrefixEnabled(boolean prefixEnabled) {
this.prefixEnabled = prefixEnabled;
}
public boolean isForAppend() {
return forAppend;
}
public void setForAppend(boolean forAppend) {
this.forAppend = forAppend;
}
public boolean isHostAppend() {
return hostAppend;
}
public void setHostAppend(boolean hostAppend) {
this.hostAppend = hostAppend;
}
public boolean isPortAppend() {
return portAppend;
}
public void setPortAppend(boolean portAppend) {
this.portAppend = portAppend;
}
public boolean isProtoAppend() {
return protoAppend;
}
public void setProtoAppend(boolean protoAppend) {
this.protoAppend = protoAppend;
}
public boolean isPrefixAppend() {
return prefixAppend;
}
public void setPrefixAppend(boolean prefixAppend) {
this.prefixAppend = prefixAppend;
}
}