ruby-nmap 0.10.0 → 1.0.0

data/lib/nmap/os.rb

@@ -1,127 +0,0 @@
-require 'nmap/os_class'
-require 'nmap/os_match'
-
-module Nmap
-  #
-  # Wraps the `os` XML element.
-  #
-  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

data/lib/nmap/os_class.rb

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

data/lib/nmap/os_match.rb

@@ -1,18 +0,0 @@
-module Nmap
-  #
-  # Represents a match for a specific {OS}.
-  #
-  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

data/lib/nmap/port.rb

@@ -1,110 +0,0 @@
-require 'nmap/service'
-require 'nmap/scripts'
-
-module Nmap
-  #
-  # Wraps a `port` XML element.
-  #
-  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

data/lib/nmap/postscript.rb

@@ -1,16 +0,0 @@
-require 'nmap/scripts'
-
-module Nmap
-  #
-  # Represents the `postscript` element.
-  #
-  class Postscript
-
-    include Scripts
-
-    def initialize(node)
-      @node = node
-    end
-
-  end
-end

data/lib/nmap/prescript.rb

@@ -1,16 +0,0 @@
-require 'nmap/scripts'
-
-module Nmap
-  #
-  # Represents the `prescript` element.
-  #
-  class Prescript
-
-    include Scripts
-
-    def initialize(node)
-      @node = node
-    end
-
-  end
-end

data/lib/nmap/program.rb

@@ -1,102 +0,0 @@
-require 'nmap/task'
-
-require 'rprogram/program'
-
-module Nmap
-  #
-  # Represents the `nmap` program.
-  #
-  class Program < RProgram::Program
-
-    name_program 'nmap'
-
-    #
-    # Finds the `nmap` program and performs a scan.
-    #
-    # @param [Hash{Symbol => Object}] options
-    #   Additional options for nmap.
-    #
-    # @param [Hash{Symbol => Object}] exec_options
-    #   Additional exec-options.
-    #
-    # @yield [task]
-    #   If a block is given, it will be passed a task object
-    #   used to specify options for nmap.
-    #
-    # @yieldparam [Task] task
-    #   The nmap task object.
-    #
-    # @return [Boolean]
-    #   Specifies whether the command exited normally.
-    #
-    # @example Specifying Nmap options via a Hash.
-    #   Nmap::Program.scan(
-    #     :targets => '192.168.1.1',
-    #     :ports => [22,80,443],
-    #     :verbose => true
-    #   )
-    #
-    # @example Specifying Nmap options via a {Task} object.
-    #   Nmap::Program.scan do |nmap|
-    #     nmap.targets = '192.168.1.1'
-    #     nmap.ports = [22,80,443]
-    #     nmap.verbose = true
-    #   end
-    #
-    # @see #scan
-    #
-    def self.scan(options={},exec_options={},&block)
-      find.scan(options,exec_options,&block)
-    end
-
-    #
-    # Finds the `nmap` program and performs a scan, but runs `nmap` under
-    # `sudo`.
-    #
-    # @see scan
-    #
-    # @since 0.8.0
-    #
-    def self.sudo_scan(options={},exec_options={},&block)
-      find.sudo_scan(options,exec_options,&block)
-    end
-
-    #
-    # Performs a scan.
-    #
-    # @param [Hash{Symbol => Object}] options
-    #   Additional options for nmap.
-    #
-    # @param [Hash{Symbol => Object}] exec_options
-    #   Additional exec-options.
-    #
-    # @yield [task]
-    #   If a block is given, it will be passed a task object
-    #   used to specify options for nmap.
-    #
-    # @yieldparam [Task] task
-    #   The nmap task object.
-    #
-    # @return [Boolean]
-    #   Specifies whether the command exited normally.
-    #
-    # @see http://rubydoc.info/gems/rprogram/0.3.0/RProgram/Program#run-instance_method
-    #   For additional exec-options.
-    #
-    def scan(options={},exec_options={},&block)
-      run_task(Task.new(options,&block),exec_options)
-    end
-
-    #
-    # Performs a scan and runs `nmap` under `sudo`.
-    #
-    # @see #scan
-    #
-    # @since 0.8.0
-    #
-    def sudo_scan(options={},exec_options={},&block)
-      sudo_task(Task.new(options,&block),exec_options)
-    end
-
-  end
-end

data/lib/nmap/run_stat.rb

@@ -1,20 +0,0 @@
-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.rb

@@ -1,34 +0,0 @@
-module Nmap
-  #
-  # Represents an Nmap scan.
-  #
-  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

data/lib/nmap/scan_task.rb

@@ -1,53 +0,0 @@
-module Nmap
-  class ScanTask < Struct.new(:name, :start_time, :end_time, :extrainfo)
-
-    #
-    # 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] extrainfo
-    #   Any extra information relating to the scan task.
-    #
-    # @since 0.1.2
-    #
-    def initialize(name,start_time,end_time,extrainfo=nil)
-      super
-    end
-
-    # @since 0.10.0
-    alias extra_info extrainfo
-
-    #
-    # 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.extrainfo})"
-    end
-
-  end
-end

data/lib/nmap/scanner.rb

@@ -1,18 +0,0 @@
-module Nmap
-  #
-  # Describes the `nmap` command.
-  #
-  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

data/lib/nmap/scripts.rb

@@ -1,71 +0,0 @@
-module Nmap
-  module Scripts
-    #
-    # The output from the NSE scripts ran against the open port.
-    #
-    # @return [Hash{String => String}]
-    #   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['output']
-        end
-      end
-
-      return @scripts
-    end
-
-    #
-    # The structured output of the NSE scripts.
-    #
-    # @return [Hash{String => Hash{String => Array<String>}}]
-    #   The NSE script names and their structured output.
-    #
-    # @since 0.9.0
-    #
-    def script_data
-      unless @script_data
-        @script_data = {}
-
-        traverse = lambda do |node|
-          case node.name
-          when 'script', 'table'
-            unless node.xpath('*[@key]').empty?
-              hash = {}
-
-              node.elements.each do |element|
-                hash[element['key']] = traverse.call(element)
-              end
-
-              hash
-            else
-              array = []
-
-              node.elements.each do |element|
-                array << traverse.call(element)
-              end
-
-              array
-            end
-          when 'elem'
-            node.inner_text
-          else
-            raise(NotImplementedError,"unrecognized XML NSE element: #{node}")
-          end
-        end
-
-        @node.xpath('script').each do |script|
-          @script_data[script['id']] = traverse.call(script)
-        end
-      end
-
-      return @script_data
-    end
-
-  end
-end