Class: IPAddr

Inherits:
Object
  • Object
show all
Includes:
Comparable
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>

Defined Under Namespace

Classes: AddressFamilyError, Error, InvalidAddressError, InvalidPrefixError

Constant Summary collapse

VERSION =

The version string

"1.2.8"
IN4MASK =

32 bit mask for IPv4

0xffffffff
IN6MASK =

128 bit mask for IPv6

0xffffffffffffffffffffffffffffffff
IN6FORMAT =

Format string for IPv6

(["%.4x"] * 8).join(':').freeze
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

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#family ⇒ Object (readonly)

Returns the address family of this IP address.



104
105
106
 
# File 'lib/ipaddr.rb', line 104

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.



108
109
110
 
# File 'lib/ipaddr.rb', line 108

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. It expects the string to be encoded in Encoding::ASCII_8BIT (BINARY).



115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# 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

Instance Method Details

#&(other) ⇒ Object

Returns a new ipaddr built by bitwise AND.



131
132
133
 
# File 'lib/ipaddr.rb', line 131

def &(other)
  return self.clone.set(@addr & coerce_other(other).to_i)
end

#+(offset) ⇒ Object

Returns a new ipaddr greater than the original address by offset



156
157
158
 
# File 'lib/ipaddr.rb', line 156

def +(offset)
  self.clone.set(@addr + offset, @family)
end

#-(offset) ⇒ Object

Returns a new ipaddr less than the original address by offset



161
162
163
 
# File 'lib/ipaddr.rb', line 161

def -(offset)
  self.clone.set(@addr - offset, @family)
end

#<<(num) ⇒ Object

Returns a new ipaddr built by bitwise left shift.



146
147
148
 
# File 'lib/ipaddr.rb', line 146

def <<(num)
  return self.clone.set(addr_mask(@addr << num))
end

#<=>(other) ⇒ Object

Compares the ipaddr with another.



435
436
437
438
439
440
441
 
# File 'lib/ipaddr.rb', line 435

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.



166
167
168
169
170
171
172
 
# File 'lib/ipaddr.rb', line 166

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.



141
142
143
 
# File 'lib/ipaddr.rb', line 141

def >>(num)
  return self.clone.set(@addr >> num)
end

#as_json ⇒ Object

Returns a string containing the IP address representation with prefix.



242
243
244
245
246
247
248
249
250
 
# 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

#cidr ⇒ Object

Returns a string containing the IP address representation in cidr notation



259
260
261
 
# File 'lib/ipaddr.rb', line 259

def cidr
  "#{to_s}/#{prefix}"
end

#eql?(other) ⇒ Boolean

Checks equality used by Hash.

Returns:

  • (Boolean) 


445
446
447
 
# File 'lib/ipaddr.rb', line 445

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



450
451
452
 
# File 'lib/ipaddr.rb', line 450

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.



264
265
266
267
268
269
270
271
272
273
274
275
 
# 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

#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

Returns:

  • (Boolean) 


192
193
194
195
196
 
# 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

#inspect ⇒ Object

Returns a string containing a human-readable representation of the ipaddr. (“#<IPAddr: family:address/mask>”)



490
491
492
493
494
495
496
497
498
499
500
501
502
 
# 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

#ip6_arpa ⇒ Object

Returns a string for DNS reverse lookup compatible with RFC3172.



414
415
416
417
418
419
 
# File 'lib/ipaddr.rb', line 414

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.



422
423
424
425
426
427
 
# File 'lib/ipaddr.rb', line 422

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.

Returns:

  • (Boolean) 


278
279
280
 
# File 'lib/ipaddr.rb', line 278

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.



380
381
382
383
384
385
386
387
388
 
# 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_compat? ⇒ Boolean

Returns true if the ipaddr is an IPv4-compatible IPv6 address.

Returns:

  • (Boolean) 


352
353
354
355
 
# File 'lib/ipaddr.rb', line 352

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.



369
370
371
372
373
374
375
376
 
# 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_mapped? ⇒ Boolean

Returns true if the ipaddr is an IPv4-mapped IPv6 address.

Returns:

  • (Boolean) 


347
348
349
 
# File 'lib/ipaddr.rb', line 347

def ipv4_mapped?
  return ipv6? && (@addr >> 32) == 0xffff
end

#ipv6? ⇒ Boolean

Returns true if the ipaddr is an IPv6 address.

Returns:

  • (Boolean) 


283
284
285
 
# File 'lib/ipaddr.rb', line 283

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. Link-local IPv4 addresses in the IPv4-mapped IPv6 address range are also considered link-local.

Returns:

  • (Boolean) 


332
333
334
335
336
337
338
339
340
341
342
343
344
 
# 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

#loopback? ⇒ Boolean

Returns true if the ipaddr is a loopback address. Loopback IPv4 addresses in the IPv4-mapped IPv6 address range are also considered as loopback addresses.

Returns:

  • (Boolean) 


290
291
292
293
294
295
296
297
298
299
300
301
302
 
# 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

#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.)



176
177
178
 
# File 'lib/ipaddr.rb', line 176

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.



393
394
395
396
397
398
 
# 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

#netmask ⇒ Object

Returns the netmask in string format e.g. 255.255.0.0



505
506
507
 
# File 'lib/ipaddr.rb', line 505

def netmask
  _to_string(@mask_addr)
end

#prefix ⇒ Object

Returns the prefix length in bits for the ipaddr.



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# 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

#prefix=(prefix) ⇒ Object

Sets the prefix length in bits



479
480
481
482
483
484
485
486
 
# 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? ⇒ 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. Private IPv4 addresses in the IPv4-mapped IPv6 address range are also considered private.

Returns:

  • (Boolean) 


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# 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

#reverse ⇒ Object

Returns a string for DNS reverse lookup. It returns a string in RFC3172 form for an IPv6 address.



402
403
404
405
406
407
408
409
410
411
 
# 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

#succ ⇒ Object

Returns the successor to the ipaddr.



430
431
432
 
# File 'lib/ipaddr.rb', line 430

def succ
  return self.clone.set(@addr + 1, @family)
end

#to_i ⇒ Object

Returns the integer representation of the ipaddr.



200
201
202
 
# File 'lib/ipaddr.rb', line 200

def to_i
  return @addr
end

#to_json(*a) ⇒ Object

Returns a json string containing the IP address representation.



253
254
255
 
# File 'lib/ipaddr.rb', line 253

def to_json(*a)
  %Q{"#{as_json(*a)}"}
end

#to_range ⇒ Object

Creates a Range object for the network address.



455
456
457
 
# File 'lib/ipaddr.rb', line 455

def to_range
  self.class.new(begin_addr, @family)..self.class.new(end_addr, @family)
end

#to_s ⇒ Object

Returns a string containing the IP address representation.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# 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 ⇒ Object

Returns a string containing the IP address representation in canonical form.



231
232
233
234
235
236
237
238
239
 
# 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

#wildcard_mask ⇒ Object

Returns the wildcard mask in string format e.g. 0.0.255.255



510
511
512
513
514
515
516
517
518
519
520
521
 
# 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

#zone_id ⇒ Object

Returns the IPv6 zone identifier, if present. Raises InvalidAddressError if not an IPv6 address.



525
526
527
528
529
530
531
 
# 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

#zone_id=(zid) ⇒ Object

Returns the IPv6 zone identifier, if present. Raises InvalidAddressError if not an IPv6 address.



535
536
537
538
539
540
541
542
543
544
545
546
 
# 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

#|(other) ⇒ Object

Returns a new ipaddr built by bitwise OR.



136
137
138
 
# File 'lib/ipaddr.rb', line 136

def |(other)
  return self.clone.set(@addr | coerce_other(other).to_i)
end

#~ ⇒ Object

Returns a new ipaddr built by bitwise negation.



151
152
153
 
# File 'lib/ipaddr.rb', line 151

def ~
  return self.clone.set(addr_mask(~@addr))
end