Skip to content

Latest commit

 

History

History
124 lines (85 loc) · 4.12 KB

README.md

File metadata and controls

124 lines (85 loc) · 4.12 KB
Raw

Hackerone::Client

A limited client library for interacting with HackerOne. Currently only supports a few operations:

Client

Initialize Client
client = HackerOne::Client::Api.new("github")

# GET '/reports' returns all reports in the "new" state for a given program
client.reports

# GET '/report/{id}' returns report data for a given report
report = client.report(id)

# PUT '/reports/{id}/assignee'
report.assign_to_user("username")
report.assign_to_group("groupname")

# POST '/reports/#{id}/activities'
report.add_comment(message, internal: false) # internal is true by default

# POST '/report/{id}/state_change change the state of a report
# `state` can be one of  new, triaged, needs-more-info, resolved, not-applicable, informative, duplicate, spam
# when marking as duplicate, you can supply the original report ID
report.state_change(:duplicate, "Your issue has been marked as X", original_report_id: 12345)

# POST '/report/{id}/add_report_reference add a "reference" e.g. internal issue number
report.add_report_reference(reference)

# Triage an issue (add a reference and set state to :triaged)
report.triage(reference)

# POST /reports/{id}/bounty_suggestions
report.suggest_bounty(message: "I suggest $500 with a small bonus. Report is well-written.", amount: 500, bonus_amount: 50)

# POST /reports/{id}/bounties
report.award_bounty(message: "Here's your bounty!", amount: 500, bonus_amount: 50)

# POST /reports/{id}/swags
report.award_swag(message: "Here's your T-Shirt")

# GET `/{program}/reporters` returns a list of unique reporters that have reported to your program
client.reporters

Program

Initialize program
program = HackerOne::Client::Program.find("insert-program-name-here")

# returns all groups, memership types and users that manage the program. **It does not include reporters**
program.users

# get all groups in a program
program.users[:relationships][:groups]

 # > program.users[:relationships][:groups]
 => {:data=>[{:id=>"xxx", :type=>"group", :attributes=>{:name=>"Admin", :created_at=>"20xx-06-16T15:44:16.721Z",
 :permissions=>["user_management", "program_management"]}}, {:id=>"xxxx", :type=>"group", :attributes=>{:name=>"Standard",
 :created_at=>"20xx-06-16T15:44:16.751Z", :permissions=>["report_management", "reward_management"]}}, {:id=>"xxxx", 
 :type=>"group", :attributes=>{:name=>"View/Comment/Triage", :created_at=>"20xx-11-11T19:39:55.393Z", :permissions=>["report_management"]}}]}
 
 # get all members in a program
 program.users[:relationships][:members]


# returns all common responses
program.common_responses

# pagination on program reporters
default: program.reporters(page_number: 1, page_size: 25)

State change hooks

You can add hooks that will be called for every state change. This can be useful e.g. for ensuring that reports always get assigned or calling out to external services for specific state changes.

# Initialization

HackerOne::Client::Report.add_state_change_hook ->(report, old_state, new_state) do
  # ...
end

Usage

Credential management

You'll need to generate an API token at https://hackerone.com/<program>/api.

  • Click "Create API token"
  • Name the token
  • Click "Create"
  • Copy down the value

Set the HACKERONE_TOKEN and HACKERONE_TOKEN_NAME environment variables.

Program name

In order to retrieve all reports for a given program, you need to supply a default program:

HackerOne::Client.program = "github"

Risk classification

Configure the low/med/high/crit ranges for easier classification based on payouts:

HackerOne::Client.low_range = 1..999
HackerOne::Client.medium_range = 1000...2500
HackerOne::Client.high_range = 2500...5000
HackerOne::Client.critical_range = 5000...100_000_000

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/oreoshake/hackerone-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.