ruby-nmap 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8192a4dc58b09117d2aa6eb71a8a43440872f780
-  data.tar.gz: 605bb8d11e670acc42b90abdfd01bfeebd8cab1c
+  metadata.gz: 388a408deac159e18f406b2a17c657ba3b775940
+  data.tar.gz: 0e532295c98b5e0b3e1e627b11d1891c3d25dac3
 SHA512:
-  metadata.gz: 21b42a7d36d7aac99b722c38e80ff85646c1d677325ff6f480400a541ce8b9c9735dbbd58e227d13e321488458b30ae291783732955c70a784cd68481e6af7d9
-  data.tar.gz: 15ecfb499d538467f5d70c8ce5276a79852c4e04a50fd4a117d4c419ca75b54a415e3f822a29623cb8c406926004d04a9a05f3198c07fb25c9dd2b2012d2d3a4
+  metadata.gz: 5c6f4a3931390deb37c27a64358055e04abd6e4f250f2c3379b9085f7885bf714006e43a2ca2bf73c44156f8057a41fc3f17d345663f7f49537f2462e0479c21
+  data.tar.gz: b3e882efab065007b1d7370106ac39f3472114cec80716e37017056f49288b008bed3f4f6cf7db05a8c31f0c0780ccf48aaa3f789f14326b48c271b8d2b00f26

data/ChangeLog.md

@@ -1,3 +1,20 @@
+### 0.8.0 / 2014-04-16
+
+* Added {Nmap::XML#each_down_host}.
+* Added {Nmap::XML#down_hosts}.
+* Added {Nmap::XML#host}.
+* Added {Nmap::XML#up_host}.
+* Added {Nmap::XML#down_host}.
+* Added {Nmap::Host#hostname}.
+* Added {Nmap::Hostname#user?}.
+* Added {Nmap::Hostname#ptr?}.
+* Added {Nmap::Program.sudo_scan}.
+* Added {Nmap::Program#sudo_scan}.
+* Renamed {Nmap::XML.load} to {Nmap::XML.parse}.
+* Fixed a typo in the `--privileged` flag (@BrentonEarl)
+* Allow multiple values in the `--script` flag.
+* Alias {Nmap::Task#script_params} to `script_args`.
+
 ### 0.7.0 / 2014-05-09
 
 * Added {Nmap::CPE}.

data/Gemfile

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

data/lib/nmap/address.rb

@@ -1,6 +1,6 @@
 module Nmap
   #
-  # Represents a IP or MAC address.
+  # Represents an IP or MAC address and Vendor name.
   #
   class Address < Struct.new(:type, :addr)
 

data/lib/nmap/host.rb

@@ -123,6 +123,20 @@ module Nmap
                end
     end
 
+    #
+    # Parses the MAC vendor of the host.
+    #
+    # @return [String]
+    #   The Mac Vendor of the host.
+    #
+    # @since 0.8.0
+    #
+    def vendor
+      @vendor ||= if (vendor = @node.at("address[@vendor]"))
+                 vendor['vendor']
+               end
+    end
+
     #
     # Parses the IPv4 address of the host.
     #
@@ -200,6 +214,17 @@ module Nmap
       each_hostname.to_a
     end
 
+    #
+    # The primary hostname of the host.
+    #
+    # @return [Hostname, nil]
+    #
+    # @since 0.8.0
+    #
+    def hostname
+      each_hostname.first
+    end
+
     #
     # Parses the OS guessing information of the host.
     #
@@ -525,12 +550,12 @@ module Nmap
     # Converts the host to a String.
     #
     # @return [String]
-    #   The address of the host.
+    #   The hostname or address of the host.
     #
     # @see address
     #
     def to_s
-      address.to_s
+      (hostname || address).to_s
     end
 
     #

data/lib/nmap/hostname.rb

@@ -6,6 +6,28 @@ module Nmap
   #
   class Hostname < Struct.new(:type, :name)
 
+    #
+    # Determines if the hostname was specified by the user.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.8.0
+    #
+    def user?
+      self.type == 'user'
+    end
+
+    #
+    # Determines if the hostname is a DNS `PTR`.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.8.0
+    #
+    def ptr?
+      self.type == 'PTR'
+    end
+
     #
     # Converts the hostname to a String.
     #

data/lib/nmap/os.rb

@@ -115,7 +115,7 @@ module Nmap
     #
     # Parses the OS match information.
     #
-    # @see each_match
+    # @see #each_match
     #
     def each(&block)
       each_match(&block)

data/lib/nmap/program.rb

@@ -49,6 +49,18 @@ module Nmap
       find.scan(options,exec_options,&block)
     end
 
+    #
+    # Finds the `nmap` program and performs a scan, but runs `nmap` under
+    # `sudo`.
+    #
+    # @see scan
+    #
+    # @since 0.8.0
+    #
+    def self.sudo_scan(options={},exec_options={},&block)
+      find.sudo_scan(options,exec_options,&block)
+    end
+
     #
     # Performs a scan.
     #
@@ -75,5 +87,16 @@ module Nmap
       run_task(Task.new(options,&block),exec_options)
     end
 
+    #
+    # Performs a scan and runs `nmap` under `sudo`.
+    #
+    # @see #scan
+    #
+    # @since 0.8.0
+    #
+    def sudo_scan(options={},exec_options={},&block)
+      sudo_task(Task.new(options,&block),exec_options)
+    end
+
   end
 end

data/lib/nmap/task.rb

@@ -14,7 +14,7 @@ module Nmap
   # ### Host Discovery:
   #
   # * `-sL` - `nmap.list`
-  # * `-sP` - `nmap.ping`
+  # * `-sn` - `nmap.ping`
   # * `-PN` - `nmap.skip_discovery`
   # * `-PS` - `nmap.syn_discovery`
   # * `-PA` - `nmap.ack_discovery`
@@ -156,8 +156,8 @@ module Nmap
   # * `--versiondb` - `nmap.versiondb`
   # * `--send-eth` - `nmap.raw_ethernet`
   # * `--send-ip` - `nmap.raw_ip`
-  # * `--privledged` - `nmap.privledged`
-  # * `--unprivledged` - `nmap.unprivledged`
+  # * `--privileged` - `nmap.privileged`
+  # * `--unprivileged` - `nmap.unprivileged`
   # * `--release-memory` - `nmap.release_memory`
   # * `--interactive` - `nmap.interactive`
   # * `-V` - `nmap.version`
@@ -177,7 +177,7 @@ module Nmap
 
     # HOST DISCOVERY:
     short_option :flag => '-sL', :name => :list
-    short_option :flag => '-sP', :name => :ping
+    short_option :flag => '-sn', :name => :ping
     short_option :flag => '-PN', :name => :skip_discovery
     short_option :flag => '-PS', :name => :syn_discovery
     short_option :flag => '-PA', :name => :ack_discovery
@@ -241,10 +241,10 @@ module Nmap
 
     # SCRIPT SCAN:
     short_option :flag => '-sC', :name => :default_script
-    long_option :flag => '--script'
-    long_option :flag => '--script-args',
-                :name => :script_params,
-                :separator => ','
+    long_option :flag => '--script', :separator => ','
+    long_option :flag => '--script-args', :separator => ','
+    alias script_params script_args
+    alias script_params= script_args=
     long_option :flag => '--script-trace'
     long_option :flag => '--script-updatedb', :name => :update_scriptdb
 
@@ -323,7 +323,7 @@ module Nmap
     long_option :flag => '--versiondb'
     long_option :flag => '--send-eth', :name => :raw_ethernet
     long_option :flag => '--send-ip', :name => :raw_ip
-    long_option :flag => '--privledged'
+    long_option :flag => '--privileged'
     long_option :flag => '--unprivleged'
     long_option :flag => '--release-memory'
     long_option :flag => '--interactive'

data/lib/nmap/version.rb

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

data/lib/nmap/xml.rb

@@ -55,10 +55,19 @@ module Nmap
     # @yieldparam [XML] xml
     #   The newly created XML object.
     #
+    # @since 0.8.0
+    #
+    def self.parse(text,&block)
+      new(Nokogiri::XML(text), &block)
+    end
+
+    #
+    # @deprecated Use {parse} instead.
+    #
     # @since 0.7.0
     #
     def self.load(text,&block)
-      new(Nokogiri::XML(text), &block)
+      parse(text,&block)
     end
 
     #
@@ -263,6 +272,65 @@ module Nmap
       each_host.to_a
     end
 
+    #
+    # Returns the first host.
+    #
+    # @return [Host]
+    #
+    # @since 0.8.0
+    #
+    def host
+      each_host.first
+    end
+
+    #
+    # Parses the hosts that were found to be down during the scan.
+    #
+    # @yield [host]
+    #   Each host will be passed to a given block.
+    #
+    # @yieldparam [Host] host
+    #   A down host in the scan.
+    #
+    # @return [XML, Enumerator]
+    #   The XML parser. If no block was given, an enumerator object will
+    #   be returned.
+    #
+    # @since 0.8.0
+    #
+    def each_down_host
+      return enum_for(__method__) unless block_given?
+
+      @doc.xpath("/nmaprun/host[status[@state='down']]").each do |host|
+        yield Host.new(host)
+      end
+
+      return self
+    end
+
+    #
+    # Parses the hosts found to be down during the scan.
+    #
+    # @return [Array<Host>]
+    #   The down hosts in the scan.
+    #
+    # @since 0.8.0
+    #
+    def down_hosts
+      each_down_host.to_a
+    end
+
+    #
+    # Returns the first host found to be down during the scan.
+    #
+    # @return [Host]
+    #
+    # @since 0.8.0
+    #
+    def down_host
+      each_down_host.first
+    end
+
     #
     # Parses the hosts that were found to be up during the scan.
     #
@@ -296,6 +364,17 @@ module Nmap
       each_up_host.to_a
     end
 
+    #
+    # Returns the first host found to be up during the scan.
+    #
+    # @return [Host]
+    #
+    # @since 0.8.0
+    #
+    def up_host
+      each_up_host.first
+    end
+
     #
     # Parses the hosts that were found to be up during the scan.
     #

data/ruby-nmap.gemspec

@@ -66,7 +66,7 @@ Gem::Specification.new do |gemspec|
   gemspec.extra_rdoc_files = Array(metadata['extra_doc_files'])
 
   gemspec.post_install_message = metadata['post_install_message']
-  gemspec.requirements         = metadata['requirements']
+  gemspec.requirements         = Array(metadata['requirements'])
 
   if gemspec.respond_to?(:required_ruby_version=)
     gemspec.required_ruby_version = metadata['required_ruby_version']

data/spec/address_spec.rb

@@ -8,7 +8,7 @@ describe Address do
     subject { described_class.new(:ipv4, addr) }
 
     it "should return the address" do
-      subject.to_s.should == addr
+      expect(subject.to_s).to eq(addr)
     end
   end
 end

data/spec/cpe/url_spec.rb

@@ -4,9 +4,9 @@ describe CPE::URL do
   describe "parse" do
     context "when the URL does not start with 'cpe:'" do
       it "should raise an ArgumentError" do
-        lambda {
+        expect {
           described_class.parse('foo:')
-        }.should raise_error(ArgumentError)
+        }.to raise_error(ArgumentError)
       end
     end
 
@@ -20,13 +20,13 @@ describe CPE::URL do
       end
 
       it "should leave them nil" do
-        subject.vendor.should == vendor
-        subject.product.should == product
-        subject.version.should == version
+        expect(subject.vendor).to eq(vendor)
+        expect(subject.product).to eq(product)
+        expect(subject.version).to eq(version)
 
-        subject.update.should be_nil
-        subject.edition.should be_nil
-        subject.language.should be_nil
+        expect(subject.update).to be_nil
+        expect(subject.edition).to be_nil
+        expect(subject.language).to be_nil
       end
     end
 
@@ -34,7 +34,7 @@ describe CPE::URL do
       subject { described_class.parse("cpe:/h:foo:bar:baz") }
 
       it "should parse it as :hardware" do
-        subject.part.should == :hardware
+        expect(subject.part).to eq(:hardware)
       end
     end
 
@@ -42,7 +42,7 @@ describe CPE::URL do
       subject { described_class.parse("cpe:/a:foo:bar:baz") }
 
       it "should parse it as :application" do
-        subject.part.should == :application
+        expect(subject.part).to eq(:application)
       end
     end
 
@@ -50,7 +50,7 @@ describe CPE::URL do
       subject { described_class.parse("cpe:/o:foo:bar:baz") }
 
       it "should parse it as :os" do
-        subject.part.should == :os
+        expect(subject.part).to eq(:os)
       end
     end
   end
@@ -61,14 +61,14 @@ describe CPE::URL do
     let(:version) { '2.6.39'      }
 
     it "should add the scheme 'cpe:'" do
-      subject.to_s.should start_with('cpe:')
+      expect(subject.to_s).to start_with('cpe:')
     end
 
     context "when fields are nil" do
       subject { described_class.new(:os,vendor,product,version) }
 
       it "should omit them" do
-        subject.to_s.should == "cpe:/o:#{vendor}:#{product}:#{version}"
+        expect(subject.to_s).to eq("cpe:/o:#{vendor}:#{product}:#{version}")
       end
     end
 
@@ -76,7 +76,7 @@ describe CPE::URL do
       subject { described_class.new(:hardware) }
 
       it "should map it to /h" do
-        subject.to_s.should == "cpe:/h"
+        expect(subject.to_s).to eq("cpe:/h")
       end
     end
 
@@ -84,7 +84,7 @@ describe CPE::URL do
       subject { described_class.new(:application) }
 
       it "should map it to /h" do
-        subject.to_s.should == "cpe:/a"
+        expect(subject.to_s).to eq("cpe:/a")
       end
     end
 
@@ -92,7 +92,7 @@ describe CPE::URL do
       subject { described_class.new(:os) }
 
       it "should map it to /h" do
-        subject.to_s.should == "cpe:/o"
+        expect(subject.to_s).to eq("cpe:/o")
       end
     end
   end