ipaddr 1.2.9 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d7f44f2a3874755d2b38a4cf417bc3b86f1298a92a47ce0df1c6da780982f10
-  data.tar.gz: d7b75a507f7345cfdb5fa1e7141748031b102e843982a5d627fb3d2f9ff9c302
+  metadata.gz: b3a45f67694de980f29fe97b4b20675bf93b95d8250b26dfcc0549816129394a
+  data.tar.gz: 37d8f96d02031b7847bd8c32b22776cdf0e9596a416defc64769899d5e89c6d3
 SHA512:
-  metadata.gz: 34b061ae03573b58b00b867655c94edb42970eccf6297ac29915fb5e9cec430479eadb0cae90c9857b395ed9d220cd9eaa596a791f0225237113ab010b6dcba4
-  data.tar.gz: 7347ead0e35fa0bad997db445806eda0bdc6d8ddcffba1b8ff6d8d36f3c3febfa429e59bf36a0b5381690c3881163b070b858dc92cea1d8eca887657a4085f96
+  metadata.gz: 3da16382856d2668a53ca3f270b708e0ec8d3d109e6c103aa9be482aac4b84697d12a9b928b13516a522ae355ab8c47e79299d4c18e356c6944add55a6033613
+  data.tar.gz: 60ec70c14d1715254f564070d8f3b7bbac87a7a07af194f99604fbf222d7cea15f08fc858497b8f9a342ea94dbccd1706f1d14b5b686792a800fce2c9cec9206

data/README.md

@@ -15,7 +15,7 @@ version than comes with older versions of ruby.
 For example, you can add this line to your application's Gemfile:
 
 ```ruby
-gem 'ipaddr', '~> 1.2'
+gem 'ipaddr'
 ```
 
 And then execute:

data/lib/ipaddr.rb

@@ -41,7 +41,7 @@ require 'socket'
 
 class IPAddr
   # The version string
-  VERSION = "1.2.9"
+  VERSION = "1.3.1"
 
   # 32 bit mask for IPv4
   IN4MASK = 0xffffffff
@@ -205,9 +205,51 @@ class IPAddr
     return @addr
   end
 
+  # Returns a string containing the binary representation of the
+  # IP address value, right adjusted to the address size (32 bits
+  # for IPv4, 128 bits for IPv6), regardless of the prefix length.
+  #
+  # e.g.:
+  #   require 'ipaddr'
+  #   p IPAddr.new("192.168.1.1").to_bits
+  #   #=> "11000000101010000000000100000001"
+  #   p IPAddr.new("3ffe:505:2::1").to_bits
+  #   #=> "00111111111111100000010100000101" \
+  #   #   "00000000000000100000000000000000" \
+  #   #   "00000000000000000000000000000000" \
+  #   #   "00000000000000000000000000000001"
+  def to_bits
+    case @family
+    when Socket::AF_INET
+      @addr.to_s(2).rjust(32, '0')
+    when Socket::AF_INET6
+      @addr.to_s(2).rjust(128, '0')
+    else
+      raise AddressFamilyError, "unsupported address family"
+    end
+  end
+
+  # Returns a string containing the hexadecimal representation of the
+  # IP address value, right adjusted to the address size.
+  #
+  # e.g.:
+  #   require 'ipaddr'
+  #   p IPAddr.new("192.168.1.1").to_hex   #=> "c0a80101"
+  #   p IPAddr.new("3ffe:505:2::1").to_hex #=> "3ffe0505000200000000000000000001"
+  def to_hex
+    case @family
+    when Socket::AF_INET
+      @addr.to_s(16).rjust(8, '0')
+    when Socket::AF_INET6
+      @addr.to_s(16).rjust(32, '0')
+    else
+      raise AddressFamilyError, "unsupported address family"
+    end
+  end
+
   # Returns a string containing the IP address representation.
   def to_s
-    str = to_string
+    str = _to_string(@addr)
     return str if ipv4?
 
     str.gsub!(/\b0{1,3}([\da-f]+)\b/i, '\1')
@@ -227,6 +269,7 @@ class IPAddr
       str = sprintf('::%s%d.%d.%d.%d', $1, $2.hex / 256, $2.hex % 256, $3.hex / 256, $3.hex % 256)
     end
 
+    str << @zone_id if @zone_id
     str
   end
 
@@ -267,12 +310,9 @@ class IPAddr
   # Returns a network byte ordered string form of the IP address.
   def hton
     case @family
-    when Socket::AF_INET
-      return [@addr].pack('N')
-    when Socket::AF_INET6
-      return (0..7).map { |i|
-        (@addr >> (112 - 16 * i)) & 0xffff
-      }.pack('n8')
+    when Socket::AF_INET, Socket::AF_INET6
+      value = to_hex
+      return [value].pack("H#{value.length}")
     else
       raise AddressFamilyError, "unsupported address family"
     end
@@ -294,11 +334,11 @@ class IPAddr
   def loopback?
     case @family
     when Socket::AF_INET
-      @addr & 0xff000000 == 0x7f000000 # 127.0.0.1/8
+      (@addr & 0xff000000 == 0x7f000000) && prefix >= 8 # 127.0.0.1/8
     when Socket::AF_INET6
       @addr == 1 || # ::1
         (@addr >> 32 == 0xffff && (
-          @addr & 0xff000000 == 0x7f000000 # ::ffff:127.0.0.1/8
+          (@addr & 0xff000000 == 0x7f000000) && prefix >= 104 # ::ffff:127.0.0.0/104 (127.0.0.1/8)
         ))
     else
       raise AddressFamilyError, "unsupported address family"
@@ -313,22 +353,22 @@ class IPAddr
   def private?
     case @family
     when Socket::AF_INET
-      @addr & 0xff000000 == 0x0a000000 ||    # 10.0.0.0/8
-        @addr & 0xfff00000 == 0xac100000 ||  # 172.16.0.0/12
-        @addr & 0xffff0000 == 0xc0a80000     # 192.168.0.0/16
+      (@addr & 0xff000000 == 0x0a000000) && prefix >= 8 ||    # 10.0.0.0/8
+        (@addr & 0xfff00000 == 0xac100000) && prefix >= 12 || # 172.16.0.0/12
+        (@addr & 0xffff0000 == 0xc0a80000) && prefix >= 16    # 192.168.0.0/16
     when Socket::AF_INET6
-      @addr & 0xfe00_0000_0000_0000_0000_0000_0000_0000 == 0xfc00_0000_0000_0000_0000_0000_0000_0000 ||
+      (@addr & 0xfe00_0000_0000_0000_0000_0000_0000_0000 == 0xfc00_0000_0000_0000_0000_0000_0000_0000) && prefix >= 7 || # fc00::/7
         (@addr >> 32 == 0xffff && (
-          @addr & 0xff000000 == 0x0a000000 ||  # ::ffff:10.0.0.0/8
-          @addr & 0xfff00000 == 0xac100000 ||  # ::ffff:172.16.0.0/12
-          @addr & 0xffff0000 == 0xc0a80000     # ::ffff:192.168.0.0/16
+          (@addr & 0xff000000 == 0x0a000000) && prefix >= 104 || # ::ffff:10.0.0.0/104 (10.0.0.0/8)
+          (@addr & 0xfff00000 == 0xac100000) && prefix >= 108 || # ::ffff:172.16.0.0/108 (172.16.0.0/12)
+          (@addr & 0xffff0000 == 0xc0a80000) && prefix >= 112    # ::ffff:192.168.0.0/112 (192.168.0.0/16)
         ))
     else
       raise AddressFamilyError, "unsupported address family"
     end
   end
 
-  # Returns true if the ipaddr is a link-local address.  IPv4
+  # Returns true if the ipaddr is a link-local unicast address.  IPv4
   # addresses in 169.254.0.0/16 reserved by RFC 3927 and link-local
   # IPv6 Unicast Addresses in fe80::/10 reserved by RFC 4291 are
   # considered link-local. Link-local IPv4 addresses in the
@@ -336,11 +376,65 @@ class IPAddr
   def link_local?
     case @family
     when Socket::AF_INET
-      @addr & 0xffff0000 == 0xa9fe0000 # 169.254.0.0/16
+      (@addr & 0xffff0000 == 0xa9fe0000) && prefix >= 16 # 169.254.0.0/16
     when Socket::AF_INET6
-      @addr & 0xffc0_0000_0000_0000_0000_0000_0000_0000 == 0xfe80_0000_0000_0000_0000_0000_0000_0000 || # fe80::/10
+      (@addr & 0xffc0_0000_0000_0000_0000_0000_0000_0000 == 0xfe80_0000_0000_0000_0000_0000_0000_0000) && prefix >= 10 || # fe80::/10
         (@addr >> 32 == 0xffff && (
-          @addr & 0xffff0000 == 0xa9fe0000 # ::ffff:169.254.0.0/16
+          (@addr & 0xffff0000 == 0xa9fe0000) && prefix >= 112 # ::ffff:169.254.0.0/112 (169.254.0.0/16)
+        ))
+    else
+      raise AddressFamilyError, "unsupported address family"
+    end
+  end
+
+  alias link_local_unicast? link_local?
+
+  # Returns true if the ipaddr is an unspecified address.  The IPv4
+  # address 0.0.0.0 and the IPv6 address :: are unspecified.  Unspecified
+  # IPv4 addresses in the IPv4-mapped IPv6 address range are also
+  # considered unspecified.
+  def unspecified?
+    case @family
+    when Socket::AF_INET
+      @addr == 0 && prefix == 32 # 0.0.0.0
+    when Socket::AF_INET6
+      @addr == 0 && prefix == 128 || # ::
+        (@addr >> 32 == 0xffff && (@addr & IN4MASK) == 0) && prefix == 128 # ::ffff:0.0.0.0
+    else
+      raise AddressFamilyError, "unsupported address family"
+    end
+  end
+
+  # Returns true if the ipaddr is a multicast address. IPv4
+  # addresses in 224.0.0.0/4 and IPv6 multicast addresses
+  # in ff00::/8 are considered multicast. Multicast IPv4 addresses in the
+  # IPv4-mapped IPv6 address range are also considered multicast.
+  def multicast?
+    case @family
+    when Socket::AF_INET
+      (@addr & 0xf0000000 == 0xe0000000) && prefix >= 4 # 224.0.0.0/4
+    when Socket::AF_INET6
+      (@addr & 0xff00_0000_0000_0000_0000_0000_0000_0000 == 0xff00_0000_0000_0000_0000_0000_0000_0000) && prefix >= 8 || # ff00::/8
+        (@addr >> 32 == 0xffff &&
+          (@addr & 0xf0000000 == 0xe0000000) && prefix >= 100 # ::ffff:224.0.0.0/100 (224.0.0.0/4)
+        )
+    else
+      raise AddressFamilyError, "unsupported address family"
+    end
+  end
+
+  # Returns true if the ipaddr is a link-local multicast address. IPv4
+  # addresses in 224.0.0.0/24 and link-local IPv6 Multicast Addresses in ff02::/16
+  # are considered link-local multicast. Link-local multicast IPv4 addresses in the
+  # IPv4-mapped IPv6 address range are also considered link-local multicast.
+  def link_local_multicast?
+    case @family
+    when Socket::AF_INET
+      (@addr & 0xffffff00 == 0xe0000000) && prefix >= 24 # 224.0.0.0/24 Local Network Control Block
+    when Socket::AF_INET6
+      (@addr & 0xffff_0000_0000_0000_0000_0000_0000_0000 == 0xff02_0000_0000_0000_0000_0000_0000_0000) && prefix >= 16 || # ff02::/16
+        (@addr >> 32 == 0xffff && (
+          (@addr & 0xffffff00 == 0xe0000000) && prefix >= 120 # ::ffff:224.0.0.0/120 (224.0.0.0/24)
         ))
     else
       raise AddressFamilyError, "unsupported address family"
@@ -539,7 +633,7 @@ class IPAddr
   def zone_id=(zid)
     if @family == Socket::AF_INET6
       case zid
-      when nil, /\A%(\w+)\z/
+      when nil, /\A%[-0-9A-Za-z._~]+\z/
         @zone_id = zid
       else
         raise InvalidAddressError, "invalid zone identifier for address"
@@ -673,12 +767,14 @@ class IPAddr
         raise AddressFamilyError, "unsupported address family: #{family}"
       end
     end
+    requested_family = family
     prefix, prefixlen = addr.split('/', 2)
     if prefix =~ /\A\[(.*)\]\z/i
       prefix = $1
       family = Socket::AF_INET6
+      bracketed = true
     end
-    if prefix =~ /\A(.*)(%\w+)\z/
+    if prefix =~ /\A(.*)(%[-0-9A-Za-z._~]+)\z/
       prefix = $1
       zone_id = $2
       family = Socket::AF_INET6
@@ -698,11 +794,17 @@ class IPAddr
       @family = Socket::AF_INET6
     end
     @zone_id = zone_id
-    if family != Socket::AF_UNSPEC && @family != family
+    if requested_family != Socket::AF_UNSPEC && @family != requested_family
       raise AddressFamilyError, "address family mismatch"
     end
     if prefixlen
       mask!(prefixlen)
+
+      if bracketed
+        warn "bracketed IPv6 address with a prefix length is an invalid address " \
+             "and will raise IPAddr::InvalidAddressError in a future version: #{addr}",
+             uplevel: 1
+      end
     else
       @mask_addr = (@family == Socket::AF_INET) ? IN4MASK : IN6MASK
     end
@@ -747,7 +849,7 @@ class IPAddr
       right = ''
     when RE_IPV6ADDRLIKE_COMPRESSED
       if $4
-        left.count(':') <= 6 or raise InvalidAddressError, "invalid address: #{left}"
+        left.count(':') <= ($1.empty? ? 7 : 6) or raise InvalidAddressError, "invalid address: #{left}"
         addr = in_addr($~[4,4])
         left = $1
         right = $3 + '0:0'
@@ -764,9 +866,6 @@ class IPAddr
     l = left.split(':')
     r = right.split(':')
     rest = 8 - l.size - r.size
-    if rest < 0
-      return nil
-    end
     (l + Array.new(rest, '0') + r).inject(0) { |i, s|
       i << 16 | s.hex
     } | addr
@@ -790,7 +889,7 @@ class IPAddr
         (@addr >> (8 * i)) & 0xff
       }.join('.')
     when Socket::AF_INET6
-      return ("%.32x" % @addr).reverse!.gsub!(/.(?!$)/, '\&.')
+      return to_hex.reverse.chars.join('.')
     else
       raise AddressFamilyError, "unsupported address family"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ipaddr
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.3.1
 platform: ruby
 authors:
 - Akinori MUSHA
@@ -42,7 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A class to manipulate an IP address in ruby
 test_files: []