nexpose 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50b3a4ea395acfdb69e8cc0293d403b9cd53eccc
-  data.tar.gz: b9e88228bbb4ff2b6a77718654f73582284328c7
+  metadata.gz: 3f12897628d1710af3338cb1dd054b486bdf6366
+  data.tar.gz: 9791475b4e43ad471b8d540bda2f9bc02e7b8de3
 SHA512:
-  metadata.gz: cc964a92ba088913a9e17b9c037282faaa545bd2cce65ef42f6bda1191b5fd4bc72872bccd1f225d6a2cef6fb3835fbe44c00a4bf6fe1d10b373bd7c26c8e03b
-  data.tar.gz: 3eca493933ccd66545cc95684d48d57fe9cd7251eaa1794cdec5a642d13ebccd2e40a9af678929656c39adda898b579672de00ad28077166c681101684187b3b
+  metadata.gz: 30abfc67f83742aba0c41f5b5289926dd9d3807680f8fc91cb8bda182db63706ab2ebd34259bf61d99466f0d8a204ba4f67ecd75d8926a95f132352a057e9e52
+  data.tar.gz: a6965ad2a9c31df45eef1efcc563bfa6fe9f7590716e5c5d6a3f70b71ed1be8ad6facffbde4d50b523ebb4582b44edc4f3c9fbd90e98e2acebff074245721e83

data/lib/nexpose/common.rb

@@ -110,9 +110,6 @@ module Nexpose
     # The date after which the schedule is disabled, in ISO 8601 format.
     attr_accessor :not_valid_after
 
-    # --
-    # TODO These are not captured or put to XML.
-    # ++
     attr_accessor :incremental
     attr_accessor :repeater_type
 
@@ -127,20 +124,23 @@ module Nexpose
       xml = %Q{<Schedule enabled='#{@enabled ? 1 : 0}' type='#{@type}' interval='#{@interval}' start='#{@start}'}
       xml << %Q{ maxDuration='#@max_duration'} if @max_duration
       xml << %Q{ notValidAfter='#@not_valid_after'} if @not_valid_after
+      xml << %Q{ incremental='#{@incremental ? 1 : 0}'} if @incremental
+      xml << %Q{ repeaterType='#@repeater_type'} if @repeater_type
       xml << '/>'
     end
 
     def self.parse(xml)
-      xml.elements.each('//Schedule') do |sched|
-        schedule = Schedule.new(sched.attributes['type'],
-                                sched.attributes['interval'].to_i,
-                                sched.attributes['start'],
-                                sched.attributes['enabled'] || true)
-        # Optional parameters.
-        schedule.max_duration = sched.attributes['maxDuration'].to_i if sched.attributes['maxDuration']
-        schedule.not_valid_after = sched.attributes['notValidAfter'] if sched.attributes['notValidAfter']
-        return schedule
-      end
+      schedule = Schedule.new(xml.attributes['type'],
+                              xml.attributes['interval'].to_i,
+                              xml.attributes['start'],
+                              xml.attributes['enabled'] != '0')
+
+      # Optional parameters.
+      schedule.max_duration = xml.attributes['maxDuration'].to_i if xml.attributes['maxDuration']
+      schedule.not_valid_after = xml.attributes['notValidAfter'] if xml.attributes['notValidAfter']
+      schedule.incremental = (xml.attributes['incremental'] && xml.attributes['incremental'] == '1')
+      schedule.repeater_type = xml.attributes['repeaterType'] if xml.attributes['repeaterType']
+      schedule
     end
   end
 end

data/lib/nexpose/report.rb

@@ -1,16 +1,20 @@
 module Nexpose
+
+  # NexposeAPI module is mixed into the Connection object, and all methods are
+  # expected to be called from there.
+  #
   module NexposeAPI
     include XMLUtils
 
     # Generate a new report using the specified report definition.
     def generate_report(report_id, wait = false)
-      xml = make_xml('ReportGenerateRequest', {'report-id' => report_id})
+      xml = make_xml('ReportGenerateRequest', { 'report-id' => report_id })
       response = execute(xml)
       if response.success
         response.res.elements.each('//ReportSummary') do |summary|
           summary = ReportSummary.parse(summary)
           # If not waiting or the report is finished, return now.
-          return summary unless wait and summary.status == 'Started'
+          return summary unless wait && summary.status == 'Started'
         end
       end
       so_far = 0
@@ -29,11 +33,11 @@ module Nexpose
     # Provide a history of all reports generated with the specified report
     # definition.
     def report_history(report_config_id)
-      xml = make_xml('ReportHistoryRequest', {'reportcfg-id' => report_config_id})
+      xml = make_xml('ReportHistoryRequest', { 'reportcfg-id' => report_config_id })
       ReportSummary.parse_all(execute(xml))
     end
 
-    # Get the details of the last report generated with the specified report id.
+    # Get details of the last report generated with the specified report id.
     def last_report(report_config_id)
       history = report_history(report_config_id)
       history.sort { |a, b| b.generated_on <=> a.generated_on }.first
@@ -42,13 +46,13 @@ module Nexpose
     # Delete a previously generated report definition.
     # Also deletes any reports generated from that configuration.
     def delete_report_config(report_config_id)
-      xml = make_xml('ReportDeleteRequest', {'reportcfg-id' => report_config_id})
+      xml = make_xml('ReportDeleteRequest', { 'reportcfg-id' => report_config_id })
       execute(xml).success
     end
 
     # Delete a previously generated report.
     def delete_report(report_id)
-      xml = make_xml('ReportDeleteRequest', {'report-id' => report_id})
+      xml = make_xml('ReportDeleteRequest', { 'report-id' => report_id })
       execute(xml).success
     end
 
@@ -69,14 +73,14 @@ module Nexpose
 
     # Retrieve the configuration for a report template.
     def get_report_template(template_id)
-      xml = make_xml('ReportTemplateConfigRequest', {'template-id' => template_id})
+      xml = make_xml('ReportTemplateConfigRequest', { 'template-id' => template_id })
       ReportTemplate.parse(execute(xml))
     end
 
     # Provide a listing of all report definitions the user can access on the
     # Security Console.
     def report_listing
-      r = execute(make_xml('ReportListingRequest', {}))
+      r = execute(make_xml('ReportListingRequest'))
       reports = []
       if r.success
         r.res.elements.each('//ReportConfigSummary') do |report|
@@ -90,7 +94,7 @@ module Nexpose
 
     # Retrieve the configuration for a report definition.
     def get_report_config(report_config_id)
-      xml = make_xml('ReportConfigRequest', {'reportcfg-id' => report_config_id})
+      xml = make_xml('ReportConfigRequest', { 'reportcfg-id' => report_config_id })
       ReportConfig.parse(execute(xml))
     end
   end
@@ -160,7 +164,11 @@ module Nexpose
     end
 
     def self.parse(xml)
-      ReportSummary.new(xml.attributes['id'], xml.attributes['cfg-id'], xml.attributes['status'], xml.attributes['generated-on'], xml.attributes['report-URI'])
+      ReportSummary.new(xml.attributes['id'],
+                        xml.attributes['cfg-id'],
+                        xml.attributes['status'],
+                        xml.attributes['generated-on'],
+                        xml.attributes['report-URI'])
     end
 
     def self.parse_all(response)
@@ -229,7 +237,7 @@ module Nexpose
     include XMLUtils
 
     # Generate a report once using a simple configuration.
-    # 
+    #
     # For XML-based reports, only the raw report is returned and not any images.
     #
     # @param [Connection] connection Nexpose connection.
@@ -255,7 +263,7 @@ module Nexpose
             if /.*base64.*/ =~ part.header.to_s
               if @format =~ /(?:ht|x)ml/
                 if part.header.to_s =~ %r(text/(?:ht|x)ml)
-                  return parse_xml(part.content.unpack("m*")[0]).to_s
+                  return parse_xml(part.content.unpack('m*')[0]).to_s
                 end
               else # text|pdf|csv|rtf
                 return part.content.unpack('m*')[0]
@@ -280,7 +288,7 @@ module Nexpose
     # Array of user IDs which have access to resulting reports.
     attr_accessor :users
     # Configuration of when a report is generated.
-    attr_accessor :generate
+    attr_accessor :frequency
     # Report delivery configuration.
     attr_accessor :delivery
     # Database export configuration.
@@ -313,7 +321,7 @@ module Nexpose
     def self.build(connection, site_id, site_name, type, format, generate_now = false)
       name = %Q{#{site_name} #{type} report in #{format}}
       config = ReportConfig.new(name, type, format)
-      config.generate = Generate.new(true, false)
+      config.frequency = Frequency.new(true, false)
       config.filters << Filter.new('site', site_id)
       config.save(connection, generate_now)
       config
@@ -355,7 +363,7 @@ module Nexpose
       xml << '</Users>'
 
       xml << %Q{<Baseline compareTo='#{@baseline}' />} if @baseline
-      xml << @generate.to_xml if @generate
+      xml << @frequency.to_xml if @frequency
       xml << @delivery.to_xml if @delivery
       xml << @db_export.to_xml if @db_export
 
@@ -385,7 +393,7 @@ module Nexpose
           config.baseline = baseline.attributes['compareTo']
         end
 
-        config.generate = Generate.parse(cfg)
+        config.frequency = Frequency.parse(cfg)
         config.delivery = Delivery.parse(cfg)
         config.db_export = DBExport.parse(cfg)
 
@@ -435,9 +443,9 @@ module Nexpose
   end
 
   # Data object associated with when a report is generated.
-  class Generate
+  class Frequency
     # Will the report be generated after a scan completes (true),
-    # or is it ad-hoc/scheduled (false).
+    # or is it ad hoc/scheduled (false).
     attr_accessor :after_scan
     # Whether or not a scan is scheduled.
     attr_accessor :scheduled
@@ -459,13 +467,15 @@ module Nexpose
     def self.parse(xml)
       xml.elements.each('//Generate') do |generate|
         if generate.attributes['after-scan'] == '1'
-          return Generate.new(true, false)
+          return Frequency.new(true, false)
         else
           if generate.attributes['schedule'] == '1'
-            schedule = Schedule.parse(xml)
-            return Generate.new(false, true, schedule)
+            generate.elements.each('Schedule') do |sched|
+              schedule = Schedule.parse(sched)
+              return Frequency.new(false, true, schedule)
+            end
           end
-          return Generate.new(false, false)
+          return Frequency.new(false, false)
         end
       end
       nil

data/lib/nexpose/site.rb

@@ -358,8 +358,8 @@ module Nexpose
       xml << %Q(<ScanConfig configID="#{@id}" name="#{@scan_template_name || @scan_template}" templateID="#{@scan_template}" configVersion="#{@config_version || 3}" engineID="#{@engine}">)
 
       xml << '<Schedules>'
-      @schedules.each do |sched|
-        xml << %Q{<Schedule enabled="#{sched.enabled ? 1 : 0}" type="#{sched.type}" interval="#{sched.interval}" start="#{sched.start}" />}
+      @schedules.each do |schedule|
+        xml << schedule.to_xml
       end
       xml << '</Schedules>'
       xml << '</ScanConfig>'
@@ -405,12 +405,8 @@ module Nexpose
           site.scan_template = scan_config.attributes['templateID']
           site.config_version = scan_config.attributes['configVersion'].to_i
           site.engine = scan_config.attributes['engineID'].to_i
-          scan_config.elements.each('Schedules/Schedule') do |sched|
-            schedule = Schedule.new(sched.attributes['type'],
-                                    sched.attributes['interval'],
-                                    sched.attributes['start'],
-                                    sched.attributes['enabled'])
-            site.schedules << schedule
+          scan_config.elements.each('Schedules/Schedule') do |schedule|
+            site.schedules << Schedule.parse(schedule)
           end
         end
 

data/lib/nexpose/util.rb

@@ -11,7 +11,7 @@ module Nexpose
       ::REXML::Document.new(xml.to_s)
     end
 
-    def make_xml(name, opts={}, data='', append_session_id=true)
+    def make_xml(name, opts = {}, data = '', append_session_id = true)
       xml = REXML::Element.new(name)
       if @session_id and append_session_id
         xml.attributes['session-id'] = @session_id

data/lib/nexpose/vuln.rb

@@ -458,14 +458,13 @@ module Nexpose
       end
 
       expiration_date = input[:expiration_date]
-      if expiration_date && !expiration_date.empty? && expiration_date =~ /\A\desc{4}-(\desc{2})-(\desc{2})\z/
+      if expiration_date && !expiration_date.empty? && expiration_date =~ /\A\d{4}-(\d{2})-(\d{2})\z/
         if $1.to_i > 12
           raise ArgumentError.new 'The expiration date month value is invalid'
         end
-
-      if $2.to_i > 31
-        raise ArgumentError.new 'The expiration date day value is invalid'
-      end
+        if $2.to_i > 31
+          raise ArgumentError.new 'The expiration date day value is invalid'
+        end
       else
         raise ArgumentError.new 'Expiration date is invalid'
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - HD Moore
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-10 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librex