ruby-nmap 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 388a408deac159e18f406b2a17c657ba3b775940
-  data.tar.gz: 0e532295c98b5e0b3e1e627b11d1891c3d25dac3
+  metadata.gz: 7a11debc4eeccebd368b11d1d0444dd142f3dc91
+  data.tar.gz: fa232e147c7cd46e96bd8a15468f6af5b4ff1723
 SHA512:
-  metadata.gz: 5c6f4a3931390deb37c27a64358055e04abd6e4f250f2c3379b9085f7885bf714006e43a2ca2bf73c44156f8057a41fc3f17d345663f7f49537f2462e0479c21
-  data.tar.gz: b3e882efab065007b1d7370106ac39f3472114cec80716e37017056f49288b008bed3f4f6cf7db05a8c31f0c0780ccf48aaa3f789f14326b48c271b8d2b00f26
+  metadata.gz: 62a04a0bde27b4ae0f9aa015cfa668ca9efe08d596f710c2b01816c9bf6bc333a5f098afb40287f8f918546286ee9414c166624343b9e1ad994009b48b299bec
+  data.tar.gz: be13fe698e9c8197a6877cdcdd6193118326a683ee52b4e23c3f421ce48594faa333da8ead0cfa466ace383cb08d3433374ea28349e117ded444513b79699baa

data/.travis.yml

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

data/ChangeLog.md

@@ -1,3 +1,21 @@
+### 0.9.0 / 2016-07-14
+
+* Added {Nmap::Address#vendor}.
+* Added {Nmap::Service#to_s}.
+* Added {Nmap::HostScript}.
+* Added {Nmap::Prescript}.
+* Added {Nmap::Postscript}.
+* Added {Nmap::XML#prescript}.
+* Added {Nmap::XML#postscript}.
+* Added `Nmap::Task#quiet` (aka `-v0`).
+* `#script_data` methods can now parse arbitrarily nested Arrays/Hashes.
+* Fixed {Nmap::CPE#each_cpe} to only match child `cpe` elements, not all
+  `cpe` elements within the document.
+* Changed {Nmap::Service#to_s} to output product/version only if both are
+  present.
+* Changed `Nmap::Task#skip_discovery` to use `-Pn` instead of `-PN`, which was
+  deprecated in nmap >= 7.00.
+
 ### 0.8.0 / 2014-04-16
 
 * Added {Nmap::XML#each_down_host}.
@@ -94,7 +112,7 @@
 ### 0.3.0 / 2010-11-08
 
 * Added {Nmap::Host#scripts}.
-* Added {Nmap::Port#scripts}.
+* Added {Nmap::Scripts#scripts Nmap::Port#scripts}.
 
 ### 0.2.0 / 2010-10-29
 

data/README.md

@@ -4,6 +4,7 @@
 * [Issues](https://github.com/sophsec/ruby-nmap/issues)
 * [Documentation](http://rubydoc.info/gems/ruby-nmap/frames)
 * [Email](mailto:postmodern.mod3 at gmail.com)
+* [![Build Status](https://travis-ci.org/sophsec/ruby-nmap.svg)](https://travis-ci.org/sophsec/ruby-nmap)
 
 ## Description
 
@@ -71,6 +72,7 @@ Print NSE script output from an XML scan file:
 
 ## Requirements
 
+* [ruby] >= 2.0.0
 * [nmap] >= 5.00
 * [nokogiri] ~> 1.3
 * [rprogram] ~> 0.3
@@ -86,5 +88,6 @@ Copyright (c) 2009-2014 Postmodern
 See {file:LICENSE.txt} for license information.
 
 [nmap]: http://www.insecure.org/
+[ruby]: https://www.ruby-lang.org/
 [nokogiri]: http://nokogiri.rubyforge.org/
 [rprogram]: https://github.com/postmodern/rprogram#readme

data/Rakefile

@@ -32,5 +32,5 @@ task :doc => :yard
 
 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'
+  sh 'sudo nmap -v -sS -sU -A -O --script ssh2-enum-algos,ssh-hostkey -oX spec/scan.xml scanme.nmap.org'
 end

data/gemspec.yml

@@ -10,6 +10,8 @@ email: postmodern.mod3@gmail.com
 homepage: https://github.com/sophsec/ruby-nmap#readme
 has_yard: true
 
+required_ruby_version: ">= 2.0.0"
+
 requirements: nmap >= 5.00
 
 dependencies:

data/lib/nmap/address.rb

@@ -2,7 +2,23 @@ module Nmap
   #
   # Represents an IP or MAC address and Vendor name.
   #
-  class Address < Struct.new(:type, :addr)
+  class Address < Struct.new(:type, :addr, :vendor)
+
+    #
+    # Initializes the address.
+    #
+    # @param [Symbol] type
+    #   The type of address.
+    #
+    # @param [String] addr
+    #   The address.
+    #
+    # @param [String, nil] vendor
+    #   The optional vendor.
+    #
+    def initialize(type,addr,vendor=nil)
+      super(type,addr,vendor)
+    end
 
     #
     # Converts the address to a String.

data/lib/nmap/cpe.rb

@@ -1,2 +1,45 @@
 require 'nmap/cpe/url'
-require 'nmap/cpe/cpe'
+
+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/host.rb

@@ -8,6 +8,7 @@ require 'nmap/tcp_sequence'
 require 'nmap/tcp_ts_sequence'
 require 'nmap/uptime'
 require 'nmap/traceroute'
+require 'nmap/host_script'
 
 require 'nokogiri'
 require 'time'
@@ -92,7 +93,8 @@ module Nmap
       @node.xpath("address[@addr]").each do |addr|
         address = Address.new(
           addr['addrtype'].to_sym,
-          addr['addr']
+          addr['addr'],
+          addr['vendor']
         )
 
         yield address
@@ -132,8 +134,8 @@ module Nmap
     # @since 0.8.0
     #
     def vendor
-      @vendor ||= if (vendor = @node.at("address[@vendor]"))
-                 vendor['vendor']
+      @vendor ||= if (vendor = @node.at("address/@vendor"))
+                 vendor.inner_text
                end
     end
 
@@ -511,16 +513,28 @@ module Nmap
     #
     # @since 0.3.0
     #
+    # @deprecated Use {#host_script} instead.
+    #
     def scripts
-      unless @scripts
-        @scripts = {}
-
-        @node.xpath('hostscript/script').each do |script|
-          @scripts[script['id']] = script['output']
-        end
+      if host_script
+        host_script.scripts
+      else
+        {}
       end
+    end
 
-      return @scripts
+    #
+    # The NSE scripts ran against the host.
+    #
+    # @return [HostScript, nil]
+    #   Contains the host script output and data.
+    #
+    # @since 0.9.0
+    #
+    def host_script
+      @host_script ||= if (hostscript = @node.at('hostscript'))
+                         HostScript.new(hostscript)
+                       end
     end
 
     #

data/lib/nmap/host_script.rb

@@ -0,0 +1,18 @@
+require 'nmap/scripts'
+
+module Nmap
+  #
+  # Represents the `hostscript` element.
+  #
+  # @since 0.9.0
+  #
+  class HostScript
+
+    include Scripts
+
+    def initialize(node)
+      @node = node
+    end
+
+  end
+end

data/lib/nmap/port.rb

@@ -1,4 +1,5 @@
 require 'nmap/service'
+require 'nmap/scripts'
 
 module Nmap
   #
@@ -6,6 +7,8 @@ module Nmap
   #
   class Port
 
+    include Scripts
+
     #
     # Creates a new Port object.
     #
@@ -70,26 +73,6 @@ module Nmap
                         end
     end
 
-    #
-    # 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
-
     alias to_i number
 
     #

data/lib/nmap/postscript.rb

@@ -0,0 +1,16 @@
+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

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

data/lib/nmap/scripts.rb

@@ -0,0 +1,71 @@
+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

data/lib/nmap/service.rb

@@ -152,7 +152,19 @@ module Nmap
       @confidence ||= @node.get_attribute('conf').to_i
     end
 
-    alias to_s name
+    #
+    # Converts the service to a String.
+    #
+    # @return [String]
+    #   String containing {#product} and {#version}, or {#name}.
+    #
+    def to_s
+      if (product && version)
+        "#{product} #{version}"
+      else
+        name
+      end
+    end
 
   end
 end

data/lib/nmap/task.rb

@@ -15,7 +15,7 @@ module Nmap
   #
   # * `-sL` - `nmap.list`
   # * `-sn` - `nmap.ping`
-  # * `-PN` - `nmap.skip_discovery`
+  # * `-Pn` - `nmap.skip_discovery`
   # * `-PS` - `nmap.syn_discovery`
   # * `-PA` - `nmap.ack_discovery`
   # * `-PU` - `nmap.udp_discovery`
@@ -131,6 +131,7 @@ module Nmap
   # ### Verbosity and Debugging:
   #
   # * `-v` - `nmap.verbose`
+  # * `-v0` - `nmap.quiet`
   # * `-d` - `nmap.debug`
   # * `--reason` - `nmap.show_reason`
   # * `--stats-every` - `nmap.stats_every`
@@ -178,7 +179,7 @@ module Nmap
     # HOST DISCOVERY:
     short_option :flag => '-sL', :name => :list
     short_option :flag => '-sn', :name => :ping
-    short_option :flag => '-PN', :name => :skip_discovery
+    short_option :flag => '-Pn', :name => :skip_discovery
     short_option :flag => '-PS', :name => :syn_discovery
     short_option :flag => '-PA', :name => :ack_discovery
     short_option :flag => '-PU', :name => :udp_discovery
@@ -300,6 +301,7 @@ module Nmap
 
     # Verbosity and Debugging:
     short_option :flag => '-v', :name => :verbose
+    short_option :flag => '-v0', :name => :quiet
     short_option :flag => '-d', :name => :debug
     long_option :flag => '--reason', :name => :show_reason
     long_option :flag => '--stats-every'