ruby-nmap 0.10.0 → 1.0.0

data/lib/nmap/xml/os.rb

@@ -0,0 +1,131 @@
+require 'nmap/xml/os_class'
+require 'nmap/xml/os_match'
+
+module Nmap
+  class XML
+    #
+    # Wraps the `os` XML element.
+    #
+    # @since 1.0.0
+    #
+    class OS
+
+      include Enumerable
+
+      #
+      # Creates a new OS object.
+      #
+      # @param [Nokogiri::XML::Node] node
+      #   The node that contains the OS guessing information.
+      #
+      def initialize(node)
+        @node = node
+      end
+
+      #
+      # Parses the OS class information.
+      #
+      # @yield [class]
+      #   Passes each OS class to the given block.
+      #
+      # @yieldparam [OSClass] class
+      #   The OS class information.
+      #
+      # @return [OS, Enumerator]
+      #   The OS information. If no block was given, an enumerator object
+      #   will be returned.
+      #
+      def each_class
+        return enum_for(__method__) unless block_given?
+
+        @node.xpath("osmatch/osclass").each do |osclass|
+          yield OSClass.new(osclass)
+        end
+
+        return self
+      end
+
+      #
+      # Parses the OS class information.
+      #
+      # @return [Array<OSClass>]
+      #   The OS class information.
+      #
+      def classes
+        each_class.to_a
+      end
+
+      #
+      # Parses the OS match information.
+      #
+      # @yield [match]
+      #   Passes each OS match to the given block.
+      #
+      # @yieldparam [OSMatch] class
+      #   The OS match information.
+      #
+      # @return [OS, Enumerator]
+      #   The OS information. If no block was given, an enumerator object
+      #   will be returned.
+      #
+      def each_match
+        return enum_for(__method__) unless block_given?
+
+        @node.xpath("osmatch").map do |osclass|
+          os_match = OSMatch.new(
+            osclass['name'],
+            osclass['accuracy'].to_i
+          )
+
+          yield os_match
+        end
+
+        return self
+      end
+
+      #
+      # Parses the OS match information.
+      #
+      # @return [Array<OSMatch>]
+      #   The OS match information.
+      #
+      def matches
+        each_match.to_a
+      end
+
+      #
+      # Parses the ports used for guessing the OS.
+      #
+      # @return [Array<Integer>]
+      #   The ports used.
+      #
+      def ports_used
+        @ports_used ||= @node.xpath("portused/@portid").map do |port|
+          port.inner_text.to_i
+        end
+      end
+
+      #
+      # Parses the OS fingerprint used by Nmap.
+      #
+      # @return [String]
+      #   The OS fingerprint.
+      #
+      def fingerprint
+        @fingerprint ||= if (fingerprint = @node.at_xpath("osfingerprint/@fingerprint"))
+                           fingerprint.inner_text
+                         end
+      end
+
+      #
+      # Parses the OS match information.
+      #
+      # @see #each_match
+      #
+      def each(&block)
+        each_match(&block)
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/os_class.rb

@@ -0,0 +1,86 @@
+require 'nmap/xml/cpe'
+
+module Nmap
+  class XML
+    #
+    # Represents an {OS} class.
+    #
+    # @since 1.0.0
+    #
+    class OSClass
+
+      include CPE
+
+      #
+      # Initializes the OS.
+      #
+      # @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.
+      #
+      # @return [String]
+      #   The String form of the OS class.
+      #
+      def to_s
+        "#{self.type} #{self.vendor} (#{self.accuracy}%)"
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/os_match.rb

@@ -0,0 +1,22 @@
+module Nmap
+  class XML
+    #
+    # Represents a match for a specific {OS}.
+    #
+    # @since 1.0.0
+    #
+    class OSMatch < Struct.new(:name, :accuracy)
+
+      #
+      # Converts the OS match to a String.
+      #
+      # @return [String]
+      #   The String form of the OS match.
+      #
+      def to_s
+        "#{self.name} (#{self.accuracy}%)"
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/port.rb

@@ -0,0 +1,114 @@
+require 'nmap/xml/service'
+require 'nmap/xml/scripts'
+
+module Nmap
+  class XML
+    #
+    # Wraps a `port` XML element.
+    #
+    # @since 1.0.0
+    #
+    class Port
+
+      include Scripts
+
+      #
+      # Creates a new Port object.
+      #
+      # @param [Nokogiri::XML::Element] node
+      #   The XML `port` element.
+      #
+      def initialize(node)
+        @node = node
+      end
+
+      #
+      # The protocol the port runs on
+      #
+      # @return [Symbol]
+      #   The protocol of the port.
+      #
+      def protocol
+        @protocol ||= @node['protocol'].to_sym
+      end
+
+      #
+      # The port number.
+      #
+      # @return [Integer]
+      #   The number of the port.
+      #
+      def number
+        @number ||= @node['portid'].to_i
+      end
+
+      #
+      # The state of the port.
+      #
+      # @return [Symbol]
+      #   The state of the port (`:open`, `:filtered` or `:closed`).
+      #
+      def state
+        @state ||= @node.at_xpath('state/@state').inner_text.to_sym
+      end
+
+      #
+      # The reason the port was discovered.
+      #
+      # @return [String]
+      #   How the port was discovered.
+      #
+      def reason
+        @reason ||= @node.at_xpath('state/@reason').inner_text
+      end
+
+      #
+      # The reason TTL.
+      #
+      # @return [Integer]
+      #
+      # @since 0.10.0
+      #
+      def reason_ttl
+        @reason ||= @node.at_xpath('state/@reason_ttl').inner_text.to_i
+      end
+
+      #
+      # The fingerprinted service of the port.
+      #
+      # @return [Service]
+      #   The service detected on the port.
+      #
+      # @since 0.6.0
+      #
+      def service
+        @service_info ||= if (service = @node.at_xpath('service'))
+                            Service.new(service)
+                          end
+      end
+
+      alias to_i number
+
+      #
+      # Converts the port to a String.
+      #
+      # @return [String]
+      #   The port number.
+      #
+      def to_s
+        number.to_s
+      end
+
+      #
+      # Inspects the port.
+      #
+      # @return [String]
+      #   The inspected port.
+      #
+      def inspect
+        "#<#{self.class}: #{self}>"
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/postscript.rb

@@ -0,0 +1,26 @@
+require 'nmap/xml/scripts'
+
+module Nmap
+  class XML
+    #
+    # Represents the `postscript` element.
+    #
+    # @since 1.0.0
+    #
+    class Postscript
+
+      include Scripts
+
+      #
+      # Initializes the Postscript object.
+      #
+      # @param [Nokogiri::XML::Node] node
+      #   The XML node that contains the host information.
+      #
+      def initialize(node)
+        @node = node
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/prescript.rb

@@ -0,0 +1,26 @@
+require 'nmap/xml/scripts'
+
+module Nmap
+  class XML
+    #
+    # Represents the `prescript` element.
+    #
+    # @since 1.0.0
+    #
+    class Prescript
+
+      include Scripts
+
+      #
+      # Initializes the Prescript object.
+      #
+      # @param [Nokogiri::XML::Node] node
+      #   The XML node that contains the host information.
+      #
+      def initialize(node)
+        @node = node
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/run_stat.rb

@@ -0,0 +1,22 @@
+module Nmap
+  class XML
+    #
+    # Represents the runstats of a scan.
+    #
+    # @since 1.0.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
+end

data/lib/nmap/xml/scan.rb

@@ -0,0 +1,38 @@
+module Nmap
+  class XML
+    #
+    # Represents an Nmap scan.
+    #
+    # @since 1.0.0
+    #
+    class Scan < Struct.new(:type, :protocol, :services)
+
+      #
+      # Creates a new Scan object.
+      #
+      # @param [Symbol] type
+      #   The type of the scan.
+      #
+      # @param [Symbol] protocol
+      #   The protocol used for the scan.
+      #
+      # @param [Array<Integer, Rage>] services
+      #   The port numbers scanned.
+      #
+      def initialize(type,protocol,services=[])
+        super(type,protocol,services)
+      end
+
+      #
+      # Converts the scan to a String.
+      #
+      # @return [String]
+      #   The String form of the scan.
+      #
+      def to_s
+        "#{self.protocol} #{self.type}"
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/scan_task.rb

@@ -0,0 +1,55 @@
+module Nmap
+  class XML
+    #
+    # @since 1.0.0
+    #
+    class ScanTask < Struct.new(:name, :start_time, :end_time, :extra_info)
+
+      #
+      # Creates a new ScanTask object.
+      #
+      # @param [String] name
+      #   The name of the scan task.
+      #
+      # @param [Time] start_time
+      #   The time the scan task begun.
+      #
+      # @param [Time] end_time
+      #   The time the scan task ended.
+      #
+      # @param [String] extra_info
+      #   Any extra information relating to the scan task.
+      #
+      # @since 0.1.2
+      #
+      def initialize(name,start_time,end_time,extra_info=nil)
+        super
+      end
+
+      #
+      # The duration of the scan task.
+      #
+      # @return [Integer]
+      #   The number of seconds it took the scan task to complete.
+      #
+      # @since 0.1.2
+      #
+      def duration
+        (self.end_time - self.start_time)
+      end
+
+      #
+      # Converts the scan task to a String.
+      #
+      # @return [String]
+      #   The String form of the scan task.
+      #
+      # @since 0.1.2
+      #
+      def to_s
+        "#{self.start_time}: #{self.name} (#{self.extra_info})"
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/scanner.rb

@@ -0,0 +1,22 @@
+module Nmap
+  class XML
+    #
+    # Describes the `nmap` command.
+    #
+    # @since 1.0.0
+    #
+    class Scanner < Struct.new(:name, :version, :arguments, :start_time)
+
+      #
+      # Converts the scanner to a String.
+      #
+      # @return [String]
+      #   The scanner name and arguments.
+      #
+      def to_s
+        "#{self.name} #{self.arguments}"
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/script.rb

@@ -0,0 +1,110 @@
+module Nmap
+  class XML
+    #
+    # Wraps a `script` XML element.
+    #
+    # @since 1.0.0
+    #
+    class Script
+
+      #
+      # Initializes a new Script object.
+      #
+      # @param [Nokogiri::XML::Node] node
+      #   The XML node that contains the host information.
+      #
+      def initialize(node)
+        @node = node
+      end
+
+      #
+      # The ID of the NSE script.
+      #
+      # @return [String]
+      #
+      def id
+        @id ||= @node['id']
+      end
+
+      #
+      # The text output from the NSE script.
+      #
+      # @return [String]
+      #
+      def output
+        @output ||= @node['output']
+      end
+
+      #
+      # Parses the structured data within the `<script>` XML element.
+      #
+      # @return [Hash{String => Hash,Array,String}, Array<Hash>, Array<String>, nil]
+      #   The parsed data.
+      #
+      def data
+        @data ||= parse_table(@node)
+      end
+
+      private
+
+      #
+      # Parses the `<table>` XML child elements within the given node.
+      #
+      # @param [Nokogiri::XML::Node] node
+      #   The XML node that contains the host information.
+      #
+      # @return [Hash{String => Hash,Array,String}, Array<Hash>, Array<String>, nil]
+      #   The parsed data.
+      #
+      def parse_tables(node)
+        if (tables = @node.xpath('table')).empty?
+          return
+        end
+
+        # check for named tables
+        if tables.all? { |table| table.has_attribute?('key') }
+          Hash[
+            tables.map { |table|
+              [table['key'], parse_table(table)]
+            }
+          ]
+        else
+          tables.map(&method(:parse_table))
+        end
+      end
+
+      #
+      # Parses the contents of a `<table>` XML element.
+      #
+      # @param [Nokogiri::XML::Node] node
+      #   The XML node that contains the host information.
+      #
+      # @return [Hash{String => Hash,Array<String>,String}, Array<String>, nil]
+      #   The parsed data.
+      #
+      def parse_table(node)
+        # check for nested tables
+        if node.xpath('count(table)') > 0
+          return parse_tables(node)
+        end
+
+        if (elems = node.xpath('elem')).empty?
+          # return nil if there are no elements
+          return
+        end
+
+        # check for named elements
+        if elems.all? { |elem| elem.has_attribute?('key') }
+          Hash[
+            elems.map { |elem|
+              [elem['key'], elem.inner_text]
+            }
+          ]
+        else
+          elems.map(&:inner_text)
+        end
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/scripts.rb

@@ -0,0 +1,33 @@
+require 'nmap/xml/script'
+
+module Nmap
+  class XML
+    #
+    # Mixin that adds methods for parsing `<script>` XML elements.
+    #
+    # @since 1.0.0
+    #
+    module Scripts
+      #
+      # The output from the NSE script's output and structured data.
+      #
+      # @return [Hash{String => Script}]
+      #   The NSE script names and output.
+      #
+      # @since 0.3.0
+      #
+      def scripts
+        unless @scripts
+          @scripts = {}
+
+          @node.xpath('script').each do |script|
+            @scripts[script['id']] = Script.new(script)
+          end
+        end
+
+        return @scripts
+      end
+
+    end
+  end
+end