Class: IPAddr
Relationships & Source Files | |
Namespace Children | |
Exceptions:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
Comparable
|
|
Inherits: | Object |
Defined in: | lib/ipaddr.rb |
Overview
IPAddr
provides a set of methods to manipulate an IP address. Both IPv4 and IPv6 are supported.
Example
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>
Constant Summary
-
IN4MASK =
32 bit mask for IPv4
0xffffffff
-
IN6FORMAT =
Format string for IPv6
(["%.4x"] * 8).join(':')
-
IN6MASK =
128 bit mask for IPv4
0xffffffffffffffffffffffffffffffff
-
RE_IPV4ADDRLIKE =
Regexp internally used for parsing IPv4 address.
%r{ \A (\d+) \. (\d+) \. (\d+) \. (\d+) \z }x
-
RE_IPV6ADDRLIKE_COMPRESSED =
Regexp internally used for parsing IPv6 address.
%r{ \A ( (?: (?: [\da-f]{1,4} : )* [\da-f]{1,4} )? ) :: ( (?: ( (?: [\da-f]{1,4} : )* ) (?: [\da-f]{1,4} | (\d+) \. (\d+) \. (\d+) \. (\d+) ) )? ) \z }xi
-
RE_IPV6ADDRLIKE_FULL =
Regexp internally used for parsing IPv6 address.
%r{ \A (?: (?: [\da-f]{1,4} : ){7} [\da-f]{1,4} | ( (?: [\da-f]{1,4} : ){6} ) (\d+) \. (\d+) \. (\d+) \. (\d+) ) \z }xi
Class Method Summary
-
.new_ntoh(addr)
Creates a new ipaddr containing the given network byte ordered string form of an IP address.
-
.ntop(addr)
Convert a network byte ordered string form of an IP address into human readable form.
-
.new(addr = '::', family = Socket::AF_UNSPEC) ⇒ IPAddr
constructor
private
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.
Instance Attribute Summary
-
#family
readonly
Returns the address family of this IP address.
-
#ipv4? ⇒ Boolean
readonly
Returns true if the ipaddr is an IPv4 address.
-
#ipv4_compat? ⇒ Boolean
readonly
Returns true if the ipaddr is an IPv4-compatible IPv6 address.
-
#ipv4_mapped? ⇒ Boolean
readonly
Returns true if the ipaddr is an IPv4-mapped IPv6 address.
-
#ipv6? ⇒ Boolean
readonly
Returns true if the ipaddr is an IPv6 address.
Instance Method Summary
-
#&(other)
Returns a new ipaddr built by bitwise AND.
-
#<<(num)
Returns a new ipaddr built by bitwise left shift.
-
#<=>(other)
Compares the ipaddr with another.
-
#==(other)
Returns true if two ipaddrs are equal.
-
#===(other)
Alias for #include?.
-
#>>(num)
Returns a new ipaddr built by bitwise right-shift.
-
#eql?(other) ⇒ Boolean
Checks equality used by Hash.
-
#hash
Returns a hash value used by Hash, Set, and Array classes.
-
#hton
Returns a network byte ordered string form of the IP address.
-
#include?(other) ⇒ Boolean
(also: #===)
Returns true if the given ipaddr is in the range.
-
#inspect
Returns a string containing a human-readable representation of the ipaddr.
-
#ip6_arpa
Returns a string for DNS reverse lookup compatible with RFC3172.
-
#ip6_int
Returns a string for DNS reverse lookup compatible with RFC1886.
-
#ipv4_compat
readonly
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-compatible IPv6 address.
-
#ipv4_mapped
readonly
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-mapped IPv6 address.
-
#mask(prefixlen)
Returns a new ipaddr built by masking IP address with the given prefixlen/netmask.
-
#native
Returns a new ipaddr built by converting the IPv6 address into a native IPv4 address.
-
#reverse
Returns a string for DNS reverse lookup.
-
#succ
Returns the successor to the ipaddr.
-
#to_i
Returns the integer representation of the ipaddr.
-
#to_range
Creates a Range object for the network address.
-
#to_s
Returns a string containing the IP address representation.
-
#to_string
Returns a string containing the IP address representation in canonical form.
-
#|(other)
Returns a new ipaddr built by bitwise OR.
-
#~
Returns a new ipaddr built by bitwise negation.
-
#mask!(mask)
protected
Set current netmask to given mask.
-
#set(addr, *family)
protected
Set @addr, the internal stored ip address, to given
addr
. - #_reverse private
- #_to_string(addr) private
- #addr_mask(addr) private
- #coerce_other(other) private
- #in6_addr(left) private
- #in_addr(addr) private
Constructor Details
.new(addr = '::', family = Socket::AF_UNSPEC) ⇒ IPAddr
(private)
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.
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.
Otherwise an IP address is generated from a packed in_addr value and an address family.
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.
# File 'lib/ipaddr.rb', line 468
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
Class Method Details
.new_ntoh(addr)
Creates a new ipaddr containing the given network byte ordered string form of an IP address.
.ntop(addr)
Convert a network byte ordered string form of an IP address into human readable form.
# File 'lib/ipaddr.rb', line 112
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
Instance Attribute Details
#family (readonly)
Returns the address family of this IP address.
# File 'lib/ipaddr.rb', line 102
attr_reader :family
#ipv4? ⇒ Boolean
(readonly)
Returns true if the ipaddr is an IPv4 address.
# File 'lib/ipaddr.rb', line 250
def ipv4? return @family == Socket::AF_INET end
#ipv4_compat? ⇒ Boolean
(readonly)
Returns true if the ipaddr is an IPv4-compatible IPv6 address.
#ipv4_mapped? ⇒ Boolean
(readonly)
Returns true if the ipaddr is an IPv4-mapped IPv6 address.
# File 'lib/ipaddr.rb', line 260
def ipv4_mapped? return ipv6? && (@addr >> 32) == 0xffff end
#ipv6? ⇒ Boolean
(readonly)
Returns true if the ipaddr is an IPv6 address.
Instance Method Details
#&(other)
Returns a new ipaddr built by bitwise AND.
# File 'lib/ipaddr.rb', line 125
def &(other) return self.clone.set(@addr & coerce_other(other).to_i) end
#<<(num)
Returns a new ipaddr built by bitwise left shift.
#<=>(other)
Compares the ipaddr with another.
# File 'lib/ipaddr.rb', line 336
def <=>(other) other = coerce_other(other) return nil if other.family != @family return @addr <=> other.to_i end
#==(other)
Returns true if two ipaddrs are equal.
# File 'lib/ipaddr.rb', line 150
def ==(other) other = coerce_other(other) return @family == other.family && @addr == other.to_i end
#===(other)
Alias for #include?.
# File 'lib/ipaddr.rb', line 197
alias === include?
#>>(num)
Returns a new ipaddr built by bitwise right-shift.
# File 'lib/ipaddr.rb', line 135
def >>(num) return self.clone.set(@addr >> num) end
#_reverse (private)
[ GitHub ]# File 'lib/ipaddr.rb', line 584
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) (private)
[ GitHub ]# File 'lib/ipaddr.rb', line 597
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) (private)
[ GitHub ]#coerce_other(other) (private)
[ GitHub ]
#eql?(other) ⇒ Boolean
Checks equality used by Hash.
#hash
Returns a hash value used by Hash, Set, and Array classes
# File 'lib/ipaddr.rb', line 351
def hash return ([@addr, @mask_addr].hash << 1) | (ipv4? ? 0 : 1) end
#hton
Returns a network byte ordered string form of the IP address.
# File 'lib/ipaddr.rb', line 236
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
#in6_addr(left) (private)
[ GitHub ]# File 'lib/ipaddr.rb', line 536
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) (private)
[ GitHub ]# File 'lib/ipaddr.rb', line 521
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
#include?(other) ⇒ Boolean
Also known as: #===
# File 'lib/ipaddr.rb', line 170
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
#inspect
Returns a string containing a human-readable representation of the ipaddr. (“#<IPAddr: family:address/mask>”)
# File 'lib/ipaddr.rb', line 373
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
#ip6_arpa
Returns a string for DNS reverse lookup compatible with RFC3172.
# File 'lib/ipaddr.rb', line 315
def ip6_arpa if !ipv6? raise InvalidAddressError, "not an IPv6 address" end return _reverse + ".ip6.arpa" end
#ip6_int
Returns a string for DNS reverse lookup compatible with RFC1886.
# File 'lib/ipaddr.rb', line 323
def ip6_int if !ipv6? raise InvalidAddressError, "not an IPv6 address" end return _reverse + ".ip6.int" end
#ipv4_compat (readonly)
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-compatible IPv6 address.
# File 'lib/ipaddr.rb', line 284
def ipv4_compat if !ipv4? raise InvalidAddressError, "not an IPv4 address" end return self.clone.set(@addr, Socket::AF_INET6) end
#ipv4_mapped (readonly)
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-mapped IPv6 address.
# File 'lib/ipaddr.rb', line 275
def ipv4_mapped if !ipv4? raise InvalidAddressError, "not an IPv4 address" end return self.clone.set(@addr | 0xffff00000000, Socket::AF_INET6) end
#mask(prefixlen)
Returns a new ipaddr built by masking IP address with the given prefixlen/netmask. (e.g. 8, 64, “255.255.255.0”, etc.)
# File 'lib/ipaddr.rb', line 157
def mask(prefixlen) return self.clone.mask!(prefixlen) end
#mask!(mask) (protected)
Set current netmask to given mask.
# File 'lib/ipaddr.rb', line 412
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
#native
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.
# File 'lib/ipaddr.rb', line 294
def native if !ipv4_mapped? && !ipv4_compat? return self end return self.clone.set(@addr & IN4MASK, Socket::AF_INET) end
#reverse
Returns a string for DNS reverse lookup. It returns a string in RFC3172 form for an IPv6 address.
#set(addr, *family) (protected)
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.
# File 'lib/ipaddr.rb', line 391
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
#succ
Returns the successor to the ipaddr.
# File 'lib/ipaddr.rb', line 331
def succ return self.clone.set(@addr + 1, @family) end
#to_i
Returns the integer representation of the ipaddr.
# File 'lib/ipaddr.rb', line 200
def to_i return @addr end
#to_range
Creates a Range object for the network address.
# File 'lib/ipaddr.rb', line 356
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
#to_s
Returns a string containing the IP address representation.
# 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
#to_string
Returns a string containing the IP address representation in canonical form.
# File 'lib/ipaddr.rb', line 231
def to_string return _to_string(@addr) end
#|(other)
Returns a new ipaddr built by bitwise OR.
# File 'lib/ipaddr.rb', line 130
def |(other) return self.clone.set(@addr | coerce_other(other).to_i) end
#~
Returns a new ipaddr built by bitwise negation.