peplum-nmap 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8b8cbc832f6aba1427bc571e95d2dcf1bdcf1cca46373f1ea291bb43923586f
-  data.tar.gz: 06a2cbcae6e9d5bb77d4502eb4f29e82dd6425ec473e70a38fd39a2d9f8d8c5c
+  metadata.gz: 77102d2b6c314e3b3f3585bb3d892338b81080087289b11631e2295cf4711499
+  data.tar.gz: cf41927ba26efe42963c4064522c3e68735f5deb3163e6067dbb863b5470daa3
 SHA512:
-  metadata.gz: e5b9cabeeeda80a9f419ecfbdf0248edd4e43d90940aa099b023b0d510c04fd6fa568073704a24a4dc187d6ec4d0d5ba7929da5f939ef0ee20dd46efe8bb16be
-  data.tar.gz: 3fec8a89cf625873b304f3d487e6be807d3e33a18294552a41ee8a1107bbf79d6d62619a4488214de082154507bfe44231ae5b28f87cdc724d5e4226a342ed4b
+  metadata.gz: ad0e5f023991b6b8c95ae46621fbb4ce55f64dabc1a6509abc6b7767571facdff926077b8e23213d5f362e38dec82f926cd97f9fc5d1a5bcb65cdacdbfd8fce8
+  data.tar.gz: 866b15d443a8a0b7bb33a57548fb460bff9fec8bf3b4120aee08e27730e62caf24041bcf58c464f327557a5c3d1bbd3c293a8d70114ff18996fed3d788a0b23b

data/examples/rest.rb

@@ -28,7 +28,7 @@ request :post, 'instances', {
     objects:     ['192.168.1.*'],
     max_workers: 5
   },
-  native: {
+  payload: {
     connect_scan:   true,
     service_scan:   true,
     default_script: true
@@ -39,6 +39,9 @@ request :post, 'instances', {
 instance_id = response_data['id']
 
 while sleep( 1 )
+  request :get, "instances/#{instance_id}/info/progress"
+  ap response_data
+
   # Continue looping while instance status is 'busy'.
   request :get, "instances/#{instance_id}"
   break if !response_data['busy']

data/examples/rpc.rb

@@ -16,7 +16,7 @@ nmap.run(
     objects:     ['192.168.1.*'],
     max_workers: 5
   },
-  native: {
+  payload: {
     connect_scan:   true,
     service_scan:   true,
     default_script: true
@@ -24,7 +24,10 @@ nmap.run(
 )
 
 # Waiting to complete.
-sleep 1 while nmap.running?
+while nmap.running?
+  ap nmap.info.progress
+  sleep 1
+end
 
 # Hooray!
 puts JSON.pretty_generate( nmap.generate_report.data )

data/lib/peplum/nmap/{native.rb → payload.rb}

@@ -5,7 +5,7 @@ require 'tmpdir'
 module Peplum
 class Nmap
 
-module Native
+module Payload
 
   DEFAULT_OPTIONS = {
     'output_normal' => '/dev/null',
@@ -21,8 +21,16 @@ module Native
   end
 
   def run( targets, options )
-    _run options.merge( targets: targets, output_xml: SCAN_REPORT )
-    report_from_xml( SCAN_REPORT )
+    # Do it this way so we'll be able to have progress reports per scanned host.
+    merge( targets.map do |target|
+      _run options.merge( targets: target, output_xml: SCAN_REPORT )
+
+      report = report_from_xml( SCAN_REPORT )
+      next if !report.include?('hosts')
+
+      Nmap::Application.master.info.update report
+      report
+    end.compact )
   end
 
   def group( targets, chunks )
@@ -45,7 +53,12 @@ module Native
          ping:       true,
          output_xml: PING_REPORT
 
-    hosts_from_xml( PING_REPORT )
+    hosts = hosts_from_xml( PING_REPORT )
+
+    # Seed the progress data with the live hosts
+    hosts.each { |h| Services::Info.progress_data['hosts'][h] ||= {} }
+
+    hosts
   end
 
   def set_default_options( nmap )

data/lib/peplum/nmap/services/info.rb

@@ -0,0 +1,26 @@
+module Peplum
+class Nmap
+module Services
+
+class Info
+
+  class <<self
+    def progress_data
+      @progress_data ||= { 'hosts' => {} }
+    end
+  end
+
+  def progress
+    self.class.progress_data
+  end
+
+  def update( data )
+    self.class.progress_data['hosts'].merge! Payload.merge( [self.class.progress_data, data] )['hosts']
+    nil
+  end
+
+end
+
+end
+end
+end

data/lib/peplum/nmap/services/rest_proxy.rb

@@ -0,0 +1,17 @@
+module Peplum
+class Nmap
+module Services
+module RESTProxy
+def self.registered( app )
+
+  app.get '/progress' do
+    instance_for( params[:instance] ) do |instance|
+      json instance.info.progress
+    end
+  end
+
+end
+end
+end
+end
+end

data/lib/peplum/nmap/version.rb

@@ -2,6 +2,6 @@
 
 module Peplum
 class Nmap
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end
 end

data/lib/peplum/nmap.rb

@@ -6,13 +6,20 @@ module Peplum
 class Nmap
 
   require_relative "nmap/version"
-  require_relative "nmap/native"
+  require_relative "nmap/payload"
 
   class Error < Peplum::Error; end
 
   class Application < Peplum::Application
-    def native_app
-      Native
+
+    require_relative "nmap/services/info"
+    instance_service_for :info, Services::Info
+
+    require_relative "nmap/services/rest_proxy"
+    rest_service_for :info, Services::RESTProxy
+
+    def payload
+      Payload
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peplum-nmap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tasos Laskos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: peplum
@@ -52,7 +52,9 @@ files:
 - examples/rest/helpers.rb
 - examples/rpc.rb
 - lib/peplum/nmap.rb
-- lib/peplum/nmap/native.rb
+- lib/peplum/nmap/payload.rb
+- lib/peplum/nmap/services/info.rb
+- lib/peplum/nmap/services/rest_proxy.rb
 - lib/peplum/nmap/version.rb
 - peplum-nmap.gemspec
 homepage: http://ecsypno.com/