lab 0.2.2 → 0.2.3

data/config/test_lab.yml

@@ -6,6 +6,67 @@
    credentials:
      - user: root
        pass: toor
+       admin: true
    os: linux
    flavor: ubuntu
    arch: 64
+ - vmid: backtrack_remote
+   driver: remote_workstation
+   user: root
+   host: vmhost
+   modifiers:
+     - Test
+   credentials:
+     - user: root
+       pass: toor
+       admin: true
+   os: linux
+   flavor: ubuntu
+   arch: 64
+###
+#  Windows XP SP3 - Browser Autopwn Target
+###
+ - vmid: 222
+   hostname: xp
+   description: Windows XP SP3 - Browser Autopwn Target
+   driver: remote_esxi
+   user: root
+   host: vmhost1
+   type: target
+   arch: 32
+   os: linux
+   credentials:
+    - user: msfadmin
+      pass: msfadmin
+      admin: true
+   tags:
+    - ie6
+    - ie7
+    - ie8
+    - firefox
+    - java
+    - flash
+    - quicktime
+###
+#  Windows 7 SP1
+###
+ - vmid: 1111
+   hostname: win7
+   description: Windows 7 SP1 - Browser Autopwn Target
+   driver: remote_esxi
+   user: root
+   host: vmhost1
+   pass: whatever
+   type: target
+   arch: 32
+   os: linux
+   credentials:
+    - user: msfadmin
+      pass: msfadmin
+      admin: true
+   tags:
+    - ie8
+    - firefox
+    - java
+    - flash
+    - quicktime

data/lab.gemspec

@@ -31,5 +31,8 @@ Gem::Specification.new do |s|
 
     # Vmware vsphere driver
     s.add_runtime_dependency "rbvmomi"
-    
+
+    # util/console.rb
+    s.add_runtime_dependency "pry"
+
 end

data/lib/lab/controller/vsphere_controller.rb

@@ -3,58 +3,14 @@
 
 module Lab
 module Controllers
-module RemoteEsxiController
-    
-  # Note that 3.5 was different (vmware-vim-cmd)
-  VIM_CMD = 'vim-cmd'.freeze
+module VsphereController
 
   def self.dir_list(basepath=nil)
     # Does this method really even make sense for esxi?
-    return "Unsupported :("
+    return "Unimplemented"
   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

data/lib/lab/driver/vsphere_driver.rb

@@ -15,7 +15,7 @@ class VsphereDriver < VmDriver
   def initialize(config)
     unless config['user'] then raise ArgumentError, "Must provide a username" end
     unless config['host'] then raise ArgumentError, "Must provide a hostname" end
-    unless config[''] then raise ArgumentError, "Must provide a password" end
+    unless config['pass'] then raise ArgumentError, "Must provide a password" end
     super(config)
 
     @user = filter_command(config['user'])
@@ -28,7 +28,7 @@ class VsphereDriver < VmDriver
       raise "WARNING: Library rbvmomi not found. Could not create driver!"
     end
 
-    vim = RbVmomi::VIM.connect host: @host, user: @user, password: @pass
+    vim = RbVmomi::VIM.connect host: @host, user: @user, password: @pass, insecure: true
     dc = vim.serviceInstance.find_datacenter("datacenter1") or fail "datacenter not found"
     @vm = dc.find_vm("test") or fail "VM not found"
   end

data/lib/lab/version.rb

@@ -1,3 +1,3 @@
 module Lab
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/lab/vm_controller.rb

@@ -35,7 +35,7 @@ module Controllers
     include Lab::Controllers::FogController
     include Lab::Controllers::DynagenController 
     include Lab::Controllers::RemoteEsxiController
-    include Lab::Controllers::VsphereDriver
+    include Lab::Controllers::VsphereController
     #include Lab::Controllers::QemuController 
     #include Lab::Controllers::QemudoController 
     def initialize (labdef=nil)
@@ -62,15 +62,19 @@ module Controllers
 
     def find_by_vmid(search)
       @vms.each do |vm|
-        return vm if vm.hostname.to_s.downcase == search.to_s.downcase
+        return vm if vm.hostname == search
       end
-      return nil
+    nil
+    end
+
+    def find_by_hostname(search)
+      self.find_by_vmid search
     end
 
     def find_by_tag(search)
       @vms.each do |vm|
         vm.tags.each do |tag| 
-          return vm if tag.downcase == search.to_s.downcase
+          return vm if tag == search
         end
       end
       return nil
@@ -121,6 +125,13 @@ module Controllers
     false
     end
 
+    def includes_hostname?(hostname)
+      @vms.each do |vm|
+        return true if (vm.hostname == hostname)
+      end
+    false
+    end
+
     #
     # Build a vm lab from a directory of files. Really only useful for file-based
     # vm hosts. (vmware workstation)

data/util/console.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'pry'
+require "#{File.expand_path(File.dirname(__FILE__))}/../lib/lab/vm_controller"
+
+@controller = Lab::Controllers::VmController.new
+@controller.from_file("#{File.expand_path(File.dirname(__FILE__))}/../config/test_lab.yml")
+
+ENV['SSL_CERT_FILE'] = "/home/jcran/.cacert.pem"
+
+Pry.start(self, :prompt => [proc{"lab (@controller) >"}])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lab
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &21345740 !ruby/object:Gem::Requirement
+  requirement: &16389100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21345740
+  version_requirements: *16389100
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &21329820 !ruby/object:Gem::Requirement
+  requirement: &16388080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21329820
+  version_requirements: *16388080
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &21328760 !ruby/object:Gem::Requirement
+  requirement: &16372100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21328760
+  version_requirements: *16372100
 - !ruby/object:Gem::Dependency
   name: rbvmomi
-  requirement: &21328000 !ruby/object:Gem::Requirement
+  requirement: &16371000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21328000
+  version_requirements: *16371000
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &16370260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *16370260
 description: ! '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. '
@@ -101,41 +112,8 @@ files:
 - lib/lab/version.rb
 - lib/lab/vm.rb
 - lib/lab/vm_controller.rb
-- src/Gemfile
-- src/Rakefile
-- src/TODO
-- src/config/test_lab.yml
-- src/config/test_targets.yml
-- src/lab.gemspec
-- src/lib/lab.rb
-- src/lib/lab/controller/dynagen_controller.rb
-- src/lib/lab/controller/fog_controller.rb
-- src/lib/lab/controller/remote_esxi_controller.rb
-- src/lib/lab/controller/remote_workstation_controller.rb
-- src/lib/lab/controller/virtualbox_controller.rb
-- src/lib/lab/controller/vsphere_controller.rb
-- src/lib/lab/controller/workstation_controller.rb
-- src/lib/lab/controller/workstation_vixr_controller.rb
-- src/lib/lab/controllers.rb
-- src/lib/lab/driver/dynagen_driver.rb
-- src/lib/lab/driver/fog_driver.rb
-- src/lib/lab/driver/remote_esxi_driver.rb
-- src/lib/lab/driver/remote_workstation_driver.rb
-- src/lib/lab/driver/virtualbox_driver.rb
-- src/lib/lab/driver/vm_driver.rb
-- src/lib/lab/driver/vsphere_driver.rb
-- src/lib/lab/driver/workstation_driver.rb
-- src/lib/lab/driver/workstation_vixr_driver.rb
-- src/lib/lab/drivers.rb
-- src/lib/lab/modifier/backtrack5_modifier.rb
-- src/lib/lab/modifier/dos_modifier.rb
-- src/lib/lab/modifier/test_modifier.rb
-- src/lib/lab/modifiers.rb
-- src/lib/lab/version.rb
-- src/lib/lab/vm.rb
-- src/lib/lab/vm_controller.rb
-- src/test/.gitkeep
 - test/.gitkeep
+- util/console.rb
 homepage: http://www.github.com/rapid7/lab/wiki
 licenses: []
 post_install_message: 

data/src/Gemfile

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

data/src/Rakefile

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

data/src/TODO

@@ -1,15 +0,0 @@
-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

@@ -1,11 +0,0 @@
- - 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

@@ -1,21 +0,0 @@
- - 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

@@ -1,35 +0,0 @@
-# -*- 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/controller/dynagen_controller.rb

@@ -1,14 +0,0 @@
-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

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

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

@@ -1,62 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

@@ -1,18 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,47 +0,0 @@
-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