lab 0.1.5 → 0.2.0

data/lib/lab/vm_controller.rb

@@ -26,216 +26,222 @@ require 'net/ssh'
 
 module Lab
 module Controllers
-	class VmController 
-
-		include Enumerable
-		include Lab::Controllers::WorkstationController 	
-		include Lab::Controllers::VirtualBoxController 
-		include Lab::Controllers::FogController
-		include Lab::Controllers::DynagenController 
-		include Lab::Controllers::RemoteEsxController
-		include Lab::Controllers::RemoteWorkstationController 	
-		#include Lab::Controllers::QemuController 
-		#include Lab::Controllers::QemudoController 
-		def initialize (labdef=nil)
-			
-			# Start with an empty array of vm objects
-			@vms = [] 
-
-			# labdef is a just a big array of hashes
-			load_vms(labdef) if labdef
-		end
-		
-		def clear!
-			@vms = []
-		end
-
-		def [](x)
-			# Support indexing by both names and number
-			if x.class == String
-				find_by_vmid(x)
-			else
-				return @vms[x]
-			end
-		end
-
-		def find_by_vmid(vmid)
-			@vms.each do |vm|
-				if (vm.hostname.to_s.downcase == vmid.to_s.downcase)
-					return vm
-				end
-			end
-			return nil
-		end
-
-		def add_vm(vmid, location=nil, os=nil, tools=nil, credentials=nil, user=nil, host=nil)			
-			@vms << Vm.new( {	'vmid' => vmid, 
-						'driver' => type, 
-						'location' => location, 
-						'credentials' => credentials,
-						'user' => user,
-						'host' => host} )
-		end
-
-		def remove_by_vmid(vmid)
-			@vms.delete(self.find_by_vmid(vmid))
-		end	
-
-		def from_file(file)
-			load_vms(YAML::load_file(file))
-		end
-
-		def load_vms(vms)
-			vms.each do |item|
-				vm = Vm.new(item)
-				@vms << vm unless includes_vmid? vm.vmid
-			end
-		end
-
-		def to_file(file)
-			File.open(file, 'w') { |f| @vms.each { |vm| f.puts vm.to_yaml } } 
-		end
-
-		def each &block
-			@vms.each { |vm| yield vm }
-		end
-
-		def includes?(specified_vm)
-			@vms.each { |vm| if (vm == specified_vm) then return true end  }
-		end
-
-		def includes_vmid?(vmid)
-			@vms.each do |vm|
-				return true if (vm.vmid == vmid)
-			end
-		false
-		end
-
-		def build_from_dir(driver_type, dir, clear=false)
-		
-			if clear
-				@vms = []
-			end
-
-			if driver_type.downcase == "workstation"
-				vm_list = ::Lab::Controllers::WorkstationController::dir_list(dir)
-			elsif driver_type.downcase == "virtualbox"	
-				vm_list = ::Lab::Controllers::VirtualBoxController::dir_list(dir)
-			elsif driver_type.downcase == "fog"
-				vm_list = ::Lab::Controllers::FogController::dir_list(dir)
-			elsif driver_type.downcase == "Dynagen"	
-				vm_list = ::Lab::Controllers::DynagenController::dir_list(dir)
-			elsif driver_type.downcase == "remote_workstation"	
-				vm_list = ::Lab::Controllers::RemoteWorkstationController::dir_list(dir)
-			elsif driver_type.downcase == "remote_esx"
-				vm_list =::Lab::Controllers::RemoteEsxController::dir_list(dir)
-			else
-				raise TypeError, "Unsupported VM Type"
-			end
-			
-			vm_list.each_index do |index|
-				@vms << Vm.new( {'vmid' => "vm_#{index}", 'driver' => driver_type, 'location' => vm_list[index]} )
-			end
-		end
-
-		def build_from_running(driver_type=nil, user=nil, host=nil, clear=false)
-		
-			if clear
-				@vms = []
-			end
-
-			case driver_type.intern
-				when :workstation
-					vm_list = ::Lab::Controllers::WorkstationController::running_list
-					
-					vm_list.each do |item|
-			
-						## Name the VM
-						index = @vms.count + 1
-	
-						## Add it to the vm list
-						@vms << Vm.new( {	'vmid' => "vm_#{index}",
-									'driver' => driver_type, 
-									'location' => item, 
-									'user' => user,
-									'host' => host } )
-					end
-					
-					
-				when :virtualbox
-					vm_list = ::Lab::Controllers::VirtualBoxController::running_list
-					vm_list.each do |item|
-						## Add it to the vm list
-						@vms << Vm.new( {	'vmid' => "#{item}",
-									'driver' => driver_type,
-									'location' => nil })
-					end
-				when :fog
-					raise "Unsupported" # TODO - figure out a way to allow this
-				when :dynagen
-					raise "Unsupported"
-				when :remote_workstation
-					vm_list = ::Lab::Controllers::RemoteWorkstationController::running_list(user, host)
-					
-					vm_list.each do |item|
-			
-						## Name the VM
-						index = @vms.count + 1
-	
-						## Add it to the vm list
-						@vms << Vm.new( {	'vmid' => "vm_#{index}",
-									'driver' => driver_type, 
-									'location' => item, 
-									'user' => user,
-									'host' => host } )
-					end
-				when :remote_esx
-					vm_list = ::Lab::Controllers::RemoteEsxController::running_list(user,host)
-					
-					vm_list.each do |item|
-						@vms << Vm.new( {	'vmid' => "#{item[:id]}",
-									'name' => "#{item[:name]}",
-									'driver' => driver_type, 
-									'user' => user,
-									'host' => host } )
-					end
-						
-				else
-					raise TypeError, "Unsupported VM Type"
-				end
-
-		end	
-
-		def build_from_config(driver_type=nil, user=nil, host=nil, clear=false)
-			if clear
-				@vms = []
-			end
-
-			case driver_type.intern
-				when :virtualbox
-					vm_list = ::Lab::Controllers::VirtualBoxController::config_list
-					
-					vm_list.each do |item|
-						## Add it to the vm list
-						@vms << Vm.new( {	'vmid' => "#{item}",
-									'driver' => driver_type, 
-									'location' => nil, 
-									'user' => user,
-									'host' => host } )
-					end
-						
-				else
-					raise TypeError, "Unsupported VM Type"
-				end
-
-		end	
-
-		def running?(vmid)
-			if includes_vmid?(vmid)
-				return self.find_by_vmid(vmid).running?
-			end
-			return false 
-		end
-	end
+  class VmController 
+
+    include Enumerable
+    include Lab::Controllers::WorkstationController   
+    include Lab::Controllers::VirtualBoxController 
+    include Lab::Controllers::FogController
+    include Lab::Controllers::DynagenController 
+    include Lab::Controllers::RemoteEsxiController
+    include Lab::Controllers::RemoteWorkstationController   
+    #include Lab::Controllers::QemuController 
+    #include Lab::Controllers::QemudoController 
+    def initialize (labdef=nil)
+      
+      # Start with an empty array of vm objects
+      @vms = [] 
+
+      # labdef is a just a big array of hashes
+      load_vms(labdef) if labdef
+    end
+    
+    def clear!
+      @vms = []
+    end
+
+    def [](x)
+      # Support indexing by both names and number
+      if x.class == String
+        find_by_vmid(x)
+      else
+        return @vms[x]
+      end
+    end
+
+    def find_by_vmid(vmid)
+      @vms.each do |vm|
+        if (vm.hostname.to_s.downcase == vmid.to_s.downcase)
+          return vm
+        end
+      end
+      return nil
+    end
+
+    def add_vm(vmid, location=nil, os=nil, tools=nil, credentials=nil, user=nil, host=nil)      
+      @vms << Vm.new( {  
+        'vmid' => vmid, 
+        'driver' => type, 
+        'location' => location, 
+        'credentials' => credentials,
+        'user' => user,
+        'host' => host} )
+    end
+
+    def remove_by_vmid(vmid)
+      @vms.delete(self.find_by_vmid(vmid))
+    end  
+
+    def from_file(file)
+      load_vms(YAML::load_file(file))
+    end
+
+    def load_vms(vms)
+      vms.each do |item|
+        vm = Vm.new(item)
+        @vms << vm unless includes_vmid? vm.vmid
+      end
+    end
+
+    def to_file(file)
+      File.open(file, 'w') { |f| @vms.each { |vm| f.puts vm.to_yaml } } 
+    end
+
+    def each &block
+      @vms.each { |vm| yield vm }
+    end
+
+    def includes?(specified_vm)
+      @vms.each { |vm| if (vm == specified_vm) then return true end  }
+    end
+
+    def includes_vmid?(vmid)
+      @vms.each do |vm|
+        return true if (vm.vmid == vmid)
+      end
+    false
+    end
+
+    def build_from_dir(driver_type, dir, clear=false)
+    
+      if clear
+        @vms = []
+      end
+
+      if driver_type.downcase == "workstation"
+        vm_list = ::Lab::Controllers::WorkstationController::dir_list(dir)
+      elsif driver_type.downcase == "virtualbox"  
+        vm_list = ::Lab::Controllers::VirtualBoxController::dir_list(dir)
+      elsif driver_type.downcase == "fog"
+        vm_list = ::Lab::Controllers::FogController::dir_list(dir)
+      elsif driver_type.downcase == "Dynagen"  
+        vm_list = ::Lab::Controllers::DynagenController::dir_list(dir)
+      elsif driver_type.downcase == "remote_workstation"  
+        vm_list = ::Lab::Controllers::RemoteWorkstationController::dir_list(dir)
+      elsif driver_type.downcase == "remote_esxi"
+        vm_list =::Lab::Controllers::RemoteEsxiController::dir_list(dir)
+      else
+        raise TypeError, "Unsupported VM Type"
+      end
+      
+      vm_list.each_index do |index|
+        @vms << Vm.new( {'vmid' => "vm_#{index}", 'driver' => driver_type, 'location' => vm_list[index]} )
+      end
+    end
+
+    def build_from_running(driver_type=nil, user=nil, host=nil, clear=false)
+    
+      if clear
+        @vms = []
+      end
+
+      case driver_type.intern
+        when :workstation
+          vm_list = ::Lab::Controllers::WorkstationController::running_list
+          
+          vm_list.each do |item|
+      
+            ## Name the VM
+            index = @vms.count + 1
+  
+            ## Add it to the vm list
+            @vms << Vm.new( {  
+              'vmid' => "vm_#{index}",
+              'driver' => driver_type, 
+              'location' => item, 
+              'user' => user,
+              'host' => host } )
+          end
+          
+          
+        when :virtualbox
+          vm_list = ::Lab::Controllers::VirtualBoxController::running_list
+          vm_list.each do |item|
+            ## Add it to the vm list
+            @vms << Vm.new( {  
+              'vmid' => "#{item}",
+              'driver' => driver_type,
+              'location' => nil })
+          end
+        when :fog
+          raise "Unsupported" # TODO - figure out a way to allow this
+        when :dynagen
+          raise "Unsupported"
+        when :remote_workstation
+          vm_list = ::Lab::Controllers::RemoteWorkstationController::running_list(user, host)
+          
+          vm_list.each do |item|
+      
+            ## Name the VM
+            index = @vms.count + 1
+  
+            ## Add it to the vm list
+            @vms << Vm.new( {  
+              'vmid' => "vm_#{index}",
+              'driver' => driver_type, 
+              'location' => item, 
+              'user' => user,
+              'host' => host } )
+          end
+        when :remote_esxi
+          vm_list = ::Lab::Controllers::RemoteEsxiController::running_list(user,host)
+          
+          vm_list.each do |item|
+            @vms << Vm.new( {  
+              'vmid' => "#{item[:id]}",
+              'name' => "#{item[:name]}",
+              'driver' => driver_type, 
+              'user' => user,
+              'host' => host } )
+          end
+            
+        else
+          raise TypeError, "Unsupported VM Type"
+        end
+
+    end  
+
+    def build_from_config(driver_type=nil, user=nil, host=nil, clear=false)
+      if clear
+        @vms = []
+      end
+
+      case driver_type.intern
+        when :virtualbox
+          vm_list = ::Lab::Controllers::VirtualBoxController::config_list
+          
+          vm_list.each do |item|
+            ## Add it to the vm list
+            @vms << Vm.new( {  
+              'vmid' => "#{item}",
+              'driver' => driver_type, 
+              'location' => nil, 
+              'user' => user,
+              'host' => host } )
+          end
+            
+        else
+          raise TypeError, "Unsupported VM Type"
+        end
+
+    end  
+
+    def running?(vmid)
+      if includes_vmid?(vmid)
+        return self.find_by_vmid(vmid).running?
+      end
+      return false 
+    end
+  end
 end
 end

data/src/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in lab.gemspec
+gemspec

data/src/README.md

@@ -0,0 +1,80 @@
+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:
+=========
+
+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 with linux as a host, porting to windows is not planned at this time.
+
+Implemented:
+ - workstation (Tested against 7.x)
+ - remote_workstation (Tested against 7.x)
+ - virtualbox (Tested against 4.x)
+ - remote_esx (VMware ESX Host Agent 4.1.0 build-348481)
+
+Partially Implemented:
+ - amazon_ec2 (via fog gem)
+ - dynagen
+
+Need Implementation:
+ - qemu
+ - qemudo
+ - others?
+
+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:
+  - whatever vm software is necessary for the driver you're using (see SUPPORTED VM TECHNOLOGIES above)
+  - 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:
+===============
+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. 
+
+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
+  vm_controller['vm1'].snapshot("clean") 
+  vm_controller['vm1'].run_command("rm /etc/resolv.conf")
+  vm_controller['vm1'].open_uri("http://autopwn:8080")
+  vm_controller['vm1'].revert("clean")
+  vm_controller['vm1'].revert("clean")
+</pre>
+METASPLOIT MSFCONSOLE LAB PLUGIN:
+=================================
+
+BACKGROUND:
+
+The lab plugin for msfconsole adds a number of commands which may be useful if you're interested in automating remote hosts with rc scripts, or if you need to control targets / support systems while utilizing the metasploit console. A potential use case is testing an IPS / IDS, and resetting the target after running each exploit. 
+
+USAGE:
+
+Here's some example usage for the lab plugin. 
+<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>