lab 0.2.5 → 0.2.6

data/README.md

@@ -12,16 +12,20 @@ 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)
+
+- 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
+
+- amazon_ec2 (via fog gem)
+- dynagen
+- vsphere
 
 Need Implementation:
+
  - qemu
  - qemudo
  - others?
@@ -31,9 +35,18 @@ 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
+
+Currently the gem must be run on a linux host with access to the vm
+tech you're automating. For instance, if you want to automate a
+workstation VM, you'll need to run the lab code on the Linux VMWare
+Workstation Host. You can work around this by using the
+remote_workstation driver, which shells (using ssh) into the remote host
+and runs the commands. Note that both systems must be running linux. 
+
+CONFIGURING:
+============
+
+Take a look at the example configuration files in config/.
 
 STANDALONE API:
 ===============
@@ -48,11 +61,10 @@ You must first create a yaml file which describes your vm. See data/lab/test_tar
   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'].create_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")
+  vm_controller['vm1'].revert_snapshot("clean")
 </pre>
 METASPLOIT MSFCONSOLE LAB PLUGIN:
 =================================

data/lab.gemspec

@@ -36,4 +36,9 @@ Gem::Specification.new do |s|
     # util/console.rb
     s.add_runtime_dependency "pry"
 
+    ##
+    ## UI Dependencies
+    ##
+    s.add_runtime_dependency "sinatra"
+
 end

data/lib/lab/driver/remote_esxi_driver.rb

@@ -20,7 +20,7 @@ class RemoteEsxiDriver < VmDriver
     
     @user = filter_command(config['user'])
     @host = filter_command(config['host'])
-    @port = config['port']    
+    @port = config['port']
   end
 
   def start
@@ -47,6 +47,10 @@ class RemoteEsxiDriver < VmDriver
     remote_system_command("vim-cmd vmsvc/power.reset #{@vmid}")
   end
 
+  def query_snapshots
+    get_snapshots
+  end
+  
   def create_snapshot(snapshot)
     snapshot = filter_input(snapshot)
     
@@ -71,8 +75,8 @@ class RemoteEsxiDriver < VmDriver
       end
     end
   
-    # If we got here, the snapshot didn't exist
-    raise "Invalid Snapshot Name"
+    # If we got here, we couldn't make it happen
+    raise "Unable to revert"
   end
 
   def delete_snapshot(snapshot, remove_children=false)

data/lib/lab/version.rb

@@ -1,3 +1,3 @@
 module Lab
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/lib/lab/vm.rb

@@ -15,6 +15,7 @@ class Vm
   attr_accessor :credentials
   attr_accessor :tools
   attr_accessor :type
+  attr_accessor :notes
   attr_accessor :os
   attr_accessor :arch
   attr_accessor :machine_tags
@@ -37,7 +38,6 @@ class Vm
   ##    modifiers - can be anything in the modifiers directory
   ##    machine_tags - list of strings associated with the machine (not individual snapshots)
   ##    snapshots - list of snapshots
-
   
   def initialize(config = {})  
 
@@ -58,6 +58,7 @@ class Vm
 
     @location = filter_input(config['location'])
     @description = config['description']
+    @notes = config['notes']
     @tools = config['tools']
     @os = config['os']
     @arch = config['arch']
@@ -182,6 +183,10 @@ class Vm
   def resume
     @driver.resume
   end
+  
+  def query_snapshots
+    @driver.query_snapshots
+  end
 
   def create_snapshot(snapshot)
     @driver.create_snapshot(snapshot)

data/ui/README

@@ -0,0 +1,11 @@
+super-simple CCDC monitoring tool
+
+setup:
+ - install some rubies (use rvm, it's super awesome)
+ - $ git clone 
+ - $ gem install sinatra
+ - $ rackup
+ - browse to :9292
+ - read the code and realize i'm scannin yer networkz
+
+screenshot: http://www.pentestify.com/x/omgeasymon.png

data/ui/config.ru

@@ -0,0 +1,13 @@
+require './labmon'
+require './helpers'
+ 
+root_dir = File.dirname(__FILE__)
+ 
+set :environment,	:production
+set :root,        	root_dir
+set :app_file,    	File.join(root_dir, 'labmon.rb')
+set :public_folder, 	root_dir + '/public'
+set :logging, 		true
+set :run, 		false
+
+run Sinatra::Application

data/ui/helpers.rb

@@ -0,0 +1,21 @@
+require 'sinatra/base'
+
+module Sinatra
+  module HTMLEscapeHelper
+    def h(text)
+      Rack::Utils.escape_html(text)
+    end
+  end
+  helpers HTMLEscapeHelper
+
+  module InputBouncer
+    def verify_as_ip_or_hostname(param)
+      return unless param # possible this could be called on a nil parameter
+      # First pass scan for anything not alphanum or . or -
+      redirect "/exception" if param =~ /[^a-zA-Z0-9\x2e\x2d]/
+      # Now test for nice formatting.
+      redirect "/exception" if !(param =~ /^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$/)
+    end
+  end
+  register InputBouncer
+end

data/ui/labmon.rb

@@ -0,0 +1,56 @@
+require 'sinatra'
+require 'lab'
+ 
+before do
+  ## Basic blacklisting of metacharacters
+  redirect to "/exception" if request.path_info =~ /\;|\|/
+  @controller = Lab::Controllers::VmController.new
+  if File.exist? "config.txt"
+    @controller.from_file(File.open("config.txt").read.strip)
+  end
+end
+ 
+get '/' do
+ redirect to "/list"
+end
+
+get '/exception' do
+  "sorry, that's not allowed, request contains bad data"
+end
+
+get '/list' do
+  erb :list
+end
+
+get '/show' do
+  redirect to '/list'
+end
+
+get '/show/:hostname' do
+  # Get the watcher
+  hostname = params[:hostname]
+  @vm = @controller[hostname]
+  erb :show
+end
+
+get '/start/:hostname' do
+  hostname = params[:hostname]
+  @vm = @controller[hostname]
+  @vm.start
+  redirect to "/show/#{hostname}"
+end
+
+get '/stop/:hostname' do
+  hostname = params[:hostname]
+  @vm = @controller[hostname]
+  @vm.stop
+  redirect to "/show/#{hostname}"
+end
+
+get '/revert_snapshot/:hostname' do
+  hostname = params[:hostname]
+  snapshot = params[:snapshot] || "clean"
+  @vm = @controller[hostname]
+  @vm.revert_snapshot snapshot
+  redirect to "/show/#{hostname}"
+end

data/ui/views/index.erb

@@ -0,0 +1 @@
+<h1> LabMon </h1>

data/ui/views/layout.erb

@@ -0,0 +1,5 @@
+<html>
+  <body>
+   <%= yield %>
+  </body>
+</html>

data/ui/views/list.erb

@@ -0,0 +1,7 @@
+<h1> LabMon </h1>
+
+<ul>
+  <% @controller.each do |vm| %>
+  <li> <a href=show/<%=vm.hostname%>><%=vm.hostname%></a> - <%= vm.description %> </li>
+  <% end %>
+</ul>

data/ui/views/show.erb

@@ -0,0 +1,31 @@
+<h1> LabMon </h1>
+
+<ul>
+<li> Hostname: <%= @vm.hostname %> </ll>
+<li> Description: <%= @vm.description %> </li>
+<li> Notes: <%= @vm.notes %> </li>
+<li> Running: <%= @vm.running? %> </li>
+<li> Tags: <%= @vm.machine_tags.join(", ") unless @vm.snapshots.nil? %></li>
+<li> Snapshots: <%= @vm.snapshots.join(", ") unless @vm.snapshots.nil? %></li>
+</ul>
+
+<table>
+<tr>
+<td>
+<form name=start_vm action="/start/<%=@vm.hostname%>">
+  <input type=submit value="Start">
+</form>
+</td>
+<td>
+<form name=stop_vm action="/stop/<%=@vm.hostname%>">
+  <input type=submit value="Stop">
+</form>
+</td>
+<td>
+<form name=revert_snapshot action="/revert_snapshot/<%=@vm.hostname%>">
+  <input type=text value="clean">
+  <input type=submit value="Revert">
+</form>
+<td>
+</tr>
+</table

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lab
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-11 00:00:00.000000000 Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &19870120 !ruby/object:Gem::Requirement
+  requirement: &19051940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19870120
+  version_requirements: *19051940
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &19869140 !ruby/object:Gem::Requirement
+  requirement: &18994720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19869140
+  version_requirements: *18994720
 - !ruby/object:Gem::Dependency
   name: rbvmomi
-  requirement: &19868260 !ruby/object:Gem::Requirement
+  requirement: &18992980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19868260
+  version_requirements: *18992980
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &19867600 !ruby/object:Gem::Requirement
+  requirement: &18992340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19867600
+  version_requirements: *18992340
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &19865900 !ruby/object:Gem::Requirement
+  requirement: &18991460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19865900
+  version_requirements: *18991460
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &18990620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18990620
 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. '
@@ -113,6 +124,15 @@ files:
 - lib/lab/vm.rb
 - lib/lab/vm_controller.rb
 - test/.gitkeep
+- ui/README
+- ui/config.ru
+- ui/helpers.rb
+- ui/labmon.rb
+- ui/log/.gitkeep
+- ui/views/index.erb
+- ui/views/layout.erb
+- ui/views/list.erb
+- ui/views/show.erb
 - util/console.rb
 homepage: http://www.github.com/rapid7/lab/wiki
 licenses: []