ruby-nmap 0.10.0 → 1.0.0

data/spec/xml_spec.rb

@@ -1,37 +1,20 @@
 require 'spec_helper'
 require 'nmap/xml'
 
-describe XML do
+describe Nmap::XML do
   let(:file) { 'spec/fixtures/scan.xml' }
   let(:path) { File.expand_path(file) }
+  let(:doc)  { Nokogiri::XML(File.open(path)) }
 
-  subject { described_class.new(path) }
+  subject { described_class.new(doc) }
 
   describe "#initialize" do
-    context "when given a Nokogiri::XML::Document" do
-      let(:document) { Nokogiri::XML(File.read(path)) }
-
-      it "should use the document" do
-        expect(described_class.new(document).version).to eq(subject.version)
-      end
-    end
-
-    context "when given an IO object" do
-      let(:io) { File.new(path) }
-
-      it "should parse the IO object" do
-        expect(described_class.new(io).version).to eq(subject.version)
-      end
-    end
-
-    context "when given a String" do
-      it "should parse the file at the path" do
-        expect(described_class.new(path).version).to eq(subject.version)
-      end
+    it "must set #doc" do
+      expect(described_class.new(doc).doc).to be(doc)
     end
   end
 
-  describe "parse" do
+  describe ".parse" do
     let(:xml) { File.read(path) }
 
     subject { described_class.parse(xml) }
@@ -45,7 +28,7 @@ describe XML do
     end
   end
 
-  describe "open" do
+  describe ".open" do
     subject { described_class.open(path) }
 
     it "should return an XML object" do
@@ -109,7 +92,7 @@ describe XML do
     subject { super().each_run_stat.first }
 
     it "should yield RunStat objects" do
-      expect(subject).to be_kind_of(RunStat)
+      expect(subject).to be_kind_of(Nmap::XML::RunStat)
     end
 
     it "should parse the end time" do
@@ -133,7 +116,7 @@ describe XML do
     subject { super().run_stats }
 
     it { is_expected.not_to be_empty }
-    it { is_expected.to all(be_kind_of(RunStat)) }
+    it { is_expected.to all(be_kind_of(Nmap::XML::RunStat)) }
   end
 
   describe "#each_task" do
@@ -153,7 +136,7 @@ describe XML do
     end
 
     it "should parse the extrainfo" do
-      expect(subject.extrainfo).not_to be_empty
+      expect(subject.extra_info).not_to be_empty
     end
   end
 
@@ -161,7 +144,7 @@ describe XML do
     subject { super().tasks }
 
     it { is_expected.not_to be_empty }
-    it { is_expected.to all(be_kind_of(ScanTask)) }
+    it { is_expected.to all(be_kind_of(Nmap::XML::ScanTask)) }
   end
 
   describe "#task" do
@@ -170,7 +153,7 @@ describe XML do
         name = "Parallel DNS resolution of 1 host."
         task = subject.task(name)
 
-        expect(task).to be_kind_of(ScanTask)
+        expect(task).to be_kind_of(Nmap::XML::ScanTask)
         expect(task.name).to be == name
       end
     end
@@ -198,7 +181,7 @@ describe XML do
     subject { super().each_host.first }
 
     it "should yield Host objects" do
-      expect(subject).to be_kind_of(Host)
+      expect(subject).to be_kind_of(Nmap::XML::Host)
     end
   end
 
@@ -206,20 +189,62 @@ describe XML do
     subject { super().hosts }
 
     it { is_expected.not_to be_empty }
-    it { expect(subject).to all(be_kind_of(Host)) }
+    it { expect(subject).to all(be_kind_of(Nmap::XML::Host)) }
   end
 
   describe "#host" do
     subject { super().host }
 
-    it { expect(subject).to be_kind_of(Host) }
+    it { expect(subject).to be_kind_of(Nmap::XML::Host) }
+  end
+
+  describe "#each_down_host" do
+    let(:file) { 'spec/fixtures/down_host_scan.xml' }
+
+    context "when given a block" do
+      it "must yield Host objects" do
+        expect { |b|
+          subject.each_down_host(&b)
+        }.to yield_successive_args(Nmap::XML::Host)
+      end
+
+      it "status must be down" do
+        yielded_hosts = []
+
+        subject.each_down_host do |host|
+          yielded_hosts << host
+        end
+
+        expect(yielded_hosts).to_not be_empty
+        expect(yielded_hosts.map { |host| host.status.state }).to all(eq(:down))
+      end
+    end
+
+    context "when not given a block" do
+      it "must return an Enumerator for the method" do
+        expect(subject.each_down_host).to be_kind_of(Enumerator)
+      end
+    end
+  end
+
+  describe "#down_hosts" do
+    let(:file) { 'spec/fixtures/down_host_scan.xml' }
+
+    subject { super().down_hosts }
+
+    it { expect(subject).to_not be_empty }
+    it { expect(subject).to all(be_kind_of(Nmap::XML::Host)) }
+
+    it "should contain only up hosts" do
+      expect(subject.map { |host| host.status.state }).to all(eq(:down))
+    end
   end
 
   describe "#down_host" do
     pending "need down hosts in scan.xml" do
       subject { super().down_host }
 
-      it { is_expected.to be_kind_of(Host) }
+      it { is_expected.to be_kind_of(Nmap::XML::Host) }
 
       it "should contain only up hosts" do
         expect(subject.status.state).to be(:down)
@@ -231,7 +256,7 @@ describe XML do
     subject { super().each_up_host.first }
 
     it "should yield Host objects" do
-      expect(subject).to be_kind_of(Host)
+      expect(subject).to be_kind_of(Nmap::XML::Host)
     end
 
     it "should be up" do
@@ -242,18 +267,18 @@ describe XML do
   describe "#up_hosts" do
     subject { super().up_hosts }
 
-    it { is_expected.not_to be_empty }
-    it { is_expected.to all(be_kind_of(Host)) }
+    it { expect(subject).not_to be_empty }
+    it { expect(subject).to all(be_kind_of(Nmap::XML::Host)) }
 
     it "should contain only up hosts" do
-      expect(subject.all? { |host| host.status.state == :up }).to be_truthy
+      expect(subject.map { |host| host.status.state }).to all(eq(:up))
     end
   end
 
   describe "#up_host" do
     subject { super().up_host }
 
-    it { is_expected.to be_kind_of(Host) }
+    it { is_expected.to be_kind_of(Nmap::XML::Host) }
 
     it "should contain only up hosts" do
       expect(subject.status.state).to be(:up)
@@ -267,14 +292,18 @@ describe XML do
   end
 
   describe "#to_s" do
-    it "should convert to a String" do
-      expect(subject.to_s).to eq(path)
+    context "when #path is set" do
+      subject { described_class.new(doc, path: path) }
+
+      it "must return #path" do
+        expect(subject.to_s).to eq(path)
+      end
     end
-  end
 
-  describe "#inspect" do
-    it "should include the class and path" do
-      expect(subject.inspect).to eq("#<#{described_class}: #{path}>")
+    context "when #path is not set" do
+      it "must return the raw XML" do
+        expect(subject.to_s).to eq(doc.to_s)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-nmap
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Postmodern
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2022-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rprogram
+  name: command_mapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -52,7 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: A Ruby interface to Nmap, the exploration tool and security / port scanner.
+description: A Ruby API to nmap, the exploration tool and security / port scanner.
+  Allows automating nmap and parsing nmap XML files.
 email: postmodern.mod3@gmail.com
 executables: []
 extensions: []
@@ -60,87 +61,92 @@ extra_rdoc_files:
 - ChangeLog.md
 - LICENSE.txt
 - README.md
+- UPGRADING.md
 files:
 - ".document"
+- ".editorconfig"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - ChangeLog.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADING.md
 - gemspec.yml
 - lib/nmap.rb
-- lib/nmap/address.rb
-- lib/nmap/cpe.rb
-- lib/nmap/cpe/url.rb
-- lib/nmap/hop.rb
-- lib/nmap/host.rb
-- lib/nmap/host_script.rb
-- lib/nmap/hostname.rb
-- lib/nmap/ip_id_sequence.rb
-- lib/nmap/os.rb
-- lib/nmap/os_class.rb
-- lib/nmap/os_match.rb
-- lib/nmap/port.rb
-- lib/nmap/postscript.rb
-- lib/nmap/prescript.rb
-- lib/nmap/program.rb
-- lib/nmap/run_stat.rb
-- lib/nmap/scan.rb
-- lib/nmap/scan_task.rb
-- lib/nmap/scanner.rb
-- lib/nmap/scripts.rb
-- lib/nmap/sequence.rb
-- lib/nmap/service.rb
-- lib/nmap/status.rb
-- lib/nmap/task.rb
-- lib/nmap/tcp_sequence.rb
-- lib/nmap/tcp_ts_sequence.rb
-- lib/nmap/traceroute.rb
-- lib/nmap/uptime.rb
+- lib/nmap/command.rb
 - lib/nmap/version.rb
 - lib/nmap/xml.rb
+- lib/nmap/xml/address.rb
+- lib/nmap/xml/cpe.rb
+- lib/nmap/xml/cpe/url.rb
+- lib/nmap/xml/hop.rb
+- lib/nmap/xml/host.rb
+- lib/nmap/xml/host_script.rb
+- lib/nmap/xml/hostname.rb
+- lib/nmap/xml/ip_id_sequence.rb
+- lib/nmap/xml/os.rb
+- lib/nmap/xml/os_class.rb
+- lib/nmap/xml/os_match.rb
+- lib/nmap/xml/port.rb
+- lib/nmap/xml/postscript.rb
+- lib/nmap/xml/prescript.rb
+- lib/nmap/xml/run_stat.rb
+- lib/nmap/xml/scan.rb
+- lib/nmap/xml/scan_task.rb
+- lib/nmap/xml/scanner.rb
+- lib/nmap/xml/script.rb
+- lib/nmap/xml/scripts.rb
+- lib/nmap/xml/sequence.rb
+- lib/nmap/xml/service.rb
+- lib/nmap/xml/status.rb
+- lib/nmap/xml/tcp_sequence.rb
+- lib/nmap/xml/tcp_ts_sequence.rb
+- lib/nmap/xml/traceroute.rb
+- lib/nmap/xml/uptime.rb
 - ruby-nmap.gemspec
-- spec/address_spec.rb
-- spec/cpe/url_spec.rb
-- spec/cpe_examples.rb
+- spec/command_spec.rb
+- spec/fixtures/down_host_scan.xml
 - spec/fixtures/local_scan.xml
 - spec/fixtures/scan.xml
-- spec/hop_spec.rb
-- spec/host_script_spec.rb
-- spec/host_spec.rb
-- spec/hostname_spec.rb
-- spec/ip_id_sequence_spec.rb
 - spec/nmap_spec.rb
-- spec/os_class_spec.rb
-- spec/os_match_spec.rb
-- spec/os_spec.rb
-- spec/port_spec.rb
-- spec/postscript_spec.rb
-- spec/prescript_spec.rb
-- spec/run_stat_spec.rb
-- spec/scan_spec.rb
-- spec/scan_task_spec.rb
-- spec/scanner_spec.rb
-- spec/scripts_examples.rb
-- spec/sequence_examples.rb
-- spec/service_spec.rb
 - spec/spec_helper.rb
-- spec/status_spec.rb
-- spec/task_spec.rb
-- spec/tcp_sequence_spec.rb
-- spec/tcp_ts_sequence_spec.rb
-- spec/traceroute_spec.rb
-- spec/uptime_spec.rb
+- spec/xml/address_spec.rb
+- spec/xml/cpe/url_spec.rb
+- spec/xml/cpe_examples.rb
+- spec/xml/hop_spec.rb
+- spec/xml/host_script_spec.rb
+- spec/xml/host_spec.rb
+- spec/xml/hostname_spec.rb
+- spec/xml/ip_id_sequence_spec.rb
+- spec/xml/os_class_spec.rb
+- spec/xml/os_match_spec.rb
+- spec/xml/os_spec.rb
+- spec/xml/port_spec.rb
+- spec/xml/postscript_spec.rb
+- spec/xml/prescript_spec.rb
+- spec/xml/run_stat_spec.rb
+- spec/xml/scan_spec.rb
+- spec/xml/scan_task_spec.rb
+- spec/xml/scanner_spec.rb
+- spec/xml/script_spec.rb
+- spec/xml/scripts_examples.rb
+- spec/xml/sequence_examples.rb
+- spec/xml/service_spec.rb
+- spec/xml/status_spec.rb
+- spec/xml/tcp_sequence_spec.rb
+- spec/xml/tcp_ts_sequence_spec.rb
+- spec/xml/traceroute_spec.rb
+- spec/xml/uptime_spec.rb
 - spec/xml_spec.rb
-homepage: https://github.com/sophsec/ruby-nmap#readme
+homepage: https://github.com/postmodern/ruby-nmap#readme
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - nmap >= 5.00
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: A Ruby interface to Nmap.
+summary: A Ruby API to nmap.
 test_files: []

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-before_install:
-  - sudo apt-get install libxml2-dev libxslt1-dev
-  - gem update --system
-  - gem install bundler -v "~> 2.0"
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby
-  - rbx
-matrix:
-  allow_failures:
-    - rvm: jruby
-    - rvm: rbx
-script: rake test

data/lib/nmap/address.rb

@@ -1,34 +0,0 @@
-module Nmap
-  #
-  # Represents an IP or MAC address and Vendor name.
-  #
-  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.
-    #
-    # @return [String]
-    #   The address.
-    #
-    def to_s
-      self.addr.to_s
-    end
-
-  end
-end

data/lib/nmap/cpe/url.rb

@@ -1,78 +0,0 @@
-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/cpe.rb

@@ -1,45 +0,0 @@
-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/hop.rb

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