ruby-nmap 0.5.1 → 0.6.0

data/lib/nmap/program.rb

@@ -3,6 +3,9 @@ require 'nmap/task'
 require 'rprogram/program'
 
 module Nmap
+  #
+  # Represents the `nmap` program.
+  #
   class Program < RProgram::Program
 
     name_program 'nmap'

data/lib/nmap/scan.rb

@@ -1,14 +1,8 @@
 module Nmap
-  class Scan
-
-    # The type of scan
-    attr_reader :type
-
-    # The protocol used for the scan
-    attr_reader :protocol
-
-    # The port numbers that were scanned
-    attr_reader :services
+  #
+  # Represents an Nmap scan.
+  #
+  class Scan < Struct.new(:type, :protocol, :services)
 
     #
     # Creates a new Scan object.
@@ -23,9 +17,7 @@ module Nmap
     #   The port numbers scanned.
     #
     def initialize(type,protocol,services=[])
-      @type = type
-      @protocol = protocol
-      @services = services
+      super(type,protocol,services)
     end
 
     #
@@ -35,7 +27,7 @@ module Nmap
     #   The String form of the scan.
     #
     def to_s
-      "#{@protocol} #{@type}"
+      "#{self.protocol} #{self.type}"
     end
 
   end

data/lib/nmap/scanner.rb

@@ -1,39 +1,8 @@
 module Nmap
-  class Scanner
-
-    # The name of the scanner
-    attr_reader :name
-
-    # The version of the scanner
-    attr_reader :version
-
-    # The arguments used with the scanner
-    attr_reader :arguments
-
-    # The time the scan begun
-    attr_reader :start_time
-
-    #
-    # Creates a new Scanner object.
-    #
-    # @param [String] name
-    #   The name of the scanner.
-    #
-    # @param [String] version
-    #   The version of the scanner.
-    #
-    # @param [String] arguments
-    #   The arguments used with the scanner.
-    #
-    # @param [Time] start_time
-    #   The time the scan begun
-    #
-    def initialize(name,version,arguments,start_time)
-      @name = name
-      @version = version
-      @arguments = arguments
-      @start_time = start_time
-    end
+  #
+  # Describes the `nmap` command.
+  #
+  class Scanner < Struct.new(:name, :version, :arguments, :start_time)
 
     #
     # Converts the scanner to a String.
@@ -42,7 +11,7 @@ module Nmap
     #   The scanner name and arguments.
     #
     def to_s
-      "#{@name} #{@arguments}"
+      "#{self.name} #{self.arguments}"
     end
 
   end

data/lib/nmap/sequence.rb

@@ -1,4 +1,9 @@
 module Nmap
+  #
+  # Base class for all Sequence classes.
+  #
+  # @since 0.5.0
+  #
   class Sequence
 
     #

data/lib/nmap/service.rb

@@ -0,0 +1,82 @@
+module Nmap
+  #
+  # Wraps a `service` XML element.
+  #
+  # @since 0.6.0
+  #
+  class Service
+
+    #
+    # 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
+
+    #
+    # 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 hostname reported by the service.
+    #
+    # @return [String]
+    #   The reported hostname.
+    #
+    def hostname
+      @hostname ||= @node.get_attribute('hostname')
+    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 confidence score of the service fingerprinting.
+    #
+    # @return [Integer]
+    #   The confidence score.
+    #
+    def confidence
+      @confidence ||= @node.get_attribute('conf').to_i
+    end
+
+    alias to_s name
+
+  end
+end

data/lib/nmap/status.rb

@@ -1,25 +1,8 @@
 module Nmap
-  class Status
-
-    # The state of a host
-    attr_reader :state
-
-    # The reason for the state
-    attr_reader :reason
-
-    #
-    # Creates a new Status object.
-    #
-    # @param [Symbol] state
-    #   The state of a host.
-    #
-    # @param [String] reason
-    #   The reason for the state.
-    #
-    def initialize(state,reason)
-      @state = state
-      @reason = reason
-    end
+  #
+  # Represents the Status of a {Host}.
+  #
+  class Status < Struct.new(:state, :reason)
 
     #
     # Converts the status to a String.
@@ -28,7 +11,7 @@ module Nmap
     #   The state.
     #
     def to_s
-      @state.to_s
+      self.state.to_s
     end
 
   end

data/lib/nmap/tcp_sequence.rb

@@ -1,6 +1,11 @@
 require 'nmap/sequence'
 
 module Nmap
+  #
+  # Represents a TCP sequence number.
+  #
+  # @since 0.5.0
+  #
   class TcpSequence < Sequence
 
     #

data/lib/nmap/tcp_ts_sequence.rb

@@ -1,6 +1,9 @@
 require 'nmap/sequence'
 
 module Nmap
+  #
+  # Represents a TCP timestamp.
+  #
   class TcpTsSequence < Sequence
 
     #

data/lib/nmap/version.rb

@@ -1,4 +1,4 @@
 module Nmap
   # ruby-nmap version
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/lib/nmap/xml.rb

@@ -6,6 +6,9 @@ require 'nmap/host'
 require 'nokogiri'
 
 module Nmap
+  #
+  # Represents an Nmap XML file.
+  #
   class XML
 
     include Enumerable
@@ -27,7 +30,7 @@ module Nmap
     #
     def initialize(path)
       @path = File.expand_path(path)
-      @doc = Nokogiri::XML(File.new(@path))
+      @doc = Nokogiri::XML(open(@path))
 
       yield self if block_given?
     end
@@ -134,7 +137,7 @@ module Nmap
     #   be returned.
     #
     def each_host(&block)
-      return enum_for(:each_host) unless block
+      return enum_for(__method__) unless block
 
       @doc.xpath('/nmaprun/host').each do |host|
         Host.new(host,&block)
@@ -167,7 +170,7 @@ module Nmap
     #   be returned.
     #
     def each_up_host(&block)
-      return enum_for(:each_up_host) unless block
+      return enum_for(__method__) unless block
 
       @doc.xpath("/nmaprun/host[status[@state='up']]").each do |host|
         Host.new(host,&block)

data/spec/host_spec.rb

@@ -1,38 +1,31 @@
 require 'spec_helper'
-require 'helpers/xml'
 
 require 'nmap/xml'
 require 'nmap/host'
 
 describe Host do
-  include Helpers
+  let(:xml) { XML.new(Helpers::SCAN_FILE) }
 
-  before(:all) do
-    @xml = XML.new(Helpers::SCAN_FILE)
-    @nse_xml = XML.new(Helpers::NSE_FILE)
-
-    @host = @xml.hosts.first
-    @nse_host = @nse_xml.hosts.first
-  end
+  subject { xml.hosts.first }
 
   it "should parse the start_time" do
-    @host.start_time.should > Time.at(0)
+    subject.start_time.should > Time.at(0)
   end
 
   it "should parse the end_time" do
-    @host.end_time.should > Time.at(0)
-    @host.end_time.should > @host.start_time
+    subject.end_time.should > Time.at(0)
+    subject.end_time.should > subject.start_time
   end
 
   it "should parse the status" do
-    status = @host.status
+    status = subject.status
     
     status.state.should == :up
     status.reason.should == 'arp-response'
   end
 
   it "should parse the addresses" do
-    addresses = @host.addresses
+    addresses = subject.addresses
     
     addresses.length.should == 2
 
@@ -44,11 +37,11 @@ describe Host do
   end
 
   it "should parse the MAC address" do
-    @host.mac.should == '00:1D:7E:EF:2A:E5'
+    subject.mac.should == '00:1D:7E:EF:2A:E5'
   end
 
   it "should parse the IPv4 address" do
-    @host.ipv4.should == '192.168.5.1'
+    subject.ipv4.should == '192.168.5.1'
   end
 
   it "should parse the IPv6 address" do
@@ -56,11 +49,11 @@ describe Host do
   end
 
   it "should have an IP" do
-    @host.ip.should == '192.168.5.1'
+    subject.ip.should == '192.168.5.1'
   end
 
   it "should have an address" do
-    @host.address.should == '192.168.5.1'
+    subject.address.should == '192.168.5.1'
   end
 
   it "should parse the hostnames" do
@@ -68,24 +61,24 @@ describe Host do
   end
 
   it "should parse the OS guessing information" do
-    @host.os.should_not be_nil
+    subject.os.should_not be_nil
   end
 
   it "should parse the ports" do
-    ports = @host.ports
+    ports = subject.ports
     
     ports.length.should == 3
   end
 
   it "should list the open ports" do
-    ports = @host.open_ports
+    ports = subject.open_ports
     
     ports.length.should == 1
     ports.all? { |port| port.state == :open }.should == true
   end
 
   it "should list TCP ports" do
-    ports = @host.tcp_ports
+    ports = subject.tcp_ports
     
     ports.length.should == 3
     ports.all? { |port| port.protocol == :tcp }.should == true
@@ -96,13 +89,19 @@ describe Host do
   end
 
   it "should convert to a String" do
-    @host.to_s.should == '192.168.5.1'
+    subject.to_s.should == '192.168.5.1'
   end
 
-  it "should list output of NSE scripts ran against the host" do
-    @nse_host.scripts.should_not be_empty
+  context "when NSE scripts are ran" do
+    let(:xml) { XML.new(Helpers::NSE_FILE) }
+
+    subject { xml.hosts.first }
+
+    it "should list output of the scripts" do
+      subject.scripts.should_not be_empty
 
-    @nse_host.scripts.keys.should_not include(nil)
-    @nse_host.scripts.values.should_not include(nil)
+      subject.scripts.keys.should_not include(nil)
+      subject.scripts.values.should_not include(nil)
+    end
   end
 end

data/spec/ip_id_sequence_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'nmap/ip_id_sequence'
+
+describe IpIdSequence do
+  let(:xml) { XML.new(Helpers::SCAN_FILE) }
+
+  subject { xml.hosts.first.ip_id_sequence }
+
+  it "should be accessible from host objects" do
+    subject.should be_kind_of(IpIdSequence)
+  end
+
+  it "should parse the description" do
+    subject.description.should == "Incremental"
+  end
+
+  it "should parse the values" do
+    subject.values.should == [0x1FB0, 0x1FB2, 0x1FB4, 0x1FB6, 0x1FB8, 0x1FBA]
+  end
+end