nmap-parser 0.3 → 0.3.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007, 2008 Kris Katterjohn
+Copyright (c) 2007, 2008, 2009 Kris Katterjohn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README

@@ -3,18 +3,21 @@
 == Kris Katterjohn                                      katterjohn@gmail.com ==
 ===============================================================================
 
-$Id: README 70 2008-04-22 23:13:01Z kjak $
+$Id: README 91 2009-01-01 20:50:08Z kjak $
 
 
 OVERVIEW
 ========
 
 This library provides a Ruby interface to Nmap's scan data.  It can run Nmap
-and parse it's XML output directly from the scan, parse a file containing the
+and parse its XML output directly from the scan, parse a file containing the
 XML data from a separate scan, parse a String of XML data from a scan, or parse
 XML data from an object via its read() method.  This information is presented
 in an easy-to-use and intuitive fashion for storing and manipulating.
 
+This is not just some Ruby port of Anthony Persaud's Perl Nmap::Parser!  There
+are more classes, many different methods, and blocks are extensively available.
+
 
 REQUIREMENTS and RECOMMENDATIONS
 ================================

data/lib/nmap/parser.rb

@@ -4,7 +4,7 @@
 #
 # Author: Kris Katterjohn <katterjohn@gmail.com>
 #
-# Copyright (c) 2007, 2008 Kris Katterjohn
+# Copyright (c) 2007, 2008, 2009 Kris Katterjohn
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -24,7 +24,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-# $Id: parser.rb 77 2008-04-24 22:19:29Z kjak $
+# $Id: parser.rb 92 2009-01-01 21:14:58Z kjak $
 # https://rubynmap.svn.sourceforge.net/svnroot/rubynmap
 
 require 'rexml/document'
@@ -44,22 +44,20 @@ end
 == What Is This Library For?
 
 This library provides a Ruby interface to Nmap's scan data.  It can run Nmap
-and parse it's XML output directly from the scan, parse a file containing the
+and parse its XML output directly from the scan, parse a file containing the
 XML data from a separate scan, parse a String of XML data from a scan, or parse
 XML data from an object via its read() method.  This information is presented
 in an easy-to-use and intuitive fashion for storing and manipulating.
 
+This is not just some Ruby port of Anthony Persaud's Perl Nmap::Parser!  There
+are more classes, many different methods, and blocks are extensively available.
+
 The Nmap Security Scanner is a great program written and maintained by
 Fyodor <fyodor@insecure.org>.  Its main function is port scanning, but it also
-has service and operating system detection, it's own scripting engine and a
-whole lot more.  One of it's many available output formats is XML, which allows
+has service and operating system detection, its own scripting engine and a
+whole lot more.  One of its many available output formats is XML, which allows
 machines to handle all of the information instead of us slowly sifting through
-tons of output!
-
-If you've ever used Anthony Persaud's Perl Nmap::Parser, you'll notice some
-similarities and should pick up on this API quickly.  Just remember, it's far
-from exactly the same!  There are more classes, many different methods, and
-blocks are used extensively (or available for use).
+tons of output.
 
 == Conventions
 
@@ -78,29 +76,29 @@ is given.
 
   Nmap::Parser
   |
-  + ::Session             <- Scan session information
+  + Session           <- Scan session information
   |
-  + ::Host                <- General host information
-     |
-     + ::ExtraPorts       <- Ports consolidated in an "ignored" state
-     |
-     + ::Port             <- General port information
-     |  |
-     |  + ::Service       <- Port Service information
-     |
-     + ::Script           <- NSE Script information (both host and port)
-     |
-     + ::Times            <- Timimg information (srtt, etc)
-     |
-     + ::Traceroute       <- General Traceroute information
-     |  |
-     |  + ::Hop           <- Individual Hop information
-     |
-     + ::OS               <- OS Detection information
-        |
-        + ::OSClass       <- OS Class information
-        |
-        + ::OSMatch       <- OS Match information
+  + Host              <- General host information
+    |
+    + ExtraPorts      <- Ports consolidated in an "ignored" state
+    |
+    + Port            <- General port information
+    | |
+    | + Service       <- Port Service information
+    |
+    + Script          <- NSE Script information (both host and port)
+    |
+    + Times           <- Timimg information (srtt, etc)
+    |
+    + Traceroute      <- General Traceroute information
+    | |
+    | + Hop           <- Individual Hop information
+    |
+    + OS              <- OS Detection information
+      |
+      + OSClass       <- OS Class information
+      |
+      + OSMatch       <- OS Match information
 
 == Parsing XML Data Already Available
 
@@ -116,9 +114,8 @@ is given.
 
 == Reading and Parsing from an Object
 
-The parseread() function isn't limited to IO objects like $stdin is
-in the example: it can read from any object that responds to a read()
-method that returns a String.
+This method can read from any object that responds to a read() method that
+returns a String: $stdin is just one example.
 
 	require 'nmap/parser'
 
@@ -126,11 +123,11 @@ method that returns a String.
 
 == Scanning and Parsing
 
-This is the only parser option that requires Nmap to be available
+This is the only parser method that requires Nmap to be available.
 
 	require 'nmap/parser'
 
-	parser = Nmap::Parser.parsescan("sudo nmap", "--script all 192.168.1.0/24")
+	parser = Nmap::Parser.parsescan("sudo nmap", "-sVC 192.168.1.0/24")
 
 == Actually Doing Something
 
@@ -140,9 +137,7 @@ open TCP ports, along with the name and output of any scripts that
 ran (on the host and individual ports).
 
 	puts "Nmap args: #{parser.session.scan_args}"
-
 	puts "Runtime: #{parser.session.scan_time} seconds"
-
 	puts
 
 	parser.hosts("up") do |host|
@@ -155,7 +150,7 @@ ran (on the host and individual ports).
 			puts "Port ##{port.num} is open (#{port.reason})"
 			puts "\tService: #{srv.name}" if srv.name
 			puts "\tProduct: #{srv.product}" if srv.product
-			puts "\tVersion: #{srv.product}" if srv.version
+			puts "\tVersion: #{srv.version}" if srv.version
 			puts
 
 			port.scripts do |script|
@@ -183,7 +178,7 @@ ran (on the host and individual ports).
 class Nmap::Parser
 	# Holds the raw XML output from Nmap
 	attr_reader :rawxml
-	# ::Session object for this scan
+	# Session object for this scan
 	attr_reader :session
 
 	# Read and parse XML from the +obj+.  +obj+ can be any object type
@@ -199,7 +194,9 @@ class Nmap::Parser
 
 		r = obj.read
 
-		raise "read() returned #{r.class} type!" if not r.is_a?String
+		if not r.is_a?String
+			raise "read() returned #{r.class} instead of a String"
+		end
 
 		p = new(r)
 
@@ -305,7 +302,7 @@ class Nmap::Parser
 	# get_ips(), calling this method on a host passed to the block may
 	# lead to adverse effects:
 	#
-	# parser.hosts { |x| puts x.addr; del_host(x) } # Don't do this!
+	# parser.hosts { |h| puts h.addr; parser.del_host(h) } # Don't do this!
 	def del_host(hostip)
 		@hosts.delete_if do |host|
 			host.addr == hostip or host.hostname == hostip
@@ -361,10 +358,8 @@ class Nmap::Parser
 
 		@session = Session.new(root)
 
-		@hosts = []
-
-		root.each_element('host') do |host|
-			@hosts << Host.new(host)
+		@hosts = root.elements.collect('host') do |host|
+			Host.new(host)
 		end
 	end
 end
@@ -432,6 +427,16 @@ class Nmap::Parser::Session
 		types
 	end
 
+	# Returns the scanflags associated with the specified scan +type+
+	# (e.g. "PSHACK" for type "ack")
+	def scanflags(type)
+		@scaninfo.each do |info|
+			return info.scanflags if info.type == type
+		end
+
+		nil
+	end
+
 	private
 
 	def initialize(root)
@@ -456,16 +461,14 @@ class Nmap::Parser::Session
 		@verbose = root.elements['verbose'].attributes['level'].to_i
 		@debug = root.elements['debugging'].attributes['level'].to_i
 
-		@scaninfo = []
-
-		root.each_element('scaninfo') do |info|
-			@scaninfo << ScanInfo.new(info)
+		@scaninfo = root.elements.collect('scaninfo') do |info|
+			ScanInfo.new(info)
 		end
 	end
 end
 
 class Nmap::Parser::Session::ScanInfo # :nodoc: all
-	attr_reader :type, :proto, :numservices
+	attr_reader :type, :scanflags, :proto, :numservices
 
 	private
 
@@ -475,6 +478,7 @@ class Nmap::Parser::Session::ScanInfo # :nodoc: all
 
 	def parse(info)
 		@type = info.attributes['type']
+		@scanflags = info.attributes['scanflags']
 		@proto = info.attributes['protocol']
 		@numservices = info.attributes['numservices'].to_i
 	end
@@ -498,7 +502,7 @@ class Nmap::Parser::Host
 	attr_reader :mac_addr
 	# The MAC vendor
 	attr_reader :mac_vendor
-	# ::OS object holding Operating System information
+	# OS object holding Operating System information
 	attr_reader :os
 	# The number of "weird responses"
 	attr_reader :smurf
@@ -512,12 +516,14 @@ class Nmap::Parser::Host
 	attr_reader :tcptssequence_class, :tcptssequence_values
 	# Uptime information
 	attr_reader :uptime_seconds, :uptime_lastboot
-	# ::Traceroute object
+	# Traceroute object
 	attr_reader :traceroute
 	# Network distance (not necessarily the same as from traceroute)
 	attr_reader :distance
-	# ::Times object holding timing information
+	# Times object holding timing information
 	attr_reader :times
+	# Host start and end times
+	attr_reader :starttime, :endtime
 
 	alias ipv4_addr ip4_addr
 	alias ipv6_addr ip6_addr
@@ -572,13 +578,9 @@ class Nmap::Parser::Host
 	# If an argument is given, only ports matching +state+ are given.
 	# Note:  "open" will also match "open|filtered", but not vice versa.
 	def tcp_ports(state = "")
-		list = []
-
-		@tcpPorts.invert.each_key do |port|
-			list << port if state.empty? or port.state >= state
-		end
-
-		list.sort!
+		list = @tcpPorts.invert.keys.find_all { |port|
+			state.empty? or port.state >= state
+		}.sort
 
 		if block_given?
 			list.each do |port|
@@ -595,13 +597,9 @@ class Nmap::Parser::Host
 	# If an argument is given, only ports matching +state+ are given.
 	# Note:  "open" will also match "open|filtered", but not vice versa.
 	def tcp_port_list(state = "")
-		list = []
-
-		@tcpPorts.invert.each_key do |port|
-			list << port.num if state.empty? or port.state >= state
-		end
-
-		list.sort!
+		list = @tcpPorts.invert.keys.map { |port|
+			port.num if state.empty? or port.state >= state
+		}.compact.sort
 
 		if block_given?
 			list.each do |port|
@@ -612,7 +610,7 @@ class Nmap::Parser::Host
 		list
 	end
 
-	# Returns state reason of TCP port +portnum+
+	# Returns the state reason of TCP port +portnum+
 	def tcp_reason(portnum)
 		return nil if @tcpPorts[portnum.to_s].nil?
 
@@ -655,7 +653,7 @@ class Nmap::Parser::Host
 		@tcpPorts[portnum.to_s].service
 	end
 
-	# Returns state of TCP port +portnum+
+	# Returns the state of TCP port +portnum+
 	def tcp_state(portnum)
 		return nil if @tcpPorts[portnum.to_s].nil?
 
@@ -676,13 +674,9 @@ class Nmap::Parser::Host
 	# If an argument is given, only ports matching +state+ are given.
 	# Note:  "open" will also match "open|filtered", but not vice versa.
 	def udp_ports(state = "")
-		list = []
-
-		@udpPorts.invert.each_key do |port|
-			list << port if state.empty? or port.state >= state
-		end
-
-		list.sort!
+		list = @udpPorts.invert.keys.find_all { |port|
+			state.empty? or port.state >= state
+		}.sort
 
 		if block_given?
 			list.each do |port|
@@ -699,13 +693,9 @@ class Nmap::Parser::Host
 	# If an argument is given, only ports matching +state+ are given.
 	# Note:  "open" will also match "open|filtered", but not vice versa.
 	def udp_port_list(state = "")
-		list = []
-
-		@udpPorts.invert.each_key do |port|
-			list << port.num if state.empty? or port.state >= state
-		end
-
-		list.sort!
+		list = @udpPorts.invert.keys.map { |port|
+			port.num if state.empty? or port.state >= state
+		}.compact.sort
 
 		if block_given?
 			list.each do |port|
@@ -716,7 +706,7 @@ class Nmap::Parser::Host
 		list
 	end
 
-	# Returns state reason of UDP port +portnum+
+	# Returns the state reason of UDP port +portnum+
 	def udp_reason(portnum)
 		return nil if @udpPorts[portnum.to_s].nil?
 
@@ -759,7 +749,7 @@ class Nmap::Parser::Host
 		@udpPorts[portnum.to_s].service
 	end
 
-	# Returns state of UDP port +portnum+
+	# Returns the state of UDP port +portnum+
 	def udp_state(portnum)
 		return nil if @udpPorts[portnum.to_s].nil?
 
@@ -780,13 +770,9 @@ class Nmap::Parser::Host
 	# If an argument is given, only protocols matching +state+ are given.
 	# Note:  "open" will also match "open|filtered", but not vice versa.
 	def ip_protos(state = "")
-		list = []
-
-		@ipProtos.invert.each_key do |proto|
-			list << proto if state.empty? or proto.state >= state
-		end
-
-		list.sort!
+		list = @ipProtos.invert.keys.find_all { |proto|
+			state.empty? or proto.state >= state
+		}.sort
 
 		if block_given?
 			list.each do |proto|
@@ -803,13 +789,9 @@ class Nmap::Parser::Host
 	# If an argument is given, only protocols matching +state+ are given.
 	# Note:  "open" will also match "open|filtered", but not vice versa.
 	def ip_proto_list(state = "")
-		list = []
-
-		@ipProtos.invert.each_key do |proto|
-			list << proto.num if state.empty? or proto.state >= state
-		end
-
-		list.sort!
+		list = @ipProtos.invert.keys.map { |proto|
+			proto.num if state.empty? or proto.state >= state
+		}.compact.sort
 
 		if block_given?
 			list.each do |proto|
@@ -820,7 +802,7 @@ class Nmap::Parser::Host
 		list
 	end
 
-	# Returns state reason of IP protocol +protonum+
+	# Returns the state reason of IP protocol +protonum+
 	def ip_reason(protonum)
 		return nil if @ipProtos[protonum.to_s].nil?
 
@@ -834,7 +816,7 @@ class Nmap::Parser::Host
 		@ipProtos[protonum.to_s].service
 	end
 
-	# Returns state of IP protocol +protonum+
+	# Returns the state of IP protocol +protonum+
 	def ip_state(protonum)
 		return nil if @ipProtos[protonum.to_s].nil?
 
@@ -875,25 +857,26 @@ class Nmap::Parser::Host
 		parse(hostinfo)
 	end
 
-	# Convert a string like '22-25,80,110-900' into
+	# Convert a string like "22-25,80,110-900" into
 	# an array with all the uncondensed elements, e.g.
-	# [ '22', '23', '24', '25, '80', '110', '111' ... ]
+	# [ 22, 23, 24, 25, 80, 110, 111 ... ]
 	def parsePortlist(ports)
 		list = []
 
-		ports.split(",").each do |set|
-			pa = set.split("-")
+		# Build array from port specification
+		ports.split(/,/).each do |item|
+			start, stop = item.split(/-/).map { |p| p.to_i }
 
-			if pa.length > 1
-				pa[0].upto(pa[1]) do |p|
-					list << p
-				end
-			else
-				list << portc
-			end
+			start ||= 0
+			stop ||= item.match(/-/) ? 65535 : start
+
+			start, stop = stop, start if stop < start
+
+			start.upto(stop) { |p| list << p }
 		end
 
-		list
+		# Sort, and remove dups and invalid ports
+		list.sort.uniq.delete_if { |p| p < 0 or p > 65535 }
 	end
 
 	def parseAddr(elem)
@@ -913,8 +896,8 @@ class Nmap::Parser::Host
 
 		return nil if elem.nil?
 
-		elem.each_element('hostname') do |name|
-			@hostnames << name.attributes['name']
+		@hostnames = elem.elements.collect('hostname') do |name|
+			name.attributes['name']
 		end
 	end
 
@@ -944,8 +927,8 @@ class Nmap::Parser::Host
 
 		return nil if ports.nil?
 
-		ports.each_element('extraports') do |e|
-			@extraports << ExtraPorts.new(e)
+		@extraports = ports.elements.collect('extraports') do |e|
+			ExtraPorts.new(e)
 		end
 
 		@extraports.sort! do |x, y|
@@ -958,8 +941,8 @@ class Nmap::Parser::Host
 
 		return nil if scriptlist.nil?
 
-		scriptlist.each_element('script') do |script|
-			@scripts << Script.new(script)
+		@scripts = scriptlist.elements.collect('script') do |script|
+			Script.new(script)
 		end
 	end
 
@@ -1035,6 +1018,12 @@ class Nmap::Parser::Host
 		@distance = distance.attributes['value'].to_i if distance
 
 		@times = Times.new(host.elements['times'])
+
+		stime = host.attributes['starttime']
+		@starttime = stime.to_i if stime
+
+		etime = host.attributes['endtime']
+		@endtime = etime.to_i if etime
 	end
 end
 
@@ -1089,7 +1078,7 @@ end
 class Nmap::Parser::Host::Port
 	# Port number
 	attr_reader :num
-	# ::Service object for this port
+	# Service object for this port
 	attr_reader :service
 	# Port state ("open", "closed", "filtered", etc)
 	attr_reader :state
@@ -1150,10 +1139,8 @@ class Nmap::Parser::Host::Port
 
 		@service = Service.new(port)
 
-		@scripts = []
-
-		port.each_element('script') do |script|
-			@scripts << Nmap::Parser::Host::Script.new(script)
+		@scripts = port.elements.collect('script') do |script|
+			Nmap::Parser::Host::Script.new(script)
 		end
 	end
 end
@@ -1219,7 +1206,7 @@ class Nmap::Parser::Host::Traceroute
 
 	# Returns an array of Hop objects, which are each a responsive hop,
 	# and passes them each to a block if one if given.
-	def hops
+	def hops() # :yields: hop
 		if block_given?
 			@hops.each do |h|
 				yield h
@@ -1239,10 +1226,8 @@ class Nmap::Parser::Host::Traceroute
 		@port = trace.attributes['port'].to_i
 		@proto = trace.attributes['proto']
 
-		@hops = []
-
-		trace.each_element('hop') do |hop|
-			@hops << Hop.new(hop)
+		@hops = trace.each_element('hop') do |hop|
+			Hop.new(hop)
 		end
 	end
 end
@@ -1506,18 +1491,18 @@ class Nmap::Parser::Host::OS
 
 		return nil if os.nil?
 
-		os.each_element('portused') do |port|
-			@portsused << PortUsed.new(port)
+		@portsused = os.elements.collect('portused') do |port|
+			PortUsed.new(port)
 		end
 
-		os.each_element('osclass') do |osclass|
-			@osclasses << OSClass.new(osclass)
+		@osclasses = os.elements.collect('osclass') do |osclass|
+			OSClass.new(osclass)
 		end
 
 		@osclasses.sort!.reverse!
 
-		os.each_element('osmatch') do |match|
-			@osmatches << OSMatch.new(match)
+		@osmatches = os.elements.collect('osmatch') do |match|
+			OSMatch.new(match)
 		end
 
 		@osmatches.sort!.reverse!

metadata

@@ -1,52 +1,59 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: nmap-parser
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-date: 2008-04-24 00:00:00 -05:00
-summary: Ruby Interface to Nmap's Scan Data (Nmap::Parser Library)
-require_paths: 
-- lib
-email: katterjohn@gmail.com
-homepage: http://rubynmap.sourceforge.net
-rubyforge_project: rubynmap
-description: Nmap::Parser Library
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.3.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Kris Katterjohn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-01 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Nmap::Parser Library
+email: katterjohn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - BUGS
 - LICENSE
 - README
 - lib/nmap/parser.rb
-test_files: []
-
+has_rdoc: true
+homepage: http://rubynmap.sourceforge.net
+post_install_message: 
 rdoc_options: 
 - --title
 - Ruby Nmap::Parser Library
 - --main
 - Nmap::Parser
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: rubynmap
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby Interface to Nmap's Scan Data (Nmap::Parser Library)
+test_files: []