nexpose 0.8.10 → 0.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81928c1e3298ba80b864e0d14499f58a9a41eae2
-  data.tar.gz: dcbe6c5b9df95b254fa98f3eb5ec2041492d389a
+  metadata.gz: 9a8af56d94e621eaf5a5c7aba69a52c4b840fe72
+  data.tar.gz: aed5d663662dcc7364d08c3c23e80e036786b3ca
 SHA512:
-  metadata.gz: aa9189178c6c2d497635cc871473f78277abe75374bcf32ac883303463b079b73bc5bdacdac0d8292fcfbd0d326f1d6754235fe2b3ab8d19dcbb260c651cb09e
-  data.tar.gz: 7fc4dc7d5a376c7a6e1a0f440e48b532cb73acb1c4470973528fb228be3d8ccbfb60d1d6acd55ce9c1ee00d3aed91dea79b691b484cfddd3bd0374bef0a5690e
+  metadata.gz: 309661c597363464b8f47162b8f31bcf0914f699938da2772bd8554b589a3217d9b10540e36b65c1188a20555fc6c2d59e0dd68143e1ab099cf8bb54bed970ce
+  data.tar.gz: 60e5a8f6050b052484f774ed9a32ad47a9d1046fa8551d5e0574926990e2e3327133a2c8544a668ea4461b592f69686f98a263d35697240b677a612d1dbd37f0

data/Gemfile

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

data/Rakefile

@@ -1,16 +1,5 @@
 # encoding: utf-8
- 
-task :build do
-	Rake::Task['clean'].execute
-	puts "[*] Building nexpose.gemspec"
-	system "gem build nexpose.gemspec &> /dev/null"
-end
- 
-task :release => :build do
-	puts "[*] Pushing nexpose to rubygems.org"
-	system "gem push nexpose-*.gem &> /dev/null"
-	Rake::Task['clean'].execute
-end
+require 'bundler/gem_tasks'
 
 task :clean do
 	system "rm *.gem &> /dev/null"

data/lib/nexpose/ajax.rb

@@ -185,5 +185,19 @@ module Nexpose
         attr.value == '1'
       end
     end
+
+    def _row_pref_of(val)
+      if val.nil? || val > 100
+        500
+      elsif val > 50
+        100
+      elsif val > 25
+        50
+      elsif val > 10
+        25
+      else
+        10
+      end
+    end
   end
 end

data/lib/nexpose/common.rb

@@ -1,9 +1,6 @@
 module Nexpose
-
-  # Constants
-
+  # Constants useful across the Nexpose module.
   module Scope
-
     GLOBAL = 'global'
     SILO = 'silo'
   end
@@ -27,7 +24,6 @@ module Nexpose
   # the application will send reports via e-mail to access-list members and
   # non-members.
   class Email
-
     # Send as file attachment or zipped file to individuals who are not members
     # of the report access list. One of: file|zip
     attr_accessor :send_as
@@ -164,6 +160,7 @@ module Nexpose
     end
   end
 
+  # Organization configuration, as used in Site and Silo.
   class Organization
     attr_accessor :name
     attr_accessor :url
@@ -178,7 +175,7 @@ module Nexpose
     attr_accessor :country
 
     def initialize(&block)
-      instance_eval &block if block_given?
+      instance_eval(&block) if block_given?
     end
 
     def self.parse(xml)

data/lib/nexpose/data_table.rb

@@ -14,11 +14,14 @@ module Nexpose
     # @param [Connection] console API connection to a Nexpose console.
     # @param [String] address Controller address relative to https://host:port
     # @param [Hash] parameters Parameters that need to be sent to the controller
-    # @param [Integer] pagination size
-    # @param [Integer] number of records to return, gets all if not specified
-    #    The following attributes need to be provided:
+    #    The following attributes may need to be provided:
     #      'sort' Column to sort by
     #      'table-id' The ID of the table to get from this controller
+    # @param [Fixnum] page_size Number of records to include per page.
+    #   Value must conform to supported defaults: -1, 10, 25, 50, 100, 500.
+    # @param [Fixnum] records number of records to return, gets all if not
+    #   specified.
+    # @param [Boolean] post Whether to use form post or get to retrieve data.
     # @return [Array[Hash]] An array of hashes representing the requested table.
     #
     # Example usage:
@@ -41,8 +44,11 @@ module Nexpose
 
       response = request.(parameters)
       data = JSON.parse(response)
-      total = records || data['totalRecords']
+
+      # Don't attept to grab more records than there are.
+      total = data['totalRecords']
       return [] if total == 0
+      total = records.nil? ? total : [records, total].min
 
       rows = []
       parameters['results'] = page_size

data/lib/nexpose/global_settings.rb

@@ -8,7 +8,7 @@ module Nexpose
 
     # Whether control scanning in enabled. A feature tied to ControlsInsight
     # integration.
-    attr_accessor :control_scanning
+    attr_reader :control_scanning
 
     # XML document representing the entire configuration.
     attr_reader :xml
@@ -19,7 +19,7 @@ module Nexpose
       @xml = xml
 
       @asset_exclusions = HostOrIP.parse(xml)
-      @control_scanning = _get_control_scanning(xml)
+      @control_scanning = parse_control_scanning_from_xml(xml)
     end
 
     # Returns true if controls scanning is enabled.
@@ -27,6 +27,11 @@ module Nexpose
       control_scanning
     end
 
+    # Enables/disables controls scanning
+    def control_scanning=(enabled)
+      add_control_scanning_to_xml(xml, enabled)
+    end
+
     # Save any updates to this settings object to the Nexpose console.
     #
     # @param [Connection] nsc Connection to a Nexpose console.
@@ -39,8 +44,8 @@ module Nexpose
         risk_model.add_attribute('recalculation_duration', 'do_not_recalculate')
       end
 
-      _replace_exclusions(xml, asset_exclusions)
-      _set_control_scanning(xml, control_scanning)
+      replace_exclusions(xml, asset_exclusions)
+      add_control_scanning_to_xml(xml, control_scanning)
 
       response = AJAX.post(nsc, '/data/admin/global-settings', xml)
       XMLUtils.success? response
@@ -85,8 +90,10 @@ module Nexpose
       new(REXML::Document.new(response))
     end
 
+    private
+
     # Internal method for updating exclusions before saving.
-    def _replace_exclusions(xml, exclusions)
+    def replace_exclusions(xml, exclusions)
       xml.elements.delete('//ExcludedHosts')
       elem = xml.root.add_element('ExcludedHosts')
       exclusions.each do |exclusion|
@@ -95,7 +102,7 @@ module Nexpose
     end
 
     # Internal method for parsing XML for whether control scanning in enabled.
-    def _get_control_scanning(xml)
+    def parse_control_scanning_from_xml(xml)
       enabled = false
       if elem = REXML::XPath.first(xml, '//enableControlsScan[@enabled]')
         enabled = elem.attribute('enabled').value.to_i == 1
@@ -104,7 +111,7 @@ module Nexpose
     end
 
     # Internal method for updating control scanning before saving.
-    def _set_control_scanning(xml, enabled)
+    def add_control_scanning_to_xml(xml, enabled)
       if elem = REXML::XPath.first(xml, '//enableControlsScan')
         elem.attributes['enabled'] = enabled ? '1' : '0'
       else

data/lib/nexpose/scan.rb

@@ -1,5 +1,4 @@
 module Nexpose
-
   class Connection
     include XMLUtils
 
@@ -110,7 +109,7 @@ module Nexpose
     # @param [HostName|IPRange] asset Asset to append to XML.
     #
     def _append_asset!(xml, asset)
-      if asset.kind_of? Nexpose::IPRange
+      if asset.is_a? Nexpose::IPRange
         xml.add_element('range', { 'from' => asset.from, 'to' => asset.to })
       else  # Assume HostName
         host = REXML::Element.new('host')
@@ -227,6 +226,26 @@ module Nexpose
       end
     end
 
+    # Get a history of past scans for this console, sorted by most recent first.
+    #
+    # Please note that for consoles with a deep history of scanning, this method
+    # could return an excessive amount of data (and take quite a bit of time to
+    # retrieve). Consider limiting the amount of data with the optional argument.
+    #
+    # @param [Fixnum] limit The maximum number of records to return from this call.
+    # @return [Array[CompletedScan]] List of completed scans, ordered by most
+    #   recently completed first.
+    #
+    def past_scans(limit = nil)
+      uri = '/data/scan/global/scan-history'
+      rows = AJAX._row_pref_of(limit)
+      params = { 'sort' => 'endTime', 'dir' => 'DESC', 'startIndex' => 0 }
+      AJAX.preserving_preference(self, 'global-completed-scans') do
+        data = DataTable._get_json_table(self, uri, params, rows, limit)
+        data.map(&CompletedScan.method(:parse_json))
+      end
+    end
+
     # Export the data associated with a single scan, and optionally store it in
     # a zip-compressed file under the provided name.
     #
@@ -276,7 +295,7 @@ module Nexpose
     def import_scan(site_id, zip_file)
       data = Rex::MIME::Message.new
       data.add_part(site_id.to_s, nil, nil, 'form-data; name="siteid"')
-      data.add_part(self.session_id, nil, nil, 'form-data; name="nexposeCCSessionID"')
+      data.add_part(session_id, nil, nil, 'form-data; name="nexposeCCSessionID"')
       scan = File.new(zip_file, 'rb')
       data.add_part(scan.read, 'application/zip', 'binary',
                     "form-data; name=\"scan\"; filename=\"#{zip_file}\"")
@@ -316,7 +335,6 @@ module Nexpose
   # can be rather verbose and isn't useful for many automation scenarios.
   #
   class ScanData
-
     # The Scan ID of the Scan
     attr_reader :scan_id
     # The site that was scanned.
@@ -582,6 +600,10 @@ module Nexpose
   class CompletedScan
     # Unique identifier of a scan.
     attr_reader :id
+    # Site ID for which the scan was run.
+    attr_reader :site_id
+    # Final status of the scan. One of :completed, :stopped, :aborted, :unknown.
+    attr_reader :status
     # Start time of the scan.
     attr_reader :start_time
     # Completion time of the scan.
@@ -609,6 +631,8 @@ module Nexpose
     def self.parse_json(json)
       new do
         @id = json['scanID']
+        @site_id = json['siteID']
+        @status = CompletedScan._parse_status(json['status'])
         @start_time = Time.at(json['startTime'] / 1000)
         @end_time = Time.at(json['endTime'] / 1000)
         @duration = json['duration']
@@ -619,5 +643,19 @@ module Nexpose
         @engine_name = json['scanEngineName']
       end
     end
+
+    # Internal method to parsing status codes.
+    def self._parse_status(code)
+      case code
+      when 'C'
+        :completed
+      when 'S'
+        :stopped
+      when 'A'
+        :aborted
+      else
+        :unknown
+      end
+    end
   end
 end

data/lib/nexpose/version.rb

@@ -0,0 +1,4 @@
+module Nexpose
+  # The latest version of the Nexpose gem
+  VERSION = '0.8.11'
+end

data/lib/nexpose.rb

@@ -94,6 +94,7 @@ require 'nexpose/vuln'
 require 'nexpose/vuln_exception'
 require 'nexpose/connection'
 require 'nexpose/maint'
+require 'nexpose/version'
 
 module Nexpose
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 0.8.10
+  version: 0.8.11
 platform: ruby
 authors:
 - HD Moore
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rex
@@ -53,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: This gem provides a Ruby API to the Nexpose vulnerability management
   product by Rapid7.
 email:
@@ -66,6 +80,7 @@ extra_rdoc_files:
 - README.markdown
 files:
 - COPYING
+- Gemfile
 - README.markdown
 - Rakefile
 - lib/README.md
@@ -105,6 +120,7 @@ files:
 - lib/nexpose/ticket.rb
 - lib/nexpose/user.rb
 - lib/nexpose/util.rb
+- lib/nexpose/version.rb
 - lib/nexpose/vuln.rb
 - lib/nexpose/vuln_exception.rb
 homepage: https://github.com/rapid7/nexpose-client