ruby-nmap 0.6.0 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8192a4dc58b09117d2aa6eb71a8a43440872f780
+  data.tar.gz: 605bb8d11e670acc42b90abdfd01bfeebd8cab1c
+SHA512:
+  metadata.gz: 21b42a7d36d7aac99b722c38e80ff85646c1d677325ff6f480400a541ce8b9c9735dbbd58e227d13e321488458b30ae291783732955c70a784cd68481e6af7d9
+  data.tar.gz: 15ecfb499d538467f5d70c8ce5276a79852c4e04a50fd4a117d4c419ca75b54a415e3f822a29623cb8c406926004d04a9a05f3198c07fb25c9dd2b2012d2d3a4

data/.gitignore

@@ -1,3 +1,5 @@
+Gemfile.lock
+coverage
 doc
 pkg
 .DS_Store
@@ -6,3 +8,4 @@ pkg
 *.log
 *.swp
 *~
+*.gem

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+before_install:
+  - sudo apt-get install libxml2-dev libxslt1-dev nmap
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode
+script: rake test

data/ChangeLog.md

@@ -1,3 +1,27 @@
+### 0.7.0 / 2014-05-09
+
+* Added {Nmap::CPE}.
+* Added {Nmap::CPE::URL}.
+* Added {Nmap::Hop}.
+* Added {Nmap::Hostname}.
+* Added {Nmap::Traceroute}.
+* Added {Nmap::Host#traceroute}.
+* Added {Nmap::Host#uptime}. (@roodee)
+* Added {Nmap::Service#ssl?}.
+* Added {Nmap::Service#protocol}.
+* Added {Nmap::Service#extra_info}.
+* Added {Nmap::Service#os_type}.
+* Added {Nmap::Service#device_type}.
+* Added {Nmap::Service#fingerprint}. (@roodee)
+* Added {Nmap::Uptime}. (@roodee)
+* Added {Nmap::RunStat}. (@roodee)
+* Added {Nmap::XML.load}. (@vzctl)
+* Added {Nmap::XML.open}.
+* Added {Nmap::XML#each_run_stat}.
+* Added {Nmap::XML#run_stats}.
+* Added {Nmap::XML#each_task}.
+* Fixed xpath bug in {Nmap::OS#each_class} (@roodee).
+
 ### 0.6.0 / 2012-11-07
 
 * Added {Nmap::Service}.

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake',           '~> 10.0'
+  gem 'rubygems-tasks', '~> 0.1'
+  gem 'rspec',          '~> 2.4'
+  gem 'simplecov',      '~> 0.7'
+  gem 'kramdown',       '~> 1.0'
+  gem 'yard',           '~> 0.7'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2012 Postmodern
+Copyright (c) 2009-2014 Postmodern
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -7,12 +7,12 @@
 
 ## Description
 
-A Ruby interface to Nmap, the exploration tool and security / port scanner.
+A Ruby interface to [nmap], the exploration tool and security / port scanner.
 
 ## Features
 
-* Provides a Ruby interface for running Nmap.
-* Provides a Parser for enumerating Nmap XML scan files.
+* Provides a Ruby interface for running nmap.
+* Provides a Parser for enumerating nmap XML scan files.
 
 ## Examples
 
@@ -21,8 +21,6 @@ Run Nmap from Ruby:
     require 'nmap/program'
     
     Nmap::Program.scan do |nmap|
-      nmap.sudo = true
-
       nmap.syn_scan = true
       nmap.service_scan = true
       nmap.os_fingerprint = true
@@ -73,9 +71,9 @@ Print NSE script output from an XML scan file:
 
 ## Requirements
 
-* [nmap](http://www.insecure.org/) >= 5.00
-* [nokogiri](http://nokogiri.rubyforge.org/) ~> 1.3
-* [rprogram](https://github.com/postmodern/rprogram#readme) ~> 0.3
+* [nmap] >= 5.00
+* [nokogiri] ~> 1.3
+* [rprogram] ~> 0.3
 
 ## Install
 
@@ -83,6 +81,10 @@ Print NSE script output from an XML scan file:
 
 ## License
 
-Copyright (c) 2009-2012 Postmodern
+Copyright (c) 2009-2014 Postmodern
 
 See {file:LICENSE.txt} for license information.
+
+[nmap]: http://www.insecure.org/
+[nokogiri]: http://nokogiri.rubyforge.org/
+[rprogram]: https://github.com/postmodern/rprogram#readme

data/Rakefile

@@ -1,40 +1,36 @@
 # encoding: utf-8
 
 require 'rubygems'
-require 'rake'
 
 begin
-  gem 'rubygems-tasks', '~> 0.1'
-  require 'rubygems/tasks'
-
-  Gem::Tasks.new
+  require 'bundler/setup'
 rescue LoadError => e
   warn e.message
-  warn "Run `gem install rubygems-tasks` to install 'rubygems/tasks'."
+  warn "Run `gem install bundler` to install Bundler"
+  exit -1
 end
 
-begin
-  gem 'rspec', '~> 2.4'
-  require 'rspec/core/rake_task'
+require 'rake'
+require 'rake/clean'
 
-  RSpec::Core::RakeTask.new
-rescue LoadError => e
-  task :spec do
-    abort "Please run `gem install rspec` to install RSpec."
-  end
-end
+CLEAN.include('spec/*.xml')
+
+require 'rubygems/tasks'
 
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :spec    => 'spec/scan.xml'
 task :test    => :spec
 task :default => :spec
 
-begin
-  gem 'yard', '~> 0.7'
-  require 'yard'
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard
 
-  YARD::Rake::YardocTask.new  
-rescue LoadError => e
-  task :yard do
-    abort "Please run `gem install yard` to install YARD."
-  end
+file 'spec/scan.xml' do
+  puts ">>> Scanning scanme.nmap.org ..."
+  sh 'sudo nmap -v -sS -sU -A -O -oX spec/scan.xml scanme.nmap.org'
 end
-task :doc => :yard

data/gemspec.yml

@@ -17,6 +17,4 @@ dependencies:
   rprogram: ~> 0.3
 
 development_dependencies:
-  rubygems-tasks: ~> 0.1
-  rspec: ~> 2.4
-  yard: ~> 0.7
+  bundler: ~> 1.0

data/lib/nmap/cpe.rb

@@ -0,0 +1,2 @@
+require 'nmap/cpe/url'
+require 'nmap/cpe/cpe'

data/lib/nmap/cpe/cpe.rb

@@ -0,0 +1,45 @@
+require 'nmap/cpe/url'
+
+module Nmap
+  #
+  # Mixins that adds methods for parsing [Common Platform Enumeration
+  # (CPE)][CPE] information.
+  #
+  # [CPE]: http://nmap.org/book/output-formats-cpe.html
+  #
+  # @since 0.7.0
+  #
+  module CPE
+    #
+    # Parses each Common Platform Enumeration (CPE) String.
+    #
+    # @yield [cpe]
+    #   Passes each CPE URL to the given block.
+    #
+    # @yieldparam [URL] cpe
+    #   The CPE URL.
+    #
+    # @return [Enumerator]
+    #   If no block is given, an enumerator object will be returned.
+    #
+    def each_cpe
+      return enum_for(__method__) unless block_given?
+
+      @node.xpath('//cpe').each do |cpe|
+        yield URL.parse(cpe.inner_text)
+      end
+
+      return self
+    end
+
+    #
+    # Parses each Common Platform Enumeration (CPE) String.
+    #
+    # @return [Array<URL>]
+    #   The CPE URLs.
+    #
+    def cpe
+      each_cpe.to_a
+    end
+  end
+end

data/lib/nmap/cpe/url.rb

@@ -0,0 +1,78 @@
+module Nmap
+  module CPE
+    #
+    # Represets a [Common Platform Enumeration (CPE)][CPE] URL.
+    #
+    # [CPE]: http://nmap.org/book/output-formats-cpe.html
+    #
+    # @since 0.7.0
+    #
+    class URL < Struct.new(:part,:vendor,:product,:version,:update,:edition,
+                           :language)
+
+      # CPE part codes
+      PARTS = {
+        '/a' => :application,
+        '/h' => :hardware,
+        '/o' => :os
+      }
+
+      #
+      # Parses a CPE URL.
+      #
+      # @param [String] url
+      #   The raw URL.
+      #
+      # @return [URL]
+      #   The parsed URL.
+      #
+      def self.parse(url)
+          scheme,
+          part,
+          vendor,
+          product,
+          version,
+          update,
+          edition,
+          language = url.split(':',8)
+
+        unless scheme == 'cpe'
+          raise(ArgumentError,"CPE URLs must begin with 'cpe:'")
+        end
+
+        vendor   = vendor.to_sym
+        product  = product.to_sym
+        language = language.to_sym if language
+
+        return new(
+          PARTS[part],
+          vendor,
+          product,
+          version,
+          update,
+          edition,
+          language
+        )
+      end
+
+      #
+      # Converts the CPE URL back into a String.
+      #
+      # @return [String]
+      #   The raw CPE URL.
+      #
+      def to_s
+        'cpe:' + [
+          PARTS.invert[part],
+          vendor,
+          product,
+          version,
+          update,
+          edition,
+          language
+        ].compact.join(':')
+      end
+
+    end
+  end
+end

data/lib/nmap/hop.rb

@@ -0,0 +1,20 @@
+module Nmap
+  #
+  # Represents a hop in a traceroute.
+  #
+  # @since 0.7.0
+  #
+  class Hop < Struct.new(:addr, :host, :ttl, :rtt)
+
+    #
+    # Converts the hop to a String.
+    #
+    # @return [String]
+    #   The IP address of the hop.
+    #
+    def to_s
+      self.addr.to_s
+    end
+
+  end
+end

data/lib/nmap/host.rb

@@ -1,12 +1,16 @@
 require 'nmap/status'
 require 'nmap/address'
+require 'nmap/hostname'
 require 'nmap/os'
 require 'nmap/port'
 require 'nmap/ip_id_sequence'
 require 'nmap/tcp_sequence'
 require 'nmap/tcp_ts_sequence'
+require 'nmap/uptime'
+require 'nmap/traceroute'
 
 require 'nokogiri'
+require 'time'
 
 module Nmap
   #
@@ -22,17 +26,8 @@ module Nmap
     # @param [Nokogiri::XML::Node] node
     #   The XML node that contains the host information.
     #
-    # @yield [host]
-    #   If a block is given, it will be passed the newly created Host
-    #   object.
-    #
-    # @yieldparam [Host] host
-    #   The newly created Host object.
-    #
     def initialize(node)
       @node = node
-
-      yield self if block_given?
     end
 
     #
@@ -123,7 +118,7 @@ module Nmap
     #   The MAC address of the host.
     #
     def mac
-      @mac ||= if (addr = @node.xpath("address[@addrtype='mac']").first)
+      @mac ||= if (addr = @node.at("address[@addrtype='mac']"))
                  addr['addr']
                end
     end
@@ -135,7 +130,7 @@ module Nmap
     #   The IPv4 address of the host.
     #
     def ipv4
-      @ipv4 ||= if (addr = @node.xpath("address[@addrtype='ipv4']").first)
+      @ipv4 ||= if (addr = @node.at("address[@addrtype='ipv4']"))
                   addr['addr']
                 end
     end
@@ -147,7 +142,7 @@ module Nmap
     #   The IPv6 address of the host.
     #
     def ipv6
-      @ipv6 ||= if (@node.xpath("address[@addrtype='ipv6']").first)
+      @ipv6 ||= if (@node.at("address[@addrtype='ipv6']"))
                   addr['addr']
                 end
     end
@@ -178,7 +173,7 @@ module Nmap
     # @yield [host]
     #   Each parsed hostname will be passed to the given block.
     #
-    # @yieldparam [String] host
+    # @yieldparam [Hostname] host
     #   A hostname of the host.
     #
     # @return [Host, Enumerator]
@@ -189,7 +184,7 @@ module Nmap
       return enum_for(__method__) unless block_given?
 
       @node.xpath("hostnames/hostname[@name]").each do |host|
-        yield host['name']
+        yield Hostname.new(host['type'],host['name'])
       end
 
       return self
@@ -198,7 +193,7 @@ module Nmap
     #
     # Parses the hostnames of the host.
     #
-    # @return [Array<String>]
+    # @return [Array<Hostname>]
     #   The hostnames of the host.
     #
     def hostnames
@@ -225,6 +220,32 @@ module Nmap
       yield @os if (@os && block_given?)
       return @os
     end
+      
+    #
+    # Parses the Uptime analysis of the host.
+    #
+    # @yield [uptime]
+    #   If a block is given, it will be passed the resulting object
+    #
+    # @yieldparam [Uptime] 
+    #   Uptime value.
+    #
+    # @return [Uptime]
+    #   The parsed object.
+    #
+    # @since 0.7.0
+    #
+    def uptime
+      @uptime ||= if (uptime = @node.at('uptime'))
+                    Uptime.new(
+                      uptime['seconds'].to_i,
+                      Time.parse(uptime['lastboot'])
+                    )
+                  end
+
+      yield @uptime if (@uptime && block_given?)
+      return @uptime
+    end
 
     #
     # Parses the Tcp Sequence number analysis of the host.
@@ -477,6 +498,29 @@ module Nmap
       return @scripts
     end
 
+    #
+    # Parses the traceroute information, if present.
+    #
+    # @yield [traceroute]
+    #   If a block is given, it will be passed the traceroute information.
+    #
+    # @yieldparam [Traceroute] traceroute
+    #   The traceroute information.
+    #
+    # @return [Traceroute]
+    #   The traceroute information.
+    #
+    # @since 0.7.0
+    #
+    def traceroute
+      @traceroute ||= if (trace = @node.at('trace'))
+                        Traceroute.new(trace)
+                      end
+
+      yield @traceroute if (@traceroute && block_given?)
+      return @traceroute
+    end
+
     #
     # Converts the host to a String.
     #
@@ -489,5 +533,15 @@ module Nmap
       address.to_s
     end
 
+    #
+    # Inspects the host.
+    #
+    # @return [String]
+    #   The inspected host.
+    #
+    def inspect
+      "#<#{self.class}: #{self}>"
+    end
+
   end
 end