metasploit-framework/lib/lab/vm.rb

##
## $Id$
##

require 'workstation_driver'
require 'workstation_vixr_driver'
require 'remote_workstation_driver'
require 'virtualbox_driver'
require 'dynagen_driver'
#require 'fog_amazon_driver'
#require 'amazon_driver'
#require 'qemu_driver'
#require 'qemudo_driver'


module Lab
class Vm
	
	attr_accessor :vmid
	attr_accessor :location
	attr_accessor :driver
	attr_accessor :credentials
	attr_accessor :tools
	attr_accessor :type
	attr_accessor :user
	attr_accessor :host
	attr_accessor :os
	attr_accessor :arch

	## Initialize takes a vm configuration hash of the form
	##  - vmid (unique identifier)
	##    driver (vm technology)
	##    user (if applicable - remote system)
	##    host (if applicable - remote system)
	##    location (file / uri)
	##    credentials (of the form [ {'user'=>"user",'pass'=>"pass", 'admin' => false}, ... ])
	##    os (currently only linux / windows)
	##    arch (currently only 32 / 64
	def initialize(config = {})	

		# Mandatory
		@vmid = config['vmid'] 
		raise "Invalid VMID" unless @vmid

		@driver = nil
		@driver_type = filter_input(config['driver'])
		@driver_type.downcase!
		 
		@type = filter_input(config['type']) || "unspecified"
		@tools = config['tools'] || false # don't filter this, not used in cmdlines
		@os = config['os'] || nil				
		@arch = config['arch']	|| nil	
		@credentials = config['credentials'] || []

		# Optional for virtualbox
		@location = filter_input(config['location'])

		# Only applicable to remote systems
		@user = filter_input(config['user']) || nil
		@host = filter_input(config['host']) || nil

		#Only dynagen
		@platform = config['platform']

		#puts "DEBUG: " + driver_type + " driver requested."

		if @driver_type == "workstation"
			@driver = Lab::Drivers::WorkstationDriver.new(@vmid, @location, @os, @tools, @credentials)
		elsif @driver_type == "workstation_vixr"
			@driver = Lab::Drivers::WorkstationVixrDriver.new(@vmid, @location, @os, @tools, @user, @host, @credentials)	
		elsif @driver_type == "remote_workstation"
			@driver = Lab::Drivers::RemoteWorkstationDriver.new(@vmid, @location, @os, @tools, @user, @host, @credentials)	
		elsif @driver_type == "virtualbox"
			@driver = Lab::Drivers::VirtualBoxDriver.new(@vmid, @location, @credentials)
		elsif @driver_type == "dynagen"
			@driver = Lab::Drivers::DynagenDriver.new(@vmid, @location,@platform)	
		#elsif @driver_type == "fog_amazon"
		#	@driver = Lab::Drivers::FogAmazonDriver.new
		#elsif @driver_type == "qemu"
		#	@driver = Lab::Drivers::QemuDriver.new	
		#elsif @driver_type == "qemudo"
		#	@driver = Lab::Drivers::QemudoDriver.new	
		#elsif @driver_type == "amazon"
		#	@driver = Lab::Drivers::AmazonDriver.new	
		else
			raise "Unknown Driver Type"
		end
	end
	
	def running?
		@driver.running?
	end

	def location
		@driver.location
	end

	def start
		@driver.start
	end

	def stop
		@driver.stop
	end

	def pause
		@driver.pause
	end

	def suspend
		@driver.suspend
	end
	
	def reset
		@driver.reset
	end
	
	def resume
		@driver.resume
	end

	def create_snapshot(snapshot)
		@driver.create_snapshot(snapshot)
	end

	def revert_snapshot(snapshot)
		@driver.revert_snapshot(snapshot)
	end

	def delete_snapshot(snapshot)
		@driver.delete_snapshot(snapshot)
	end

	def revert_and_start(snapshot)
		self.revert_snapshot(snapshot)
		self.start
	end

	def copy_to(from,to)
		@driver.copy_to(from,to)
	end
	
	def copy_from(from,to)
		@driver.copy_from(from,to)
	end
	
	def run_command(command)
		@driver.run_command(command)
	end

	def check_file_exists(file)
		@driver.check_file_exists(file)
	end
	
	def create_directory(directory)
		@driver.create_directory(directory)
	end

	def open_uri(uri)
		# we don't filter the uri, as it's getting tossed into a script 
		# by the driver
		if @os == "windows"
			command = "\"C:\\program files\\internet explorer\\iexplore.exe\" #{uri}"
		else
			command = "firefox #{uri}"
		end

		@driver.run_command(command)
	end

	def to_s
		return "#{@vmid}: #{@location}"
	end

	def to_yaml
		out =  " - vmid: #{@vmid}\n"
		out += "   driver: #{@driver_type}\n"
		out += "   location: #{@driver.location}\n"
		out += "   type: #{@type}\n"
		out += "   tools: #{@tools}\n"
		out += "   os: #{@os}\n"
		out += "   arch: #{@arch}\n"
		if @user or @host # Remote vm/drivers only
			out += "   user: #{@user}\n"
			out += "   host: #{@host}\n"
		end

		out += "   credentials:\n"
		@credentials.each do |credential|		
			out += "     - user: #{credential['user']}\n"
			out += "       pass: #{credential['pass']}\n"
		end
		
	 	return out
	end
private

	def filter_input(string)
		return unless string
					
		if !(string =~ /^[\d*\w*\s*\[\]\{\}\/\\\.\-\"\(\)]*$/)
			raise "WARNING! Invalid character in: #{string}"
		end

		string
	end
end
end