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

IPv4 的 32 位掩码

IN6FORMAT

IPv6 的格式字符串

IN6MASK

IPv6 的 128 位掩码

RE_IPV4ADDRLIKE

Regexp 在内部用于解析 IPv4 地址。

RE_IPV6ADDRLIKE_COMPRESSED

Regexp 在内部用于解析 IPv6 地址。

RE_IPV6ADDRLIKE_FULL

Regexp 在内部用于解析 IPv6 地址。

VERSION

属性

family[R]

返回此 IP 地址的地址族。

公共类方法

new(addr = '::', family = Socket::AF_UNSPEC) 单击以切换源

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

在前一种情况下，以下为将被识别的有效格式：“地址”、“地址/前缀长度”和“地址/掩码”，其中 IPv6 地址可以用方括号（“[”和“]”）括起来。如果指定了前缀长度或掩码，它将返回一个掩码 IP 地址。虽然地址族是由指定字符串自动确定的，但你可以通过可选的第二个参数明确指定一个地址族。

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

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

# File lib/ipaddr.rb, line 593
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
new_ntoh(addr) 单击以切换源代码

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

# File lib/ipaddr.rb, line 107
def self.new_ntoh(addr)
  return new(ntop(addr))
end
ntop(addr) 单击以切换源代码

将网络字节顺序字符串形式的 IP 地址转换为人类可读形式。

# File lib/ipaddr.rb, line 113
def self.ntop(addr)
  case addr.size
  when 4
    addr.unpack('C4').join('.')
  when 16
    IN6FORMAT % addr.unpack('n8')
  else
    raise AddressFamilyError, "unsupported address family"
  end
end

公共实例方法

&(other) 单击以切换源代码

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

# File lib/ipaddr.rb, line 125
def &(other)
  return self.clone.set(@addr & coerce_other(other).to_i)
end
<<(num) 单击以切换源代码

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

# File lib/ipaddr.rb, line 140
def <<(num)
  return self.clone.set(addr_mask(@addr << num))
end
<=>(other) 单击以切换源代码

将 ipaddr 与另一个 ipaddr 进行比较。

# File lib/ipaddr.rb, line 386
def <=>(other)
  other = coerce_other(other)
rescue
  nil
else
  @addr <=> other.to_i if other.family == @family
end
==(other) 单击以切换源代码

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

# File lib/ipaddr.rb, line 150
def ==(other)
  other = coerce_other(other)
rescue
  false
else
  @family == other.family && @addr == other.to_i
end
===(other)
别名：include?
>>(num) 单击以切换源代码

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

# File lib/ipaddr.rb, line 135
def >>(num)
  return self.clone.set(@addr >> num)
end
eql?(other) 单击以切换源代码

检查 Hash 使用的相等性。

# File lib/ipaddr.rb, line 396
def eql?(other)
  return self.class == other.class && self.hash == other.hash && self == other
end
hash() 单击以切换源代码

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

# File lib/ipaddr.rb, line 401
def hash
  return ([@addr, @mask_addr, @zone_id].hash << 1) | (ipv4? ? 0 : 1)
end
hton() 点击切换源代码

返回 IP 地址的网络字节序字符串形式。

# File lib/ipaddr.rb, line 226
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
include?(other) 点击切换源代码

如果给定的 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

# File lib/ipaddr.rb, line 176
def include?(other)
  other = coerce_other(other)
  return false unless other.family == family
  begin_addr <= other.begin_addr && end_addr >= other.end_addr
end
别名： ===
inspect() 点击切换源代码

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

# File lib/ipaddr.rb, line 441
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
ip6_arpa() 点击切换源代码

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

# File lib/ipaddr.rb, line 365
def ip6_arpa
  if !ipv6?
    raise InvalidAddressError, "not an IPv6 address: #{@addr}"
  end
  return _reverse + ".ip6.arpa"
end
ip6_int() 点击切换源代码

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

# File lib/ipaddr.rb, line 373
def ip6_int
  if !ipv6?
    raise InvalidAddressError, "not an IPv6 address: #{@addr}"
  end
  return _reverse + ".ip6.int"
end
ipv4?() 点击切换源代码

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

# File lib/ipaddr.rb, line 240
def ipv4?
  return @family == Socket::AF_INET
end
ipv4_compat() 点击切换源代码

返回一个新的 ipaddr，该 ipaddr 是通过将本机 IPv4 地址转换为 IPv4 兼容 IPv6 地址而构建的。

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

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

# File lib/ipaddr.rb, line 305
def ipv4_compat?
  warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE
  _ipv4_compat?
end
ipv4_mapped() 点击切换源代码

返回一个新的 ipaddr，该 ipaddr 是通过将本机 IPv4 地址转换为 IPv4 映射 IPv6 地址而构建的。

# File lib/ipaddr.rb, line 322
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_mapped?() 点击切换源代码

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

# File lib/ipaddr.rb, line 300
def ipv4_mapped?
  return ipv6? && (@addr >> 32) == 0xffff
end
ipv6?() 点击切换源代码

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

# File lib/ipaddr.rb, line 245
def ipv6?
  return @family == Socket::AF_INET6
end
link_local?() 点击切换源代码

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

loopback?() 点击切换源代码

如果 ipaddr 是一个环回地址，则返回 true。

# File lib/ipaddr.rb, line 250
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
mask(prefixlen) 点击切换源代码

通过使用给定的 prefixlen/netmask 对 IP 地址进行掩码，返回一个新构建的 ipaddr。（例如 8、64、“255.255.255.0”等）

# File lib/ipaddr.rb, line 160
def mask(prefixlen)
  return self.clone.mask!(prefixlen)
end
native() 点击切换源代码

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

# File lib/ipaddr.rb, line 344
def native
  if !ipv4_mapped? && !_ipv4_compat?
    return self
  end
  return self.clone.set(@addr & IN4MASK, Socket::AF_INET)
end
netmask() 点击切换源代码

以字符串格式返回 netmask，例如 255.255.0.0

# File lib/ipaddr.rb, line 456
def netmask
  _to_string(@mask_addr)
end
prefix() 点击切换源代码

返回 ipaddr 的前缀长度（以位为单位）。

# File lib/ipaddr.rb, line 411
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
prefix=(prefix) 点击切换源代码

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

# File lib/ipaddr.rb, line 430
def prefix=(prefix)
  case prefix
  when Integer
    mask!(prefix)
  else
    raise InvalidPrefixError, "prefix must be an integer: #{@addr}"
  end
end
private?() 点击切换源代码

如果 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 地址也被视为私有地址。

# File lib/ipaddr.rb, line 266
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
reverse() 点击切换源代码

返回一个用于 DNS 反向查找的字符串。它为 IPv6 地址返回 RFC3172 形式的字符串。

# File lib/ipaddr.rb, line 353
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
succ() 点击切换源代码

返回 ipaddr 的后继。

# File lib/ipaddr.rb, line 381
def succ
  return self.clone.set(@addr + 1, @family)
end
to_i() 点击切换源代码

返回 ipaddr 的整数表示形式。

# File lib/ipaddr.rb, line 184
def to_i
  return @addr
end
to_range() 点击切换源代码

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

# File lib/ipaddr.rb, line 406
def to_range
  self.class.new(begin_addr, @family)..self.class.new(end_addr, @family)
end
to_s() 点击切换源代码

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

# File lib/ipaddr.rb, line 189
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
to_string() 单击以切换源

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

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

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

  return str
end
zone_id() 单击以切换源

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

# File lib/ipaddr.rb, line 462
def zone_id
  if @family == Socket::AF_INET6
    @zone_id
  else
    raise InvalidAddressError, "not an IPv6 address"
  end
end
zone_id=(zid) 单击以切换源

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

# File lib/ipaddr.rb, line 472
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
|(other) 单击以切换源

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

# 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

受保护的实例方法

begin_addr() 单击以切换源 
# File lib/ipaddr.rb, line 487
def begin_addr
  @addr & @mask_addr
end
end_addr() 单击以切换源 
# File lib/ipaddr.rb, line 491
def end_addr
  case @family
  when Socket::AF_INET
    @addr | (IN4MASK ^ @mask_addr)
  when Socket::AF_INET6
    @addr | (IN6MASK ^ @mask_addr)
  else
    raise AddressFamilyError, "unsupported address family"
  end
end
mask!(mask) 单击以切换源

Set 当前网络掩码为给定的掩码。

# File lib/ipaddr.rb, line 529
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: #{@addr}"
      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}: #{@addr}"
      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: #{@addr}"
    end
    masklen = 32 - prefixlen
    @mask_addr = ((IN4MASK >> masklen) << masklen)
  when Socket::AF_INET6
    if prefixlen < 0 || prefixlen > 128
      raise InvalidPrefixError, "invalid length: #{@addr}"
    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) 单击以切换源

Set +@addr+，内部存储的 IP 地址，为给定的 addr。使用第一个 family 成员验证参数 addr，该成员为 Socket::AF_INET 或 Socket::AF_INET6。

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

私有实例方法

_ipv4_compat?() 单击以切换源 
# File lib/ipaddr.rb, line 310
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 716
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 729
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 705
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 642
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 668
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}"
      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: #{@addr}"
      left = $1
      right = $2
      addr = 0
    end
  else
    raise InvalidAddressError, "invalid address: #{@addr}"
  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 653
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: #{@addr}"
    s.match(/\A0./) and raise InvalidAddressError, "zero-filled number in IPv4 address is ambiguous: #{@addr}"
    i << 8 | n
  }
end