Merge pull request #7 from SamuelMwangiW/ip-utils

Add IP Address checks

src/DTO/IPAddress.php

@@ -4,11 +4,58 @@
 
 namespace SamuelMwangiW\Linode\DTO;
 
+use SamuelMwangiW\Linode\Support\IpUtils;
+
 class IPAddress
 {
+    public string $ip;
+
+    protected array $v4 = [
+        '0.0.0.0/8',
+        '10.0.0.0/8',
+        '127.0.0.0/8',
+        '172.16.0.0/12',
+        '192.168.0.0/16',
+        '169.254.0.0/16',
+    ];
+
+    protected array $v6 = [
+        '::1/128',
+        'fc00::/7',
+        'fd00::/8',
+        'fe80::/10',
+    ];
+
     public function __construct(
-        public string $ip
+        string $ip
     ) {
+        if (!filter_var($ip, FILTER_VALIDATE_IP)) {
+            throw new \InvalidArgumentException('Invalid IP received');
+        }
+
+        $this->ip = $ip;
+    }
+
+    public function isV4(): bool
+    {
+        return !$this->isV6();
+    }
+
+    public function isV6(): bool
+    {
+        return substr_count($this->ip, ':') > 1;
+    }
+
+    public function isPrivate(): bool
+    {
+        $ips = $this->isV4() ? $this->v4 : $this->v6;
+
+        return IpUtils::checkIp($this->ip, $ips);
+    }
+
+    public function isPublic(): bool
+    {
+        return !$this->isPrivate();
     }
 
     public function __toString(): string

src/Support/IpUtils.php

@@ -0,0 +1,176 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SamuelMwangiW\Linode\Support;
+
+class IpUtils
+{
+    private static array $checkedIps = [];
+
+    /**
+     * 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|array $ips List of IPs or subnets (can be a string if only a single one)
+     */
+    public static function checkIp(string $requestIp, string|array $ips): bool
+    {
+        if (!\is_array($ips)) {
+            $ips = [$ips];
+        }
+
+        $method = substr_count($requestIp, ':') > 1 ? 'checkIp6' : 'checkIp4';
+
+        foreach ($ips as $ip) {
+            if (self::$method($requestIp, $ip)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Compares two IPv4 addresses.
+     * In case a subnet is given, it checks if it contains the request IP.
+     *
+     * @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(string $requestIp, string $ip): bool
+    {
+        $cacheKey = $requestIp.'-'.$ip;
+        if (isset(self::$checkedIps[$cacheKey])) {
+            return self::$checkedIps[$cacheKey];
+        }
+
+        if (!filter_var($requestIp, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4)) {
+            return self::$checkedIps[$cacheKey] = false;
+        }
+
+        if (str_contains($ip, '/')) {
+            [$address, $netmask] = explode('/', $ip, 2);
+
+            if ('0' === $netmask) {
+                return self::$checkedIps[$cacheKey] = filter_var($address, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4);
+            }
+
+            if ($netmask < 0 || $netmask > 32) {
+                return self::$checkedIps[$cacheKey] = false;
+            }
+        } else {
+            $address = $ip;
+            $netmask = 32;
+        }
+
+        if (false === ip2long($address)) {
+            return self::$checkedIps[$cacheKey] = false;
+        }
+
+        return self::$checkedIps[$cacheKey] = 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 $ip IPv6 address or subnet in CIDR notation
+     *
+     * @throws \RuntimeException When IPV6 support is not enabled
+     */
+    public static function checkIp6(string $requestIp, string $ip): bool
+    {
+        $cacheKey = $requestIp.'-'.$ip;
+        if (isset(self::$checkedIps[$cacheKey])) {
+            return self::$checkedIps[$cacheKey];
+        }
+
+        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 (str_contains($ip, '/')) {
+            [$address, $netmask] = explode('/', $ip, 2);
+
+            if ('0' === $netmask) {
+                return (bool) unpack('n*', @inet_pton($address));
+            }
+
+            if ($netmask < 1 || $netmask > 128) {
+                return self::$checkedIps[$cacheKey] = false;
+            }
+        } else {
+            $address = $ip;
+            $netmask = 128;
+        }
+
+        $bytesAddr = unpack('n*', @inet_pton($address));
+        $bytesTest = unpack('n*', @inet_pton($requestIp));
+
+        if (!$bytesAddr || !$bytesTest) {
+            return self::$checkedIps[$cacheKey] = 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 self::$checkedIps[$cacheKey] = false;
+            }
+        }
+
+        return self::$checkedIps[$cacheKey] = true;
+    }
+
+    /**
+     * Anonymizes an IP/IPv6.
+     *
+     * Removes the last byte for v4 and the last 8 bytes for v6 IPs
+     */
+    public static function anonymize(string $ip): string
+    {
+        $wrappedIPv6 = false;
+        if (str_starts_with($ip, '[') && str_ends_with($ip, ']')) {
+            $wrappedIPv6 = true;
+            $ip = substr($ip, 1, -1);
+        }
+
+        $packedAddress = inet_pton($ip);
+        if (4 === \strlen($packedAddress)) {
+            $mask = '255.255.255.0';
+        } elseif ($ip === inet_ntop($packedAddress & inet_pton('::ffff:ffff:ffff'))) {
+            $mask = '::ffff:ffff:ff00';
+        } elseif ($ip === inet_ntop($packedAddress & inet_pton('::ffff:ffff'))) {
+            $mask = '::ffff:ff00';
+        } else {
+            $mask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000';
+        }
+        $ip = inet_ntop($packedAddress & inet_pton($mask));
+
+        if ($wrappedIPv6) {
+            $ip = '['.$ip.']';
+        }
+
+        return $ip;
+    }
+}

tests/Datasets/Ip.php

@@ -0,0 +1,22 @@
+<?php
+
+dataset('valid-ipv4', [
+    '8.8.8.8',
+    '10.10.10.10',
+    '192.168.20.13',
+    '192.168.1.1',
+    '1.2.3.4',
+]);
+
+dataset('private-ipv4',[
+    '10.10.10.10',
+    '192.168.20.13',
+]);
+
+dataset('public-ipv4',[
+    '1.2.3.4',
+    '8.8.8.8',
+    '5.11.11.5',
+    '9.9.9.9',
+]);
+

tests/IPAddressTest.php

@@ -0,0 +1,32 @@
+<?php
+
+use SamuelMwangiW\Linode\DTO\IPAddress;
+
+it('returns true for ipv4 addresses', function (string $ip) {
+    $IpAddressObj = new IPAddress($ip);
+
+    expect($IpAddressObj)
+        ->ip->toBe($ip)
+        ->isV4()->toBeTrue()
+        ->isV6()->toBeFalse();
+})->with('valid-ipv4');
+
+it('returns true for private ipv4 addresses', function (string $ip) {
+    $IpAddressObj = new IPAddress($ip);
+
+    expect($IpAddressObj)
+        ->ip->toBe($ip)
+        ->isV4()->toBeTrue()
+        ->isPrivate()->toBeTrue()
+        ->isPublic()->toBeFalse();
+})->with('private-ipv4');
+
+it('returns true for public ipv4 addresses', function (string $ip) {
+    $IpAddressObj = new IPAddress($ip);
+
+    expect($IpAddressObj)
+        ->ip->toBe($ip)
+        ->isV4()->toBeTrue()
+        ->isPublic()->toBeTrue()
+        ->isPrivate()->toBeFalse();
+})->with('public-ipv4');