1. class
  2. SilverStripe
  3. \
  4. Control
  5. \
  6. Middleware
  7. \
  8. TrustedProxyMiddleware

TrustedProxyMiddleware

class TrustedProxyMiddleware implements HTTPMiddleware

This middleware will rewrite headers that provide IP and host details from an upstream proxy.

Methods

string
getTrustedProxyIPs()

Return the comma-separated list of IP ranges that are trusted to provide proxy headers Can also be 'none' or '*' (all)

$this
setTrustedProxyIPs(string $trustedProxyIPs)

Set the comma-separated list of IP ranges that are trusted to provide proxy headers Can also be 'none' or '*' (all)

array
getProxyHostHeaders()

Return the array of headers from which to lookup the hostname

$this
setProxyHostHeaders(array $proxyHostHeaders)

Set the array of headers from which to lookup the hostname.

array
getProxyIPHeaders()

Return the array of headers from which to lookup the client IP

$this
setProxyIPHeaders(array $proxyIPHeaders)

Set the array of headers from which to lookup the client IP.

array
getProxySchemeHeaders()

Return the array of headers from which to lookup the client scheme (http/https)

$this
setProxySchemeHeaders(array $proxySchemeHeaders)

Set array of headers from which to lookup the client scheme (http/https) Can also specify comma-separated list as a single string.

HTTPResponse
process(HTTPRequest $request, callable $delegate)

Generate response for the given request

Details

at line 56
string getTrustedProxyIPs()

Return the comma-separated list of IP ranges that are trusted to provide proxy headers Can also be 'none' or '*' (all)

Return Value

string

at line 68
$this setTrustedProxyIPs(string $trustedProxyIPs)

Set the comma-separated list of IP ranges that are trusted to provide proxy headers Can also be 'none' or '*' (all)

Parameters

string $trustedProxyIPs

Return Value

$this

at line 79
array getProxyHostHeaders()

Return the array of headers from which to lookup the hostname

Return Value

array

at line 90
$this setProxyHostHeaders(array $proxyHostHeaders)

Set the array of headers from which to lookup the hostname.

Parameters

array $proxyHostHeaders

Return Value

$this

at line 101
array getProxyIPHeaders()

Return the array of headers from which to lookup the client IP

Return Value

array

at line 112
$this setProxyIPHeaders(array $proxyIPHeaders)

Set the array of headers from which to lookup the client IP.

Parameters

array $proxyIPHeaders

Return Value

$this

at line 123
array getProxySchemeHeaders()

Return the array of headers from which to lookup the client scheme (http/https)

Return Value

array

at line 135
$this setProxySchemeHeaders(array $proxySchemeHeaders)

Set array of headers from which to lookup the client scheme (http/https) Can also specify comma-separated list as a single string.

Parameters

array $proxySchemeHeaders

Return Value

$this

at line 141
HTTPResponse process(HTTPRequest $request, callable $delegate)

Generate response for the given request

Parameters

HTTPRequest $request
callable $delegate

Return Value

HTTPResponse