nexpose 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 584499f88ee81a2448cdfeb678b7c3558547af44
-  data.tar.gz: 12b0b5b05463523515453d095dd4aa68fd5c989c
+  metadata.gz: 375665364ba49ff95d55ef5cf904955697a1ba5d
+  data.tar.gz: 863da9f7656341a934e154e5f576a6225afc3df4
 SHA512:
-  metadata.gz: d91c67f78e7e1201b254d0ca9028697da033aea3e736a490462a24acebbbf8736b758f28e721baadc31b888585e79eaff8dc2d92a68b0fce0bec6f31905843c5
-  data.tar.gz: 6d03e8f451ba644ce2779e98712e9acb488438a028ebd7ccf717dec7a93c52dd8179425f73bfd5b5337e71f4ba0211cfd27574c61f4fef9ab40cfdb95320add9
+  metadata.gz: 882e9bec98184b52d96c897c84cf36d226ed638125d8faa66ef1e7aa2ad8994792977b03ce799b312971c6ff677fa4cfbc5db7b511af5d502e04fb333a3d095e
+  data.tar.gz: 4b6460e699d3723cb50bc86f81aa0a7ddf6a1de1a9e7a3e2fc0dd1f28b761794e25f80eb063aef83b46c16eee19d6b03e2b4c4ea579078c8ed562175de02fb73

data/lib/nexpose.rb

@@ -83,6 +83,7 @@ require 'nexpose/user'
 require 'nexpose/vuln'
 require 'nexpose/vuln_exception'
 require 'nexpose/connection'
+require 'nexpose/backup'
 
 module Nexpose
 

data/lib/nexpose/backup.rb

@@ -0,0 +1,109 @@
+module Nexpose
+
+  module NexposeAPI
+
+    # Retrieve a list of all backups currently stored on the Console.
+    #
+    # @return [Array[Backup]] List of backups.
+    #
+    def list_backups
+      data = DataTable._get_dyn_table(self, '/admin/global/ajax/backup_listing.txml')
+      data.map { |b| Backup.parse(b) }
+    end
+
+    # Create a backup of this security console's data.
+    # A restart will be initiated in order to put the product into maintenance
+    # mode while the backup is made. It will then restart automatically.
+    #
+    # @param [Boolean] platform_independent Whether to make a platform
+    #   independent backup.
+    # @param [String] description A note about this backup which will be
+    #   visible through the web interface.
+    # @return [Boolean] Whether a backup is successfully initiated.
+    #
+    def backup(platform_independent = false, description = nil)
+      parameters = { 'backup_desc' => description,
+                     'cmd' => 'backup',
+                     'platform_independent' => platform_independent,
+                     'targetTask' => 'backupRestore' }
+      xml = AJAX.form_post(self, '/admin/global/maintenance/maintCmd.txml', parameters)
+      if !!(xml =~ /succeded="true"/)
+        _maintenance_restart
+      end
+    end
+
+    def _maintenance_restart
+      parameters = { 'cancelAllTasks' => false,
+                     'cmd' => 'restartServer',
+                     'targetTask' => 'maintModeHandler' }
+      xml = AJAX.form_post(self, '/admin/global/maintenance/maintCmd.txml', parameters)
+      !!(xml =~ /succeded="true"/)
+    end
+  end
+
+  # Details about an existing backup on the security console.
+  #
+  class Backup
+
+    # Filename
+    attr_reader :name
+    # Date the backup was made.
+    attr_reader :date
+    # Description of the backup.
+    attr_reader :description
+    # Nexpose version the console was on when the backup was made.
+    attr_reader :version
+    # Whether the backup is platform-idependent or not.
+    attr_reader :platform_independent
+    # Size of backup file on disk, in Bytes. Can be used to estimate the amount
+    # of time the backup may take to load.
+    attr_reader :size
+
+    def initialize(name, date, description, version, independent, size)
+      @name = name
+      @date = date
+      @description = description
+      @version = version
+      @platform_independent = independent
+      @size = size
+    end
+
+    # Restore this backup to the Nexpose console.
+    # It will restart the console after acknowledging receiving the request.
+    #
+    # @param [Connection] nsc An active connection to a Nexpose console.
+    # @return [Boolean] Whether the request was received.
+    #
+    def restore(nsc)
+      parameters = { 'backupid' => @name,
+                     'cmd' => 'restore',
+                     'targetTask' => 'backupRestore' }
+      xml = AJAX.form_post(nsc, '/admin/global/maintenance/maintCmd.txml', parameters)
+      if !!(xml =~ /succeded="true"/)
+        nsc._maintenance_restart
+      end
+    end
+
+    # Remove this backup file from the security console.
+    #
+    # @param [Connection] nsc An active connection to a Nexpose console.
+    # @return [Boolean] If the backup was removed.
+    #
+    def delete(nsc)
+      parameters = { 'backupid' => @name,
+                     'cmd' => 'deleteBackup',
+                     'targetTask' => 'backupRestore' }
+      xml = AJAX.form_post(nsc, '/admin/global/maintenance/maintCmd.txml', parameters)
+      !!(xml =~ /succeded="true"/)
+    end
+
+    def self.parse(hash)
+      new(hash['Download'],
+          Time.at(hash['Date'].to_i / 1000),
+          hash['Description'],
+          hash['Version'],
+          hash['Platform-Independent'],
+          hash['Size'])
+    end
+  end
+end

data/lib/nexpose/report.rb

@@ -102,7 +102,7 @@ module Nexpose
     attr_reader :scope
 
     def initialize(config_id, template_id, status, generated_on, uri, scope)
-      @config_id = config_id
+      @config_id = config_id.to_i
       @template_id = template_id
       @status = status
       @generated_on = generated_on
@@ -111,7 +111,7 @@ module Nexpose
     end
 
     def self.parse(xml)
-      ReportConfigSummary.new(xml.attributes['cfg-id'],
+      ReportConfigSummary.new(xml.attributes['cfg-id'].to_i,
                               xml.attributes['template-id'],
                               xml.attributes['status'],
                               xml.attributes['generated-on'],
@@ -138,7 +138,7 @@ module Nexpose
 
     def initialize(id, config_id, status, generated_on, uri)
       @id = id
-      @config_id = config_id
+      @config_id = config_id.to_i
       @status = status
       @generated_on = generated_on
       @uri = uri
@@ -339,8 +339,10 @@ module Nexpose
       connection.delete_report_config(@id)
     end
 
+    include Sanitize
+
     def to_xml
-      xml = %(<ReportConfig format='#{@format}' id='#{@id}' name='#{@name}' template-id='#{@template_id}')
+      xml = %(<ReportConfig format='#{@format}' id='#{@id}' name='#{replace_entities(@name)}' template-id='#{@template_id}')
       xml << %( owner='#{@owner}') if @owner
       xml << %( timezone='#{@time_zone}') if @time_zone
       xml << %( language='#{@language}') if @language
@@ -368,8 +370,8 @@ module Nexpose
         config = ReportConfig.new(cfg.attributes['name'],
                                   cfg.attributes['template-id'],
                                   cfg.attributes['format'],
-                                  cfg.attributes['id'],
-                                  cfg.attributes['owner'],
+                                  cfg.attributes['id'].to_i,
+                                  cfg.attributes['owner'].to_i,
                                   cfg.attributes['timezone'])
 
         cfg.elements.each('//description') do |desc|

data/lib/nexpose/site.rb

@@ -423,9 +423,22 @@ module Nexpose
       @to = to unless from == to
     end
 
+    # Size of the IP range. The total number of IP addresses represented
+    # by this range.
+    #
+    # @return [Fixnum] size of the range.
+    #
+    def size
+      return 1 if @to.nil?
+      from = IPAddr.new(@from)
+      to = IPAddr.new(@to)
+      (from..to).to_a.size
+    end
+
     include Comparable
 
     def <=>(other)
+      return 1 unless other.respond_to? :from
       from = IPAddr.new(@from)
       to = @to.nil? ? from : IPAddr.new(@to)
       cf_from = IPAddr.new(other.from)
@@ -444,10 +457,12 @@ module Nexpose
     end
 
     def eql?(other)
+      return false unless other.respond_to? :from
       @from == other.from && @to == other.to
     end
 
     def include?(single_ip)
+      return false unless single_ip.respond_to? :from
       from = IPAddr.new(@from)
       to = @to.nil? ? from : IPAddr.new(@to)
       other = IPAddr.new(single_ip)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - HD Moore
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-16 00:00:00.000000000 Z
+date: 2013-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librex
@@ -55,6 +55,7 @@ files:
 - Rakefile
 - lib/nexpose.rb
 - lib/nexpose/pool.rb
+- lib/nexpose/backup.rb
 - lib/nexpose/group.rb
 - lib/nexpose/device.rb
 - lib/nexpose/report_template.rb