Skip to content

Commit d0bdb37

Browse files
committed
Link to reference documentation on available categories
1 parent eb1f940 commit d0bdb37

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

EXAMPLE_ADVISORY.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ date = "2020-01-31"
77
url = "https://example.com"
88
#references = ["https://github.com/mystuff/mycrate/discussions/1"]
99
#informational = "unmaintained"
10-
# Valid categories: "code-execution", "crypto-failure", "denial-of-service", "file-disclosure"
11-
# "format-injection", "memory-corruption", "memory-exposure", "privilege-escalation"
10+
# See https://docs.rs/rustsec/latest/rustsec/advisory/enum.Category.html
1211
categories = ["code-execution", "privilege-escalation"]
1312
#cvss = "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:H/A:H"
1413
keywords = ["example", "freeform", "keywords"]

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ url = "https://github.com/mystuff/mycrate/issues/123"
7575
# - "notice" for other informational notices
7676
#informational = "unmaintained"
7777

78-
# Optional: Categories this advisory falls under. Valid categories are:
79-
# "code-execution", "crypto-failure", "denial-of-service", "file-disclosure"
80-
# "format-injection", "memory-corruption", "memory-exposure", "privilege-escalation"
78+
# Optional: Categories this advisory falls under.
79+
#
80+
# See <https://docs.rs/rustsec/latest/rustsec/advisory/enum.Category.html>.
8181
categories = ["crypto-failure"]
8282

8383
# Optional: a Common Vulnerability Scoring System score. More information
@@ -119,7 +119,7 @@ keywords = ["ssl", "mitm"]
119119

120120
# Table of canonical paths to vulnerable functions (optional)
121121
# mapping to which versions impacted by this advisory used that particular
122-
# name (e.g. if the function was renamed between versions).
122+
# name (e.g. if the function was renamed between versions).
123123
# The path syntax is `cratename::path::to::function`, without any
124124
# parameters or additional information, followed by a list of version reqs.
125125
[affected.functions]

0 commit comments

Comments
 (0)