Commit inicial powerservice

This commit is contained in:
Gabriel
2026-10-19 12:45:45 -06:00
commit ad85486fe2
10158 changed files with 2736804 additions and 0 deletions
@@ -0,0 +1,2 @@
vendor/*
coverage/*
@@ -0,0 +1,34 @@
{
"name": "cloudflare/cf-ip-rewrite",
"description": "Library to rewrite CloudFlare IP Addresses to the end-user IP address",
"version": "1.0.4",
"homepage": "https://github.com/cloudflare/cf-ip-rewrite",
"keywords": [
"ip rewrite",
"cloudflare"
],
"authors": [
{
"name": "CloudFlare",
"homepage": "http://www.cloudflare.com/"
}
],
"license": "MIT",
"type": "library",
"scripts": {
"test": "vendor/bin/phpunit -c phpunit.xml.dist",
"format": "vendor/bin/phpcs -n --standard=PSR2 --extensions=php,live.php src/"
},
"require": {
"php": ">=5.3.0"
},
"autoload": {
"psr-0": {
"CloudFlare\\": "src/"
}
},
"require-dev": {
"phpunit/phpunit": "^4.8",
"squizlabs/php_codesniffer": "2.*"
}
}
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="./tests/bootstrap.php">
<testsuites>
<testsuite name="CloudFlare PHP IP Rewrite Test Suite">
<directory>./tests/</directory>
</testsuite>
</testsuites>
<filter>
<whitelist processUncoveredFilesFromWhitelist="true">
<directory>./src</directory>
</whitelist>
</filter>
</phpunit>
@@ -0,0 +1,63 @@
# Cloudflare PHP IP Rewriting
This module makes it easy for developers to add rewrite Cloudflare IP Addresses for actual end-user IP Addresses at the application layer. It is recommended to either install mod_cloudflare for Apache or use nginx rewrite rules (<https://support.cloudflare.com/hc/en-us/articles/200170706-Does-CloudFlare-have-an-IP-module-for-Nginx->) if possible.
For those cases, where the IP can not be guaranteed to be rewritten by one of these alternate means, this module can be used to rewrite the IP address.
### How it works
```php
$ipRewrite = new CloudFlare\IpRewrite();
$is_cf = $ipRewrite->isCloudFlare();
$rewritten_ip = $ipRewrite->getRewrittenIP();
$original_ip = $ipRewrite->getOriginalIP();
```
The class exposes three methods for interaction and a constructor.
Initializing `IpRewrite()` object will try to rewrite the IP. If the IP is rewritten, `$_SERVER["REMOTE_ADDR"]` will be updated to reflect the end-user's IP address.
`isCloudFlare();` returns `true` if the `CF_CONNECTING_IP` header is present in the request and the request originates from a Cloudflare IP.
`getRewrittenIP()` Returns the rewritten ip address if a rewrite occurs, otherwise it will return `null`.
`getOriginalIP()` returns the saved original ip address from `$_SERVER["REMOTE_ADDR"]`.
### Best Pratice
```php
// Initialize object to rewrite the headers
try {
$ipRewrite = new CloudFlare\IpRewrite();
} catch (RuntimeException $e) {
// PHP configurations does not support IPv6
}
// Check if the request is from Cloudflare
$is_cf = $ipRewrite->isCloudFlare();
if ($is_cf) {
// Get original or rewritten ip
// Order does not matter
...
$rewritten_ip = $ipRewrite->getRewrittenIP();
...
$original_ip = $ipRewrite->getOriginalIP();
...
}
```
#### Caution
Rewrite action is triggered only once in constructor. If `getRewrittenIP()` or `getOriginalIP()` is called multiple times it'll return the first result regardless if a change happened after the first call. Since rewrite action was not triggered.
To get the newest changes a new `IpRewrite` object should be used.
### Testing this module
This module comes with a set of tests that can be run using phpunit. To run the tests, run `composer install` on the package and then one of the following commands:
#### Basic Tests
composer test
#### With code coverage report in `coverage` folder
vendor/bin/phpunit -c phpunit.xml.dist --coverage-html coverage
@@ -0,0 +1,134 @@
<?php
namespace CloudFlare;
class IpRewrite
{
private $is_loaded = false;
private $original_ip = null;
private $rewritten_ip = null;
// Found at https://www.cloudflare.com/ips/
private $cf_ipv4 = array(
'173.245.48.0/20',
'103.21.244.0/22',
'103.22.200.0/22',
'103.31.4.0/22',
'141.101.64.0/18',
'108.162.192.0/18',
'190.93.240.0/20',
'188.114.96.0/20',
'197.234.240.0/22',
'198.41.128.0/17',
'162.158.0.0/15',
'104.16.0.0/12',
'172.64.0.0/13',
'131.0.72.0/22',
);
private $cf_ipv6 = array(
'2400:cb00::/32',
'2405:8100::/32',
'2405:b500::/32',
'2606:4700::/32',
'2803:f800::/32',
'2c0f:f248::/32',
'2a06:98c0::/29'
);
public function __construct()
{
$this->rewrite();
}
/**
* Is a request from CloudFlare?
* @return bool
*/
public function isCloudFlare()
{
if (!isset($_SERVER['HTTP_CF_CONNECTING_IP'])) {
return false;
} else {
// Check if original ip has already been restored, e.g. by nginx - assume it was from cloudflare then
if ($_SERVER['REMOTE_ADDR'] === $_SERVER['HTTP_CF_CONNECTING_IP']) {
return true;
}
}
return $this->isCloudFlareIP();
}
/**
* Check if a request comes from a CloudFlare IP.
* @return bool
*/
public function isCloudFlareIP()
{
// Store original remote address in $original_ip
$this->original_ip = $this->getOriginalIP();
if (!isset($this->original_ip)) {
return false;
}
// Process original_ip if on cloudflare
$ip_ranges = $this->cf_ipv4;
if (IpUtils::isIpv6($this->original_ip)) {
$ip_ranges = $this->cf_ipv6;
}
foreach ($ip_ranges as $range) {
if (IpUtils::checkIp($this->original_ip, $range)) {
return true;
}
}
return false;
}
/**
* Get the original IP Address of a given request.
* @return IP Address or null on error
*/
public function getOriginalIP()
{
// If $original_ip is not set, return the REMOTE_ADDR
if (!isset($this->original_ip)) {
$this->original_ip = $_SERVER['REMOTE_ADDR'];
}
return $this->original_ip;
}
/**
* Gets the re-written IP after rewrite() is run.
* @return IP Address or null on error
*/
public function getRewrittenIP()
{
return $this->rewritten_ip;
}
/**
* Handle the rewriting of CloudFlare IP Addresses to end-user IP Addresses.
* NOTE: This function will ultimately rewrite $_SERVER["REMOTE_ADDR"] if the site is on CloudFlare
* @return bool
* @
*/
public function rewrite()
{
// only should be run once per page load
if ($this->is_loaded) {
return false;
}
$this->is_loaded = true;
$is_cf = $this->isCloudFlare();
if (!$is_cf) {
return false;
}
$this->rewritten_ip = $_SERVER['REMOTE_ADDR'] = $_SERVER['HTTP_CF_CONNECTING_IP'];
return true;
}
}
@@ -0,0 +1,146 @@
<?php
namespace CloudFlare;
class IpUtils
{
/**
* This class should not be instantiated.
*/
private function __construct()
{
}
/**
* Checks if an IPv4 or IPv6 address is contained in the list of given IPs or subnets.
*
* @param string $requestIp IP to check
* @param string|array $ips List of IPs or subnets (can be a string if only a single one)
*
* @return bool Whether the IP is valid
*/
public static function checkIp($requestIp, $ips)
{
if (!is_array($ips)) {
$ips = array($ips);
}
foreach ($ips as $ip) {
if (self::isIpv4($requestIp) && self::checkIp4($requestIp, $ip) ||
(self::isIpv6($requestIp) && self::checkIp6($requestIp, $ip))) {
return true;
}
}
return false;
}
/**
* Checks if the ip is v4.
*
* @param string $ip IP to check
*
* @return bool return true if ipv4
*/
public static function isIpv4($requestIp)
{
if (substr_count($requestIp, ':') > 1) {
return false;
}
return true;
}
/**
* Checks if the ip is v6.
*
* @param string $ip IP to check
*
* @return bool return true if ipv6
*/
public static function isIpv6($ip)
{
return !self::isIpv4($ip);
}
/**
* Compares two IPv4 addresses.
* In case a subnet is given, it checks if it contains the request IP.
*
* @param string $requestIp IPv4 address to check
* @param string $ip IPv4 address or subnet in CIDR notation
*
* @return bool Whether the request IP matches the IP, or whether the request IP is within the CIDR subnet.
*/
public static function checkIp4($requestIp, $ip)
{
if (false !== strpos($ip, '/')) {
list($address, $netmask) = explode('/', $ip, 2);
if ($netmask === '0') {
// Ensure IP is valid - using ip2long below implicitly validates, but we need to do it manually here
return filter_var($address, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4);
}
if ($netmask < 0 || $netmask > 32) {
return false;
}
} else {
$address = $ip;
$netmask = 32;
}
return 0 === substr_compare(sprintf('%032b', ip2long($requestIp)), sprintf('%032b', ip2long($address)), 0, $netmask);
}
/**
* Compares two IPv6 addresses.
* In case a subnet is given, it checks if it contains the request IP.
*
* @author David Soria Parra <dsp at php dot net>
*
* @see https://github.com/dsp/v6tools
*
* @param string $requestIp IPv6 address to check
* @param string $ip IPv6 address or subnet in CIDR notation
*
* @return bool Whether the IP is valid
*
* @throws \RuntimeException When IPV6 support is not enabled
*/
public static function checkIp6($requestIp, $ip)
{
if (!((extension_loaded('sockets') && defined('AF_INET6')) || @inet_pton('::1'))) {
throw new \RuntimeException('Unable to check Ipv6. Check that PHP was not compiled with option "disable-ipv6".');
}
if (false !== strpos($ip, '/')) {
list($address, $netmask) = explode('/', $ip, 2);
if ($netmask < 1 || $netmask > 128) {
return false;
}
} else {
$address = $ip;
$netmask = 128;
}
$bytesAddr = unpack('n*', @inet_pton($address));
$bytesTest = unpack('n*', @inet_pton($requestIp));
if (!$bytesAddr || !$bytesTest) {
return false;
}
for ($i = 1, $ceil = ceil($netmask / 16); $i <= $ceil; ++$i) {
$left = $netmask - 16 * ($i - 1);
$left = ($left <= 16) ? $left : 16;
$mask = ~(0xffff >> $left) & 0xffff;
if (($bytesAddr[$i] & $mask) != ($bytesTest[$i] & $mask)) {
return false;
}
}
return true;
}
}
@@ -0,0 +1,42 @@
<?php
use CloudFlare\IpUtils;
class IpUtilsTest extends PHPUnit_Framework_TestCase
{
public function testIpv4()
{
$addr = '192.168.1.1';
$this->assertTrue(IpUtils::checkIp($addr, '192.168.1.1'));
$this->assertTrue(IpUtils::checkIp($addr, '192.168.1.1/1'));
$this->assertTrue(IpUtils::checkIp($addr, '192.168.1.0/24'));
$this->assertFalse(IpUtils::checkIp($addr, '1.2.3.4/1'));
$this->assertFalse(IpUtils::checkIp($addr, '192.168.1.1/33')); // invalid subnet
$this->assertTrue(IpUtils::checkIp($addr, array('1.2.3.4/1', '192.168.1.0/24')));
$this->assertTrue(IpUtils::checkIp($addr, array('192.168.1.0/24', '1.2.3.4/1')));
$this->assertFalse(IpUtils::checkIp($addr, array('1.2.3.4/1', '4.3.2.1/1')));
$this->assertTrue(IpUtils::checkIp($addr, '0.0.0.0/0'));
$this->assertTrue(IpUtils::checkIp($addr, '192.168.1.0/0'));
$this->assertFalse(IpUtils::checkIp($addr, '256.256.256/0')); // invalid CIDR notation
}
public function testIpv6()
{
if (!defined('AF_INET6')) {
$this->markTestSkipped('Only works when PHP is compiled without the option "disable-ipv6".');
}
$this->assertTrue(IpUtils::checkIp('2a01:198:603:0:396e:4789:8e99:890f', '2a01:198:603:0::/65'));
$this->assertFalse(IpUtils::checkIp('2a00:198:603:0:396e:4789:8e99:890f', '2a01:198:603:0::/65'));
$this->assertFalse(IpUtils::checkIp('2a01:198:603:0:396e:4789:8e99:890f', '::1'));
$this->assertTrue(IpUtils::checkIp('2a01:198:603:0:396e:4789:8e99:890f', array('::1', '2a01:198:603:0::/65')));
$this->assertTrue(IpUtils::checkIp('2a01:198:603:0:396e:4789:8e99:890f', array('2a01:198:603:0::/65', '::1')));
$this->assertFalse(IpUtils::checkIp('2a01:198:603:0:396e:4789:8e99:890f', array('::1', '1a01:198:603:0::/65')));
$this->assertFalse(IpUtils::checkIp('2a01:198:603:0:396e:4789:8e99:890f', 'unknown'));
$this->assertTrue(IpUtils::checkIp('0:0:0:0:0:0:0:1', '::1'));
$this->assertFalse(IpUtils::checkIp('0:0:603:0:396e:4789:8e99:0001', '::1'));
$this->assertFalse(IpUtils::checkIp('}__test|O:21:&quot;JDatabaseDriverMysqli&quot;:3:{s:2', '::1'));
IpUtils::checkIp('2a01:198:603:0:396e:4789:8e99:890f', '2a01:198:603:0::/65');
}
}
@@ -0,0 +1,147 @@
<?php
use CloudFlare\IpRewrite;
class RewriteTest extends \PHPUnit_Framework_TestCase
{
private $ipRewrite = null;
public function tearDown()
{
unset($_SERVER['HTTP_CF_CONNECTING_IP']);
unset($_SERVER['REMOTE_ADDR']);
}
public function testOnCloudFlareIPv4()
{
$remote_addr = '103.21.244.2';
$connecting_ip = '8.8.8.8';
$_SERVER['REMOTE_ADDR'] = $remote_addr;
$_SERVER['HTTP_CF_CONNECTING_IP'] = $connecting_ip;
$this->ipRewrite = new IpRewrite();
$this->assertTrue($this->ipRewrite->isCloudFlare());
$this->assertTrue($this->ipRewrite->isCloudFlareIP());
$this->assertEquals($this->ipRewrite->getRewrittenIP(), $connecting_ip);
$this->assertEquals($this->ipRewrite->getOriginalIP(), $remote_addr);
}
public function testRequestFromCloudFlareNoConnectingIPHeader()
{
$remote_addr = '103.21.244.2';
$_SERVER['REMOTE_ADDR'] = $remote_addr;
$this->ipRewrite = new IpRewrite();
$this->assertFalse($this->ipRewrite->isCloudFlare());
$this->assertTrue($this->ipRewrite->isCloudFlareIP());
$this->assertNull($this->ipRewrite->getRewrittenIP());
$this->assertEquals($this->ipRewrite->getOriginalIP(), $remote_addr);
}
public function testOffCloudFlareIPv4()
{
$remote_addr = '8.8.8.8';
$_SERVER['REMOTE_ADDR'] = $remote_addr;
$this->ipRewrite = new IpRewrite();
$this->assertFalse($this->ipRewrite->isCloudFlare());
$this->assertFalse($this->ipRewrite->isCloudFlareIP());
$this->assertNull($this->ipRewrite->getRewrittenIP());
$this->assertEquals($this->ipRewrite->getOriginalIP(), $remote_addr);
}
public function testOffCloudFlareIPv4FakeModCloudflare()
{
$remote_addr = '8.8.8.8';
$connecting_ip = '8.8.4.4';
$_SERVER['REMOTE_ADDR'] = $remote_addr;
$_SERVER['HTTP_CF_CONNECTING_IP'] = $connecting_ip;
$this->ipRewrite = new IpRewrite();
$this->assertFalse($this->ipRewrite->isCloudFlare());
$this->assertFalse($this->ipRewrite->isCloudFlareIP());
$this->assertNull($this->ipRewrite->getRewrittenIP());
$this->assertEquals($this->ipRewrite->getOriginalIP(), $remote_addr);
}
public function testOnlyProcessOnce()
{
$remote_addr = '108.162.192.2';
$connecting_ip = '8.8.8.8';
$_SERVER['REMOTE_ADDR'] = $remote_addr;
$_SERVER['HTTP_CF_CONNECTING_IP'] = $connecting_ip;
$this->ipRewrite = new IpRewrite();
$this->assertTrue($this->ipRewrite->isCloudFlare());
$this->assertTrue($this->ipRewrite->isCloudFlareIP());
$this->assertEquals($this->ipRewrite->getRewrittenIP(), $connecting_ip);
$this->assertEquals($this->ipRewrite->getOriginalIP(), $remote_addr);
// swap values and expect the original still, since it only allows one run per load
$remote_addr2 = '103.21.244.2';
$connecting_ip2 = '8.8.4.4';
$_SERVER['REMOTE_ADDR'] = $remote_addr2;
$_SERVER['HTTP_CF_CONNECTING_IP'] = $connecting_ip2;
$this->assertTrue($this->ipRewrite->isCloudFlare());
$this->assertEquals($this->ipRewrite->getRewrittenIP(), $connecting_ip);
$this->assertEquals($this->ipRewrite->getOriginalIP(), $remote_addr);
}
public function testOnCloudFlareIPv6()
{
$remote_addr = '2803:f800::23';
$connecting_ip = '2001:4860:4860::8888';
$_SERVER['REMOTE_ADDR'] = $remote_addr;
$_SERVER['HTTP_CF_CONNECTING_IP'] = $connecting_ip;
$this->ipRewrite = new IpRewrite();
$this->assertTrue($this->ipRewrite->isCloudFlare());
$this->assertTrue($this->ipRewrite->isCloudFlareIP());
$this->assertEquals($this->ipRewrite->getRewrittenIP(), $connecting_ip);
$this->assertEquals($this->ipRewrite->getOriginalIP(), $remote_addr);
}
public function testOffCloudFlareIPv6()
{
$remote_addr = '2001:4860:4860::8888';
$_SERVER['REMOTE_ADDR'] = $remote_addr;
$this->ipRewrite = new IpRewrite();
$this->assertFalse($this->ipRewrite->isCloudFlare());
$this->assertFalse($this->ipRewrite->isCloudFlare());
$this->assertNull($this->ipRewrite->getRewrittenIP());
$this->assertEquals($this->ipRewrite->getOriginalIP(), $remote_addr);
}
public function testRequestFromCloudflareNginxRealIp()
{
$connecting_ip = '8.8.8.8';
// REMOTE_ADDR already rewritten by Nginx
$_SERVER['REMOTE_ADDR'] = $connecting_ip;
$_SERVER['HTTP_CF_CONNECTING_IP'] = $connecting_ip;
$this->ipRewrite = new IpRewrite();
$this->assertTrue($this->ipRewrite->isCloudFlare());
$this->assertEquals($this->ipRewrite->getRewrittenIP(), $connecting_ip);
$this->assertEquals($this->ipRewrite->getOriginalIP(), $connecting_ip);
}
}
@@ -0,0 +1,3 @@
<?php
require __DIR__.'/../vendor/autoload.php';