класс IPAddr

Родитель:: Объект
Включенные модули:: Comparable

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: Regexp внутренне используется для разбора IPv4 адреса.
RE_IPV6ADDRLIKE_COMPRESSED: Regexp внутренне используется для разбора IPv6 адреса.
RE_IPV6ADDRLIKE_FULL: Regexp внутренне используется для разбора IPv6 адреса.

Атрибуты

family[R]

Возвращает семейство адреса этого IP-адреса.

Открытые методы класса

new(addr = '::', family = Socket::AF_UNSPEC) Показать исходный код

# File lib/ipaddr.rb, line 557
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
rescue InvalidAddressError => e
  raise e.class, "#{e.message}: #{addr}"
end

Создаёт новый объект ipaddr, либо из удобочитаемой строки IP-адреса, либо из упакованного значения in_addr с последующим семейством адресов.

В первом случае, допускаются следующие форматы: «адрес», «адрес/длина_префикса» и «адрес/маска», где IPv6-адрес может быть заключён в квадратные скобки (`[' и `]'). Если указана длина префикса или маска, возвращается замаскированный IP-адрес. Несмотря на то, что семейство адреса определяется автоматически из указанной строки, вы можете явно указать его с помощью необязательного второго аргумента.

В противном случае IP-адрес генерируется из упакованного значения in_addr и семейства адресов.

Класс IPAddr определяет множество методов и операторов, некоторые из которых, такие как &, |, include? и ==, принимают строку или упакованное значение in_addr вместо объекта IPAddr.

new_ntoh(addr) Показать исходный код

# File lib/ipaddr.rb, line 106
def self.new_ntoh(addr)
  return new(ntop(addr))
end

Создаёт новый ipaddr, содержащий строку IP-адреса в сетевом порядке байтов.

ntop(addr) Показать исходный код

# File lib/ipaddr.rb, line 112
def self.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-адреса в сетевом порядке байтов в удобочитаемый вид.

Общедоступные методы экземпляра

&(other) Показать исходный код

# File lib/ipaddr.rb, line 125
def &(other)
  return self.clone.set(@addr & coerce_other(other).to_i)
end

Возвращает новый ipaddr, созданный с помощью побитового И.

<<(num) Показать исходный код

# File lib/ipaddr.rb, line 140
def <<(num)
  return self.clone.set(addr_mask(@addr << num))
end

Возвращает новый ipaddr, созданный с помощью побитового сдвига влево.

<=>(other) Показать исходный код

# File lib/ipaddr.rb, line 391
def <=>(other)
  other = coerce_other(other)
rescue
  nil
else
  @addr <=> other.to_i if other.family == @family
end

Сравнивает ipaddr с другим.

==(other) Показать исходный код

# File lib/ipaddr.rb, line 150
def ==(other)
  other = coerce_other(other)
rescue
  false
else
  @family == other.family && @addr == other.to_i
end

Возвращает true, если два ipaddr равны.

===(other)

Псевдоним для: include?

>>(num) Показать исходный код

# File lib/ipaddr.rb, line 135
def >>(num)
  return self.clone.set(@addr >> num)
end

Возвращает новый ipaddr, созданный с помощью побитового сдвига вправо.

eql?(other) Показать исходный код

# File lib/ipaddr.rb, line 401
def eql?(other)
  return self.class == other.class && self.hash == other.hash && self == other
end

Проверка равенства, используемая методом Hash.

hash() Показать исходный код

# File lib/ipaddr.rb, line 406
def hash
  return ([@addr, @mask_addr].hash << 1) | (ipv4? ? 0 : 1)
end

Возвращает значение хеша, используемое классами Hash, Set и Array.

hton() Показать исходный код

# File lib/ipaddr.rb, line 239
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-адреса.

include?(other) Показать исходный код

# File lib/ipaddr.rb, line 173
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

Также используется как: ===

inspect() Показать исходный код

# File lib/ipaddr.rb, line 457
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>»)

ip6_arpa() Показать исходный код

# File lib/ipaddr.rb, line 370
def ip6_arpa
  if !ipv6?
    raise InvalidAddressError, "not an IPv6 address"
  end
  return _reverse + ".ip6.arpa"
end

Возвращает строку для обратного поиска DNS, совместимую с RFC3172.

ip6_int() Показать исходный код

# File lib/ipaddr.rb, line 378
def ip6_int
  if !ipv6?
    raise InvalidAddressError, "not an IPv6 address"
  end
  return _reverse + ".ip6.int"
end

Возвращает строку для обратного поиска DNS, совместимую с RFC1886.

ipv4?() Показать исходный код

# File lib/ipaddr.rb, line 253
def ipv4?
  return @family == Socket::AF_INET
end

Возвращает true, если ipaddr — это IPv4-адрес.

ipv4_compat() Показать исходный код

# File lib/ipaddr.rb, line 338
def ipv4_compat
  warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE
  if !ipv4?
    raise InvalidAddressError, "not an IPv4 address"
  end
  return self.clone.set(@addr, Socket::AF_INET6)
end

Возвращает новый ipaddr, созданный путём преобразования нативного IPv4-адреса в совместимый IPv4-адрес IPv6.

ipv4_compat?() Показать исходный код

# File lib/ipaddr.rb, line 312
def ipv4_compat?
  warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE
  _ipv4_compat?
end

Возвращает true, если ipaddr — это совместимый IPv4-адрес IPv6.

ipv4_mapped() Показать исходный код

# File lib/ipaddr.rb, line 329
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.

ipv4_mapped?() Показать исходный код

# File lib/ipaddr.rb, line 307
def ipv4_mapped?
  return ipv6? && (@addr >> 32) == 0xffff
end

Возвращает true, если ipaddr — это IPv4-отображённый адрес IPv6.

ipv6?() Показать исходный код

# File lib/ipaddr.rb, line 258
def ipv6?
  return @family == Socket::AF_INET6
end

Возвращает true, если ipaddr — это IPv6-адрес.

link_local?() Показать исходный код

# File lib/ipaddr.rb, line 295
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

Возвращает true, если ipaddr — это адрес локальной сети. IPv4-адреса в 169.254.0.0/16, зарезервированные RFC 3927, и адреса одноадресной локальной сети IPv6 в fe80::/10, зарезервированные RFC 4291, считаются адресами локальной сети.

loopback?() Показать исходный код

# File lib/ipaddr.rb, line 263
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

Возвращает true, если ipaddr — это адрес обратной связи.

mask(prefixlen) Показать исходный код

# File lib/ipaddr.rb, line 160
def mask(prefixlen)
  return self.clone.mask!(prefixlen)
end

Возвращает новый ipaddr, созданный путём маскирования IP-адреса с указанным prefixlen/netmask. (например, 8, 64, «255.255.255.0» и т. д.).

native() Показать исходный код

# File lib/ipaddr.rb, line 349
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.

prefix() Показать исходный код

# File lib/ipaddr.rb, line 427
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

Возвращает длину префикса в битах для ipaddr.

prefix=(prefix) Показать исходный код

# File lib/ipaddr.rb, line 446
def prefix=(prefix)
  case prefix
  when Integer
    mask!(prefix)
  else
    raise InvalidPrefixError, "prefix must be an integer"
  end
end

Устанавливает длину префикса в битах.

private?() Показать исходный код

# File lib/ipaddr.rb, line 278
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

Возвращает true, если ipaddr — это частный адрес. IPv4-адреса в 10.0.0.0/8, 172.16.0.0/12 и 192.168.0.0/16 (определены в RFC 1918) и IPv6-адреса уникальных локальных адресов в fc00::/7 (определены в RFC 4193) считаются частными.

reverse() Показать исходный код

# File lib/ipaddr.rb, line 358
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.

END_OF_DOCUMENT_MARKER

succ() Показать исходный код

# File lib/ipaddr.rb, line 386
def succ
  return self.clone.set(@addr + 1, @family)
end

Возвращает преемника ipaddr.

to_i() Показать исходный код

# File lib/ipaddr.rb, line 203
def to_i
  return @addr
end

Возвращает целое числовое представление ipaddr.

to_range() Показать исходный код

# File lib/ipaddr.rb, line 411
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 для сетевого адреса.

to_s() Показать исходный код

# File lib/ipaddr.rb, line 208
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-адреса.

to_string() Показать исходный код

# File lib/ipaddr.rb, line 234
def to_string
  return _to_string(@addr)
end

Возвращает строку, содержащую представление IP-адреса в канонической форме.

|(other) Показать исходный код

# File lib/ipaddr.rb, line 130
def |(other)
  return self.clone.set(@addr | coerce_other(other).to_i)
end

Возвращает новый ipaddr, созданный с помощью побитового ИЛИ.

~() Показать исходный код

# File lib/ipaddr.rb, line 145
def ~
  return self.clone.set(addr_mask(~@addr))
end

Возвращает новый ipaddr, созданный с помощью побитового отрицания.

Защищённые методы экземпляра

mask!(mask) Показать исходный код

# File lib/ipaddr.rb, line 496
def mask!(mask)
  case mask
  when 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
      n = @mask_addr ^ m.instance_variable_get(:@mask_addr)
      unless ((n + 1) & n).zero?
        raise InvalidPrefixError, "invalid mask #{mask}"
      end
      @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

Устанавливает текущую маску сети на заданную маску.

set(addr, *family) Показать исходный код

# File lib/ipaddr.rb, line 475
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.

Приватные методы экземпляра

_ipv4_compat?() Показать исходный код

# File lib/ipaddr.rb, line 317
def _ipv4_compat?
  if !ipv6? || (@addr >> 32) != 0
    return false
  end
  a = (@addr & IN4MASK)
  return a != 0 && a != 1
end

_reverse() Показать исходный код

# File lib/ipaddr.rb, line 675
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

_to_string(addr) Показать исходный код

# File lib/ipaddr.rb, line 688
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

addr_mask(addr) Показать исходный код

# File lib/ipaddr.rb, line 664
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

coerce_other(other) Показать исходный код

# File lib/ipaddr.rb, line 601
def coerce_other(other)
  case other
  when IPAddr
    other
  when String
    self.class.new(other)
  else
    self.class.new(other, @family)
  end
end

in6_addr(left) Показать исходный код

# File lib/ipaddr.rb, line 627
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

in_addr(addr) Показать исходный код

# File lib/ipaddr.rb, line 612
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.