lab 0.1.5 → 0.2.0

data/src/lib/lab/driver/workstation_vixr_driver.rb

@@ -0,0 +1,126 @@
+require 'vm_driver'
+##
+## $Id$
+##
+
+# This requires rhythmx's vixr driver from https://github.com/rhythmx/vixr 
+# and below that, the VIX api from vmware http://www.vmware.com/support/developer/vix-api/
+
+module Lab
+module Drivers
+
+class WorkstationVixrDriver < VmDriver
+
+  attr_accessor :type
+  attr_accessor :location
+
+  def initialize(vmid, location, os=nil, tools=false, credentials=nil)
+
+    # We have to treat this differently, as it's not in the same tree
+    begin
+      require 'vixr'
+    rescue LoadError
+      puts   "WARNING: Library pro_vixr not found. To resolve this error, please\n" + 
+        "         install the vixr gem. Latest is available here:\n" +
+        "https://github.com/rhythmx/vixr ."
+      raise "Unable to create vixr driver"
+    end
+    
+    @vmid = filter_command(vmid)
+    @location = filter_command(location)
+
+    if !File.exist?(@location)
+      raise ArgumentError,"Couldn't find: " + location
+    end
+
+    @credentials = credentials
+    @tools = tools  # not used in command lines, no filter
+    @os = os  # not used in command lines, no filter
+
+    # TODO - Currently only implemented for the first set
+    if @credentials.count > 0
+      @vm_user = filter_input(@credentials[0]['user']) || "\'\'"
+      @vm_pass = filter_input(@credentials[0]['pass']) || "\'\'"
+    end
+    
+    host = VixR.connect()
+    vm = host.open_vmx(@location)
+    
+  end
+
+  def start
+    vm.power_on
+  end
+
+  def stop
+    vm.power_off
+  end
+
+  def suspend
+    vm.suspend
+  end
+
+  def pause
+    vm.pause
+  end
+
+  def reset
+    vm.reset
+  end
+
+  def create_snapshot(snapshot)
+    snapshot = filter_input(snapshot)
+    system_command("ssh #{@user}@#{@host} vmrun -T ws snapshot \\\'#{@location}\\\' #{snapshot} nogui")
+  end
+
+  def revert_snapshot(snapshot)
+    snapshot = filter_input(snapshot)
+    system_command("ssh #{@user}@#{@host} vmrun -T ws revertToSnapshot \\\'#{@location}\\\' #{snapshot} nogui")
+  end
+
+  def delete_snapshot(snapshot)
+    snapshot = filter_input(snapshot)
+    system_command("ssh #{@user}@#{@host} vmrun -T ws deleteSnapshot \\\'#{@location}\\\' #{snapshot} nogui" )
+  end
+
+
+  def run_command(command)
+    command = filter_input(command)
+    if vm.login(@vm_user,@vm_pass)
+      vm.run_prog(command)
+    end
+  end
+  
+  def copy_from(from, to)
+    from = filter_input(from)
+    to = filter_input(to)
+    cp_from_host(from,to)
+  end
+
+  def copy_to(from, to)
+    from = filter_input(from)
+    to = filter_input(to)
+    vm.cp_to_guest(from,to)
+  end
+
+  def check_file_exists(file)
+    file = filter_input(file)
+    file_exists?(file)
+  end
+
+  def create_directory(directory)
+    directory = filter_input(directory)
+  end
+
+  def cleanup
+
+  end
+
+  def running?
+    vm.running?
+  end
+
+end
+
+end 
+end

data/src/lib/lab/drivers.rb

@@ -0,0 +1,9 @@
+require 'driver/workstation_driver'
+require 'driver/virtualbox_driver'
+require 'driver/fog_driver'
+require 'driver/dynagen_driver'
+require 'driver/remote_workstation_driver'
+require 'driver/remote_esxi_driver'
+require 'driver/vsphere_driver'
+#require 'driver/qemu_driver'
+#require 'driver/qemudo_driver'

data/src/lib/lab/modifier/backtrack5_modifier.rb

@@ -0,0 +1,16 @@
+module Lab
+module Modifier
+module Backtrack5
+
+  def nmap(options)
+    run_command("nmap #{filter_input(options)}")
+  end
+  
+  def testssl(site)
+    run_command("/pentest/scanners/testssl/testssl.sh #{filter_input(site)}")
+  end
+  
+end
+end
+end
+

data/src/lib/lab/modifier/dos_modifier.rb

@@ -0,0 +1,14 @@
+# This assumes you're on a recent ubuntu
+# TODO - enforce this, or split it out...
+
+module Lab
+module Modifier
+module Dos
+
+  def ping(target)
+    run_command("ping #{filter_input(target)}")
+  end
+
+end
+end
+end

data/src/lib/lab/modifier/test_modifier.rb

@@ -0,0 +1,16 @@
+# This assumes you're on a recent ubuntu
+# TODO - enforce this, or split it out...
+
+module Lab
+module Modifier
+module Test
+  def install_nmap
+    run_command("sudo apt-get install nmap")
+  end
+
+  def nmap(options)
+    run_command("nmap #{filter_input(options)}")
+  end
+end
+end
+end

data/src/lib/lab/modifiers.rb

@@ -0,0 +1,3 @@
+require 'modifier/test_modifier'
+require 'modifier/backtrack5_modifier'
+require 'modifier/dos_modifier'	

data/src/lib/lab/version.rb

@@ -0,0 +1,3 @@
+module Lab
+  VERSION = "0.2.0"
+end

data/src/lib/lab/vm.rb

@@ -0,0 +1,269 @@
+#
+module Lab
+
+#
+# This class encapsulates a vm, provides functionality on that vm, and contains a single driver.
+#
+class Vm
+  
+  attr_accessor :vmid
+  attr_accessor :hostname
+  attr_accessor :description
+  attr_accessor :user
+  attr_accessor :host
+  attr_accessor :location
+  attr_accessor :driver
+  attr_accessor :credentials
+  attr_accessor :tools
+  attr_accessor :type
+  attr_accessor :os
+  attr_accessor :arch
+  attr_accessor :tags
+
+  ## Initialize takes a vm configuration hash of the form
+  ##  - vmid (unique id)
+  ##    hostname (unique name)
+  ##    description (describes the vm's contents)
+  ##    driver (vm driver)
+  ##    location (if applicable - local system)
+  ##    user (if applicable - remote system)
+  ##    host (if applicable - remote system)
+  ##    pass (if applicable - remote system) # DISCOURAGED - USE KEYS!
+  ##    tools (true if tools are installed)
+  ##    type ( qa / vulnerable / etc - freeform option)
+  ##    credentials (of the form [ {'user'=>"user",'pass'=>"pass", 'admin' => false}, ... ])
+  ##    os (currently linux / windows / solaris / aix) - may be used in modifiers
+  ##    arch (currently 32 / 64)
+  ##    modifiers - array of strings, can be anything in the modifiers directory
+  ##    tags - array of strings associated with this vm
+  
+  def initialize(config = {})  
+
+    # TODO - This is a mess. clean up, and pass stuff down to drivers
+    # and then rework the code that uses this api. 
+    @vmid = config['vmid'].to_s 
+    raise "Invalid VMID" unless @vmid
+
+    # Grab the hostname if specified, otherwise use the vmid
+    # VMID will be different in the case of ESX
+    @hostname = config['hostname']
+    if !@hostname
+      @hostname = @vmid
+    end
+
+    @driver_type = filter_input(config['driver'])
+    @driver_type.downcase!
+
+    @location = filter_input(config['location'])
+    @description = config['description']
+    @tools = config['tools']
+    @os = config['os']
+    @arch = config['arch']
+    @type = filter_input(config['type']) || "unspecified"
+    @credentials = config['credentials'] || []
+    
+    # TODO - Currently only implemented for the first set
+    if @credentials.count > 0
+      @vm_user = filter_input(@credentials[0]['user']) || "\'\'"
+      @vm_pass = filter_input(@credentials[0]['pass']) || "\'\'"
+      @vm_keyfile = filter_input(@credentials[0]['keyfile'])
+    end
+
+    # Only applicable to remote systems
+    @user = filter_input(config['user']) || nil
+    @host = filter_input(config['host']) || nil
+    @port = filter_input(config['port']) || nil
+    @pass = filter_input(config['pass']) || nil # DISCORAGED, use keys!
+
+    # Only dynagen systems need this
+    @platform = config['platform']
+
+    # Only fog systems need this
+    @fog_config = config['fog_config']
+
+    # Process the correct driver
+    if @driver_type == "workstation"
+      @driver = Lab::Drivers::WorkstationDriver.new(config)
+    elsif @driver_type == "remote_workstation"
+      @driver = Lab::Drivers::RemoteWorkstationDriver.new(config)
+    elsif @driver_type == "virtualbox"
+      @driver = Lab::Drivers::VirtualBoxDriver.new(config)
+    elsif @driver_type == "fog"
+      @driver = Lab::Drivers::FogDriver.new(config, config['fog_config'])
+    elsif @driver_type == "dynagen"
+      @driver = Lab::Drivers::DynagenDriver.new(config, config['dynagen_config'])  
+    elsif @driver_type == "remote_esxi"
+      @driver = Lab::Drivers::RemoteEsxiDriver.new(config)
+    elsif @driver_type == "vsphere"
+      @driver = Lab::Drivers::VsphereDriver.new(config)
+    #elsif @driver_type == "qemu"
+    #  @driver = Lab::Drivers::QemuDriver.new
+    #elsif @driver_type == "qemudo"
+    #  @driver = Lab::Drivers::QemudoDriver.new
+    else
+      raise "Unknown Driver Type"
+    end
+        
+    # Load in a list of modifiers. These provide additional methods
+    # Currently it is up to the user to verify that 
+    # modifiers are properly used with the correct VM image.
+    #
+    # If not, the results are likely to be disasterous.
+    @modifiers = config['modifiers']
+    
+    if @modifiers  
+      begin
+         @modifiers.each { |modifier|  self.class.send(:include, eval("Lab::Modifier::#{modifier}"))}
+      rescue Exception => e
+        # modifier likely didn't exist
+      end
+    end
+    
+    #
+    # Grab a tags array
+    #
+    @tags = config['tags']
+    
+  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)
+    @driver.revert_snapshot(snapshot)
+    @driver.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 "#{@hostname}"
+  end
+
+  def to_yaml
+    
+    # TODO - push this down to the drivers.
+    
+    # Standard configuration options
+    out =  " - vmid: #{@vmid}\n"
+    out += "   hostname: #{@hostname}\n"
+    out += "   driver: #{@driver_type}\n"
+    out += "   description: |\n #{@description}\n"
+    out += "   location: #{@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"
+      out += "   port: #{@port}\n"
+      out += "   pass: #{@pass}\n"
+    end
+
+    if @platform
+      out += "   platform: #{@platform}\n"
+    end
+
+    if @fog_config
+      out += @fog_config.to_yaml
+    end
+
+    if @dynagen_config
+      out += @dynagen_config.to_yaml
+    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 # nil becomes empty string
+    return unless string.class == String # Allow other types
+          
+    unless /^[(!)\d*\w*\s*\[\]\{\}\/\\\.\-\"\(\)]*$/.match string
+      raise "WARNING! Invalid character in: #{string}"
+    end
+
+    string
+  end
+end
+end