IpUtils.php 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpFoundation;
  11. /**
  12. * Http utility functions.
  13. *
  14. * @author Fabien Potencier <fabien@symfony.com>
  15. */
  16. class IpUtils
  17. {
  18. private static array $checkedIps = [];
  19. /**
  20. * This class should not be instantiated.
  21. */
  22. private function __construct()
  23. {
  24. }
  25. /**
  26. * Checks if an IPv4 or IPv6 address is contained in the list of given IPs or subnets.
  27. *
  28. * @param string|array $ips List of IPs or subnets (can be a string if only a single one)
  29. */
  30. public static function checkIp(string $requestIp, string|array $ips): bool
  31. {
  32. if (!\is_array($ips)) {
  33. $ips = [$ips];
  34. }
  35. $method = substr_count($requestIp, ':') > 1 ? 'checkIp6' : 'checkIp4';
  36. foreach ($ips as $ip) {
  37. if (self::$method($requestIp, $ip)) {
  38. return true;
  39. }
  40. }
  41. return false;
  42. }
  43. /**
  44. * Compares two IPv4 addresses.
  45. * In case a subnet is given, it checks if it contains the request IP.
  46. *
  47. * @param string $ip IPv4 address or subnet in CIDR notation
  48. *
  49. * @return bool Whether the request IP matches the IP, or whether the request IP is within the CIDR subnet
  50. */
  51. public static function checkIp4(string $requestIp, string $ip): bool
  52. {
  53. $cacheKey = $requestIp.'-'.$ip;
  54. if (isset(self::$checkedIps[$cacheKey])) {
  55. return self::$checkedIps[$cacheKey];
  56. }
  57. if (!filter_var($requestIp, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4)) {
  58. return self::$checkedIps[$cacheKey] = false;
  59. }
  60. if (str_contains($ip, '/')) {
  61. [$address, $netmask] = explode('/', $ip, 2);
  62. if ('0' === $netmask) {
  63. return self::$checkedIps[$cacheKey] = false !== filter_var($address, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4);
  64. }
  65. if ($netmask < 0 || $netmask > 32) {
  66. return self::$checkedIps[$cacheKey] = false;
  67. }
  68. } else {
  69. $address = $ip;
  70. $netmask = 32;
  71. }
  72. if (false === ip2long($address)) {
  73. return self::$checkedIps[$cacheKey] = false;
  74. }
  75. return self::$checkedIps[$cacheKey] = 0 === substr_compare(sprintf('%032b', ip2long($requestIp)), sprintf('%032b', ip2long($address)), 0, $netmask);
  76. }
  77. /**
  78. * Compares two IPv6 addresses.
  79. * In case a subnet is given, it checks if it contains the request IP.
  80. *
  81. * @author David Soria Parra <dsp at php dot net>
  82. *
  83. * @see https://github.com/dsp/v6tools
  84. *
  85. * @param string $ip IPv6 address or subnet in CIDR notation
  86. *
  87. * @throws \RuntimeException When IPV6 support is not enabled
  88. */
  89. public static function checkIp6(string $requestIp, string $ip): bool
  90. {
  91. $cacheKey = $requestIp.'-'.$ip;
  92. if (isset(self::$checkedIps[$cacheKey])) {
  93. return self::$checkedIps[$cacheKey];
  94. }
  95. if (!((\extension_loaded('sockets') && \defined('AF_INET6')) || @inet_pton('::1'))) {
  96. throw new \RuntimeException('Unable to check Ipv6. Check that PHP was not compiled with option "disable-ipv6".');
  97. }
  98. // Check to see if we were given a IP4 $requestIp or $ip by mistake
  99. if (!filter_var($requestIp, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV6)) {
  100. return self::$checkedIps[$cacheKey] = false;
  101. }
  102. if (str_contains($ip, '/')) {
  103. [$address, $netmask] = explode('/', $ip, 2);
  104. if (!filter_var($address, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV6)) {
  105. return self::$checkedIps[$cacheKey] = false;
  106. }
  107. if ('0' === $netmask) {
  108. return (bool) unpack('n*', @inet_pton($address));
  109. }
  110. if ($netmask < 1 || $netmask > 128) {
  111. return self::$checkedIps[$cacheKey] = false;
  112. }
  113. } else {
  114. if (!filter_var($ip, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV6)) {
  115. return self::$checkedIps[$cacheKey] = false;
  116. }
  117. $address = $ip;
  118. $netmask = 128;
  119. }
  120. $bytesAddr = unpack('n*', @inet_pton($address));
  121. $bytesTest = unpack('n*', @inet_pton($requestIp));
  122. if (!$bytesAddr || !$bytesTest) {
  123. return self::$checkedIps[$cacheKey] = false;
  124. }
  125. for ($i = 1, $ceil = ceil($netmask / 16); $i <= $ceil; ++$i) {
  126. $left = $netmask - 16 * ($i - 1);
  127. $left = ($left <= 16) ? $left : 16;
  128. $mask = ~(0xFFFF >> $left) & 0xFFFF;
  129. if (($bytesAddr[$i] & $mask) != ($bytesTest[$i] & $mask)) {
  130. return self::$checkedIps[$cacheKey] = false;
  131. }
  132. }
  133. return self::$checkedIps[$cacheKey] = true;
  134. }
  135. /**
  136. * Anonymizes an IP/IPv6.
  137. *
  138. * Removes the last byte for v4 and the last 8 bytes for v6 IPs
  139. */
  140. public static function anonymize(string $ip): string
  141. {
  142. $wrappedIPv6 = false;
  143. if ('[' === substr($ip, 0, 1) && ']' === substr($ip, -1, 1)) {
  144. $wrappedIPv6 = true;
  145. $ip = substr($ip, 1, -1);
  146. }
  147. $packedAddress = inet_pton($ip);
  148. if (4 === \strlen($packedAddress)) {
  149. $mask = '255.255.255.0';
  150. } elseif ($ip === inet_ntop($packedAddress & inet_pton('::ffff:ffff:ffff'))) {
  151. $mask = '::ffff:ffff:ff00';
  152. } elseif ($ip === inet_ntop($packedAddress & inet_pton('::ffff:ffff'))) {
  153. $mask = '::ffff:ff00';
  154. } else {
  155. $mask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000';
  156. }
  157. $ip = inet_ntop($packedAddress & inet_pton($mask));
  158. if ($wrappedIPv6) {
  159. $ip = '['.$ip.']';
  160. }
  161. return $ip;
  162. }
  163. }