ruby-nmap 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8765d23433a0084314d1e77d295a5f4f3634db7
-  data.tar.gz: af7b74ff8336e49ddb704100fad33f10656ee959
+  metadata.gz: '07049218e947bfd368b40b59010f838c9e298f25'
+  data.tar.gz: 94176a6041fc4da9a2adcd7ebf4ea9714ff6b6e2
 SHA512:
-  metadata.gz: e21d33b52f03a2eeee743c81bb614e919be5ea9f160af50d6f6935de90368bbccba4f9989b070607c417b03cc0a21679c06a12afa4a81c951e8ab3e2ac8288d6
-  data.tar.gz: 368e3aebd55908e2bc4d0690e58ad51d4aa1c2c66d696d7430d3b53e32f40940348776cd2fdd0bf0bc2c6b47de70b3af325e7de1b8e00981006de433da2f5c53
+  metadata.gz: 6b753b489e1f5f8ee6e03ea9162e7a120d3fdfcb97d138f3cd0d6b02f521b0630240322e8ebb76b88a54437095b1ac40e2f2271e1692b0665df8f7203ee8bd7f
+  data.tar.gz: f00bec7139dcd52ef9f4d351da5c3821fa0a2f20cb3570927b11b80f0c90f74cdf32876a252f1ad9b4a1b8051921c493af848991896d857b657381431438285f

data/ChangeLog.md

@@ -1,3 +1,18 @@
+### 0.9.3 / 2018-05-01
+
+* Added missing `Nmap::Task#defeat_icmp_ratelimit` for the
+  `--defeat-icmp-ratelimit` option.
+* Added missing `Nmap::Task#nsock_engine` for the `--nsock-engine` option.
+* Added the {Nmap::XML#prescripts} alias.
+* Added the {Nmap::XML#postscripts} alias.
+* Allow `Task#sctp_init_ping` to accept a port Range object.
+* Fixed a typo in the `Task#defeat_rst_ratelimit` name.
+* Fixed the option formatting of `Nmap::Task#syn_discovery`.
+* Fixed the option formatting of `Nmap::Task#ack_discovery`.
+* Fixed the option formatting of `Nmap::Task#udp_discovery`.
+* Fixed the option formatting of `Nmap::Task#sctp_init_ping`.
+* Fixed the option formatting of `Nmap::Task#ip_ping`.
+
 ### 0.9.2 / 2017-01-13
 
 * Fix file descriptor leak in {Nmap::XML#initialize} by using

data/Gemfile

@@ -10,5 +10,5 @@ group :development do
   gem 'json'
   gem 'simplecov',      '~> 0.7'
   gem 'kramdown'
-  gem 'yard',           '~> 0.8'
+  gem 'yard',           '~> 0.9'
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2017 Postmodern
+Copyright (c) 2009-2018 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

@@ -32,6 +32,15 @@ Run Nmap from Ruby:
       nmap.targets = '192.168.1.*'
     end
 
+Run `sudo nmap` from Ruby:
+
+    require 'nmap/program'
+
+    Nmap::Program.sudo_scan do |nmap|
+      nmap.syn_scan = true
+      # ...
+    end
+
 Parse Nmap XML scan files:
 
     require 'nmap/xml'
@@ -83,7 +92,7 @@ Print NSE script output from an XML scan file:
 
 ## License
 
-Copyright (c) 2009-2017 Postmodern
+Copyright (c) 2009-2018 Postmodern
 
 See {file:LICENSE.txt} for license information.
 

data/Rakefile

@@ -12,11 +12,9 @@ end
 
 require 'rake'
 require 'rake/clean'
-
 CLEAN.include('spec/*.xml')
 
 require 'rubygems/tasks'
-
 Gem::Tasks.new
 
 require 'rspec/core/rake_task'

data/lib/nmap/host.rb

@@ -63,7 +63,7 @@ module Nmap
     #
     def status
       unless @status
-        status = @node.at('status')
+        status = @node.at_xpath('status')
 
         @status = Status.new(
           status['state'].to_sym,
@@ -120,7 +120,7 @@ module Nmap
     #   The MAC address of the host.
     #
     def mac
-      @mac ||= if (addr = @node.at("address[@addrtype='mac']"))
+      @mac ||= if (addr = @node.at_xpath("address[@addrtype='mac']"))
                  addr['addr']
                end
     end
@@ -134,7 +134,7 @@ module Nmap
     # @since 0.8.0
     #
     def vendor
-      @vendor ||= if (vendor = @node.at("address/@vendor"))
+      @vendor ||= if (vendor = @node.at_xpath("address/@vendor"))
                  vendor.inner_text
                end
     end
@@ -146,7 +146,7 @@ module Nmap
     #   The IPv4 address of the host.
     #
     def ipv4
-      @ipv4 ||= if (addr = @node.at("address[@addrtype='ipv4']"))
+      @ipv4 ||= if (addr = @node.at_xpath("address[@addrtype='ipv4']"))
                   addr['addr']
                 end
     end
@@ -158,7 +158,7 @@ module Nmap
     #   The IPv6 address of the host.
     #
     def ipv6
-      @ipv6 ||= if (addr = @node.at("address[@addrtype='ipv6']"))
+      @ipv6 ||= if (addr = @node.at_xpath("address[@addrtype='ipv6']"))
                   addr['addr']
                 end
     end
@@ -240,7 +240,7 @@ module Nmap
     #   The OS guessing information.
     #
     def os
-      @os ||= if (os = @node.at('os'))
+      @os ||= if (os = @node.at_xpath('os'))
                 OS.new(os)
               end
 
@@ -263,7 +263,7 @@ module Nmap
     # @since 0.7.0
     #
     def uptime
-      @uptime ||= if (uptime = @node.at('uptime'))
+      @uptime ||= if (uptime = @node.at_xpath('uptime'))
                     Uptime.new(
                       uptime['seconds'].to_i,
                       Time.parse(uptime['lastboot'])
@@ -287,7 +287,7 @@ module Nmap
     #   The parsed object.
     #
     def tcp_sequence
-      @tcp_sequence ||= if (seq = @node.at('tcpsequence'))
+      @tcp_sequence ||= if (seq = @node.at_xpath('tcpsequence'))
                           TcpSequence.new(seq)
                         end
 
@@ -317,7 +317,7 @@ module Nmap
     #   The parsed object.
     #
     def ip_id_sequence
-      @ip_id_sequence ||= if (seq = @node.at('ipidsequence'))
+      @ip_id_sequence ||= if (seq = @node.at_xpath('ipidsequence'))
                             IpIdSequence.new(seq)
                           end
 
@@ -347,7 +347,7 @@ module Nmap
     #   The parsed object.
     #
     def tcp_ts_sequence
-      @tcp_ts_sequence ||= if (seq = @node.at('tcptssequence'))
+      @tcp_ts_sequence ||= if (seq = @node.at_xpath('tcptssequence'))
                              TcpTsSequence.new(seq)
                            end
 
@@ -532,7 +532,7 @@ module Nmap
     # @since 0.9.0
     #
     def host_script
-      @host_script ||= if (hostscript = @node.at('hostscript'))
+      @host_script ||= if (hostscript = @node.at_xpath('hostscript'))
                          HostScript.new(hostscript)
                        end
     end
@@ -552,7 +552,7 @@ module Nmap
     # @since 0.7.0
     #
     def traceroute
-      @traceroute ||= if (trace = @node.at('trace'))
+      @traceroute ||= if (trace = @node.at_xpath('trace'))
                         Traceroute.new(trace)
                       end
 

data/lib/nmap/os.rb

@@ -109,7 +109,7 @@ module Nmap
     #   The OS fingerprint.
     #
     def fingerprint
-      @fingerprint ||= if (fingerprint = @node.at("osfingerprint/@fingerprint"))
+      @fingerprint ||= if (fingerprint = @node.at_xpath("osfingerprint/@fingerprint"))
                          fingerprint.inner_text
                        end
     end

data/lib/nmap/port.rb

@@ -46,7 +46,7 @@ module Nmap
     #   The state of the port (`:open`, `:filtered` or `:closed`).
     #
     def state
-      @state ||= @node.at('state/@state').inner_text.to_sym
+      @state ||= @node.at_xpath('state/@state').inner_text.to_sym
     end
 
     #
@@ -56,7 +56,7 @@ module Nmap
     #   How the port was discovered.
     #
     def reason
-      @reason ||= @node.at('state/@reason').inner_text
+      @reason ||= @node.at_xpath('state/@reason').inner_text
     end
 
     #
@@ -68,7 +68,7 @@ module Nmap
     # @since 0.6.0
     #
     def service
-      @service_info ||= if (service = @node.at('service'))
+      @service_info ||= if (service = @node.at_xpath('service'))
                           Service.new(service)
                         end
     end

data/lib/nmap/task.rb

@@ -95,7 +95,9 @@ module Nmap
   # * `--max-scan-delay` - `nmap.max_scan_delay`
   # * `--min-rate` - `nmap.min_rate`
   # * `--max-rate` - `nmap.max_rate`
-  # * `--default-rst-ratelimit` - `nmap.default_rst_ratelimit`
+  # * `--defeat-rst-ratelimit` - `nmap.defeat_rst_ratelimit`
+  # * `--defeat-icmp-ratelimit` - `nmap.defeat_icmp_ratelimit`
+  # * `--nsock-engine` - `nmap.nsock_engine`
   # * `-T` - `nmap.timing_template`
   # * `-T0` - `nmap.paranoid_timing`
   # * `-T1` - `nmap.sneaky_timing`
@@ -180,14 +182,24 @@ module Nmap
     short_option :flag => '-sL', :name => :list
     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
-    short_option :flag => '-PU', :name => :udp_discovery
-    short_option :flag => '-PY', :name => :sctp_init_ping
+    short_option :flag => '-PS', :name => :syn_discovery do |opt,value|
+      ["#{opt.flag}#{format_port_list(value)}"]
+    end
+    short_option :flag => '-PA', :name => :ack_discovery do |opt,value|
+      ["#{opt.flag}#{format_port_list(value)}"]
+    end
+    short_option :flag => '-PU', :name => :udp_discovery do |opt,value|
+      ["#{opt.flag}#{format_port_list(value)}"]
+    end
+    short_option :flag => '-PY', :name => :sctp_init_ping do |opt,value|
+      ["#{opt.flag}#{format_port_list(value)}"]
+    end
     short_option :flag => '-PE', :name => :icmp_echo_discovery
     short_option :flag => '-PP', :name => :icmp_timestamp_discovery
     short_option :flag => '-PM', :name => :icmp_netmask_discovery
-    short_option :flag => '-PO', :name => :ip_ping
+    short_option :flag => '-PO', :name => :ip_ping do |opt,value|
+      ["#{opt.flag}#{format_protocol_list(value)}"]
+    end
     short_option :flag => '-PR', :name => :arp_ping
     long_option :flag => '--traceroute', :name => :traceroute
     short_option :flag => '-n', :name => :disable_dns
@@ -215,17 +227,9 @@ module Nmap
     # PORT SPECIFICATION AND SCAN ORDER:
     short_option :flag => '-p', :name => :ports do |opt,value|
       unless value.empty?
-        [opt.flag, value.map { |port|
-          case port
-          when Range
-            "#{port.first}-#{port.last}"
-          else
-            port.to_s
-          end
-        }.join(',')]
+        [opt.flag, format_port_list(value)]
       end
     end
-
     short_option :flag => '-F', :name => :fast
     short_option :flag => '-r', :name => :consecutively
     long_option :flag => '--top-ports'
@@ -268,7 +272,9 @@ module Nmap
     long_option :flag => '--max-scan-delay'
     long_option :flag => '--min-rate'
     long_option :flag => '--max-rate'
-    long_option :flag => '--default-rst-ratelimit'
+    long_option :flag => '--defeat-rst-ratelimit'
+    long_option :flag => '--defeat-icmp-ratelimit'
+    long_option :flag => '--nsock-engine'
     short_option :flag => '-T', :name => :timing_template
     short_option :flag => '-T0', :name => :paranoid_timing
     short_option :flag => '-T1', :name => :sneaky_timing
@@ -334,5 +340,42 @@ module Nmap
 
     non_option :tailing => true, :name => :targets
 
+    private
+
+    #
+    # Fomats a port list.
+    #
+    # @param [Array<Integer,Range>] ports
+    #   The port ranges.
+    #
+    # @return [String]
+    #   Comma separated string.
+    #
+    def self.format_port_list(ports)
+      ports.map { |port|
+        case port
+        when Range
+          "#{port.first}-#{port.last}"
+        else
+          port.to_s
+        end
+      }.join(',')
+    end
+
+    #
+    # Formats a protocol list.
+    #
+    # @param [Array<Integer,Range>] protocols
+    #   The IP protocol numbers.
+    #
+    # @return [String]
+    #   Comma separated string.
+    #
+    def self.format_protocol_list(protocols)
+      # NOTE: the man page says the protocol list is similar to the format of
+      # a port range.
+      format_port_list(protocols)
+    end
+
   end
 end

data/lib/nmap/version.rb

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

data/lib/nmap/xml.rb

@@ -255,6 +255,8 @@ module Nmap
                      end
     end
 
+    alias prescripts prescript
+
     #
     # The NSE scripts ran after the scan.
     #
@@ -269,6 +271,8 @@ module Nmap
                       end
     end
 
+    alias postscripts postscript
+
     #
     # Parses the hosts in the scan.
     #

data/spec/task_spec.rb

@@ -3,34 +3,148 @@ require 'nmap/task'
 
 describe Task do
   describe "#ports=" do
-    it "should ignore empty port Arrays" do
-      subject.ports = []
+    context "when given an empty Array" do
+      before { subject.ports = [] }
 
-      expect(subject.arguments).to eq([])
+      it "should ignore empty port Arrays" do
+        subject.ports = []
+
+        expect(subject.arguments).to eq([])
+      end
+    end
+
+    context "when given a String" do
+      let(:ports) { '80,21,25' }
+
+      before { subject.ports = ports }
+
+      it "should emit the String as is" do
+        expect(subject.arguments).to eq(['-p', ports])
+      end
     end
 
-    it "should format a String of ports" do
-      subject.ports = '80,21,25'
+    context "when given an Array of Strings" do
+      let(:ports) { %w[80 21 25] }
+
+      before { subject.ports = ports }
+
+      it "should format an Array of String ports" do
+        expect(subject.arguments).to eq(['-p', ports.join(',')])
+      end
+    end
+
+    context "when given an Array of Integers" do
+      let(:ports) { [80, 21, 25] }
+
+      before { subject.ports = ports }
+
+      it "should format an Array of Integer ports" do
+        expect(subject.arguments).to eq(['-p', ports.join(',')])
+      end
+    end
+
+    context "when given an Array containing a Range" do
+      let(:ports) { [80, 21..25] }
+
+      before { subject.ports = ports }
+
+      it "should format the Range" do
+        expect(subject.arguments).to eq([
+          '-p', "#{ports[0]},#{ports[1].begin}-#{ports[1].end}"
+        ])
+      end
+    end
+  end
+
+  shared_examples "optional port range" do |flag,method|
+    before { subject.send(:"#{method}=",ports) }
+
+    context "when given a Boolean" do
+      let(:ports) { true }
+
+      it "should emit the '#{flag}' option flag" do
+        expect(subject.arguments).to eq([flag])
+      end
+    end
+
+    context "when given an empty Array" do
+      let(:ports) { [] }
+
+      it "should emit the '#{flag}' option flag" do
+        expect(subject.arguments).to eq([flag])
+      end
+    end
+
+    context "when given an Array of Integers" do
+      let(:ports) { [80, 21, 25] }
+
+      it "should emit the '#{flag}' option flag with the Integer ports" do
+        expect(subject.arguments).to eq(["#{flag}#{ports.join(',')}"])
+      end
+    end
+
+    context "when given an Array containing a Range" do
+      let(:ports) { [80, 21..25] }
+
+      it "should emit the '#{flag}' option flag with the Integer ports" do
+        expect(subject.arguments).to eq([
+          "#{flag}#{ports[0]},#{ports[1].begin}-#{ports[1].end}"
+        ])
+      end
+    end
+  end
+
+  describe "#syn_discovery" do
+    include_examples "optional port range", '-PS', :syn_discovery
+  end
+
+  describe "#ack_discovery" do
+    include_examples "optional port range", '-PA', :ack_discovery
+  end
+
+  describe "#udp_discovery" do
+    include_examples "optional port range", '-PU', :udp_discovery
+  end
+
+  describe "#sctp_init_ping" do
+    include_examples "optional port range", '-PY', :sctp_init_ping
+  end
+
+  describe "#ip_ping" do
+    before { subject.ip_ping = protocols }
+
+    context "when given a Boolean" do
+      let(:protocols) { true }
 
-      expect(subject.arguments).to eq(%w[-p 80,21,25])
+      it "should emit the '-PO' option flag" do
+        expect(subject.arguments).to eq(['-PO'])
+      end
     end
 
-    it "should format an Array of String ports" do
-      subject.ports = %w[80 21 25]
+    context "when given an empty Array" do
+      let(:protocols) { [] }
 
-      expect(subject.arguments).to eq(%w[-p 80,21,25])
+      it "should emit the '-PO' option flag" do
+        expect(subject.arguments).to eq(['-PO'])
+      end
     end
 
-    it "should format an Array of Integer ports" do
-      subject.ports = [80, 21, 25]
+    context "when given an Array of Integers" do
+      let(:protocols) { [80, 21, 25] }
 
-      expect(subject.arguments).to eq(%w[-p 80,21,25])
+      it "should emit the '-PO' option flag with the Integer ports" do
+        expect(subject.arguments).to eq(["-PO#{protocols.join(',')}"])
+      end
     end
 
-    it "should format a Range of ports" do
-      subject.ports = [80, 21..25]
+    context "when given an Array containing a Range" do
+      let(:protocols) { [80, 21..25] }
 
-      expect(subject.arguments).to eq(%w[-p 80,21-25])
+      it "should emit the '-PO' option flag with the Integer ports" do
+        expect(subject.arguments).to eq([
+          "-PO#{protocols[0]},#{protocols[1].begin}-#{protocols[1].end}"
+        ])
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-nmap
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Postmodern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-14 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - nmap >= 5.00
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A Ruby interface to Nmap.