ruby-nmap 0.9.3 → 1.0.0

data/lib/nmap/xml/sequence.rb

@@ -0,0 +1,52 @@
+module Nmap
+  class XML
+    #
+    # Base class for all Sequence classes.
+    #
+    # @since 1.0.0
+    #
+    class Sequence
+
+      #
+      # Creates a new sequence object.
+      #
+      # @param [Nokogiri::XML::Node] node
+      #   The node that contains the sequence information.
+      #
+      # @since 0.5.0
+      #
+      def initialize(node)
+        @node = node
+      end
+
+      #
+      # The description of the sequence.
+      #
+      # @return [String]
+      #   The sequence class from nmap.
+      # 
+      # @since 0.5.0
+      #
+      def description
+        @description ||= @node['class']
+      end
+
+      #
+      # The values within the sequence.
+      #
+      # @return [Array<Numeric>]
+      #   A sample of sequence numbers taken by nmap.
+      #
+      # @since 0.5.0
+      #
+      def values
+        @values ||= if @node['values']
+                      @node['values'].split(',').map { |value| value.to_i(16) }
+                    else
+                      []
+                    end
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/service.rb

@@ -0,0 +1,172 @@
+require 'nmap/xml/cpe'
+
+module Nmap
+  class XML
+    #
+    # Wraps a `service` XML element.
+    #
+    # @since 1.0.0
+    #
+    class Service
+
+      include CPE
+
+      #
+      # Creates a new OS object.
+      #
+      # @param [Nokogiri::XML::Node] node
+      #   The node that contains the OS guessing information.
+      #
+      def initialize(node)
+        @node = node
+      end
+
+      #
+      # The name of the service.
+      #
+      # @return [String]
+      #   The service name.
+      #
+      def name
+        @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.
+      #
+      # @return [String]
+      #   The product name.
+      #
+      def product
+        @product ||= @node.get_attribute('product')
+      end
+
+      #
+      # The version of the service.
+      #
+      # @return [String]
+      #   The service version.
+      #
+      def version
+        @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.
+      #
+      # @return [String]
+      #   The reported hostname.
+      #
+      def hostname
+        @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.
+      #
+      # @return [Symbol]
+      #   The fingerprint method.
+      #
+      def fingerprint_method
+        @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.
+      #
+      # @return [Integer]
+      #   The confidence score.
+      #
+      def confidence
+        @confidence ||= @node.get_attribute('conf').to_i
+      end
+
+      #
+      # Converts the service to a String.
+      #
+      # @return [String]
+      #   String containing {#product} and {#version}, or {#name}.
+      #
+      def to_s
+        if (product && version)
+          "#{product} #{version}"
+        else
+          name
+        end
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/status.rb

@@ -0,0 +1,22 @@
+module Nmap
+  class XML
+    #
+    # Represents the Status of a {Host}.
+    #
+    # @since 1.0.0
+    #
+    class Status < Struct.new(:state, :reason, :reason_ttl)
+
+      #
+      # Converts the status to a String.
+      #
+      # @return [String]
+      #   The state.
+      #
+      def to_s
+        self.state.to_s
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/tcp_sequence.rb

@@ -0,0 +1,48 @@
+require 'nmap/xml/sequence'
+
+module Nmap
+  class XML
+    #
+    # Represents a TCP sequence number.
+    #
+    # @since 1.0.0
+    #
+    class TcpSequence < Sequence
+
+      #
+      # @return [Numeric]
+      #   The difficulty index from nmap
+      #
+      # @since 0.5.0
+      #   
+      def index
+        @index ||= if (index_string = @node['index'])
+                     index_string.to_i
+                   end
+      end
+
+      #
+      # @return [String]
+      #   The difficulty description from nmap
+      #
+      # @since 0.5.0
+      #
+      def difficulty
+        @difficulty ||= @node['difficulty']
+      end
+
+      #
+      # Converts the TcpSequence class to a String.
+      #
+      # @return [String]
+      #   The String form of the object.
+      #
+      # @since 0.5.0
+      #
+      def to_s
+        "index=#{index} difficulty=#{difficulty.inspect} values=#{values.inspect}"
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/tcp_ts_sequence.rb

@@ -0,0 +1,26 @@
+require 'nmap/xml/sequence'
+
+module Nmap
+  class XML
+    #
+    # Represents a TCP timestamp.
+    #
+    # @since 1.0.0
+    #
+    class TcpTsSequence < Sequence
+
+      #
+      # Converts the TcpTsSequence class to a String.
+      #
+      # @return [String]
+      #   The String form of the object.
+      #
+      # @since 0.5.0
+      #
+      def to_s
+        "description=#{description.inspect} values=#{values.inspect}"
+      end
+
+    end
+  end
+end

data/lib/nmap/xml/traceroute.rb

@@ -0,0 +1,73 @@
+require 'nmap/xml/hop'
+
+module Nmap
+  class XML
+    #
+    # Wraps the `trace` XML element.
+    #
+    # @since 1.0.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, nil]
+      #   The `port` XML attribute.
+      #
+      def port
+        @port ||= if @node['port']
+                    @node['port'].to_i
+                  end
+      end
+
+      #
+      # The protocol used for the traceroute.
+      #
+      # @return [Symbol, nil]
+      #   The `proto` XML element.
+      #
+      def protocol
+        @protocol ||= if @node['proto']
+                        @node['proto'].to_sym
+                      end
+      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
+end

data/lib/nmap/xml/uptime.rb

@@ -0,0 +1,22 @@
+module Nmap
+  class XML
+    #
+    # Wraps a `uptime` XML element.
+    #
+    # @since 1.0.0
+    #
+    class Uptime < Struct.new(:seconds, :last_boot)
+
+      #
+      # Converts the uptime object to a String.
+      #
+      # @return [String]
+      #   The String form of the Uptime.
+      #
+      def to_s
+        "uptime: #{self.seconds} (#{self.last_boot})"
+      end
+
+    end
+  end
+end

data/lib/nmap/xml.rb

@@ -1,10 +1,10 @@
-require 'nmap/scanner'
-require 'nmap/scan_task'
-require 'nmap/scan'
-require 'nmap/host'
-require 'nmap/run_stat'
-require 'nmap/prescript'
-require 'nmap/postscript'
+require 'nmap/xml/scanner'
+require 'nmap/xml/scan_task'
+require 'nmap/xml/scan'
+require 'nmap/xml/host'
+require 'nmap/xml/run_stat'
+require 'nmap/xml/prescript'
+require 'nmap/xml/postscript'
 
 require 'nokogiri'
 
@@ -16,31 +16,36 @@ module Nmap
 
     include Enumerable
 
+    # The parsed XML document.
+    #
+    # @return [Nokogiri::XML]
+    #
+    # @api private
+    attr_reader :doc
+
     # Path of the Nmap XML scan file
+    #
+    # @return [String, nil]
     attr_reader :path
 
     #
     # Creates a new XML object.
     #
-    # @param [Nokogiri::XML::Document, IO, String] document
+    # @param [Nokogiri::XML::Document] doc
     #   The path to the Nmap XML scan file or Nokogiri::XML::Document.
     #
+    # @param [String, nil] path
+    #   The optional path the XML was loaded from.
+    #
     # @yield [xml]
     #   If a block is given, it will be passed the new XML object.
     #
     # @yieldparam [XML] xml
     #   The newly created XML object.
     #
-    def initialize(document)
-      case document
-      when Nokogiri::XML::Document
-        @doc = document
-      when IO, StringIO
-        @doc = Nokogiri::XML(document)
-      else
-        @path = File.expand_path(document)
-        @doc  = File.open(@path) { |file| Nokogiri::XML(file) }
-      end
+    def initialize(doc, path: nil)
+      @doc  = doc
+      @path = File.expand_path(path) if path
 
       yield self if block_given?
     end
@@ -63,15 +68,6 @@ module Nmap
       new(Nokogiri::XML(text),&block)
     end
 
-    #
-    # @deprecated Use {parse} instead.
-    #
-    # @since 0.7.0
-    #
-    def self.load(text,&block)
-      parse(text,&block)
-    end
-
     #
     # Creates a new XML object from the file.
     #
@@ -87,7 +83,10 @@ module Nmap
     # @since 0.7.0
     #
     def self.open(path,&block)
-      new(path,&block)
+      path = File.expand_path(path)
+      doc  = Nokogiri::XML(File.open(path))
+
+      new(doc, path: path, &block)
     end
 
     #
@@ -241,6 +240,21 @@ module Nmap
       each_task.to_a
     end
 
+    #
+    # Finds the task with the given name.
+    #
+    # @param [String] name
+    #   The task name to search for.
+    #
+    # @return [ScanTask, nil]
+    #   The scan task with the matching name or `nil`.
+    #
+    # @since 0.10.0
+    #
+    def task(name)
+      each_task.find { |scan_task| scan_task.name == name }
+    end
+
     #
     # The NSE scripts ran before the scan.
     #
@@ -255,8 +269,6 @@ module Nmap
                      end
     end
 
-    alias prescripts prescript
-
     #
     # The NSE scripts ran after the scan.
     #
@@ -271,8 +283,6 @@ module Nmap
                       end
     end
 
-    alias postscripts postscript
-
     #
     # Parses the hosts in the scan.
     #
@@ -422,20 +432,12 @@ module Nmap
     # Converts the XML parser to a String.
     #
     # @return [String]
-    #   The path of the XML scan file.
+    #   The path of the XML file or the raw XML.
     #
     def to_s
-      @path.to_s
-    end
-
-    #
-    # Inspects the XML file.
-    #
-    # @return [String]
-    #   The inspected XML file.
-    #
-    def inspect
-      "#<#{self.class}: #{self}>"
+      if @path then @path.to_s
+      else          @doc.to_s
+      end
     end
 
   end