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>
- CLASS IPAddr::AddressFamilyError
- CLASS IPAddr::Error
- CLASS IPAddr::InvalidAddressError
- CLASS IPAddr::InvalidPrefixError
- #
- B
- E
- H
- I
- L
- M
- N
- P
- R
- S
- T
- Z
- #
Constants
IN4MASK | = | 0xffffffff |
32 bit mask for IPv4 |
||
IN6FORMAT | = | (["%.4x"] * 8).join(':').freeze |
Format string for IPv6 |
||
IN6MASK | = | 0xffffffffffffffffffffffffffffffff |
128 bit mask for IPv6 |
||
RE_IPV4ADDRLIKE | = | %r{ \A (\d+) \. (\d+) \. (\d+) \. (\d+) \z }x |
|
||
RE_IPV6ADDRLIKE_COMPRESSED | = | %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 | = | %r{ \A (?: (?: [\da-f]{1,4} : ){7} [\da-f]{1,4} | ( (?: [\da-f]{1,4} : ){6} ) (\d+) \. (\d+) \. (\d+) \. (\d+) ) \z }xi |
|
||
VERSION | = | "1.2.6" |
Attributes
[R] | family | Returns the address family of this IP address. |
Class Public methods
new(addr = '::', family = Socket::AF_UNSPEC) Link
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 ruby/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) Link
Creates a new ipaddr containing the given network byte ordered string form of an IP address.
ntop(addr) Link
Convert a network byte ordered string form of an IP address into human readable form.
Instance Public methods
&(other) Link
Returns a new ipaddr built by bitwise AND.
<<(num) Link
Returns a new ipaddr built by bitwise left shift.
<=>(other) Link
Compares the ipaddr with another.
==(other) Link
Returns true if two ipaddrs are equal.
>>(num) Link
Returns a new ipaddr built by bitwise right-shift.
hash() Link
hton() Link
Returns a network byte ordered string form of the IP address.
include?(other) Link
Returns true if the given ipaddr is in the range.
e.g.:
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() Link
Returns a string containing a human-readable representation of the ipaddr. (“#<IPAddr: family:address/mask>”)
# File ruby/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() Link
Returns a string for DNS reverse lookup compatible with RFC3172.
ip6_int() Link
Returns a string for DNS reverse lookup compatible with RFC1886.
ipv4?() Link
Returns true if the ipaddr is an IPv4 address.
ipv4_compat() Link
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-compatible IPv6 address.
ipv4_compat?() Link
Returns true if the ipaddr is an IPv4-compatible IPv6 address.
ipv4_mapped() Link
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-mapped IPv6 address.
# File ruby/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?() Link
Returns true if the ipaddr is an IPv4-mapped IPv6 address.
ipv6?() Link
Returns true if the ipaddr is an IPv6 address.
link_local?() Link
Returns true if the ipaddr is a link-local address. IPv4 addresses in 169.254.0.0/16 reserved by RFC 3927 and Link-Local IPv6 Unicast Addresses in fe80::/10 reserved by RFC 4291 are considered link-local.
# File ruby/lib/ipaddr.rb, line 288 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
loopback?() Link
Returns true if the ipaddr is a loopback address.
mask(prefixlen) Link
Returns a new ipaddr built by masking IP address with the given prefixlen/netmask. (e.g. 8, 64, “255.255.255.0”, etc.)
native() Link
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.
netmask() Link
Returns the netmask in string format e.g. 255.255.0.0
prefix() Link
Returns the prefix length in bits for the ipaddr.
prefix=(prefix) Link
Sets the prefix length in bits
private?() Link
Returns true if the ipaddr is a private address. IPv4 addresses in 10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16 as defined in RFC 1918 and IPv6 Unique Local Addresses in fc00::/7 as defined in RFC 4193 are considered private. Private IPv4 addresses in the IPv4-mapped IPv6 address range are also considered private.
# File ruby/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() Link
Returns a string for DNS reverse lookup. It returns a string in RFC3172 form for an IPv6 address.
succ() Link
Returns the successor to the ipaddr.
to_i() Link
Returns the integer representation of the ipaddr.
to_s() Link
Returns a string containing the IP address representation.
# File ruby/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() Link
Returns a string containing the IP address representation in canonical form.
zone_id() Link
Returns the IPv6 zone identifier, if present. Raises InvalidAddressError
if not an IPv6 address.
zone_id=(zid) Link
Returns the IPv6 zone identifier, if present. Raises InvalidAddressError
if not an IPv6 address.
|(other) Link
Returns a new ipaddr built by bitwise OR.
~() Link
Returns a new ipaddr built by bitwise negation.
Instance Protected methods
begin_addr() Link
end_addr() Link
mask!(mask) Link
Set
current netmask to given mask.
# File ruby/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) Link
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 ruby/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