From d0bdb37b2b1dc8a81f47e2042d59227b1f06473f Mon Sep 17 00:00:00 2001 From: Dirkjan Ochtman Date: Mon, 8 Dec 2025 11:06:26 +0100 Subject: [PATCH] Link to reference documentation on available categories --- EXAMPLE_ADVISORY.md | 3 +-- README.md | 8 ++++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/EXAMPLE_ADVISORY.md b/EXAMPLE_ADVISORY.md index 4e04127c..aa51cea7 100644 --- a/EXAMPLE_ADVISORY.md +++ b/EXAMPLE_ADVISORY.md @@ -7,8 +7,7 @@ date = "2020-01-31" url = "https://example.com" #references = ["https://github.com/mystuff/mycrate/discussions/1"] #informational = "unmaintained" -# Valid categories: "code-execution", "crypto-failure", "denial-of-service", "file-disclosure" -# "format-injection", "memory-corruption", "memory-exposure", "privilege-escalation" +# See https://docs.rs/rustsec/latest/rustsec/advisory/enum.Category.html categories = ["code-execution", "privilege-escalation"] #cvss = "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:H/A:H" keywords = ["example", "freeform", "keywords"] diff --git a/README.md b/README.md index af1b8fdd..47674bd6 100644 --- a/README.md +++ b/README.md @@ -75,9 +75,9 @@ url = "https://github.com/mystuff/mycrate/issues/123" # - "notice" for other informational notices #informational = "unmaintained" -# Optional: Categories this advisory falls under. Valid categories are: -# "code-execution", "crypto-failure", "denial-of-service", "file-disclosure" -# "format-injection", "memory-corruption", "memory-exposure", "privilege-escalation" +# Optional: Categories this advisory falls under. +# +# See . categories = ["crypto-failure"] # Optional: a Common Vulnerability Scoring System score. More information @@ -119,7 +119,7 @@ keywords = ["ssl", "mitm"] # Table of canonical paths to vulnerable functions (optional) # mapping to which versions impacted by this advisory used that particular -# name (e.g. if the function was renamed between versions). +# name (e.g. if the function was renamed between versions). # The path syntax is `cratename::path::to::function`, without any # parameters or additional information, followed by a list of version reqs. [affected.functions]