8000 added report components to hacker book · ManPython/docs.hackerone.com@a828947 · GitHub
[go: up one dir, main page]

Skip to content

Commit a828947

Browse files
committed
added report components to hacker book
1 parent 8d15904 commit a828947

File tree

5 files changed

+60
-1
lines changed

5 files changed

+60
-1
lines changed
Loading
Loading
Loading

docs/hackers/report-components.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "Report Components"
3+
path: "/hackers/report-components.html"
4+
id: "hackers/report-components"
5+
---
6+
7+
Vulnerability reports consist of different components that are good to understand when viewing them on hacktivity or in your inbox.
8+
9+
### Hacker Info
10+
The top of the report shows the hacker that submitted the report as well as their hacking statistics by reputation, signal, and impact.
11+
12+
![hacker info](./images/report-timeline-hacker-info.png)
13+
14+
### Report ID and Title
15+
Below the hacker information is the report ID number and title. If you're a contributor to the report, you can change the report title to something more suitable. The color behind the report number represents the state the report is in. These are the different colors and the [report states](report-states.html) they represent:
16+
17+
Color | Report State
18+
----- | ---------
19+
Purple | New
20+
Light Blue | Needs more info
21+
Yellow | [Retesting](retesting.html)
22+
Green | Resolved
23+
Orange | Triaged
24+
Brown | Duplicate
25+
Grey | Informative
26+
Red | Not Applicable
27+
28+
### Report Metadata
29+
You’ll be able to view these metadata fields underneath the title of the report:
30+
31+
Metadata Field | Details
32+
-------------- | --------
33+
State | The state the report is in.
34+
Disclosed | The date the report was disclosed. Only shows for reports that were disclosed.
35+
Reported To | The name of the program the report was submitted to.
36+
Asset | The specific asset the vulnerability was found on.
37+
Weakness | The type of weakness of the vulnerability.
38+
Bounty | (*Only shows for resolved reports that were given a bounty*) How much bounty the report was awarded.
39+
Severity | The severity level of the vulnerability.
40+
Participants | All of the hackers involved in finding the vulnerability as well as program members involved with triaging the report.
41+
Visibility | Indicates the status of disclosure of the vulnerability.
42+
43+
![report metadata](./images/report-components-metadata.png)
44+
45+
### Summary
46+
Either your security team or the hacker(s) involved with the report can choose to provide an optional summary of the report. Including a summary helps future viewers of the report to understand the context without having to scroll through the entire report. Click **ADD SUMMARY** to add a summary to the report.
47+
48+
### Timeline
49+
The report timeline shows all of the activity that occurs in the report between the hackers and the program members involved with triaging the report. It will show when:
50+
* A hacker or a program member adds a comment
51+
* The state of the report changes
52+
* A bounty is set
53+
* A bounty has been given
54+
* A hacker requests mediation
55+
* A hacker or program member requests public disclosure
56+
57+
![report timeline](./images/report-components-timeline.png)

src/pages/hackers/hackers-nav.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@
110110
path: /hackers/report-actions.html
111111
- title: Report States
112112
path: /hackers/report-states.html
113+
- title: Report Components
114+
path: /hackers/report-components.html
113115
- title: Quality Reports
114116
path: /hackers/quality-reports.html
115117
- title: Using Markdown
@@ -126,6 +128,6 @@
126128
- title: Keyboard Shortcuts
127129
path: /hackers/keyboard-shortcuts.html
128130
- title: Pentests
129-
items:
131+
items:
130132
- title: Pentest Overview
131133
path: /hackers/pentest-overview.html

0 commit comments

Comments
 (0)
0