ruby-nmap 0.6.0 → 0.7.0

data/lib/nmap/hostname.rb

@@ -0,0 +1,20 @@
+module Nmap
+  #
+  # Represents a hostname.
+  #
+  # @since 0.7.0
+  #
+  class Hostname < Struct.new(:type, :name)
+
+    #
+    # Converts the hostname to a String.
+    #
+    # @return [String]
+    #   The name of the host.
+    #
+    def to_s
+      self.name.to_s
+    end
+
+  end
+end

data/lib/nmap/os.rb

@@ -15,16 +15,8 @@ module Nmap
     # @param [Nokogiri::XML::Node] node
     #   The node that contains the OS guessing information.
     #
-    # @yield [os]
-    #   If a block is given, it will passed the newly created OS object.
-    #
-    # @yieldparam [OS] os
-    #   The newly created OS object.
-    #
     def initialize(node)
       @node = node
-
-      yield self if block_given?
     end
 
     #
@@ -43,15 +35,8 @@ module Nmap
     def each_class
       return enum_for(__method__) unless block_given?
 
-      @node.xpath("osclass").map do |osclass|
-        os_class = OSClass.new(
-          osclass['type'].to_sym,
-          osclass['vendor'],
-          osclass['osfamily'].to_sym,
-          osclass['accuracy'].to_i
-        )
-
-        yield os_class
+      @node.xpath("osmatch/osclass").each do |osclass|
+        yield OSClass.new(osclass)
       end
 
       return self

data/lib/nmap/os_class.rb

@@ -1,8 +1,72 @@
+require 'nmap/cpe'
+
 module Nmap
   #
   # Represents an {OS} class.
   #
-  class OSClass < Struct.new(:type, :vendor, :family, :accuracy)
+  class OSClass
+
+    include CPE
+
+    #
+    # Initializes the os class.
+    #
+    # @param [Nokogiri::XML::Node] node
+    #   The node that contains the OS Class information.
+    #
+    def initialize(node)
+      @node = node
+    end
+
+    #
+    # The OS type.
+    #
+    # @return [String]
+    #
+    def type
+      @type ||= if @node['type']
+                  @node['type'].to_sym
+                end
+    end
+
+    #
+    # The OS vendor.
+    #
+    # @return [String]
+    #
+    def vendor
+      @vendor ||= @node.get_attribute('vendor')
+    end
+
+    #
+    # The OS family.
+    #
+    # @return [Symbol, nil]
+    #
+    def family
+      @family ||= @node.get_attribute('osfamily').to_sym
+    end
+
+    #
+    # The OS generation.
+    #
+    # @return [Symbol, nil]
+    #
+    def gen
+      @gen ||= if @node['osgen']
+                 @node['osgen'].to_sym
+               end
+    end
+
+    #
+    # The accuracy of the OS class information.
+    #
+    # @return [Integer]
+    #   Returns a number between 0 and 10.
+    #
+    def accuracy
+      @accuracy ||= @node.get_attribute('accuracy').to_i
+    end
 
     #
     # Converts the OS class to a String.

data/lib/nmap/port.rb

@@ -102,5 +102,15 @@ module Nmap
       number.to_s
     end
 
+    #
+    # Inspects the port.
+    #
+    # @return [String]
+    #   The inspected port.
+    #
+    def inspect
+      "#<#{self.class}: #{self}>"
+    end
+
   end
 end

data/lib/nmap/run_stat.rb

@@ -0,0 +1,20 @@
+module Nmap
+  #
+  # Represents the runstats of a scan.
+  #
+  # @since 0.7.0
+  #
+  class RunStat < Struct.new(:end_time, :elapsed, :summary, :exit_status)
+
+    #
+    # Converts the stats to a String.
+    #
+    # @return [String]
+    #   The String form of the scan.
+    #
+    def to_s
+      "#{self.end_time} #{self.elapsed} #{self.exit_status}"
+    end
+
+  end
+end

data/lib/nmap/scan_task.rb

@@ -1,17 +1,5 @@
 module Nmap
-  class ScanTask
-
-    # The name of the scan task
-    attr_reader :name
-
-    # The time the scan task begun
-    attr_reader :start_time
-
-    # The time the scan task ended
-    attr_reader :end_time
-
-    # Extra information on the scan task
-    attr_reader :extrainfo
+  class ScanTask < Struct.new(:name, :start_time, :end_time, :extrainfo)
 
     #
     # Creates a new ScanTask object.
@@ -31,10 +19,7 @@ module Nmap
     # @since 0.1.2
     #
     def initialize(name,start_time,end_time,extrainfo=nil)
-      @name = name
-      @start_time = start_time
-      @end_time = end_time
-      @extrainfo = extrainfo
+      super
     end
 
     #
@@ -46,7 +31,7 @@ module Nmap
     # @since 0.1.2
     #
     def duration
-      (@end_time - @start_time)
+      (self.end_time - self.start_time)
     end
 
     #
@@ -58,7 +43,7 @@ module Nmap
     # @since 0.1.2
     #
     def to_s
-      "#{@start}: #{@name} (#{@extrainfo})"
+      "#{self.start_time}: #{self.name} (#{self.extrainfo})"
     end
 
   end

data/lib/nmap/sequence.rb

@@ -12,18 +12,10 @@ module Nmap
     # @param [Nokogiri::XML::Node] node
     #   The node that contains the sequence information.
     #
-    # @yield [sequence]
-    #   If a block is given, it will passed the newly created sequence.
-    #
-    # @yieldparam [Sequence] sequence
-    #   The newly created sequence object.
-    #
     # @since 0.5.0
     #
     def initialize(node)
       @node = node
-
-      yield self if block_given?
     end
 
     #
@@ -35,7 +27,7 @@ module Nmap
     # @since 0.5.0
     #
     def description
-      @node['class']
+      @description ||= @node['class']
     end
 
     #
@@ -47,15 +39,11 @@ module Nmap
     # @since 0.5.0
     #
     def values
-      unless @values
-        @values = []
-
-        if (string = @node['values'])
-          string.scan(/[^\s,]+/) { |match| @values << match.to_i(16) }
-        end
-      end
-
-      return @values
+      @values ||= if @node['values']
+                    @node['values'].split(',').map { |value| value.to_i(16) }
+                  else
+                    []
+                  end
     end
 
   end

data/lib/nmap/service.rb

@@ -1,3 +1,5 @@
+require 'nmap/cpe'
+
 module Nmap
   #
   # Wraps a `service` XML element.
@@ -6,6 +8,8 @@ module Nmap
   #
   class Service
 
+    include CPE
+
     #
     # Creates a new OS object.
     #
@@ -26,6 +30,30 @@ module Nmap
       @name ||= @node.get_attribute('name')
     end
 
+    #
+    # Determines if the service requires SSL.
+    #
+    # @return [Boolean]
+    #   Checks whether the `tunnel` XML attribute is `ssl`.
+    #
+    # @since 0.7.0
+    #
+    def ssl?
+      (@ssl ||= @node['tunnel']) == 'ssl'
+    end
+
+    #
+    # The application protocol used by the service.
+    #
+    # @return [String]
+    #   The `proto` XML attribute.
+    #
+    # @since 0.7.0
+    #
+    def protocol
+      @protocol ||= @node['proto']
+    end
+
     #
     # The product of the service.
     #
@@ -46,6 +74,18 @@ module Nmap
       @version ||= @node.get_attribute('version')
     end
 
+    #
+    # The extra information from the service scan.
+    #
+    # @return [String]
+    #   The `extrainfo` XML attribute.
+    #
+    # @since 0.7.0
+    #
+    def extra_info
+      @extra_info ||= @node['extrainfo']
+    end
+
     #
     # The hostname reported by the service.
     #
@@ -56,6 +96,30 @@ module Nmap
       @hostname ||= @node.get_attribute('hostname')
     end
 
+    #
+    # The reported OS type.
+    #
+    # @return [String]
+    #   The `ostype` XML attribute.
+    #
+    # @since 0.7.0
+    #
+    def os_type
+      @os_type ||= @node['ostype']
+    end
+
+    #
+    # The reported device type.
+    #
+    # @return [String]
+    #   The `devicetype` XML attribute.
+    #
+    # @since 0.7.0
+    #
+    def device_type
+      @device_type ||= @node['devicetype']
+    end
+
     #
     # The fingerprint method used to identify the service.
     #
@@ -66,6 +130,18 @@ module Nmap
       @fingerprint_method ||= @node.get_attribute('method').to_sym
     end
 
+    #
+    # The actual fingerprint
+    #
+    # @return [String]
+    #   The fingerprint
+    #
+    # @since 0.7.0
+    #
+    def fingerprint
+      @fingerprint ||= @node.get_attribute('servicefp')
+    end
+      
     #
     # The confidence score of the service fingerprinting.
     #

data/lib/nmap/tcp_sequence.rb

@@ -27,7 +27,7 @@ module Nmap
     # @since 0.5.0
     #
     def difficulty
-      @node['difficulty']
+      @difficulty ||= @node['difficulty']
     end
 
     #

data/lib/nmap/traceroute.rb

@@ -0,0 +1,67 @@
+require 'nmap/hop'
+
+module Nmap
+  #
+  # Wraps the `trace` XML element.
+  #
+  # @since 0.7.0
+  #
+  class Traceroute
+
+    include Enumerable
+
+    #
+    # Creates a new traceroute.
+    #
+    # @param [Nokogiri::XML::Element] node
+    #   The `trace` XML element.
+    #
+    def initialize(node)
+      @node = node
+    end
+
+    #
+    # The port used for the traceroute.
+    #
+    # @return [Integer]
+    #   The `port` XML attribute.
+    #
+    def port
+      @port ||= @node['port'].to_i
+    end
+
+    #
+    # The protocol used for the traceroute.
+    #
+    # @return [Symbol]
+    #   The `proto` XML element.
+    #
+    def protocol
+      @protocol ||= @node['proto'].to_sym
+    end
+
+    #
+    # Parses the traceroute information for the host.
+    #
+    # @yield [hop]
+    #   Each hop to the host.
+    #
+    # @yieldparam [Hop] hop
+    #   A hop to the host.
+    #
+    # @return [Traceroute, Enumerator]
+    #   The traceroute.
+    #   If no block was given, an enumerator will be returned.
+    #
+    def each
+      return enum_for(__method__) unless block_given?
+
+      @node.xpath('hop').each do |hop|
+        yield Hop.new(hop['ipaddr'],hop['host'],hop['ttl'],hop['rtt'])
+      end
+
+      return self
+    end
+
+  end
+end