nexpose-magic 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46316b96692e942e08a24d91c67939017fbb9d8d
+  data.tar.gz: ce6dcd7e2d17e5a8d0a52c9ddc1905a0261cd427
+SHA512:
+  metadata.gz: 16b266ea56fae5da2e3e854fa897e306641aceff2ae4d81c371683d248085c833e22c659598c189a45d78a14f2379fb43ab3277175d11800502067ca06e3b0ac
+  data.tar.gz: f08095961f428ce5ba66a8d19f75eb6f0573ff7becb3a26489abe95f1c4a10840fc566721ef6311b7737e3217ee79d4de3fe4d0c79edd5dd231260830863d323

data/README

@@ -0,0 +1,26 @@
+Nexpose Magic is a project created by Matthew Spah to help Nexpose Admins pull information from their consoles on the command line.
+
+It is currently in alpha stage and should only be used for testing purposes.
+
+Required files:
+ nexpose-magic.rb
+ nexmagic.rb
+
+Nexpose Magic uses the arugments supplied by -u, -p, and -i to make the connection the the nexpose console
+
+To display information about a specific scan engine:
+	- nexmagic.rb -i 192.168.1.128 -u nexposeuser -p password -e [--engine] <engine ID>
+
+To display nexpose site information:
+	- nexmagic.rb -i 192.168.1.128 -u nexposeuser -p password -t [--site] <site ID>
+
+To display scans that are currently running on your nexpose console:
+	- nexmagic.rb -i 192.168.1.128 -u nexposeuser -p password -v [--vscans]
+
+To display a table list of either all sites or engines present on a console:
+	- nexmagic.rb -i 192.168.1.128 -u nexposeuser -p password -l [--list] <scans | engines>
+
+To display command line help:
+	- nexmagic.rb -h
+
+

data/bin/nexmagic.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+require 'nexpose-magic'
+require 'optparse'
+require 'nexpose'
+require 'table_print'
+include Nexpose
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: nexpose-magic.rb -c [console] [options]"
+
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  opts.on('-i', "--ip <IP ADDRESS>", "Nexpose Console IP") do |i|
+    options[:ip] = i
+  end
+
+  opts.on('-u', "--user <User>", "Nexpose Console User") do |u|
+    options[:user] = u
+  end
+
+  opts.on('-p', "--password <Password>", "Nexpose Console Password") do |p|
+    options[:password] = p
+  end
+
+  opts.on('-t', "--port <Port Number>", "Nexpose Port Number") do |t|
+    options[:port] = t
+  end
+
+  opts.on("-e", "--engine <Engine ID>", "Display Scan Engine Information") do |e|
+    options[:scan_engine] = e
+  end
+
+  opts.on("-s", "--site <site ID>", "Display Site Information") do |s|
+    options[:site] = s
+  end
+
+  opts.on("-v", "--vscans", "Display currently running Nexpose vulnerability scans") do |v|
+    options[:scans] = v
+  end
+
+  opts.on("-l", "--list [sites] [engines]", "Display tabled list of all Nexpose Sites, or Scan Engines present on a console") do |l|
+    options[:list] = l 
+  end
+
+  opts.on_tail("-h", "--help", "Show help message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+begin
+  nsc = Connection.new(options[:ip], options[:user], options[:password]) if options[:port].nil?
+  nsc = Connection.new(options[:ip], options[:user], options[:password], port = options[:port]) if options[:port]
+  nsc.login
+rescue => e 
+  raise e
+end  
+
+nexpose = NexposeMagic.new
+
+if not options[:scan_engine].nil?
+  nexpose.engine = Engine.load(nsc, options[:scan_engine]) 
+  nexpose.populate_engine.each { |x| puts x }
+
+elsif not options[:site].nil?
+  nexpose.site = Site.load(nsc, options[:site])
+  nexpose.populate_site.each {|x| puts x }
+
+elsif not options[:list].nil?
+  case options[:list]
+    when "engines"
+      nexpose.engines = nsc.list_engines
+      nexpose.list_engines
+    when "sites"
+      nexpose.sites = nsc.list_sites
+      nexpose.list_sites
+    else
+      puts "You gave an invalid list argument"
+  end
+
+elsif not options[:scans].nil?
+  nexpose.scans = nsc.scan_activity
+  nexpose.populate_scans.each { |x| puts x }
+end
+
+nsc.logout
+
+
+

data/lib/nexpose-magic.rb

@@ -0,0 +1,69 @@
+
+class NexposeMagic
+
+  attr_accessor :engine, :site, :scans, :sites, :engines
+
+  def initialize(engine=nil, site=nil, scans=nil, list_sites=nil, list_engines=nil)
+    @engine = engine 
+    @site = site
+    @scans = scans
+    @list_sites = list_sites
+    @list_engines = list_engines
+  end
+
+  def populate_site
+    @assets = convert_ip_range(@site.assets)
+    @siteinfo = [ "Site Name: #{@site.name}",
+      "Site Engine ID: #{@site.engine}",
+      "Site Scan Template: #{@site.scan_template_name}",
+      "Site Assets: " ] 
+    @assets.each { |asset| @siteinfo << "#{asset}" }
+    @siteinfo
+  end
+
+  def populate_engine
+    @engineinfo = [ "Engine Name: #{@engine.name}",
+    "Engine Address: #{@engine.address}",
+    "Engine ID: #{@engine.id}",
+    "Engine Sites: " ] 
+    @engine.sites.each { |x| @engineinfo << "Site ID: #{x.id} Site Name: #{x.name}" }
+    @engineinfo
+  end
+
+  def convert_ip_range(assets)
+    ips = []
+    assets.each do |asset|
+      unless asset.to
+        ips << asset.from
+      else
+        ips << asset.from + "-" + asset.to
+      end
+    end
+    ips
+  end
+
+  def populate_scans
+    return ["No scans currently running"] if @scans.empty?
+
+    @scaninfo = [ "Scans currently runnning"]
+    @scans.each do |x|
+        @scaninfo << "Scan ID: #{x.scan_id}"
+        @scaninfo << "Site ID: #{x.site_id}"
+        @scaninfo << "Status: #{x.status}"
+        @scaninfo << "Engine ID: #{x.engine_id}"
+        @scaninfo << "Scan Start Time: #{x.start_time}"
+        @scaninfo << "Nodes: #{x.nodes.live}"
+        @scaninfo << ""
+      end
+    @scaninfo
+  end
+
+  def list_sites
+    tp @sites
+  end
+
+  def list_engines
+    tp @engines
+  end
+
+end

data/nexposemagic.rspec

@@ -0,0 +1,44 @@
+require 'nexpose-magic'
+#You'll need to fill in Connection.new for this test to be successful 
+# 
+
+describe NexposeMagic do
+
+  before :each do
+    @nexpose = NexposeMagic.new 
+  end
+
+  it "should populate engine information about a known scan engine" do
+    sites = []
+    stub_site = stub :id => "234234", :name => "This is a test site"
+    sites << stub_site
+    stub_engine = stub :name => "CFS-LH-2000", :id => "99", :address => "192.168.1.25", :sites => sites
+    @nexpose.engine = stub_engine
+    @nexpose.populate_engine.should include("Engine Name: CFS-LH-2000")
+    @nexpose.populate_engine.should include("Engine Address: 192.168.1.25")
+  end
+
+  it "should populate site information about a known site" do
+    assets = []
+    stub_asset = stub :from => "192.168.1.1", :to => "192.168.1.254"
+    assets << stub_asset
+    stub_site = stub :name => "This is a test site", :engine => "CFS-LH-2000", :scan_template_name => "Template PCI", :assets => assets
+    @nexpose.site = stub_site
+    @nexpose.populate_site.should include("Site Name: This is a test site")
+  end
+
+  it "should let you know when no scans are running" do
+    stub_scans = []
+    @nexpose.scans = stub_scans
+    @nexpose.populate_scans.should include("No scans currently running")
+  end
+
+  it "should display scans when they are running" do
+    stub_scans = []
+    stub_nodes = stub :live => "46"
+    stub_scan = stub :scan_id => "32434", :site_id => "343434", :status => "running", :engine_id => "99", :start_time => "03/02/2014 12:34:54", :nodes => stub_nodes
+    stub_scans << stub_scan
+    @nexpose.scans = stub_scans 
+    @nexpose.populate_scans.should include("Scan ID: 32434")
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: nexpose-magic
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matthew Spah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nexpose
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: table_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Nexpose-magic - Nexpose adminstration CLI tool
+email: spahmatthew@gmail.com
+executables:
+- nexmagic.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- bin/nexmagic.rb
+- lib/nexpose-magic.rb
+- nexposemagic.rspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Nexpose-magic - Nexpose adminstration CLI tool
+test_files: []