nexpose 0.1.7 → 0.1.8

data/lib/nexpose.rb

@@ -71,6 +71,7 @@ require 'nexpose/creds'
 require 'nexpose/connection'
 require 'nexpose/role'
 require 'nexpose/common'
+require 'nexpose/group'
 
 module Nexpose
 

data/lib/nexpose/group.rb

@@ -0,0 +1,118 @@
+module Nexpose
+  module NexposeAPI
+    include XMLUtils
+
+    # Delete an asset group and all associated data.
+    #
+    # @param [Fixnum] id Asset group ID to delete.
+    #
+    # @return [Boolean] Whether group deletion succeeded.
+    #
+    def asset_group_delete(id)
+      r = execute(make_xml('AssetGroupDeleteRequest', {'group-id' => id}))
+      r.success
+    end
+
+    alias_method :delete_asset_group, :asset_group_delete
+
+    # Retrieve a list of all asset groups the user is authorized to view or
+    # manage.
+    #
+    # @return [Array[AssetGroupSummary]] Array of AssetGroupSummary objects.
+    #
+    def asset_groups
+      r = execute(make_xml('AssetGroupListingRequest'))
+
+      res = []
+      if r.success
+        r.res.elements.each('//AssetGroupSummary') do |group|
+          res << AssetGroupSummary.new(group.attributes['id'].to_i,
+                                       group.attributes['name'].to_s,
+                                       group.attributes['description'].to_s,
+                                       group.attributes['riskscore'].to_f)
+        end
+      end
+      res
+    end
+
+    alias_method :asset_groups_listing, :asset_groups
+  end
+
+  # Summary value object for asset group information.
+  #
+  class AssetGroupSummary
+    attr_reader :id, :name, :description, :risk_score
+
+    def initialize(id, name, desc, risk)
+      @id, @name, @description, @risk_score = id, name, desc, risk
+    end
+
+    # Delete this asset group and all associated data.
+    #
+    # @param [Connection] connection Connection to security console.
+    #
+    def delete(connection)
+      connection.asset_group_delete(@id)
+    end
+  end
+
+  # Asset group configuration object containing Device details.
+  #
+  class AssetGroup < AssetGroupSummary
+
+    # Array[Device] of devices associated with this asset group.
+    attr_accessor :devices
+
+    def initialize(id, name, desc, risk)
+      @id, @name, @description, @risk_score = id, name, desc, risk
+      @devices = []
+    end
+
+    # Launch adhoc scans against each group of assets per site.
+    #
+    # @param [Connection] connection Connection to console where asset group is configured.
+    # @return [Array[Hash[Fixnum, Fixnum]]] Array of scan ID and engine ID
+    #   pairs for each scan launched.
+    #
+    def rescan_assets(connection)
+      sites_ids = @devices.collect { |d| d.site_id }.uniq
+      scans = []
+      sites_ids.each do |id|
+        dev_ids = @devices.select { |d| d.site_id == id }.map { |d| d.id }
+        scans << connection.site_device_scan_start(id, dev_ids)
+      end
+      scans
+    end
+
+    # Load an existing configuration from a Nexpose instance.
+    #
+    # @param [Connection] connection Connection to console where asset group is configured.
+    # @param [Fixnum] id Asset group ID of an existing group.
+    # @return [AssetGroup] Asset group configuration loaded from a Nexpose console.
+    #
+    def self.load(connection, id)
+      r = APIRequest.execute(connection.url,
+                             %Q(<AssetGroupConfigRequest session-id="#{connection.session_id}" group-id="#{id}"/>))
+      parse(r.res)
+    end
+
+    def self.parse(rexml)
+      return nil unless rexml
+
+      rexml.elements.each('//AssetGroup') do |group|
+        asset_group = new(group.attributes['id'].to_i,
+                          group.attributes['name'].to_s,
+                          group.attributes['description'].to_s,
+                          group.attributes['riskscore'].to_f)
+        rexml.elements.each('//Devices/device') do |dev|
+          asset_group.devices << Device.new(dev.attributes['id'].to_i,
+                                            dev.attributes['address'].to_s,
+                                            dev.attributes['site-id'].to_i,
+                                            dev.attributes['riskfactor'].to_f,
+                                            dev.attributes['riskscore'].to_f)
+        end
+        return asset_group
+      end
+    end
+  end
+end

data/lib/nexpose/misc.rb

@@ -7,56 +7,6 @@ module Nexpose
       r.success
     end
 
-    def asset_group_delete(connection, id, debug = false)
-      r = execute(make_xml('AssetGroupDeleteRequest', {'group-id' => param}))
-      r.success
-    end
-
-    #-------------------------------------------------------------------------
-    # Returns all asset group information
-    #-------------------------------------------------------------------------
-    def asset_groups_listing()
-      r = execute(make_xml('AssetGroupListingRequest'))
-
-      if r.success
-        res = []
-        r.res.elements.each('//AssetGroupSummary') do |group|
-          res << {
-            :asset_group_id => group.attributes['id'].to_i,
-            :name => group.attributes['name'].to_s,
-            :description => group.attributes['description'].to_s,
-            :risk_score => group.attributes['riskscore'].to_f,
-          }
-        end
-        res
-      else
-        false
-      end
-    end
-
-    #-------------------------------------------------------------------------
-    # Returns an asset group configuration information for a specific group ID
-    #-------------------------------------------------------------------------
-    def asset_group_config(group_id)
-      r = execute(make_xml('AssetGroupConfigRequest', {'group-id' => group_id}))
-
-      if r.success
-        res = []
-        r.res.elements.each('//Devices/device') do |device_info|
-          res << {
-            :device_id => device_info.attributes['id'].to_i,
-            :site_id => device_info.attributes['site-id'].to_i,
-            :address => device_info.attributes['address'].to_s,
-            :riskfactor => device_info.attributes['riskfactor'].to_f,
-          }
-        end
-        res
-      else
-        false
-      end
-    end
-
-    #
     # Lists all the users for the NSC along with the user details.
     #
     def list_users

data/lib/nexpose/site.rb

@@ -98,9 +98,9 @@ module Nexpose
     # Starts device specific site scanning.
     #
     # devices - An Array of device IDs
-    # hosts - An Array of Hashes [o]=>{:range=>"to,from"} [1]=>{:host=>host}
+    # hosts - An Array of Hashes [o]=>{:range=>"from,to"} [1]=>{:host=>host}
     #-----------------------------------------------------------------------
-    def site_device_scan_start(site_id, devices, hosts)
+    def site_device_scan_start(site_id, devices, hosts = nil)
 
       if hosts == nil and devices == nil
         raise ArgumentError.new("Both the device and host list is nil")
@@ -120,9 +120,12 @@ module Nexpose
         inner_xml = REXML::Element.new 'Hosts'
         hosts.each_index do |x|
           if hosts[x].key? :range
-            to = hosts[x][:range].split(',')[0]
-            from = hosts[x][:range].split(',')[1]
-            inner_xml.add_element 'range', {'to' => "#{to}", 'from' => "#{from}"}
+            from, to = hosts[x][:range].split(',')
+            if to
+              inner_xml.add_element 'range', {'to' => to, 'from' => from}
+            else
+              inner_xml.add_element 'range', {'from' => from}
+            end
           end
           if hosts[x].key? :host
             host_element = REXML::Element.new 'host'
@@ -223,9 +226,40 @@ module Nexpose
       is_dynamic
     end
 
+    # Adds an asset to this site by host name.
+    #
+    # @param [String] hostname FQDN or DNS-resolvable host name of an asset.
+    def add_host(hostname)
+      @assets << HostName.new(hostname)
+    end
+
+    # Adds an asset to this site by IP address.
+    #
+    # @param [String] ip IP address of an asset.
+    def add_ip(ip)
+      @assets << IPRange.new(ip)
+    end
+
+    # Adds an asset to this site, resolving whether an IP or hostname is
+    # provided.
+    #
+    # @param [String] asset Identifier of an asset, either IP or host name.
+    #
+    def add_asset(asset)
+      begin
+        add_ip(asset)
+      rescue ArgumentError => e
+        if e.message == 'invalid address'
+          add_host(asset)
+        else
+          raise "Unable to parse asset: '#{asset}'"
+        end
+      end
+    end
+
     # Load an existing configuration from a Nexpose instance.
     #
-    # @param [Connection] connection Connection to console where scan will be launched.
+    # @param [Connection] connection Connection to console where site exists.
     # @param [Fixnum] id Site ID of an existing site.
     # @return [Site] Site configuration loaded from a Nexpose console.
     def self.load(connection, id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librex
@@ -58,6 +58,7 @@ files:
 - README.markdown
 - Rakefile
 - lib/nexpose.rb
+- lib/nexpose/group.rb
 - lib/nexpose/ticket.rb
 - lib/nexpose/common.rb
 - lib/nexpose/scan_engine.rb