EspoCRM – Open Source CRM Application
PHP calendarcontactscrmcrm-platformcrm-systemcustomer-portalcustomer-supportcustomizabledocumentsemail-marketingkanbanleadsopen-sourcephpplatformsales-automationsingle-page-applicationsupport
More IP address checks
Yuriida1eea262a62
diff --git a/application/Espo/Core/Utils/Security/HostCheck.php b/application/Espo/Core/Utils/Security/HostCheck.phpindex 427ce8c531..a4130b8577 100644--- a/application/Espo/Core/Utils/Security/HostCheck.php+++ b/application/Espo/Core/Utils/Security/HostCheck.php@@ -30,14 +30,48 @@namespace Espo\Core\Utils\Security;use const DNS_A;+use const DNS_AAAA;use const FILTER_FLAG_NO_PRIV_RANGE;use const FILTER_FLAG_NO_RES_RANGE;+use const FILTER_FLAG_GLOBAL_RANGE;use const FILTER_FLAG_HOSTNAME;use const FILTER_VALIDATE_DOMAIN;use const FILTER_VALIDATE_IP;class HostCheck{+ /** @var string[] */+ private const array BLOCKED_IPV4_RANGES = [+ '0.0.0.0/8', // "This network"+ '10.0.0.0/8', // Private+ '100.64.0.0/10', // Shared address space, CGNAT (RFC 6598)+ '127.0.0.0/8', // Loopback+ '169.254.0.0/16', // Link-local, cloud metadata+ '172.16.0.0/12', // Private+ '192.0.0.0/24', // IETF protocol assignments+ '192.0.2.0/24', // Documentation (TEST-NET-1)+ '192.88.99.0/24', // 6to4 relay anycast (deprecated)+ '192.168.0.0/16', // Private+ '198.18.0.0/15', // Benchmarking+ '198.51.100.0/24', // Documentation (TEST-NET-2)+ '203.0.113.0/24', // Documentation (TEST-NET-3)+ '224.0.0.0/4', // Multicast+ '240.0.0.0/4', // Reserved, limited broadcast+ ];++ /** @var string[] */+ private const array ALLOWED_IPV6_RANGES = [+ '2000::/3', // Global unicast+ ];++ /** @var string[] */+ private const array BLOCKED_IPV6_RANGES = [+ '2001::/23', // IETF protocol assignments+ '2001:db8::/32', // Documentation+ '2002::/16', // 6to4 (only reached if unwrapping failed)+ '3fff::/20', // Documentation (RFC 9637)+ ];+/*** Validates the string is a host and it's not internal.* If not a host, returns false.@@ -141,27 +175,34 @@ class HostCheck$ipAddress = substr($ipAddress, 7);}- if (filter_var($ipAddress, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {- $packed = inet_pton($ipAddress);+ $packed = $this->toPackedUnwrapped($ipAddress);++ if ($packed !== null) {+ if (strlen($packed) === 4) {+ if (self::matchesAnyRange($packed, self::BLOCKED_IPV4_RANGES)) {+ return false;+ }+ } else {+ if (!self::matchesAnyRange($packed, self::ALLOWED_IPV6_RANGES)) {+ return false;+ }- if ($packed !== false && strlen($packed) === 16) {- if (str_starts_with($packed, "\x00\x64\xff\x9b\x00\x00\x00\x00\x00\x00\x00\x00")) {- // NAT64 64:ff9b::/96- $ipAddress = inet_ntop(substr($packed, 12, 4));- } else if ($packed[0] === "\x20" && $packed[1] === "\x02") {- // 6to4 2002::/16- $ipAddress = inet_ntop(substr($packed, 2, 4));- } else if (str_starts_with($packed, "\x20\x01\x00\x00")) {- // Teredo 2001:0000::/32- $ipAddress = inet_ntop(substr($packed, 12, 4) ^ "\xff\xff\xff\xff");+ if (self::matchesAnyRange($packed, self::BLOCKED_IPV6_RANGES)) {+ return false;}}++ $ipAddress = inet_ntop($packed);++ if ($ipAddress === false) {+ return false;+ }}return (bool) filter_var($ipAddress,FILTER_VALIDATE_IP,- FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE+ FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE | FILTER_FLAG_GLOBAL_RANGE);}@@ -185,7 +226,7 @@ class HostCheck} else if (preg_match('/^0[0-7]+$/', $part) && $part !== '0') {$num = octdec($part);} else if (ctype_digit($part)) {- $num = (int)$part;+ $num = (int) $part;} else {return false;}@@ -241,4 +282,93 @@ class HostCheck{return preg_match('/^0x[0-9a-fA-F]+$/', $value) === 1;}++ /**+ * Returns the binary address (4 or 16 bytes). IPv6 addresses that embed an IPv4+ * address the packet will actually be delivered to are unwrapped to that IPv4 address.+ */+ private function toPackedUnwrapped(string $ipAddress): ?string+ {+ if (!filter_var($ipAddress, FILTER_VALIDATE_IP)) {+ return null;+ }++ $packed = inet_pton($ipAddress);++ if ($packed === false) {+ return null;+ }++ if (strlen($packed) === 4) {+ return $packed;+ }++ if (strlen($packed) !== 16) {+ return null;+ }++ // IPv4-mapped ::ffff:0:0/96, in any notation.+ if (str_starts_with($packed, "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xff")) {+ return substr($packed, 12, 4);+ }++ // NAT64 64:ff9b::/96+ if (str_starts_with($packed, "\x00\x64\xff\x9b\x00\x00\x00\x00\x00\x00\x00\x00")) {+ return substr($packed, 12, 4);+ }++ // 6to4 2002::/16+ if (str_starts_with($packed, "\x20\x02")) {+ return substr($packed, 2, 4);+ }++ // Teredo 2001:0000::/32+ if (str_starts_with($packed, "\x20\x01\x00\x00")) {+ return substr($packed, 12, 4) ^ "\xff\xff\xff\xff";+ }++ return $packed;+ }++ /**+ * @param string[] $ranges CIDR ranges of the same family as the address.+ */+ private static function matchesAnyRange(string $packed, array $ranges): bool+ {+ foreach ($ranges as $range) {+ if (self::isInRange($packed, $range)) {+ return true;+ }+ }++ return false;+ }++ private static function isInRange(string $packed, string $cidr): bool+ {+ [$network, $bits] = explode('/', $cidr, 2);++ $networkPacked = inet_pton($network);++ if ($networkPacked === false || strlen($networkPacked) !== strlen($packed)) {+ return false;+ }++ $bits = (int) $bits;+ $fullBytes = intdiv($bits, 8);++ if (substr($packed, 0, $fullBytes) !== substr($networkPacked, 0, $fullBytes)) {+ return false;+ }++ $remainingBits = $bits % 8;++ if ($remainingBits === 0) {+ return true;+ }++ $mask = (0xff << (8 - $remainingBits)) & 0xff;++ return (ord($packed[$fullBytes]) & $mask) === (ord($networkPacked[$fullBytes]) & $mask);+ }}diff --git a/tests/unit/Espo/Core/Utils/Security/HostCheckTest.php b/tests/unit/Espo/Core/Utils/Security/HostCheckTest.phpindex 45aa16350f..5f58fe529c 100644--- a/tests/unit/Espo/Core/Utils/Security/HostCheckTest.php+++ b/tests/unit/Espo/Core/Utils/Security/HostCheckTest.php@@ -90,6 +90,47 @@ class HostCheckTest extends TestCase['fe80::1', false],['fc00::1', false],['::1', false],++ ['::', false],+ // Carrier-grade NAT, incl. Alibaba Cloud metadata.+ ['100.100.100.200', false],+ ['100.64.0.1', false],+ ['100.127.255.255', false],+ ['100.63.255.255', true],+ ['100.128.0.1', true],+ // Other special-purpose IPv4.+ ['192.0.0.192', false],+ ['192.0.2.1', false],+ ['198.18.0.1', false],+ ['198.19.255.255', false],+ ['198.51.100.1', false],+ ['203.0.113.1', false],+ ['224.0.0.1', false],+ ['239.255.255.250', false],+ ['255.255.255.255', false],+ ['169.254.169.254', false],+ ['8.8.8.8', true],+ // IPv4 embedded in IPv6.+ ['::ffff:100.100.100.200', false],+ ['::FFFF:100.100.100.200', false],+ ['0:0:0:0:0:ffff:6464:64c8', false],+ ['::ffff:8.8.8.8', true],+ ['64:ff9b::6464:64c8', false],+ ['2002:6464:64c8::', false],+ ['2001:0000:4136:e378:8000:0000:9b9b:9b37', false],+ ['::100.100.100.200', false],+ ['64:ff9b:1::a00:1', false],+ // Non-global IPv6.+ ['fd00:ec2::254', false],+ ['fec0::1', false],+ ['ff02::1', false],+ ['ff0e::1', false],+ ['100::1', false],+ ['2001:db8::1', false],+ ['3fff::1', false],+ // Malformed.+ ['fe80::1%eth0', false],+ ['not-an-ip', false],];}