Class: Nexpose::IPRange

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/nexpose/site.rb

Overview

Object that represents a single IP address or an inclusive range of IP addresses. If to is nil then the from field will be used to specify a single IP Address only.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ip) ⇒ IPRange #initialize(start_ip, end_ip) ⇒ IPRange #initialize(cidr_range) ⇒ IPRange

Returns an IP address range of one or more addresses.

Overloads:

  • #initialize(ip) ⇒ IPRange

    Examples:

    Nexpose::IPRange.new('192.168.1.0')

    Parameters:

    • from (#to_s) —

      the IP single IP address.

  • #initialize(start_ip, end_ip) ⇒ IPRange

    Examples:

    Nexpose::IPRange.new('192.168.1.0', '192.168.1.255')

    Parameters:

    • from (#to_s) —

      the IP to start the range with.

    • to (#to_s) —

      the IP to end the range with.

  • #initialize(cidr_range) ⇒ IPRange
    Note:

    The range will not be stripped of reserved IP addresses (such as x.x.x.0 and x.x.x.255).

    Examples:

    Nexpose::IPRange.new('192.168.1.0/24')

    Parameters:

    • from (#to_s) —

      the CIDR notation IP address range.



651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/nexpose/site.rb', line 651

def initialize(from, to = nil)
  @from = from
  @to   = to unless from == to

  return unless @to.nil?

  range = IPAddr.new(@from.to_s).to_range
  unless range.one?
    @from = range.first.to_s
    @to   = range.last.to_s
  end
end

Instance Attribute Details

#from ⇒ Object

Start of range *Required



628
629
630
 
# File 'lib/nexpose/site.rb', line 628

def from
  @from
end

#to ⇒ Object

End of range *Optional (If nil then IPRange is a single IP Address)



630
631
632
 
# File 'lib/nexpose/site.rb', line 630

def to
  @to
end

Instance Method Details

#<=>(other) ⇒ Object 



678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/nexpose/site.rb', line 678

def <=>(other)
  return 1 unless other.respond_to? :from
  from    = IPAddr.new(@from)
  to      = @to.nil? ? from : IPAddr.new(@to)
  cf_from = IPAddr.new(other.from)
  cf_to   = IPAddr.new(other.to.nil? ? other.from : other.to)
  if cf_to < from
    1
  elsif to < cf_from
    -1
  else # Overlapping
    0
  end
end

#==(other) ⇒ Object 



693
694
695
 
# File 'lib/nexpose/site.rb', line 693

def ==(other)
  eql?(other)
end

#as_xml ⇒ Object Also known as: to_xml_elem 



721
722
723
724
725
 
# File 'lib/nexpose/site.rb', line 721

def as_xml
  xml = REXML::Element.new('range')
  xml.add_attributes({ 'from' => @from, 'to' => @to })
  xml
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


697
698
699
700
 
# File 'lib/nexpose/site.rb', line 697

def eql?(other)
  return false unless other.respond_to? :from
  @from == other.from && @to == other.to
end

#hash ⇒ Object 



717
718
719
 
# File 'lib/nexpose/site.rb', line 717

def hash
  to_xml.hash
end

#include?(single_ip) ⇒ Boolean

Returns:

  • (Boolean) 


702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/nexpose/site.rb', line 702

def include?(single_ip)
  return false unless single_ip.respond_to? :from
  from  = IPAddr.new(@from)
  to    = @to.nil? ? from : IPAddr.new(@to)
  other = IPAddr.new(single_ip)

  if other < from
    false
  elsif to < other
    false
  else
    true
  end
end

#size ⇒ Fixnum

Size of the IP range. The total number of IP addresses represented by this range.

Returns:

  • (Fixnum) —

    size of the range.



669
670
671
672
673
674
 
# File 'lib/nexpose/site.rb', line 669

def size
  return 1 if @to.nil?
  from = IPAddr.new(@from)
  to   = IPAddr.new(@to)
  (from..to).to_a.size
end

#to_s ⇒ Object 



732
733
734
735
 
# File 'lib/nexpose/site.rb', line 732

def to_s
  return from.to_s if to.nil?
  "#{from.to_s} - #{to.to_s}"
end

#to_xml ⇒ Object 



728
729
730
 
# File 'lib/nexpose/site.rb', line 728

def to_xml
  as_xml.to_s
end