NexposeRunner 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13adebf5deaf318e68db7a8965cd1aaddbe75003
-  data.tar.gz: 44ccda32d83f9aa9064fb26f63072935033b0812
+  metadata.gz: df40a00a8781da6369dc8747aa6c43326d23e86a
+  data.tar.gz: fad5354e24b58e807648123f4a9e71751732256c
 SHA512:
-  metadata.gz: a98f08b066853cc72dac0b4378b0ab6a8dba85f70896528a6c338069822424b23dd4165a5beabbbc0e3fe22f735447abbbe8ff82414e6ee8d757db0eecc27457
-  data.tar.gz: 888df0a298044649828885df63b90c7596b2c853bb5f7a45ab520af376d9e03ca8d3c277c00c11d85ec142a7f99b1d6b412920c1490504f383aae8d33d3ae206
+  metadata.gz: e9e28ff3ef5d613251c92c934ec01a5bc25cbb77c962145329135315a6bcce25861b7de39db822c2e48793385f3f630e68637b188cc2b74d255267616f8b8957
+  data.tar.gz: fd2a32764de13f24f2f616f46b41dd0f2a977c29c70bb7984864df7ca4e85455c3296bab8c8699699852f343ac614fc5580ca17d90cd0cbdff12cb3ef7454579

data/.gitignore

@@ -23,3 +23,5 @@ mkmf.log
 .idea/
 config/scan.yml
 config/scan.yml.bak
+*.*~
+*~

data/NexposeRunner.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'nexpose', '0.8.3'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake', '< 11.0'
   spec.add_development_dependency 'rspec', '3.0.0'
 end

data/bin/scan

@@ -3,13 +3,18 @@
 require 'nexpose-runner/scan'
 
 $stdout.sync = true
-NexposeRunner::Scan.start({
-  'connection_url' => ARGV[0], 
-  'username' => ARGV[1], 
-  'password' => ARGV[2], 
-  'port' => ARGV[3], 
-  'site_name' => ARGV[4], 
-  'ip_addresses' => ARGV[5], 
-  'scan_template' => ARGV[6],
-  'engine' => ARGV[7]
-})
+
+if ARGV.grep(/^--/).empty?
+  NexposeRunner::Scan.start({
+    'connection_url' => ARGV[0], 
+    'username' => ARGV[1], 
+    'password' => ARGV[2], 
+    'port' => ARGV[3], 
+    'site_name' => ARGV[4], 
+    'ip_addresses' => ARGV[5], 
+    'scan_template' => ARGV[6],
+    'engine' => ARGV[7]
+  })
+else
+  NexposeRunner::Scan.start(ARGV)
+end

data/lib/NexposeRunner/version.rb

@@ -1,4 +1,4 @@
 module NexposeRunner
-    VERSION = '0.0.9'
+    VERSION = '0.0.10'
 end
 

data/lib/nexpose-runner/command_line_arg_parser.rb

@@ -0,0 +1,58 @@
+require 'optparse'
+
+class CommandLineArgumentParser
+  def self.parse(args)
+    options = {}
+    options['connection_url'] = ''
+    options['username'] = ''
+    options['password'] = ''
+    options['port'] = 0
+    options['site_name'] = ''
+    options['ip_addresses'] = ''
+    options['scan_template'] = ''
+    options['engine'] = ''
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = 'Usage: scan [options]'
+
+      opts.separator ''
+      opts.separator 'Specific options:'
+
+      opts.on('--connection-url URL', 'Nexpose Url') do |url|
+        options['connection_url'] = url
+      end
+      
+      opts.on('--username USERNAME', 'Nexpose Login Username') do |username|
+        options['username'] = username
+      end
+      
+      opts.on('--password PASSWORD', 'Nexpose Login Password') do |password|
+        options['password'] = password
+      end
+
+      opts.on('--port PORT', 'Nexpose port') do |port|
+        options['port'] = port
+      end
+      
+      opts.on('--site-name NAME', 'Nexpose site name') do |sitename|
+        options['site_name'] = sitename
+      end
+      
+      opts.on('--ip-addresses IPS', 'Comma separated list of IP Addresses to scan') do |ips|
+        options['ip_addresses'] = ips
+      end
+      
+      opts.on('--scan-template TEMPLATE', 'Nexpose scan template to use') do |template|
+        options['scan_template'] = template
+      end
+      
+      opts.on('--engine ENGINE', 'Nexpose scan engine to use') do |engine|
+        options['engine'] = engine
+      end
+      
+    end
+
+    opt_parser.parse!(args)
+    options
+  end
+end

data/lib/nexpose-runner/constants.rb

@@ -8,6 +8,7 @@ module CONSTANTS
   VULNERABILITY_FOUND_MESSAGE = '---------All YOUR BASE ARE BELONG TO US---------------\nVulnerabilities were found, breaking build'
   DEFAULT_PORT = '3780'
   VULNERABILITY_REPORT_NAME = 'nexpose-vulnerability-report.csv'
+  VULNERABILITY_DETAIL_REPORT_NAME = 'nexpose-vulnerability-detail-report.csv' 
   SOFTWARE_REPORT_NAME = 'nexpose-software-report.csv'
   POLICY_REPORT_NAME = 'nexpose-policy-report.csv'
 
@@ -32,6 +33,19 @@ module CONSTANTS
                                 JOIN dim_vulnerability_solution USING (vulnerability_id)
                                 JOIN dim_solution_highest_supercedence USING (solution_id)
                                 JOIN dim_solution ds ON superceding_solution_id = ds.solution_id'
+                                
+  VULNERABILITY_DETAIL_REPORT_QUERY = 'SELECT DISTINCT
+                                          fasvi.vulnerability_id,
+                                          da.ip_address,
+                                          CASE WHEN fasvi.port = -1 THEN NULL ELSE fasvi.port END,
+                                          dv.title,
+                                          dv.description,
+                                          ds.fix
+                                        FROM fact_asset_scan_vulnerability_instance fasvi
+                                        JOIN dim_asset da USING (asset_id)
+                                        JOIN dim_vulnerability dv USING (vulnerability_id)
+                                        JOIN dim_vulnerability_solution dvs USING (vulnerability_id)
+                                        JOIN dim_solution ds USING (solution_id)'
 
   SOFTWARE_REPORT_QUERY = 'SELECT
                              dsi.name,

data/lib/nexpose-runner/scan.rb

@@ -1,9 +1,9 @@
 require 'nexpose'
 require 'csv'
+require 'json'
 require 'nexpose-runner/constants'
 require 'nexpose-runner/scan_run_description'
 
-
 module NexposeRunner
   module Scan
     def Scan.start(options)
@@ -26,6 +26,10 @@ module NexposeRunner
       puts "Scan complete for #{run_details.site_name}, Generating Vulnerability Report"
       vulnerbilities = generate_report(CONSTANTS::VULNERABILITY_REPORT_QUERY, site.id, nsc)
       generate_csv(vulnerbilities, CONSTANTS::VULNERABILITY_REPORT_NAME)
+      
+      puts "Scan complete for #{run_details.site_name}, Generating Vulnerability Detail Report"
+      vuln_details = generate_report(CONSTANTS:: VULNERABILITY_DETAIL_REPORT_QUERY, site.id, nsc)
+      generate_csv(vulnerbilities, CONSTANTS::VULNERABILITY_DETAIL_REPORT_NAME)
 
       puts "Scan complete for #{run_details.site_name}, Generating Software Report"
       software = generate_report(CONSTANTS::SOFTWARE_REPORT_QUERY, site.id, nsc)
@@ -74,6 +78,7 @@ module NexposeRunner
       end
       site.save nsc
       puts "Created site #{run_details.site_name} successfully with the following host(s) #{run_details.ip_addresses.join(', ')}"
+      
       site
     end
 

data/lib/nexpose-runner/scan_run_description.rb

@@ -1,13 +1,16 @@
 require 'yaml'
+require 'nexpose-runner/command_line_arg_parser'
 
 class ScanRunDescription
   attr_accessor :connection_url, :username, :password, :port, :site_name, :ip_addresses, :scan_template, :engine
   @@port_value = ''
-  @@ip_addresses = ''
+  @@ip_addresses = []
 
   def initialize(options)
     if File.file?('config/scan.yml')
       options = YAML.load_file('config/scan.yml')
+    elsif options.instance_of? Array
+      options = CommandLineArgumentParser.parse(options)
     end
 
     self.connection_url = options['connection_url']
@@ -38,7 +41,7 @@ class ScanRunDescription
   end
 
   def ip_addresses=(value)
-    @@ip_addresses = value.split(',')
+    @@ip_addresses = value.split(',') unless value.nil?
   end
 
   def ip_addresses

data/spec/scan_spec.rb

@@ -21,6 +21,7 @@ describe 'nexpose-runner' do
       @expected_site_name = 'my_cool_software_build-28'
       @expected_ips = '10.5.0.15,10.5.0.20,10.5.0.35'
       @expected_scan_template = 'full-audit-widget-corp'
+      
       @mock_scan_id = '12'
       @mock_site_id = '1'
 
@@ -28,6 +29,8 @@ describe 'nexpose-runner' do
       @mock_vuln_report = 'ip_address,title,date_published,severity,summary,fix
                             10.5.0.15,Database Open Access,2010-01-01,Severe,Restrict database access,<p><p>Configure the database server to only allow access to trusted systems. For example, the PCI DSS standard requires you to place the database in an internal network zone, segregated from the DMZ </p></p>
                             10.5.0.15.180,MySQL Obsolete Version,2007-07-25,Critical,Upgrade to the latest version of Oracle MySQL,<p>Download and apply the upgrade from: <a href=http://dev.mysql.com/downloads/mysql>http://dev.mysql.com/downloads/mysql</a></p>'.chomp
+                            
+      @mock_vuln_detail_report = 'stuff'.chomp
 
       @mock_software_report = 'name,ip_address,host_name,description,description,vendor,name,version
                               my_cool_software_build-28,10.5.0.15,,CentOS Linux 6.5,Virtual Machine,Linux,MAKEDEV,3.24-6.el6
@@ -58,7 +61,8 @@ describe 'nexpose-runner' do
         'port' => @expected_port,
         'site_name' => @expected_site_name,
         'ip_addresses' => @expected_ips,
-        'scan_template' => @expected_scan_template
+        'scan_template' => @expected_scan_template,
+        'exception_file' => @expected_exception_file
       }
 
     end
@@ -214,6 +218,7 @@ describe 'nexpose-runner' do
                                                 .and_return(@mock_report)
 
           expect_report_to_be_called_with(CONSTANTS::VULNERABILITY_REPORT_NAME, CONSTANTS::VULNERABILITY_REPORT_QUERY, @mock_vuln_report)
+          expect_report_to_be_called_with(CONSTANTS::VULNERABILITY_DETAIL_REPORT_NAME, CONSTANTS::VULNERABILITY_DETAIL_REPORT_QUERY, @mock_vuln_detail_report)
           expect_report_to_be_called_with(CONSTANTS::SOFTWARE_REPORT_NAME, CONSTANTS::SOFTWARE_REPORT_QUERY, @mock_software_report)
           expect_report_to_be_called_with(CONSTANTS::POLICY_REPORT_NAME, CONSTANTS::POLICY_REPORT_QUERY, @mock_policy_report)
 
@@ -270,6 +275,8 @@ end
 
 def get_mock_nexpose_client
   mock_nexpose_client = double(Nexpose::Connection)
+  xml = REXML::Element.new('test')
+  mock_api_request = double(Nexpose::APIRequest)
 
   allow(mock_nexpose_client).to receive(:call).with(any_args).and_return({})
 
@@ -282,10 +289,33 @@ def get_mock_nexpose_client
 
   allow(Nexpose::Connection).to receive(:new)
                              .and_return(mock_nexpose_client)
-
+                             
+  allow(mock_nexpose_client).to receive(:make_xml)
+                             .with(any_args)
+                             .and_return(xml)
+                             
+  allow(mock_nexpose_client).to receive(:make_xml)
+                             .with(any_args)
+                             .and_return(xml)
+                             
+  allow(mock_nexpose_client).to receive(:filter)
+                            .with(any_args)
+                            .and_return({})                             
+                             
+  allow(mock_nexpose_client).to receive(:execute)
+                             .with(any_args)
+                             .and_return(mock_api_request)
+                             
+  allow(mock_api_request).to receive(:success)
+                             .and_return(false) #this is just to shut up the underlying api.
+                             
+  allow(mock_api_request).to receive(:attributes)
+                             .and_return(xml)                             
+                             
   mock_nexpose_client
 end
 
+
 def get_mock_scan_summary
   mock_scan_summary = double(Nexpose::ScanSummary)
 
@@ -359,3 +389,4 @@ def get_mock_scan
   allow(mock_scan).to receive(:id).and_return(@mock_scan_id)
   mock_scan
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: NexposeRunner
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Nathan Gibson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nexpose
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,7 @@ files:
 - config/scan.yml.example
 - lib/NexposeRunner.rb
 - lib/NexposeRunner/version.rb
+- lib/nexpose-runner/command_line_arg_parser.rb
 - lib/nexpose-runner/constants.rb
 - lib/nexpose-runner/scan.rb
 - lib/nexpose-runner/scan_run_description.rb