Skip to content

Conversation

@tomaz-lc
Copy link

Details

Documentation updates for IP address classification operators following changes in dr-engine.

Based on top of changes from #84.

Changes

New Operators Documented

Operator Description
is public ipv4 address Matches only publicly routable IPv4 addresses
is public ipv6 address Matches only publicly routable IPv6 addresses
is private ipv4 address Matches RFC1918 + CGNAT IPv4 addresses
is private ipv6 address Matches ULA (fc00::/7) IPv6 addresses

Updated Operators

Operator Changes
is private address Added CGNAT (100.64.0.0/10), added IPv6 ULA support, added RFC references
is public address Added CGNAT exclusion, fixed multicast handling, added full IPv6 support, added RFC references

Documentation Corrections (Breaking Behavior)

Previous Documentation Corrected Documentation
Multicast (224.0.0.0/4) "considered public as they can traverse the internet" Multicast is now correctly excluded from public (not routable unicast)
No mention of CGNAT CGNAT (100.64.0.0/10) now excluded from public, included in private
No IPv6 documentation Full IPv6 support documented with RFC references

RFC References Added

  • RFC 1918 (IPv4 Private)
  • RFC 6598 (CGNAT)
  • RFC 1122 (Loopback, Unspecified)
  • RFC 3927 (Link-Local)
  • RFC 5771 (Multicast)
  • RFC 4193 (IPv6 ULA)
  • RFC 4291 (IPv6 Loopback, Link-Local, Multicast)
  • RFC 3879 (Deprecated Site-Local)

Documents new D&R operators for version-specific IP address classification:
- is public ipv4 address
- is public ipv6 address
- is private ipv4 address
- is private ipv6 address

Updates existing operator documentation:
- is private address: Added CGNAT (RFC 6598) and IPv6 ULA (RFC 4193)
- is public address: Added comprehensive IPv6 support, corrected multicast
  handling, added CGNAT exclusion

All address ranges now include RFC references for clarity.

BREAKING CHANGE: Documentation now correctly states that multicast addresses
(224.0.0.0/4, ff00::/8) are NOT considered public. Previous documentation
incorrectly stated they were public.
@tomaz-lc tomaz-lc requested a review from maximelb January 30, 2026 17:12
@tomaz-lc tomaz-lc merged commit 156b37c into docs/is-public-address-clarification Jan 30, 2026
@tomaz-lc tomaz-lc deleted the docs/is-public-address-clarification-updates branch January 30, 2026 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants