Class: IPAddr
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>
Defined Under Namespace
Classes: AddressFamilyError, Error, InvalidAddressError, InvalidPrefixError
Constant Summary collapse
- IN4MASK =
32 bit mask for IPv4
0xffffffff
- IN6MASK =
128 bit mask for IPv6
0xffffffffffffffffffffffffffffffff
- IN6FORMAT =
Format string for IPv6
(["%.4x"] * 8).join(':')
- RE_IPV4ADDRLIKE =
Regexp internally used for parsing IPv4 address.
%r{ \A (\d+) \. (\d+) \. (\d+) \. (\d+) \z }x
- 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
- 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
Instance Attribute Summary collapse
-
#family ⇒ Object
readonly
Returns the address family of this IP address.
Class Method Summary collapse
-
.new_ntoh(addr) ⇒ Object
Creates a new ipaddr containing the given network byte ordered string form of an IP address.
-
.ntop(addr) ⇒ Object
Convert a network byte ordered string form of an IP address into human readable form.
Instance Method Summary collapse
-
#&(other) ⇒ Object
Returns a new ipaddr built by bitwise AND.
-
#<<(num) ⇒ Object
Returns a new ipaddr built by bitwise left shift.
-
#<=>(other) ⇒ Object
Compares the ipaddr with another.
-
#==(other) ⇒ Object
Returns true if two ipaddrs are equal.
-
#>>(num) ⇒ Object
Returns a new ipaddr built by bitwise right-shift.
-
#eql?(other) ⇒ Boolean
Checks equality used by Hash.
-
#hash ⇒ Object
Returns a hash value used by Hash, Set, and Array classes.
-
#hton ⇒ Object
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 ⇒ Object
Returns a string containing a human-readable representation of the ipaddr.
-
#ip6_arpa ⇒ Object
Returns a string for DNS reverse lookup compatible with RFC3172.
-
#ip6_int ⇒ Object
Returns a string for DNS reverse lookup compatible with RFC1886.
-
#ipv4? ⇒ Boolean
Returns true if the ipaddr is an IPv4 address.
-
#ipv4_compat ⇒ Object
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-compatible IPv6 address.
-
#ipv4_compat? ⇒ Boolean
Returns true if the ipaddr is an IPv4-compatible IPv6 address.
-
#ipv4_mapped ⇒ Object
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-mapped IPv6 address.
-
#ipv4_mapped? ⇒ Boolean
Returns true if the ipaddr is an IPv4-mapped IPv6 address.
-
#ipv6? ⇒ Boolean
Returns true if the ipaddr is an IPv6 address.
-
#link_local? ⇒ Boolean
Returns true if the ipaddr is a link-local address.
-
#loopback? ⇒ Boolean
Returns true if the ipaddr is a loopback address.
-
#mask(prefixlen) ⇒ Object
Returns a new ipaddr built by masking IP address with the given prefixlen/netmask.
-
#native ⇒ Object
Returns a new ipaddr built by converting the IPv6 address into a native IPv4 address.
-
#netmask ⇒ Object
Returns the netmask in string format e.g.
-
#prefix ⇒ Object
Returns the prefix length in bits for the ipaddr.
-
#prefix=(prefix) ⇒ Object
Sets the prefix length in bits.
-
#private? ⇒ Boolean
Returns true if the ipaddr is a private address.
-
#reverse ⇒ Object
Returns a string for DNS reverse lookup.
-
#succ ⇒ Object
Returns the successor to the ipaddr.
-
#to_i ⇒ Object
Returns the integer representation of the ipaddr.
-
#to_range ⇒ Object
Creates a Range object for the network address.
-
#to_s ⇒ Object
Returns a string containing the IP address representation.
-
#to_string ⇒ Object
Returns a string containing the IP address representation in canonical form.
-
#zone_id ⇒ Object
Returns the IPv6 zone identifier, if present.
-
#zone_id=(zid) ⇒ Object
Returns the IPv6 zone identifier, if present.
-
#|(other) ⇒ Object
Returns a new ipaddr built by bitwise OR.
-
#~ ⇒ Object
Returns a new ipaddr built by bitwise negation.
Instance Attribute Details
#family ⇒ Object (readonly)
Returns the address family of this IP address.
102 103 104 |
# File 'lib/ipaddr.rb', line 102 def family @family end |
Class Method Details
.new_ntoh(addr) ⇒ Object
Creates a new ipaddr containing the given network byte ordered string form of an IP address.
106 107 108 |
# File 'lib/ipaddr.rb', line 106 def self.new_ntoh(addr) return new(ntop(addr)) end |
.ntop(addr) ⇒ Object
Convert a network byte ordered string form of an IP address into human readable form.
112 113 114 115 116 117 118 119 120 121 |
# File 'lib/ipaddr.rb', line 112 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 |
Instance Method Details
#&(other) ⇒ Object
Returns a new ipaddr built by bitwise AND.
124 125 126 |
# File 'lib/ipaddr.rb', line 124 def &(other) return self.clone.set(@addr & coerce_other(other).to_i) end |
#<<(num) ⇒ Object
Returns a new ipaddr built by bitwise left shift.
139 140 141 |
# File 'lib/ipaddr.rb', line 139 def <<(num) return self.clone.set(addr_mask(@addr << num)) end |
#<=>(other) ⇒ Object
Compares the ipaddr with another.
381 382 383 384 385 386 387 |
# File 'lib/ipaddr.rb', line 381 def <=>(other) other = coerce_other(other) rescue nil else @addr <=> other.to_i if other.family == @family end |
#==(other) ⇒ Object
Returns true if two ipaddrs are equal.
149 150 151 152 153 154 155 |
# File 'lib/ipaddr.rb', line 149 def ==(other) other = coerce_other(other) rescue false else @family == other.family && @addr == other.to_i end |
#>>(num) ⇒ Object
Returns a new ipaddr built by bitwise right-shift.
134 135 136 |
# File 'lib/ipaddr.rb', line 134 def >>(num) return self.clone.set(@addr >> num) end |
#eql?(other) ⇒ Boolean
Checks equality used by Hash.
391 392 393 |
# File 'lib/ipaddr.rb', line 391 def eql?(other) return self.class == other.class && self.hash == other.hash && self == other end |
#hash ⇒ Object
Returns a hash value used by Hash, Set, and Array classes
396 397 398 |
# File 'lib/ipaddr.rb', line 396 def hash return ([@addr, @mask_addr, @zone_id].hash << 1) | (ipv4? ? 0 : 1) end |
#hton ⇒ Object
Returns a network byte ordered string form of the IP address.
227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/ipaddr.rb', line 227 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) ⇒ Boolean Also known as: ===
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
175 176 177 178 179 180 181 |
# File 'lib/ipaddr.rb', line 175 def include?(other) other = coerce_other(other) return false unless other.family == family range = to_range other = other.to_range range.begin <= other.begin && range.end >= other.end end |
#inspect ⇒ Object
Returns a string containing a human-readable representation of the ipaddr. (“#<IPAddr: family:address/mask>”)
447 448 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/ipaddr.rb', line 447 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 ⇒ Object
Returns a string for DNS reverse lookup compatible with RFC3172.
360 361 362 363 364 365 |
# File 'lib/ipaddr.rb', line 360 def ip6_arpa if !ipv6? raise InvalidAddressError, "not an IPv6 address: #{@addr}" end return _reverse + ".ip6.arpa" end |
#ip6_int ⇒ Object
Returns a string for DNS reverse lookup compatible with RFC1886.
368 369 370 371 372 373 |
# File 'lib/ipaddr.rb', line 368 def ip6_int if !ipv6? raise InvalidAddressError, "not an IPv6 address: #{@addr}" end return _reverse + ".ip6.int" end |
#ipv4? ⇒ Boolean
Returns true if the ipaddr is an IPv4 address.
241 242 243 |
# File 'lib/ipaddr.rb', line 241 def ipv4? return @family == Socket::AF_INET end |
#ipv4_compat ⇒ Object
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-compatible IPv6 address.
328 329 330 331 332 333 334 |
# File 'lib/ipaddr.rb', line 328 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? ⇒ Boolean
Returns true if the ipaddr is an IPv4-compatible IPv6 address.
300 301 302 303 |
# File 'lib/ipaddr.rb', line 300 def ipv4_compat? warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE _ipv4_compat? end |
#ipv4_mapped ⇒ Object
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-mapped IPv6 address.
317 318 319 320 321 322 323 324 |
# File 'lib/ipaddr.rb', line 317 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? ⇒ Boolean
Returns true if the ipaddr is an IPv4-mapped IPv6 address.
295 296 297 |
# File 'lib/ipaddr.rb', line 295 def ipv4_mapped? return ipv6? && (@addr >> 32) == 0xffff end |
#ipv6? ⇒ Boolean
Returns true if the ipaddr is an IPv6 address.
246 247 248 |
# File 'lib/ipaddr.rb', line 246 def ipv6? return @family == Socket::AF_INET6 end |
#link_local? ⇒ Boolean
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.
283 284 285 286 287 288 289 290 291 292 |
# File 'lib/ipaddr.rb', line 283 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? ⇒ Boolean
Returns true if the ipaddr is a loopback address.
251 252 253 254 255 256 257 258 259 260 |
# File 'lib/ipaddr.rb', line 251 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) ⇒ Object
Returns a new ipaddr built by masking IP address with the given prefixlen/netmask. (e.g. 8, 64, “255.255.255.0”, etc.)
159 160 161 |
# File 'lib/ipaddr.rb', line 159 def mask(prefixlen) return self.clone.mask!(prefixlen) end |
#native ⇒ Object
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.
339 340 341 342 343 344 |
# File 'lib/ipaddr.rb', line 339 def native if !ipv4_mapped? && !_ipv4_compat? return self end return self.clone.set(@addr & IN4MASK, Socket::AF_INET) end |
#netmask ⇒ Object
Returns the netmask in string format e.g. 255.255.0.0
462 463 464 |
# File 'lib/ipaddr.rb', line 462 def netmask _to_string(@mask_addr) end |
#prefix ⇒ Object
Returns the prefix length in bits for the ipaddr.
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 |
# File 'lib/ipaddr.rb', line 417 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) ⇒ Object
Sets the prefix length in bits
436 437 438 439 440 441 442 443 |
# File 'lib/ipaddr.rb', line 436 def prefix=(prefix) case prefix when Integer mask!(prefix) else raise InvalidPrefixError, "prefix must be an integer: #{@addr}" end end |
#private? ⇒ Boolean
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.
266 267 268 269 270 271 272 273 274 275 276 277 |
# 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 else raise AddressFamilyError, "unsupported address family" end end |
#reverse ⇒ Object
Returns a string for DNS reverse lookup. It returns a string in RFC3172 form for an IPv6 address.
348 349 350 351 352 353 354 355 356 357 |
# File 'lib/ipaddr.rb', line 348 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 ⇒ Object
Returns the successor to the ipaddr.
376 377 378 |
# File 'lib/ipaddr.rb', line 376 def succ return self.clone.set(@addr + 1, @family) end |
#to_i ⇒ Object
Returns the integer representation of the ipaddr.
185 186 187 |
# File 'lib/ipaddr.rb', line 185 def to_i return @addr end |
#to_range ⇒ Object
Creates a Range object for the network address.
401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
# File 'lib/ipaddr.rb', line 401 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 ⇒ Object
Returns a string containing the IP address representation.
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/ipaddr.rb', line 190 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 ⇒ Object
Returns a string containing the IP address representation in canonical form.
216 217 218 219 220 221 222 223 224 |
# File 'lib/ipaddr.rb', line 216 def to_string str = _to_string(@addr) if @family == Socket::AF_INET6 str << zone_id.to_s end return str end |
#zone_id ⇒ Object
Returns the IPv6 zone identifier, if present. Raises InvalidAddressError if not an IPv6 address.
468 469 470 471 472 473 474 |
# File 'lib/ipaddr.rb', line 468 def zone_id if @family == Socket::AF_INET6 @zone_id else raise InvalidAddressError, "not an IPv6 address" end end |
#zone_id=(zid) ⇒ Object
Returns the IPv6 zone identifier, if present. Raises InvalidAddressError if not an IPv6 address.
478 479 480 481 482 483 484 485 486 487 488 489 |
# File 'lib/ipaddr.rb', line 478 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) ⇒ Object
Returns a new ipaddr built by bitwise OR.
129 130 131 |
# File 'lib/ipaddr.rb', line 129 def |(other) return self.clone.set(@addr | coerce_other(other).to_i) end |
#~ ⇒ Object
Returns a new ipaddr built by bitwise negation.
144 145 146 |
# File 'lib/ipaddr.rb', line 144 def ~ return self.clone.set(addr_mask(~@addr)) end |