TrustedProxyMiddleware
class TrustedProxyMiddleware implements HTTPMiddleware (View source)
This middleware will rewrite headers that provide IP and host details from an upstream proxy.
Methods
Return the comma-separated list of IP ranges that are trusted to provide proxy headers Can also be 'none' or '*' (all)
Set the comma-separated list of IP ranges that are trusted to provide proxy headers Can also be 'none' or '*' (all)
Set the array of headers from which to lookup the hostname.
Set the array of headers from which to lookup the client IP.
Return the array of headers from which to lookup the client scheme (http/https)
Set array of headers from which to lookup the client scheme (http/https) Can also specify comma-separated list as a single string.
Determine if the current request is coming from a trusted proxy
Extract an IP address from a header value that has been obtained.
Details
        
                            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
        
                    protected        bool
    isTrustedProxy(HTTPRequest $request)
        
    
    Determine if the current request is coming from a trusted proxy
        
                    protected        string
    getIPFromHeaderValue(string $headerValue)
        
    
    Extract an IP address from a header value that has been obtained.
Accepts single IP or comma separated string of IPs