scandb 0.1.0 → 0.1.1

data/History.txt

@@ -1,4 +1,13 @@
-=== 1.0.0 / 2008-07-31
+=== 0.1.1 / 2008-08-17
+
+* Added a work-around to DataMappers current problem with lazy-loading
+  has-many relations.
+* Added various convenience methods.
+* Added the OSClass, OSClassGuess, OSMatch and OSMatchGuess models.
+* Require dm-serializer by default.
+* Added verbose and export options for the scandb utility.
+
+=== 0.1.0 / 2008-07-31
 
 * Fixed a bug where LibXML wasn't being included for ScanDB::Nmap.
 

data/Manifest.txt

@@ -11,8 +11,10 @@ lib/scandb/model.rb
 lib/scandb/port.rb
 lib/scandb/service.rb
 lib/scandb/scanned_port.rb
-lib/scandb/os.rb
-lib/scandb/os_guess.rb
+lib/scandb/os_class.rb
+lib/scandb/os_class_guess.rb
+lib/scandb/os_match.rb
+lib/scandb/os_match_guess.rb
 lib/scandb/host_name.rb
 lib/scandb/host.rb
 lib/scandb/nmap.rb

data/Rakefile

@@ -11,6 +11,7 @@ Hoe.new('scandb', ScanDB::VERSION) do |p|
     ['do_sqlite3', '>=0.9.3'],
     ['dm-core', '>=0.9.3'],
     ['dm-types', '>=0.9.3'],
+    ['dm-serializer','>=0.9.3'],
     'libxml-ruby'
   ]
 end

data/lib/scandb/database.rb

@@ -25,8 +25,10 @@ require 'scandb/exceptions/invalid_database_config'
 require 'scandb/config'
 require 'scandb/port'
 require 'scandb/service'
-require 'scandb/os'
-require 'scandb/os_guess'
+require 'scandb/os_class'
+require 'scandb/os_class_guess'
+require 'scandb/os_match'
+require 'scandb/os_match_guess'
 require 'scandb/host_name'
 require 'scandb/host'
 
@@ -52,17 +54,28 @@ module ScanDB
     # exist.
     #
     def Database.config
-      if File.file?(CONFIG_FILE)
-        conf = YAML.load(CONFIG_FILE)
+      unless class_variable_defined?('@@scandb_database_config')
+        @@scandb_database_config = DEFAULT_CONFIG
 
-        unless (conf.kind_of?(Hash) || conf.kind_of?(String))
-          raise(InvalidDatabaseConfig,"#{CONFIG_FILE} must contain either a Hash or a String",caller)
-        end
+        if File.file?(CONFIG_FILE)
+          conf = YAML.load(CONFIG_FILE)
+
+          unless (conf.kind_of?(Hash) || conf.kind_of?(String))
+            raise(InvalidDatabaseConfig,"#{CONFIG_FILE} must contain either a Hash or a String",caller)
+          end
 
-        return conf
+          @@scandb_database_config = conf
+        end
       end
 
-      return DEFAULT_CONFIG
+      return @@scandb_database_config ||= DEFAULT_CONFIG
+    end
+
+    #
+    # Sets the Database configuration to the specified _configuration_.
+    #
+    def Database.config=(configuration)
+      @@scandb_database_config = configuration
     end
 
     #
@@ -88,12 +101,23 @@ module ScanDB
     # _configuration is not given, +DEFAULT_CONFIG+ will be used to setup
     # the Database.
     #
-    def Database.setup(configuration=DEFAULT_CONFIG,&block)
+    def Database.setup(configuration=Database.config,&block)
       Database.setup_log
       DataMapper.setup(:default, configuration)
 
       block.call if block
 
+      # sourced from http://gist.github.com/3010
+      # in order to fix a has-many lazy-loading bug
+      # in dm-core <= 0.9.4
+      descendants = DataMapper::Resource.descendants.dup
+      descendants.each do |model|
+        descendants.merge(model.descendants) if model.respond_to?(:descendants)
+      end
+      descendants.each do |model|
+        model.relationships.each_value { |r| r.child_key if r.child_model == model }
+      end
+
       DataMapper.auto_upgrade!
       return nil
     end

data/lib/scandb/host.rb

@@ -23,7 +23,8 @@
 
 require 'scandb/model'
 require 'scandb/host_name'
-require 'scandb/os_guess'
+require 'scandb/os_class_guess'
+require 'scandb/os_match_guess'
 require 'scandb/scanned_port'
 
 module ScanDB
@@ -31,12 +32,19 @@ module ScanDB
 
     include Model
 
+    # The IP address of the Host
     property :ip, String
 
+    # The host-names of the host
     has n, :names, :class_name => 'HostName'
 
-    has n, :os_guesses, :order => [:accuracy.desc], :class_name => 'OSGuess'
+    # The OS Class guesses of the host
+    has n, :os_class_guesses, :class_name => 'OSClassGuess'
 
+    # The OS Match guesses of the host
+    has n, :os_match_guesses, :class_name => 'OSMatchGuess'
+
+    # The scanned ports of the host
     has n, :scanned_ports
 
     #
@@ -46,6 +54,60 @@ module ScanDB
       names.first
     end
 
+    #
+    # Returns the best OS Class guess.
+    #
+    def best_class_guess
+      os_class_guesses.first
+    end
+
+    #
+    # Returns the best OS Match guess.
+    #
+    def best_match_guess
+      os_match_guesses.first
+    end
+
+    #
+    # Returns all the open ports on the host.
+    #
+    def open_ports
+      scanned_ports.all(:status => :open)
+    end
+
+    #
+    # Returns all the filtered ports on the host.
+    #
+    def filtered_ports
+      scanned_ports.all(:status => :filtered)
+    end
+
+    #
+    # Returns all the closed ports on the host.
+    #
+    def closed_ports
+      scanned_ports.all(:status => :closed)
+    end
+
+    alias ports open_ports
+
+    #
+    # Returns the ports numbers of all open ports on the host.
+    #
+    def port_numbers
+      open_ports.map { |port| port.number }
+    end
+
+    #
+    # Returns the services of all open ports on the host.
+    #
+    def services
+      ports.service
+    end
+
+    #
+    # Returns the IP address of the host in String form.
+    #
     def to_s
       ip
     end

data/lib/scandb/model.rb

@@ -22,6 +22,7 @@
 #
 
 require 'dm-core'
+require 'dm-serializer'
 
 module ScanDB
   module Model

data/lib/scandb/nmap.rb

@@ -32,12 +32,13 @@ module ScanDB
 
     #
     # Imports scan information from a Nmap XML scan file, specified by
-    # the _path_. Returns an Array of Host objects.
+    # the _path_. Returns an Array of Host objects. If a _block_ is given
+    # it will be passed the newly created Host object.
     #
-    #   Nmap.from_xml('path/to/scan.xml')
+    #   Nmap.import_xml('path/to/scan.xml')
     #   # => [...]
     #
-    def Nmap.from_xml(path)
+    def Nmap.import_xml(path,&block)
       doc = XML::Document.file(path)
       hosts = []
 
@@ -45,24 +46,36 @@ module ScanDB
         ip = host.find_first("address[@addr and @addrtype='ipv4']")['addr']
         new_host = Host.first_or_create(:ip => ip)
 
-        host.find('hostname').each do |hostname|
+        host.find('hostnames/hostname').each do |hostname|
           new_host.names << HostName.first_or_create(
-            :name => hostname['name'],
-            :host_id => new_host.id
+            :name => hostname['name']
           )
         end
 
         host.find('os/osclass').each do |osclass|
-          new_os = OS.first_or_create(
+          new_os_class = OSClass.first_or_create(
             :type => osclass['type'],
             :vendor => osclass['vendor'],
             :family => osclass['osfamily'],
             :version => osclass['osgen']
           )
 
-          new_host.os_guesses << OSGuess.first_or_create(
-            :os_id => new_os.id,
-            :accuracy => osclass['accuracy'].to_i
+          new_host.os_class_guesses.first_or_create(
+            :accuracy => osclass['accuracy'].to_i,
+            :os_class_id => new_os_class.id,
+            :host_id => new_host.id
+          )
+        end
+
+        host.find('os/osmatch').each do |osmatch|
+          new_os_match = OSMatch.first_or_create(
+            :name => osmatch['name']
+          )
+
+          new_host.os_match_guesses.first_or_create(
+            :accuracy => osmatch['accuracy'].to_i,
+            :os_match_id => new_os_match.id,
+            :host_id => new_host.id
           )
         end
 
@@ -76,7 +89,7 @@ module ScanDB
             :name => port.find_first('service[@name]')['name']
           )
 
-          new_host.scanned_ports << ScannedPort.first_or_create(
+          new_host.scanned_ports.first_or_create(
             :status => port.find_first('state[@state]')['state'].to_sym,
             :service_id => new_service.id,
             :port_id => new_port.id,
@@ -86,6 +99,7 @@ module ScanDB
 
         new_host.save
 
+        block.call(new_host) if block
         hosts << new_host
       end
 

data/lib/scandb/os_class.rb

@@ -0,0 +1,61 @@
+#
+#--
+# ScanDB - A library for importing and analyzing information generated by
+# various network scanning utilities.
+#
+# Copyright (c) 2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#++
+#
+
+require 'scandb/model'
+
+module ScanDB
+  class OSClass
+
+    include Model
+
+    # The type of OS
+    property :type, String
+
+    # The vendor of the OS
+    property :vendor, String
+
+    # The family the OS belongs to
+    property :family, String
+
+    # The version of the OS
+    property :version, String
+
+    # The guesses for the OS Class.
+    has n, :guesses, :class_name => 'OSClassGuess'
+
+    #
+    # Returns the String form of the OS Class.
+    #
+    def to_s
+      vars = []
+
+      vars << "type=#{type}" if type
+      vars << "vendor=#{vendor}" if vendor
+      vars << "family=#{family}" if family
+      vars << "version=#{version}" if version
+
+      return vars.join(' ')
+    end
+
+  end
+end

data/lib/scandb/{os_guess.rb → os_class_guess.rb}

@@ -21,20 +21,29 @@
 #++
 #
 
+require 'scandb/os_class'
 require 'scandb/model'
-require 'scandb/os'
-require 'scandb/host'
 
 module ScanDB
-  class OSGuess
+  class OSClassGuess
 
     include Model
 
+    # The accuracy of the guess
     property :accuracy, Integer
 
-    belongs_to :os, :class_name => 'OS'
+    # The OS Class
+    belongs_to :os_class, :class_name => 'OSClass'
 
+    # The Host that the guess was made against
     belongs_to :host
 
+    #
+    # Returns the String form of the OS Class guess.
+    #
+    def to_s
+      "#{accuracy}%: #{os_class}"
+    end
+
   end
 end

data/lib/scandb/{os.rb → os_match.rb}

@@ -24,19 +24,19 @@
 require 'scandb/model'
 
 module ScanDB
-  class OS
+  class OSMatch
 
     include Model
 
-    property :type, String
+    # The name of the OS match
+    property :name, String
 
-    property :vendor, String
+    # The guesses for this OS match
+    has n, :guesses, :class_name => 'OSMatchGuess'
 
-    property :family, String
-
-    property :version, String
-
-    has n, :guesses, :class_name => 'OSGuess'
+    def to_s
+      name
+    end
 
   end
 end

data/lib/scandb/os_match_guess.rb

@@ -0,0 +1,49 @@
+#
+#--
+# ScanDB - A library for importing and analyzing information generated by
+# various network scanning utilities.
+#
+# Copyright (c) 2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#++
+#
+
+require 'scandb/os_match'
+require 'scandb/model'
+
+module ScanDB
+  class OSMatchGuess
+
+    include Model
+
+    # The accuracy of the guess
+    property :accuracy, Integer
+
+    # The OS Match for the guess
+    belongs_to :os_match, :class_name => 'OSMatch'
+
+    # The Host that the guess was made against
+    belongs_to :host
+
+    #
+    # Returns the String form of the OS Match guess.
+    #
+    def to_s
+      "#{accuracy}%: #{os_match}"
+    end
+
+  end
+end

data/lib/scandb/port.rb

@@ -32,14 +32,20 @@ module ScanDB
 
     include Model
 
+    # The protocol that the port is runnin on
+    # (<tt>:tcp</tt>, <tt>:udp</tt>)
     property :protocol, Enum[:tcp, :udp]
 
+    # The port number
     property :number, Integer
 
+    # The scanned ports related to this port
     has n, :scanned, :class_name => 'ScannedPort'
 
+    # The hosts which were scanned for this port
     has n, :hosts, :through => :scanned
 
+    # The services that were found running on this port
     has n, :services, :through => :scanned
 
     #

data/lib/scandb/runner.rb

@@ -36,7 +36,7 @@ module ScanDB
       options = OpenStruct.new
 
       opts = OptionParser.new do |opts|
-        opts.banner = 'usage: scandb [-d URI] [--import-nmap FILE | -L | -p PORT | -s NAME]'
+        opts.banner = 'usage: scandb [-v] [-d URI] [--import-nmap FILE | -L | -p PORT | -s NAME]'
 
         opts.on('-d','--database URI','The URI for the Database.','Defaults to ~/.scandb/scandb.db') do |uri|
           options.database = uri
@@ -55,10 +55,41 @@ module ScanDB
           options.with_port = port.to_i
         end
 
+        opts.on('--with-open-ports','List hosts with open ports') do
+          options.with_port_status = :open
+        end
+
+        opts.on('--with-filtered-ports','List hosts with filtered ports') do
+          options.with_port_status = :filtered
+        end
+
+        opts.on('--with-closed-ports','List hosts with closed ports') do
+          options.with_port_status = :closed
+        end
+
         opts.on('-s','--with-service NAME','List hosts with the specified service') do |name|
           options.with_service = name
         end
 
+        opts.on('--export-yaml FILE','Exports hosts as a YAML file') do |path|
+          options.export = :yaml
+          options.export_path = path
+        end
+
+        opts.on('--export-xml FILE','Exports hosts as a XML file') do |path|
+          options.export = :xml
+          options.export_path = path
+        end
+
+        opts.on('-v','--verbose','Increase verbosity of output') do
+          options.verbose = true
+        end
+
+        opts.on('-V','--version','Print ScanDB version and exit') do
+          puts ScanDB::Version
+          exit
+        end
+
         opts.on('-h','--help','This cruft') do
           puts opts
           exit
@@ -70,8 +101,16 @@ module ScanDB
       if options.import
         case options.import
         when :nmap then
-          hosts = Nmap.from_xml(options.import_file)
-          puts "Success imported #{hosts.length} hosts."
+          hosts = Nmap.import_xml(options.import_file)
+
+          case hosts.length
+          when 0
+            puts "No hosts where imported."
+          when 1
+            puts "Imported #{hosts.length} host."
+          else
+            puts "Imported #{hosts.length} hosts."
+          end
         end
       else
         if options.with_port
@@ -82,7 +121,64 @@ module ScanDB
           hosts = Host.all
         end
 
-        hosts.each { |host| puts host}
+        if options.export
+          File.open(options.export_path,'w') do |output|
+            case options.export
+            when :yaml
+              output.write(hosts.to_yaml)
+            when :xml
+              output.write(hosts.to_xml)
+            end
+          end
+        else
+          hosts.each do |host|
+            if options.verbose
+              print "[ #{host} ]\n\n"
+
+              unless host.names.empty?
+                puts '  Host names:'
+
+                host.names.each do |name|
+                  puts "    #{name}"
+                end
+
+                print "\n"
+              end
+
+              unless host.os_class_guesses.empty?
+                puts '  OS Classes:'
+
+                host.os_class_guesses.each do |guess|
+                  puts "    #{guess}"
+                end
+
+                print "\n"
+              end
+
+              unless host.os_match_guesses.empty?
+                puts '  OS Matches:'
+
+                host.os_match_guesses.each do |guess|
+                  puts "    #{guess}"
+                end
+
+                print "\n"
+              end
+
+              unless host.scanned_ports.empty?
+                puts "  Scanned Ports:"
+
+                host.scanned_ports.each do |scanned_port|
+                  puts "  #{scanned_port}"
+                end
+
+                print "\n"
+              end
+            else
+              puts host
+            end
+          end
+        end
       end
 
       return true

data/lib/scandb/scanned_port.rb

@@ -33,12 +33,17 @@ module ScanDB
 
     include Model
 
+    # The scan status of the Port (<tt>:open</tt>, <tt>:filtered</tt>,
+    # <tt>:closed</tt>)
     property :status, Enum[:open, :filtered, :closed]
 
+    # The Service that is running on the scanned port
     belongs_to :service
 
+    # The Port
     belongs_to :port
 
+    # The Host that the scan was performed against
     belongs_to :host
 
     #

data/lib/scandb/service.rb

@@ -30,10 +30,13 @@ module ScanDB
 
     include Model
 
+    # Name of the service
     property :name, String
 
+    # Scanned ports that were found to be running the service
     has n, :scanned, :class_name => 'ScannedPort'
 
+    # Hosts that were found to be running the service
     has n, :hosts, :through => :scanned
 
     #

data/lib/scandb/version.rb

@@ -23,5 +23,5 @@
 
 module ScanDB
   # ScanDB version
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scandb
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Postmodern Modulus III
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-31 00:00:00 -07:00
+date: 2008-08-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.3
     version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-serializer
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.3
+    version: 
 - !ruby/object:Gem::Dependency 
   name: libxml-ruby
   type: :runtime
@@ -87,8 +97,10 @@ files:
 - lib/scandb/port.rb
 - lib/scandb/service.rb
 - lib/scandb/scanned_port.rb
-- lib/scandb/os.rb
-- lib/scandb/os_guess.rb
+- lib/scandb/os_class.rb
+- lib/scandb/os_class_guess.rb
+- lib/scandb/os_match.rb
+- lib/scandb/os_match_guess.rb
 - lib/scandb/host_name.rb
 - lib/scandb/host.rb
 - lib/scandb/nmap.rb