NexposeRunner 0.0.17b → 0.0.18b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2590c12a930cd78ea7a98bc29b6ef168e3a58c9
-  data.tar.gz: 02cb068245f7a6f67ebd6766ac446dd83f08f21f
+  metadata.gz: d1536cfdfc2c19fce8e94788b322f2e8a43b7537
+  data.tar.gz: '00728fc5b2cc85d0ee62c29bd2342829535c4a6e'
 SHA512:
-  metadata.gz: cffa73b37cd25356e60f12324274806734a614a8827b4a14d2b44835e0f6c21be55cfcd62b71d934cfeba006ffe14fa3085ccbf1bce2e8c78793786477c4afad
-  data.tar.gz: 45f65266bd748c9264e945dc2699189b9bfc376a54b31a8573d28fa047dcfca007e186299665d39e405dca14dc056487aa63b0dbfd9576249f8dc459854b39a8
+  metadata.gz: a6a8a660ea6f780fa7130d2e209f963e0271b2ac8d34deaa1c1983e187bc1ae5fedb395d3ef1e80409f7f949f0a5aa3d58db2d67b95ada0b44d3cc00547d545e
+  data.tar.gz: cf8835ed343017dbd61c39843a61f79d9e6c206bcb868b83453ce58b5e36e8cdb51c1999714b7f43ecc3615b8edfe077f02bdf1be2d69faad9e3ec26dd46db0e

data/README.md

@@ -30,7 +30,7 @@ This gem allows you to specify the Nexpose Server URL, Exceptions URL (optional)
 
 EXAMPLE:
 
-    $ scan --connection test.com --exceptions_list_url raw.github.com/exceptions.txt --username username1 --password password1 --port 443 --site-name myfirstsite --ip-addresses 192.168.1.10 --scan-template full-audit --Engine 2
+    $ scan --connection test.com --exceptions_list_url raw.github.com/exceptions.txt --username username1 --password password1 --port 443 --site-name myfirstsite --ip-addresses 192.168.1.10 --scan-template full-audit --engine_id 2
     
 It is possible to use a YAML file to drive the configuration of this module.  An example configuration file is provided in config/scan.yml.example.  Simply copy it to config/scan.yml and modify it to work with your environment.
 

data/bin/scan

@@ -13,7 +13,7 @@ if ARGV.grep(/^--/).empty?
     'site_name' => ARGV[4], 
     'ip_addresses' => ARGV[5], 
     'scan_template' => ARGV[6],
-    'engine' => ARGV[7],
+    'engine_id' => ARGV[7],
     'timeout' => ARGV[8],
     'open_timeout' => ARGV[9]})
 else

data/config/scan.yml.example

@@ -4,7 +4,7 @@ password: ''
 port: '3780'
 site_name: ''
 ip_addresses: ''
-scan_template: ''
-engine: ''
+scan_template_id: ''
+engine_id: ''
 timeout: ''
 open_timeout: ''

data/lib/NexposeRunner/version.rb

@@ -1,4 +1,4 @@
 module NexposeRunner
-    VERSION = '0.0.17b'
+    VERSION = '0.0.18b'
 end
 

data/lib/nexpose-runner/command_line_arg_parser.rb

@@ -11,7 +11,7 @@ class CommandLineArgumentParser
     options['site_name'] = ''
     options['ip_addresses'] = ''
     options['scan_template'] = ''
-    options['engine'] = ''
+    options['engine_id'] = ''
 
     opt_parser = OptionParser.new do |opts|
       opts.banner = 'Usage: scan [options]'
@@ -46,12 +46,12 @@ class CommandLineArgumentParser
         options['ip_addresses'] = ips
       end
       
-      opts.on('--scan-template TEMPLATE', 'Nexpose scan template to use') do |template|
-        options['scan_template'] = template
+      opts.on('--scan-template-id TEMPLATE', 'Nexpose scan template to use') do |template|
+        options['scan_template_id'] = template
       end
       
-      opts.on('--engine ENGINE', 'Nexpose scan engine to use') do |engine|
-        options['engine'] = engine
+      opts.on('--engine-id ENGINE', 'Nexpose scan engine to use') do |engine|
+        options['engine_id'] = engine
       end
 
       

data/lib/nexpose-runner/constants.rb

@@ -5,7 +5,7 @@ module CONSTANTS
   REQUIRED_PASSWORD_MESSAGE = 'OOPS! Looks like you forgot to give me a password to login to Nexpose with'
   REQUIRED_SITE_NAME_MESSAGE = 'OOPS! Looks like you forgot to give me a Nexpose Site Name'
   REQUIRED_IP_ADDRESS_MESSAGE = 'OOPS! Looks like you forgot to give me an IP Address to scan'
-  REQUIRED_SCAN_TEMPLATE_MESSAGE = 'OOPS! Looks like you forgot to give me a Scan Template to use'
+  REQUIRED_SCAN_TEMPLATE_MESSAGE = 'OOPS! Looks like you forgot to give me a Scan Template ID to use'
   VULNERABILITY_FOUND_MESSAGE = '---------All YOUR BASE ARE BELONG TO US---------------\nVulnerabilities were found, breaking build'
   DEFAULT_PORT = '3780'
   DEFAULT_TIMEOUT = '120'

data/lib/nexpose-runner/scan.rb

@@ -96,7 +96,7 @@ module NexposeRunner
 
     def self.start_scan(nsc, site, run_details)
 
-      puts "Starting scan for #{run_details.site_name} using the #{run_details.scan_template} scan template"
+      puts "Starting scan for #{run_details.site_name} using the #{run_details.scan_template_id} scan template"
       scan = site.scan nsc
 
       begin
@@ -109,12 +109,12 @@ module NexposeRunner
 
     def self.create_site(run_details, nsc)
       puts "Creating a nexpose site named #{run_details.site_name}"
-      site = Nexpose::Site.new run_details.site_name, run_details.scan_template
+      site = Nexpose::Site.new run_details.site_name, run_details.scan_template_id
       run_details.ip_addresses.each { |address|
           site.included_addresses address
       }
-      if run_details.engine
-        site.engine = run_details.engine
+      if run_details.engine_id
+        site.engine_id = run_details.engine_id
       end
       site.save nsc
       puts "Created site #{run_details.site_name} successfully with the following host(s) #{run_details.ip_addresses.join(', ')}"

data/lib/nexpose-runner/scan_run_description.rb

@@ -2,7 +2,7 @@ require 'yaml'
 require 'nexpose-runner/command_line_arg_parser'
 
 class ScanRunDescription
-  attr_accessor :connection_url, :exceptions_list_url, :username, :password, :port, :site_name, :ip_addresses, :scan_template, :engine
+  attr_accessor :connection_url, :exceptions_list_url, :username, :password, :port, :site_name, :ip_addresses, :scan_template_id, :engine_id
   @@port_value = ''
   @@ip_addresses = []
   @@timeout = ''
@@ -23,8 +23,8 @@ class ScanRunDescription
     @@port_value = options['port']
     self.site_name = options['site_name']
     self.ip_addresses = options['ip_addresses']
-    self.scan_template = options['scan_template']
-    self.engine = options['engine']
+    self.scan_template_id = options['scan_template_id']
+    self.engine_id = options['engine_id']
     self.timeout = options['timeout']
     self.open_timeout = options['open_timeout']
   end
@@ -35,7 +35,7 @@ class ScanRunDescription
     raise StandardError, CONSTANTS::REQUIRED_PASSWORD_MESSAGE if password.nil? || password.empty?
     raise StandardError, CONSTANTS::REQUIRED_SITE_NAME_MESSAGE if site_name.nil? || site_name.empty?
     raise StandardError, CONSTANTS::REQUIRED_IP_ADDRESS_MESSAGE if ip_addresses.length == 0
-    raise StandardError, CONSTANTS::REQUIRED_SCAN_TEMPLATE_MESSAGE if scan_template.nil? || scan_template.empty?
+    raise StandardError, CONSTANTS::REQUIRED_SCAN_TEMPLATE_MESSAGE if scan_template_id.nil? || scan_template_id.empty?
 
   end
 

data/spec/scan_spec.rb

@@ -20,7 +20,7 @@ describe 'nexpose-runner' do
       @expected_port = '3781'
       @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'
+      @expected_scan_template_id = 'full-audit-widget-corp'
       @timeout = '120'
       @open_timeout = '120'
 
@@ -64,7 +64,7 @@ describe 'nexpose-runner' do
         'port' => @expected_port,
         'site_name' => @expected_site_name,
         'ip_addresses' => @expected_ips,
-        'scan_template' => @expected_scan_template,
+        'scan_template_id' => @expected_scan_template_id,
         'timeout' => @timeout,
         'open_timeout' => @open_timeout
       }
@@ -128,10 +128,10 @@ describe 'nexpose-runner' do
 
       it 'should throw an error if no scan template is passed' do
         options = @options.clone
-        options['scan_template'] = nil
+        options['scan_template_id'] = nil
         expect { 
           NexposeRunner::Scan.start(options) 
-        }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a Scan Template to use')
+        }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a Scan Template ID to use')
       end
 
       it 'should use 3780 as default if port is empty string' do
@@ -150,7 +150,7 @@ describe 'nexpose-runner' do
 
       it 'should create a new Nexpose site with the supplied site name and scan template' do
         expect(Nexpose::Site).to receive(:new)
-                                       .with(@options['site_name'], @options['scan_template'])
+                                       .with(@options['site_name'], @options['scan_template_id'])
                                        .and_return(@mock_nexpose_site)
 
         NexposeRunner::Scan.start(@options)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: NexposeRunner
 version: !ruby/object:Gem::Version
-  version: 0.0.17b
+  version: 0.0.18b
 platform: ruby
 authors:
 - Nathan Gibson