IpUtils.php 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
  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 $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 $requestIp IP to check
  29. * @param string|array $ips List of IPs or subnets (can be a string if only a single one)
  30. *
  31. * @return bool Whether the IP is valid
  32. */
  33. public static function checkIp($requestIp, $ips)
  34. {
  35. if (!\is_array($ips)) {
  36. $ips = [$ips];
  37. }
  38. $method = substr_count($requestIp, ':') > 1 ? 'checkIp6' : 'checkIp4';
  39. foreach ($ips as $ip) {
  40. if (self::$method($requestIp, $ip)) {
  41. return true;
  42. }
  43. }
  44. return false;
  45. }
  46. /**
  47. * Compares two IPv4 addresses.
  48. * In case a subnet is given, it checks if it contains the request IP.
  49. *
  50. * @param string $requestIp IPv4 address to check
  51. * @param string $ip IPv4 address or subnet in CIDR notation
  52. *
  53. * @return bool Whether the request IP matches the IP, or whether the request IP is within the CIDR subnet
  54. */
  55. public static function checkIp4($requestIp, $ip)
  56. {
  57. $cacheKey = $requestIp.'-'.$ip;
  58. if (isset(self::$checkedIps[$cacheKey])) {
  59. return self::$checkedIps[$cacheKey];
  60. }
  61. if (!filter_var($requestIp, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4)) {
  62. return self::$checkedIps[$cacheKey] = false;
  63. }
  64. if (str_contains($ip, '/')) {
  65. [$address, $netmask] = explode('/', $ip, 2);
  66. if ('0' === $netmask) {
  67. return self::$checkedIps[$cacheKey] = filter_var($address, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4);
  68. }
  69. if ($netmask < 0 || $netmask > 32) {
  70. return self::$checkedIps[$cacheKey] = false;
  71. }
  72. } else {
  73. $address = $ip;
  74. $netmask = 32;
  75. }
  76. if (false === ip2long($address)) {
  77. return self::$checkedIps[$cacheKey] = false;
  78. }
  79. return self::$checkedIps[$cacheKey] = 0 === substr_compare(sprintf('%032b', ip2long($requestIp)), sprintf('%032b', ip2long($address)), 0, $netmask);
  80. }
  81. /**
  82. * Compares two IPv6 addresses.
  83. * In case a subnet is given, it checks if it contains the request IP.
  84. *
  85. * @author David Soria Parra <dsp at php dot net>
  86. *
  87. * @see https://github.com/dsp/v6tools
  88. *
  89. * @param string $requestIp IPv6 address to check
  90. * @param string $ip IPv6 address or subnet in CIDR notation
  91. *
  92. * @return bool Whether the IP is valid
  93. *
  94. * @throws \RuntimeException When IPV6 support is not enabled
  95. */
  96. public static function checkIp6($requestIp, $ip)
  97. {
  98. $cacheKey = $requestIp.'-'.$ip;
  99. if (isset(self::$checkedIps[$cacheKey])) {
  100. return self::$checkedIps[$cacheKey];
  101. }
  102. if (!((\extension_loaded('sockets') && \defined('AF_INET6')) || @inet_pton('::1'))) {
  103. throw new \RuntimeException('Unable to check Ipv6. Check that PHP was not compiled with option "disable-ipv6".');
  104. }
  105. if (str_contains($ip, '/')) {
  106. [$address, $netmask] = explode('/', $ip, 2);
  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. $address = $ip;
  115. $netmask = 128;
  116. }
  117. $bytesAddr = unpack('n*', @inet_pton($address));
  118. $bytesTest = unpack('n*', @inet_pton($requestIp));
  119. if (!$bytesAddr || !$bytesTest) {
  120. return self::$checkedIps[$cacheKey] = false;
  121. }
  122. for ($i = 1, $ceil = ceil($netmask / 16); $i <= $ceil; ++$i) {
  123. $left = $netmask - 16 * ($i - 1);
  124. $left = ($left <= 16) ? $left : 16;
  125. $mask = ~(0xffff >> $left) & 0xffff;
  126. if (($bytesAddr[$i] & $mask) != ($bytesTest[$i] & $mask)) {
  127. return self::$checkedIps[$cacheKey] = false;
  128. }
  129. }
  130. return self::$checkedIps[$cacheKey] = true;
  131. }
  132. /**
  133. * Anonymizes an IP/IPv6.
  134. *
  135. * Removes the last byte for v4 and the last 8 bytes for v6 IPs
  136. */
  137. public static function anonymize(string $ip): string
  138. {
  139. $wrappedIPv6 = false;
  140. if ('[' === substr($ip, 0, 1) && ']' === substr($ip, -1, 1)) {
  141. $wrappedIPv6 = true;
  142. $ip = substr($ip, 1, -1);
  143. }
  144. $packedAddress = inet_pton($ip);
  145. if (4 === \strlen($packedAddress)) {
  146. $mask = '255.255.255.0';
  147. } elseif ($ip === inet_ntop($packedAddress & inet_pton('::ffff:ffff:ffff'))) {
  148. $mask = '::ffff:ffff:ff00';
  149. } elseif ($ip === inet_ntop($packedAddress & inet_pton('::ffff:ffff'))) {
  150. $mask = '::ffff:ff00';
  151. } else {
  152. $mask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000';
  153. }
  154. $ip = inet_ntop($packedAddress & inet_pton($mask));
  155. if ($wrappedIPv6) {
  156. $ip = '['.$ip.']';
  157. }
  158. return $ip;
  159. }
  160. }