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

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

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#familyObject (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
122
# File 'lib/ipaddr.rb', line 112

def self.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 Method Details

#&(other) ⇒ Object

Returns a new ipaddr built by bitwise AND.


125
126
127
# File 'lib/ipaddr.rb', line 125

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

#<<(num) ⇒ Object

Returns a new ipaddr built by bitwise left shift.


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

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

#<=>(other) ⇒ Object

Compares the ipaddr with another.


391
392
393
394
395
396
397
# File 'lib/ipaddr.rb', line 391

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.


150
151
152
153
154
155
156
# File 'lib/ipaddr.rb', line 150

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.


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

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

#eql?(other) ⇒ Boolean

Checks equality used by Hash.

Returns:

  • (Boolean)

401
402
403
# File 'lib/ipaddr.rb', line 401

def eql?(other)
  return self.class == other.class && self.hash == other.hash && self == other
end

#hashObject

Returns a hash value used by Hash, Set, and Array classes


406
407
408
# File 'lib/ipaddr.rb', line 406

def hash
  return ([@addr, @mask_addr].hash << 1) | (ipv4? ? 0 : 1)
end

#htonObject

Returns a network byte ordered string form of the IP address.


239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/ipaddr.rb', line 239

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")
p net1.include?(net2)     #=> true
p net1.include?(net3)     #=> false

Returns:

  • (Boolean)

173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/ipaddr.rb', line 173

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

#inspectObject

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


457
458
459
460
461
462
463
464
465
466
467
468
# File 'lib/ipaddr.rb', line 457

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_arpaObject

Returns a string for DNS reverse lookup compatible with RFC3172.


370
371
372
373
374
375
# File 'lib/ipaddr.rb', line 370

def ip6_arpa
  if !ipv6?
    raise InvalidAddressError, "not an IPv6 address"
  end
  return _reverse + ".ip6.arpa"
end

#ip6_intObject

Returns a string for DNS reverse lookup compatible with RFC1886.


378
379
380
381
382
383
# File 'lib/ipaddr.rb', line 378

def ip6_int
  if !ipv6?
    raise InvalidAddressError, "not an IPv6 address"
  end
  return _reverse + ".ip6.int"
end

#ipv4?Boolean

Returns true if the ipaddr is an IPv4 address.

Returns:

  • (Boolean)

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

def ipv4?
  return @family == Socket::AF_INET
end

#ipv4_compatObject

Returns a new ipaddr built by converting the native IPv4 address into an IPv4-compatible IPv6 address.


338
339
340
341
342
343
344
# File 'lib/ipaddr.rb', line 338

def ipv4_compat
  warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE
  if !ipv4?
    raise InvalidAddressError, "not an IPv4 address"
  end
  return self.clone.set(@addr, Socket::AF_INET6)
end

#ipv4_compat?Boolean

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

Returns:

  • (Boolean)

312
313
314
315
# File 'lib/ipaddr.rb', line 312

def ipv4_compat?
  warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE
  _ipv4_compat?
end

#ipv4_mappedObject

Returns a new ipaddr built by converting the native IPv4 address into an IPv4-mapped IPv6 address.


329
330
331
332
333
334
# File 'lib/ipaddr.rb', line 329

def ipv4_mapped
  if !ipv4?
    raise InvalidAddressError, "not an IPv4 address"
  end
  return self.clone.set(@addr | 0xffff00000000, Socket::AF_INET6)
end

#ipv4_mapped?Boolean

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

Returns:

  • (Boolean)

307
308
309
# File 'lib/ipaddr.rb', line 307

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

#ipv6?Boolean

Returns true if the ipaddr is an IPv6 address.

Returns:

  • (Boolean)

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

def ipv6?
  return @family == Socket::AF_INET6
end

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.

Returns:

  • (Boolean)

295
296
297
298
299
300
301
302
303
304
# File 'lib/ipaddr.rb', line 295

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.

Returns:

  • (Boolean)

263
264
265
266
267
268
269
270
271
272
# File 'lib/ipaddr.rb', line 263

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


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

def mask(prefixlen)
  return self.clone.mask!(prefixlen)
end

#nativeObject

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.


349
350
351
352
353
354
# File 'lib/ipaddr.rb', line 349

def native
  if !ipv4_mapped? && !_ipv4_compat?
    return self
  end
  return self.clone.set(@addr & IN4MASK, Socket::AF_INET)
end

#prefixObject

Returns the prefix length in bits for the ipaddr.


427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
# File 'lib/ipaddr.rb', line 427

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


446
447
448
449
450
451
452
453
# File 'lib/ipaddr.rb', line 446

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.

Returns:

  • (Boolean)

278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/ipaddr.rb', line 278

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

#reverseObject

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


358
359
360
361
362
363
364
365
366
367
# File 'lib/ipaddr.rb', line 358

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

#succObject

Returns the successor to the ipaddr.


386
387
388
# File 'lib/ipaddr.rb', line 386

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

#to_iObject

Returns the integer representation of the ipaddr.


203
204
205
# File 'lib/ipaddr.rb', line 203

def to_i
  return @addr
end

#to_rangeObject

Creates a Range object for the network address.


411
412
413
414
415
416
417
418
419
420
421
422
423
424
# File 'lib/ipaddr.rb', line 411

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_sObject

Returns a string containing the IP address representation.


208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/ipaddr.rb', line 208

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_stringObject

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


234
235
236
# File 'lib/ipaddr.rb', line 234

def to_string
  return _to_string(@addr)
end

#|(other) ⇒ Object

Returns a new ipaddr built by bitwise OR.


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

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

#~Object

Returns a new ipaddr built by bitwise negation.


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

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