Class: NexposeTicketing::CommonHelper

Inherits:
Object
  • Object
show all
Defined in:
lib/nexpose_ticketing/common_helper.rb

Constant Summary collapse

MAX_NUM_REFS = 
3

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ CommonHelper

Returns a new instance of CommonHelper.



5
6
7
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 5

def initialize(options)
  @ticketing_mode = options[:ticket_mode]
end

Instance Method Details

#generate_nxid(nexpose_id, row) ⇒ Object

Generates the NXID. The NXID is a unique identifier used to find and update and/or close tickets.

  • Args :

    • nexpose_identifier_id - Site/TAG ID the tickets are being generated for. Required for all? { |e| } ticketing modes

    • row - Row from the generated Nexpose CSV report. Required for default (‘D’) mode.

    • current_ip - The IP address of that this ticket is for. Required for IP mode (‘I’) mode.

  • Returns :

    • NXID string.



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 203

def generate_nxid(nexpose_id, row)
  fail 'Row data is nil' if row.nil?

  case @ticketing_mode
    when 'D' then "#{nexpose_id}d#{row['asset_id']}d#{row['vulnerability_id']}"
    when 'I' then "#{nexpose_id}i#{row['ip_address']}"
    when 'V' then "#{nexpose_id}v#{row['vulnerability_id']}"
    else fail 'Ticketing mode not recognised.'
  end
end

#get_assets(row) ⇒ Object

Returns the assets for a vulnerability in a format suitable to be inserted into a ticket.

- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • String formatted with affected assets.



319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 319

def get_assets(row)  
  status = row['comparison']
  header = "\n#{status || 'Affected' } Assets\n"

  assets = []
  row['assets'].to_s.split('~').each do |a|
    details = a.split('|')
    assets << " - #{details[1]} #{"\t(#{details[2]})" if !details[2].empty?}"
  end
  asset_list = assets.join("\n")
  "#{header}#{asset_list}"
end

#get_default_ticket_description(description, row) ⇒ Object

Generates a hash containing the information necessary to generate a Default-mode ticket description.

- +description+ - Base ticket hash with NXID.
- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • Hash containing ticket description information.



73
74
75
76
77
78
79
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 73

def get_default_ticket_description(description, row)
  description[:header] = get_vuln_header(row)
  description[:header] << get_discovery_info(row)
  description[:references] = get_references(row)
  description[:solutions] = get_solutions(row)
  description
end

#get_description(nexpose_id, row) ⇒ Object

Gets the base description hash from the relevant mode-specific method which can converted into a finished description.

- +nexpose_id+ - The site or tag indentifier.
- +options+ -  The options read from the ticket config file.

  • Returns :

    • Hash containing ticket description information.



18
19
20
21
22
23
24
25
26
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 18

def get_description(nexpose_id, row)
  description = { nxid: "NXID: #{generate_nxid(nexpose_id, row)}" }
  case @ticketing_mode
  when 'D' then get_default_ticket_description(description, row)
  when 'I' then get_ip_ticket_description(description, row)
  when 'V' then get_vuln_ticket_description(description, row)
  else fail "Ticketing mode #{@ticketing_mode} not recognised."
  end
end

#get_discovery_info(row) ⇒ Object 



288
289
290
291
292
293
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 288

def get_discovery_info(row)
  return '' if row['first_discovered'].to_s == ""
  info = "\nFirst Seen: #{row['first_discovered']}\n"
  info << "Last Seen: #{row['most_recently_discovered']}\n"
  info
end

#get_field_info(fields, row) ⇒ Object

Returns the relevant row values for printing.

- +fields+ -  The fields which are relevant to the ticket.
- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • String formatted with relevant fields.



340
341
342
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 340

def get_field_info(fields, row)
  fields.map { |x| "#{x.sub("_", " ")}: #{row[x]}" }.join(", ")
end

#get_ip_ticket_description(description, row) ⇒ Object

Generates a hash containing the information necessary to generate an IP-mode ticket description.

- +description+ - Base ticket hash with NXID.
- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • Hash containing ticket description information.



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 90

def get_ip_ticket_description(description, row)
  description[:vulnerabilities] = []

  status = row['comparison']
  vuln_info = "++ #{status} Vulnerabilities ++\n" if !status.nil?
  description[:ticket_status] = status

  vuln_info = vuln_info.to_s + get_vuln_info(row)
  description[:vulnerabilities] << vuln_info
  description
end

#get_references(row) ⇒ Object

Formats the references for a vulnerability in a format suitable to be inserted into a ticket.

- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • String formatted with source and reference.



302
303
304
305
306
307
308
309
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 302

def get_references(row)
  return '' if row['references'].nil?
  references = "\nSources:\n"
  refs =  row['references'].split(', ')
  refs[MAX_NUM_REFS] = '...' if refs.count > MAX_NUM_REFS
  refs[0..MAX_NUM_REFS].each { |r| references << " - #{r}\n" }
  references
end

#get_short_summary(row) ⇒ Object

Generates a short summary for a vulnerability.

- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • String containing a short summary of the vulnerability.



270
271
272
273
274
275
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 270

def get_short_summary(row)
  summary = row['solutions']
  delimiter = summary.to_s.index('|')
  return summary[summary.index(':')+1...delimiter].strip if delimiter
  summary.length <= 100 ? summary : summary[0...100]
end

#get_solutions(row) ⇒ Object

Formats the solutions for a vulnerability in a format suitable to be inserted into a ticket.

- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • String formatted with solution information.



284
285
286
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 284

def get_solutions(row)
  row['solutions'].to_s.gsub('|', "\n").gsub('~', "\n--\n")
end

#get_title(row, maximum = nil) ⇒ Object

Generates the ticket’s title depending on the ticketing mode.

- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • String containing the ticket title.



251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 251

def get_title(row, maximum=nil)
  title = case @ticketing_mode
      when 'D' then "#{row['ip_address']} => #{get_short_summary(row)}"
      when 'I' then "#{row['ip_address']} => Vulnerabilities"
      when 'V' then "Vulnerability: #{row['title']}"
      else fail 'Ticketing mode not recognised.'
    end
  return title if maximum == nil || title.length < maximum

  title = "#{title[0, 97]}..."
end

#get_vuln_header(row) ⇒ Object

Generates the vulnerability header from the row data.

- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • String formatted with vulnerability data.



236
237
238
239
240
241
242
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 236

def get_vuln_header(row)
  ticket = "\n=============================="
  ticket << "\nVulnerability ID: #{row['vulnerability_id']}"
  ticket << "\nCVSS Score: #{row['cvss_score']}"
  ticket << "\n=============================="
  ticket
end

#get_vuln_info(row) ⇒ Object

Formats the row data to be inserted into a ‘D’ or ‘I’ mode ticket description.

- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • String formatted with vulnerability data.



221
222
223
224
225
226
227
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 221

def get_vuln_info(row)
  ticket = get_vuln_header(row)
  ticket << get_discovery_info(row)
  ticket << get_references(row)
  ticket << "\n#{get_solutions(row)}"
  ticket.gsub("\n", "\n ")
end

#get_vuln_ticket_description(description, row) ⇒ Object

Generates a hash containing the information necessary to generate a Vulnerability-mode ticket description.

- +description+ - Base ticket hash with NXID.
- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • Hash containing ticket description information.



111
112
113
114
115
116
117
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 111

def get_vuln_ticket_description(description, row)
  description[:header] = get_vuln_header(row)
  description[:references] = get_references(row)
  description[:solutions] = get_solutions(row)
  description[:assets] = get_assets(row)
  description
end

#print_default_ticket_description(description) ⇒ Object

Generates a final description string based on a Default-mode description hash.

- +description+ - The finished ticket hash to be converted.

  • Returns :

    • String containing ticket description text.



159
160
161
162
163
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 159

def print_default_ticket_description(description)
  ticket = "#{description[:header]}\n#{description[:references]}"
  ticket << "#{description[:solutions]}"
  ticket
end

#print_description(description) ⇒ Object

Generates a final description string based on a description hash.

- +description+ - The finished ticket hash to be converted.

  • Returns :

    • String containing ticket description text.



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 53

def print_description(description)
  ticket = case @ticketing_mode
           when 'D' then print_default_ticket_description(description)
           when 'I' then print_ip_ticket_description(description)
           when 'V' then print_vuln_ticket_description(description)
           else fail "Ticketing mode #{@ticketing_mode} not recognised."
           end
  ticket << "\n\n\n#{description[:nxid]}"
  ticket
end

#print_ip_ticket_description(description) ⇒ Object

Generates a final description string based on an IP-mode description hash.

- +description+ - The finished ticket hash to be converted.

  • Returns :

    • String containing ticket description text.



173
174
175
176
177
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 173

def print_ip_ticket_description(description)
  ticket = ''
  description[:vulnerabilities].each { |v| ticket << "#{v}\n" } 
  ticket
end

#print_vuln_ticket_description(description) ⇒ Object

Generates a final description string based on a Vulnerability-mode description hash.

- +description+ - The finished ticket hash to be converted.

  • Returns :

    • String containing ticket description text.



187
188
189
190
191
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 187

def print_vuln_ticket_description(description)
  ticket = "#{description[:header]}\n#{description[:assets]}"
  ticket << "\n#{description[:references]}\n#{description[:solutions]}"
  ticket
end

#update_description(description, row) ⇒ Object

Updates an existing description hash containing information necessary to generate a ticket description. Note that Default mode tickets may not be updated.

- +description+ - The existing ticket hash to be updated.
- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • Hash containing ticket description information.



38
39
40
41
42
43
44
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 38

def update_description(description, row)
  case @ticketing_mode
  when 'I' then return update_ip_ticket_description(description, row)
  when 'V' then return update_vuln_ticket_description(description, row)
  else description
  end
end

#update_ip_ticket_description(description, row) ⇒ Object

Updates an existing IP-mode description hash containing information necessary to generate a ticket description.

- +description+ - The existing ticket hash to be updated.
- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • Hash containing updated ticket description information.



128
129
130
131
132
133
134
135
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 128

def update_ip_ticket_description(description, row)
  status = row['comparison']
  header = "++ #{status} Vulnerabilities ++\n"
  header = "" unless description[:ticket_status] != status
  
  description[:vulnerabilities] << "#{header}#{get_vuln_info(row)}"
  description
end

#update_vuln_ticket_description(description, row) ⇒ Object

Updates an existing Vulnerability-mode description hash containing information necessary to generate a ticket description.

- +description+ - The existing ticket hash to be updated.
- +row+ -  CSV row containing vulnerability data.

  • Returns :

    • Hash containing updated ticket description information.



146
147
148
149
 
# File 'lib/nexpose_ticketing/common_helper.rb', line 146

def update_vuln_ticket_description(description, row)
  description[:assets] += "\n#{get_assets(row)}"
  description
end