Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reserved/well-established note category/title combinations #725

Merged
merged 4 commits into from
May 12, 2024
Merged

Reserved/well-established note category/title combinations #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
45a5bdc
Preconditions
tschmidtb51 Apr 23, 2024
d8bab66
Vulnerability summary vs. CVE description
tschmidtb51 Apr 23, 2024
9544368
Document Notes
tschmidtb51 Apr 23, 2024
c93df8f
Well-established note category/title combinations
tschmidtb51 Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions csaf_2.1/prose/edit/src/schema-elements-02-props-01-document.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,14 @@ Document notes (`notes`) of value type Notes Type (`notes_t`) holds notes associ
},
```

The following combinations of `category` and `title` have a special meaning and MUST be used as stated below:

| `category` | `title` | content of `text` |
sthagen marked this conversation as resolved.
Show resolved Hide resolved
|---------------|---------------|-------------------|
| `description` | Product Description | Contains a description of a product given in the `product_tree` in regards to field of application and core functionality. |
| `general` | General Security Recommendations | Contains general advise and security recommendations that are related, generic and might be independently applicable of the content of the CSAF document. |
| `summary` | Summary | Contains a short summary of the content of the advisory. |

#### Document Property - Publisher

Publisher (`publisher`) has value type `object` with the mandatory properties Category (`category`), Name (`name`) and
Expand Down
8 changes: 8 additions & 0 deletions csaf_2.1/prose/edit/src/schema-elements-02-props-03-vulnerabilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,14 @@ Vulnerability notes (`notes`) of value type Notes Type (`notes_t`) holds notes a
},
```

The following combinations of `category` and `title` have a special meaning and MUST be used as stated below:

| `category` | `title` | content of `text` |
sthagen marked this conversation as resolved.
Show resolved Hide resolved
|---------------|---------------|-------------------|
| `description` | CVE Description | Contains the official and unchanged CVE description for this specific vulnerability. |
| `description` | Preconditions | Contains a description of the preconditions that have to be fulfilled to be able to exploit the vulnerability, e.g. user account or physical access. |
| `summary` | Vulnerability Summary | Contains a summary of the vulnerability which is not the official CVE description. |

#### Vulnerabilities Property - Product Status

Product status (`product_status`) of value type `object` with 1 or more properties contains different lists of `product_ids` which
Expand Down
Loading