class 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>

Constants

IN4MASK: 32 位 IPv4 掩码
IN6FORMAT: IPv6 格式字符串
IN6MASK: 128 位 IPv6 掩码
RE_IPV4ADDRLIKE: 用于解析 IPv4 地址的内部 Regexp。
RE_IPV6ADDRLIKE_COMPRESSED: 用于解析 IPv6 地址的内部 Regexp。
RE_IPV6ADDRLIKE_FULL: 用于解析 IPv6 地址的内部 Regexp。
VERSION: 版本字符串

属性

family [R]

返回此 IP 地址的地址族。

Public Class Methods

new (addr = '::', family = Socket::AF_UNSPEC)

Source

# File lib/ipaddr.rb, line 658
def initialize(addr = '::', family = Socket::AF_UNSPEC)
  @mask_addr = nil
  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('/', 2)
  if prefix =~ /\A\[(.*)\]\z/i
    prefix = $1
    family = Socket::AF_INET6
  end
  if prefix =~ /\A(.*)(%\w+)\z/
    prefix = $1
    zone_id = $2
    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
  @zone_id = zone_id
  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

从人类可读的 IP 地址字符串表示形式或打包的 in_addr 值（后跟地址族）创建新的 ipaddr 对象。

在前一种情况下，以下是将被识别的有效格式：“address”、“address/prefixlen”和“address/mask”，其中 IPv6 地址可能包含在方括号 ('[' 和 ']') 中。如果指定了前缀长度或掩码，则返回一个带掩码的 IP 地址。虽然地址族会根据指定的字符串自动确定，但您可以通过可选的第二个参数显式指定它。

否则，将根据打包的 in_addr 值和地址族生成 IP 地址。

IPAddr 类定义了许多方法和运算符，其中一些（例如 &, |, include? 和 ==）接受字符串或打包的 in_addr 值，而不是 IPAddr 对象。

new_ntoh (addr)

Source

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

创建一个新的 ipaddr，其中包含给定的网络字节顺序的 IP 地址字符串形式。

ntop (addr)

Source

# File lib/ipaddr.rb, line 115
def self.ntop(addr)
  if addr.is_a?(String) && addr.encoding != Encoding::BINARY
    raise InvalidAddressError, "invalid encoding (given #{addr.encoding}, expected BINARY)"
  end

  case addr.bytesize
  when 4
    addr.unpack('C4').join('.')
  when 16
    IN6FORMAT % addr.unpack('n8')
  else
    raise AddressFamilyError, "unsupported address family"
  end
end

将网络字节顺序的 IP 地址字符串形式转换为人类可读的形式。它期望字符串以 Encoding::ASCII_8BIT (BINARY) 编码。

Public Instance Methods

& (other)

Source

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

返回通过按位 AND 构建的新 ipaddr。

+ (offset)

Source

# File lib/ipaddr.rb, line 156
def +(offset)
  self.clone.set(@addr + offset, @family)
end

返回比原始地址大 offset 的新 ipaddr。

- (offset)

Source

# File lib/ipaddr.rb, line 161
def -(offset)
  self.clone.set(@addr - offset, @family)
end

返回比原始地址小 offset 的新 ipaddr。

<< (num)

Source

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

返回通过按位左移构建的新 ipaddr。

<=> (other)

Source

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

将 ipaddr 与另一个进行比较。

== (other)

Source

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

如果两个 ipaddrs 相等，则返回 true。

=== (other)

的别名： include?

>> (num)

Source

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

返回通过按位右移构建的新 ipaddr。

| (other)

Source

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

返回通过按位 OR 构建的新 ipaddr。

~ ()

Source

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

返回通过按位取反构建的新 ipaddr。

as_json (*)

Source

# File lib/ipaddr.rb, line 242
def as_json(*)
  if ipv4? && prefix == 32
    to_s
  elsif ipv6? && prefix == 128
    to_s
  else
    cidr
  end
end

返回包含带前缀的 IP 地址表示形式的字符串。

cidr ()

Source

# File lib/ipaddr.rb, line 259
def cidr
  "#{to_s}/#{prefix}"
end

返回包含 CIDR 记法的 IP 地址表示形式的字符串。

eql? (other)

Source

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

由 Hash 使用的相等性检查。

hash ()

Source

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

返回由 Hash、Set 和 Array 类使用的哈希值。

hton ()

Source

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

Source

# File lib/ipaddr.rb, line 192
def include?(other)
  other = coerce_other(other)
  return false unless other.family == family
  begin_addr <= other.begin_addr && end_addr >= other.end_addr
end

如果给定的 ipaddr 在范围内，则返回 true。

例如：

require 'ipaddr'
net1 = IPAddr.new("192.168.2.0/24")
net2 = IPAddr.new("192.168.2.100")
net3 = IPAddr.new("192.168.3.0")
net4 = IPAddr.new("192.168.2.0/16")
p net1.include?(net2)     #=> true
p net1.include?(net3)     #=> false
p net1.include?(net4)     #=> false
p net4.include?(net1)     #=> true

也别名为： ===

inspect ()

Source

# File lib/ipaddr.rb, line 490
def inspect
  case @family
  when Socket::AF_INET
    af = "IPv4"
  when Socket::AF_INET6
    af = "IPv6"
    zone_id = @zone_id.to_s
  else
    raise AddressFamilyError, "unsupported address family"
  end
  return sprintf("#<%s: %s:%s%s/%s>", self.class.name,
                 af, _to_string(@addr), zone_id, _to_string(@mask_addr))
end

返回包含 ipaddr 的人类可读表示形式的字符串。（“#<IPAddr: family:address/mask>”)

ip6_arpa ()

Source

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

返回与 RFC3172 兼容的 DNS 反向查找字符串。

ip6_int ()

Source

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

返回与 RFC1886 兼容的 DNS 反向查找字符串。

ipv4? ()

Source

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

如果 ipaddr 是 IPv4 地址，则返回 true。

ipv4_compat ()

Source

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

返回通过将本机 IPv4 地址转换为 IPv4 兼容 IPv6 地址构建的新 ipaddr。

ipv4_compat? ()

Source

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

如果 ipaddr 是 IPv4 兼容 IPv6 地址，则返回 true。

ipv4_mapped ()

Source

# File lib/ipaddr.rb, line 369
def ipv4_mapped
  if !ipv4?
    raise InvalidAddressError, "not an IPv4 address: #{@addr}"
  end
  clone = self.clone.set(@addr | 0xffff00000000, Socket::AF_INET6)
  clone.instance_variable_set(:@mask_addr, @mask_addr | 0xffffffffffffffffffffffff00000000)
  clone
end

返回通过将本机 IPv4 地址转换为 IPv4 映射 IPv6 地址构建的新 ipaddr。

ipv4_mapped? ()

Source

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

如果 ipaddr 是 IPv4 映射 IPv6 地址，则返回 true。

ipv6? ()

Source

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

如果 ipaddr 是 IPv6 地址，则返回 true。

link_local? ()

Source

# File lib/ipaddr.rb, line 332
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 || # fe80::/10
      (@addr & 0xffff_0000_0000 == 0xffff_0000_0000 && (
        @addr & 0xffff0000 == 0xa9fe0000 # ::ffff:169.254.0.0/16
      ))
  else
    raise AddressFamilyError, "unsupported address family"
  end
end

如果 ipaddr 是链路本地地址，则返回 true。RFC 3927 保留的 169.254.0.0/16 中的 IPv4 地址和 RFC 4291 保留的 fe80::/10 中的链路本地 IPv6 单播地址被视为链路本地。IPv4 映射 IPv6 地址范围内的链路本地 IPv4 地址也被视为链路本地。

loopback? ()

Source

# File lib/ipaddr.rb, line 290
def loopback?
  case @family
  when Socket::AF_INET
    @addr & 0xff000000 == 0x7f000000 # 127.0.0.1/8
  when Socket::AF_INET6
    @addr == 1 || # ::1
      (@addr & 0xffff_0000_0000 == 0xffff_0000_0000 && (
        @addr & 0xff000000 == 0x7f000000 # ::ffff:127.0.0.1/8
      ))
  else
    raise AddressFamilyError, "unsupported address family"
  end
end

如果 ipaddr 是回送地址，则返回 true。IPv4 映射 IPv6 地址范围内的回送 IPv4 地址也被视为回送地址。

mask (prefixlen)

Source

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

通过使用给定的前缀长度/网络掩码对 IP 地址进行掩码来构建新的 ipaddr。（例如 8、64、“255.255.255.0”等）

native ()

Source

# File lib/ipaddr.rb, line 393
def native
  if !ipv4_mapped? && !_ipv4_compat?
    return self
  end
  return self.clone.set(@addr & IN4MASK, Socket::AF_INET)
end

返回通过将 IPv6 地址转换为本机 IPv4 地址构建的新 ipaddr。如果 IP 地址不是 IPv4 映射或 IPv4 兼容的 IPv6 地址，则返回 self。

netmask ()

Source

# File lib/ipaddr.rb, line 505
def netmask
  _to_string(@mask_addr)
end

以字符串格式返回网络掩码，例如 255.255.0.0。

prefix ()

Source

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

Source

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

设置前缀长度（以位为单位）。

private? ()

Source

# File lib/ipaddr.rb, line 309
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 ||
      (@addr & 0xffff_0000_0000 == 0xffff_0000_0000 && (
        @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
      ))
  else
    raise AddressFamilyError, "unsupported address family"
  end
end

如果 ipaddr 是私有地址，则返回 true。RFC 1918 中定义的 10.0.0.0/8、172.16.0.0/12 和 192.168.0.0/16 中的 IPv4 地址以及 RFC 4193 中定义的 fc00::/7 中的 IPv6 唯一本地地址被视为私有。IPv4 映射 IPv6 地址范围内的私有 IPv4 地址也被视为私有。

reverse ()

Source

# File lib/ipaddr.rb, line 402
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 格式的字符串。

succ ()

Source

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

返回 ipaddr 的后继者。

to_i ()

Source

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

返回 ipaddr 的整数表示形式。

to_json (*a)

Source

# File lib/ipaddr.rb, line 253
def to_json(*a)
  %Q{"#{as_json(*a)}"}
end

返回包含 IP 地址表示形式的 JSON 字符串。

to_range ()

Source

# File lib/ipaddr.rb, line 455
def to_range
  self.class.new(begin_addr, @family)..self.class.new(end_addr, @family)
end

为网络地址创建一个 Range 对象。

to_s ()

Source

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

Source

# File lib/ipaddr.rb, line 231
def to_string
  str = _to_string(@addr)

  if @family == Socket::AF_INET6
    str << zone_id.to_s
  end

  return str
end

以规范形式返回包含 IP 地址表示形式的字符串。

wildcard_mask ()

Source

# File lib/ipaddr.rb, line 510
def wildcard_mask
  case @family
  when Socket::AF_INET
    mask = IN4MASK ^ @mask_addr
  when Socket::AF_INET6
    mask = IN6MASK ^ @mask_addr
  else
    raise AddressFamilyError, "unsupported address family"
  end

  _to_string(mask)
end

以字符串格式返回通配符掩码，例如 0.0.255.255。

zone_id ()

Source

# File lib/ipaddr.rb, line 525
def zone_id
  if @family == Socket::AF_INET6
    @zone_id
  else
    raise InvalidAddressError, "not an IPv6 address"
  end
end

返回 IPv6 区域标识符（如果存在）。如果不是 IPv6 地址，则引发 InvalidAddressError。

zone_id= (zid)

Source

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

返回 IPv6 区域标识符（如果存在）。如果不是 IPv6 地址，则引发 InvalidAddressError。

Protected Instance Methods

mask! (mask)

Source

# File lib/ipaddr.rb, line 594
def mask!(mask)
  case mask
  when String
    case mask
    when /\A(0|[1-9]+\d*)\z/
      prefixlen = mask.to_i
    when /\A\d+\z/
      raise InvalidPrefixError, "leading zeros in prefix"
    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)

Source

# File lib/ipaddr.rb, line 570
def set(addr, *family)
  case family[0] ? family[0] : @family
  when Socket::AF_INET
    if addr < 0 || addr > IN4MASK
      raise InvalidAddressError, "invalid address: #{addr}"
    end
  when Socket::AF_INET6
    if addr < 0 || addr > IN6MASK
      raise InvalidAddressError, "invalid address: #{addr}"
    end
  else
    raise AddressFamilyError, "unsupported address family"
  end
  @addr = addr
  if family[0]
    @family = family[0]
    if @family == Socket::AF_INET
      @mask_addr &= IN4MASK
    end
  end
  return self
end

将内部存储的 IP 地址 +@addr+ 设置为给定的 addr。参数 addr 使用第一个 family 成员（为 Socket::AF_INET 或 Socket::AF_INET6）进行验证。