module IPAddress

Constants

AUTHORS
GEM
NAME

Public Class Methods

parse(str) click to toggle source

Parse the argument string to create a new IPv4, IPv6 or Mapped IP object

ip  = IPAddress.parse "172.16.10.1/24"
ip6 = IPAddress.parse "2001:db8::8:800:200c:417a/64"
ip_mapped = IPAddress.parse "::ffff:172.16.10.1/128"

All the object created will be instances of the correct class:

ip.class
  #=> IPAddress::IPv4
ip6.class
  #=> IPAddress::IPv6
ip_mapped.class
  #=> IPAddress::IPv6::Mapped

# File lib/ipaddress.rb, line 42
def IPAddress::parse(str)
  case str
  when %r:.+\./
    IPAddress::IPv6::Mapped.new(str)
  else
    IPAddress::IPv4.new(str) rescue IPAddress::IPv6.new(str)
  end
end

valid?(addr) click to toggle source

Checks if the given string is a valid IP address, either IPv4 or IPv6

Example:

IPAddress::valid? "2002::1"
  #=> true

IPAddress::valid? "10.0.0.256"   
  #=> false

# File lib/ipaddress.rb, line 87
def self.valid?(addr)
  valid_ipv4?(addr) || valid_ipv6?(addr)
end

valid_ipv4?(addr) click to toggle source

Checks if the given string is a valid IPv4 address

Example:

IPAddress::valid_ipv4? "2002::1"
  #=> false

IPAddress::valid_ipv4? "172.16.10.1"
  #=> true

# File lib/ipaddress.rb, line 102
def self.valid_ipv4?(addr)
  if %r\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\Z/ =~ addr
    return $~.captures.all? {|i| i.to_i < 256}
  end
  false
end

valid_ipv4_netmask?(addr) click to toggle source

Checks if the argument is a valid IPv4 netmask expressed in dotted decimal format.

IPAddress.valid_ipv4_netmask? "255.255.0.0"
  #=> true

# File lib/ipaddress.rb, line 116
def self.valid_ipv4_netmask?(addr)
  arr = addr.split(".").map{|i| i.to_i}.pack("CCCC").unpack("B*").first.scan(%r01/)
  arr.empty? && valid_ipv4?(addr)
rescue
  return false
end

valid_ipv6?(addr) click to toggle source

Checks if the given string is a valid IPv6 address

Example:

IPAddress::valid_ipv6? "2002::1"
  #=> true

IPAddress::valid_ipv6? "2002::DEAD::BEEF"
  #=> false

# File lib/ipaddress.rb, line 134
def self.valid_ipv6?(addr)
  # IPv6 (normal)
  return true if %r\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*\Z/ =~ addr
  return true if %r\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*)?\Z/ =~ addr
  return true if %r\A::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*)?\Z/ =~ addr
  # IPv6 (IPv4 compat)
  return true if %r\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*:/ =~ addr && valid_ipv4?($')
  return true if %r\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*:)?/ =~ addr && valid_ipv4?($')
  return true if %r\A::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*:)?/ =~ addr && valid_ipv4?($')
  false
end

Public Instance Methods

ipv4?() click to toggle source

True if the object is an IPv4 address

ip = IPAddress("192.168.10.100/24")

ip.ipv4?
  #-> true

# File lib/ipaddress.rb, line 59
def ipv4?
  self.kind_of? IPAddress::IPv4
end

ipv6?() click to toggle source

True if the object is an IPv6 address

ip = IPAddress("192.168.10.100/24")

ip.ipv6?
  #-> false

# File lib/ipaddress.rb, line 71
def ipv6?
  self.kind_of? IPAddress::IPv6
end