класс IPAddr
IPAddr предоставляет набор методов для работы с IP-адресами. Поддерживаются как IPv4, так и IPv6.
Пример
require 'ipaddr' ipaddr1 = IPAddr.new "3ffe:505:2::1" p ipaddr1 #=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0001/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff> p ipaddr1.to_s #=> "3ffe:505:2::1" ipaddr2 = ipaddr1.mask(48) #=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0000/ffff:ffff:ffff:0000:0000:0000:0000:0000> p ipaddr2.to_s #=> "3ffe:505:2::" ipaddr3 = IPAddr.new "192.168.2.0/24" p ipaddr3 #=> #<IPAddr: IPv4:192.168.2.0/255.255.255.0>
Константы
- IN4MASK
-
32-битный массив для IPv4
- IN6FORMAT
-
Строка формата для IPv6
- IN6MASK
-
128-битный массив для IPv6
- RE_IPV4ADDRLIKE
-
Регулярное выражение внутренне используемое для разбора IP-адреса IPv4.
- RE_IPV6ADDRLIKE_COMPRESSED
-
Регулярное выражение внутренне используемое для разбора IP-адреса IPv6.
- RE_IPV6ADDRLIKE_FULL
-
Регулярное выражение внутренне используемое для разбора IP-адреса IPv6.
Атрибуты
Возвращает семейство адресов этого IP-адреса.
Публичные методы класса
# File lib/ipaddr.rb, line 470
def initialize(addr = '::', family = Socket::AF_UNSPEC)
if !addr.kind_of?(String)
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
raise AddressFamilyError, "address family must be specified"
else
raise AddressFamilyError, "unsupported address family: #{family}"
end
end
prefix, prefixlen = addr.split('/')
if prefix =~ /\A\[(.*)\]\z/i
prefix = $1
family = Socket::AF_INET6
end
# It seems AI_NUMERICHOST doesn't do the job.
#Socket.getaddrinfo(left, nil, Socket::AF_INET6, Socket::SOCK_STREAM, nil,
# Socket::AI_NUMERICHOST)
@addr = @family = nil
if family == Socket::AF_UNSPEC || family == Socket::AF_INET
@addr = in_addr(prefix)
if @addr
@family = Socket::AF_INET
end
end
if !@addr && (family == Socket::AF_UNSPEC || family == Socket::AF_INET6)
@addr = in6_addr(prefix)
@family = Socket::AF_INET6
end
if family != Socket::AF_UNSPEC && @family != family
raise AddressFamilyError, "address family mismatch"
end
if prefixlen
mask!(prefixlen)
else
@mask_addr = (@family == Socket::AF_INET) ? IN4MASK : IN6MASK
end
end Создаёт новый объект ipaddr, либо из удобочитаемой строки представления IP-адреса, либо из упакованного значения #in_addr с семейством адресов.
В первом случае, распознаются следующие форматы: “адрес”, “адрес/длина_префикса” и “адрес/маска”, где IP-адрес IPv6 может быть заключен в квадратные скобки (`[' и `]'). Если указана длина префикса или маска, возвращается замаскированный IP-адрес. Несмотря на то, что семейство адресов определяется автоматически из указанной строки, вы можете явно указать его в качестве второго аргумента.
В противном случае, IP-адрес генерируется из упакованного значения #in_addr и семейства адресов.
Класс IPAddr определяет множество методов и операторов, некоторые из которых, такие как &, |, include? и ==, принимают строку или упакованное значение #in_addr вместо объекта IPAddr.
# File lib/ipaddr.rb, line 105 def IPAddr::new_ntoh(addr) return IPAddr.new(IPAddr::ntop(addr)) end
Создаёт новый ipaddr, содержащий указанную строку IP-адреса в сетевом порядке байтов.
# File lib/ipaddr.rb, line 111
def IPAddr::ntop(addr)
case addr.size
when 4
s = addr.unpack('C4').join('.')
when 16
s = IN6FORMAT % addr.unpack('n8')
else
raise AddressFamilyError, "unsupported address family"
end
return s
end Преобразует строку IP-адреса в сетевом порядке байтов в удобочитаемый вид.
Общедоступные методы экземпляров
# File lib/ipaddr.rb, line 124 def &(other) return self.clone.set(@addr & coerce_other(other).to_i) end
Возвращает новый ipaddr, созданный с помощью побитового И.
# File lib/ipaddr.rb, line 139 def <<(num) return self.clone.set(addr_mask(@addr << num)) end
Возвращает новый ipaddr, созданный с помощью побитового сдвига влево.
# File lib/ipaddr.rb, line 338 def <=>(other) other = coerce_other(other) rescue nil else @addr <=> other.to_i if other.family == @family end
Сравнивает ipaddr с другим.
# File lib/ipaddr.rb, line 149 def ==(other) other = coerce_other(other) rescue false else @family == other.family && @addr == other.to_i end
Возвращает true, если два ipaddr равны.
# File lib/ipaddr.rb, line 134 def >>(num) return self.clone.set(@addr >> num) end
Возвращает новый ipaddr, созданный с помощью побитового сдвига вправо.
# File lib/ipaddr.rb, line 348 def eql?(other) return self.class == other.class && self.hash == other.hash && self == other end
Проверяет равенство, используемое методом Hash.
# File lib/ipaddr.rb, line 238
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')
else
raise AddressFamilyError, "unsupported address family"
end
end Возвращает строку IP-адреса в сетевом порядке байтов.
# File lib/ipaddr.rb, line 172
def include?(other)
other = coerce_other(other)
if ipv4_mapped?
if (@mask_addr >> 32) != 0xffffffffffffffffffffffff
return false
end
mask_addr = (@mask_addr & IN4MASK)
addr = (@addr & IN4MASK)
family = Socket::AF_INET
else
mask_addr = @mask_addr
addr = @addr
family = @family
end
if other.ipv4_mapped?
other_addr = (other.to_i & IN4MASK)
other_family = Socket::AF_INET
else
other_addr = other.to_i
other_family = other.family
end
if family != other_family
return false
end
return ((addr & mask_addr) == (other_addr & mask_addr))
end Возвращает true, если заданный ipaddr находится в диапазоне.
Например:
require 'ipaddr'
net1 = IPAddr.new("192.168.2.0/24")
net2 = IPAddr.new("192.168.2.100")
net3 = IPAddr.new("192.168.3.0")
p net1.include?(net2) #=> true
p net1.include?(net3) #=> false
# File lib/ipaddr.rb, line 375
def inspect
case @family
when Socket::AF_INET
af = "IPv4"
when Socket::AF_INET6
af = "IPv6"
else
raise AddressFamilyError, "unsupported address family"
end
return sprintf("#<%s: %s:%s/%s>", self.class.name,
af, _to_string(@addr), _to_string(@mask_addr))
end Возвращает строку с удобочитаемым представлением ipaddr. («#<IPAddr: family:address/mask>»)
# File lib/ipaddr.rb, line 317
def ip6_arpa
if !ipv6?
raise InvalidAddressError, "not an IPv6 address"
end
return _reverse + ".ip6.arpa"
end Возвращает строку для обратного поиска DNS, совместимую с RFC3172.
# File lib/ipaddr.rb, line 325
def ip6_int
if !ipv6?
raise InvalidAddressError, "not an IPv6 address"
end
return _reverse + ".ip6.int"
end Возвращает строку для обратного поиска DNS, совместимую с RFC1886.
# File lib/ipaddr.rb, line 252 def ipv4? return @family == Socket::AF_INET end
Возвращает true, если ipaddr является IPv4-адресом.
# File lib/ipaddr.rb, line 286
def ipv4_compat
if !ipv4?
raise InvalidAddressError, "not an IPv4 address"
end
return self.clone.set(@addr, Socket::AF_INET6)
end Возвращает новый ipaddr, созданный путем преобразования нативного IPv4-адреса в IPv4-совместимый IPv6-адрес.
# File lib/ipaddr.rb, line 267
def ipv4_compat?
if !ipv6? || (@addr >> 32) != 0
return false
end
a = (@addr & IN4MASK)
return a != 0 && a != 1
end Возвращает true, если ipaddr является IPv4-совместимым IPv6-адресом.
# File lib/ipaddr.rb, line 277
def ipv4_mapped
if !ipv4?
raise InvalidAddressError, "not an IPv4 address"
end
return self.clone.set(@addr | 0xffff00000000, Socket::AF_INET6)
end Возвращает новый ipaddr, созданный путем преобразования нативного IPv4-адреса в IPv4-отображаемый IPv6-адрес.
# File lib/ipaddr.rb, line 262 def ipv4_mapped? return ipv6? && (@addr >> 32) == 0xffff end
Возвращает true, если ipaddr является IPv4-отображаемым IPv6-адресом.
# File lib/ipaddr.rb, line 257 def ipv6? return @family == Socket::AF_INET6 end
Возвращает true, если ipaddr является IPv6-адресом.
# File lib/ipaddr.rb, line 159 def mask(prefixlen) return self.clone.mask!(prefixlen) end
Возвращает новый ipaddr, созданный путем маскирования IP-адреса заданным префиксом/маской. (например, 8, 64, «255.255.255.0» и т. д.).
# File lib/ipaddr.rb, line 296
def native
if !ipv4_mapped? && !ipv4_compat?
return self
end
return self.clone.set(@addr & IN4MASK, Socket::AF_INET)
end Возвращает новый ipaddr, созданный путем преобразования IPv6-адреса в нативный IPv4-адрес. Если IP-адрес не является IPv4-отображаемым или IPv4-совместимым IPv6-адресом, возвращает self.
# File lib/ipaddr.rb, line 305
def reverse
case @family
when Socket::AF_INET
return _reverse + ".in-addr.arpa"
when Socket::AF_INET6
return ip6_arpa
else
raise AddressFamilyError, "unsupported address family"
end
end Возвращает строку для обратного поиска DNS. Для IPv6-адресов возвращает строку в формате RFC3172.
# File lib/ipaddr.rb, line 333 def succ return self.clone.set(@addr + 1, @family) end
Возвращает преемника ipaddr.
# File lib/ipaddr.rb, line 202 def to_i return @addr end
Возвращает целое числовое представление ipaddr.
# File lib/ipaddr.rb, line 358
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
raise AddressFamilyError, "unsupported address family"
end
return clone.set(begin_addr, @family)..clone.set(end_addr, @family)
end Создает объект Range для сетевого адреса.
# File lib/ipaddr.rb, line 207
def to_s
str = to_string
return str if ipv4?
str.gsub!(/\b0{1,3}([\da-f]+)\b/i, '\1')
loop do
break if str.sub!(/\A0:0:0:0:0:0:0:0\z/, '::')
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
str.sub!(/:{3,}/, '::')
if /\A::(ffff:)?([\da-f]{1,4}):([\da-f]{1,4})\z/i =~ str
str = sprintf('::%s%d.%d.%d.%d', $1, $2.hex / 256, $2.hex % 256, $3.hex / 256, $3.hex % 256)
end
str
end Возвращает строку, содержащую представление IP-адреса.
# File lib/ipaddr.rb, line 233 def to_string return _to_string(@addr) end
Возвращает строку, содержащую представление IP-адреса в канонической форме.
# File lib/ipaddr.rb, line 129 def |(other) return self.clone.set(@addr | coerce_other(other).to_i) end
Возвращает новый ipaddr, созданный с помощью побитового ИЛИ.
# File lib/ipaddr.rb, line 144 def ~ return self.clone.set(addr_mask(~@addr)) end
Возвращает новый ipaddr, построенный путём поразрядного отрицания.
Защищенные методы экземпляра
# File lib/ipaddr.rb, line 414
def mask!(mask)
if mask.kind_of?(String)
if mask =~ /\A\d+\z/
prefixlen = mask.to_i
else
m = IPAddr.new(mask)
if m.family != @family
raise InvalidPrefixError, "address family is not same"
end
@mask_addr = m.to_i
@addr &= @mask_addr
return self
end
else
prefixlen = mask
end
case @family
when Socket::AF_INET
if prefixlen < 0 || prefixlen > 32
raise InvalidPrefixError, "invalid length"
end
masklen = 32 - prefixlen
@mask_addr = ((IN4MASK >> masklen) << masklen)
when Socket::AF_INET6
if prefixlen < 0 || prefixlen > 128
raise InvalidPrefixError, "invalid length"
end
masklen = 128 - prefixlen
@mask_addr = ((IN6MASK >> masklen) << masklen)
else
raise AddressFamilyError, "unsupported address family"
end
@addr = ((@addr >> masklen) << masklen)
return self
end Установить текущую маску сети на заданную маску.
# File lib/ipaddr.rb, line 393
def set(addr, *family)
case family[0] ? family[0] : @family
when Socket::AF_INET
if addr < 0 || addr > IN4MASK
raise InvalidAddressError, "invalid address"
end
when Socket::AF_INET6
if addr < 0 || addr > IN6MASK
raise InvalidAddressError, "invalid address"
end
else
raise AddressFamilyError, "unsupported address family"
end
@addr = addr
if family[0]
@family = family[0]
end
return self
end Установить +@addr+, внутренний сохранённый IP-адрес, на заданное значение addr. Параметр addr проверяется с использованием первого family члена, который является Socket::AF_INET или Socket::AF_INET6.
Приватные методы экземпляра
# File lib/ipaddr.rb, line 586
def _reverse
case @family
when Socket::AF_INET
return (0..3).map { |i|
(@addr >> (8 * i)) & 0xff
}.join('.')
when Socket::AF_INET6
return ("%.32x" % @addr).reverse!.gsub!(/.(?!$)/, '\&.')
else
raise AddressFamilyError, "unsupported address family"
end
end # File lib/ipaddr.rb, line 599
def _to_string(addr)
case @family
when Socket::AF_INET
return (0..3).map { |i|
(addr >> (24 - 8 * i)) & 0xff
}.join('.')
when Socket::AF_INET6
return (("%.32x" % addr).gsub!(/.{4}(?!$)/, '\&:'))
else
raise AddressFamilyError, "unsupported address family"
end
end # File lib/ipaddr.rb, line 575
def addr_mask(addr)
case @family
when Socket::AF_INET
return addr & IN4MASK
when Socket::AF_INET6
return addr & IN6MASK
else
raise AddressFamilyError, "unsupported address family"
end
end # File lib/ipaddr.rb, line 512
def coerce_other(other)
case other
when IPAddr
other
when String
self.class.new(other)
else
self.class.new(other, @family)
end
end # File lib/ipaddr.rb, line 538
def in6_addr(left)
case left
when RE_IPV6ADDRLIKE_FULL
if $2
addr = in_addr($~[2,4])
left = $1 + ':'
else
addr = 0
end
right = ''
when RE_IPV6ADDRLIKE_COMPRESSED
if $4
left.count(':') <= 6 or raise InvalidAddressError, "invalid address"
addr = in_addr($~[4,4])
left = $1
right = $3 + '0:0'
else
left.count(':') <= ($1.empty? || $2.empty? ? 8 : 7) or
raise InvalidAddressError, "invalid address"
left = $1
right = $2
addr = 0
end
else
raise InvalidAddressError, "invalid address"
end
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
end # File lib/ipaddr.rb, line 523
def in_addr(addr)
case addr
when Array
octets = addr
else
m = RE_IPV4ADDRLIKE.match(addr) or return nil
octets = m.captures
end
octets.inject(0) { |i, s|
(n = s.to_i) < 256 or raise InvalidAddressError, "invalid address"
s.match(/\A0./) and raise InvalidAddressError, "zero-filled number in IPv4 address is ambiguous"
i << 8 | n
}
end
Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.