Class: Nexpose::AdhocReportConfig
- Inherits:
-
Object
- Object
- Nexpose::AdhocReportConfig
- 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
Instance Attribute Summary collapse
-
#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.
-
#filters ⇒ Object
Array of filters associated with this report.
-
#format ⇒ Object
Format.
-
#language ⇒ Object
Returns the value of attribute language.
-
#owner ⇒ Object
Returns the value of attribute owner.
-
#template_id ⇒ Object
The ID of the report template used.
-
#time_zone ⇒ Object
Returns the value of attribute time_zone.
Instance Method Summary collapse
-
#add_filter(type, id) ⇒ Object
Add a new filter to this report configuration.
-
#generate(connection) ⇒ Object
Generate a report once using a simple configuration.
-
#initialize(template_id, format, site_id = nil, owner = nil, time_zone = nil) ⇒ AdhocReportConfig
constructor
A new instance of AdhocReportConfig.
- #to_xml ⇒ Object
Methods included from XMLUtils
Constructor Details
#initialize(template_id, format, site_id = nil, owner = nil, time_zone = nil) ⇒ AdhocReportConfig
Returns a new instance of AdhocReportConfig.
191 192 193 194 195 196 197 198 199 |
# File 'lib/nexpose/report.rb', line 191 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.
189 190 191 |
# File 'lib/nexpose/report.rb', line 189 def baseline @baseline end |
#filters ⇒ Object
Array of filters associated with this report.
182 183 184 |
# File 'lib/nexpose/report.rb', line 182 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
176 177 178 |
# File 'lib/nexpose/report.rb', line 176 def format @format end |
#language ⇒ Object
Returns the value of attribute language.
179 180 181 |
# File 'lib/nexpose/report.rb', line 179 def language @language end |
#owner ⇒ Object
Returns the value of attribute owner.
177 178 179 |
# File 'lib/nexpose/report.rb', line 177 def owner @owner end |
#template_id ⇒ Object
The ID of the report template used.
174 175 176 |
# File 'lib/nexpose/report.rb', line 174 def template_id @template_id end |
#time_zone ⇒ Object
Returns the value of attribute time_zone.
178 179 180 |
# File 'lib/nexpose/report.rb', line 178 def time_zone @time_zone end |
Instance Method Details
#add_filter(type, id) ⇒ Object
Add a new filter to this report configuration.
202 203 204 |
# File 'lib/nexpose/report.rb', line 202 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.
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/nexpose/report.rb', line 231 def generate(connection) xml = %(<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
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/nexpose/report.rb', line 206 def to_xml xml = %(<AdhocReportConfig format='#{@format}' template-id='#{@template_id}') xml << %( owner='#{@owner}') if @owner xml << %( timezone='#{@time_zone}') if @time_zone xml << %( language='#{@language}') if @language xml << '>' xml << '<Filters>' @filters.each { |filter| xml << filter.to_xml } xml << '</Filters>' xml << %(<Baseline compareTo='#{@baseline}' />) if @baseline xml << '</AdhocReportConfig>' end |