Class: Dradis::Plugins::Burp::Html::Importer

Inherits:
Upload::Importer
  • Object
show all
Defined in:
lib/dradis/plugins/burp/html/importer.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Importer

Returns a new instance of Importer.



18
19
20
21
 
# File 'lib/dradis/plugins/burp/html/importer.rb', line 18

def initialize(args={})
  args[:plugin] = Dradis::Plugins::Burp
  super(args)
end

Class Method Details

.templates ⇒ Object 



14
15
16
 
# File 'lib/dradis/plugins/burp/html/importer.rb', line 14

def self.templates
  { evidence: 'html_evidence', issue: 'html_issue' }
end

Instance Method Details

#extract_html_fragment_for(id) ⇒ Object

Html for an issue and evidence is not nested inside an html element.

An issue is the html fragment from <span id=“X”> (where X is a single integer number: 1, 2, 3…) until the next span like that or the end of the file.

An evidence is the html fragment from <span id=“X.Y”> (where X is the issue index and Y the evidence index: 1.1, 1.2,…,2.1, 2.2,…) until the next evidence span (id=“X.Z”), the next issue span (id=“Y”), or the end of the file.

This method extracts all the html related to as specific issue id or evidence id.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/dradis/plugins/burp/html/importer.rb', line 123

def extract_html_fragment_for(id)
  next_id = if /\d+\.\d+/ =~ id
              id_parts = id.split('.')
              "#{id_parts[0]}.#{id_parts[1].to_i + 1}"
            else
              id.to_i + 1
            end

  start_element = @doc.xpath("//span[@id='#{id}']")
  return nil if start_element.empty?

  ending_element = @doc.xpath("//span[@id='#{next_id}']")
  if ending_element.empty? && /\d+\.\d+/ =~ id
    next_id = id.split('.')[0].to_i + 1
    ending_element = @doc.xpath("//span[@id='#{next_id}']")
  end

  xpath = "//*[preceding-sibling::span[@id='#{id}']"
  xpath += " and following-sibling::span[@id='#{next_id}']" unless ending_element.empty?
  xpath += ']'

  start_element + @doc.xpath(xpath)
end

#import(params = {}) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/dradis/plugins/burp/html/importer.rb', line 23

def import(params = {})
  logger.info { 'Parsing Burp Scanner HTML output file...' }
  @doc = Nokogiri::HTML(File.read(params[:file]))
  logger.info { 'Done.' }

  # Issue headers are like: <span class="BODH0" id="X">
  issue_headers = @doc.xpath("//span[contains(@class, 'BODH0')]")

  if issue_headers.count.zero?
    error = "Document doesn't seem to be in the Burp Scanner HTML format."
    logger.fatal { error }
    content_service.create_note text: error
    return false
  end

  issue_headers.each do |header|
    issue_id = header.attr('id')
    html     = extract_html_fragment_for(issue_id)
    process_html_issue(html)
  end

  logger.info { 'Burp Scanner results successfully imported' }
  true
end

#process_html_evidence(html_evidence, issue) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/dradis/plugins/burp/html/importer.rb', line 89

def process_html_evidence(html_evidence, issue)
  evidence_id = html_evidence.attr('id').value
  logger.info { "Processing evidence #{evidence_id}" }

  host_td    = html_evidence.xpath("//td[starts-with(.,'Host:')]").first
  host_label = host_td.next_element.text.split('//').last
  host       = content_service.create_node(label: host_label, type: :host)

  evidence_text =
    mapping_service.apply_mapping(
      source: 'html_evidence',
      data: html_evidence
    )

  content_service.create_evidence(
    issue: issue,
    node: host,
    content: evidence_text
  )
end

#process_html_issue(html_issue) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/dradis/plugins/burp/html/importer.rb', line 48

def process_html_issue(html_issue)
  header     = html_issue.first
  title      = header.text.gsub(/^\d+\.\S/, '')
  burp_id =
    if (link = header.css('a').first)
      link.attr('href')[/\/([0-9a-f]+)_.*/, 1].to_i(16)
    else
      title
    end
  issue_id   = html_issue.attr('id').value
  issue_text =
    mapping_service.apply_mapping(
      source: 'html_issue',
      data: html_issue
    )

  logger.info { "Processing issue #{issue_id}: #{title}" }
  issue = content_service.create_issue(text: issue_text, id: burp_id)

  # Evidence headers are like:
  #   <span class="BODH1" id="X.Y">
  # where:
  #   X is the issue index
  #   Y is the evidence index
  evidence_headers = html_issue.xpath(
    "//span[contains(@class, 'BODH1') and starts-with(@id, '#{issue_id}.')]"
  )

  # If there are no evidence headers inside this issue, this is a
  # "single evidence" case: our evidence html is the issue html itself
  if evidence_headers.count.zero?
    process_html_evidence(html_issue, issue)
  else
    evidence_headers.each do |header|
      evidence_id = header.attr('id')
      html = extract_html_fragment_for(evidence_id)
      process_html_evidence(html, issue)
    end
  end
end