nexposecli 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a07316475b55fdc50b6e3fa3ee0541a43e5f2d5f
-  data.tar.gz: 46bbc3f787e9cc57a48d2faac0f80ef60ed902a3
+  metadata.gz: d2600f716f565ba39880a04fac81dcfbf020da2f
+  data.tar.gz: 42100610ee2c841a9228f2d030605a27544f9dfa
 SHA512:
-  metadata.gz: c806214d80328f916283d549b127b5a1002d4d7b9047a545a2bfc327050354b4ed80f3d8a79893825546e738cbc0c4fc046a93c16a9d2b529acb3880ddc9e37a
-  data.tar.gz: 6a384917b44f606e4267052ddd5fafebe44d46d0c7e827abac61bdef11542f8d57ec70d402ac0145e186ab1934a1b7444c294a094eb13ef6e3a76f794df6e840
+  metadata.gz: 29a4f6751333290493c6c9f85fd86316978df295bb089b90347c20dc3dc79c9092e8ea40b2e82b8422990ae1fd370595e124599becf28d1c552d95eefcc1bff2
+  data.tar.gz: 454045409cc51ec66e798f893c16ba0895699e704f69f4fad1c418864fd74d1a955e85c5c147ffcba5c10438bc70a8aeefe8d8ddb139229605503f3ad44b5583

data/bin/nexposecli

@@ -37,8 +37,11 @@ require 'pp'
 # Set default var values
 $nxport = 3780
 $debug = false
+$filteradd = false
 $format = 'default'
 $dryrun = false
+$norun = false
+$nodload = false
 $multitenant = false
 uf_scanners = ''
 
@@ -290,6 +293,9 @@ if args.scanpath
 end
 
 $debug = TRUE if args.verbose
+$norun = TRUE if args.norun
+$nodload = TRUE if args.nodload
+$filteradd = TRUE if args.filteradd
 $multitenant = TRUE if args.silo
 $dryrun = TRUE if args.dryrun
 uputs("CLI", "Command-line verbosity mode is #{$debug.to_s}")
@@ -315,8 +321,10 @@ uputs("CLI", "Checking for the requested action")
 @action |= 32 if args.run
 @action |= 64 if args.sync
 @action |= 128 if args.copy
+@action |= 256 if args.download
+@action |= 512 if args.status
 uputs("ACTION", "The requested action value is: #{@action.to_s}")
-raise "You can only submit one action per task, see --help (action submitted: #{@action.to_s})" unless [1,2,4,8,16,32,64,128].include?(@action)
+raise "You can only submit one action per task, see --help (action submitted: #{@action.to_s})" unless [1,2,4,8,16,32,64,128,256,512].include?(@action)
 
 uputs("TARGET", "Checking for the requested target")
 @target = 0
@@ -612,6 +620,23 @@ when 2   # TARGET ENGINE
   when 16  # delete
     uputs("ACTION", 'delete ENGINE action requested')
     puts 'Not yet implemented'
+  when 512  # status
+    uputs("ACTION", 'status ENGINE action requested')
+    filter = "Name"
+    filterv = ".*"
+ 
+    if args.filter != nil && args.filterv != nil
+       filter = "#{args.filter}"
+       filterv = "#{args.filterv}"
+    end
+    engines = @nsc.engine_versions 
+    puts '%25s' % "Name" + ' ' + '%10s' % "Status" + ' ' + '%10s' % "Version" + ' ' + '%25s' % "Last Product Update ID" + ' ' + '%25s' % "Last Content Update ID"
+    engines.each do |engine|
+       if engine[filter].match(filterv)
+          upp engine
+          puts '%25s' % engine["Name"] + ' ' + '%10s' % engine["Status"] + ' ' + '%10s' % engine["Version"] + ' ' + '%25s' % engine["Last Product Update ID"] + ' ' + '%25s' % engine["Last Content Update ID"]
+       end
+    end
   else
     uputs("ACTION", 'The action requested is not implemented for target')
     puts 'The action requested is not implemented for target'
@@ -674,9 +699,25 @@ when 8   # TARGET SCAN
   when 1   # create
     uputs("SCAN", 'create SCAN action requested')
     unless (
-      args.id != nil && ( args.range || args.targets )
+      (args.id != nil && ( args.range || args.targets )) || args.id != nil
     )
-      raise 'Please supply the site id and ip range, or targets to scan, see --help'
+      raise 'Please supply the site id OR the site id and ip range, or targets to scan, see --help'
+    end
+
+    if ( args.range == nil && args.targets == nil )
+       # Site Scan only
+       uputs("SCAN", "SCAN action requested for Site Id[#{args.id}]")
+       site = Nexpose::Site.load(@nsc, args.id.to_i)
+       puts 'The SCAN action requested will be submitted'
+       begin
+          scan = site.scan(@nsc)
+       rescue Nexpose::APIError => e
+          STDERR.puts "ERROR [ For Site Id[#{args.id}] #{e.to_s} ]"
+          exit(-1)
+       end
+       puts "The SCAN action requested has been submitted, and is running using: Site Id[#{args.id}] Scan Id[#{scan.id}] Scan Engine/Pool Id[#{scan.id}]"
+       upp scan
+       exit(0)
     end
 
     # CLI args for scan task attempts and sleep interval
@@ -1395,55 +1436,86 @@ when 32  # TARGET ASSET
    end
 when 64  # TARGET REPORT
    case @action
-   when 1   # create
+   when 1, 32   # create and run
       uputs("ACTION", 'create REPORT action requested')
+   if args.name == nil
+      args.name = "Default Report Name"
+   end
+   if (args.id != nil) || (args.template != nil)
+      report_config = nil
+      if args.id != nil
+         report_config = Nexpose::ReportConfig.load(@nsc, args.id)
+         upp report_config
+      elsif args.template != nil
+         report_config = Nexpose::ReportConfig.new(args.name, args.template, args.format, -1)
+         begin
+            report_config.save(@nsc, false)
+         rescue Nexpose::APIError => e
+           uputs("REPORT", "An error occurred while attempting to create the report config: #{e.to_s}")
+           STDERR.puts "ERROR [ " + e.to_s + " ]"
+           exit(-1)
+         end
+      end
 
-   if (args.id != nil)
-      report_config = Nexpose::ReportConfig.load(@nsc, args.id)
-      report_config.filters.delete_if do |filter|
-         if filter.type == "device"
-           upp filter
-           true
+      unless $filteradd
+         report_config.filters.delete_if do |filter|
+            # if filter.type == "device"
+            if ["device","site","group"].include?(filter.type)
+              upp filter
+              true
+            end
          end
+         uputs("DEBUG", 'report_config.filters post device filter deletion')
       end
-      uputs("DEBUG", 'report_config.filters post device filter deletion')
       upp(report_config.filters)
 
+      if args.filter && args.filterv
+            uputs("DEBUG", "report_config.filters #{args.filter} : #{args.filterv} ")
+            report_config.add_filter(args.filter.to_s, args.filterv.to_i)
+      end
       if (args.host != nil)
          # EJG pass site id through...
          device = @nsc.find_device_by_address( args.host, args.site)
          if (device != nil)
-            report_config.id = -1
+            # report_config.id = -1
             scan_asset_device_id = device.id.to_i
-            report_config.name = "Asset: " + args.host.to_s + " (" + Time.now.strftime("%Y%m%d%H%M%S") + ")"
+            report_config.name = "#{args.name}: " + args.host.to_s + " (" + Time.now.strftime("%Y%m%d%H%M%S") + ")"
             report_config.add_filter('device', scan_asset_device_id)
             report_config.save(@nsc)
          else
             puts "Device Id is nil. No match found for ip: " + args.host.to_s + "\n"
          end
       else
-         report_config.name = "Default Report Name (" + Time.now.strftime("%Y%m%d%H%M%S") + ")"
-      end
-      puts "- Running the report now...\n"
-      report_run = report_config.generate(@nsc)
-
-      # check for report run status
-      report_summary = @nsc.last_report(report_config.id)
-      while report_summary.status != "Generated"
-          puts "- Sleeping... " + report_summary.status.to_s + "\n"
-          sleep(2)
-          report_summary = @nsc.last_report(report_config.id)
+         report_config.name = "#{args.name} (" + Time.now.strftime("%Y%m%d%H%M%S") + ")"
+         report_config.save(@nsc)
+      end
+
+      unless $norun
+         puts "- Running the report now...\n"
+         report_run = report_config.generate(@nsc)
+         puts "- Report job has been submitted.\n"
+
+         unless $nodload
+            # check for report run status
+            report_summary = @nsc.last_report(report_config.id)
+            while report_summary.status != "Generated"
+                puts "- Sleeping... " + report_summary.status.to_s + "\n"
+                sleep(2)
+                report_summary = @nsc.last_report(report_config.id)
+            end
+         end
       end
-      # pp report_summary
 
-      puts "---\n- Report Id: " + report_config.id.to_s + " \n"
-      puts "---\n- The report can be found via:\n https://#{@nsc_server}:3780" + report_summary.uri.to_s + "\n"
+      unless $norun || $nodload
+         puts "---\n- Report Id: " + report_config.id.to_s + " \n"
+         puts "---\n- The report can be found via:\n https://#{@nsc_server}:3780" + report_summary.uri.to_s + "\n"
 
-      report_filename = report_summary.uri.split('/').last
-      if (args.name != nil)
-         report_filename.sub! 'Document', "#{args.name}"
+         report_filename = report_summary.uri.split('/').last
+         if (args.name != nil)
+            report_filename.sub! 'Document', "#{args.name}"
+         end
+         download("https://#{@nsc_server}:3780" + report_summary.uri.to_s, "./#{Time.now.strftime("%Y%m%d_%H%M%S_")}#{report_filename}", @nsc)
       end
-      download("https://#{@nsc_server}:3780" + report_summary.uri.to_s, "./#{Time.now.strftime("%Y%m%d_%H%M%S_")}#{report_filename}", @nsc)
    end
 
    when 2   # list
@@ -1463,6 +1535,29 @@ when 64  # TARGET REPORT
    when 16  # delete
       uputs("ACTION", 'delete REPORT action requested')
       puts 'Not yet implemented'
+   when 256 # download
+      uputs("ACTION", 'download REPORT action requested')
+      # check for report run status
+      report_summary = @nsc.last_report(args.id.to_i)
+      upp report_summary
+      while report_summary.status != "Generated"
+          puts "- Sleeping... " + report_summary.status.to_s + "\n"
+          sleep(2)
+          report_summary = @nsc.last_report(args.id.to_i)
+      end
+
+      puts "---\n- Report Id: " + args.id.to_s + " \n"
+      puts "---\n- The report can be found via:\n https://#{@nsc_server}:3780" + report_summary.uri.to_s + "\n"
+
+      report_filename = report_summary.uri.split('/').last
+      if (args.name != nil)
+         report_filename.sub! 'Document', "#{args.name}"
+      end
+      download("https://#{@nsc_server}:3780" + report_summary.uri.to_s, "./generated#{report_summary.generated_on}_#{report_filename}", @nsc)
+   when 512 # status
+      uputs("ACTION", 'status REPORT action requested')
+      report_summary = @nsc.last_report(args.id.to_i)
+      puts "The report status for report config id[#{args.id}] is: #{report_summary.status}"
    else
       uputs("ACTION", 'The action requested is not implemented for target')
       puts 'The action requested is not implemented for target'

data/lib/nexposecli/args.rb

@@ -15,9 +15,21 @@ module Nexposecli
        short                 : v
        desc                  : Run verbosely
    
+     - name                  : filteradd
+       desc                  : Filter mode default is FALSE for replace, if TRUE add
+   
      - name                  : dryrun
        desc                  : Dry run mode, do not commit to Console
    
+     - name                  : norun
+       desc                  : Do not execute or generate the object affected
+   
+     - name                  : nodload
+       desc                  : Do not download the object affected
+   
+     - name                  : download
+       desc                  : Download the generated Report locally, into the current directory
+   
      - comment               : EVM Administrative Actions
    
      - name                  : create
@@ -35,6 +47,9 @@ module Nexposecli
        short                 : s
        desc                  : The show action is used to display details of a single object
    
+     - name                  : status
+       desc                  : The status action is used to display the status of a single object
+   
      - name                  : update
        short                 : u
        desc                  : The update action is used to change properties of a single object
@@ -207,6 +222,10 @@ module Nexposecli
        desc                  : The desired format of the output, default, csv
        required              : true
    
+     - name                  : format
+       desc                  : The desired format of the report, default is csv
+       required              : true
+   
      - name                  : filter
        short                 : f
        desc                  : Filters which are applied to the action, in the form key:value pairs

data/lib/nexposecli/version.rb

@@ -1,3 +1,3 @@
 module Nexposecli
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexposecli
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Erik Gomez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nexpose