lab 0.1.5 → 0.2.0

data/src/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/src/TODO

@@ -0,0 +1,15 @@
+This is a list of basic priorities for the lab code...
+
+* Implement more technologies
+
+ a) finish amazon ec2 (via fog)
+ b) qemu
+ c) qemudo
+ d) kvm
+ e) other cloud technologies (newservers, slicehost/rackspace,etc)
+
+* Implement a cloning function on each controller
+
+* Support Windows as a host platform. Currently all the code assumes a linux host is running it. The same applies for the remote_* drivers -- they've not been tested on windows.
+
+* Consolidate the remote_system_command code & provide a filter. Create an unsafe_system_command and unsafe_remote_system_command function call for when we control the entire string.

data/src/config/test_lab.yml

@@ -0,0 +1,11 @@
+ - vmid: backtrack
+   driver: workstation
+   location: /opt/vm/backtrack5/Backtrack5x64.vmx
+   modifiers:
+     - Test
+   credentials:
+     - user: root
+       pass: toor
+   os: linux
+   flavor: ubuntu
+   arch: 64

data/src/config/test_targets.yml

@@ -0,0 +1,21 @@
+ - vmid: metasploitable
+   driver: workstation
+   location: /opt/vm/lab/user/Metasploitable/Metasploitable.vmx
+   tools: false
+   credentials: 
+     - user: msfadmin
+       pass: msfadmin
+ - vmid: windows2000_target
+   driver: workstation
+   location: /opt/vm/lab/vuln/msf_Win2000SP4/Windows 2000 AS.vmx
+   tools: true
+   credentials: 
+ - vmid: windowsxp_target
+   driver: remote_workstation
+   host: vmhost
+   user: root
+   location: /opt/vm/lab/vuln/msf_WinXPSP1/Windows XP Professional.vmx
+   tools: true
+   credentials: 
+     - user: administrator
+       pass: administrator

data/src/lab.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'lab/version'
+
+Gem::Specification.new do |s|
+  s.name        = "lab"
+  s.version     = Lab::VERSION
+  s.authors     = ["Jonathan Cran"]
+  s.email       = ["jcran@rapid7.com"]
+  s.homepage    = "http://www.github.com/rapid7/lab/wiki"
+  s.summary     = %q{Manage VMs like a boss}
+  s.description = %q{Start/Stop/Revert and do other cool stuff w/ Vmware, Virtualbox, and ESXi vms. This gem wraps common CLI utilities and other gems to create a common inteface for vms. }
+
+  s.rubyforge_project = "lab"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+
+    # ??
+    s.add_runtime_dependency "nokogiri"
+
+    # Multiple things - fallback execute / copy
+    s.add_runtime_dependency "net-ssh"
+    s.add_runtime_dependency "net-scp"
+
+    # Vmware ESX driver
+    s.add_runtime_dependency "rbvmomi"
+    
+end

data/src/lib/lab.rb

@@ -0,0 +1,2 @@
+require 'lab/vm_controller'
+require 'lab/version'

data/src/lib/lab/controller/dynagen_controller.rb

@@ -0,0 +1,14 @@
+module Lab
+module Controllers
+module DynagenController
+
+  def self.running_list
+    raise "Unsupported"
+  end
+
+  def self.dir_list(basepath=nil)
+    raise "Unsupported"
+  end
+end
+end
+end

data/src/lib/lab/controller/fog_controller.rb

@@ -0,0 +1,6 @@
+module Lab
+module Controllers
+module FogController
+end
+end
+end

data/src/lib/lab/controller/remote_esxi_controller.rb

@@ -0,0 +1,62 @@
+# This controller was built against: 
+# VMware ESX Host Agent 4.1.0 build-348481
+
+module Lab
+module Controllers
+module RemoteEsxiController
+    
+  # Note that 3.5 was different (vmware-vim-cmd)
+  VIM_CMD = 'vim-cmd'.freeze
+
+  def self.dir_list(basepath=nil)
+    # Does this method really even make sense for esxi?
+    return "Unsupported :("
+  end
+
+  def self.running_list(user, host)
+    user.gsub!(/(\W)*/, '')
+    host.gsub!(/(\W)*/, '')
+
+    # first get all registered vms
+    registered_vms = self.get_vms(user, host) || []
+    running_vms = []
+
+    # now let's see which ones are running
+    # TODO:  this is ghetto, would be better not to connect repeatedly
+    registered_vms.each do |vm|
+      remote_cmd = "ssh #{user}@#{host} \"#{VIM_CMD} vmsvc/power.getstate #{vm[:id]}\""
+      raw = `#{remote_cmd}`
+      running_vms << vm if raw =~ /Powered on/
+    end
+
+    return running_vms
+  end
+
+private 
+
+  def self.get_vms(user, host)
+    user.gsub!(/(\W)*/, '')
+    host.gsub!(/(\W)*/, '')
+    
+    vms = [] # array of VM hashes
+    remote_cmd = "ssh #{user}@#{host} \"#{VIM_CMD} vmsvc/getallvms | grep ^[0-9] | sed 's/[[:blank:]]\\{3,\\}/ /g'\""
+    raw = `#{remote_cmd}`.split("\n")
+
+    raw.each do |line|
+      # So effing ghetto
+      id_and_name = line.split('[datastore').first
+      id = id_and_name.split(' ').first
+  
+      ## TODO - there's surely a better way to do this.
+      name_array = id_and_name.split(' ')
+      name_array.shift
+      name = name_array.join(' ')
+      vms << {:id => id, :name => name}
+    end
+    
+    return vms
+  end
+  
+end
+end
+end

data/src/lib/lab/controller/remote_workstation_controller.rb

@@ -0,0 +1,22 @@
+module Lab
+module Controllers
+module RemoteWorkstationController
+
+  def self.running_list(user, host)
+    user.gsub!(/(\W)*/, '')
+    host.gsub!(/(\W)*/, '')
+
+    remote_cmd = "ssh #{user}@#{host} \"vmrun list nogui\""
+    vm_list = `#{remote_cmd}`.split("\n")
+    vm_list.shift
+
+    return vm_list
+  end
+
+  def self.dir_list(basepath=nil)
+    vm_list = Find.find(basepath).select { |f| f =~ /\.vmx$/ }
+    return vm_list
+  end
+end
+end
+end

data/src/lib/lab/controller/virtualbox_controller.rb

@@ -0,0 +1,25 @@
+module Lab
+module Controllers
+module VirtualBoxController
+
+  def self.running_list
+    vm_names_and_uuids = `VBoxManage list runningvms`
+    return vm_names_and_uuids.scan(/\"(.*)\" {.*}/).flatten
+  end
+
+  def self.config_list
+    vm_names_and_uuids = `VBoxManage list vms`
+    return vm_names_and_uuids.scan(/\"(.*)\" {.*}/).flatten
+  end
+
+  def self.config_list_uuid
+    vm_names_and_uuids = `VBoxManage list vms`
+    return vm_names_and_uuids.scan(/\".*\" {(.*)}/).flatten
+  end
+    
+  def self.dir_list(basepath=nil)
+    vm_list = Find.find(basepath).select { |f| f =~ /\.xml$/ }
+  end
+end
+end
+end

data/src/lib/lab/controller/vsphere_controller.rb

@@ -0,0 +1,18 @@
+# This controller was built against: 
+# VMware ESX Host Agent 4.1.0 build-348481
+
+module Lab
+module Controllers
+module VsphereController
+
+  def self.dir_list(basepath=nil)
+    return "Unimplemented"
+  end
+  
+  def self.running_list(user, host)
+    return "Unimplemented"
+  end
+  
+end
+end
+end

data/src/lib/lab/controller/workstation_controller.rb

@@ -0,0 +1,17 @@
+module Lab
+module Controllers
+module WorkstationController
+
+  def self.running_list
+    vm_list = `vmrun list`.split("\n")
+    vm_list.shift
+    return vm_list
+  end
+
+  def self.dir_list(basepath=nil)
+    vm_list = Find.find(basepath).select { |f| f =~ /\.vmx$/ }
+    return vm_list
+  end
+end
+end
+end

data/src/lib/lab/controller/workstation_vixr_controller.rb

@@ -0,0 +1,19 @@
+module Lab
+module Controllers
+module WorkstationVixrController
+
+  def self.running_list
+    vm_list = `vmrun list`.split("\n")
+    vm_list.shift
+
+    return vm_list
+  end
+
+  def self.dir_list(basepath=nil)
+    vm_list = Find.find(basepath).select { |f| f =~ /\.vmx$/ }
+
+    return vm_list
+  end
+end
+end
+end

data/src/lib/lab/controllers.rb

@@ -0,0 +1,9 @@
+require 'controller/workstation_controller'
+require 'controller/virtualbox_controller'
+require 'controller/fog_controller'
+require 'controller/dynagen_controller'
+require 'controller/remote_workstation_controller'
+require 'controller/remote_esxi_controller'
+require 'controller/vsphere_controller'
+#require 'controller/qemu_controller'
+#require 'controller/qemudo_controller'

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

@@ -0,0 +1,47 @@
+require 'vm_driver'
+
+#
+# $Id$
+#
+
+#
+# To use this driver, you have to have a lab which is preconfigured. The best / easiest
+# way i've found to to set up a lab is GNS3
+# 
+
+module Lab
+module Drivers
+  class DynagenDriver < VmDriver
+    def initialize(config,dynagen_config)
+      super(config)
+      @running = false
+      @dynagen_platform = filter_command(dynagen_config['dynagen_platform'])
+    end
+
+    def start
+      # TODO - write the location-file to a temp-file 
+      #        and set the autostart property 
+
+      ## start background dynamips process
+      system_command("dynamips -H #{@dynagen_platform} &")
+      system_command("dynagen  #{@location}")
+      @running = true
+    end
+
+    def stop
+      system_command("killall dynagen")
+      @running = false
+    end
+
+    def cleanup
+      `killall dynagen`
+      `killall dynamips`
+      @running = false
+    end
+
+    def running?
+      return @running
+    end
+  end
+end
+end

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

@@ -0,0 +1,104 @@
+require 'vm_driver'
+
+##
+## $Id$
+##
+
+module Lab
+module Drivers
+class FogDriver < VmDriver
+
+  def initialize(config,fog_config)
+    
+    super(config)
+    @fog_config = fog_config
+
+    # Soft dependency
+    begin
+      require 'fog'
+    rescue LoadError
+      raise "WARNING: Library fog not found. Could not create driver"
+    end
+
+    if @fog_config['fog_type'] == "ec2"
+
+      # AWS / EC2 Base Credential Configuration
+      @aws_cert_file = IO.read(fog_config['fog_aws_cert_file']).chomp if fog_config['fog_aws_cert_file']
+      @aws_private_key_file = IO.read(fog_config['fog_aws_private_key_file']).chomp if fog_config['fog_aws_private_key_file']
+      @ec2_access_key_file = IO.read(fog_config['fog_ec2_access_key_file']).chomp if fog_config['fog_ec2_access_key_file']
+      @ec2_secret_access_key_file = IO.read(fog_config['fog_ec2_secret_access_key_file']).chomp if fog_config['fog_ec2_secret_access_key_file']
+      
+      # Instance Keys
+      @ec2_instance_public_key_file = IO.read(fog_config['fog_ec2_instance_public_key_file']).chomp if fog_config['fog_ec2_instance_public_key_file']
+      @ec2_instance_private_key_file = IO.read(fog_config['fog_ec2_instance_private_key_file']).chomp if fog_config['fog_ec2_instance_private_key_file']
+      
+      # Instance Details
+      @ec2_base_ami = fog_config['fog_ec2_base_ami']
+      @ec2_flavor = fog_config['fog_ec2_flavor']
+      @ec2_user = fog_config['fog_ec2_user']
+      @ec2_region = fog_config['fog_ec2_region']
+          
+      # Set up a connection
+      @compute = Fog::Compute.new(
+        :provider => "Aws",
+        :aws_access_key_id => @aws_access_key_file,
+        :aws_secret_access_key => @aws_secret_access_key_file )
+    else
+      raise "Unsupported fog type"
+    end
+  end
+
+  def start
+    ec2_settings = {
+      :image_id => @ec2_base_ami,
+      :flavor_id =>  @ec2_flavor,
+      :public_key_path => @ec2_instance_public_key_file,
+      :private_key_path => @ec2_instance_private_key_file,
+      :username => @ec2_user}
+    begin
+      @fog_server = @compute.servers.bootstrap(ec2_settings)
+    rescue Fog::Compute::AWS::Error => e
+      raise "Couldn't authenticate to AWS - did you place keys in the creds/ directory?"
+      exit
+    end
+  end
+
+  def stop
+    @fog_server.destroy
+  end
+
+  def suspend
+    raise "unimplemented"
+  end
+
+  def pause
+    raise "unimplemented"
+  end
+
+  def reset
+    raise "unimplemented"
+  end
+
+  def create_snapshot(snapshot)
+    raise "unimplemented"
+  end
+
+  def revert_snapshot(snapshot)
+    raise "unimplemented"
+  end
+
+  def delete_snapshot(snapshot)
+    raise "unimplemented"
+  end
+
+  def cleanup
+    @fog_server.destroy
+  end
+
+  def running?
+    return true #TODO
+  end
+
+end
+end 
+end