ruby-nmap 0.5.1 → 0.6.0

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.6.0 / 2012-11-07
+
+* Added {Nmap::Service}.
+* Renamed `Nmap::IpidSequence` to {Nmap::IpIdSequence}.
+* Renamed {Nmap::Host#ipidsequence} to {Nmap::Host#ip_id_sequence}.
+* Renamed {Nmap::Host#tcpsequence} to {Nmap::Host#tcp_sequence}.
+* Renamed {Nmap::Host#tcptssequence} to {Nmap::Host#tcp_ts_sequence}.
+
 ### 0.5.1 / 2012-05-27
 
 * Replaced ore-tasks with

data/README.md

@@ -75,7 +75,7 @@ Print NSE script output from an XML scan file:
 
 * [nmap](http://www.insecure.org/) >= 5.00
 * [nokogiri](http://nokogiri.rubyforge.org/) ~> 1.3
-* [rprogram](https://github.com/postmodern/rprogram) ~> 0.3
+* [rprogram](https://github.com/postmodern/rprogram#readme) ~> 0.3
 
 ## Install
 

data/lib/nmap/address.rb

@@ -1,25 +1,8 @@
 module Nmap
-  class Address
-
-    # Type of the address
-    attr_reader :type
-
-    # Address
-    attr_reader :addr
-
-    #
-    # Creates a new Address object.
-    #
-    # @param [Symbol] type
-    #   The type of the address.
-    #
-    # @param [String] addr
-    #   The address.
-    #
-    def initialize(type,addr)
-      @type = type
-      @addr = addr
-    end
+  #
+  # Represents a IP or MAC address.
+  #
+  class Address < Struct.new(:type, :addr)
 
     #
     # Converts the address to a String.
@@ -28,7 +11,7 @@ module Nmap
     #   The address.
     #
     def to_s
-      @addr.to_s
+      self.addr.to_s
     end
 
   end

data/lib/nmap/host.rb

@@ -9,6 +9,9 @@ require 'nmap/tcp_ts_sequence'
 require 'nokogiri'
 
 module Nmap
+  #
+  # Wraps a `host` XML element.
+  #
   class Host
 
     include Enumerable
@@ -89,7 +92,7 @@ module Nmap
     #   If no block was given, an enumerator will be returned.
     #
     def each_address
-      return enum_for(:each_address) unless block_given?
+      return enum_for(__method__) unless block_given?
 
       @node.xpath("address[@addr]").each do |addr|
         address = Address.new(
@@ -120,13 +123,9 @@ module Nmap
     #   The MAC address of the host.
     #
     def mac
-      unless @mac
-        addr = @node.xpath("address[@addr][@addrtype='mac']").first
-
-        @mac = addr['addr'] if addr
-      end
-
-      return @mac
+      @mac ||= if (addr = @node.xpath("address[@addrtype='mac']").first)
+                 addr['addr']
+               end
     end
 
     #
@@ -136,13 +135,9 @@ module Nmap
     #   The IPv4 address of the host.
     #
     def ipv4
-      unless @ipv4
-        addr = @node.xpath("address[@addr][@addrtype='ipv4']").first
-
-        @ipv4 = addr['addr'] if addr
-      end
-
-      return @ipv4
+      @ipv4 ||= if (addr = @node.xpath("address[@addrtype='ipv4']").first)
+                  addr['addr']
+                end
     end
 
     #
@@ -152,13 +147,9 @@ module Nmap
     #   The IPv6 address of the host.
     #
     def ipv6
-      unless @ipv6
-        addr = @node.xpath("address[@addr][@addrtype='ipv6']").first
-
-        @ipv6 = addr['addr'] if addr
-      end
-
-      return @ipv6
+      @ipv6 ||= if (@node.xpath("address[@addrtype='ipv6']").first)
+                  addr['addr']
+                end
     end
 
     #
@@ -195,7 +186,7 @@ module Nmap
     #   If no block was given, an enumerator will be returned.
     #
     def each_hostname
-      return enum_for(:each_hostname) unless block_given?
+      return enum_for(__method__) unless block_given?
 
       @node.xpath("hostnames/hostname[@name]").each do |host|
         yield host['name']
@@ -226,46 +217,76 @@ module Nmap
     # @return [OS]
     #   The OS guessing information.
     #
-    def os(&block)
-      if (os = @node.at('os'))
-        @os = OS.new(os,&block)
-      end
+    def os
+      @os ||= if (os = @node.at('os'))
+                OS.new(os)
+              end
+
+      yield @os if (@os && block_given?)
+      return @os
     end
 
+    #
     # Parses the Tcp Sequence number analysis of the host.
     #
-    # @yield [tcpsequence]
+    # @yield [sequence]
     #   If a block is given, it will be passed the resulting object
     #
-    # @yieldparam [TcpSequence] tcpsequence
+    # @yieldparam [TcpSequence] sequence
     #   Tcp Sequence number analysis.
     #
     # @return [TcpSequence]
     #   The parsed object.
     #
+    def tcp_sequence
+      @tcp_sequence ||= if (seq = @node.at('tcpsequence'))
+                          TcpSequence.new(seq)
+                        end
+
+      yield @tcp_sequence if (@tcp_sequence && block_given?)
+      return @tcp_sequence
+    end
+
+    #
+    # @deprecated Use {#tcp_sequence} instead.
+    #
     def tcpsequence(&block)
-      if (seq = @node.at('tcpsequence'))
-        @tcpsequence = TcpSequence.new(seq,&block)
-      end
+      warn "DEPRECATION: use #{self.class}#tcp_sequence instead"
+
+      tcp_sequence(&block)
     end
 
+    #
     # Parses the IPID sequence number analysis of the host.
     #
     # @yield [ipidsequence]
     #   If a block is given, it will be passed the resulting object
     #
-    # @yieldparam [IpidSequence] ipidsequence
+    # @yieldparam [IpIdSequence] ipidsequence
     #   IPID Sequence number analysis.
     #
-    # @return [IpidSequence]
+    # @return [IpIdSequence]
     #   The parsed object.
     #
+    def ip_id_sequence
+      @ip_id_sequence ||= if (seq = @node.at('ipidsequence'))
+                            IpIdSequence.new(seq)
+                          end
+
+      yield @ip_id_sequence if (@ip_id_sequence && block_given?)
+      return @ip_id_sequence
+    end
+
+    #
+    # @deprecated Use {#ip_id_sequence} instead.
+    #
     def ipidsequence(&block)
-      if (seq = @node.at('ipidsequence'))
-        @ipidsequence = IpidSequence.new(seq,&block)
-      end
+      warn "DEPRECATION: use #{self.class}#ip_id_sequence instead"
+
+      ip_id_sequence(&block)
     end
 
+    #
     # Parses the TCP Timestamp sequence number analysis of the host.
     #
     # @yield [tcptssequence]
@@ -277,10 +298,22 @@ module Nmap
     # @return [TcpTsSequence]
     #   The parsed object.
     #
+    def tcp_ts_sequence
+      @tcp_ts_sequence ||= if (seq = @node.at('tcptssequence'))
+                             TcpTsSequence.new(seq)
+                           end
+
+      yield @tcp_ts_sequence if (@tcp_ts_sequence && block_given?)
+      return @tcp_ts_sequence
+    end
+
+    #
+    # @deprecated Use {#tcp_ts_sequence} instead.
+    #
     def tcptssequence(&block)
-      if (seq = @node.at('tcptssequence'))
-        @tcptssequence = TcpTsSequence.new(seq,&block)
-      end
+      warn "DEPRECATION: use #{self.class}#tcp_ts_sequence instead"
+
+      tcp_ts_sequence(&block)
     end
 
     #
@@ -297,7 +330,7 @@ module Nmap
     #   If no block was given, an enumerator will be returned.
     #
     def each_port
-      return enum_for(:each_port) unless block_given?
+      return enum_for(__method__) unless block_given?
 
       @node.xpath("ports/port").each do |port|
         yield Port.new(port)
@@ -329,8 +362,8 @@ module Nmap
     #   The host.
     #   If no block was given, an enumerator will be returned.
     #
-    def each_open_port(&block)
-      return enum_for(:each_open_port) unless block_given?
+    def each_open_port
+      return enum_for(__method__) unless block_given?
 
       @node.xpath("ports/port[state/@state='open']").each do |port|
         yield Port.new(port)
@@ -363,7 +396,7 @@ module Nmap
     #   If no block was given, an enumerator will be returned.
     #
     def each_tcp_port
-      return enum_for(:each_tcp_port) unless block_given?
+      return enum_for(__method__) unless block_given?
 
       @node.xpath("ports/port[@protocol='tcp']").each do |port|
         yield Port.new(port)
@@ -396,7 +429,7 @@ module Nmap
     #   If no block was given, an enumerator will be returned.
     #
     def each_udp_port
-      return enum_for(:each_udp_port) unless block_given?
+      return enum_for(__method__) unless block_given?
 
       @node.xpath("ports/port[@protocol='udp']").each do |port|
         yield Port.new(port)

data/lib/nmap/ip_id_sequence.rb

@@ -1,7 +1,12 @@
 require 'nmap/sequence'
 
 module Nmap
-  class IpidSequence < Sequence
+  #
+  # Represents an IP ID.
+  #
+  # @since 0.5.0
+  #
+  class IpIdSequence < Sequence
 
     #
     # Converts the IpidSequence class to a String.

data/lib/nmap/os.rb

@@ -2,6 +2,9 @@ require 'nmap/os_class'
 require 'nmap/os_match'
 
 module Nmap
+  #
+  # Wraps the `os` XML element.
+  #
   class OS
 
     include Enumerable
@@ -38,7 +41,7 @@ module Nmap
     #   will be returned.
     #
     def each_class
-      return enum_for(:each_class) unless block_given?
+      return enum_for(__method__) unless block_given?
 
       @node.xpath("osclass").map do |osclass|
         os_class = OSClass.new(
@@ -78,7 +81,7 @@ module Nmap
     #   will be returned.
     #
     def each_match
-      return enum_for(:each_match) unless block_given?
+      return enum_for(__method__) unless block_given?
 
       @node.xpath("osmatch").map do |osclass|
         os_match = OSMatch.new(

data/lib/nmap/os_class.rb

@@ -1,39 +1,8 @@
 module Nmap
-  class OSClass
-
-    # The OS class
-    attr_reader :type
-
-    # The OS vendor
-    attr_reader :vendor
-
-    # The family of the OS
-    attr_reader :family
-
-    # The accuracy of the OS guess
-    attr_reader :accuracy
-
-    #
-    # Creates a new OSClass object.
-    #
-    # @param [Symbol] type
-    #   The class of the OS.
-    #
-    # @param [String] vendor
-    #   The vendor of the OS.
-    #
-    # @param [String] family
-    #   The family of the OS.
-    #
-    # @param [Integer] accuracy
-    #   The accuracy of the OS guess.
-    #
-    def initialize(type,vendor,family,accuracy)
-      @type = type
-      @vendor = vendor
-      @family = family
-      @accuracy = accuracy
-    end
+  #
+  # Represents an {OS} class.
+  #
+  class OSClass < Struct.new(:type, :vendor, :family, :accuracy)
 
     #
     # Converts the OS class to a String.
@@ -42,7 +11,7 @@ module Nmap
     #   The String form of the OS class.
     #
     def to_s
-      "#{@type} #{@vendor} (#{@accuracy}%)"
+      "#{self.type} #{self.vendor} (#{self.accuracy}%)"
     end
 
   end

data/lib/nmap/os_match.rb

@@ -1,25 +1,8 @@
 module Nmap
-  class OSMatch
-
-    # The name of the OS
-    attr_reader :name
-
-    # The accuracy of the OS guess
-    attr_reader :accuracy
-
-    #
-    # Creates a OSMatch object.
-    #
-    # @param [String] name
-    #   The name of the OS.
-    #
-    # @param [Integer] accuracy
-    #   The accuracy of the OS guess.
-    #
-    def initialize(name,accuracy)
-      @name = name
-      @accuracy = accuracy
-    end
+  #
+  # Represents a match for a specific {OS}.
+  #
+  class OSMatch < Struct.new(:name, :accuracy)
 
     #
     # Converts the OS match to a String.
@@ -28,7 +11,7 @@ module Nmap
     #   The String form of the OS match.
     #
     def to_s
-      "#{@name} (#{@accuracy}%)"
+      "#{self.name} (#{self.accuracy}%)"
     end
 
   end

data/lib/nmap/port.rb

@@ -1,4 +1,9 @@
+require 'nmap/service'
+
 module Nmap
+  #
+  # Wraps a `port` XML element.
+  #
   class Port
 
     #
@@ -52,15 +57,17 @@ module Nmap
     end
 
     #
-    # The service the port provides.
+    # The fingerprinted service of the port.
     #
-    # @return [String]
+    # @return [Service]
     #   The service detected on the port.
     #
+    # @since 0.6.0
+    #
     def service
-      @service ||= if (service = @node.at('service/@name'))
-                     service.inner_text
-                   end
+      @service_info ||= if (service = @node.at('service'))
+                          Service.new(service)
+                        end
     end
 
     #