metasploit-runner 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73317964938841513e2416cfcc75a4ca3298d314
-  data.tar.gz: 735c44a012cf169362a164f20174eec6f89aa9c4
+  metadata.gz: e7e2d2dec14bd740b81ca421a7a055a7532c52dc
+  data.tar.gz: 82b61166b05fac46c87965cc3bf479305d45e0c7
 SHA512:
-  metadata.gz: 271fe1d83224bca7e1ed3a4e49e12c0940eaf402309c968d90c16789ea35f457f22f00e390bc3237703073a837193293c0788852ce2365b8f64920b248b70d91
-  data.tar.gz: d84c7f0fb8defdab950e6e550c89013ed84319f5919e0ba09489367cc4ec3ddcc77b8b0983a9f9af4dd0f662772424ec8a9ae4bcec0d793dec2e5df539ee5eae
+  metadata.gz: aa4689843ef2cd354dd0c735c0ddcf44f4ab2c9e8b249c14e90c0c08f74263dfeb6f821f17be7152138637ed4a6963c238f4b6f6a909c7b02e5e1780718a0ff6
+  data.tar.gz: e4cd97fa3a0bfcbf178e8c7e4a4e02b2361c54dc5db4359f29d214340bc9b6062a3895f9af29c6c2a8bbab72423ce64cc98f611ba7ba70b785bfb9482ca237c0

data/.gitignore

@@ -21,3 +21,5 @@ tmp
 *.a
 mkmf.log
 .idea/
+config/exploit.yml
+config/explout.yml.bak

data/README.md

@@ -1,12 +1,11 @@
 # MetasploitPenTestScript
 
-This is a ruby gem that basically wraps the msfrpc-client gem. 
+This is a ruby gem that basically wraps the msfrpc-client gem.
 
-It was primarily created to automate workspace creation and automatic import of nexpose scan data from use in 
-a Jenkins automated CI/CD environment. 
+It was primarily created to automate workspace creation and automatic import of Nexpose scan data from use in
+a Jenkins automated CI/CD environment.
 
-Basically this allows you to attach metasploit to your Continuous Delivery/Continuous integration pipeline. 
-Though it can be used for other purposes.
+Basically this allows you to attach Metasploit to your Continuous Delivery/Continuous Integration pipeline, though it can be used for other purposes.
 
 ## Installation
 
@@ -24,28 +23,28 @@ Or install it yourself as:
 
 ## Usage
 
-This gem allows you to specify the Metasploit Connection URL, Metasploit Connection Port, Metasploit URI, SSL true/false, Token, Workspace Name, Nexpose Console Name, Device/Target IP, and Exploit Module OS Filter.
+This gem allows you to specify the Metasploit Connection URL, Metasploit Connection Port, Metasploit URI, SSL true/false, Token, Workspace Name, Nexpose Console Name, Device/Target IP, Exploit Module OS Filter, report type, and Whitelist CIDR block for exploits..
 
-The nexpose_console_name is optional, if you specify a nexpose console name it will use the workspace_name, and nexpose console name to pull scan data from a nexpose console.
+The nexpose_console_name is optional, if you specify a Nexpose console name it will use the workspace_name, and Nexpose console name to pull scan data from a Nexpose console.
 IMPORTANT: Your "Site Name" in Nexpose, must match your "Workspace" name in Metasploit and you must add your Nexpose Console to Metasploit for this to work properly.
 
-    $ exploit "connection_url" "port" "uri" "use_ssl" "token" "workspace_name" "nexpose_console_name" "device_ip_to_scan" "os_filter" "module_filter" "report_type"
+    $ exploit "connection_url" "port" "uri" "use_ssl" "token" "workspace_name" "nexpose_console_name" "device_ip_to_scan" "os_filter" "module_filter" "report_type" "whitelist_hosts"
 
 Example WITH Nexpose Console Integration:
 
-    $ exploit "sploit.mydomain.com" "3790" "/api/1.0" "<true/false>" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "nexpose-console-1" "10.0.0.1" "<true/false>" "exploit/windows/smb/psexec" "fisma"
+    $ exploit "sploit.mydomain.com" "3790" "/api/1.0" "<true/false>" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "nexpose-console-1" "10.0.0.1" "<true/false>" "exploit/windows/smb/psexec" "fisma" "10.0.0.0/8"
 
 Example WITHOUT Nexpose Console Integration:
 
-    $ exploit "sploit.mydomain.com" "3790" "/api/1.0" "true" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "" "10.0.0.1" "false" "exploit/windows/smb/psexec" "fisma"
+    $ exploit "sploit.mydomain.com" "3790" "/api/1.0" "true" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "" "10.0.0.1" "false" "exploit/windows/smb/psexec" "fisma" "10.0.0.0/8"
 
-Additionally, an os filter may be passed in to determine which modules will be ran during an exploit.  The os filter parameter will default to false (all modules will run) if you do not pass a value.
+Additionally, an OS filter may be passed in to determine which modules will be ran during an exploit.  The os filter parameter will default to false (all modules will run) if you do not pass a value.
 
-    Note: at the time of publishing this version of the gem, that was over 6,000 modules, which is ALOT. This option will only work of metasploit has a high confidence in your O/S type.
+    Note: at the time of publishing this version of the gem, that was over 6,000 modules, which is A LOT. This option will only work of metasploit has a high confidence in your O/S type.
 
 Example WITH OS Filter:
 
-    $ exploit "sploit.mydomain.com" "3790" "/api/1.0" "true" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "nexpose-console-1" "10.0.0.1" "true" "" "fisma"
+    $ exploit "sploit.mydomain.com" "3790" "/api/1.0" "true" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "nexpose-console-1" "10.0.0.1" "true" "" "fisma" "10.0.0.0/8"
 
 The if you do not pass the following options they will default to the respective values:
 
@@ -56,11 +55,13 @@ The if you do not pass the following options they will default to the respective
 
 Example using the defaults:
 
-    $ exploit "sploit.mydomain.com" "" "" "" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "nexpose-console-1" "10.0.0.1" "" "" ""
+    $ exploit "sploit.mydomain.com" "" "" "" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "nexpose-console-1" "10.0.0.1" "" "" "" "10.0.0.0/8"
+
+It is possible to use a YAML file to drive the configuration of this module.  An example YAML file is included in config/exploit.yml.example.  Simply copy it to config/exploit.yml and modify it to work with your environment.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/MetasploitPenTestScript/fork )
+1. Fork it ( https://github.com/amngibson/metasploit-runner/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/bin/exploit

@@ -3,16 +3,17 @@
 require 'metasploit/exploit'
 
 $stdout.sync = true
-Metasploit::Exploit.start({ 
-  'connection_url' => ARGV[0], 
-  'port' => ARGV[1], 
-  'uri' => ARGV[2], 
-  'use_ssl' => ARGV[3], 
-  'token' => ARGV[4], 
-  'workspace_name' => ARGV[5], 
-  'nexpose_console_name' => ARGV[6], 
-  'device_ip_to_scan' => ARGV[7], 
-  'use_os_filter' => ARGV[8], 
-  'module_filter' => ARGV[9], 
-  'report_type' => ARGV[10]
+Metasploit::Exploit.start({
+  'connection_url' => ARGV[0],
+  'port' => ARGV[1],
+  'uri' => ARGV[2],
+  'use_ssl' => ARGV[3],
+  'token' => ARGV[4],
+  'workspace_name' => ARGV[5],
+  'nexpose_console_name' => ARGV[6],
+  'device_ip_to_scan' => ARGV[7],
+  'use_os_filter' => ARGV[8],
+  'module_filter' => ARGV[9],
+  'report_type' => ARGV[10],
+  'whitelist_hosts' => ARGV[11]
 })

data/config/exploit.yml.example

@@ -0,0 +1,11 @@
+connection_url: 'sploit.mydomain.com'
+port: '3790'
+uri: '/api/1.0'
+use_ssl: 'true'
+token: 'asdlkjhsdfuw1228340asdasf8'
+workspace_name: 'mycoolsoftware-build-28'
+nexpose_console_name: 'nexpose-console-1'
+device_ip_to_scan: '10.0.0.1'
+use_os_filter: 'true'
+module_filter: 'exploit/windows/smb/psexec'
+report_type: 'fisma'

data/lib/MetasploitPenTestScript/version.rb

@@ -1,3 +1,3 @@
 module MetasploitPenTestScript
-  VERSION = "0.2.1"
+  VERSION = "0.2.3"
 end

data/lib/metasploit/exploit.rb

@@ -41,7 +41,7 @@ module Metasploit
         wait_for_task_to_stop_running(rpc_client, CONSTANTS::IMPORTING_DATA_MESSAGE, import['task_id'])
       end
     end
-    
+
     def self.create_workspace(rpc_client, workspace_name)
       rpc_client.call('pro.workspace_add', {'name' => workspace_name})
     end
@@ -105,7 +105,7 @@ module Metasploit
     end
 
     def self.write_report_after_generation(rpc_client, run_details, report_id)
-      (1..100).each do 
+      (1..100).each do
         download = rpc_client.call('pro.report_download', report_id)
         if download && download['report_artifacts'] && download['report_artifacts'].length > 0
           download['report_artifacts'].each_with_index do |artifact, index|

data/lib/metasploit/exploit_run_description.rb

@@ -1,15 +1,18 @@
+require 'yaml'
+
 class ExploitRunDescription
-  attr_accessor :connection_url, 
-    :port, 
-    :uri, 
-    :use_ssl, 
-    :token, 
-    :workspace_name, 
-    :nexpose_console_name, 
-    :device_ip_to_scan, 
-    :use_os_filter, 
+  attr_accessor :connection_url,
+    :port,
+    :uri,
+    :use_ssl,
+    :token,
+    :workspace_name,
+    :nexpose_console_name,
+    :device_ip_to_scan,
+    :use_os_filter,
     :module_filter,
-    :report_type
+    :report_type,
+    :whitelist_hosts
 
   @@port_value = ''
   @@uri_value = ''
@@ -18,6 +21,9 @@ class ExploitRunDescription
   @@use_os_filter_value = ''
 
   def initialize(options)
+    if File.file?('config/exploit.yml')
+      options = YAML.load_file('config/exploit.yml')
+    end
     self.connection_url = options['connection_url']
     @@port_value = options['port']
     @@uri_value = options['uri']
@@ -29,12 +35,13 @@ class ExploitRunDescription
     self.use_os_filter = options['use_os_filter']
     self.module_filter = options['module_filter']
     self.report_type = options['report_type']
+    self.whitelist_hosts = options['whitelist_hosts']
   end
 
   def verify
     raise StandardError, CONSTANTS::REQUIRED_TOKEN_MESSAGE if token.nil? || token.empty?
     raise StandardError, CONSTANTS::REQUIRED_CONNECTION_URL_MESSAGE if connection_url.nil? || connection_url.empty?
-    raise StandardError, CONSTANTS::REQUIRED_DEVICE_IP_TO_SCAN_MESSAGE if @@device_ip_to_scan_value.nil? || @@device_ip_to_scan_value.empty?
+    raise StandardError, CONSTANTS::REQUIRED_DEVICE_IP_TO_SCAN_MESSAGE if device_ip_to_scan.nil? || device_ip_to_scan.empty?
     raise StandardError, CONSTANTS::REQUIRED_WORKSPACE_MESSAGE if workspace_name.nil? || workspace_name.empty?
   end
 
@@ -49,7 +56,9 @@ class ExploitRunDescription
   end
 
   def device_ip_to_scan=(value)
-    @@device_ip_to_scan_value = value
+    if !@@device_ip_to_scan_value.nil?
+        @@device_ip_to_scan_value = value.strip!
+    end
   end
 
   def get_audit_options
@@ -63,7 +72,7 @@ class ExploitRunDescription
 
   def get_exploit_options
     { "workspace" => self.workspace_name,
-      "DS_WHITELIST_HOSTS" => @@device_ip_to_scan_value,
+      "DS_WHITELIST_HOSTS" => self.whitelist_hosts,
       "DS_MinimumRank" => "great",
       "DS_EXPLOIT_SPEED" => 5,
       "DS_EXPLOIT_TIMEOUT" => 2,
@@ -86,7 +95,18 @@ class ExploitRunDescription
   end
 
   def device_ip_to_scan
-    "http://#{@@device_ip_to_scan_value}"
+    if @@device_ip_to_scan_value.nil? || @@device_ip_to_scan_value.empty?
+        return nil
+    end
+    values = @@device_ip_to_scan_value.split(' ')
+    if values.nil? || values.length == 0
+        return nil
+    end
+    ret = []
+    values.each do |value|
+        ret.push("http://#{value}/")
+    end
+    ret.join(' ')
   end
 
   def port=(value)

data/spec/exploit_config_spec.rb

@@ -0,0 +1,54 @@
+require 'metasploit/exploit_run_description'
+
+file_path = 'config/exploit.yml'
+describe 'exploit_user_config_file_tests' do
+  if File.file?('config/exploit.yml')
+    File.rename('config/exploit.yml','config/exploit.yml.bak')
+  end
+
+  describe 'start' do
+    before(:each) do
+      config_file = File.new(file_path, 'w')
+      config_file.puts("connection_url: 'mydomain.wat'")
+      config_file.close
+      @exploit_run_description = ExploitRunDescription.new({})
+    end
+
+    after(:each) do
+      File.delete(file_path) if File.exist?(file_path)
+    end
+
+    it 'should get configuration from the config/exploit.yaml when provided' do
+      expect(@exploit_run_description.connection_url).to eq('mydomain.wat')
+    end
+  end
+
+  if File.file?('config/exploit.yml.bak')
+    File.rename('config/exploit.yml.bak', 'config/exploit.yml')
+  end
+
+end
+
+describe 'exploit_default_config_tests' do
+  if File.file?('config/exploit.yml')
+    File.rename('config/exploit.yml', 'config/exploit.yml.bak')
+  end
+
+  describe 'start' do
+    before(:each) do
+      @options = {
+        'connection_url' => 'foo.bar'
+      }
+      @exploit_run_description = ExploitRunDescription.new(@options)
+    end
+
+    it 'should get configuration from the command line options' do
+      expect(@exploit_run_description.connection_url).to eq('foo.bar')
+    end
+  end
+
+  if File.file?('config/exploit.yml.bak')
+    File.rename('config/exploit.yml.bak', 'config/exploit.yml')
+  end
+
+end

data/spec/exploit_run_description_spec.rb

@@ -1,6 +1,10 @@
 require 'metasploit/exploit_run_description'
 
 describe 'exploit_run_description' do
+  if File.file?('config/exploit.yml')
+    File.rename('config/exploit.yml', 'config/exploit.yml.bak')
+  end
+
   describe 'start' do
     before(:each) do
       @expected_connection = 'http://test.connection'
@@ -18,7 +22,9 @@ describe 'exploit_run_description' do
       @expected_tls ='TLS1'
       @mock_rpc_client = get_mock_rpc_client
       @mock_device_ip_to_scan = '127.0.0.1'
-      @mock_device_url_to_scan = "http://#{@mock_device_ip_to_scan}"
+      @mock_device_url_to_scan = "http://#{@mock_device_ip_to_scan}/"
+      @mock_whitelist_hosts = "10.0.0.0/8"
+
       @options =  {
         'connection_url' => @expected_connection,
         'port' => @expected_port,
@@ -30,10 +36,11 @@ describe 'exploit_run_description' do
         'device_ip_to_scan' => @mock_device_ip_to_scan,
         'use_os_filter' => @expected_use_os_filter,
         'module_filter' => @expected_module_filter,
-        'report_type' => @expected_report_type
+        'report_type' => @expected_report_type,
+        'whitelist_hosts' => @mock_whitelist_hosts
       }
-      
-      @exploit_run_description = ExploitRunDescription.new(@options) 
+
+      @exploit_run_description = ExploitRunDescription.new(@options)
     end
 
     it 'should accept all of the needed parameters and persist them' do
@@ -48,6 +55,7 @@ describe 'exploit_run_description' do
       expect(@exploit_run_description.use_os_filter).to eq(@expected_os_filter)
       expect(@exploit_run_description.module_filter).to eq(@expected_module_filter)
       expect(@exploit_run_description.report_type).to eq(@expected_report_type)
+      expect(@exploit_run_description.whitelist_hosts).to eq(@mock_whitelist_hosts)
     end
 
     it 'should use 3790 as default if port is empty string' do
@@ -172,4 +180,8 @@ describe 'exploit_run_description' do
       end
     end
   end
+
+  if File.file?('config/exploit.yml.bak')
+    File.rename('config/exploit.yml.bak', 'config/exploit.yml')
+  end
 end

data/spec/exploit_spec.rb

@@ -36,7 +36,8 @@ describe 'exploit' do
       @expected_module_filter = 'exploit/windows/smb/psexec'
       @mock_rpc_client = get_mock_rpc_client
       @mock_device_ip_to_scan = '127.0.0.1'
-      @mock_device_url_to_scan = "http://#{@mock_device_ip_to_scan}"
+      @mock_device_url_to_scan = "http://#{@mock_device_ip_to_scan}/"
+      @mock_whitelist_hosts = "10.0.0.0/8"
 
       @options = {
         'connection_url' => @expected_connection,
@@ -49,7 +50,8 @@ describe 'exploit' do
         'device_ip_to_scan' => @mock_device_ip_to_scan,
         'use_os_filter' => @expected_use_os_filter,
         'module_filter' => @expected_module_filter,
-        'report_type' => @expected_report_type
+        'report_type' => @expected_report_type,
+        'whitelist_hosts' => @mock_whitelist_hosts
       }
     end
 
@@ -67,24 +69,24 @@ describe 'exploit' do
       it 'should throw an error if no token is passed' do
         options = @options.clone
         options['token'] = nil;
-        expect { 
-          Metasploit::Exploit.start(options) 
+        expect {
+          Metasploit::Exploit.start(options)
         }.to raise_error(StandardError, 'PWNED! Token is required')
       end
 
       it 'should throw an error if no connection url is passed' do
         options = @options.clone
         options['connection_url'] = nil
-        expect { 
-          Metasploit::Exploit.start(options) 
+        expect {
+          Metasploit::Exploit.start(options)
         }.to raise_error(StandardError, 'PWNED! Connection URL is required')
       end
 
       it 'should throw an error if no ip address is passed' do
         options = @options.clone
         options['device_ip_to_scan'] = nil;
-        expect { 
-          Metasploit::Exploit.start(options) 
+        expect {
+          Metasploit::Exploit.start(options)
         }.to raise_error(StandardError, 'PWNED! Device IP to scan is required')
       end
 
@@ -114,8 +116,8 @@ describe 'exploit' do
       it 'should throw an error if workspace name is invalid' do
         options = @options.clone
         options['workspace_name'] = nil
-        expect { 
-          Metasploit::Exploit.start(options) 
+        expect {
+          Metasploit::Exploit.start(options)
         }.to raise_error(StandardError, 'PWNED! Workspace Name is required')
       end
     end
@@ -142,7 +144,7 @@ describe 'exploit' do
                                       'DS_NEXPOSE_CONSOLE' => @expected_nexpose_console_name,
                                       'DS_NEXPOSE_SITE' => @expected_workspace_name
                                     })
-        
+
         Metasploit::Exploit.start(@options)
       end
 
@@ -159,17 +161,17 @@ describe 'exploit' do
 
         it 'should call to check the status of an import' do
           expect(@mock_rpc_client).to receive(:call).with('pro.task_status', @expected_import_task_id)
-          
+
           Metasploit::Exploit.start(@options)
         end
 
         it 'should call to check the status until it is not running' do
           expect(@mock_rpc_client).to receive(:call)
                                       .with('pro.task_status', @expected_import_task_id)
-                                      .and_return({ 
+                                      .and_return({
                                         '1' => {
-                                          'status' => 'running', 
-                                          'progress' => 25, 
+                                          'status' => 'running',
+                                          'progress' => 25,
                                           'info' => 'Generating the export data file'
                                         }
                                       })
@@ -180,8 +182,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_import_task_id)
                                       .and_return({
                                         '1' => {
-                                          'status' => 'not running', 
-                                          'progress' => 100, 
+                                          'status' => 'not running',
+                                          'progress' => 100,
                                           'info' => 'Complete'
                                         }
                                       })
@@ -196,8 +198,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_import_task_id)
                                       .and_return({
                                         '1' => {
-                                          'status' => 'running', 
-                                          'progress' => 25, 
+                                          'status' => 'running',
+                                          'progress' => 25,
                                           'info' => 'Generating the export data file'
                                         }
                                       })
@@ -208,8 +210,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_import_task_id)
                                       .and_return({
                                         '1' => {
-                                          'status' => 'not running', 
-                                          'progress' => 100, 
+                                          'status' => 'not running',
+                                          'progress' => 100,
                                           'info' => 'Complete'
                                         }
                                       })
@@ -217,7 +219,7 @@ describe 'exploit' do
                                       .ordered
           #Expecting 7 because we are mocking 6 above and the global :call mock in get_mock_rpc_client
           expect(Metasploit::Exploit).to receive(:sleep).with(3).exactly(107).times
-          
+
           Metasploit::Exploit.start(@options)
         end
       end
@@ -231,7 +233,7 @@ describe 'exploit' do
                                       'DS_URLS' => @mock_device_url_to_scan
                                     })
 
-        Metasploit::Exploit.start(@options)                     
+        Metasploit::Exploit.start(@options)
       end
 
       describe 'wait for scan to be over' do
@@ -249,7 +251,7 @@ describe 'exploit' do
         it 'should call to check the status of the scan' do
           expect(@mock_rpc_client).to receive(:call).with('pro.task_status', @expected_webscan_task_id)
 
-          Metasploit::Exploit.start(@options)                     
+          Metasploit::Exploit.start(@options)
         end
 
         it 'should call to check the status until it is not running' do
@@ -257,8 +259,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_webscan_task_id)
                                       .and_return({
                                         '12' => {
-                                          'status' => 'running', 
-                                          'progress' => 50, 
+                                          'status' => 'running',
+                                          'progress' => 50,
                                           'info' => 'Validating Target URLs'
                                         }
                                       })
@@ -269,24 +271,24 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_webscan_task_id)
                                       .and_return({
                                         '12' => {
-                                          'status' => 'not running', 
-                                          'progress' => 100, 
+                                          'status' => 'not running',
+                                          'progress' => 100,
                                           'info' => 'Complete'
                                         }
                                       })
                                       .once
                                       .ordered
 
-          Metasploit::Exploit.start(@options)           
+          Metasploit::Exploit.start(@options)
         end
 
         it 'should sleep for 3 seconds if the status is still running' do
           expect(@mock_rpc_client).to receive(:call)
                                       .with('pro.task_status', @expected_webscan_task_id)
-                                      .and_return({ 
+                                      .and_return({
                                         '12' => {
-                                          'status' => 'running', 
-                                          'progress' => 50, 
+                                          'status' => 'running',
+                                          'progress' => 50,
                                           'info' => 'Validating Target URLs'
                                         }
                                       })
@@ -297,8 +299,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_webscan_task_id)
                                       .and_return({
                                          '12' => {
-                                           'status' => 'not running', 
-                                           'progress' => 100, 
+                                           'status' => 'not running',
+                                           'progress' => 100,
                                            'info' => 'Complete'
                                          }
                                       })
@@ -308,7 +310,7 @@ describe 'exploit' do
           #Expecting 7 because we are mocking 6 above and the global :call mock in get_mock_rpc_client
           expect(Metasploit::Exploit).to receive(:sleep).with(3).exactly(107).times
 
-          Metasploit::Exploit.start(@options)          
+          Metasploit::Exploit.start(@options)
         end
       end
     end
@@ -316,13 +318,13 @@ describe 'exploit' do
     describe 'start generating report' do
       it 'should start a report' do
         expect(@mock_rpc_client).to receive(:call)
-                                    .with('pro.start_report', { 
-                                     'workspace' => @expected_workspace_name,  
+                                    .with('pro.start_report', {
+                                     'workspace' => @expected_workspace_name,
                                      'name' => @expected_workspace_name,
                                      'report_type' => @expected_report_type,
                                      'created_by' => @expected_workspace_name,
                                      'file_formats' => [:pdf],
-                                     'DS_WHITELIST_HOSTS' => @mock_device_url_to_scan,  
+                                     'DS_WHITELIST_HOSTS' => @mock_device_url_to_scan,
                                     })
 
         Metasploit::Exploit.start(@options)
@@ -373,7 +375,7 @@ describe 'exploit' do
                                       .and_return({
                                         '14' => {
                                           'status' => 'running',
-                                          'progress' => 3, 
+                                          'progress' => 3,
                                           'info' => 'Auditing your website'
                                         }
                                       })
@@ -384,8 +386,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_audit_task_id)
                                       .and_return({
                                         '14' => {
-                                          'status' => 'not running', 
-                                          'progress' => 100, 
+                                          'status' => 'not running',
+                                          'progress' => 100,
                                           'info' => 'Complete'
                                         }
                                       })
@@ -400,8 +402,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_audit_task_id)
                                       .and_return({
                                         '14' => {
-                                          'status' => 'running', 
-                                          'progress' => 3, 
+                                          'status' => 'running',
+                                          'progress' => 3,
                                           'info' => 'Auditing your website'
                                         }
                                       })
@@ -412,14 +414,14 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_audit_task_id)
                                       .and_return({
                                         '14' => {
-                                          'status' => 'not running', 
-                                          'progress' => 100, 
+                                          'status' => 'not running',
+                                          'progress' => 100,
                                           'info' => 'Complete'
                                         }
                                       })
                                       .once
                                       .ordered
-        
+
           expect(Metasploit::Exploit).to receive(:sleep)
                                          .with(3)
                                          .exactly(107)
@@ -436,7 +438,7 @@ describe 'exploit' do
         expect(@mock_rpc_client).to receive(:call)
                                     .with('pro.start_exploit', {
                                       "workspace" => @expected_workspace_name,
-                                      "DS_WHITELIST_HOSTS" => @mock_device_ip_to_scan,
+                                      "DS_WHITELIST_HOSTS" => @mock_whitelist_hosts,
                                       "DS_MinimumRank" => @expected_minimum_rank,
                                       "DS_EXPLOIT_SPEED" => @expected_exploit_speed,
                                       "DS_EXPLOIT_TIMEOUT" => @expected_exploit_timeout,
@@ -454,7 +456,7 @@ describe 'exploit' do
         expect(@mock_rpc_client).to receive(:call)
                                     .with('pro.start_exploit', {
                                       "workspace" => @expected_workspace_name,
-                                      "DS_WHITELIST_HOSTS" => @mock_device_ip_to_scan,
+                                      "DS_WHITELIST_HOSTS" => @mock_whitelist_hosts,
                                       "DS_MinimumRank" => @expected_minimum_rank,
                                       "DS_EXPLOIT_SPEED" => @expected_exploit_speed,
                                       "DS_EXPLOIT_TIMEOUT" => @expected_exploit_timeout,
@@ -472,7 +474,7 @@ describe 'exploit' do
         expect(@mock_rpc_client).to receive(:call)
                                     .with('pro.start_exploit', {
                                       "workspace" => @expected_workspace_name,
-                                      "DS_WHITELIST_HOSTS" => @mock_device_ip_to_scan,
+                                      "DS_WHITELIST_HOSTS" => @mock_whitelist_hosts,
                                       "DS_MinimumRank" => @expected_minimum_rank,
                                       "DS_EXPLOIT_SPEED" => @expected_exploit_speed,
                                       "DS_EXPLOIT_TIMEOUT" => @expected_exploit_timeout,
@@ -492,7 +494,7 @@ describe 'exploit' do
         expect(@mock_rpc_client).to receive(:call)
                                     .with('pro.start_exploit', {
                                       "workspace" => @expected_workspace_name,
-                                      "DS_WHITELIST_HOSTS" => @mock_device_ip_to_scan,
+                                      "DS_WHITELIST_HOSTS" => @mock_whitelist_hosts,
                                       "DS_MinimumRank" => @expected_minimum_rank,
                                       "DS_EXPLOIT_SPEED" => @expected_exploit_speed,
                                       "DS_EXPLOIT_TIMEOUT" => @expected_exploit_timeout,
@@ -513,7 +515,7 @@ describe 'exploit' do
         expect(@mock_rpc_client).to receive(:call)
                                     .with('pro.start_exploit', {
                                       "workspace" => @expected_workspace_name,
-                                      "DS_WHITELIST_HOSTS" => @mock_device_ip_to_scan,
+                                      "DS_WHITELIST_HOSTS" => @mock_whitelist_hosts,
                                       "DS_MinimumRank" => @expected_minimum_rank,
                                       "DS_EXPLOIT_SPEED" => @expected_exploit_speed,
                                       "DS_EXPLOIT_TIMEOUT" => @expected_exploit_timeout,
@@ -534,7 +536,7 @@ describe 'exploit' do
           expect(@mock_rpc_client).to receive(:call)
                                       .with('pro.start_exploit', {
                                         "workspace" => @expected_workspace_name,
-                                        "DS_WHITELIST_HOSTS" => @mock_device_ip_to_scan,
+                                        "DS_WHITELIST_HOSTS" => @mock_whitelist_hosts,
                                         "DS_MinimumRank" => @expected_minimum_rank,
                                         "DS_EXPLOIT_SPEED" => @expected_exploit_speed,
                                         "DS_EXPLOIT_TIMEOUT" => @expected_exploit_timeout,
@@ -561,8 +563,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_exploit_task_id)
                                       .and_return({
                                         '13' => {
-                                          'status' => 'running', 
-                                          'progress' => 3, 
+                                          'status' => 'running',
+                                          'progress' => 3,
                                           'info' => 'WordPress Asset-Manager PHP File Upload Vulnerability'
                                         }
                                       })
@@ -573,8 +575,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_exploit_task_id)
                                       .and_return({
                                         '13' => {
-                                          'status' => 'not running', 
-                                          'progress' => 100, 
+                                          'status' => 'not running',
+                                          'progress' => 100,
                                           'info' => 'Complete'
                                         }
                                       })
@@ -589,8 +591,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_exploit_task_id)
                                       .and_return({
                                         '13' => {
-                                          'status' => 'running', 
-                                          'progress' => 3, 
+                                          'status' => 'running',
+                                          'progress' => 3,
                                           'info' => 'WordPress Asset-Manager PHP File Upload Vulnerability'
                                         }
                                       })
@@ -601,8 +603,8 @@ describe 'exploit' do
                                       .with('pro.task_status', @expected_exploit_task_id)
                                       .and_return({
                                         '13' => {
-                                          'status' => 'not running', 
-                                          'progress' => 100, 
+                                          'status' => 'not running',
+                                          'progress' => 100,
                                           'info' => 'Complete'
                                         }
                                       })
@@ -624,11 +626,11 @@ end
 
 def get_default_options_and_override(override)
   {
-    :host => @expected_connection, 
-    :port => @expected_port, 
-    :token => @expected_token, 
-    :uri => @expected_uri, 
-    :ssl => @expected_ssl, 
+    :host => @expected_connection,
+    :port => @expected_port,
+    :token => @expected_token,
+    :uri => @expected_uri,
+    :ssl => @expected_ssl,
     :ssl_version => @expected_ssl_version
   }.merge(override)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metasploit-runner
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Nathan Gibson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msfrpc-client
@@ -83,11 +83,13 @@ files:
 - README.md
 - Rakefile
 - bin/exploit
+- config/exploit.yml.example
 - lib/MetasploitPenTestScript.rb
 - lib/MetasploitPenTestScript/version.rb
 - lib/metasploit/constants.rb
 - lib/metasploit/exploit.rb
 - lib/metasploit/exploit_run_description.rb
+- spec/exploit_config_spec.rb
 - spec/exploit_run_description_spec.rb
 - spec/exploit_spec.rb
 - spec/spec_helper.rb
@@ -111,11 +113,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Script to run automated Metaspolit Penetration Tests.
 test_files:
+- spec/exploit_config_spec.rb
 - spec/exploit_run_description_spec.rb
 - spec/exploit_spec.rb
 - spec/spec_helper.rb