程序包 cn.taketoday.web.util

类 ForwardedHeaderUtils

java.lang.Object

cn.taketoday.web.util.ForwardedHeaderUtils

public abstract class ForwardedHeaderUtils
extends Object

Utility class to assist with processing "Forwarded" and "X-Forwarded-*" headers.

Note: There are security considerations surrounding the use of forwarded headers. Those should not be used unless the application is behind a trusted proxy that inserts them and also explicitly removes any such headers coming from an external source.

In most cases, you should not use this class directly but rather rely on ForwardedHeaderFilter for Web MVC or ForwardedHeaderTransformer in order to extract the information from the headers as early as possible and discard such headers. Underlying servers such as Tomcat, Jetty, and Reactor Netty also provide options to handle forwarded headers even earlier.

从以下版本开始:

4.0

作者:

Rossen Stoyanchev, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private static final Pattern	FORWARDED_FOR_PATTERN
private static final Pattern	FORWARDED_HOST_PATTERN
private static final Pattern	FORWARDED_PROTO_PATTERN
private static final String	FORWARDED_VALUE

构造器概要

构造器

构造器	说明
ForwardedHeaderUtils()

方法概要

修饰符和类型	方法	说明
private static void	adaptForwardedHost(UriComponentsBuilder uriComponentsBuilder, String rawValue)
static UriComponentsBuilder	adaptFromForwardedHeaders(URI uri, HttpHeaders headers)	Adapt the scheme+host+port of the given URI from the "Forwarded" header (see RFC 7239) or from the "X-Forwarded-Host", "X-Forwarded-Port", and "X-Forwarded-Proto" headers if "Forwarded" is not present.
private static boolean	isForwardedSslOn(HttpHeaders headers)
static InetSocketAddress	parseForwardedFor(URI uri, HttpHeaders headers, InetSocketAddress remoteAddress)	Parse the first "Forwarded: for=..." or "X-Forwarded-For" header value to an InetSocketAddress representing the address of the client.

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

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

字段详细资料

FORWARDED_VALUE

private static final String FORWARDED_VALUE

另请参阅:

• 常量字段值

FORWARDED_HOST_PATTERN

private static final Pattern FORWARDED_HOST_PATTERN

FORWARDED_PROTO_PATTERN

private static final Pattern FORWARDED_PROTO_PATTERN

FORWARDED_FOR_PATTERN

private static final Pattern FORWARDED_FOR_PATTERN

构造器详细资料

ForwardedHeaderUtils

public ForwardedHeaderUtils()

方法详细资料

adaptFromForwardedHeaders

public static UriComponentsBuilder adaptFromForwardedHeaders(URI uri,
 HttpHeaders headers)

Adapt the scheme+host+port of the given URI from the "Forwarded" header (see RFC 7239) or from the "X-Forwarded-Host", "X-Forwarded-Port", and "X-Forwarded-Proto" headers if "Forwarded" is not present.

参数:

uri - the request URI

headers - the HTTP headers to consider

返回:

a UriComponentsBuilder that reflects the request URI and additional updates from forwarded headers

isForwardedSslOn

private static boolean isForwardedSslOn(HttpHeaders headers)

adaptForwardedHost

private static void adaptForwardedHost(UriComponentsBuilder uriComponentsBuilder,
 String rawValue)

parseForwardedFor

@Nullable
public static InetSocketAddress parseForwardedFor(URI uri,
 HttpHeaders headers,
 @Nullable
 InetSocketAddress remoteAddress)

Parse the first "Forwarded: for=..." or "X-Forwarded-For" header value to an InetSocketAddress representing the address of the client.

参数:

uri - the request URI

headers - the request headers that may contain forwarded headers

remoteAddress - the current remote address

返回:

an InetSocketAddress with the extracted host and port, or null if the headers are not present

另请参阅:

• RFC 7239, Section 5.2