msfrpc-client 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11744747ce28ee144620957a3c362e3eb1e5b843
-  data.tar.gz: ef6329d09ec64617a0bd266f4fe0c1ab480c464f
+  metadata.gz: eae20060bcf4dfb1bdbfa1fc3f530ed7a7421e8b
+  data.tar.gz: d07865830b68e642d3b4d90a3a91da825050eea7
 SHA512:
-  metadata.gz: dca81c9fa5e2f6485e188273a061ff88d7554180f3e98ca990e1e5328a5a1ca5d9053a2c6c116e414fa1087814627f778ca9d8c781763567fddcfe38803df6ea
-  data.tar.gz: bad778fbbc15b44635fd72f41694db3a77296e729dc2324871f627ebd9bb6097f77aa6665f44fc347dbf7b187f5f2315e127fabb92cee0af8e57cccd70faa621
+  metadata.gz: af9827831127544c74d2ffdad8f2d7f5b3dda6e8f9ca42e0a2635d147b0ef886eb68ed188afde445ef3afa36d575256da07798c087470f7252f6efaa94e64a77
+  data.tar.gz: 9aa9459aab5fc8bdb85ef015641688f7f3b91c3c8383cc4ad50dc2000fb7420dc4a122b7da449594a804c62a6596e47d5e692c7d50d68d0288bf324462768090

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.4.1

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    msfrpc-client (1.1.0)
-      msgpack
-      rex
+    msfrpc-client (1.1.1)
+      msgpack (~> 1)
+      rex (~> 2)
 
 GEM
   remote: https://rubygems.org/
@@ -12,46 +12,46 @@ GEM
     filesize (0.1.1)
     jsobfu (0.4.2)
       rkelly-remix
-    json (2.0.3)
+    json (2.1.0)
     metasm (1.0.3)
-    mini_portile2 (2.1.0)
+    mini_portile2 (2.2.0)
     msgpack (1.1.0)
-    nokogiri (1.7.0.1)
-      mini_portile2 (~> 2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
     rake (12.0.0)
-    rb-readline-r7 (0.5.2.0)
-    rex (2.0.10)
+    rb-readline (0.5.4)
+    rex (2.0.11)
       filesize
       jsobfu (~> 0.4.1)
       json
       metasm (~> 1.0.2)
       nokogiri
-      rb-readline-r7
+      rb-readline
       robots
     rkelly-remix (0.0.7)
     robots (0.10.1)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
+  bundler (~> 1)
   msfrpc-client!
-  rake
-  rspec
+  rake (~> 12)
+  rspec (~> 3)
 
 BUNDLED WITH
-   1.14.6
+   1.15.1

data/examples/msfrpc_irb.rb

@@ -19,9 +19,8 @@ rpc  = Msf::RPC::Client.new(opts)
 
 $stdout.puts "[*] The RPC client is available in variable 'rpc'"
 if rpc.token
-	$stdout.puts "[*] Sucessfully authenticated to the server"
+  $stdout.puts "[*] Sucessfully authenticated to the server"
 end
 
 $stdout.puts "[*] Starting IRB shell..."
 Rex::Ui::Text::IrbShell.new(binding).run
-

data/examples/msfrpc_pro_discover.rb

@@ -0,0 +1,207 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+require 'msfrpc-client'
+require 'rex/ui'
+
+def usage(ropts)
+  $stderr.puts ropts
+
+  if @rpc and @rpc.token
+    wspaces = @rpc.call("pro.workspaces") rescue {}
+    if wspaces.keys.length > 0
+      $stderr.puts "Active Projects:"
+      wspaces.each_pair do |k,v|
+        $stderr.puts "\t#{k}"
+      end
+    end
+  end
+  $stderr.puts ""
+  exit(1)
+end
+
+opts = {}
+
+# Parse script-specific options
+parser = Msf::RPC::Client.option_parser(opts)
+parser.separator('Discover Mandatory Options:')
+
+parser.on("--project PROJECT") do |x|
+  opts[:project] = x
+end
+
+parser.on("--targets TARGETS") do |x|
+  opts[:targets] = [x]
+end
+
+parser.on("--blacklist BLACKLIST (optional)") do |x|
+  opts[:blacklist] = x
+end
+
+parser.on("--speed SPEED (optional)") do |x|
+  opts[:speed] = x
+end
+
+parser.on("--extra-ports PORTS (optional)") do |x|
+  opts[:extra_ports] = x
+end
+
+parser.on("--blacklist-ports PORTS (optional)") do |x|
+  opts[:blacklist_ports] = x
+end
+
+parser.on("--custom-ports PORTS (optional)") do |x|
+  opts[:custom_ports] = x
+end
+
+parser.on("--portscan-timeout TIMEOUT (optional)") do |x|
+  opts[:portscan_timeout] = x
+end
+
+parser.on("--source-port PORT (optional)") do |x|
+  opts[:source_port] = x
+end
+
+parser.on("--custom-nmap-options OPTIONS (optional)") do |x|
+  opts[:custom_nmap_options] = x
+end
+
+parser.on("--disable-udp-probes (optional)") do
+  opts[:disable_udp_probes] = true
+end
+
+parser.on("--disable-finger-users (optional)") do
+  opts[:disable_finger_users] = true
+end
+
+parser.on("--disable-snmp-scan (optional)") do
+  opts[:disable_snmp_scan] = true
+end
+
+parser.on("--disable-service-identification (optional)") do
+  opts[:disable_service_identification] = true
+end
+
+parser.on("--smb-user USER (optional)") do |x|
+  opts[:smb_user] = x
+end
+
+parser.on("--smb-pass PASS (optional)") do |x|
+  opts[:smb_pass] = x
+end
+
+parser.on("--smb-domain DOMAIN (optional)") do |x|
+  opts[:smb_domain] = x
+end
+
+parser.on("--dry-run (optional)") do
+  opts[:dry_run] = true
+end
+
+parser.on("--single-scan (optional)") do
+  opts[:single_scan] = true
+end
+
+parser.on("--fast-detect (optional)") do
+  opts[:fast_detect] = true
+end
+
+parser.on("--help") do
+  $stderr.puts parser
+  exit(1)
+end
+
+parser.separator('')
+parser.parse!(ARGV)
+
+@rpc  = Msf::RPC::Client.new(opts)
+
+if not @rpc.token
+  $stderr.puts "Error: Invalid RPC server options specified"
+  $stderr.puts parser
+  exit(1)
+end
+
+# Provide default values for certain options - If there's no alternative set
+# use the default provided by Pro -- see the documentation.
+project       = opts[:project]  || usage(parser)
+targets       = opts[:targets]  || usage(parser)
+blacklist      = opts[:blacklist]
+speed        = opts[:speed]    || "5"
+extra_ports      = opts[:extra_ports]
+blacklist_ports      = opts[:blacklist_ports]
+custom_ports      = opts[:custom_ports]
+portscan_timeout    = opts[:portscan_timeout]  || 300
+source_port      = opts[:source_port]
+custom_nmap_options    = opts[:custom_nmap_options] ||
+disable_udp_probes    = opts[:disable_udp_probes] || false
+disable_finger_users    = opts[:disable_finger_users] || false
+disable_snmp_scan    = opts[:disable_snmp_scan] || false
+disable_service_identification  = opts[:disable_service_identification] || false
+smb_user      = opts[:smb_user] || ""
+smb_pass      = opts[:smb_pass] || ""
+smb_domain      = opts[:smb_domain] || ""
+single_scan      = opts[:single_scan] || false
+fast_detect      = opts[:fast_detect] || false
+
+# Get the default user from Pro
+user       = @rpc.call("pro.default_admin_user")['username']
+
+# Create the task object with all options
+task     = @rpc.call("pro.start_discover", {
+        'workspace'    => project,
+        'username'     => user,
+        'ips'      => targets,
+        'DS_BLACKLIST_HOSTS'  => blacklist,
+        'DS_PORTSCAN_SPEED'  => speed,
+        'DS_PORTS_EXTRA'  => extra_ports,
+        'DS_PORTS_BLACKLIST'  => blacklist_ports,
+        'DS_PORTS_CUSTOM'  => custom_ports,
+        'DS_PORTSCAN_TIMEOUT'   => portscan_timeout,
+        'DS_PORTSCAN_SOURCE_PORT' => source_port,
+        'DS_CustomNmap'    => custom_nmap_options,
+        'DS_UDP_PROBES'    => disable_udp_probes,
+        'DS_FINGER_USERS'  => disable_finger_users,
+        'DS_SNMP_SCAN'    => disable_snmp_scan,
+        'DS_IDENTIFY_SERVICES'  => disable_service_identification,
+        'DS_SMBUser'    => smb_user,
+        'DS_SMBPass'    => smb_pass,
+        'DS_SMBDomain'    => smb_domain,
+        'DS_SINGLE_SCAN'  => single_scan,
+        'DS_FAST_DETECT'  => fast_detect
+})
+
+puts "DEBUG: Running task with #{task.inspect}"
+
+if not task['task_id']
+  $stderr.puts "[-] Error starting the task: #{task.inspect}"
+  exit(0)
+end
+
+puts "[*] Creating Task ID #{task['task_id']}..."
+while true
+  select(nil, nil, nil, 0.50)
+
+  stat = @rpc.call("pro.task_status", task['task_id'])
+
+  if stat['status'] == 'invalid'
+    $stderr.puts "[-] Error checking task status"
+    exit(0)
+  end
+
+  info = stat[ task['task_id'] ]
+
+  if not info
+    $stderr.puts "[-] Error finding the task"
+    exit(0)
+  end
+
+  if info['status'] == "error"
+    $stderr.puts "[-] Error generating report: #{info['error']}"
+    exit(0)
+  end
+
+  break if info['progress'] == 100
+end
+
+$stdout.puts "[+] Task Complete!"

data/examples/msfrpc_pro_exploit.rb

@@ -0,0 +1,225 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+require 'msfrpc-client'
+require 'rex/ui'
+
+def usage(ropts)
+  $stderr.puts ropts
+
+  if @rpc and @rpc.token
+    wspaces = @rpc.call("pro.workspaces") rescue {}
+    if wspaces.keys.length > 0
+      $stderr.puts "Active Projects:"
+      wspaces.each_pair do |k,v|
+        $stderr.puts "\t#{k}"
+      end
+    end
+  end
+  $stderr.puts ""
+  exit(1)
+end
+
+opts = {}
+opts[:blacklist]      = ''
+opts[:whitelist_ports] = ''
+opts[:blacklist_ports] = ''
+opts[:exploit_timeout] = 5
+opts[:limit_sessions] = true
+opts[:ignore_fragile_devices] = true
+opts[:filter_by_os]   = true
+opts[:only_match]     = false
+opts[:match_vulns]    = true
+opts[:match_ports]    = true
+opts[:payload_method] = "auto"
+opts[:payload_type]   = "meterpreter"
+opts[:payload_ports]  = "4000-5000"
+opts[:evasion_level_tcp] = 0
+opts[:evasion_level_app] = 0
+opts[:module_filter] = ''
+
+# Parse script-specific options
+parser = Msf::RPC::Client.option_parser(opts)
+parser.separator('Exploit Specific Options:')
+
+parser.on("--project PROJECT") do |x|
+  opts[:project] = x
+end
+
+parser.on("--targets TARGETS") do |x|
+  opts[:targets] = x
+end
+
+parser.on("--speed SPEED") do |x|
+  opts[:speed] = x
+end
+
+parser.on("--minimum-rank RANK") do |x|
+  opts[:rank] = x
+end
+
+parser.on("--blacklist BLACKLIST (optional)") do |x|
+  opts[:blacklist] = x
+end
+
+parser.on("--whitelist-ports PORTS (optional)") do |x|
+  opts[:whitelist_ports] = x
+end
+
+parser.on("--blacklist-ports PORTS (optional)") do |x|
+  opts[:blacklist_ports] = x
+end
+
+parser.on("--exploit-timeout TIMEOUT (optional)") do |x|
+  opts[:exploit_timeout] = x
+end
+
+parser.on("--limit-sessions (optional)") do |x|
+  opts[:limit_sessions] = (x =~ /^(y|t|1)/i ? true : false )
+end
+
+parser.on("--ignore-fragile-devices (optional)") do |x|
+  opts[:ignore_fragile_devices] = (x =~ /^(y|t|1)/i ? true : false )
+end
+
+parser.on("--filter-by-os (optional)") do |x|
+  opts[:filter_by_os] = (x =~ /^(y|t|1)/i ? true : false )
+end
+
+parser.on("--dry-run (optional)") do |x|
+  opts[:only_match] = (x =~ /^(y|t|1)/i ? true : false )
+end
+
+parser.on("--match-vulns (optional)") do |x|
+  opts[:match_vulns] = (x =~ /^(y|t|1)/i ? true : false )
+end
+
+parser.on("--match-ports (optional)") do |x|
+  opts[:match_ports] = (x =~ /^(y|t|1)/i ? true : false )
+end
+
+parser.on("--payload-method AUTO|REVERSE|BIND (optional)") do |x|
+  opts[:payload_method] = x
+end
+
+parser.on("--payload-type METERPRETER|SHELL (optional)") do |x|
+  opts[:payload_type] = x
+end
+
+parser.on("--payload-ports PORTS (optional)") do |x|
+  opts[:payload_ports] = x
+end
+
+parser.on("--evasion-level-tcp LEVEL (optional)") do |x|
+  opts[:evasion_level_tcp] = x
+end
+
+parser.on("--evasion-level-app LEVEL (optional)") do |x|
+  opts[:evasion_level_app] = x
+end
+
+parser.on("--module-filter FILTER (optional)") do |x|
+  opts[:module_filter] = x
+end
+
+parser.on("--help") do
+  $stderr.puts parser
+  exit(1)
+end
+
+parser.separator('')
+parser.parse!(ARGV)
+
+@rpc  = Msf::RPC::Client.new(opts)
+
+if not @rpc.token
+  $stderr.puts "Error: Invalid RPC server options specified"
+  $stderr.puts parser
+  exit(1)
+end
+
+# Store the user's settings
+project       = opts[:project]  || usage(parser)
+targets       = opts[:targets]  || usage(parser)
+rank        = opts[:rank]    || usage(parser)
+speed        = opts[:speed]    || usage(parser)
+blacklist      = opts[:blacklist]
+whitelist_ports      = opts[:whitelist_ports]
+blacklist_ports      = opts[:blacklist_ports]
+exploit_timeout      = opts[:exploit_timeout]
+limit_sessions      = opts[:limit_sessions]
+ignore_fragile_devices    = opts[:ignore_fragile_devices]
+filter_by_os      = opts[:filter_by_os]
+only_match      = opts[:only_match]
+match_vulns      = opts[:match_vulns]
+match_ports      = opts[:match_ports]
+payload_method      = opts[:payload_method]
+payload_type      = opts[:payload_type]
+payload_ports      = opts[:payload_ports]
+evasion_level_tcp    = opts[:evasion_level_tcp]
+evasion_level_app    = opts[:evasion_level_app]
+module_filter      = opts[:module_filter]
+#===
+
+# Get the default user
+user       = @rpc.call("pro.default_admin_user")['username']
+
+# Create the task object with all options
+task     = @rpc.call("pro.start_exploit", {
+        'workspace'      => project,
+        'username'       => user,
+        'DS_WHITELIST_HOSTS'    => targets,
+        'DS_BLACKLIST_HOSTS'    => blacklist,
+        'DS_WHITELIST_PORTS'      => whitelist_ports,
+        'DS_BLACKLIST_PORTS'    => blacklist_ports,
+        'DS_MinimumRank'     => rank,
+        'DS_EXPLOIT_SPEED'    => speed,
+        'DS_EXPLOIT_TIMEOUT'    => exploit_timeout,
+        'DS_LimitSessions'    => limit_sessions,
+        'DS_IgnoreFragileDevices'   => ignore_fragile_devices,
+        'DS_FilterByOS'      => filter_by_os,
+        'DS_OnlyMatch'      => only_match,
+        'DS_MATCH_VULNS'    => match_vulns,
+        'DS_MATCH_PORTS'    => match_ports,
+        'DS_PAYLOAD_METHOD'    => payload_method,
+        'DS_PAYLOAD_TYPE'    => payload_type,
+        'DS_PAYLOAD_PORTS'    => payload_ports,
+        'DS_EVASION_LEVEL_TCP'    => evasion_level_tcp,
+        'DS_EVASION_LEVEL_APP'    => evasion_level_app,
+        'DS_ModuleFilter'    => module_filter
+})
+
+puts "DEBUG: Running task with #{task.inspect}"
+
+if not task['task_id']
+  $stderr.puts "[-] Error starting the task: #{task.inspect}"
+  exit(0)
+end
+
+puts "[*] Creating Task ID #{task['task_id']}..."
+while true
+  select(nil, nil, nil, 0.50)
+
+  stat = @rpc.call("pro.task_status", task['task_id'])
+
+  if stat['status'] == 'invalid'
+    $stderr.puts "[-] Error checking task status"
+    exit(0)
+  end
+
+  info = stat[ task['task_id'] ]
+
+  if not info
+    $stderr.puts "[-] Error finding the task"
+    exit(0)
+  end
+
+  if info['status'] == "error"
+    $stderr.puts "[-] Error generating report: #{info['error']}"
+    exit(0)
+  end
+
+  break if info['progress'] == 100
+end
+
+$stdout.puts "[+] Task Complete!"