akrabat/ip-address-middleware

PSR-15 middleware that determines the client IP address and stores it as a ServerRequest attribute

Client IP address middleware

PSR-15 Middleware that determines the client IP address and stores it as an ServerRequest attribute called ip_address. It optionally checks various common proxy headers and then falls back to $_SERVER['REMOTE_ADDR']., _(*1)

![Build status][Master image], _(*2)

Configuration

The constructor takes 4 parameters which can be used to configure this middleware., _(*3)

Check proxy headers, _(*4)

Note that the proxy headers are only checked if the first parameter to the constructor is set to true. If it is set to false, then only $_SERVER['REMOTE_ADDR'] is used., _(*5)

Trusted Proxies, _(*6)

If you configure to check the proxy headers (first parameter is true), you have to provide an array of trusted proxies as the second parameter. When the array is empty, the proxy headers will always be evaluated which is not recommended. If the array is not empty, it must contain strings with IP addresses (wildcard * is allowed in any given part) or networks in CIDR-notation. One of them must match the $_SERVER['REMOTE_ADDR'] variable in order to allow evaluating the proxy headers - otherwise the REMOTE_ADDR itself is returned., _(*7)

Attribute name, _(*8)

By default, the name of the attribute is 'ip_address'. This can be changed by the third constructor parameter., _(*9)

Headers to inspect, _(*10)

By default, this middleware checks the 'Forwarded', 'X-Forwarded-For', 'X-Forwarded', 'X-Cluster-Client-Ip' and 'Client-Ip' headers. You can replace this list with your own using the fourth constructor parameter., _(*11)

If you use the nginx, set_real_ip_from directive, then you should probably set this to:, _(*12)

$headersToInspect = [
    'X-Real-IP',
    'Forwarded',
    'X-Forwarded-For',
    'X-Forwarded',
    'X-Cluster-Client-Ip',
    'Client-Ip',
];

If you use CloudFlare, then according to the documentation you should probably set this to:, _(*13)

$headersToInspect = [
    'CF-Connecting-IP',
    'True-Client-IP',
    'Forwarded',
    'X-Forwarded-For',
    'X-Forwarded',
    'X-Cluster-Client-Ip',
    'Client-Ip',
];

Security considerations

A malicious client may send any header to your proxy, including any proxy headers, containing any IP address. If your proxy simply adds another IP address to the header, an attacker can send a fake IP. Make sure to setup your proxy in a way that removes any sent (and possibly faked) headers from the original request and replaces them with correct values (i.e. the currently used REMOTE_ADDR on the proxy server)., _(*14)

This library cannot by design ensure you get correct and trustworthy results if your network environment isn't setup properly., _(*15)

Installation

composer require akrabat/ip-address-middleware, _(*16)

In Mezzio, copy Mezzio/config/ip_address.global.php.dist into your Mezzio Application config/autoload directory as ip_address.global.php, _(*17)

Usage

In Slim 3:, _(*18)

$checkProxyHeaders = true; // Note: Never trust the IP address for security processes!
$trustedProxies = ['10.0.0.1', '10.0.0.2']; // Note: Never trust the IP address for security processes!
$app->add(new RKA\Middleware\IpAddress($checkProxyHeaders, $trustedProxies));

$app->get('/', function ($request, $response, $args) {
    $ipAddress = $request->getAttribute('ip_address');

    return $response;
});

In Laminas or Mezzio, add to your pipeline.php config at the correct stage, usually just before the DispatchMiddleware:, _(*19)

# config/pipeline.php
# using default config
$app->add(RKA\Middleware\IpAddress::class);

If required, update your .env file with the environmental variables found in /config/autoload/ip_address.global.php., _(*20)

Testing

• Code style: $ vendor/bin/phpcs
• Unit tests: $ vendor/bin/phpunit
• Code coverage: $ vendor/bin/phpunit --coverage-html ./build