-
Notifications
You must be signed in to change notification settings - Fork 4
/
burp-dump.rb
539 lines (473 loc) · 22.6 KB
/
burp-dump.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
#!/usr/bin/env ruby
#
# Dump - a Burp plugin to dump HTTP(S) request/responses to a filesystem.
#
# Copyright (c) 2017, Richard Springs <richard.springs[at]stratumsecurity.com>
# All rights reserved.
#
# Significantly borrowed Java Swing/GridBag code from the dradis/burp-dradis.rb plugin, by Daniel Martin <etd[at]nomejortu.com>
#
# Licensed under GPLv2. See LICENSE.txt for full licensing information.
#
require 'date'
require 'fileutils'
require 'java'
require 'json'
require 'uri'
java_import 'java.awt.event.ActionListener'
java_import 'java.awt.BorderLayout'
java_import 'java.awt.Color'
java_import 'java.awt.Desktop'
java_import 'java.awt.FileDialog'
java_import 'java.awt.GridBagConstraints'
java_import 'java.awt.GridBagLayout'
java_import 'java.awt.Toolkit'
java_import 'java.awt.datatransfer.StringSelection'
java_import 'javax.swing.BorderFactory'
java_import 'javax.swing.Box'
java_import 'javax.swing.ButtonGroup'
java_import 'javax.swing.GroupLayout'
java_import 'javax.swing.JCheckBox'
java_import 'javax.swing.JEditorPane'
java_import 'javax.swing.JFileChooser'
java_import 'javax.swing.JMenuItem'
java_import 'javax.swing.JOptionPane'
java_import 'javax.swing.JPanel'
java_import 'javax.swing.JRadioButton'
java_import 'javax.swing.JSeparator'
java_import 'javax.swing.SwingConstants'
java_import 'burp.IBurpExtender'
java_import 'burp.IExtensionHelpers'
java_import 'burp.ITab'
class BurpExtender
include IBurpExtender, ITab
module META
NAME = 'Dump'
TAB_CAPTION = 'Dump'
VERSION = '0.0.7'
end
def registerExtenderCallbacks(callbacks)
@callbacks = callbacks
# set our extension name
callbacks.setExtensionName(META::NAME)
# obtain a reference to the helpers
@helpers = callbacks.getHelpers()
# obtain our output and error streams
@stdout = java.io.PrintWriter.new(callbacks.getStdout(), true)
@stderr = java.io.PrintWriter.new(callbacks.getStderr(), true)
@stdout.println "Loading #{META::NAME} (v#{META::VERSION})..."
# Add a configuration tab
callbacks.addSuiteTab(self)
# Restore settings
default_settings()
end
def getTabCaption
META::TAB_CAPTION
end
def getUiComponent
@tab ||= build_config_panel()
end
private
def build_config_panel
panel = javax.swing.JPanel.new
layout = java.awt.GridBagLayout.new
constraints = java.awt.GridBagConstraints.new
panel.setLayout(layout)
panel.setBorder( BorderFactory.createEtchedBorder() )
label_title = javax.swing.JLabel.new('<html><h3>Dump</h3></html>')
label_title.foreground = java.awt.Color.new(209,122,33)
label_description = javax.swing.JLabel.new('Use this plugin to dump HTTP(S) request/responses to a filesystem.')
label_edition = javax.swing.JLabel.new('Format:')
@radio_burp_text_logfile = javax.swing.JRadioButton.new('')
@radio_burp_text_logfile.addActionListener { clear_output_location() }
@radio_burp_text_logfile.selected = true
@radio_webscarab_logfile = javax.swing.JRadioButton.new('')
@radio_webscarab_logfile.addActionListener { clear_output_location() }
@logfile_type_group = javax.swing.ButtonGroup.new()
@logfile_type_group.add(@radio_burp_text_logfile)
@logfile_type_group.add(@radio_webscarab_logfile)
editor_burp_text_logfile = javax.swing.JEditorPane.new(
'text/html',
'Burp'
)
editor_burp_text_logfile.editable = false
editor_burp_text_logfile.opaque = false
editor_burp_text_logfile.background = java.awt.Color.new(0,0,0,0)
editor_burp_text_logfile.setToolTipText('Generates a single text file, containing all requests and responses. Format is very similar as the option generated under Project Options, Misc, Logging.')
editor_webscarab_logfile = javax.swing.JEditorPane.new(
'text/html',
'WebScarab'
)
editor_webscarab_logfile.editable = false
editor_webscarab_logfile.opaque = false
editor_webscarab_logfile.background = java.awt.Color.new(0,0,0,0)
editor_webscarab_logfile.setToolTipText('Generates a series of text files, where each request and response is saved into a separate file. Format is similar to the logging output generated by OWASP WebScarab.')
@field_host_filter = javax.swing.JTextField.new()
label_host_filter = javax.swing.JLabel.new('Host Filter:')
label_host_filter.setLabelFor(@field_host_filter)
label_host_filter.setToolTipText('Use * to log requests and responses for all hostnames. Enter a single hostname or list of hostnames separated by commas to filter on specific hosts. This filter does NOT use regular expressions.')
@field_burp_comment_header = javax.swing.JTextField.new()
@field_burp_comment_header.enabled = false
@label_burp_comment_header = javax.swing.JLabel.new('Burp Comment Header:')
@label_burp_comment_header.setLabelFor(@field_burp_comment_header)
@label_burp_comment_header.setToolTipText('Custom HTTP Header to insert Burp comments into request and responses.')
@field_context_separator = javax.swing.JTextField.new()
@field_context_separator.enabled = false
@label_context_separator = javax.swing.JLabel.new('Context Separator:')
@label_context_separator.setLabelFor(@field_context_separator)
@label_context_separator.setToolTipText('Burp comments matching the specified string update the context, which is included in all Burp Comment Header instances in addition to the current comment')
@field_output_location = javax.swing.JTextField.new()
label_output_location = javax.swing.JLabel.new('Output Location:')
label_output_location.setLabelFor(@field_output_location)
label_output_location.setToolTipText('Specify location for output')
button_open = javax.swing.JButton.new('Open')
button_open.add_action_listener { open_output_location }
button_dump = javax.swing.JButton.new('Dump')
button_dump.add_action_listener { dump }
@label_status = javax.swing.JLabel.new('')
vertical_glue = Box.createVerticalGlue()
constraints.anchor = java.awt.GridBagConstraints::NORTH
constraints.fill = java.awt.GridBagConstraints::BOTH
constraints.gridx = 0
constraints.gridy = 0
constraints.gridwidth = 6
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,0,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(label_title, constraints)
constraints.anchor = java.awt.GridBagConstraints::NORTH
constraints.fill = java.awt.GridBagConstraints::BOTH
constraints.gridx = 0
constraints.gridy = 1
constraints.gridwidth = 6
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(0,10,10,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(label_description, constraints)
constraints.anchor = java.awt.GridBagConstraints::EAST
constraints.fill = java.awt.GridBagConstraints::VERTICAL
constraints.gridx = 0
constraints.gridy = 2
constraints.gridwidth = 1
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(label_edition, constraints)
constraints.anchor = java.awt.GridBagConstraints::NORTH
constraints.fill = java.awt.GridBagConstraints::BOTH
constraints.gridx = 1
constraints.gridy = 2
constraints.gridwidth = 1
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,0)
constraints.weightx = 0
constraints.weighty = 0
panel.add(@radio_burp_text_logfile, constraints)
constraints.anchor = java.awt.GridBagConstraints::WEST
constraints.fill = java.awt.GridBagConstraints::VERTICAL
constraints.gridx = 2
constraints.gridy = 2
constraints.gridwidth = 1
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,0,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(editor_burp_text_logfile, constraints)
constraints.anchor = java.awt.GridBagConstraints::NORTH
constraints.fill = java.awt.GridBagConstraints::BOTH
constraints.gridx = 3
constraints.gridy = 2
constraints.gridwidth = 1
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,0)
constraints.weightx = 0
constraints.weighty = 0
panel.add(@radio_webscarab_logfile, constraints)
constraints.anchor = java.awt.GridBagConstraints::WEST
constraints.fill = java.awt.GridBagConstraints::VERTICAL
constraints.gridx = 4
constraints.gridy = 2
constraints.gridwidth = 1
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,0,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(editor_webscarab_logfile, constraints)
constraints.anchor = java.awt.GridBagConstraints::EAST
constraints.fill = java.awt.GridBagConstraints::VERTICAL
constraints.gridx = 0
constraints.gridy = 3
constraints.gridwidth = 1
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(label_host_filter, constraints)
constraints.anchor = java.awt.GridBagConstraints::NORTH
constraints.fill = java.awt.GridBagConstraints::BOTH
constraints.gridx = 1
constraints.gridy = 3
constraints.gridwidth = 4
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 1
constraints.weighty = 0
panel.add(@field_host_filter, constraints)
constraints.anchor = java.awt.GridBagConstraints::EAST
constraints.fill = java.awt.GridBagConstraints::VERTICAL
constraints.gridx = 0
constraints.gridy = 4
constraints.gridwidth = 1
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(@label_burp_comment_header, constraints)
constraints.anchor = java.awt.GridBagConstraints::NORTH
constraints.fill = java.awt.GridBagConstraints::BOTH
constraints.gridx = 1
constraints.gridy = 4
constraints.gridwidth = 4
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(@field_burp_comment_header, constraints)
constraints.anchor = java.awt.GridBagConstraints::EAST
constraints.fill = java.awt.GridBagConstraints::VERTICAL
constraints.gridx = 0
constraints.gridy = 5
constraints.gridwidth = 1
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(@label_context_separator, constraints)
constraints.anchor = java.awt.GridBagConstraints::NORTH
constraints.fill = java.awt.GridBagConstraints::BOTH
constraints.gridx = 1
constraints.gridy = 5
constraints.gridwidth = 4
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(@field_context_separator, constraints)
constraints.anchor = java.awt.GridBagConstraints::EAST
constraints.fill = java.awt.GridBagConstraints::VERTICAL
constraints.gridx = 0
constraints.gridy = 6
constraints.gridwidth = 1
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(label_output_location, constraints)
constraints.anchor = java.awt.GridBagConstraints::NORTH
constraints.fill = java.awt.GridBagConstraints::BOTH
constraints.gridx = 1
constraints.gridy = 6
constraints.gridwidth = 4
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(@field_output_location, constraints)
constraints.anchor = java.awt.GridBagConstraints::WEST
constraints.fill = java.awt.GridBagConstraints::VERTICAL
constraints.gridx = 5
constraints.gridy = 6
constraints.insets = java.awt.Insets.new(5,5,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(button_open, constraints)
constraints.anchor = java.awt.GridBagConstraints::WEST
constraints.fill = java.awt.GridBagConstraints::VERTICAL
constraints.gridx = 1
constraints.gridy = 8
constraints.insets = java.awt.Insets.new(5,10,5,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(button_dump, constraints)
constraints.anchor = java.awt.GridBagConstraints::NORTH
constraints.fill = java.awt.GridBagConstraints::BOTH
constraints.gridx = 4
constraints.gridy = 8
constraints.gridwidth = 4
constraints.gridheight = 1
constraints.insets = java.awt.Insets.new(5,10,10,5)
constraints.weightx = 0
constraints.weighty = 0
panel.add(@label_status, constraints)
container = javax.swing.JPanel.new
container.setLayout(java.awt.BorderLayout.new(5,5))
container.add(panel, java.awt.BorderLayout::PAGE_START)
container.add(vertical_glue, java.awt.BorderLayout::LINE_END)
container
end
def open_output_location
if @radio_burp_text_logfile.selected
file_chooser = Java::javax::swing::JFileChooser.new("JRuby panel")
file_chooser.set_dialog_title("Specify Output Location For Burp Log File")
success = file_chooser.show_open_dialog(nil)
if success == Java::javax::swing::JFileChooser::APPROVE_OPTION
output_location = file_chooser.get_selected_file.get_absolute_path
if output_location && output_location.length > 0
@field_output_location.text = output_location
end
end
elsif @radio_webscarab_logfile.selected
file_chooser = Java::javax::swing::JFileChooser.new("JRuby panel")
file_chooser.set_dialog_title("Specify Output Location For WebScarab Log File Directory")
file_chooser.setFileSelectionMode(Java::javax::swing::JFileChooser::DIRECTORIES_ONLY)
success = file_chooser.show_open_dialog(nil)
if success == Java::javax::swing::JFileChooser::APPROVE_OPTION
output_location = file_chooser.get_selected_file.get_absolute_path
if output_location && output_location.length > 0
@field_output_location.text = output_location
end
end
end
end
def clear_output_location
@field_output_location.text = ''
@label_status.text = ''
end
def default_settings
@field_host_filter.text = '*'
@field_output_location.text = ''
@field_burp_comment_header.text = 'X-Burp-Comment:'
@field_context_separator.text = '!!!'
@field_host_filter.enabled = true
@field_output_location.enabled = true
@field_burp_comment_header.enabled = true
@field_context_separator.enabled = true
end
def does_match_host_filter(current_host)
host_filter = @field_host_filter.text
# $host_filter uses wildcard match
if host_filter == "*"
return true
# $host_filter is a list of hosts separated by commas
elsif ! host_filter.index(',').nil?
host_filter.split(',').each do |host_in_filter|
if ! current_host.index(host_in_filter.strip).nil?
return true
end
end
# $host_filter is a single host
elsif ! current_host.index(host_filter.strip).nil?
return true
else
# wom wom
return false
end
end
def modify_with_comment(text, x_annotated_comment)
modified_text = ""
# if body is present, find the index of %0d%0a%0d%0a
line_return_index = text.index((@line_separator*2))
if ! line_return_index.nil? and line_return_index > 0
# insert annotated comment
modified_text = text[0..(line_return_index - 1)] + @line_separator + x_annotated_comment + text[line_return_index..text.length]
return modified_text
else
# something went wrong
return text
end
end
def update_with_comment(request, response, comment)
# detect Context Separator
if comment and comment.length > 0 and comment.include? @field_context_separator.text
@last_context = comment
end
# build Burp Comment Header
x_annotated_comment = "#{@field_burp_comment_header.text} #{comment} | #{@last_context}"
# modify request/response with Burp Comment Header
request, response = modify_with_comment(request, x_annotated_comment), modify_with_comment(response, x_annotated_comment)
return request, response
end
def write_to_filesystem(request, response)
File.open(@field_output_location.text + "/" + @counter.to_s + "-request" + @extension, "wb") do |f|
f.write(request)
end
File.open(@field_output_location.text + "/" + @counter.to_s + "-response" + @extension, "wb") do |f|
f.write(response)
end
end
def append_to_filesystem(request, response, protocol, host, port)
log_separator = "=" * 54 + @line_separator
meta_separator = " " * 2
uri = protocol + "://" + host + ":" + port.to_s
fake_ipaddress = "[" + host + "]" # faked, not accessible via Extender API
fake_time = @fake_timestamp.strftime("%I:%M:%S %p") # faked, not accessible via Extender API
header = log_separator + fake_time + meta_separator + uri + meta_separator + fake_ipaddress + @line_separator + log_separator
log_entry = header + request + @line_separator + log_separator + response + @line_separator + log_separator + @line_separator * 3
File.open(@field_output_location.text, "ab") do |f|
f.write(log_entry)
end
end
def dump()
start_time = Time.now
@counter = 1
@line_separator = "\r\n"
@last_context = ""
@extension = ".txt"
@fake_timestamp = Time.new("+12:00") # faked, not accessible via Extender API
# return error message if Host Header Filter is blank,
if @field_host_filter.text == ""
javax.swing.JOptionPane.showMessageDialog(nil, "Please specify a Host Header Filter.")
return
end
# return error message if Output Location is blank
if @field_output_location.text == ""
javax.swing.JOptionPane.showMessageDialog(nil, "Please specify an Output Location.")
return
end
# return error message if Output Location exists (Burp)
if @radio_burp_text_logfile.selected == true && File.exist?(@field_output_location.text)
javax.swing.JOptionPane.showMessageDialog(nil, "Output File already exists.\nPlease specify a new Output Location")
return
end
# return error message if Output Location contains files (WebScarab)
if @radio_webscarab_logfile.selected == true
unsorted_file_list = Dir.entries(@field_output_location.text)
if ! unsorted_file_list.nil? && unsorted_file_list.length > 2 # ".", ".."" for empty directories
javax.swing.JOptionPane.showMessageDialog(nil, "Output Directory already contains files.\nPlease specify a new Output Location")
return
end
end
# iterate through BurpSuite's proxy history
proxy_history = @callbacks.getProxyHistory()
if ! proxy_history.nil? && proxy_history.length > 0
proxy_history.each do |item|
begin
# filter out unwanted requests/responses via host header
if item.host && item.host.length > 0 && does_match_host_filter(item.host)
request, response = item.request.to_s, item.response.to_s
# insert Burp Comment Header into request/response, unless Burp Comment Header is empty
if @field_burp_comment_header && @field_burp_comment_header.text.length > 0
comment = item.get_comment.to_s
request, response = update_with_comment(request, response, comment)
end
# write to disk
if @radio_webscarab_logfile.selected == true
write_to_filesystem(request, response)
elsif @radio_burp_text_logfile.selected == true
append_to_filesystem(request, response, item.protocol, item.host, item.port)
end
end
rescue IOError => e
# javax.swing.JOptionPane.showMessageDialog(nil, "If you can see me, something has gone horribly wrong :(")
end
@counter += 1
@fake_timestamp = @fake_timestamp + 1
end
end
# display message upon completion
@label_status.text = "Last Dump Completed @ #{Time.now.strftime "%H:%M:%S %m/%d/%Y"} (~ #{Time.now.to_i - start_time.to_i}s)"
end
end