metasploit-runner 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff96df61da304a50fe9261a61ed81b275115bad
-  data.tar.gz: b17212e78aa95a8c9577f1928bdbab36975bd410
+  metadata.gz: 87b65201b1361ddbc5f3d441ddaabb796a16ef83
+  data.tar.gz: 094d207a73b98cb52931b4db4aa8a50ad1f0a562
 SHA512:
-  metadata.gz: 855b16bed365745386841cdc0fae3cc61f5a80a115c74bc1cf613e8561842c97a7d2ea7d3f0fc3de9d2b1723449ef3f41a2892f4cc271af7fce6de12091442b6
-  data.tar.gz: 639a94bbe7a5b88808c420a21fae786f52a62a15dfeee2d4f47158aa9c239788017fada5941eb7b9c8bc0bc0cedb13bb6f008527990d289cc059c0d9d0cfcd2e
+  metadata.gz: 91072d871169e598691a9048544200cb71a945f6a3b7577cb5e3590c834cc14c7b31aadd5e2073180ea2769f486a5f0516656400e3853f266bac35ca03c29767
+  data.tar.gz: 967f1fe9ca1eca4b2523ef3dcc714daa1749af04962e21b766c73d12692770531f3b305473f306ecc4a06d77efe0e5e9dcb57709ed57775cb7677d30936f1132

data/.travis.yml

@@ -1,5 +1,11 @@
 language: ruby
 rvm:
-  - "2.1.2"
-# uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+- 2.1.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: kwPTUQGR25urq/yKIFLcV2TjBalTGU5uWI+jK36I1fatvtbk6geL3BbpPuyiIQOvu2Kge6c5bEQpnOFNNeRW08G7vojhn1aFp7MtKLuE47jazbA1ekGh7Cvyt/actu9wensNAuew87IpJW9Fjxu+5B/RHz678nJqIA4zxFwL1TU=
+  gem: metasploit-runner
+  on:
+    tags: true
+    repo: amngibson/metasploit-runner

data/README.md

@@ -24,14 +24,22 @@ 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.
+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.
+
+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"
 
-Example:
+Example WITH Nexpose Console Integration:
 
     $ exploit "sploit.mydomain.com" "3790" "/api/1.0" "true" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "nexpose-console-1" "10.0.0.1"
 
+Example WITHOUT Nexpose Console Integration:
+
+    $ exploit "sploit.mydomain.com" "3790" "/api/1.0" "true" "asdlkjhsdfuw1228340asdasf8" "mycoolsoftware-build-28" "" "10.0.0.1"
+
+
 The if you do not pass the following options they will default to the respective values:
 
        port -> 3790

data/lib/MetasploitPenTestScript/version.rb

@@ -1,3 +1,3 @@
 module MetasploitPenTestScript
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/metasploit/constants.rb

@@ -3,6 +3,7 @@ module CONSTANTS
   DEFAULT_URI = '/api/1.0'
   DEFAULT_SSL = true
   RUNNING_IMPORT_STATUS = 'running'
+  EXPLOIT_RUNNING_MESSAGE = 'running'
   REQUIRED_TOKEN_MESSAGE = 'PWNED! Token is required'
   REQUIRED_CONNECTION_URL_MESSAGE = 'PWNED! Connection URL is required'
   REQUIRED_DEVICE_IP_TO_SCAN_MESSAGE = 'PWNED! Device IP to scan is required'
@@ -12,6 +13,7 @@ module CONSTANTS
   USING_DEFAULT_SSL_MESSAGE = '[*] Using SSL=TRUE'
   IMPORTING_DATA_MESSAGE = '[*] Importing...'
   SCANNING_MESSAGE = '[*] Scanning all your things...'
+  EXPLOIT_MESSAGE = '[*] Exploiting all your things...'
   REQUIRED_WORKSPACE_MESSAGE = 'PWNED! Workspace Name is required'
   SKIPPING_IMPORT_MESSAGE = '[*] Nexpose Console option was not passed, skipping Nexpose Import'
 

data/lib/metasploit/exploit.rb

@@ -15,6 +15,8 @@ module Metasploit
       do_nexpose_import(rpc_client, run_details)
 
       do_metasploit_scan(rpc_client, run_details)
+
+      do_metasploit_exploit(rpc_client, run_details)
     end
 
     private
@@ -45,6 +47,11 @@ module Metasploit
       wait_for_task_to_stop_running(rpc_client, CONSTANTS::SCANNING_MESSAGE, scan['task_id'])
     end
 
+    def self.do_metasploit_exploit(rpc_client, run_details)
+      sploit = rpc_client.call('pro.start_exploit', {'workspace' => run_details.workspace_name})
+      wait_for_task_to_stop_running(rpc_client, CONSTANTS::EXPLOIT_MESSAGE, sploit['task_id'])
+    end
+
     def self.wait_for_task_to_stop_running(rpc_client, status_message, task_id)
       sleep(3)
       status = rpc_client.call('pro.task_status', task_id)

data/spec/exploit_spec.rb

@@ -16,6 +16,7 @@ describe 'exploit' do
       @expected_nexpose_console_name = 'nexpose_console_name'
       @expected_webscan_task_id = '12'
       @expected_import_task_id = '1'
+      @expected_exploit_task_id = '13'
       @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}"
@@ -137,7 +138,7 @@ describe 'exploit' do
                                       .ordered
 
           #Expecting 5 because we are mocking 4 above and the global :call mock in get_mock_rpc_client
-          expect(Metasploit::Exploit).to receive(:sleep).with(3).exactly(5).times
+          expect(Metasploit::Exploit).to receive(:sleep).with(3).exactly(6).times
 
           Metasploit::Exploit.start(@expected_connection, @expected_port, @expected_uri, @expected_ssl,  @expected_token, @expected_workspace_name, @expected_nexpose_console_name, @mock_device_ip_to_scan)
         end
@@ -153,7 +154,7 @@ describe 'exploit' do
         Metasploit::Exploit.start(@expected_connection, @expected_port, @expected_uri, @expected_ssl,  @expected_token, @expected_workspace_name, @expected_nexpose_console_name, @mock_device_ip_to_scan)
       end
 
-      describe 'wait to be over' do
+      describe 'wait for scan to be over' do
         before(:each) do
           expect(@mock_rpc_client).to receive(:call)
                                       .with('pro.start_webscan', {'workspace' => @expected_workspace_name,
@@ -196,8 +197,68 @@ describe 'exploit' do
                                       .once
                                       .ordered
 
-          #Expecting 5 because we are mocking 4 above and the global :call mock in get_mock_rpc_client
-          expect(Metasploit::Exploit).to receive(:sleep).with(3).exactly(5).times
+          #Expecting 6 because we are mocking 4 above and the global :call mock in get_mock_rpc_client
+          expect(Metasploit::Exploit).to receive(:sleep).with(3).exactly(6).times
+
+          Metasploit::Exploit.start(@expected_connection, @expected_port, @expected_uri, @expected_ssl,  @expected_token, @expected_workspace_name, @expected_nexpose_console_name, @mock_device_ip_to_scan)
+        end
+      end
+    end
+
+    describe 'start a exploit' do
+
+      it 'should kick off an exploit' do
+        expect(@mock_rpc_client).to receive(:call)
+                                    .with('pro.start_exploit', {'workspace' => @expected_workspace_name})
+
+        Metasploit::Exploit.start(@expected_connection, @expected_port, @expected_uri, @expected_ssl,  @expected_token, @expected_workspace_name, @expected_nexpose_console_name, @mock_device_ip_to_scan)
+      end
+
+      describe 'wait for exploit to be over' do
+        before(:each) do
+
+          expect(@mock_rpc_client).to receive(:call)
+                                      .with('pro.start_exploit', {'workspace' => @expected_workspace_name})
+                                      .and_return({'task_id' => @expected_exploit_task_id})
+        end
+
+        it 'should call to check the status of the exploit' do
+          expect(@mock_rpc_client).to receive(:call).with('pro.task_status', @expected_exploit_task_id)
+
+          Metasploit::Exploit.start(@expected_connection, @expected_port, @expected_uri, @expected_ssl,  @expected_token, @expected_workspace_name, @expected_nexpose_console_name, @mock_device_ip_to_scan)
+        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_exploit_task_id)
+                                      .and_return({'status' => 'running'})
+                                      .exactly(3).times
+                                      .ordered
+
+          expect(@mock_rpc_client).to receive(:call)
+                                      .with('pro.task_status', @expected_exploit_task_id)
+                                      .and_return({'status' => 'not running'})
+                                      .once
+                                      .ordered
+
+          Metasploit::Exploit.start(@expected_connection, @expected_port, @expected_uri, @expected_ssl,  @expected_token, @expected_workspace_name, @expected_nexpose_console_name, @mock_device_ip_to_scan)
+        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_exploit_task_id)
+                                      .and_return({'status' => 'running'})
+                                      .exactly(3).times
+                                      .ordered
+
+          expect(@mock_rpc_client).to receive(:call)
+                                      .with('pro.task_status', @expected_exploit_task_id)
+                                      .and_return({'status' => 'not running'})
+                                      .once
+                                      .ordered
+
+          #Expecting 6 because we are mocking 4 above and the global :call mock in get_mock_rpc_client
+          expect(Metasploit::Exploit).to receive(:sleep).with(3).exactly(6).times
 
           Metasploit::Exploit.start(@expected_connection, @expected_port, @expected_uri, @expected_ssl,  @expected_token, @expected_workspace_name, @expected_nexpose_console_name, @mock_device_ip_to_scan)
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metasploit-runner
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nathan Gibson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-24 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msfrpc-client