Class: Nexpose::ScanData

Inherits:
Object
  • Object
show all
Defined in:
lib/nexpose/scan.rb

Overview

Minimal scan data object. Unlike ScanSummary, these objects don’t collect vulnerability data, which can be rather verbose and isn’t useful for many automation scenarios.

Direct Known Subclasses

ScanSummary

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scan_id, site_id, engine_id, status, start_time, end_time) ⇒ ScanData

Constructor



464
465
466
 
# File 'lib/nexpose/scan.rb', line 464

def initialize(scan_id, site_id, engine_id, status, start_time, end_time)
  @scan_id, @site_id, @engine_id, @status, @start_time, @end_time = scan_id, site_id, engine_id, status, start_time, end_time
end

Instance Attribute Details

#end_time ⇒ Object (readonly)

The scan finish time



458
459
460
 
# File 'lib/nexpose/scan.rb', line 458

def end_time
  @end_time
end

#engine_id ⇒ Object (readonly)

The Engine ID the scan was dispatched to.



454
455
456
 
# File 'lib/nexpose/scan.rb', line 454

def engine_id
  @engine_id
end

#scan_id ⇒ Object (readonly)

The Scan ID of the Scan



450
451
452
 
# File 'lib/nexpose/scan.rb', line 450

def scan_id
  @scan_id
end

#site_id ⇒ Object (readonly)

The site that was scanned.



452
453
454
 
# File 'lib/nexpose/scan.rb', line 452

def site_id
  @site_id
end

#start_time ⇒ Object (readonly)

The scan start time



456
457
458
 
# File 'lib/nexpose/scan.rb', line 456

def start_time
  @start_time
end

#status ⇒ Object (readonly)

The scan status. One of: running|finished|stopped|error|dispatched|paused|aborted|uknown



461
462
463
 
# File 'lib/nexpose/scan.rb', line 461

def status
  @status
end

Class Method Details

.parse(xml) ⇒ Object 



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/nexpose/scan.rb', line 468

def self.parse(xml)
  # Start time can be empty in some error conditions.
  start_time = nil
  unless xml.attributes['startTime'] == ''
    start_time = DateTime.parse(xml.attributes['startTime'].to_s).to_time
    # Timestamp is UTC, but parsed as local time.
    start_time -= start_time.gmt_offset
  end

  # End time is often not present, since reporting on running scans.
  end_time = nil
  if xml.attributes['endTime']
    end_time = DateTime.parse(xml.attributes['endTime'].to_s).to_time
    # Timestamp is UTC, but parsed as local time.
    end_time -= end_time.gmt_offset
  end

  ScanData.new(xml.attributes['scan-id'].to_i,
               xml.attributes['site-id'].to_i,
               xml.attributes['engine-id'].to_i,
               xml.attributes['status'],
               start_time,
               end_time)
end