org.dromara.soul.web.support

类 XForwardedRemoteAddressResolver

java.lang.Object

org.dromara.soul.web.support.XForwardedRemoteAddressResolver

所有已实现的接口:

RemoteAddressResolver

public class XForwardedRemoteAddressResolver
extends Object
implements RemoteAddressResolver

Parses the client address from the X-Forwarded-For header. If header is not present, falls back to RemoteAddressResolver and ServerHttpRequest.getRemoteAddress(). Use the static constructor methods which meets your security requirements.

作者:

Andrew Fitzgerald

另请参阅:

X-Forwarded-For reference

字段概要

字段

限定符和类型	字段和说明
static String	X_FORWARDED_FOR Forwarded-For header name.

构造器概要

构造器

构造器和说明
XForwardedRemoteAddressResolver(int maxTrustedIndex)

方法概要

限定符和类型	方法和说明
static XForwardedRemoteAddressResolver	maxTrustedIndex(int maxTrustedIndex) trusted IP address found in the X-Forwarded-For header (when present).
InetSocketAddress	resolve(org.springframework.web.server.ServerWebExchange exchange) The X-Forwarded-For header contains a comma separated list of IP addresses.
static XForwardedRemoteAddressResolver	trustAll()

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

X_FORWARDED_FOR

public static final String X_FORWARDED_FOR

Forwarded-For header name.

另请参阅:

常量字段值

构造器详细资料

XForwardedRemoteAddressResolver

public XForwardedRemoteAddressResolver(int maxTrustedIndex)

方法详细资料

trustAll

public static XForwardedRemoteAddressResolver trustAll()

返回:

a XForwardedRemoteAddressResolver which always extracts the first IP address found in the X-Forwarded-For header (when present). Equivalent to calling maxTrustedIndex(int) with a maxTrustedIndex of Integer.MAX_VALUE. This configuration is vulnerable to spoofing via manually setting the X-Forwarded-For header. If the resulting IP address is used for security purposes, use maxTrustedIndex(int) instead.

maxTrustedIndex

public static XForwardedRemoteAddressResolver maxTrustedIndex(int maxTrustedIndex)

trusted IP address found in the X-Forwarded-For header (when present). This configuration exists to prevent a malicious actor from spoofing the value of the X-Forwarded-For header. If you know that your gateway application is only accessible from a a trusted load balancer, then you can trust that the load balancer will append a valid client IP address to the X-Forwarded-For header, and should use a value of `1` for the `maxTrustedIndex`. Given the X-Forwarded-For value of [0.0.0.1, 0.0.0.2, 0.0.0.3]:

参数:

maxTrustedIndex - correlates to the number of trusted proxies expected in front of Spring Cloud Gateway (index starts at 1).

返回:

a XForwardedRemoteAddressResolver which extracts the last

resolve

public InetSocketAddress resolve(org.springframework.web.server.ServerWebExchange exchange)

The X-Forwarded-For header contains a comma separated list of IP addresses. This method parses those IP addresses into a list. If no X-Forwarded-For header is found, an empty list is returned. If multiple X-Forwarded-For headers are found, an empty list is returned out of caution.

指定者:

resolve 在接口中 RemoteAddressResolver

参数:

exchange - the exchange

返回:

The parsed values of the X-Forwarded-Header.