nexpose 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21a667918d8b90c0e4c4973bf75c5dca00ea27a6
-  data.tar.gz: 627a5f8bf4f1317fe753dd6707cf13384722f094
+  metadata.gz: 8ad0041be128712796475321b8b6866cc1c28509
+  data.tar.gz: 24eec90003a73b8cad10bda5d77e0c39ae7bd932
 SHA512:
-  metadata.gz: ded568b5819049f20ce3b346389a5bdce391895060ba8f0a2cf20bb7057b934fc892689fb61def7b9aa7fbd701176b539160425875fd99b543c9dd80c422fded
-  data.tar.gz: 16a60054fc1af1aecebc4534378efc3b8b84b37e3063f0107cb4d36ce23a489e5387b5399c067046770741913ee513104ea058448fdc94c0e83c154b9b67a995
+  metadata.gz: e06af399eb90fd5a65ce07b1d68c6fa0c740d173680c6adbc95508a232cd7783968031b80178155a54f485f75b616da0cd964e1e36732052c3e41334f3e5f398
+  data.tar.gz: af24f65ecf732076ff96bc3f486d04754c3f16410def4194c44193ff97c73a50929adf3bb63d21c0cfb94cda25549b1bd843ca9de9b1bf59b23ff6595f75cf2e

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    nexpose (3.2.0)
+    nexpose (2.1.3)
+      multipart-post (~> 2.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -16,7 +17,8 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    multi_json (1.10.1)
+    multi_json (1.11.0)
+    multipart-post (2.0.0)
     parser (2.2.0.3)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.0)
@@ -25,7 +27,7 @@ GEM
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
       rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.1)
+    rspec-core (3.2.2)
       rspec-support (~> 3.2.0)
     rspec-expectations (3.2.0)
       diff-lcs (>= 1.2.0, < 2.0)

data/lib/nexpose.rb

@@ -92,6 +92,8 @@ require 'nexpose/report_template'
 require 'nexpose/role'
 require 'nexpose/scan'
 require 'nexpose/scan_template'
+require 'nexpose/scheduled_backup'
+require 'nexpose/scheduled_maintenance'
 require 'nexpose/shared_secret'
 require 'nexpose/silo'
 require 'nexpose/silo_profile'

data/lib/nexpose/manage.rb

@@ -43,6 +43,25 @@ module Nexpose
       end
     end
 
+    # Obtain the version information for each scan engine.
+    # Includes Product, Content, and Java versions.
+    #
+    def engine_versions
+      info = console_command('version engines')
+      versions = []
+      engines = info.sub('VERSION INFORMATION\n', '').split(/\n\n/)
+      engines.each do |eng|
+        engdata = {}
+        eng.split(/\n/).each do |kv|
+          key, value = kv.split(/:\s*/)
+          key = key.sub('Local Engine  ', '').sub('Remote Engine ', '')
+          engdata[key] = value
+        end
+        versions << engdata
+      end
+      versions
+    end
+
     # Induce the application to retrieve required updates and restart
     # if necessary.
     #

data/lib/nexpose/scheduled_backup.rb

@@ -0,0 +1,85 @@
+module Nexpose
+  # Configuration structure for scheduled backups.
+  class ScheduledBackup < APIObject
+    require 'json'
+    include JsonSerializer
+
+    # Whether or not this schedule is enabled. Defaults to true if not set
+    attr_accessor :enabled
+    # Valid schedule types: daily, hourly, monthly-date, monthly-day, weekly.
+    attr_accessor :schedule_type
+    # The repeat interval based upon type.
+    attr_accessor :schedule_interval
+    # The earliest date to generate the report on (in ISO 8601 format).
+    attr_accessor :schedule_start
+    # The description of the backup. Defaults to nil if not set
+    attr_accessor :description
+    # Whether the backup will be platform independent or not. Defaults to true if not set
+    attr_accessor :platform_independent
+    # Whether the backup should pause all local scans or wait for local scans to complete. Defaults to true if not set
+    attr_accessor :pause_local_scans
+    # Number of minutes to wait for running scans to pause/complete before aborting the backup task. Defaults to 0 if not set
+    attr_accessor :cancellation_window
+
+    def initialize(start:, enabled: true, type:, interval:, platform_independent: true, description: nil, pause_local_scans: true, cancellation_window: 0)
+      @schedule_start = start
+      @enabled = enabled
+      @schedule_type = type
+      @schedule_interval = interval.to_i
+      @platform_independent = platform_independent
+      @description = description
+      @pause_local_scans = pause_local_scans
+      @cancellation_window = cancellation_window.to_i
+    end
+
+    def to_json
+      JSON.generate(to_h)
+    end
+
+    def save(nsc)
+      params = to_json
+      AJAX.post(nsc, '/api/2.1/schedule_backup/', params, AJAX::CONTENT_TYPE::JSON)
+    end
+
+    def self.from_hash(hash)
+      repeat_backup_hash = hash[:repeat_type]
+      backup = new(start: hash[:start_date],
+                   enabled: hash[:enabled],
+                   type: repeat_backup_hash[:type],
+                   interval: repeat_backup_hash[:interval],
+                   platform_independent: hash[:platform_independent],
+                   description: hash[:description],
+                   pause_local_scans: hash[:pause_local_scans],
+                   cancellation_window: hash[:cancellation_window])
+      backup
+    end
+
+    def to_h
+      backup_hash = {
+        start_date: @schedule_start,
+        enabled: @enabled,
+        description: @description,
+        platform_independent: @platform_independent,
+        pause_local_scans: @pause_local_scans,
+        cancellation_window: @cancellation_window
+      }
+      repeat_hash = {
+        type: @schedule_type,
+        interval: @schedule_interval
+      }
+      backup_hash[:repeat_type] = repeat_hash
+      backup_hash
+    end
+
+    def self.load(nsc)
+      uri = '/api/2.1/schedule_backup/'
+      resp = AJAX.get(nsc, uri, AJAX::CONTENT_TYPE::JSON)
+      hash = JSON.parse(resp, symbolize_names: true).first
+      Nexpose::ScheduledBackup.from_hash(hash || [])
+    end
+
+    def self.delete(nsc)
+      AJAX.delete(nsc, '/api/2.1/schedule_backup/', AJAX::CONTENT_TYPE::JSON)
+    end
+  end
+end

data/lib/nexpose/scheduled_maintenance.rb

@@ -0,0 +1,90 @@
+module Nexpose
+  # Configuration structure for scheduled maintenance.
+  class ScheduledMaintenance < APIObject
+    require 'json'
+    include JsonSerializer
+
+    # Whether or not this maintenance schedule is enabled. Defaults to true if not set
+    attr_accessor :enabled
+    # Valid schedule types: daily, hourly, monthly-date, monthly-day, weekly.
+    attr_accessor :schedule_type
+    # The repeat interval based upon type.
+    attr_accessor :schedule_interval
+    # The earliest date to generate the report on (in ISO 8601 format).
+    attr_accessor :schedule_start
+    # Whether the reindex task should run. Defaults to true if not set
+    attr_accessor :reindex
+    # Whether the compression task should run. Defaults to true if not set
+    attr_accessor :compress
+    # Whether the cleanup task should run. Defaults to true if not set
+    attr_accessor :cleanup
+    # Whether the maintenance should pause all local scans or wait for local scans to complete. Defaults to true if not set
+    attr_accessor :pause_local_scans
+    # Number of minutes to wait for running scans to pause/complete before aborting the maintenance task. Defaults to 0 if not set
+    attr_accessor :cancellation_window
+
+    def initialize(start:, enabled: true, type:, interval:, reindex: false, compress: true, cleanup: true, pause_local_scans: true, cancellation_window: 0)
+      @schedule_start = start
+      @enabled = enabled
+      @schedule_type = type
+      @schedule_interval = interval.to_i
+      @reindex = reindex
+      @compress = compress
+      @cleanup = cleanup
+      @pause_local_scans = pause_local_scans
+      @cancellation_window = cancellation_window.to_i
+    end
+
+    def to_json
+      JSON.generate(to_h)
+    end
+
+    def save(nsc)
+      params = to_json
+      AJAX.post(nsc, '/api/2.1/schedule_maintenance/', params, AJAX::CONTENT_TYPE::JSON)
+    end
+
+    def self.from_hash(hash)
+      repeat_backup_hash = hash[:repeat_type]
+      backup = new(start: hash[:start_date],
+                   enabled: hash[:enabled],
+                   type: repeat_backup_hash[:type],
+                   interval: repeat_backup_hash[:interval],
+                   reindex: hash[:reindex],
+                   compress: hash[:compression],
+                   cleanup: hash[:cleanup],
+                   pause_local_scans: hash[:pause_local_scans],
+                   cancellation_window: hash[:cancellation_window])
+      backup
+    end
+
+    def to_h
+      maintenance_hash = {
+        start_date: @schedule_start,
+        enabled: @enabled,
+        cleanup: @cleanup,
+        reindex: @reindex,
+        compression: @compress,
+        pause_local_scans: @pause_local_scans,
+        cancellation_window: @cancellation_window
+      }
+      repeat_hash = {
+        type: @schedule_type,
+        interval: @schedule_interval
+      }
+      maintenance_hash[:repeat_type] = repeat_hash
+      maintenance_hash
+    end
+
+    def self.load(nsc)
+      uri = '/api/2.1/schedule_maintenance/'
+      resp = AJAX.get(nsc, uri, AJAX::CONTENT_TYPE::JSON)
+      hash = JSON.parse(resp, symbolize_names: true).first
+      Nexpose::ScheduledMaintenance.from_hash(hash || [])
+    end
+
+    def self.delete(nsc)
+      AJAX.delete(nsc, '/api/2.1/schedule_maintenance/', AJAX::CONTENT_TYPE::JSON)
+    end
+  end
+end

data/lib/nexpose/version.rb

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

data/lib/nexpose/vuln.rb

@@ -297,6 +297,7 @@ module Nexpose
   end
 
   # An instance of a vulnerability discovered on an asset.
+  # Accessible from {Nexpose::Asset#vulnerability_instances}.
   #
   class VulnerabilityInstance < APIObject
     # ID of the asset where the vulnerability instance was detected.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - HD Moore
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,6 +174,8 @@ files:
 - lib/nexpose/role.rb
 - lib/nexpose/scan.rb
 - lib/nexpose/scan_template.rb
+- lib/nexpose/scheduled_backup.rb
+- lib/nexpose/scheduled_maintenance.rb
 - lib/nexpose/shared_credential.rb
 - lib/nexpose/shared_secret.rb
 - lib/nexpose/silo.rb
@@ -212,8 +214,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby API for Rapid7 Nexpose
 test_files: []
+has_rdoc: