Module: PWN::WWW::HackerOne

Defined in:
lib/pwn/www/hacker_one.rb

Overview

This plugin supports hackerone.com actions.

Class Method Summary collapse

Class Method Details

.authors ⇒ Object

Author(s)

0day Inc. <[email protected]>



592
593
594
595
596
 
# File 'lib/pwn/www/hacker_one.rb', line 592

public_class_method def self.authors
  "AUTHOR(S):
    0day Inc. <[email protected]>
  "
end

.close(opts = {}) ⇒ Object

Supported Method Parameters

browser_obj = PWN::WWW::HackerOne.close(

browser_obj: 'required - browser_obj returned from #open method'

)



581
582
583
584
585
586
587
588
 
# File 'lib/pwn/www/hacker_one.rb', line 581

public_class_method def self.close(opts = {})
  browser_obj = opts[:browser_obj]
  PWN::Plugins::TransparentBrowser.close(
    browser_obj: browser_obj
  )
rescue StandardError => e
  raise e
end

.get_bounty_programs(opts = {}) ⇒ Object

Supported Method Parameters

programs_arr = PWN::WWW::HackerOne.get_bounty_programs(

min_payouts_enabled: 'optional - only display programs where payouts are > $0.00 (defaults to false)',
suppress_progress: 'optional - suppress output (defaults to false)',
proxy: 'optional - scheme://proxy_host:port || tor'

)



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
 
# File 'lib/pwn/www/hacker_one.rb', line 35

public_class_method def self.get_bounty_programs(opts = {})
  min_payouts_enabled = opts[:min_payouts_enabled] || false
  raise 'ERROR: min_payouts_enabled should be true or false' unless [true, false].include?(min_payouts_enabled)

  suppress_progress = opts[:suppress_progress] || false
  raise 'ERROR: suppress_progress should be true or false' unless [true, false].include?(suppress_progress)

  proxy = opts[:proxy]

  browser_obj = PWN::Plugins::TransparentBrowser.open(
    browser_type: :rest,
    proxy: proxy
  )
  rest_client = browser_obj[:browser]
  rest_request = rest_client::Request

  graphql_endpoint = 'https://hackerone.com/graphql'
  headers = { content_type: 'application/json' }
  # NOTE: If you copy this payload to the pwn REPL
  # the triple dots ... attempt to execute commands
  # <cough>Pry CE</cough>
  query = "
    query GetBountyPrograms($after: String) {
      teams(
        first: 100,
        after: $after,
        where: { state: {_in: [soft_launched, public_mode]} }
      ) {
        edges {
          node {
            handle
            name
            minimum_bounty
          }
        }
        pageInfo {
          endCursor
          hasNextPage
        }
      }
    }
  "

  programs_arr = []
  cursor = nil

  loop do
    payload = {
      operationName: 'GetBountyPrograms',
      variables: { after: cursor },
      query: query
    }

    rest_response = rest_request.execute(
      method: :post,
      url: graphql_endpoint,
      headers: headers,
      payload: payload.to_json.delete("\n"),
      verify_ssl: false
    )

    data = JSON.parse(rest_response.body, symbolize_names: true)

    teams = data[:data][:teams][:edges]
    teams.each do |edge|
      team = edge[:node]
      min_payout = team[:minimum_bounty] ? team[:minimum_bounty].to_f : 0.0
      next if min_payouts_enabled && min_payout.zero?

      # next if min_payouts_enabled && min_payout.zero?

      print '.' unless suppress_progress

      min_payout_fmt = format('$%0.2f', min_payout)
      handle = team[:handle]
      link = "https://hackerone.com/#{handle}"
      scheme = URI.parse(link).scheme
      host = URI.parse(link).host
      path = URI.parse(link).path
      burp_target_config = "#{scheme}://#{host}/teams#{path}/assets/download_burp_project_file.json"

      bounty_program_hash = {
        name: handle,
        min_payout: min_payout_fmt,
        policy: "#{link}?view_policy=true",
        burp_target_config: burp_target_config,
        scope: "#{link}/policy_scopes",
        hacktivity: "#{link}/hacktivity",
        thanks: "#{link}/thanks",
        updates: "#{link}/updates",
        collaborators: "#{link}/collaborators"
      }
      programs_arr.push(bounty_program_hash)
    end

    page_info = data[:data][:teams][:pageInfo]
    cursor = page_info[:endCursor]
    break unless page_info[:hasNextPage]
  end
  puts "\n"

  programs_arr.sort_by! { |p| -p[:min_payout].gsub('$', '').gsub(',', '').to_f }

  system_role_content = 'Suggest an optimal bug bounty program to target on HackerOne to maximize potential earnings based on values within `min_payout` and publicly known vulnerabilities that have surfaced for the `name` of the program.'
  ai_analysis = PWN::AI::Introspection.reflect_on(
    request: programs_arr.to_json,
    system_role_content: system_role_content,
    spinner: true,
    suppress_pii_warning: true
  )
  puts "\n\n#{ai_analysis}" unless ai_analysis.nil?

  programs_arr
rescue RestClient::ExceptionWithResponse => e
  if e.response
    puts "HTTP RESPONSE CODE: #{e.response.code}"
    puts "HTTP RESPONSE HEADERS:\n#{e.response.headers}"
    puts "HTTP RESPONSE BODY:\n#{e.response.body}\n\n\n"
  end

  raise e
rescue StandardError => e
  raise e
ensure
  browser_obj = PWN::Plugins::TransparentBrowser.close(browser_obj: browser_obj) if browser_obj
  rest_client = nil if rest_client
  rest_request = nil if rest_request
end

.get_hacktivity(opts = {}) ⇒ Object

Supported Method Parameters

hacktivity = PWN::WWW::HackerOne.get_hacktivity(

program_name: 'required - program name from #get_bounty_programs method',
proxy: 'optional - scheme://proxy_host:port || tor'

)



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
 
# File 'lib/pwn/www/hacker_one.rb', line 316

public_class_method def self.get_hacktivity(opts = {})
  program_name = opts[:program_name]
  proxy = opts[:proxy]

  browser_obj = PWN::Plugins::TransparentBrowser.open(
    browser_type: :rest,
    proxy: proxy
  )
  rest_client = browser_obj[:browser]
  rest_request = rest_client::Request

  graphql_endpoint = 'https://hackerone.com/graphql'
  headers = { content_type: 'application/json' }
  # NOTE: If you copy this payload to the pwn REPL
  # the triple dots ... attempt to execute commands
  # <cough>Pry CE</cough>
  payload = {
    operationName: 'HacktivitySearchQuery',
    variables: {
      from: 0,
      product_area: 'other',
      product_feature: 'other',
      queryString: "team:(\"#{program_name}\")",
      size: 100,
      sort: {
        field: 'disclosed_at',
        direction: 'DESC'
      }
    },
    query: 'query HacktivitySearchQuery(
        $queryString: String!,
        $from: Int,
        $size: Int,
        $sort: SortInput!
      ) {
        me {
          id
          __typename
        }
        search(
          index: CompleteHacktivityReportIndex
          query_string: $queryString
          from: $from
          size: $size
          sort: $sort
        ) {
          __typename
          total_count
          nodes {
            __typename
            ... on HacktivityDocument {
              id
              _id
              reporter {
                id
                username
                name
                __typename
              }
              cve_ids
              cwe
              severity_rating
              upvoted: upvoted_by_current_user
              public
              report {
                id
                databaseId: _id
                title
                substate
                url
                disclosed_at
                report_generated_content {
                  id
                  hacktivity_summary
                  __typename
                }
                __typename
              }
              votes
              team {
                id
                handle
                name
                medium_profile_picture: profile_picture(size: medium)
                url
                currency
                __typename
              }
              total_awarded_amount
              latest_disclosable_action
              latest_disclosable_activity_at
              submitted_at
              disclosed
              has_collaboration
              __typename
            }
          }
        }
      }
    '
  }

  rest_response = rest_request.execute(
    method: :post,
    url: graphql_endpoint,
    headers: headers,
    payload: payload.to_json.delete("\n"),
    verify_ssl: false
  )

  json_resp_hash = JSON.parse(rest_response.body, symbolize_names: true)

  json_resp = {
    name: program_name,
    hacktivity: json_resp_hash
  }

  system_role_content = 'Analyze the hacktivity details for the given bug bounty program on HackerOne. Identify significant disclosed reports, common vulnerability types, and any trends that could inform future security assessments based on the provided hacktivity information.'
  ai_analysis = PWN::AI::Introspection.reflect_on(
    request: json_resp.to_json,
    system_role_content: system_role_content,
    spinner: true,
    suppress_pii_warning: true
  )
  puts "\n\n#{ai_analysis}" unless ai_analysis.nil?

  json_resp
rescue RestClient::ExceptionWithResponse => e
  if e.response
    puts "HTTP RESPONSE CODE: #{e.response.code}"
    puts "HTTP RESPONSE HEADERS:\n#{e.response.headers}"
    puts "HTTP RESPONSE BODY:\n#{e.response.body}\n\n\n"
  end

  raise e
rescue StandardError => e
  raise e
ensure
  browser_obj = PWN::Plugins::TransparentBrowser.close(browser_obj: browser_obj) if browser_obj
  rest_client = nil if rest_client
  rest_request = nil if rest_request
end

.get_scope_details(opts = {}) ⇒ Object

Supported Method Parameters

scope_details = PWN::WWW::HackerOne.get_scope_details(

program_name: 'required - program name from #get_bounty_programs method',
proxy: 'optional - scheme://proxy_host:port || tor'

)



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
 
# File 'lib/pwn/www/hacker_one.rb', line 170

public_class_method def self.get_scope_details(opts = {})
  program_name = opts[:program_name]
  proxy = opts[:proxy]

  browser_obj = PWN::Plugins::TransparentBrowser.open(
    browser_type: :rest,
    proxy: proxy
  )
  rest_client = browser_obj[:browser]
  rest_request = rest_client::Request

  graphql_endpoint = 'https://hackerone.com/graphql'
  headers = { content_type: 'application/json' }
  # NOTE: If you copy this payload to the pwn REPL
  # the triple dots ... attempt to execute commands
  # <cough>Pry CE</cough>
  payload = {
    operationName: 'PolicySearchStructuredScopesQuery',
    variables: {
      handle: program_name,
      searchString: '',
      eligibleForSubmission: nil,
      eligibleForBounty: nil,
      asmTagIds: [],
      from: 0,
      size: 100,
      sort: {
        field: 'cvss_score',
        direction: 'DESC'
      },
      product_area: 'h1_assets',
      product_feature: 'policy_scopes'
    },
    query: 'query PolicySearchStructuredScopesQuery(
      $handle: String!,
      $searchString: String,
      $eligibleForSubmission: Boolean,
      $eligibleForBounty: Boolean,
      $minSeverityScore: SeverityRatingEnum,
      $asmTagIds: [Int],
      $from: Int, $size: Int, $sort: SortInput) {
        team(handle: $handle) {
          id
          structured_scopes_search(
            search_string: $searchString
            eligible_for_submission: $eligibleForSubmission
            eligible_for_bounty: $eligibleForBounty
            min_severity_score: $minSeverityScore
            asm_tag_ids: $asmTagIds
            from: $from
            size: $size
            sort: $sort
          ) {
            nodes {
              ... on StructuredScopeDocument {
                id
                ...PolicyScopeStructuredScopeDocument
                __typename
              }
              __typename
            }
            pageInfo {
              startCursor
              hasPreviousPage
              endCursor
              hasNextPage
              __typename
            }
            total_count
            __typename
          }
          __typename
        }
      }

      fragment PolicyScopeStructuredScopeDocument on StructuredScopeDocument {
        id
        identifier
        display_name
        instruction
        cvss_score
        eligible_for_bounty
        eligible_for_submission
        asm_system_tags
        created_at
        updated_at
        attachments {
          id
          file_name
          file_size
          content_type
          expiring_url
          __typename
        }
        __typename
      }
    '
  }

  rest_response = rest_request.execute(
    method: :post,
    url: graphql_endpoint,
    headers: headers,
    payload: payload.to_json.delete("\n"),
    verify_ssl: false
  )

  json_resp_hash = JSON.parse(rest_response.body, symbolize_names: true)

  json_resp = {
    name: program_name,
    scope_details: json_resp_hash
  }

  system_role_content = 'Analyze the scope details for the given bug bounty program on HackerOne. Identify key areas of interest, potential vulnerabilities, and any patterns that could inform a targeted security assessment based on the provided scope information.'
  ai_analysis = PWN::AI::Introspection.reflect_on(
    request: json_resp.to_json,
    system_role_content: system_role_content,
    spinner: true,
    suppress_pii_warning: true
  )
  puts "\n\n#{ai_analysis}" unless ai_analysis.nil?

  json_resp
rescue RestClient::ExceptionWithResponse => e
  if e.response
    puts "HTTP RESPONSE CODE: #{e.response.code}"
    puts "HTTP RESPONSE HEADERS:\n#{e.response.headers}"
    puts "HTTP RESPONSE BODY:\n#{e.response.body}\n\n\n"
  end

  raise e
rescue StandardError => e
  raise e
ensure
  browser_obj = PWN::Plugins::TransparentBrowser.close(browser_obj: browser_obj) if browser_obj
  rest_client = nil if rest_client
  rest_request = nil if rest_request
end

.help ⇒ Object

Display Usage for this Module



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/pwn/www/hacker_one.rb', line 600

public_class_method def self.help
  puts "USAGE:
    browser_obj = #{self}.open(
      browser_type: 'optional - :firefox|:chrome|:ie|:headless (Defaults to :firefox)',
      proxy: 'optional - scheme://proxy_host:port || tor'
    )

    programs_arr = #{self}.get_bounty_programs(
      min_payouts_enabled: 'optional - only display programs where payouts are > $0.00 (defaults to false)',
      suppress_progress: 'optional - suppress output (defaults to false)',
      proxy: 'optional - scheme://proxy_host:port || tor'
    )

    scope_details = #{self}.get_scope_details(
      program_name: 'required - program name from #get_bounty_programs method',
      proxy: 'optional - scheme://proxy_host:port || tor'
    )

    hacktivity = #{self}.get_hacktivity(
      program_name: 'required - program name from #get_bounty_programs method',
      proxy: 'optional - scheme://proxy_host:port || tor'
    )

    #{self}.save_burp_target_config_file(
      programs_arr: 'required - array of hashes returned from #get_bounty_programs method',
      browser_opts: 'optional - opts supported by PWN::Plugins::TransparentBrowser.open method',
      name: 'optional - name of burp target config file (defaults to ALL)',
      root_dir: 'optional - directory to save burp target config files (defaults to \"./\"))'
    )

    browser_obj = #{self}.login(
      browser_obj: 'required - browser_obj returned from #open method',
      username: 'required - username',
      password: 'optional - passwd (will prompt if blank),
    )

    browser_obj = #{self}.logout(
      browser_obj: 'required - browser_obj returned from #open method'
    )

    #{self}.close(
      browser_obj: 'required - browser_obj returned from #open method'
    )

    #{self}.authors
  "
end

.login(opts = {}) ⇒ Object

Supported Method Parameters

browser_obj = PWN::WWW::HackerOne.login(

browser_obj: 'required - browser_obj returned from #open method',
username: 'required - username',
password: 'optional - passwd (will prompt if blank)'

)



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/pwn/www/hacker_one.rb', line 535

public_class_method def self.(opts = {})
  browser_obj = opts[:browser_obj]
  username = opts[:username].to_s.scrub.strip.chomp
  password = opts[:password]

  browser = browser_obj[:browser]

  if password.nil?
    password = PWN::Plugins::AuthenticationHelper.mask_password
  else
    password = opts[:password].to_s.scrub.strip.chomp
  end

  browser.goto('https://hackerone.com/users/sign_in')

  browser.text_field(name: 'user[email]').wait_until(&:present?).set(username)
  browser.text_field(name: 'user[password]').wait_until(&:present?).set(password)
  browser.button(name: 'commit').click!

  browser_obj
rescue StandardError => e
  raise e
end

.logout(opts = {}) ⇒ Object

Supported Method Parameters

browser_obj = PWN::WWW::HackerOne.logout(

browser_obj: 'required - browser_obj returned from #open method'

)



564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/pwn/www/hacker_one.rb', line 564

public_class_method def self.logout(opts = {})
  browser_obj = opts[:browser_obj]

  browser = browser_obj[:browser]
  browser.i(class: 'icon-arrow-closure').click!
  browser.link(index: 16).click!

  browser_obj
rescue StandardError => e
  raise e
end

.open(opts = {}) ⇒ Object

Supported Method Parameters

browser_obj = PWN::WWW::HackerOne.open(

browser_type: 'optional - :firefox|:chrome|:ie|:headless (Defaults to :firefox)',
proxy: 'optional - scheme://proxy_host:port || tor'

)



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/pwn/www/hacker_one.rb', line 17

public_class_method def self.open(opts = {})
  browser_obj = PWN::Plugins::TransparentBrowser.open(opts)

  browser = browser_obj[:browser]
  browser.goto('https://www.hackerone.com')

  browser_obj
rescue StandardError => e
  raise e
end

.save_burp_target_config_file(opts = {}) ⇒ Object

Supported Method Parameters

PWN::WWW::HackerOne.save_burp_target_config_file(

programs_arr: 'required - array of hashes returned from #get_bounty_programs method',
browser_opts: 'optional - opts supported by PWN::Plugins::TransparentBrowser.open method',
name: 'optional - name of burp target config file (defaults to ALL)',
root_dir: 'optional - directory to save burp target config files (defaults to "./"))'

)



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
 
# File 'lib/pwn/www/hacker_one.rb', line 467

public_class_method def self.save_burp_target_config_file(opts = {})
  programs_arr = opts[:programs_arr]
  raise 'ERROR: programs_arr should be data returned from #get_bounty_programs' unless programs_arr.any?

  browser_opts = opts[:browser_opts]
  raise 'ERROR: browser_opts should be a hash' unless browser_opts.nil? ||
                                                      browser_opts.is_a?(Hash)

  browser_opts ||= {}
  browser_opts[:browser_type] = :rest

  name = opts[:name]
  root_dir = opts[:root_dir]

  rest_obj = PWN::Plugins::TransparentBrowser.open(browser_opts)
  rest_client = rest_obj[:browser]::Request
  user_agent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 13_5_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36'

  if name
    path = "./burp_target_config_file-#{name}.json" if opts[:root_dir].nil?
    path = "#{root_dir}/burp_target_config_file-#{name}.json" unless opts[:root_dir].nil?
    burp_download_link = programs_arr.select do |program|
      program[:name] == name
    end.first[:burp_target_config]

    resp = rest_client.execute(
      method: :get,
      headers: { user_agent: user_agent },
      url: burp_download_link
    )
    json_resp = JSON.parse(resp.body)

    puts "Saving to: #{path}"
    File.write(path, JSON.pretty_generate(json_resp))
  else
    programs_arr.each do |program|
      name = program[:name]
      burp_download_link = program[:burp_target_config]
      path = "./burp_target_config_file-#{name}.json" if opts[:root_dir].nil?
      path = "#{root_dir}/burp_target_config_file-#{name}.json" unless opts[:root_dir].nil?

      resp = rest_client.execute(
        method: :get,
        headers: { user_agent: user_agent },
        url: burp_download_link
      )
      json_resp = JSON.parse(resp.body)

      puts "Saving to: #{path}"
      File.write(path, JSON.pretty_generate(json_resp))
    rescue JSON::ParserError,
           RestClient::NotFound
      puts '-'
      next
    end
  end
  puts 'complete.'
rescue StandardError => e
  raise e
end