yidas/client-ip

Get client IP with safe and coincident way from server even behind Proxy or Load-Balancer

Maintainers

Details

github.com/yidas/php-client-ip

Homepage

Source

Issues

Installs: 73 705

Dependents: 0

Suggesters: 0

Security: 0

Stars: 23

Watchers: 2

Forks: 10

Open Issues: 0

Type:project

1.0.0 2017-09-05 09:23 UTC

BSD-3-Clause 2986db258265173b69796616fa1d9a7363df0d29

IPreal ipclient ipproxy iploadbalancer ip

This package is auto-updated.

Last update: 2024-10-14 19:41:06 UTC

README

Get client IP with safe and coincident way from server even behind Proxy or Load-Balancer.

Latest Stable Version License Total Downloads Monthly Downloads

Real IP implement on Web application, which solve the problem that the server receiving requests through trust proxies or load-balancers without Transparent-Mode.

DEMONSTRATION

echo ClientIP::get();
ClientIP::config([
    'proxyIPs' => ['192.168.0.0/16', '172.217.3.11'],
    'headerKeys' => ['HTTP_X_FORWARDED_FOR']
    ]);
echo ClientIP::get();

If the client IP is 203.169.1.37, there are some connection situation for demonstrating referring by above sample code:

Load-Balancer normal network

your server is behind a Load-Balencer and in a private network.

ClientIP::config([
    'proxyIPs' => true
    ]);

Setting proxyIPs as true means all requests are go through Load-balancer, which will always get forward IP, same as above setting:

ClientIP::config([
    'proxyIPs' => ['0.0.0.0/32']
    ]);

The result from the server:

192.168.0.10 //Before setting the config
203.169.1.37 //After setting the config, get the forward IP

Proxy optional network

If your server is in public network, not only receives requests directly, but also supports trust proxies for going through:

ClientIP::config([
    'proxyIPs' => ['172.217.3.11']
    ]);

The result from the server

  • Way 1: Client connect to server directly:
203.169.1.37 //Before setting the config
203.169.1.37 //The request IP is not from proxyIPs, so identify as a Client.
  • Way 2: Client connect to server through Proxy:
172.217.3.11 //Before setting the config
203.169.1.37 //The request IP comes from proxyIPs, get the forward IP.

INSTALLATION

Run Composer in your project:

composer require yidas/client-ip

Then initialize it at the bootstrap of application such as config file:

require __DIR__ . '/vendor/autoload.php';
ClientIP::config([
   'proxyIPs' => ['192.168.0.0/16']
   ]);

CONFIGURATION

Example configuration:

ClientIP::config([
   'proxyIPs' => ['192.168.0.0/16', '172.217.2.89'],
   'headerKeys' => ['HTTP_X_FORWARDED_FOR'],
   ]);

DISCUSSION

Implement from Web Server

The another way to fetch real IP is implemnet from the Web server side: