1. class
  2. Illuminate
  3. \
  4. Http
  5. \
  6. Middleware
  7. \
  8. TrustProxies

TrustProxies

class TrustProxies (View source)

Properties

protected array<int,string>|string|null $proxies

The trusted proxies for the application.
protected int $headers

The trusted proxies headers for the application.
static protected array<int,string>|string|null $alwaysTrustProxies

The proxies that have been configured to always be trusted.
static protected int|null $alwaysTrustHeaders

The proxies headers that have been configured to always be trusted.

Methods

mixed
handle(Request $request, Closure $next)

Handle an incoming request.

void
setTrustedProxyIpAddresses(Request $request)

Sets the trusted proxies on the request.

void
setTrustedProxyIpAddressesToSpecificIps(Request $request, array $trustedIps)

Specify the IP addresses to trust explicitly.

void
setTrustedProxyIpAddressesToTheCallingIp(Request $request)

Set the trusted proxy to be the IP address calling this servers.

int
getTrustedHeaderNames()

Retrieve trusted header name(s), falling back to defaults if config not set.

int
headers()

Get the trusted headers.

array|string|null
proxies()

Get the trusted proxies.

static void
at(array|string $proxies)

Specify the IP addresses of proxies that should always be trusted.

static void
withHeaders(int $headers)

Specify the proxy headers that should always be trusted.

static void
flushState()

Flush the state of the middleware.

Details

at line 52
mixed handle(Request $request, Closure $next)

Handle an incoming request.

Parameters

Request $request
Closure $next

Return Value

mixed

Exceptions

HttpException

at line 67
protected void setTrustedProxyIpAddresses(Request $request)

Sets the trusted proxies on the request.

Parameters

Request $request

Return Value

void

at line 95
protected void setTrustedProxyIpAddressesToSpecificIps(Request $request, array $trustedIps)

Specify the IP addresses to trust explicitly.

Parameters

Request $request
array $trustedIps

Return Value

void

at line 112
protected void setTrustedProxyIpAddressesToTheCallingIp(Request $request)

Set the trusted proxy to be the IP address calling this servers.

Parameters

Request $request

Return Value

void

at line 122
protected int getTrustedHeaderNames()

Retrieve trusted header name(s), falling back to defaults if config not set.

Return Value

int

A bit field of Request::HEADER_*, to set which headers to trust from your proxies.

at line 147
protected int headers()

Get the trusted headers.

Return Value

int

at line 157
protected array|string|null proxies()

Get the trusted proxies.

Return Value

array|string|null

at line 168
static void at(array|string $proxies)

Specify the IP addresses of proxies that should always be trusted.

Parameters

array|string $proxies

Return Value

void

at line 179
static void withHeaders(int $headers)

Specify the proxy headers that should always be trusted.

Parameters

int $headers

Return Value

void

at line 189
static void flushState()

Flush the state of the middleware.

Return Value

void