ruby-nmap 0.4.1 → 0.5.0

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.5.0 / 2011-04-11
+
+* Require nokogiri ~> 1.3.
+* Require rprogram ~> 0.3.
+* `ip_scan` in {Nmap::Task} should map to `-sO` (thanks corvus).
+
 ### 0.4.1 / 2010-11-23
 
 * Fixed a bug in {Nmap::XML#each} where it was calling `each_up_hosts`,

data/README.md

@@ -74,8 +74,8 @@ Print NSE script output from an XML scan file:
 ## Requirements
 
 * [nmap](http://www.insecure.org/) >= 5.00
-* [nokogiri](http://nokogiri.rubyforge.org/) >= 1.3.0
-* [rprogram](http://github.com/postmodern/rprogram) ~> 0.2.0
+* [nokogiri](http://nokogiri.rubyforge.org/) ~> 1.3
+* [rprogram](http://github.com/postmodern/rprogram) ~> 0.3
 
 ## Install
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 
 begin
-  gem 'ore-tasks', '~> 0.3.0'
+  gem 'ore-tasks', '~> 0.4'
   require 'ore/tasks'
 
   Ore::Tasks.new
@@ -12,7 +12,7 @@ rescue LoadError => e
 end
 
 begin
-  gem 'rspec', '~> 2.1.0'
+  gem 'rspec', '~> 2.4'
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new
@@ -22,6 +22,7 @@ rescue LoadError => e
   end
 end
 task :default => :spec
+task :test => :spec
 
 begin
   gem 'yard', '~> 0.6.0'

data/gemspec.yml

@@ -13,10 +13,10 @@ has_yard: true
 requirements: nmap >= 5.00
 
 dependencies:
-  nokogiri: >= 1.3.0
-  rprogram: ~> 0.2.0
+  nokogiri: ~> 1.3
+  rprogram: ~> 0.3
 
 development_dependencies:
-  ore-tasks: ~> 0.3.0
-  rspec: ~> 2.1.0
+  ore-tasks: ~> 0.4
+  rspec: ~> 2.4
   yard: ~> 0.6.0

data/lib/nmap/host.rb

@@ -2,6 +2,9 @@ require 'nmap/status'
 require 'nmap/address'
 require 'nmap/os'
 require 'nmap/port'
+require 'nmap/ip_id_sequence'
+require 'nmap/tcp_sequence'
+require 'nmap/tcp_ts_sequence'
 
 require 'nokogiri'
 
@@ -229,6 +232,57 @@ module Nmap
       end
     end
 
+    # Parses the Tcp Sequence number analysis of the host.
+    #
+    # @yield [tcpsequence]
+    #   If a block is given, it will be passed the resulting object
+    #
+    # @yieldparam [TcpSequence] tcpsequence
+    #   Tcp Sequence number analysis.
+    #
+    # @return [TcpSequence]
+    #   The parsed object.
+    #
+    def tcpsequence(&block)
+      if (seq = @node.at('tcpsequence'))
+        @tcpsequence = TcpSequence.new(seq,&block)
+      end
+    end
+
+    # Parses the IPID sequence number analysis of the host.
+    #
+    # @yield [ipidsequence]
+    #   If a block is given, it will be passed the resulting object
+    #
+    # @yieldparam [IpidSequence] ipidsequence
+    #   IPID Sequence number analysis.
+    #
+    # @return [IpidSequence]
+    #   The parsed object.
+    #
+    def ipidsequence(&block)
+      if (seq = @node.at('ipidsequence'))
+        @ipidsequence = IpidSequence.new(seq,&block)
+      end
+    end
+
+    # Parses the TCP Timestamp sequence number analysis of the host.
+    #
+    # @yield [tcptssequence]
+    #   If a block is given, it will be passed the resulting object
+    #
+    # @yieldparam [TcpTsSequence] tcptssequence
+    #   TCP Timestamp Sequence number analysis.
+    #
+    # @return [TcpTsSequence]
+    #   The parsed object.
+    #
+    def tcptssequence(&block)
+      if (seq = @node.at('tcptssequence'))
+        @tcptssequence = TcpTsSequence.new(seq,&block)
+      end
+    end
+
     #
     # Parses the scanned ports of the host.
     #

data/lib/nmap/ip_id_sequence.rb

@@ -0,0 +1,19 @@
+require 'nmap/sequence'
+
+module Nmap
+  class IpidSequence < Sequence
+
+    #
+    # Converts the IpidSequence class to a String.
+    #
+    # @return [String]
+    #   The String form of the object.
+    #
+    # @since 0.5.0
+    #
+    def to_s
+      "description=#{description.inspect} values=#{values.inspect}"
+    end
+
+  end
+end

data/lib/nmap/os.rb

@@ -61,7 +61,7 @@ module Nmap
     #   The OS class information.
     #
     def classes
-      enum_for(:each_class).to_a
+      each_class.to_a
     end
 
     #
@@ -99,7 +99,7 @@ module Nmap
     #   The OS match information.
     #
     def matches
-      enum_for(:each_match).to_a
+      each_match.to_a
     end
 
     #

data/lib/nmap/program.rb

@@ -13,6 +13,9 @@ module Nmap
     # @param [Hash{Symbol => Object}] options
     #   Additional options for nmap.
     #
+    # @param [Hash{Symbol => Object}] exec_options
+    #   Additional exec-options.
+    #
     # @yield [task]
     #   If a block is given, it will be passed a task object
     #   used to specify options for nmap.
@@ -37,8 +40,10 @@ module Nmap
     #     nmap.verbose = true
     #   end
     #
-    def self.scan(options={},&block)
-      self.find.scan(options,&block)
+    # @see #scan
+    #
+    def self.scan(options={},exec_options={},&block)
+      find.scan(options,exec_options,&block)
     end
 
     #
@@ -47,6 +52,9 @@ module Nmap
     # @param [Hash{Symbol => Object}] options
     #   Additional options for nmap.
     #
+    # @param [Hash{Symbol => Object}] exec_options
+    #   Additional exec-options.
+    #
     # @yield [task]
     #   If a block is given, it will be passed a task object
     #   used to specify options for nmap.
@@ -57,8 +65,11 @@ module Nmap
     # @return [Boolean]
     #   Specifies whether the command exited normally.
     #
-    def scan(options={},&block)
-      run_task(Task.new(options,&block))
+    # @see http://rubydoc.info/gems/rprogram/0.3.0/RProgram/Program#run-instance_method
+    #   For additional exec-options.
+    #
+    def scan(options={},exec_options={},&block)
+      run_task(Task.new(options,&block),exec_options)
     end
 
   end

data/lib/nmap/sequence.rb

@@ -0,0 +1,57 @@
+module Nmap
+  class Sequence
+
+    #
+    # Creates a new sequence object.
+    #
+    # @param [Nokogiri::XML::Node] node
+    #   The node that contains the sequence information.
+    #
+    # @yield [sequence]
+    #   If a block is given, it will passed the newly created sequence.
+    #
+    # @yieldparam [Sequence] sequence
+    #   The newly created sequence object.
+    #
+    # @since 0.5.0
+    #
+    def initialize(node)
+      @node = node
+
+      yield self if block_given?
+    end
+
+    #
+    # The description of the sequence.
+    #
+    # @return [String]
+    #   The sequence class from nmap.
+    # 
+    # @since 0.5.0
+    #
+    def description
+      @node['class']
+    end
+
+    #
+    # The values within the sequence.
+    #
+    # @return [Array<Numeric>]
+    #   A sample of sequence numbers taken by nmap.
+    #
+    # @since 0.5.0
+    #
+    def values
+      unless @values
+        @values = []
+
+        if (string = @node['values'])
+          string.scan(/[^\s,]+/) { |match| @values << match.to_i(16) }
+        end
+      end
+
+      return @values
+    end
+
+  end
+end

data/lib/nmap/task.rb

@@ -46,7 +46,7 @@ module Nmap
   # * `--scanflags` - `nmap.tcp_scan_flags`
   # * `-sZ` - `nmap.sctp_cookie_echo_scan`
   # * `-sI` - `nmap.idle_scan`
-  # * `-s0` - `nmap.ip_scan`
+  # * `-sO` - `nmap.ip_scan`
   # * `-b` - `nmap.ftp_bounce_scan`
   #
   # ### Port Specification and Scan Order:
@@ -208,7 +208,7 @@ module Nmap
     long_option :flag => '--scanflags', :name => :tcp_scan_flags
     short_option :flag => '-sZ', :name => :sctp_cookie_echo_scan
     short_option :flag => '-sI', :name => :idle_scan
-    short_option :flag => '-s0', :name => :ip_scan
+    short_option :flag => '-sO', :name => :ip_scan
     short_option :flag => '-b', :name => :ftp_bounce_scan
 
     # PORT SPECIFICATION AND SCAN ORDER:

data/lib/nmap/tcp_sequence.rb

@@ -0,0 +1,41 @@
+require 'nmap/sequence'
+
+module Nmap
+  class TcpSequence < Sequence
+
+    #
+    # @return [Numeric]
+    #   The difficulty index from nmap
+    #
+    # @since 0.5.0
+    #   
+    def index
+      @index ||= if (index_string = @node['index'])
+                   index_string.to_i
+                 end
+    end
+
+    #
+    # @return [String]
+    #   The difficulty description from nmap
+    #
+    # @since 0.5.0
+    #
+    def difficulty
+      @node['difficulty']
+    end
+
+    #
+    # Converts the TcpSequence class to a String.
+    #
+    # @return [String]
+    #   The String form of the object.
+    #
+    # @since 0.5.0
+    #
+    def to_s
+      "index=#{index} difficulty=#{difficulty.inspect} values=#{values.inspect}"
+    end
+
+  end
+end

data/lib/nmap/tcp_ts_sequence.rb

@@ -0,0 +1,19 @@
+require 'nmap/sequence'
+
+module Nmap
+  class TcpTsSequence < Sequence
+
+    #
+    # Converts the TcpTsSequence class to a String.
+    #
+    # @return [String]
+    #   The String form of the object.
+    #
+    # @since 0.5.0
+    #
+    def to_s
+      "description=#{description.inspect} values=#{values.inspect}"
+    end
+
+  end
+end

data/lib/nmap/version.rb

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

data/lib/nmap/xml.rb

@@ -150,7 +150,7 @@ module Nmap
     #   The hosts in the scan.
     #
     def hosts
-      enum_for(:each_host).to_a
+      each_host.to_a
     end
 
     #
@@ -183,7 +183,7 @@ module Nmap
     #   The hosts in the scan.
     #
     def up_hosts
-      enum_for(:each_up_host).to_a
+      each_up_host.to_a
     end
 
     #

data/ruby-nmap.gemspec

@@ -5,6 +5,11 @@ begin
     # custom logic here
   end
 rescue NameError
-  STDERR.puts "The 'ruby-nmap.gemspec' file requires Ore."
-  STDERR.puts "Run `gem install ore-core` to install Ore."
+  begin
+    require 'ore/specification'
+    retry
+  rescue LoadError
+    STDERR.puts "The 'ruby-nmap.gemspec' file requires Ore."
+    STDERR.puts "Run `gem install ore-core` to install Ore."
+  end
 end

data/spec/sequence_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'helpers/xml'
+
+require 'nmap/tcp_sequence'
+require 'nmap/tcp_ts_sequence'
+require 'nmap/ip_id_sequence'
+require 'nmap/xml'
+require 'cgi'
+
+describe TcpSequence do
+  include Helpers
+
+  before(:all) do
+    @xml = XML.new(Helpers::SCAN_FILE)
+    @tcpsequence = @xml.hosts.first.tcpsequence
+  end
+
+  it "should be accessible from host objects" do
+    @tcpsequence.should be_kind_of(TcpSequence)
+  end
+
+  it "should parse the index" do
+    @tcpsequence.index.should == 25
+  end
+
+  it "should parse the difficulty description" do
+    @tcpsequence.difficulty.should == "Good luck!"
+  end
+
+  it "should parse the values" do
+    @tcpsequence.values.should == [0xAF1B39BD,0xAF1C33BD,0xAF1F21BD,0xAF201BBD,0xAF2115BD,0xAF220FBD]
+  end
+end
+
+describe IpidSequence do
+  include Helpers
+
+  before(:all) do
+    @xml = XML.new(Helpers::SCAN_FILE)
+    @ipidsequence = @xml.hosts.first.ipidsequence
+  end
+
+  it "should be accessible from host objects" do
+    @ipidsequence.should be_kind_of(IpidSequence)
+  end
+
+  it "should parse the description" do
+    @ipidsequence.description.should == "Incremental"
+  end
+
+  it "should parse the values" do
+    @ipidsequence.values.should == [0x1FB0,0x1FB2,0x1FB4,0x1FB6,0x1FB8,0x1FBA]
+  end
+end
+
+describe TcpTsSequence do
+  include Helpers
+
+  before(:all) do
+    @xml = XML.new(Helpers::SCAN_FILE)
+    @tcptssequence = @xml.hosts.first.tcptssequence
+  end
+
+  it "should be accessible from host objects" do
+    @tcptssequence.should be_kind_of(TcpTsSequence)
+  end
+
+  it "should parse the description" do
+    @tcptssequence.description.should == "2HZ"
+  end
+
+  it "should parse the values" do
+    @tcptssequence.values.should == [0x1858,0x1858,0x1859,0x1859,0x1859,0x1859]
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-gem 'rspec', '~> 2.1.0'
+gem 'rspec', '~> 2.4'
 require 'rspec'
-require 'nmap/version'
 
+require 'nmap/version'
 include Nmap

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-nmap
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-23 00:00:00 -08:00
-default_executable: 
+date: 2011-04-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -23,13 +18,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
+        version: "1.3"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,11 +31,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 2
-        - 0
-        version: 0.2.0
+        version: "0.3"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -55,11 +42,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 0
-        version: 0.3.0
+        version: "0.4"
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -70,11 +53,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 1
-        - 0
-        version: 2.1.0
+        version: "2.4"
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -85,15 +64,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 0
         version: 0.6.0
   type: :development
   version_requirements: *id005
 description: A Ruby interface to Nmap, the exploration tool and security / port scanner.
-email: postmodern.mod3@gmail.com
+email: 
+- postmodern.mod3@gmail.com
 executables: []
 
 extensions: []
@@ -101,6 +77,7 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
+- .gemtest
 - .rspec
 - .yardopts
 - ChangeLog.md
@@ -111,6 +88,7 @@ files:
 - lib/nmap.rb
 - lib/nmap/address.rb
 - lib/nmap/host.rb
+- lib/nmap/ip_id_sequence.rb
 - lib/nmap/os.rb
 - lib/nmap/os_class.rb
 - lib/nmap/os_match.rb
@@ -119,8 +97,11 @@ files:
 - lib/nmap/scan.rb
 - lib/nmap/scan_task.rb
 - lib/nmap/scanner.rb
+- lib/nmap/sequence.rb
 - lib/nmap/status.rb
 - lib/nmap/task.rb
+- lib/nmap/tcp_sequence.rb
+- lib/nmap/tcp_ts_sequence.rb
 - lib/nmap/version.rb
 - lib/nmap/xml.rb
 - ruby-nmap.gemspec
@@ -131,10 +112,10 @@ files:
 - spec/nmap_spec.rb
 - spec/os_spec.rb
 - spec/port_spec.rb
+- spec/sequence_spec.rb
 - spec/spec_helper.rb
 - spec/task_spec.rb
 - spec/xml_spec.rb
-has_rdoc: yard
 homepage: http://github.com/sophsec/ruby-nmap
 licenses: 
 - MIT
@@ -148,21 +129,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: 
 - nmap >= 5.00
 rubyforge_project: ruby-nmap
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to Nmap.
@@ -170,6 +147,7 @@ test_files:
 - spec/host_spec.rb
 - spec/port_spec.rb
 - spec/nmap_spec.rb
+- spec/sequence_spec.rb
 - spec/os_spec.rb
 - spec/xml_spec.rb
 - spec/task_spec.rb