class IpUtils in Zircon Profile 8

Http utility functions.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\HttpFoundation\IpUtils

1 file declares its use of IpUtils

IpUtilsTest.php in vendor/symfony/http-foundation/Tests/IpUtilsTest.php

File

vendor/symfony/http-foundation/IpUtils.php, line 19

Namespace

Symfony\Component\HttpFoundation

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,
      );
    }
    $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 $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));
    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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
IpUtils::checkIp	public static	function	Checks if an IPv4 or IPv6 address is contained in the list of given IPs or subnets.
IpUtils::checkIp4	public static	function	Compares two IPv4 addresses. In case a subnet is given, it checks if it contains the request IP.
IpUtils::checkIp6	public static	function	Compares two IPv6 addresses. In case a subnet is given, it checks if it contains the request IP.
IpUtils::__construct	private	function	This class should not be instantiated.