Class InetAddressMatchers

java.lang.Object
org.springframework.security.util.matcher.InetAddressMatchers

public final class InetAddressMatchers extends Object
Factory for creating InetAddressMatcher instances with various matching strategies for IP addresses.
Since:
7.1
  • Method Details

    • builder

      public static InetAddressMatchers.Builder builder()
      Creates a new builder for configuring an InetAddressMatcher.
      Returns:
      a new InetAddressMatchers.Builder instance
    • matchExternal

      public static InetAddressMatchers.Builder matchExternal()
      Creates a new builder configured to match external (non-private) IP addresses.
      Returns:
      a InetAddressMatchers.Builder configured to match external addresses
    • matchInternal

      public static InetAddressMatchers.Builder matchInternal()
      Creates a new builder configured to match internal (private) IP addresses.

      Internal addresses include loopback addresses (127.0.0.0/8 for IPv4, ::1 for IPv6), private IPv4 address ranges (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16), and IPv6 Unique Local Addresses (fc00::/7).

      Returns:
      a InetAddressMatchers.Builder configured to match internal addresses
    • fromIpAddress

      public static InetAddressMatcher fromIpAddress(String ipAddress)
      Creates an InetAddressMatcher that matches a specific IP address or subnet using CIDR notation (e.g., 192.168.1.0/24).

      Both IPv4 and IPv6 addresses are supported.

      Parameters:
      ipAddress - the IP address or CIDR range to match against
      Returns:
      an InetAddressMatcher for the given IP address pattern