Module: PWN::Plugins::BurpSuite

Defined in:
lib/pwn/plugins/burp_suite.rb

Overview

This plugin was created to interact w/ Burp Suite Pro in headless mode to kick off spidering/live scanning

Class Method Summary collapse

Class Method Details

.active_scan(opts = {}) ⇒ Object

Supported Method Parameters

active_scan_url_arr = PWN::Plugins::BurpSuite.active_scan(

burp_obj: 'required - burp_obj returned by #start method',
target_url: 'required - target url to scan in sitemap (should be loaded & authenticated w/ burp_obj[:mitm_browser])',
exclude_paths: 'optional - array of paths to exclude from active scan (default: [])'

)



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1662

public_class_method def self.active_scan(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]
  target_url = opts[:target_url].to_s.scrub.strip.chomp
  raise 'ERROR: target_url parameter is required' if target_url.empty?

  exclude_paths = opts[:exclude_paths] ||= []

  target_scheme = URI.parse(target_url).scheme
  target_host = URI.parse(target_url).host
  target_path = URI.parse(target_url).path
  target_port = URI.parse(target_url).port.to_i
  active_scan_url_arr = []

  json_sitemap = get_sitemap(burp_obj: burp_obj, url: target_url)
  json_sitemap.uniq.each do |site|
    # Skip if the site does not have a request or http_service
    next if site[:request].empty?

    json_req = site[:request]
    b64_decoded_req = Base64.strict_decode64(json_req)
    json_path = b64_decoded_req.split[1].to_s.scrub.strip.chomp
    next if exclude_paths.include?(json_path)

    json_query = json_path.split('?')[1].to_s.scrub.strip.chomp

    json_http_svc = site[:http_service]
    json_protocol = json_http_svc[:protocol]
    json_host = json_http_svc[:host].to_s.scrub.strip.chomp
    json_port = json_http_svc[:port].to_i

    json_uri = format_uri_from_sitemap_resp(
      scheme: json_protocol,
      host: json_host,
      port: json_port,
      path: json_path,
      query: json_query
    )

    uri_in_scope = in_scope(
      burp_obj: burp_obj,
      uri: json_uri
    )

    puts "Skipping #{json_uri} - not in scope. Check out #{self}.help >>  #add_to_scope method" unless uri_in_scope
    next unless uri_in_scope

    # If the protocol is HTTPS, set use_https to true
    use_https = false
    use_https = true if json_protocol == 'https'

    print "Adding #{json_uri} to Active Scan"
    active_scan_url_arr.push(json_uri)
    post_body = {
      host: json_host,
      port: json_port,
      use_https: use_https,
      request: json_req
    }.to_json
    # Kick off an active scan for each given page in the json_sitemap results
    resp = rest_browser.post(
      "http://#{mitm_rest_api}/scan/active",
      post_body,
      content_type: 'application/json'
    )
    puts " => #{resp.code}"
  rescue RestClient::ExceptionWithResponse => e
    puts " => #{e.response.code}" if e.respond_to?(:response) && e.response
    next
  end

  # Wait for scan completion
  loop do
    scan_queue = rest_browser.get("http://#{mitm_rest_api}/scan/active")
    json_scan_queue = JSON.parse(scan_queue, symbolize_names: true)
    break if json_scan_queue.all? { |scan| scan[:status] == 'finished' }

    puts "\n\n\n"
    puts '-' * 90
    json_scan_queue.each do |scan|
      puts "Target ID: #{scan[:id]}, Request Count: #{scan[:request_count]}, Progress: #{scan[:percent_complete]}%, Status: #{scan[:status]}"
    end

    sleep 30
  end
  # scan_queue_total = json_scan_queue.count
  # json_scan_queue.each do |scan_item|
  #   this_scan_item_id = scan_item[:id]
  #   until scan_item[:status] == 'finished'
  #     scan_item_resp = rest_browser.get("http://#{mitm_rest_api}/scan/active/#{this_scan_item_id}")
  #     scan_item = JSON.parse(scan_item_resp, symbolize_names: true)
  #     scan_status = scan_item[:status]
  #     puts "Target ID ##{this_scan_item_id} of ##{scan_queue_total}| #{scan_status}"
  #     sleep 3
  #   end
  #   puts "Target ID ##{this_scan_item_id} of ##{scan_queue_total}| 100% complete\n"
  # end

  active_scan_url_arr # Return array of targeted URIs to pass to #generate_scan_report method
rescue StandardError => e
  # stop(burp_obj: burp_obj) unless burp_obj.nil?
  puts e.backtrace
  raise e
end

.add_proxy_listener(opts = {}) ⇒ Object

Supported Method Parameters

json_proxy_listener = PWN::Plugins::BurpSuite.add_proxy_listener(

burp_obj: 'required - burp_obj returned by #start method',
bindAddress: 'required - bind address for the proxy listener (e.g., "127.0.0.1")',
port: 'required - port for the proxy listener (e.g., 8081)',
enabled: 'optional - enable the listener (defaults to true)'

)



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/pwn/plugins/burp_suite.rb', line 527

public_class_method def self.add_proxy_listener(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]
  bind_address = opts[:bindAddress]
  raise 'ERROR: bindAddress parameter is required' if bind_address.nil?

  port = opts[:port]
  raise 'ERROR: port parameter is required' if port.nil?

  enabled = opts[:enabled] != false # Default to true if not specified

  proxy_listeners = get_proxy_listeners(burp_obj: burp_obj)
  last_known_proxy_id = 0
  last_known_proxy_id = proxy_listeners.last[:id].to_i if proxy_listeners.any?
  next_id = last_known_proxy_id + 1

  post_body = {
    id: next_id.to_s,
    bindAddress: bind_address,
    port: port,
    enabled: enabled
  }.to_json

  listener = rest_browser.post("http://#{mitm_rest_api}/proxy/listeners", post_body, content_type: 'application/json; charset=UTF8')
  JSON.parse(listener, symbolize_names: true)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.add_repeater_tab(opts = {}) ⇒ Object

Supported Method Parameters

repeater_id = PWN::Plugins::BurpSuite.add_repeater_tab(

burp_obj: 'required - burp_obj returned by #start method',
name: 'required - name of the repeater tab (max 30 characters)',
request: 'optional - base64 encoded HTTP request string'

)



1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1797

public_class_method def self.add_repeater_tab(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  name = opts[:name]
  raise 'ERROR: name parameter is required' if name.nil?

  request = opts[:request]
  raise 'ERROR: request parameter is required' if request.nil?

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  post_body = {
    name: name[0..29],
    request: request
  }.to_json

  repeater_resp = rest_browser.post(
    "http://#{mitm_rest_api}/repeater",
    post_body,
    content_type: 'application/json; charset=UTF8'
  )

  repeater_resp = JSON.parse(repeater_resp, symbolize_names: true)
  { id: repeater_resp[:value] }
rescue StandardError => e
  raise e
end

.add_to_scope(opts = {}) ⇒ Object

Supported Method Parameters

json_in_scope = PWN::Plugins::BurpSuite.add_to_scope(

burp_obj: 'required - burp_obj returned by #start method',
target_url: 'required - target url to add to scope'

)



407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/pwn/plugins/burp_suite.rb', line 407

public_class_method def self.add_to_scope(opts = {})
  burp_obj = opts[:burp_obj]
  target_url = opts[:target_url]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  post_body = { url: target_url }.to_json

  in_scope = rest_browser.post("http://#{mitm_rest_api}/scope", post_body, content_type: 'application/json; charset=UTF8')
  JSON.parse(in_scope, symbolize_names: true)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.add_to_sitemap(opts = {}) ⇒ Object

Supported Method Parameters: json_sitemap = PWN::Plugins::BurpSuite.add_to_sitemap(

burp_obj: 'required - burp_obj returned by #start method',
sitemap: 'required - sitemap hash to add',
debug: 'optional - boolean to enable sitemap debugging (default: false)'

)

Example: json_sitemap = PWN::Plugins::BurpSuite.add_to_sitemap(

burp_obj: burp_obj,
sitemap: {
  request: 'base64_encoded_request_string',
  response: 'base64_encoded_response_string',
  highlight: 'NONE'||'RED'||'ORANGE'||'YELLOW'||'GREEN'||'CYAN'||'BLUE'||'PINK'||'MAGENTA'||'GRAY',
  comment: 'optional comment for the sitemap entry',
  http_service: {
    host: 'example.com',
    port: 80,
    protocol: 'http'
  }
}



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1144

public_class_method def self.add_to_sitemap(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]
  sitemap = opts[:sitemap] ||= {}
  debug = opts[:debug] || false

  rest_client = rest_browser::Request
  response = rest_client.execute(
    method: :post,
    url: "http://#{mitm_rest_api}/sitemap",
    payload: sitemap.to_json,
    headers: { content_type: 'application/json; charset=UTF-8' },
    timeout: 10
  )

  if debug
    puts "\nSubmitted:"
    puts sitemap.inspect
    print 'Press Enter to continue...'
    gets
  end
  # Return response body (assumed to be JSON)
  JSON.parse(response.body, symbolize_names: true)
rescue RestClient::ExceptionWithResponse => e
  puts "ERROR: Failed to add to sitemap: #{e.message}"
  puts "HTTP error adding to sitemap: Status #{e.response.code}, Response: #{e.response.body}" if e.respond_to?(:response) && e.response.respond_to?(:code) && e.response.respond_to?(:body)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.authors ⇒ Object

Author(s)

0day Inc. <support@0dayinc.com>



2059
2060
2061
2062
2063
 
# File 'lib/pwn/plugins/burp_suite.rb', line 2059

public_class_method def self.authors
  "AUTHOR(S):
    0day Inc. <support@0dayinc.com>
  "
end

.delete_proxy_listener(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::BurpSuite.delete_proxy_listener(

burp_obj: 'required - burp_obj returned by #start method',
id: 'optional - ID of the proxy listener (defaults to 0)'

)



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/pwn/plugins/burp_suite.rb', line 601

public_class_method def self.delete_proxy_listener(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]
  id = opts[:id] ||= 0
  proxy_listeners = get_proxy_listeners(burp_obj: burp_obj)
  listener_by_id = proxy_listeners.find { |listener| listener[:id].to_i == id.to_i }
  raise "ERROR: No proxy listener found with ID #{id}" if listener_by_id.nil?

  rest_browser.delete("http://#{mitm_rest_api}/proxy/listeners/#{id}")
  true # Return true to indicate successful deletion (or error if API fails)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.delete_repeater_tab(opts = {}) ⇒ Object

Supported Method Parameters

uri_in_scope = PWN::Plugins::BurpSuite.delete_repeater_tab(

burp_obj: 'required - burp_obj returned by #start method',
id: 'required - id of the repeater tab to delete'

)



1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1947

public_class_method def self.delete_repeater_tab(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  id = opts[:id]
  raise 'ERROR: id parameter is required' if id.nil?

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  rest_browser.delete(
    "http://#{mitm_rest_api}/repeater/#{id}",
    content_type: 'application/json; charset=UTF8'
  )

  { id: id }
rescue StandardError => e
  raise e
end

.disable_proxy(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::BurpSuite.disable_proxy(

burp_obj: 'required - burp_obj returned by #start method'

)



490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/pwn/plugins/burp_suite.rb', line 490

public_class_method def self.disable_proxy(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  disable_resp = rest_browser.post("http://#{mitm_rest_api}/proxy/intercept/disable", nil)
  JSON.parse(disable_resp, symbolize_names: true)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.enable_proxy(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::BurpSuite.enable_proxy(

burp_obj: 'required - burp_obj returned by #start method'

)



473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/pwn/plugins/burp_suite.rb', line 473

public_class_method def self.enable_proxy(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  enable_resp = rest_browser.post("http://#{mitm_rest_api}/proxy/intercept/enable", nil)
  JSON.parse(enable_resp, symbolize_names: true)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.generate_scan_report(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::BurpSuite.generate_scan_report(

burp_obj: 'required - burp_obj returned by #start method',
target_url: 'required - target_url passed to #active_scan method',
output_dir: 'required - directory to save the report',
report_type: required - <:html|:xml>'

)



1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1975

public_class_method def self.generate_scan_report(opts = {})
  burp_obj = opts[:burp_obj]
  target_url = opts[:target_url]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]
  output_dir = opts[:output_dir]
  raise "ERROR: #{output_dir} does not exist." unless Dir.exist?(output_dir)

  report_type = opts[:report_type]

  valid_report_types_arr = %i[html xml]
  raise "ERROR: INVALID Report Type => #{report_type}" unless valid_report_types_arr.include?(report_type)

  case report_type
  when :html
    report_path = "#{output_dir}/burp_active_scan_results.html"
  when :xml
    report_path = "#{output_dir}/burp_active_scan_results.xml"
  end

  scheme = URI.parse(target_url).scheme
  host = URI.parse(target_url).host
  port = URI.parse(target_url).port
  path = URI.parse(target_url).path
  query = URI.parse(target_url).query

  target_domain = format_uri_from_sitemap_resp(
    scheme: scheme,
    host: host,
    port: port,
    path: path,
    query: query
  )

  puts "Generating #{report_type} report for #{target_domain}..."
  report_url = Base64.strict_encode64(target_domain)
  # Ready scanreport API call in pwn_burp to support HTML & XML report generation
  report_resp = rest_browser.get(
    "http://#{mitm_rest_api}/scanreport/#{report_type.to_s.upcase}/#{report_url}"
  )

  File.open(report_path, 'w') do |f|
    f.puts(report_resp.body.gsub("\r\n", "\n"))
  end
rescue RestClient::BadRequest => e
  puts e.response
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.get_all_repeater_tabs(opts = {}) ⇒ Object

Supported Method Parameters

repeater_tabs = PWN::Plugins::BurpSuite.get_all_repeater_tabs(

burp_obj: 'required - burp_obj returned by #start method'

)



1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1832

public_class_method def self.get_all_repeater_tabs(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  repeater_resp = rest_browser.get(
    "http://#{mitm_rest_api}/repeater",
    content_type: 'application/json; charset=UTF8'
  )

  JSON.parse(repeater_resp, symbolize_names: true)
rescue StandardError => e
  raise e
end

.get_proxy_history(opts = {}) ⇒ Object

Supported Method Parameters

json_proxy_history = PWN::Plugins::BurpSuite.get_proxy_history(

burp_obj: 'required - burp_obj returned by #start method',
limit: 'optional - number of proxy history entries to return (default: 200)',
offset: 'optional - offset for pagination of proxy history entries (default: 0)',
uri: 'optional - filter proxy history entries by URI (default: nil)',
highlight: 'optional - highlight color to filter proxy history results (default: "NONE")',
keyword: 'optional - keyword to filter proxy history entries (default: nil)',
return_as: 'optional - :base64 or :har (defaults to :base64)'

)



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/pwn/plugins/burp_suite.rb', line 628

public_class_method def self.get_proxy_history(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  limit = opts[:limit] ||= 200
  offset = opts[:offset] ||= 0
  uri = opts[:uri]
  highlight = opts[:highlight] ||= 'NONE'
  keyword = opts[:keyword]
  return_as = opts[:return_as] ||= :base64

  if uri.nil?
    rest_call = "http://#{mitm_rest_api}/proxy/history?limit=#{limit}&offset=#{offset}&highlight=#{highlight}"
  else
    base64_encoded_uri = Base64.strict_encode64(uri.to_s.scrub.strip.chomp)
    rest_call = "http://#{mitm_rest_api}/proxy/history/#{base64_encoded_uri}?limit=#{limit}&offset=#{offset}&highlight=#{highlight}"
  end

  sitemap = rest_browser.get(
    rest_call,
    content_type: 'application/json; charset=UTF8'
  )

  sitemap_arr = JSON.parse(sitemap, symbolize_names: true)

  if keyword
    sitemap_arr = sitemap_arr.select do |site|
      decoded_request = Base64.strict_decode64(site[:request])
      decoded_request.include?(keyword)
    end
  end

  if return_as == :har
    # Convert to HAR format
    har_entries = sitemap_arr.map do |site|
      decoded_request = Base64.strict_decode64(site[:request])

      # Parse request head and body
      if decoded_request.include?("\r\n\r\n")
        request_head, request_body = decoded_request.split("\r\n\r\n", 2)
      else
        request_head = decoded_request
        request_body = ''
      end
      request_lines = request_head.split("\r\n")
      request_line = request_lines.shift
      method, full_path, http_version = request_line.split(' ', 3)
      headers = {}
      request_lines.each do |line|
        next if line.empty?

        key, value = line.split(': ', 2)
        headers[key] = value if key && value
      end

      host = headers['Host'] || raise('No Host header found in request')
      scheme = 'http' # Hardcoded as protocol is not available; consider enhancing if available in site
      url = "#{scheme}://#{host}#{full_path}"
      uri = URI.parse(url)
      query_string = uri.query ? URI.decode_www_form(uri.query).map { |k, v| { name: k, value: v.to_s } } : []

      request_headers_size = request_head.bytesize + 4 # Account for \r\n\r\n
      request_body_size = request_body.bytesize

      request_obj = {
        method: method,
        url: uri.to_s,
        httpVersion: http_version,
        headers: headers.map { |k, v| { name: k, value: v } },
        queryString: query_string,
        headersSize: request_headers_size,
        bodySize: request_body_size
      }

      if request_body_size.positive?
        mime_type = headers['Content-Type'] || 'application/octet-stream'
        post_data = {
          mimeType: mime_type,
          text: request_body
        }
        post_data[:params] = URI.decode_www_form(request_body).map { |k, v| { name: k, value: v.to_s } } if mime_type.include?('x-www-form-urlencoded')
        request_obj[:postData] = post_data
      end

      if site[:response]
        decoded_response = Base64.strict_decode64(site[:response])

        # Parse response head and body
        if decoded_response.include?("\r\n\r\n")
          response_head, response_body = decoded_response.split("\r\n\r\n", 2)
        else
          response_head = decoded_response
          response_body = ''
        end
        response_lines = response_head.split("\r\n")
        status_line = response_lines.shift
        version, status_str, status_text = status_line.split(' ', 3)
        status = status_str.to_i
        status_text ||= ''
        response_headers = {}
        response_lines.each do |line|
          next if line.empty?

          key, value = line.split(': ', 2)
          response_headers[key] = value if key && value
        end

        response_headers_size = response_head.bytesize + 4 # Account for \r\n\r\n
        response_body_size = response_body.bytesize
        mime_type = response_headers['Content-Type'] || 'text/plain'

        response_obj = {
          status: status,
          statusText: status_text,
          httpVersion: version,
          headers: response_headers.map { |k, v| { name: k, value: v } },
          content: {
            size: response_body_size,
            mimeType: mime_type,
            text: response_body
          },
          redirectURL: response_headers['Location'] || '',
          headersSize: response_headers_size,
          bodySize: response_body_size
        }
      else
        response_obj = {
          status: 0,
          statusText: 'No response',
          httpVersion: 'unknown',
          headers: [],
          content: {
            size: 0,
            mimeType: 'text/plain',
            text: ''
          },
          redirectURL: '',
          headersSize: -1,
          bodySize: 0
        }
      end

      {
        startedDateTime: Time.now.iso8601,
        time: 0,
        request: request_obj,
        response: response_obj,
        cache: {},
        timings: {
          send: 0,
          wait: 0,
          receive: 0
        },
        pageref: 'page_1'
      }
    end

    har_log = {
      log: {
        version: '1.2',
        creator: {
          name: 'BurpSuite via PWN::Plugins::BurpSuite',
          version: '1.0'
        },
        pages: [{
          startedDateTime: Time.now.iso8601,
          id: 'page_1',
          title: 'Sitemap Export',
          pageTimings: {}
        }],
        entries: har_entries
      }
    }

    sitemap_arr = har_log
  end

  sitemap_arr.uniq
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.get_proxy_listeners(opts = {}) ⇒ Object

Supported Method Parameters

json_proxy_listeners = PWN::Plugins::BurpSuite.get_proxy_listeners(

burp_obj: 'required - burp_obj returned by #start method'

)



507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/pwn/plugins/burp_suite.rb', line 507

public_class_method def self.get_proxy_listeners(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  listeners = rest_browser.get("http://#{mitm_rest_api}/proxy/listeners", content_type: 'application/json; charset=UTF8')
  JSON.parse(listeners, symbolize_names: true)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.get_repeater_tab(opts = {}) ⇒ Object

Supported Method Parameters

repeater_tab = PWN::Plugins::BurpSuite.get_repeater_tab(

burp_obj: 'required - burp_obj returned by #start method',
id: 'required - id of the repeater tab to get'

)



1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1855

public_class_method def self.get_repeater_tab(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  id = opts[:id]
  raise 'ERROR: id parameter is required' if id.nil?

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  repeater_resp = rest_browser.get(
    "http://#{mitm_rest_api}/repeater/#{id}",
    content_type: 'application/json; charset=UTF8'
  )

  JSON.parse(repeater_resp, symbolize_names: true)
rescue StandardError => e
  raise e
end

.get_scan_issues(opts = {}) ⇒ Object

Supported Method Parameters

json_scan_issues = PWN::Plugins::BurpSuite.get_scan_issues(

burp_obj: 'required - burp_obj returned by #start method'

)



1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1773

public_class_method def self.get_scan_issues(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  rest_client = rest_browser::Request
  scan_issues = rest_client.execute(
    method: :get,
    url: "http://#{mitm_rest_api}/scanissues",
    timeout: 540
  )
  JSON.parse(scan_issues, symbolize_names: true)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.get_sitemap(opts = {}) ⇒ Object

Supported Method Parameters

json_sitemap = PWN::Plugins::BurpSuite.get_sitemap(

burp_obj: 'required - burp_obj returned by #start method',
limit: 'optional - number of sitemap entries to return (default: 200)',
offset: 'optional - offset for pagination of sitemap entries (default: 0)',
uri: 'optional - URI to filter sitemap entries (default: nil)',
highlight: 'optional - highlight color to filter proxy history results (default: "NONE")',
keyword: 'optional - keyword to filter sitemap entries (default: nil)',
return_as: 'optional - :base64 or :har (defaults to :base64)'

)



938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/pwn/plugins/burp_suite.rb', line 938

public_class_method def self.get_sitemap(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  limit = opts[:limit] ||= 200
  offset = opts[:offset] ||= 0
  uri = opts[:uri]
  highlight = opts[:highlight] ||= 'NONE'
  keyword = opts[:keyword]
  return_as = opts[:return_as] ||= :base64

  if uri.nil?
    rest_call = "http://#{mitm_rest_api}/sitemap?limit=#{limit}&offset=#{offset}&highlight=#{highlight}"
  else
    base64_encoded_uri = Base64.strict_encode64(uri.to_s.scrub.strip.chomp)
    rest_call = "http://#{mitm_rest_api}/sitemap/#{base64_encoded_uri}?limit=#{limit}&offset=#{offset}&highlight=#{highlight}"
  end

  sitemap = rest_browser.get(
    rest_call,
    content_type: 'application/json; charset=UTF8'
  )

  sitemap_arr = JSON.parse(sitemap, symbolize_names: true)

  if keyword
    sitemap_arr = sitemap_arr.select do |site|
      decoded_request = Base64.strict_decode64(site[:request])
      decoded_request.include?(keyword)
    end
  end

  if return_as == :har
    # Convert to HAR format
    har_entries = sitemap_arr.map do |site|
      decoded_request = Base64.strict_decode64(site[:request])

      # Parse request head and body
      if decoded_request.include?("\r\n\r\n")
        request_head, request_body = decoded_request.split("\r\n\r\n", 2)
      else
        request_head = decoded_request
        request_body = ''
      end
      request_lines = request_head.split("\r\n")
      request_line = request_lines.shift
      method, full_path, http_version = request_line.split(' ', 3)
      headers = {}
      request_lines.each do |line|
        next if line.empty?

        key, value = line.split(': ', 2)
        headers[key] = value if key && value
      end

      host = headers['Host'] || raise('No Host header found in request')
      scheme = 'http' # Hardcoded as protocol is not available; consider enhancing if available in site
      url = "#{scheme}://#{host}#{full_path}"
      uri = URI.parse(url)
      query_string = uri.query ? URI.decode_www_form(uri.query).map { |k, v| { name: k, value: v.to_s } } : []

      request_headers_size = request_head.bytesize + 4 # Account for \r\n\r\n
      request_body_size = request_body.bytesize

      request_obj = {
        method: method,
        url: uri.to_s,
        httpVersion: http_version,
        headers: headers.map { |k, v| { name: k, value: v } },
        queryString: query_string,
        headersSize: request_headers_size,
        bodySize: request_body_size
      }

      if request_body_size.positive?
        mime_type = headers['Content-Type'] || 'application/octet-stream'
        post_data = {
          mimeType: mime_type,
          text: request_body
        }
        post_data[:params] = URI.decode_www_form(request_body).map { |k, v| { name: k, value: v.to_s } } if mime_type.include?('x-www-form-urlencoded')
        request_obj[:postData] = post_data
      end

      if site[:response]
        decoded_response = Base64.strict_decode64(site[:response])

        # Parse response head and body
        if decoded_response.include?("\r\n\r\n")
          response_head, response_body = decoded_response.split("\r\n\r\n", 2)
        else
          response_head = decoded_response
          response_body = ''
        end
        response_lines = response_head.split("\r\n")
        status_line = response_lines.shift
        version, status_str, status_text = status_line.split(' ', 3)
        status = status_str.to_i
        status_text ||= ''
        response_headers = {}
        response_lines.each do |line|
          next if line.empty?

          key, value = line.split(': ', 2)
          response_headers[key] = value if key && value
        end

        response_headers_size = response_head.bytesize + 4 # Account for \r\n\r\n
        response_body_size = response_body.bytesize
        mime_type = response_headers['Content-Type'] || 'text/plain'

        response_obj = {
          status: status,
          statusText: status_text,
          httpVersion: version,
          headers: response_headers.map { |k, v| { name: k, value: v } },
          content: {
            size: response_body_size,
            mimeType: mime_type,
            text: response_body
          },
          redirectURL: response_headers['Location'] || '',
          headersSize: response_headers_size,
          bodySize: response_body_size
        }
      else
        response_obj = {
          status: 0,
          statusText: 'No response',
          httpVersion: 'unknown',
          headers: [],
          content: {
            size: 0,
            mimeType: 'text/plain',
            text: ''
          },
          redirectURL: '',
          headersSize: -1,
          bodySize: 0
        }
      end

      {
        startedDateTime: Time.now.iso8601,
        time: 0,
        request: request_obj,
        response: response_obj,
        cache: {},
        timings: {
          send: 0,
          wait: 0,
          receive: 0
        },
        pageref: 'page_1'
      }
    end

    har_log = {
      log: {
        version: '1.2',
        creator: {
          name: 'BurpSuite via PWN::Plugins::BurpSuite',
          version: '1.0'
        },
        pages: [{
          startedDateTime: Time.now.iso8601,
          id: 'page_1',
          title: 'Sitemap Export',
          pageTimings: {}
        }],
        entries: har_entries
      }
    }

    sitemap_arr = har_log
  end

  sitemap_arr.uniq
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.get_websocket_history(opts = {}) ⇒ Object

Supported Method Parameters

json_web_socket_history = PWN::Plugins::BurpSuite.get_websocket_history(

burp_obj: 'required - burp_obj returned by #start method',
limit: 'optional - number of websocket history entries to return (default: 200)',
offset: 'optional - offset for pagination of websocket history entries (default: 0)',
highlight: 'optional - highlight color to filter websocket history results (default: "NONE")',
keyword: 'optional - keyword to filter websocket history entries (default: nil)'

)



858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/pwn/plugins/burp_suite.rb', line 858

public_class_method def self.get_websocket_history(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  limit = opts[:limit] ||= 200
  offset = opts[:offset] ||= 0
  highlight = opts[:highlight] ||= 'NONE'
  keyword = opts[:keyword]

  rest_call = "http://#{mitm_rest_api}/websocket/history?limit=#{limit}&offset=#{offset}&highlight=#{highlight}"

  sitemap = rest_browser.get(
    rest_call,
    content_type: 'application/json; charset=UTF8'
  )

  sitemap_arr = JSON.parse(sitemap, symbolize_names: true)

  if keyword
    sitemap_arr = sitemap_arr.select do |site|
      decoded_request = Base64.strict_decode64(site[:request])
      decoded_request.include?(keyword)
    end
  end

  sitemap_arr.uniq
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.help ⇒ Object

Display Usage for this Module



2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
 
# File 'lib/pwn/plugins/burp_suite.rb', line 2067

public_class_method def self.help
  puts "USAGE:
    burp_obj1 = #{self}.start(
      burp_jar_path: 'optional - path of burp suite pro jar file (defaults to /opt/burpsuite/burpsuite_pro.jar)',
      headless: 'optional - run headless if set to true',
      browser_type: 'optional - defaults to :firefox. See PWN::Plugins::TransparentBrowser.help for a list of types'
    )

    uri_in_scope = #{self}.in_scope(
      burp_obj: 'required - burp_obj returned by #start method',
      uri: 'required - URI to determine if in scope'
    )

    json_in_scope = #{self}.add_to_scope(
      burp_obj: 'required - burp_obj returned by #start method',
      target_url: 'required - target url to add to scope'
    )

    json_spider = #{self}.spider(
      burp_obj: 'required - burp_obj returned by #start method',
      target_url: 'required - target url to spider in scope'
    )

    #{self}.enable_proxy(
      burp_obj: 'required - burp_obj returned by #start method'
    )

    #{self}.disable_proxy(
      burp_obj: 'required - burp_obj returned by #start method'
    )

    #{self}.get_proxy_listeners(
      burp_obj: 'required - burp_obj returned by #start method'
    )

    json_proxy_listener = #{self}.add_proxy_listener(
      burp_obj: 'required - burp_obj returned by #start method',
      bindAddress: 'required - bind address for the proxy listener (e.g., \"127.0.0.1\")',
      port: 'required - port for the proxy listener (e.g., 8081)',
      enabled: 'optional - enable the listener (defaults to true)'
    )

    json_proxy_listener = #{self}.update_proxy_listener(
      burp_obj: 'required - burp_obj returned by #start method',
      id: 'optional - ID of the proxy listener (defaults to 0)',
      bindAddress: 'optional - bind address for the proxy listener (defaults to value of existing listener)',
      port: 'optional - port for the proxy listener (defaults to value of existing listener)',
      enabled: 'optional - enable the listener (defaults to value of existing listener)'
    )

    #{self}.delete_proxy_listener(
      burp_obj: 'required - burp_obj returned by #start method',
      id: 'optional - ID of the proxy listener (defaults to 0)'
    )

    json_proxy_history = #{self}.get_proxy_history(
      burp_obj: 'required - burp_obj returned by #start method',
      limit: 'optional - integer to limit number of proxy history entries returned (default: 200)',
      offset: 'optional - integer to offset proxy history results (default: 0)',
      uri: 'optional - URI to filter proxy history results (default: nil)',
      highlight: 'optional - highlight color to filter proxy history results (default: \"NONE\")',
      keyword: 'optional - keyword to filter proxy history results (default: nil)',
      return_as: 'optional - :base64 or :har (defaults to :base64)'
    )

    json_proxy_history = #{self}.update_proxy_history(
      burp_obj: 'required - burp_obj returned by #start method',
      entry: 'required - proxy history entry hash to update'
    )

    json_proxy_history = #{self}.get_websocket_history(
      burp_obj: 'required - burp_obj returned by #start method',
      limit: 'optional - integer to limit number of websocket history entries returned (default: 200)',
      offset: 'optional - integer to offset websocket history results (default: 0)',
      highlight: 'optional - highlight color to filter proxy history results (default: \"NONE\")',
      keyword: 'optional - keyword to filter websocket history results (default: nil)'
    )

    json_proxy_history = #{self}.update_websocket_history(
      burp_obj: 'required - burp_obj returned by #start method',
      entry: 'required - websocket history entry hash to update'
    )

    json_sitemap = #{self}.get_sitemap(
      burp_obj: 'required - burp_obj returned by #start method',
      limit: 'optional - integer to limit number of sitemap entries returned (default: 200)',
      offset: 'optional - integer to offset sitemap results (default: 0)',
      uri: 'optional - URI to filter sitemap results (default: nil)',
      highlight: 'optional - highlight color to filter proxy history results (default: \"NONE\")',
      keyword: 'optional - keyword to filter sitemap results (default: nil)',
      return_as: 'optional - :base64 or :har (defaults to :base64)'
    )

    json_sitemap = #{self}.add_to_sitemap(
      burp_obj: 'required - burp_obj returned by #start method',
      sitemap: 'required - sitemap hash to add',
      debug: 'optional - boolean to enable sitemap debugging (default: false)'
    )

    Example:
    json_sitemap = #{self}.add_to_sitemap(
      burp_obj: 'required - burp_obj returned by #start method',
      sitemap: {
        request: 'base64_encoded_request_string',
        response: 'base64_encoded_response_string',
        highlight: 'NONE'||'RED'||'ORANGE'||'YELLOW'||'GREEN'||'CYAN'||'BLUE'||'PINK'||'MAGENTA'||'GRAY',
        comment: 'optional comment for the sitemap entry',
        http_service: {
          host: 'example.com',
          port: 80,
          protocol: 'http'
        }
      }
    )

    json_sitemap = #{self}.update_sitemap(
      burp_obj: 'required - burp_obj returned by #start method',
      entry: 'required - sitemap entry hash to update'
    )

    json_sitemap = #{self}.import_openapi_to_sitemap(
      burp_obj: 'required - burp_obj returned by #start method',
      openapi_spec: 'required - path to OpenAPI JSON or YAML specification file',
      additional_http_headers: 'optional - hash of additional HTTP headers to include in requests (default: {})',
      debug: 'optional - boolean to enable debug logging (default: false)',
      highlight: 'optional - highlight color for the sitemap entry (default: \"NONE\")',
      comment: 'optional - comment for the sitemap entry (default: \"\")',
    )

    active_scan_url_arr = #{self}.active_scan(
      burp_obj: 'required - burp_obj returned by #start method',
      target_url: 'required - target url to scan in sitemap (should be loaded & authenticated w/ burp_obj[:mitm_browser])',
      exclude_paths: 'optional - array of paths to exclude from active scan (default: [])'
    )

    json_scan_issues = #{self}.get_scan_issues(
      burp_obj: 'required - burp_obj returned by #start method'
    ).to_json

    repeater_id = #{self}.add_repeater_tab(
      burp_obj: 'required - burp_obj returned by #start method',
      name: 'required - name of the repeater tab (max 30 characters)',
      request: 'optional - base64 encoded HTTP request string'
    )

    repeater_tabs = #{self}.get_all_repeater_tabs(
      burp_obj: 'required - burp_obj returned by #start method'
    )

    repeater_tab = #{self}.get_repeater_tab(
      burp_obj: 'required - burp_obj returned by #start method',
      id: 'required - id of the repeater tab to get'
    )

    repeater_resp = #{self}.send_repeater_request(
      burp_obj: 'required - burp_obj returned by #start method',
      id: 'required - id of the repeater tab to send'
    )

    repeater_obj = #{self}.update_repeater_tab(
      burp_obj: 'required - burp_obj returned by #start method',
      id: 'required - id of the repeater tab to update',
      name: 'required - name of the repeater tab (max 30 characters)',
      request: 'required - base64 encoded HTTP request string'
    )

    repeater_obj = #{self}.delete_repeater_tab(
      burp_obj: 'required - burp_obj returned by #start method',
      id: 'required - id of the repeater tab to delete'
    )

    #{self}.generate_scan_report(
      burp_obj: 'required - burp_obj returned by #start method',
      target_url: 'required - target_url passed to #active_scan method',
      output_dir: 'required - directory to save the report',
      report_type: 'required - <:html|:xml>'
    )

    #{self}.stop(
      burp_obj: 'required - burp_obj returned by #start method'
    )

    #{self}.authors
  "
end

.import_openapi_to_sitemap(opts = {}) ⇒ Object

Supported Method Parameters: json_sitemap = PWN::Plugins::BurpSuite.import_openapi_to_sitemap(

burp_obj: 'required - burp_obj returned by #start method',
openapi_spec: 'required - path to OpenAPI JSON or YAML specification file',
additional_http_headers: 'optional - hash of additional HTTP headers to include in requests (default: {})',
highlight: 'optional - highlight color for the sitemap entry (default: "NONE")',
comment: 'optional - comment for the sitemap entry (default: "")',
debug: 'optional - boolean to enable debug logging (default: false)'

)



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1219

public_class_method def self.import_openapi_to_sitemap(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  openapi_spec = opts[:openapi_spec]
  raise 'ERROR: openapi_spec parameter is required' if openapi_spec.nil?

  additional_http_headers = opts[:additional_http_headers] ||= {}
  raise 'ERROR: additional_http_headers must be a Hash' unless additional_http_headers.is_a?(Hash)

  highlight = opts[:highlight] ||= 'NONE'
  comment = opts[:comment].to_s.scrub

  debug = opts[:debug] || false

  openapi_spec_root = File.dirname(openapi_spec)
  Dir.chdir(openapi_spec_root)

  # Parse the OpenAPI JSON or YAML specification file
  # If the openapi_spec is YAML, convert it to JSON
  openapi = if openapi_spec.end_with?('.json')
              JSON.parse(File.read(openapi_spec), symbolize_names: true)
            elsif openapi_spec.end_with?('.yaml', '.yml')
              YAML.safe_load_file(openapi_spec, permitted_classes: [Symbol, Date, Time], aliases: true, symbolize_names: true)
            else
              raise "ERROR: Unsupported file extension for #{openapi_spec}. Expected .json, .yaml, or .yml."
            end

  # Initialize result array
  sitemap_arr = []

  # Get servers; default to empty array if not present
  servers = openapi[:servers].is_a?(Array) ? openapi[:servers] : []
  if servers.empty?
    warn("No servers defined in #{openapi_spec}. Using default server 'http://localhost'.")
    servers = [{ url: 'http://localhost', description: 'Default server' }]
  end

  # Valid HTTP methods for validation
  valid_methods = %w[get post put patch delete head options trace connect]

  # Helper lambda to resolve $ref in schemas
  resolve_ref = lambda do |openapi, ref|
    return nil unless ref&.start_with?('#/')

    parts = ref.sub('#/', '').split('/')
    resolved = openapi
    parts.each do |part|
      resolved = resolved[part.to_sym]
      return nil unless resolved
    end
    resolved
  end

  # Iterate through each server
  servers.each do |server|
    server_url = server[:url]
    unless server_url.is_a?(String)
      warn("[ERROR] Invalid server URL type '#{server_url.class}' in #{openapi_spec}: Expected String, got #{server_url.inspect}")
      next
    end

    begin
      uri = URI.parse(server_url)
      host = uri.host
      port = uri.port
      protocol = uri.scheme
      server_path = uri.path&.sub(%r{^/+}, '')&.sub(%r{/+$}, '') || ''

      warn("[DEBUG] Processing server: #{server_url}, host: #{host}, port: #{port}, protocol: #{protocol}, server_path: #{server_path}") if debug

      # Iterate through each path and its methods
      openapi[:paths]&.each do |path, methods|
        # Convert path to string, handling different types
        path_str = case path
                   when Symbol, String
                     path.to_s
                   else
                     warn("[ERROR] Invalid path type '#{path.class}' in #{openapi_spec}: Expected Symbol or String, got #{path.inspect}")
                     '/' # Fallback to root path
                   end

        # Construct full path by prepending server path if present
        full_path = server_path.empty? ? path_str : "/#{server_path}/#{path_str.sub(%r{^/+}, '')}".gsub(%r{/+}, '/')

        # Initialize path-level parameters
        path_parameters = []

        # Process methods based on type
        operations = []
        if methods.is_a?(Hash)
          # Extract path-level parameters
          path_parameters = methods[:parameters].is_a?(Array) ? methods[:parameters] : []
          warn("[DEBUG] Path-level parameters for #{full_path}: #{path_parameters.inspect}") if debug && !path_parameters.empty?

          # Collect operations for valid HTTP methods
          methods.each do |method, details|
            method_str = case method
                         when Symbol, String
                           method.to_s.downcase
                         else
                           warn("[ERROR] Invalid method type '#{method.class}' for path '#{full_path}' in #{openapi_spec}: Expected Symbol or String, got #{method.inspect}")
                           nil
                         end

            next unless method_str && valid_methods.include?(method_str)

            operations << { method: method_str, details: details }
          end
        elsif methods.is_a?(Array)
          warn("[DEBUG] Methods is an array for path '#{full_path}' in #{openapi_spec}: #{methods.inspect}") if debug

          # Look for parameters in the array
          param_entry = methods.find { |m| m.is_a?(Hash) && m[:parameters].is_a?(Array) }
          path_parameters = param_entry[:parameters] if param_entry
          warn("[DEBUG] Path-level parameters for #{full_path}: #{path_parameters.inspect}") if debug && !path_parameters.empty?

          # Collect operations from array elements
          methods.each do |op|
            next unless op.is_a?(Hash)

            # Infer method from operationId or other indicators
            method_str = if op[:operationId].is_a?(String)
                           op_id = op[:operationId].downcase
                           valid_methods.find { |m| op_id.start_with?(m) }
                         elsif op[:method].is_a?(String) || op[:method].is_a?(Symbol)
                           op[:method].to_s.downcase if valid_methods.include?(op[:method].to_s.downcase)
                         end

            if method_str
              operations << { method: method_str, details: op }
            else
              warn("[ERROR] Could not infer valid HTTP method for operation #{op.inspect} in path '#{full_path}' in #{openapi_spec}")
            end
          end
        else
          warn("[ERROR] Invalid methods type '#{methods.class}' for path '#{full_path}' in #{openapi_spec}: Expected Hash or Array, got #{methods.inspect}")
        end

        # Process each operation
        operations.each do |op|
          method_str = op[:method]
          details = op[:details]

          # Handle details based on type
          operation = case details
                      when Hash
                        details
                      when Array
                        # Find the first hash with responses, or use empty hash
                        selected = details.find { |d| d.is_a?(Hash) && d[:responses].is_a?(Hash) }
                        if selected
                          selected
                        else
                          warn("[ERROR] No valid operation hash found in array for #{method_str.upcase} #{full_path} in #{openapi_spec}: Got #{details.inspect}")
                          {}
                        end
                      else
                        warn("[ERROR] Invalid details type '#{details.class}' for #{method_str.upcase} #{full_path} in #{openapi_spec}: Expected Hash or Array, got #{details.inspect}")
                        {}
                      end

          # Skip if operation is empty (indicating invalid details)
          if operation.empty?
            warn("[DEBUG] Skipping #{method_str.upcase} #{full_path} due to invalid operation data") if debug
            next
          end

          # Skip if no valid responses
          unless operation[:responses].is_a?(Hash)
            warn("[ERROR] No valid responses for #{method_str.upcase} #{full_path} in #{openapi_spec}: Expected Hash, got #{operation[:responses].inspect}")
            next
          end

          begin
            # Construct HTTP request headers
            request_headers = {
              host: host
            }
            request_headers.merge!(additional_http_headers)

            # Combine path-level and operation-level parameters
            operation_parameters = operation[:parameters].is_a?(Array) ? operation[:parameters] : []
            all_parameters = path_parameters + operation_parameters
            warn("[DEBUG] All parameters for #{method_str.upcase} #{full_path}: #{all_parameters.inspect}") if debug && !all_parameters.empty?

            # Determine response code from operation[:responses].keys
            fallback_response_code = 200
            response_keys = operation[:responses].keys
            response_key = response_keys.find { |key| key.to_s.to_i.between?(100, 599) } || fallback_response_code.to_s
            response_code = response_key.to_s.to_i

            # Construct response body from operation responses schema example, schema $ref example, etc.
            response_obj = operation[:responses][response_key] || {}
            content = response_obj[:content] || {}
            content_type = content.keys.first&.to_s || 'text/plain'

            response_body = ''
            unless [204, 304].include?(response_code)
              content_obj = content[content_type.to_sym] || {}
              example = content_obj[:example]
              if example.nil? && content_obj[:examples].is_a?(Hash)
                ex_key = content_obj[:examples].keys.first
                if ex_key
                  ex = content_obj[:examples][ex_key]
                  if ex[:$ref]
                    resolved_ex = resolve_ref.call(openapi, ex[:$ref])
                    example = resolved_ex[:value] if resolved_ex
                  else
                    example = ex[:value]
                  end
                end
              end

              if example.nil?
                schema = content_obj[:schema]
                if schema
                  if schema[:$ref]
                    ref = schema[:$ref]
                    if ref.start_with?('#/')
                      parts = ref.sub('#/', '').split('/')
                      resolved = openapi
                      parts.each do |part|
                        resolved = resolved[part.to_sym]
                        break unless resolved
                      end
                      schema = resolved if resolved
                    end
                  end

                  example = schema[:example]
                  if example.nil? && schema[:examples].is_a?(Hash)
                    ex_key = schema[:examples].keys.first
                    if ex_key
                      ex = schema[:examples][ex_key]
                      if ex[:$ref]
                        resolved_ex = resolve_ref.call(openapi, ex[:$ref])
                        example = resolved_ex[:value] if resolved_ex
                      else
                        example = ex[:value]
                      end
                    end
                  end
                end
              end

              response_body = example || response_obj[:description] || "INFO: Unable to resolve response body from #{openapi_spec} => { 'http_method': '#{method_str.upcase}', 'path': '#{full_path}', 'response_code': '#{response_code}' }"
            end

            # Try to extract query samples from response example if it's a links object
            query_hash = nil
            if response_body.is_a?(Hash) && response_body[:links]
              href = response_body.dig(:links, :self, :href)
              # href ||= response_body[:links].values.first&.dig(:href) rescue nil
              if href.nil? && response_body[:links].is_a?(Hash) && !response_body[:links].empty?
                first_value = response_body[:links].values.first
                href = first_value[:href] if first_value.is_a?(Hash)
              end
              if href
                begin
                  parsed_uri = URI.parse(href)
                  query_hash = URI.decode_www_form(parsed_uri.query).to_h if parsed_uri.path.end_with?(path_str) && parsed_uri.query
                rescue URI::InvalidURIError => e
                  warn("[DEBUG] Invalid href in response example: #{href} - #{e.message}") if debug
                end
              end
            end

            # Process path parameters for substitution
            request_path = full_path.dup
            query_params = []

            all_parameters.each do |param|
              next unless param.is_a?(Hash) && param[:name] && param[:in]

              param_name = param[:name].to_s

              # Get param_value with precedence: param.examples > param.example > schema.examples > schema.example > 'FUZZ'
              param_value = if param[:examples].is_a?(Hash) && !param[:examples].empty?
                              first_ex = param[:examples].values.first
                              if first_ex.is_a?(Hash)
                                if first_ex[:$ref]
                                  # Resolve $ref for example if present
                                  resolved_ex = resolve_ref.call(openapi, first_ex[:$ref])
                                  resolved_ex[:value] if resolved_ex
                                else
                                  first_ex[:value]
                                end
                              else
                                first_ex
                              end || 'FUZZ'
                            elsif param.key?(:example)
                              param[:example]
                            else
                              schema = param[:schema]
                              if schema
                                if schema[:$ref]
                                  resolved_schema = resolve_ref.call(openapi, schema[:$ref])
                                  schema = resolved_schema if resolved_schema
                                end
                                if schema[:examples].is_a?(Hash) && !schema[:examples].empty?
                                  first_ex = schema[:examples].values.first
                                  if first_ex.is_a?(Hash)
                                    if first_ex[:$ref]
                                      resolved_ex = resolve_ref.call(openapi, first_ex[:$ref])
                                      resolved_ex[:value] if resolved_ex
                                    else
                                      first_ex[:value]
                                    end
                                  else
                                    first_ex
                                  end || 'FUZZ'
                                elsif schema.key?(:example)
                                  schema[:example]
                                else
                                  'FUZZ'
                                end
                              else
                                'FUZZ'
                              end
                            end

              # If still 'FUZZ' and it's a query param, try to get from response example query_hash
              param_value = query_hash[param_name] if param_value == 'FUZZ' && param[:in] == 'query' && query_hash&.key?(param_name)

              case param[:in]
              when 'header'
                # Aggregate remaining HTTP header names from spec,
                # reference as keys, and assign their respective
                # values to the request_headers hash
                param_key = param_name.downcase
                request_headers[param_key] = param_value.to_s
              when 'path'
                # Substitute path parameter with the resolved value
                request_path.gsub!("{#{param_name}}", param_value.to_s)
              when 'query'
                # Collect query parameters
                query_params.push("#{URI.encode_www_form_component(param_name)}=#{URI.encode_www_form_component(param_value.to_s)}")
              end
            end

            # Append query parameters to path if any
            request_path += "?#{query_params.join('&')}" if query_params.any?

            # Construct request lines, including all headers
            request_lines = [
              "#{method_str.upcase} #{request_path} HTTP/1.1"
            ]
            request_headers.each do |key, value|
              # Capitalize header keys (e.g., 'host' to 'Host', 'authorization' to 'Authorization')
              header_key = key.to_s.split('-').map(&:capitalize).join('-')
              request_lines.push("#{header_key}: #{value}")
            end
            request_lines << '' << '' # Add blank lines for HTTP request body separation

            request = request_lines.join("\r\n")
            encoded_request = Base64.strict_encode64(request)

            response_status = case response_code
                              when 200 then '200 OK'
                              when 201 then '201 Created'
                              when 204 then '204 No Content'
                              when 301 then '301 Moved Permanently'
                              when 302 then '302 Found'
                              when 303 then '303 See Other'
                              when 304 then '304 Not Modified'
                              when 307 then '307 Temporary Redirect'
                              when 308 then '308 Permanent Redirect'
                              when 400 then '400 Bad Request'
                              when 401 then '401 Unauthorized'
                              when 403 then '403 Forbidden'
                              when 404 then '404 Not Found'
                              when 500 then '500 Internal Server Error'
                              when 502 then '502 Bad Gateway'
                              when 503 then '503 Service Unavailable'
                              when 504 then '504 Gateway Timeout'
                              else "#{fallback_response_code} OK"
                              end

            # Serialize response_body based on content_type
            if content_type =~ /json/i && (response_body.is_a?(Hash) || response_body.is_a?(Array))
              response_body = JSON.generate(response_body)
            else
              response_body = response_body.to_s
            end

            response_lines = [
              "HTTP/1.1 #{response_status}",
              "Content-Type: #{content_type}",
              "Content-Length: #{response_body.length}",
              '',
              response_body
            ]
            response = response_lines.join("\r\n")
            encoded_response = Base64.strict_encode64(response)

            # Build the hash for this endpoint
            sitemap_hash = {
              request: encoded_request,
              response: encoded_response,
              highlight: highlight.to_s.upcase,
              comment: comment,
              http_service: {
                host: host,
                port: port,
                protocol: protocol
              }
            }

            # Add to the results array
            sitemap_arr.push(sitemap_hash)
            warn("[DEBUG] Added sitemap entry for #{method_str.upcase} #{request_path} on #{server_url} with headers #{request_headers.inspect}") if debug
          rescue StandardError => e
            warn("[ERROR] Failed to process #{method_str.upcase} #{full_path} on #{server_url}: #{e.message}")
            warn("[DEBUG] Operation: #{operation.inspect}, Parameters: #{all_parameters.inspect}, Headers: #{request_headers.inspect}") if debug
          end
        end
      end
    rescue URI::InvalidURIError => e
      warn("[ERROR] Invalid server URL '#{server_url}' in #{openapi_spec}: #{e.message}")
    end
  end

  sitemap_arr.each do |sitemap|
    add_to_sitemap(burp_obj: burp_obj, sitemap: sitemap)
  rescue RestClient::ExceptionWithResponse => e
    puts e.message
    next
  end

  sitemap_arr
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.in_scope(opts = {}) ⇒ Object

Supported Method Parameters

uri_in_scope = PWN::Plugins::BurpSuite.in_scope(

burp_obj: 'required - burp_obj returned by #start method',
uri: 'required - URI to determine if in scope'

)



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/pwn/plugins/burp_suite.rb', line 380

public_class_method def self.in_scope(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  uri = opts[:uri]
  raise 'ERROR: uri parameter is required' if uri.nil?

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]
  base64_encoded_uri = Base64.strict_encode64(uri.to_s.scrub.strip.chomp)

  in_scope_resp = rest_browser.get(
    "http://#{mitm_rest_api}/scope/#{base64_encoded_uri}",
    content_type: 'application/json; charset=UTF8'
  )
  json_in_scope = JSON.parse(in_scope_resp, symbolize_names: true)
  json_in_scope[:value]
rescue StandardError => e
  raise e
end

.send_repeater_request(opts = {}) ⇒ Object

Supported Method Parameters

repeater_resp = PWN::Plugins::BurpSuite.send_repeater_request(

burp_obj: 'required - burp_obj returned by #start method',
id: 'required - id of the repeater tab to send'

)



1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1881

public_class_method def self.send_repeater_request(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  id = opts[:id]
  raise 'ERROR: id parameter is required' if id.nil?

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  repeater_resp = rest_browser.post(
    "http://#{mitm_rest_api}/repeater/#{id}/send",
    content_type: 'application/json; charset=UTF8'
  )

  JSON.parse(repeater_resp, symbolize_names: true)
rescue StandardError => e
  raise e
end

.spider(opts = {}) ⇒ Object

Supported Method Parameters

json_spider = PWN::Plugins::BurpSuite.spider(

burp_obj: 'required - burp_obj returned by #start method',
target_url: 'required - target url to add to crawl / spider'

)



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
 
# File 'lib/pwn/plugins/burp_suite.rb', line 428

public_class_method def self.spider(opts = {})
  burp_obj = opts[:burp_obj]
  target_url = opts[:target_url]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  post_body = { url: target_url }.to_json

  in_scope = rest_browser.post(
    "http://#{mitm_rest_api}/spider",
    post_body,
    content_type: 'application/json; charset=UTF8'
  )
  spider_json = JSON.parse(in_scope, symbolize_names: true)
  spider_id = spider_json[:id]

  spider_status_json = {}
  loop do
    print '.'
    spider_status_resp = rest_browser.get("http://#{mitm_rest_api}/spider/#{spider_id}")
    spider_status_json = JSON.parse(spider_status_resp, symbolize_names: true)
    spider_status = spider_status_json[:status]
    case spider_status
    when 'queued', 'running'
      sleep 3
    when 'failed', 'finished'
      break
    else
      puts "Unknown spider status detected: #{spider_status}"
      break
    end
  end
  print "\n"

  spider_json.merge!(spider_status_json)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.start(opts = {}) ⇒ Object

Supported Method Parameters

burp_obj1 = PWN::Plugins::BurpSuite.start(

burp_jar_path: 'optional - path of burp suite pro jar file (defaults to /opt/burpsuite/burpsuite_pro.jar)',
headless: 'optional - run burp headless if set to true',
browser_type: 'optional - defaults to :firefox. See PWN::Plugins::TransparentBrowser.help for a list of types',
burp_ip: 'optional - IP address for the Burp proxy (defaults to 127.0.0.1)',
burp_port: 'optional - port for the Burp proxy (defaults to a random unused port)',
pwn_burp_ip: 'optional - IP address for the PWN Burp API (defaults to 127.0.0.1)',
pwn_burp_port: 'optional - port for the PWN Burp API (defaults to a random unused port)'

)



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
 
# File 'lib/pwn/plugins/burp_suite.rb', line 296

public_class_method def self.start(opts = {})
  burp_jar_path = opts[:burp_jar_path] ||= '/opt/burpsuite/burpsuite-pro.jar'
  raise "ERROR: #{burp_jar_path} not found." unless File.exist?(burp_jar_path)

  raise 'ERROR: /opt/burpsuite/pwn-burp.jar not found.  For more details about installing this extension, checkout https://github.com/0dayinc/pwn_burp' unless File.exist?('/opt/burpsuite/pwn-burp.jar')

  burp_root = File.dirname(burp_jar_path)

  headless = opts[:headless] || false
  browser_type = opts[:browser_type] ||= :firefox
  browser_type = browser_type.to_s.downcase.to_sym unless browser_type.is_a?(Symbol)
  browser_type = :headless if headless
  burp_ip = opts[:burp_ip] ||= '127.0.0.1'
  burp_port = opts[:burp_port] ||= PWN::Plugins::Sock.get_random_unused_port

  pwn_burp_ip = opts[:pwn_burp_ip] ||= '127.0.0.1'
  pwn_burp_port = opts[:pwn_burp_port] ||= PWN::Plugins::Sock.get_random_unused_port

  burp_cmd_string = 'java -Xms4G -Xmx16G'
  burp_cmd_string = "#{burp_cmd_string} -Djava.awt.headless=true" if headless
  burp_cmd_string = "#{burp_cmd_string} -Dproxy.address=#{burp_ip} -Dproxy.port=#{burp_port}"
  burp_cmd_string = "#{burp_cmd_string} -Dserver.address=#{pwn_burp_ip} -Dserver.port=#{pwn_burp_port}"
  burp_cmd_string = "#{burp_cmd_string} -jar #{burp_jar_path}"

  # Construct burp_obj
  burp_obj = {}
  burp_obj[:pid] = Process.spawn(burp_cmd_string, pgroup: true)
  browser_obj1 = PWN::Plugins::TransparentBrowser.open(browser_type: :rest)
  rest_browser = browser_obj1[:browser]

  burp_obj[:mitm_proxy] = "#{burp_ip}:#{burp_port}"
  burp_obj[:mitm_rest_api] = "#{pwn_burp_ip}:#{pwn_burp_port}"
  burp_obj[:rest_browser] = rest_browser

  # Proxy always listens on localhost...use SSH tunneling if remote access is required
  browser_obj2 = PWN::Plugins::TransparentBrowser.open(
    browser_type: browser_type,
    proxy: "http://#{burp_obj[:mitm_proxy]}",
    devtools: true
  )

  burp_obj[:mitm_browser] = browser_obj2

  # Wait for pwn_burp_port to open prior to returning burp_obj
  loop do
    s = TCPSocket.new(pwn_burp_ip, pwn_burp_port)
    s.close
    break
  rescue Errno::ECONNREFUSED
    print '.'
    sleep 3
    next
  end

  # Delete existing proxy listener and add new one
  # in favor of weird update behavior in event the port is alread in use
  # by another application which refuses to enable the listener even when
  # the port is changed via the update method.
  delete_proxy_listener(
    burp_obj: burp_obj,
    id: 0
  )

  add_proxy_listener(
    burp_obj: burp_obj,
    bindAddress: burp_ip,
    port: burp_port,
    enabled: true
  )

  burp_obj = init_introspection_thread(burp_obj: burp_obj, type: :sitemap)
  burp_obj = init_introspection_thread(burp_obj: burp_obj, type: :proxy_history)
  init_introspection_thread(burp_obj: burp_obj, type: :websocket_history)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.stop(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::BurpSuite.stop(

burp_obj: 'required - burp_obj returned by #start method'

)



2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/pwn/plugins/burp_suite.rb', line 2039

public_class_method def self.stop(opts = {})
  burp_obj = opts[:burp_obj]

  browser_obj = burp_obj[:mitm_browser]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]
  introspection_thread_arr = burp_obj[:introspection_threads]
  introspection_thread_arr.each(&:kill) if introspection_thread_arr.is_a?(Array) && introspection_thread_arr.any?
  # introspection_thread.kill unless introspection_thread.nil?

  PWN::Plugins::TransparentBrowser.close(browser_obj: browser_obj)
  rest_browser.post("http://#{mitm_rest_api}/shutdown", '')

  burp_obj = nil
rescue StandardError => e
  raise e
end

.update_burp_jar ⇒ Object

Supported Method Parameters

PWN::Plugins::BurpSuite.update_burp_jar( )



2030
2031
2032
 
# File 'lib/pwn/plugins/burp_suite.rb', line 2030

public_class_method def self.update_burp_jar
  # TODO: Do this if PortSwigger ever decides to includes this functionality as a CLI argument.
end

.update_proxy_history(opts = {}) ⇒ Object

Supported Method Parameters

json_proxy_history = PWN::Plugins::BurpSuite.update_proxy_history(

burp_obj: 'required - burp_obj returned by #start method',
entry: 'required - hash of the proxy history entry to update'

)



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/pwn/plugins/burp_suite.rb', line 818

public_class_method def self.update_proxy_history(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  entry = opts[:entry]
  raise 'ERROR: entry parameter is required and must be a hash' unless entry.is_a?(Hash)

  id = entry[:id]
  raise 'ERROR: id key value pair is required within entry hash' if id.nil?

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  # Only allow updating of comment and highlight fields
  entry.delete(:request)
  entry.delete(:response)
  entry.delete(:http_service)

  put_body = entry.to_json

  proxy_history_resp = rest_browser.put(
    "http://#{mitm_rest_api}/proxy/history/#{id}",
    put_body,
    content_type: 'application/json; charset=UTF8'
  )

  JSON.parse(proxy_history_resp, symbolize_names: true)
rescue StandardError => e
  raise e
end

.update_proxy_listener(opts = {}) ⇒ Object

Supported Method Parameters

json_proxy_listener = PWN::Plugins::BurpSuite.update_proxy_listener(

burp_obj: 'required - burp_obj returned by #start method',
id: 'optional - ID of the proxy listener (defaults to 0)',
bindAddress: 'optional - bind address for the proxy listener (defaults to value of existing listener)',
port: 'optional - port for the proxy listener (defaults to value of existing listener)',
enabled: 'optional - enable or disable the listener (defaults to value of existing listener)'

)



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/pwn/plugins/burp_suite.rb', line 567

public_class_method def self.update_proxy_listener(opts = {})
  burp_obj = opts[:burp_obj]
  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]
  id = opts[:id] ||= 0

  proxy_listeners = get_proxy_listeners(burp_obj: burp_obj)
  listener_by_id = proxy_listeners.find { |listener| listener[:id].to_i == id.to_i }
  raise "ERROR: No proxy listener found with ID #{id}" if listener_by_id.nil?

  bind_address = opts[:bindAddress] ||= listener_by_id[:bindAddress]
  port = opts[:port] ||= listener_by_id[:port]
  enabled = opts[:enabled] ||= listener_by_id[:enabled]

  post_body = {
    id: id.to_s,
    bindAddress: bind_address,
    port: port,
    enabled: enabled
  }.to_json

  listener = rest_browser.put("http://#{mitm_rest_api}/proxy/listeners/#{id}", post_body, content_type: 'application/json; charset=UTF8')
  JSON.parse(listener, symbolize_names: true)
rescue StandardError => e
  stop(burp_obj: burp_obj) unless burp_obj.nil?
  raise e
end

.update_repeater_tab(opts = {}) ⇒ Object

Supported Method Parameters

repeater_obj = PWN::Plugins::BurpSuite.update_repeater_tab(

burp_obj: 'required - burp_obj returned by #start method',
id: 'required - id of the repeater tab to update',
name: 'required - name of the repeater tab (max 30 characters)',
request: 'required - base64 encoded HTTP request string'

)



1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1909

public_class_method def self.update_repeater_tab(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  id = opts[:id]
  raise 'ERROR: id parameter is required' if id.nil?

  name = opts[:name]
  raise 'ERROR: name parameter is required' if name.nil?

  request = opts[:request]
  raise 'ERROR: request parameter is required' if request.nil?

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  put_body = {
    name: name[0..29],
    request: request
  }.to_json

  repeater_resp = rest_browser.put(
    "http://#{mitm_rest_api}/repeater/#{id}",
    put_body,
    content_type: 'application/json; charset=UTF8'
  )

  JSON.parse(repeater_resp, symbolize_names: true)
rescue StandardError => e
  raise e
end

.update_sitemap(opts = {}) ⇒ Object

Supported Method Parameters

json_sitemap = PWN::Plugins::BurpSuite.update_sitemap(

burp_obj: 'required - burp_obj returned by #start method',
entry: 'required - hash of the sitemap entry to update'

)



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/pwn/plugins/burp_suite.rb', line 1182

public_class_method def self.update_sitemap(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  entry = opts[:entry]
  raise 'ERROR: entry parameter is required and must be a hash' unless entry.is_a?(Hash)

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  # Only allow updating of comment and highlight fields
  # NOTE we need the request as its used to identify the sitemap entry to update
  entry.delete(:response)
  entry.delete(:http_service)

  put_body = entry.to_json

  sitemap_resp = rest_browser.put(
    "http://#{mitm_rest_api}/sitemap",
    put_body,
    content_type: 'application/json; charset=UTF8'
  )

  JSON.parse(sitemap_resp, symbolize_names: true)
rescue StandardError => e
  raise e
end

.update_websocket_history(opts = {}) ⇒ Object

Supported Method Parameters

json_proxy_history = PWN::Plugins::BurpSuite.update_proxy_history(

burp_obj: 'required - burp_obj returned by #start method',
entry: 'required - hash of the websocket history entry to update'

)



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/pwn/plugins/burp_suite.rb', line 896

public_class_method def self.update_websocket_history(opts = {})
  burp_obj = opts[:burp_obj]
  raise 'ERROR: burp_obj parameter is required' unless burp_obj.is_a?(Hash)

  entry = opts[:entry]
  raise 'ERROR: entry parameter is required and must be a hash' unless entry.is_a?(Hash)

  id = entry[:id]
  raise 'ERROR: id key value pair is required within entry hash' if id.nil?

  rest_browser = burp_obj[:rest_browser]
  mitm_rest_api = burp_obj[:mitm_rest_api]

  # Only allow updating of comment and highlight fields
  entry.delete(:web_socket_id)
  entry.delete(:direction)
  entry.delete(:payload)

  put_body = entry.to_json

  proxy_history_resp = rest_browser.put(
    "http://#{mitm_rest_api}/websocket/history/#{id}",
    put_body,
    content_type: 'application/json; charset=UTF8'
  )

  JSON.parse(proxy_history_resp, symbolize_names: true)
rescue StandardError => e
  raise e
end