ipaddr icon indicating copy to clipboard operation
ipaddr copied to clipboard

Fix IPAddr equality to compare network masks

Open goulon opened this issue 4 months ago • 0 comments

Why Address Mask is Essential for IPAddr Equality

In networking, an IP address without a prefix/netmask is fundamentally incomplete.

Two IP addresses should only be compared using the address, mask, and version because the mask determines which bits identify the network and which bits identify the host.

Without the mask, two addresses like 2001:db8::1/32 and 2001:db8::1/48 may appear identical, but they represent different scopes—different network ranges, not a full subnet versus a single host.

Comparing only the address and version ignores this important context, leading to inaccurate network identities. This is relevant for access control and routing.

The Problem:

# Before this fix:
IPAddr.new("2001:db8::1/48") == IPAddr.new("2001:db8::1/32")  # => true (wrong!)

These represent entirely different networks:

  • 2001:db8::1/48 is a network with 2^80 usable host addresses
  • 2001:db8::1/32 is a network with 2^96 usable host addresses

The Solution: By including @mask_addr in equality, we ensure that two IPAddr objects are equal only when they represent the same network scope, not just the same base address.

IPv6 Example:

a = IPAddr.new("2001:db8::1/32")    # Regional Internet Registry allocation
b = IPAddr.new("2001:db8::1/48")    # Single organization assignment

a == b  # Now correctly returns false

This change fixes the issue by including @mask_addr in the equality check. As a result, equality now reflects both the address value and the applied network mask, which better matches user expectations and common networking semantics.

The test suite has been updated to ensure comparisons now account for prefix length differences.

This aligns with RFC 4291's definition that IPv6 addresses are meaningless without their prefix length context, and matches the behavior network engineers expect when comparing network identities, making IPAddr#== semantically correct according to networking standards rather than just comparing raw integer values.

goulon avatar Aug 22 '25 05:08 goulon