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

mixed handle(Request $request, Closure $next)

Handle an incoming request.

Parameters

Request	$request
Closure	$next

Return Value

mixed

Exceptions

HttpException

protected void setTrustedProxyIpAddresses(Request $request)

Sets the trusted proxies on the request.

Parameters

Request

$request

Return Value

void

protected void setTrustedProxyIpAddressesToSpecificIps(Request $request, array $trustedIps)

Specify the IP addresses to trust explicitly.

Parameters

Request	$request
array	$trustedIps

Return Value

void

protected void setTrustedProxyIpAddressesToTheCallingIp(Request $request)

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

Parameters

Request

$request

Return Value

void

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.

protected int headers()

Get the trusted headers.

Return Value

int

protected array|string|null proxies()

Get the trusted proxies.

Return Value

array|string|null

static void at(array|string $proxies)

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

Parameters

array|string

$proxies

Return Value

void

static void withHeaders(int $headers)

Specify the proxy headers that should always be trusted.

Parameters

int

$headers

Return Value

void

static void flushState()

Flush the state of the middleware.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Http/Middleware/TrustProxies.html