lab 0.0.4 → 0.0.5

data/README

@@ -1,14 +1,15 @@
 This folder contains the libraries necessary to run the lab plugin, and can also be used in a standalone way to automate virtual machines.
 
-==CONCEPTS:
+CONCEPTS:
+=========
 
 The lab provides a clean interface to common vm functions such as start / stop / snapshot / revert and even running system commands or higher-level functions like opening a browser to a specified URL. It's designed so the different VM technologies have a similiar interface, and you can ignore the specifics of the VM tech. The majority of the functionality is implemented in the form of drivers and controllers. Drivers implement the underlying command for each vm software (such as start/stop/revert), and controllers implement the commands which apply to all vms (such as listing all running vms, or cloning a vm). 
 
 If you're interested in porting a vm software (see below), please take a look at the workstation_driver.rb and the workstation_controller.rb -- This is a simple driver / controller in the lab, and you can simply copy / modify this to implement a new driver & controller for the software. 
 
-==SUPPORTED VM TECHNOLOGIES:
-
-NOTE: The lab libraries have only been tested on linux, porting to windows is not planned at this time.
+SUPPORTED VM TECHNOLOGIES:
+==========================
+NOTE: The lab libraries have only been tested with linux as a host, porting to windows is not planned at this time.
 
 Implemented:
  - workstation (Tested against 7.x)
@@ -25,8 +26,8 @@ Need Implementation:
  - qemudo
  - others?
 
-==PLATFORM SUPPORT:
-
+PLATFORM SUPPORT:
+=================
 You will need to have this code running on a linux box, Currently this has only been run / tested on Ubuntu 9.04 -> 10.04, though it should run on any linux with an ssh client and the dependencies below. Remote VM Hosts will need to be linux as well, though other platforms may work (untested). If you're interested in porting it to windows, please contact me (jcran). 
 
 Platform Dependencies:
@@ -34,8 +35,8 @@ Platform Dependencies:
   - net/scp - the gem (net-scp). Required to copy files to/from the devices in the case that tools are not installed. Not necessary if tools are installed. 
   - fog - require to use the amazon_ec2 driver
 
-==STANDALONE API:
-
+STANDALONE API:
+===============
 BACKGROUND:
 
 The lab libraries add tons of useful functionality that isn't exposed through the lab plugin, such as the ability to run commands on hosts. This library can serve as an excellent base for more complex operations on a remote host as well. 
@@ -43,7 +44,7 @@ The lab libraries add tons of useful functionality that isn't exposed through th
 USAGE:
 
 You must first create a yaml file which describes your vm. See data/lab/test_targets.yml for an example.  
-
+<pre>
   require 'vm_controller'
   vm_controller = ::Lab::Controllers::VmController.new(YAML.load_file(lab_def)) 
   vm_controller['vm1'].start
@@ -52,8 +53,9 @@ You must first create a yaml file which describes your vm. See data/lab/test_tar
   vm_controller['vm1'].open_uri("http://autopwn:8080")
   vm_controller['vm1'].revert("clean")
   vm_controller['vm1'].revert("clean")
-
-==METASPLOIT MSFCONSOLE LAB PLUGIN:
+</pre>
+METASPLOIT MSFCONSOLE LAB PLUGIN:
+=================================
 
 BACKGROUND:
 
@@ -62,16 +64,17 @@ The lab plugin for msfconsole adds a number of commands which may be useful if y
 USAGE:
 
 Here's some example usage for the lab plugin. 
-
-  msf> load lab						// Loads the lab plugin
-  msf> lab_load <path_to_lab_file> 			// Loads from a lab configuration file. See data/lab/test_targets.yml for an example
-  msf> lab_load_dir workstation /path/to/vmx/files	// Loads from a local directory.
-  msf> lab_load_running remote_esx root esx_server	// Loads all running vms. 
-  msf> lab_start vm1					// Start a vm which was loaded above
-  msf> lab_snapshot vm1 snapshot_1			// Snapshot a vm as 'snapshot_1'
-  msf> lab_run_command ("rm -rf /")			// oops!
-  msf> lab_show 					// Show all vms that we're aware of
-  msf> lab_show_running					// Show only running vms
-  msf> lab_start vm2					// Start another vm
-  msf> lab_suspend  vm1					// Suspend a vm
-  msf> lab_revert all snapshot_1			// Revert all vms back to 'snapshot_1'
+<pre>
+  msf> load lab                           // Loads the lab plugin
+  msf> lab_load <path_to_lab_file>        // Loads from a lab configuration file. See data/lab/test_targets.yml for an example
+  msf> lab_load_dir workstation /path/to/vmx/files  // Loads from a local directory.
+  msf> lab_load_running remote_esx root esx_server  // Loads all running vms. 
+  msf> lab_start vm1                      // Start a vm which was loaded above
+  msf> lab_snapshot vm1 snapshot_1        // Snapshot a vm as 'snapshot_1'
+  msf> lab_run_command ("rm -rf /")       // oops!
+  msf> lab_show                           // Show all vms that we're aware of
+  msf> lab_show_running                   // Show only running vms
+  msf> lab_start vm2                      // Start another vm
+  msf> lab_suspend  vm1                   // Suspend a vm
+  msf> lab_revert all snapshot_1          // Revert all vms back to 'snapshot_1'
+</pre>

data/lib/lab/version.rb

@@ -1,3 +1,3 @@
 module Lab
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/lab/vm.rb

@@ -196,7 +196,7 @@ class Vm
 	end
 
 	def to_s
-		return "#{@vmid}"
+		return "#{@hostname}"
 	end
 
 	def to_yaml

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lab
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-17 00:00:00.000000000 Z
+date: 2012-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &7082080 !ruby/object:Gem::Requirement
+  requirement: &18669540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7082080
+  version_requirements: *18669540
 description: Start/Stop/Revert and do other cool stuff w/ Vmware, Virtualbox, and
   ESXi vms
 email:
@@ -56,7 +56,6 @@ files:
 - lib/lab/drivers.rb
 - lib/lab/modifier/backtrack5_modifier.rb
 - lib/lab/modifier/dos_modifier.rb
-- lib/lab/modifier/meterpreter_modifier.rb
 - lib/lab/modifier/test_modifier.rb
 - lib/lab/modifiers.rb
 - lib/lab/version.rb

data/lib/lab/modifier/meterpreter_modifier.rb

@@ -1,167 +0,0 @@
-$:.unshift(File.join(File.dirname(__FILE__), '..', '..'))
-
-module Lab
-module Modifier
-module Meterpreter
-
-end
-end
-end
-
-
-# This allows us to override the default way of running commands
-# Currently useful for the esx controller
-
-module Lab
-class Vm
-	
-	attr_accessor :framework
-	attr_accessor :session
-	attr_accessor :session_input
-	attr_accessor :session_output
-
-	def create_framework
-		return if @framework
-		@framework    = Msf::Simple::Framework.create
-	end
-	
-	# perform the setup only once
-	def setup_session
-		return if @session
-
-		# require the framework (assumes this sits in lib/lab/modifiers)
-		require 'msf/base'
-
-		create_framework 	## TODO - this should use a single framework 
-					## for all hosts, not one-per-host
-
-		@session 		= nil
-		@session_input        	= Rex::Ui::Text::Input::Buffer.new
-		@session_output       	= Rex::Ui::Text::Output::Buffer.new
-	
-		if @os == "windows"
-			exploit_name = 'windows/smb/psexec'
-
-			# TODO - check for x86, choose the appropriate payload
-
-			payload_name = 'windows/meterpreter/bind_tcp'
-			options = {	"RHOST"		  => @hostname, 
-					        "SMBUser" 	=> @vm_user, 
-					        "SMBPass" 	=> @vm_pass}
-
-      			puts "DEBUG: using options #{options}"
-
-			# Initialize the exploit instance
-			exploit = @framework.exploits.create(exploit_name)
-
-			begin
-				# Fire it off.
-				@session = exploit.exploit_simple(
-					'Payload'     	=> payload_name,
-					'Options'     	=> options,
-					'LocalInput'  	=> @session_input,
-					'LocalOutput' 	=> @session_output)
-				@session.load_stdapi
-				
-				puts "DEBUG: Generated session: #{@session}"
-				
-			rescue  Exception => e 
-  			  puts "DEBUG: Unable to exploit"
-  			  puts e.to_s
-			end
-							
-		else
-			module_name = 'scanner/ssh/ssh_login'
-			
-			# TODO - check for x86, choose the appropriate payload
-			
-			payload_name = 'linux/x86/shell_bind_tcp'
-			options = {	"RHOSTS"		=> @hostname, 
-					"USERNAME" 		=> @vm_user, 
-					"PASSWORD" 		=> @vm_pass, 
-					"BLANK_PASSWORDS" 	=> false, 
-					"USER_AS_PASS" 		=> false, 
-					"VERBOSE" 		=> false}
-
-      			puts "DEBUG: using options #{options}"
-
-			# Initialize the module instance
-			aux = @framework.auxiliary.create(module_name)
-			
-			puts "DEBUG: created module: #{aux}"
-			
-			begin 
-				# Fire it off.
-				aux.run_simple(
-					'Payload'     => payload_name,
-					'Options'     => options,
-					'LocalInput'  => @session_input,
-					'LocalOutput' => @session_output)
-				
-				@session = @framework.sessions.first.last
-				puts "DEBUG: Generated session: #{@session}"
-			rescue Exception => e 
-			  puts "DEBUG: Unable to exploit"
-			  puts e.to_s
-			end
-		end
-		
-
-		
-	end
-
-	def run_command(command, timeout=60)
-		
-		setup_session
-		puts "Using session #{@session}"
-		
-		# TODO: pass the timeout down
-	
-		if @session
-			if @session.type == "shell"
-				puts "Running command via shell: #{command}"		
-				@session.shell_command_token(command, timeout)
-			elsif @session.type == "meterpreter" 
-				puts "Running command via meterpreter: #{command}"		
-				@session.shell_command(command) #, timeout)
-			end
-		else
-			raise "No session"
-		end
-	end
-	
-	
-	# This isn't part of the normal API, but too good to pass up. 
-	def run_script(script, options)
-		if @session.type == "meterpreter"
-			@session.execute_script(script, options)
-		else
-			raise "Unsupported on #{@session.type}"
-		end
-	end
-	
-	# For meterpreter API compatibility
-	#def execute_file(script,options)
-	#	run_script(script,options)
-	#end
-	
-	def copy_to(local,remote)
-		setup_session
-		if @session.type == "meterpreter"
-			@session.run_cmd("upload #{local} #{remote}")
-		else
-			@driver.copy_to(local,remote)
-		end
-	end
-	
-	def copy_from(local, remote)
-		setup_session
-		if @session.type == "meterpreter"
-			@session.run_cmd("download #{local} #{remote}")
-		else
-			@driver.copy_from(local,remote)
-		end
-	end
-	
-end
-end