@@ -96,23 +96,34 @@ new report to the database by following these steps:
96
96
97
97
### If the report is labeled ` NeedsReport `
98
98
99
- 1 . From the repo root, run ` vulnreport create <GitHub issue number> ` .
99
+ 1 . Create a new branch.
100
+ 2 . From the repo root, run ` vulnreport create <GitHub issue number> ` .
100
101
vulnreport will create a YAML report template for the CVE or GHSA at the
101
102
specified GitHub issue number. This command works for both regular reports
102
103
and excluded reports. It also accepts multiple Github issue numbers (space
103
104
separated), and Github issue ranges (e.g., ` 1000-1010 ` ).
104
- 2 . Edit the report file template.
105
- 3 . From the repo root, run ` vulnreport commit [<report file> | <GitHub issue number>] ` .
105
+ 3 . Edit the report file template.
106
+ 1 . If a person or organization is given credit in the CVE or GHSA, add the
107
+ name to the "credit" field. Otherwise, delete the field.
108
+ 2 . In the "vulnerable_at" field, put the highest version just before the
109
+ vuln is fixed. The pkgsite versions page can help with the list of
110
+ versions. The GitHub UI also makes it easy to list tags (click "Code",
111
+ then the dropdown that shows the current branch, then "Tags"). Walk the
112
+ versions backwards from the fixed one to find the highest that doesn't
113
+ contain the fix. (It might not be the immediately preceding version.)
114
+ 3 . Add vulnerable functions to the "symbols" list by reading the CVE,
115
+ the fixing CLs, and the code at the vulnerable version you chose above.
116
+ 4 . From the repo root, run ` vulnreport commit [<report file> | <GitHub issue number>] ` .
106
117
(Example: ` vulnreport commit 1623 ` .)
107
118
This will lint the report, add exported symbols, convert the YAML to OSV, and commit
108
119
the new files with a standard commit message. Commits are to the local git
109
120
repository. The ` vulnreport commit ` command also accepts multiple
110
121
space-separated files/issue numbers, and will create a separate commit for
111
122
each report.
112
- 4 . Send the commit for review and approval. See the Go
123
+ 5 . Send the commit for review and approval. See the Go
113
124
[ contribution guide] ( https://go.dev/doc/contribute ) for sending a change on
114
125
Gerrit.
115
- 5 . If you make changes to the report during review, run
126
+ 6 . If you make changes to the report during review, run
116
127
` vulnreport fix <GitHub issue number> ` before re-mailing to update the OSV
117
128
and perform other useful actions.
118
129
0 commit comments