2018-12-18 08:09:08 +03:00
|
|
|
# frozen_string_literal: true
|
2002-12-23 20:07:49 +03:00
|
|
|
#
|
|
|
|
# ipaddr.rb - A class to manipulate an IP address
|
|
|
|
#
|
|
|
|
# Copyright (c) 2002 Hajimu UMEMOTO <ume@mahoroba.org>.
|
2012-06-02 13:18:32 +04:00
|
|
|
# Copyright (c) 2007, 2009, 2012 Akinori MUSHA <knu@iDaemons.org>.
|
2002-12-23 20:07:49 +03:00
|
|
|
# All rights reserved.
|
|
|
|
#
|
|
|
|
# You can redistribute and/or modify it under the same terms as Ruby.
|
|
|
|
#
|
|
|
|
# $Id$
|
2006-08-05 00:39:28 +04:00
|
|
|
#
|
2008-03-21 15:15:06 +03:00
|
|
|
# Contact:
|
|
|
|
# - Akinori MUSHA <knu@iDaemons.org> (current maintainer)
|
|
|
|
#
|
2002-12-23 20:07:49 +03:00
|
|
|
# TODO:
|
|
|
|
# - scope_id support
|
2008-03-21 15:15:06 +03:00
|
|
|
#
|
2002-12-23 20:07:49 +03:00
|
|
|
require 'socket'
|
|
|
|
|
2006-08-05 00:39:28 +04:00
|
|
|
# IPAddr provides a set of methods to manipulate an IP address. Both IPv4 and
|
|
|
|
# IPv6 are supported.
|
|
|
|
#
|
|
|
|
# == Example
|
|
|
|
#
|
|
|
|
# require 'ipaddr'
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2006-08-05 00:39:28 +04:00
|
|
|
# ipaddr1 = IPAddr.new "3ffe:505:2::1"
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2011-05-19 04:07:25 +04:00
|
|
|
# p ipaddr1 #=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0001/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2011-05-19 04:07:25 +04:00
|
|
|
# p ipaddr1.to_s #=> "3ffe:505:2::1"
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2011-05-19 01:19:18 +04:00
|
|
|
# ipaddr2 = ipaddr1.mask(48) #=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0000/ffff:ffff:ffff:0000:0000:0000:0000:0000>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2011-05-19 04:07:25 +04:00
|
|
|
# p ipaddr2.to_s #=> "3ffe:505:2::"
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2006-08-05 00:39:28 +04:00
|
|
|
# ipaddr3 = IPAddr.new "192.168.2.0/24"
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2011-05-19 04:07:25 +04:00
|
|
|
# p ipaddr3 #=> #<IPAddr: IPv4:192.168.2.0/255.255.255.0>
|
2006-08-05 00:39:28 +04:00
|
|
|
|
2002-12-23 20:07:49 +03:00
|
|
|
class IPAddr
|
2022-12-05 09:31:42 +03:00
|
|
|
VERSION = "1.2.5"
|
2002-12-23 20:07:49 +03:00
|
|
|
|
2011-05-22 06:21:56 +04:00
|
|
|
# 32 bit mask for IPv4
|
2002-12-23 20:07:49 +03:00
|
|
|
IN4MASK = 0xffffffff
|
2016-05-21 05:18:44 +03:00
|
|
|
# 128 bit mask for IPv6
|
2002-12-23 20:07:49 +03:00
|
|
|
IN6MASK = 0xffffffffffffffffffffffffffffffff
|
2012-06-02 13:18:32 +04:00
|
|
|
# Format string for IPv6
|
2021-07-20 04:48:33 +03:00
|
|
|
IN6FORMAT = (["%.4x"] * 8).join(':').freeze
|
2002-12-23 20:07:49 +03:00
|
|
|
|
2012-06-02 13:18:32 +04:00
|
|
|
# Regexp _internally_ used for parsing IPv4 address.
|
|
|
|
RE_IPV4ADDRLIKE = %r{
|
|
|
|
\A
|
|
|
|
(\d+) \. (\d+) \. (\d+) \. (\d+)
|
|
|
|
\z
|
|
|
|
}x
|
|
|
|
|
|
|
|
# Regexp _internally_ used for parsing IPv6 address.
|
|
|
|
RE_IPV6ADDRLIKE_FULL = %r{
|
|
|
|
\A
|
|
|
|
(?:
|
|
|
|
(?: [\da-f]{1,4} : ){7} [\da-f]{1,4}
|
|
|
|
|
|
|
|
|
( (?: [\da-f]{1,4} : ){6} )
|
|
|
|
(\d+) \. (\d+) \. (\d+) \. (\d+)
|
|
|
|
)
|
|
|
|
\z
|
|
|
|
}xi
|
|
|
|
|
|
|
|
# Regexp _internally_ used for parsing IPv6 address.
|
|
|
|
RE_IPV6ADDRLIKE_COMPRESSED = %r{
|
|
|
|
\A
|
|
|
|
( (?: (?: [\da-f]{1,4} : )* [\da-f]{1,4} )? )
|
|
|
|
::
|
|
|
|
( (?:
|
|
|
|
( (?: [\da-f]{1,4} : )* )
|
|
|
|
(?:
|
|
|
|
[\da-f]{1,4}
|
|
|
|
|
|
|
|
|
(\d+) \. (\d+) \. (\d+) \. (\d+)
|
|
|
|
)
|
|
|
|
)? )
|
|
|
|
\z
|
|
|
|
}xi
|
|
|
|
|
2012-08-31 11:30:22 +04:00
|
|
|
# Generic IPAddr related error. Exceptions raised in this class should
|
|
|
|
# inherit from Error.
|
|
|
|
class Error < ArgumentError; end
|
|
|
|
|
|
|
|
# Raised when the provided IP address is an invalid address.
|
|
|
|
class InvalidAddressError < Error; end
|
|
|
|
|
|
|
|
# Raised when the address family is invalid such as an address with an
|
|
|
|
# unsupported family, an address with an inconsistent family, or an address
|
|
|
|
# who's family cannot be determined.
|
|
|
|
class AddressFamilyError < Error; end
|
|
|
|
|
|
|
|
# Raised when the address is an invalid length.
|
|
|
|
class InvalidPrefixError < InvalidAddressError; end
|
|
|
|
|
2002-12-23 20:07:49 +03:00
|
|
|
# Returns the address family of this IP address.
|
2006-07-20 21:36:36 +04:00
|
|
|
attr_reader :family
|
2002-12-23 20:07:49 +03:00
|
|
|
|
|
|
|
# Creates a new ipaddr containing the given network byte ordered
|
|
|
|
# string form of an IP address.
|
2018-12-18 08:09:08 +03:00
|
|
|
def self.new_ntoh(addr)
|
|
|
|
return new(ntop(addr))
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
|
|
|
# Convert a network byte ordered string form of an IP address into
|
|
|
|
# human readable form.
|
2018-12-18 08:09:08 +03:00
|
|
|
def self.ntop(addr)
|
2002-12-23 20:07:49 +03:00
|
|
|
case addr.size
|
|
|
|
when 4
|
2018-10-28 03:13:31 +03:00
|
|
|
addr.unpack('C4').join('.')
|
2002-12-23 20:07:49 +03:00
|
|
|
when 16
|
2018-10-28 03:13:31 +03:00
|
|
|
IN6FORMAT % addr.unpack('n8')
|
2002-12-23 20:07:49 +03:00
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a new ipaddr built by bitwise AND.
|
|
|
|
def &(other)
|
2007-10-04 22:23:22 +04:00
|
|
|
return self.clone.set(@addr & coerce_other(other).to_i)
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a new ipaddr built by bitwise OR.
|
|
|
|
def |(other)
|
2007-10-04 22:23:22 +04:00
|
|
|
return self.clone.set(@addr | coerce_other(other).to_i)
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a new ipaddr built by bitwise right-shift.
|
|
|
|
def >>(num)
|
|
|
|
return self.clone.set(@addr >> num)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a new ipaddr built by bitwise left shift.
|
|
|
|
def <<(num)
|
|
|
|
return self.clone.set(addr_mask(@addr << num))
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a new ipaddr built by bitwise negation.
|
|
|
|
def ~
|
|
|
|
return self.clone.set(addr_mask(~@addr))
|
|
|
|
end
|
|
|
|
|
2007-10-04 22:23:22 +04:00
|
|
|
# Returns true if two ipaddrs are equal.
|
2002-12-23 20:07:49 +03:00
|
|
|
def ==(other)
|
2007-10-04 22:23:22 +04:00
|
|
|
other = coerce_other(other)
|
2016-11-05 16:53:38 +03:00
|
|
|
rescue
|
|
|
|
false
|
|
|
|
else
|
|
|
|
@family == other.family && @addr == other.to_i
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a new ipaddr built by masking IP address with the given
|
|
|
|
# prefixlen/netmask. (e.g. 8, 64, "255.255.255.0", etc.)
|
|
|
|
def mask(prefixlen)
|
|
|
|
return self.clone.mask!(prefixlen)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns true if the given ipaddr is in the range.
|
|
|
|
#
|
|
|
|
# e.g.:
|
|
|
|
# require 'ipaddr'
|
|
|
|
# net1 = IPAddr.new("192.168.2.0/24")
|
2007-10-04 22:23:22 +04:00
|
|
|
# net2 = IPAddr.new("192.168.2.100")
|
|
|
|
# net3 = IPAddr.new("192.168.3.0")
|
2019-10-31 20:06:13 +03:00
|
|
|
# net4 = IPAddr.new("192.168.2.0/16")
|
2011-05-19 04:07:25 +04:00
|
|
|
# p net1.include?(net2) #=> true
|
|
|
|
# p net1.include?(net3) #=> false
|
2019-10-31 20:06:13 +03:00
|
|
|
# p net1.include?(net4) #=> false
|
|
|
|
# p net4.include?(net1) #=> true
|
2002-12-23 20:07:49 +03:00
|
|
|
def include?(other)
|
2021-10-07 18:02:46 +03:00
|
|
|
other = coerce_other(other)
|
|
|
|
return false unless other.family == family
|
2019-10-31 20:06:13 +03:00
|
|
|
range = to_range
|
2021-10-07 18:02:46 +03:00
|
|
|
other = other.to_range
|
2019-10-31 20:06:13 +03:00
|
|
|
range.begin <= other.begin && range.end >= other.end
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
alias === include?
|
|
|
|
|
|
|
|
# Returns the integer representation of the ipaddr.
|
|
|
|
def to_i
|
|
|
|
return @addr
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a string containing the IP address representation.
|
|
|
|
def to_s
|
2003-12-18 09:38:30 +03:00
|
|
|
str = to_string
|
|
|
|
return str if ipv4?
|
|
|
|
|
|
|
|
str.gsub!(/\b0{1,3}([\da-f]+)\b/i, '\1')
|
|
|
|
loop do
|
2012-06-02 13:18:32 +04:00
|
|
|
break if str.sub!(/\A0:0:0:0:0:0:0:0\z/, '::')
|
2003-12-18 09:38:30 +03:00
|
|
|
break if str.sub!(/\b0:0:0:0:0:0:0\b/, ':')
|
|
|
|
break if str.sub!(/\b0:0:0:0:0:0\b/, ':')
|
|
|
|
break if str.sub!(/\b0:0:0:0:0\b/, ':')
|
|
|
|
break if str.sub!(/\b0:0:0:0\b/, ':')
|
|
|
|
break if str.sub!(/\b0:0:0\b/, ':')
|
|
|
|
break if str.sub!(/\b0:0\b/, ':')
|
|
|
|
break
|
|
|
|
end
|
2005-01-19 12:05:50 +03:00
|
|
|
str.sub!(/:{3,}/, '::')
|
2003-12-18 09:38:30 +03:00
|
|
|
|
2012-06-02 13:18:32 +04:00
|
|
|
if /\A::(ffff:)?([\da-f]{1,4}):([\da-f]{1,4})\z/i =~ str
|
2003-12-18 09:38:30 +03:00
|
|
|
str = sprintf('::%s%d.%d.%d.%d', $1, $2.hex / 256, $2.hex % 256, $3.hex / 256, $3.hex % 256)
|
|
|
|
end
|
|
|
|
|
|
|
|
str
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a string containing the IP address representation in
|
|
|
|
# canonical form.
|
|
|
|
def to_string
|
2020-07-13 19:36:06 +03:00
|
|
|
str = _to_string(@addr)
|
|
|
|
|
|
|
|
if @family == Socket::AF_INET6
|
|
|
|
str << zone_id.to_s
|
|
|
|
end
|
|
|
|
|
|
|
|
return str
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
|
|
|
# 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|
|
2011-05-19 01:19:18 +04:00
|
|
|
(@addr >> (112 - 16 * i)) & 0xffff
|
2002-12-23 20:07:49 +03:00
|
|
|
}.pack('n8')
|
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns true if the ipaddr is an IPv4 address.
|
|
|
|
def ipv4?
|
|
|
|
return @family == Socket::AF_INET
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns true if the ipaddr is an IPv6 address.
|
|
|
|
def ipv6?
|
|
|
|
return @family == Socket::AF_INET6
|
|
|
|
end
|
|
|
|
|
2017-10-21 16:34:19 +03:00
|
|
|
# Returns true if the ipaddr is a loopback address.
|
|
|
|
def loopback?
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
@addr & 0xff000000 == 0x7f000000
|
|
|
|
when Socket::AF_INET6
|
|
|
|
@addr == 1
|
|
|
|
else
|
|
|
|
raise AddressFamilyError, "unsupported address family"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns true if the ipaddr is a private address. IPv4 addresses
|
|
|
|
# in 10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16 as defined in RFC
|
|
|
|
# 1918 and IPv6 Unique Local Addresses in fc00::/7 as defined in RFC
|
|
|
|
# 4193 are considered private.
|
|
|
|
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
|
|
|
|
when Socket::AF_INET6
|
|
|
|
@addr & 0xfe00_0000_0000_0000_0000_0000_0000_0000 == 0xfc00_0000_0000_0000_0000_0000_0000_0000
|
|
|
|
else
|
|
|
|
raise AddressFamilyError, "unsupported address family"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns true if the ipaddr is a link-local 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.
|
|
|
|
def link_local?
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
@addr & 0xffff0000 == 0xa9fe0000 # 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
|
|
|
|
else
|
|
|
|
raise AddressFamilyError, "unsupported address family"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2002-12-23 20:07:49 +03:00
|
|
|
# Returns true if the ipaddr is an IPv4-mapped IPv6 address.
|
|
|
|
def ipv4_mapped?
|
|
|
|
return ipv6? && (@addr >> 32) == 0xffff
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns true if the ipaddr is an IPv4-compatible IPv6 address.
|
|
|
|
def ipv4_compat?
|
2017-12-12 14:56:25 +03:00
|
|
|
warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE
|
2017-10-21 16:34:19 +03:00
|
|
|
_ipv4_compat?
|
|
|
|
end
|
|
|
|
|
|
|
|
def _ipv4_compat?
|
2002-12-23 20:07:49 +03:00
|
|
|
if !ipv6? || (@addr >> 32) != 0
|
|
|
|
return false
|
|
|
|
end
|
|
|
|
a = (@addr & IN4MASK)
|
|
|
|
return a != 0 && a != 1
|
|
|
|
end
|
|
|
|
|
2017-10-21 16:34:19 +03:00
|
|
|
private :_ipv4_compat?
|
|
|
|
|
2002-12-23 20:07:49 +03:00
|
|
|
# Returns a new ipaddr built by converting the native IPv4 address
|
|
|
|
# into an IPv4-mapped IPv6 address.
|
|
|
|
def ipv4_mapped
|
|
|
|
if !ipv4?
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidAddressError, "not an IPv4 address: #{@addr}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
2021-10-07 18:02:46 +03:00
|
|
|
clone = self.clone.set(@addr | 0xffff00000000, Socket::AF_INET6)
|
|
|
|
clone.instance_variable_set(:@mask_addr, @mask_addr | 0xffffffffffffffffffffffff00000000)
|
|
|
|
clone
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a new ipaddr built by converting the native IPv4 address
|
|
|
|
# into an IPv4-compatible IPv6 address.
|
|
|
|
def ipv4_compat
|
2017-12-12 14:56:25 +03:00
|
|
|
warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE
|
2002-12-23 20:07:49 +03:00
|
|
|
if !ipv4?
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidAddressError, "not an IPv4 address: #{@addr}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
return self.clone.set(@addr, Socket::AF_INET6)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a new ipaddr built by converting the IPv6 address into a
|
|
|
|
# native IPv4 address. If the IP address is not an IPv4-mapped or
|
|
|
|
# IPv4-compatible IPv6 address, returns self.
|
|
|
|
def native
|
2017-10-21 16:34:19 +03:00
|
|
|
if !ipv4_mapped? && !_ipv4_compat?
|
2002-12-23 20:07:49 +03:00
|
|
|
return self
|
|
|
|
end
|
|
|
|
return self.clone.set(@addr & IN4MASK, Socket::AF_INET)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a string for DNS reverse lookup. It returns a string in
|
|
|
|
# RFC3172 form for an IPv6 address.
|
|
|
|
def reverse
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
return _reverse + ".in-addr.arpa"
|
|
|
|
when Socket::AF_INET6
|
|
|
|
return ip6_arpa
|
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a string for DNS reverse lookup compatible with RFC3172.
|
|
|
|
def ip6_arpa
|
|
|
|
if !ipv6?
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidAddressError, "not an IPv6 address: #{@addr}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
return _reverse + ".ip6.arpa"
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a string for DNS reverse lookup compatible with RFC1886.
|
|
|
|
def ip6_int
|
|
|
|
if !ipv6?
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidAddressError, "not an IPv6 address: #{@addr}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
return _reverse + ".ip6.int"
|
|
|
|
end
|
|
|
|
|
2007-10-04 22:56:32 +04:00
|
|
|
# Returns the successor to the ipaddr.
|
|
|
|
def succ
|
|
|
|
return self.clone.set(@addr + 1, @family)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Compares the ipaddr with another.
|
|
|
|
def <=>(other)
|
|
|
|
other = coerce_other(other)
|
2016-11-05 16:53:38 +03:00
|
|
|
rescue
|
|
|
|
nil
|
|
|
|
else
|
|
|
|
@addr <=> other.to_i if other.family == @family
|
2007-10-04 22:56:32 +04:00
|
|
|
end
|
|
|
|
include Comparable
|
|
|
|
|
2009-08-04 10:10:42 +04:00
|
|
|
# Checks equality used by Hash.
|
|
|
|
def eql?(other)
|
|
|
|
return self.class == other.class && self.hash == other.hash && self == other
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a hash value used by Hash, Set, and Array classes
|
|
|
|
def hash
|
2020-07-13 19:36:06 +03:00
|
|
|
return ([@addr, @mask_addr, @zone_id].hash << 1) | (ipv4? ? 0 : 1)
|
2009-08-04 10:10:42 +04:00
|
|
|
end
|
|
|
|
|
2007-10-04 22:56:32 +04:00
|
|
|
# Creates a Range object for the network address.
|
|
|
|
def to_range
|
|
|
|
begin_addr = (@addr & @mask_addr)
|
|
|
|
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
end_addr = (@addr | (IN4MASK ^ @mask_addr))
|
|
|
|
when Socket::AF_INET6
|
|
|
|
end_addr = (@addr | (IN6MASK ^ @mask_addr))
|
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2007-10-04 22:56:32 +04:00
|
|
|
end
|
|
|
|
|
2021-12-13 12:12:07 +03:00
|
|
|
self.class.new(begin_addr, @family)..self.class.new(end_addr, @family)
|
2007-10-04 22:56:32 +04:00
|
|
|
end
|
|
|
|
|
2017-10-21 16:34:19 +03:00
|
|
|
# Returns the prefix length in bits for the ipaddr.
|
|
|
|
def prefix
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
n = IN4MASK ^ @mask_addr
|
|
|
|
i = 32
|
|
|
|
when Socket::AF_INET6
|
|
|
|
n = IN6MASK ^ @mask_addr
|
|
|
|
i = 128
|
|
|
|
else
|
|
|
|
raise AddressFamilyError, "unsupported address family"
|
|
|
|
end
|
|
|
|
while n.positive?
|
|
|
|
n >>= 1
|
|
|
|
i -= 1
|
|
|
|
end
|
|
|
|
i
|
|
|
|
end
|
|
|
|
|
|
|
|
# Sets the prefix length in bits
|
|
|
|
def prefix=(prefix)
|
|
|
|
case prefix
|
|
|
|
when Integer
|
|
|
|
mask!(prefix)
|
|
|
|
else
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidPrefixError, "prefix must be an integer: #{@addr}"
|
2017-10-21 16:34:19 +03:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2002-12-23 20:07:49 +03:00
|
|
|
# Returns a string containing a human-readable representation of the
|
|
|
|
# ipaddr. ("#<IPAddr: family:address/mask>")
|
|
|
|
def inspect
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
af = "IPv4"
|
|
|
|
when Socket::AF_INET6
|
|
|
|
af = "IPv6"
|
2020-07-13 19:36:06 +03:00
|
|
|
zone_id = @zone_id.to_s
|
2002-12-23 20:07:49 +03:00
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
2020-07-13 19:36:06 +03:00
|
|
|
return sprintf("#<%s: %s:%s%s/%s>", self.class.name,
|
|
|
|
af, _to_string(@addr), zone_id, _to_string(@mask_addr))
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
2019-10-09 13:23:27 +03:00
|
|
|
# Returns the netmask in string format e.g. 255.255.0.0
|
|
|
|
def netmask
|
|
|
|
_to_string(@mask_addr)
|
|
|
|
end
|
|
|
|
|
2020-07-13 19:36:06 +03:00
|
|
|
# Returns the IPv6 zone identifier, if present.
|
|
|
|
# Raises InvalidAddressError if not an IPv6 address.
|
|
|
|
def zone_id
|
|
|
|
if @family == Socket::AF_INET6
|
|
|
|
@zone_id
|
|
|
|
else
|
|
|
|
raise InvalidAddressError, "not an IPv6 address"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns the IPv6 zone identifier, if present.
|
|
|
|
# Raises InvalidAddressError if not an IPv6 address.
|
|
|
|
def zone_id=(zid)
|
|
|
|
if @family == Socket::AF_INET6
|
|
|
|
case zid
|
|
|
|
when nil, /\A%(\w+)\z/
|
|
|
|
@zone_id = zid
|
|
|
|
else
|
|
|
|
raise InvalidAddressError, "invalid zone identifier for address"
|
|
|
|
end
|
|
|
|
else
|
|
|
|
raise InvalidAddressError, "not an IPv6 address"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2002-12-23 20:07:49 +03:00
|
|
|
protected
|
|
|
|
|
2011-05-22 06:21:56 +04:00
|
|
|
# Set +@addr+, the internal stored ip address, to given +addr+. The
|
|
|
|
# parameter +addr+ is validated using the first +family+ member,
|
|
|
|
# which is +Socket::AF_INET+ or +Socket::AF_INET6+.
|
2002-12-23 20:07:49 +03:00
|
|
|
def set(addr, *family)
|
|
|
|
case family[0] ? family[0] : @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
if addr < 0 || addr > IN4MASK
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidAddressError, "invalid address: #{@addr}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
when Socket::AF_INET6
|
|
|
|
if addr < 0 || addr > IN6MASK
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidAddressError, "invalid address: #{@addr}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
@addr = addr
|
|
|
|
if family[0]
|
|
|
|
@family = family[0]
|
2021-12-02 12:56:39 +03:00
|
|
|
if @family == Socket::AF_INET
|
|
|
|
@mask_addr &= IN4MASK
|
|
|
|
end
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
return self
|
|
|
|
end
|
|
|
|
|
2012-08-21 08:50:18 +04:00
|
|
|
# Set current netmask to given mask.
|
2002-12-23 20:07:49 +03:00
|
|
|
def mask!(mask)
|
2017-10-21 16:34:19 +03:00
|
|
|
case mask
|
|
|
|
when String
|
2019-06-05 04:58:15 +03:00
|
|
|
case mask
|
|
|
|
when /\A(0|[1-9]+\d*)\z/
|
2011-05-19 01:19:18 +04:00
|
|
|
prefixlen = mask.to_i
|
2019-06-05 04:58:15 +03:00
|
|
|
when /\A\d+\z/
|
|
|
|
raise InvalidPrefixError, "leading zeros in prefix"
|
2002-12-23 20:07:49 +03:00
|
|
|
else
|
2011-05-19 01:19:18 +04:00
|
|
|
m = IPAddr.new(mask)
|
|
|
|
if m.family != @family
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidPrefixError, "address family is not same: #{@addr}"
|
2011-05-19 01:19:18 +04:00
|
|
|
end
|
|
|
|
@mask_addr = m.to_i
|
2017-10-21 16:34:19 +03:00
|
|
|
n = @mask_addr ^ m.instance_variable_get(:@mask_addr)
|
|
|
|
unless ((n + 1) & n).zero?
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidPrefixError, "invalid mask #{mask}: #{@addr}"
|
2017-10-21 16:34:19 +03:00
|
|
|
end
|
2011-05-19 01:19:18 +04:00
|
|
|
@addr &= @mask_addr
|
|
|
|
return self
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
else
|
|
|
|
prefixlen = mask
|
|
|
|
end
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
if prefixlen < 0 || prefixlen > 32
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidPrefixError, "invalid length: #{@addr}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
masklen = 32 - prefixlen
|
|
|
|
@mask_addr = ((IN4MASK >> masklen) << masklen)
|
|
|
|
when Socket::AF_INET6
|
|
|
|
if prefixlen < 0 || prefixlen > 128
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidPrefixError, "invalid length: #{@addr}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
masklen = 128 - prefixlen
|
|
|
|
@mask_addr = ((IN6MASK >> masklen) << masklen)
|
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
@addr = ((@addr >> masklen) << masklen)
|
|
|
|
return self
|
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
2007-10-04 22:23:22 +04:00
|
|
|
# Creates a new ipaddr object either from a human readable IP
|
|
|
|
# address representation in string, or from a packed in_addr value
|
|
|
|
# followed by an address family.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2007-10-04 22:23:22 +04:00
|
|
|
# In the former case, the following are the valid formats that will
|
|
|
|
# be recognized: "address", "address/prefixlen" and "address/mask",
|
|
|
|
# where IPv6 address may be enclosed in square brackets (`[' and
|
|
|
|
# `]'). If a prefixlen or a mask is specified, it returns a masked
|
|
|
|
# IP address. Although the address family is determined
|
|
|
|
# automatically from a specified string, you can specify one
|
|
|
|
# explicitly by the optional second argument.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2010-03-20 06:30:59 +03:00
|
|
|
# Otherwise an IP address is generated from a packed in_addr value
|
2007-10-04 22:23:22 +04:00
|
|
|
# and an address family.
|
2002-12-23 20:07:49 +03:00
|
|
|
#
|
2007-10-04 22:23:22 +04:00
|
|
|
# The IPAddr class defines many methods and operators, and some of
|
|
|
|
# those, such as &, |, include? and ==, accept a string, or a packed
|
|
|
|
# in_addr value instead of an IPAddr object.
|
2002-12-23 20:07:49 +03:00
|
|
|
def initialize(addr = '::', family = Socket::AF_UNSPEC)
|
2021-12-13 12:12:07 +03:00
|
|
|
@mask_addr = nil
|
2002-12-23 20:07:49 +03:00
|
|
|
if !addr.kind_of?(String)
|
2007-10-04 22:23:22 +04:00
|
|
|
case family
|
|
|
|
when Socket::AF_INET, Socket::AF_INET6
|
|
|
|
set(addr.to_i, family)
|
|
|
|
@mask_addr = (family == Socket::AF_INET) ? IN4MASK : IN6MASK
|
|
|
|
return
|
|
|
|
when Socket::AF_UNSPEC
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "address family must be specified"
|
2007-10-04 22:23:22 +04:00
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family: #{family}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
end
|
2019-05-07 02:39:42 +03:00
|
|
|
prefix, prefixlen = addr.split('/', 2)
|
2015-10-23 10:35:14 +03:00
|
|
|
if prefix =~ /\A\[(.*)\]\z/i
|
2002-12-23 20:07:49 +03:00
|
|
|
prefix = $1
|
|
|
|
family = Socket::AF_INET6
|
|
|
|
end
|
2020-07-13 19:36:06 +03:00
|
|
|
if prefix =~ /\A(.*)(%\w+)\z/
|
|
|
|
prefix = $1
|
|
|
|
zone_id = $2
|
|
|
|
family = Socket::AF_INET6
|
|
|
|
end
|
2002-12-23 20:07:49 +03:00
|
|
|
# It seems AI_NUMERICHOST doesn't do the job.
|
|
|
|
#Socket.getaddrinfo(left, nil, Socket::AF_INET6, Socket::SOCK_STREAM, nil,
|
2011-05-19 04:07:25 +04:00
|
|
|
# Socket::AI_NUMERICHOST)
|
2002-12-23 20:07:49 +03:00
|
|
|
@addr = @family = nil
|
|
|
|
if family == Socket::AF_UNSPEC || family == Socket::AF_INET
|
|
|
|
@addr = in_addr(prefix)
|
|
|
|
if @addr
|
2011-05-19 01:19:18 +04:00
|
|
|
@family = Socket::AF_INET
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
end
|
|
|
|
if !@addr && (family == Socket::AF_UNSPEC || family == Socket::AF_INET6)
|
|
|
|
@addr = in6_addr(prefix)
|
|
|
|
@family = Socket::AF_INET6
|
|
|
|
end
|
2020-07-13 19:36:06 +03:00
|
|
|
@zone_id = zone_id
|
2002-12-23 20:07:49 +03:00
|
|
|
if family != Socket::AF_UNSPEC && @family != family
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "address family mismatch"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
if prefixlen
|
|
|
|
mask!(prefixlen)
|
|
|
|
else
|
2008-07-07 12:12:23 +04:00
|
|
|
@mask_addr = (@family == Socket::AF_INET) ? IN4MASK : IN6MASK
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2007-10-04 22:23:22 +04:00
|
|
|
def coerce_other(other)
|
|
|
|
case other
|
|
|
|
when IPAddr
|
|
|
|
other
|
|
|
|
when String
|
|
|
|
self.class.new(other)
|
|
|
|
else
|
|
|
|
self.class.new(other, @family)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2002-12-23 20:07:49 +03:00
|
|
|
def in_addr(addr)
|
2012-06-02 13:18:32 +04:00
|
|
|
case addr
|
|
|
|
when Array
|
|
|
|
octets = addr
|
|
|
|
else
|
|
|
|
m = RE_IPV4ADDRLIKE.match(addr) or return nil
|
|
|
|
octets = m.captures
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
2012-06-02 13:18:32 +04:00
|
|
|
octets.inject(0) { |i, s|
|
2019-05-08 04:44:42 +03:00
|
|
|
(n = s.to_i) < 256 or raise InvalidAddressError, "invalid address: #{@addr}"
|
|
|
|
s.match(/\A0./) and raise InvalidAddressError, "zero-filled number in IPv4 address is ambiguous: #{@addr}"
|
2012-06-02 13:18:32 +04:00
|
|
|
i << 8 | n
|
|
|
|
}
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
|
|
|
def in6_addr(left)
|
|
|
|
case left
|
2012-06-02 13:18:32 +04:00
|
|
|
when RE_IPV6ADDRLIKE_FULL
|
|
|
|
if $2
|
|
|
|
addr = in_addr($~[2,4])
|
|
|
|
left = $1 + ':'
|
|
|
|
else
|
|
|
|
addr = 0
|
|
|
|
end
|
2002-12-23 20:07:49 +03:00
|
|
|
right = ''
|
2012-06-02 13:18:32 +04:00
|
|
|
when RE_IPV6ADDRLIKE_COMPRESSED
|
|
|
|
if $4
|
2019-05-08 04:44:42 +03:00
|
|
|
left.count(':') <= 6 or raise InvalidAddressError, "invalid address: #{@addr}"
|
2012-06-02 13:18:32 +04:00
|
|
|
addr = in_addr($~[4,4])
|
|
|
|
left = $1
|
|
|
|
right = $3 + '0:0'
|
|
|
|
else
|
2013-02-18 11:31:17 +04:00
|
|
|
left.count(':') <= ($1.empty? || $2.empty? ? 8 : 7) or
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidAddressError, "invalid address: #{@addr}"
|
2012-06-02 13:18:32 +04:00
|
|
|
left = $1
|
|
|
|
right = $2
|
|
|
|
addr = 0
|
|
|
|
end
|
|
|
|
else
|
2019-05-08 04:44:42 +03:00
|
|
|
raise InvalidAddressError, "invalid address: #{@addr}"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
l = left.split(':')
|
|
|
|
r = right.split(':')
|
|
|
|
rest = 8 - l.size - r.size
|
|
|
|
if rest < 0
|
|
|
|
return nil
|
|
|
|
end
|
2012-06-02 13:18:32 +04:00
|
|
|
(l + Array.new(rest, '0') + r).inject(0) { |i, s|
|
2007-10-04 23:03:56 +04:00
|
|
|
i << 16 | s.hex
|
2012-06-02 13:18:32 +04:00
|
|
|
} | addr
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
|
|
|
|
def addr_mask(addr)
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
2007-10-04 23:03:56 +04:00
|
|
|
return addr & IN4MASK
|
2002-12-23 20:07:49 +03:00
|
|
|
when Socket::AF_INET6
|
2007-10-04 23:03:56 +04:00
|
|
|
return addr & IN6MASK
|
2002-12-23 20:07:49 +03:00
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def _reverse
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
return (0..3).map { |i|
|
2011-05-19 01:19:18 +04:00
|
|
|
(@addr >> (8 * i)) & 0xff
|
2002-12-23 20:07:49 +03:00
|
|
|
}.join('.')
|
|
|
|
when Socket::AF_INET6
|
|
|
|
return ("%.32x" % @addr).reverse!.gsub!(/.(?!$)/, '\&.')
|
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def _to_string(addr)
|
|
|
|
case @family
|
|
|
|
when Socket::AF_INET
|
|
|
|
return (0..3).map { |i|
|
2011-05-19 01:19:18 +04:00
|
|
|
(addr >> (24 - 8 * i)) & 0xff
|
2002-12-23 20:07:49 +03:00
|
|
|
}.join('.')
|
|
|
|
when Socket::AF_INET6
|
|
|
|
return (("%.32x" % addr).gsub!(/.{4}(?!$)/, '\&:'))
|
|
|
|
else
|
2012-08-31 11:30:22 +04:00
|
|
|
raise AddressFamilyError, "unsupported address family"
|
2002-12-23 20:07:49 +03:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
end
|
|
|
|
|
2012-11-16 20:55:29 +04:00
|
|
|
unless Socket.const_defined? :AF_INET6
|
2012-06-02 13:18:32 +04:00
|
|
|
class Socket < BasicSocket
|
|
|
|
# IPv6 protocol family
|
2021-07-20 04:48:33 +03:00
|
|
|
AF_INET6 = Object.new.freeze
|
2012-06-02 13:18:32 +04:00
|
|
|
end
|
|
|
|
|
|
|
|
class << IPSocket
|
|
|
|
private
|
|
|
|
|
|
|
|
def valid_v6?(addr)
|
|
|
|
case addr
|
|
|
|
when IPAddr::RE_IPV6ADDRLIKE_FULL
|
|
|
|
if $2
|
|
|
|
$~[2,4].all? {|i| i.to_i < 256 }
|
|
|
|
else
|
|
|
|
true
|
|
|
|
end
|
|
|
|
when IPAddr::RE_IPV6ADDRLIKE_COMPRESSED
|
|
|
|
if $4
|
|
|
|
addr.count(':') <= 6 && $~[4,4].all? {|i| i.to_i < 256}
|
|
|
|
else
|
|
|
|
addr.count(':') <= 7
|
|
|
|
end
|
|
|
|
else
|
|
|
|
false
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
alias getaddress_orig getaddress
|
|
|
|
|
|
|
|
public
|
|
|
|
|
|
|
|
# Returns a +String+ based representation of a valid DNS hostname,
|
|
|
|
# IPv4 or IPv6 address.
|
2012-08-21 08:50:18 +04:00
|
|
|
#
|
2012-06-02 13:18:32 +04:00
|
|
|
# IPSocket.getaddress 'localhost' #=> "::1"
|
|
|
|
# IPSocket.getaddress 'broadcasthost' #=> "255.255.255.255"
|
|
|
|
# IPSocket.getaddress 'www.ruby-lang.org' #=> "221.186.184.68"
|
|
|
|
# IPSocket.getaddress 'www.ccc.de' #=> "2a00:1328:e102:ccc0::122"
|
|
|
|
def getaddress(s)
|
|
|
|
if valid_v6?(s)
|
|
|
|
s
|
|
|
|
else
|
|
|
|
getaddress_orig(s)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|