Class: Nexpose::AdhocReportConfig

Inherits:
Object
  • Object
show all
Includes:
XMLUtils
Defined in:
lib/nexpose/report.rb

Overview

Definition object for an adhoc report configuration.

NOTE: XML reports only return the text of the report, but no images.

Direct Known Subclasses

ReportConfig

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from XMLUtils

#make_xml, #parse_xml

Constructor Details

#initialize(template_id, format, site_id = nil, owner = nil, time_zone = nil) ⇒ AdhocReportConfig

Returns a new instance of AdhocReportConfig.



199
200
201
202
203
204
205
206
207
 
# File 'lib/nexpose/report.rb', line 199

def initialize(template_id, format, site_id = nil, owner = nil, time_zone = nil)
  @template_id = template_id
  @format = format
  @owner = owner
  @time_zone = time_zone

  @filters = []
  @filters << Filter.new('site', site_id) if site_id
end

Instance Attribute Details

#baseline ⇒ Object

Baseline comparison highlights the changes between two scans, including newly discovered assets, services and vulnerabilities, assets and services that are no longer available and vulnerabilities that were mitigated or fixed. The current scan results can be compared against the results of the first scan, the most recent (previous) scan, or the scan results from a particular date.



197
198
199
 
# File 'lib/nexpose/report.rb', line 197

def baseline
  @baseline
end

#filters ⇒ Object

Array of filters associated with this report.



190
191
192
 
# File 'lib/nexpose/report.rb', line 190

def filters
  @filters
end

#format ⇒ Object

Format. One of: pdf|html|rtf|xml|text|csv|db|raw-xml|raw-xml-v2|ns-xml|qualys-xml



185
186
187
 
# File 'lib/nexpose/report.rb', line 185

def format
  @format
end

#owner ⇒ Object

Returns the value of attribute owner.



186
187
188
 
# File 'lib/nexpose/report.rb', line 186

def owner
  @owner
end

#template_id ⇒ Object

The ID of the report template used.



183
184
185
 
# File 'lib/nexpose/report.rb', line 183

def template_id
  @template_id
end

#time_zone ⇒ Object

Returns the value of attribute time_zone.



187
188
189
 
# File 'lib/nexpose/report.rb', line 187

def time_zone
  @time_zone
end

Instance Method Details

#add_filter(type, id) ⇒ Object

Add a new filter to this report configuration.



210
211
212
 
# File 'lib/nexpose/report.rb', line 210

def add_filter(type, id)
  filters << Filter.new(type, id)
end

#generate(connection) ⇒ Object

Generate a report once using a simple configuration.

For XML-based reports, only the raw report is returned and not any images.

Parameters:

Returns:

  • Report in text format except for PDF, which returns binary data.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/nexpose/report.rb', line 238

def generate(connection)
  xml = %Q{<ReportAdhocGenerateRequest session-id='#{connection.session_id}'>}
  xml << to_xml
  xml << '</ReportAdhocGenerateRequest>'
  response = connection.execute(xml)
  if response.success
    content_type_response = response.raw_response.header['Content-Type']
    if content_type_response =~ /multipart\/mixed;\s*boundary=([^\s]+)/
      # Nexpose sends an incorrect boundary format which breaks parsing
      # e.g., boundary=XXX; charset=XXX
      # Fix by removing everything from the last semi-colon onward.
      last_semi_colon_index = content_type_response.index(/;/, content_type_response.index(/boundary/))
      content_type_response = content_type_response[0, last_semi_colon_index]

      data = 'Content-Type: ' + content_type_response + "\r\n\r\n" + response.raw_response_data
      doc = Rex::MIME::Message.new(data)
      doc.parts.each do |part|
        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
            end
          else # text|pdf|csv|rtf
            return part.content.unpack('m*')[0]
          end
        end
      end
    end
  end
end

#to_xml ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/nexpose/report.rb', line 214

def to_xml
  xml = %Q(<AdhocReportConfig format='#{@format}' template-id='#{@template_id}')
  xml << %Q( owner='#{@owner}') if @owner
  xml << %Q( timezone='#{@time_zone}') if @time_zone
  xml << '>'

  xml << '<Filters>'
  @filters.each { |filter| xml << filter.to_xml }
  xml << '</Filters>'

  xml << %Q(<Baseline compareTo='#{@baseline}' />) if @baseline

  xml << '</AdhocReportConfig>'
end