middlewares/client-ip

Middleware to detect the client ip and save it as a request attribute.

Requirements

• PHP >= 7.0
• A PSR-7 http message implementation (Diactoros, Guzzle, Slim, etc...)
• A PSR-15 middleware dispatcher

Installation

This package is installable and autoloadable via Composer as middlewares/client-ip.

composer require middlewares/client-ip

Example

$dispatcher = new Dispatcher([
	new Middlewares\ClientIp(),

    function ($request) {
        //Get the client ip
        $ip = $request->getAttribute('client-ip');
    }
]);

$response = $dispatcher->dispatch(new ServerRequest());

Options

proxy(array $ips = [], array $headers = [])

Configure the detection through proxies. The first argument is an array of ips of the trusted proxies. If it's empty, no ip filtering is made. The second argument is a list of the headers to inspect. If it's not defined, uses the default value ['Forwarded', 'Forwarded-For', 'Client-Ip', 'X-Forwarded', 'X-Forwarded-For', 'X-Cluster-Client-Ip']. Disabled by default.

//Use proxies
$middleware = (new Middlewares\ClientIp())->proxy();

//Trust only some proxies by ip
$middleware = (new Middlewares\ClientIp())->proxy(['10.10.10.10', '10.10.10.11']);

//Trust only some proxies by ip using a specific header
$middleware = (new Middlewares\ClientIp())->proxy(['10.10.10.10', '10.10.10.11'], ['X-Forwarded-For']);

remote($remote = true)

Used to get the ip from localhost environment using http://ipecho.net/plain. Disabled by default.

attribute(string $attribute)

The attribute name used to store the ip in the server request. By default is client-ip.

---

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.

The MIT License (MIT). Please see LICENSE for more information.