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.

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

Editorial for Editor revision 2025-01-29 #862

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 10 additions & 7 deletions csaf_2.1/prose/edit/src/conformance.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Informative Comments:
> The order in which targets, and their corresponding clauses appear is somewhat arbitrary as there is
> no natural order on such diverse roles participating in the document exchanging ecosystem.
>
> Except for the target **CSAF document**, all other 16 targets span a taxonomy of the complex CSAF ecosystems existing
> Except for the target **CSAF document**, all other 22 targets span a taxonomy of the complex CSAF ecosystems existing
> in and between diverse security advisory generating, sharing, and consuming communities.
>
> In any case, there are no capabilities organized in increasing quality levels for targets because
Expand Down Expand Up @@ -61,9 +61,10 @@ The entities ("conformance targets") for which this document defines requirement

A text file or data stream satisfies the "CSAF document" conformance profile if it:

* conforms to the syntax and semantics defined in section [sec](#date-and-time)
* conforms to the syntax and semantics defined in section [sec](#date-and-time).
* conforms to the syntax and semantics defined in section [sec](#schema-elements).
* satisfies at least one profile defined in section [sec](#profiles).
* conforms to the syntax and semantics defined in section [sec](#additional-conventions).
* does not fail any mandatory test defined in section [sec](#mandatory-tests).

### Conformance Clause 2: CSAF producer
Expand Down Expand Up @@ -382,9 +383,9 @@ The resulting translated document:

A processor satisfies the "CSAF consumer" conformance profile if the processor:

* reads CSAF documents and interprets them according to the semantics defined in section [sec](#schema-elements).
* satisfies those normative requirements in section [sec](#schema-elements) and [sec](#safety-security-and-data-protection-considerations) that
are designated as applying to CSAF consumers.
* reads CSAF documents and interprets them according to the semantics defined in section [sec](#schema-elements) and [sec](#additional-conventions).
* satisfies those normative requirements in section [sec](#schema-elements), [sec](#additional-conventions) and
[sec](#safety-security-and-data-protection-considerations) that are designated as applying to CSAF consumers.

### Conformance Clause 11: CSAF viewer

Expand Down Expand Up @@ -535,8 +536,10 @@ Firstly, the program:

Secondly, the program fulfills the following for all items of:

* type `/$defs/full_product_name_t/cpe`: If a CPE is invalid, the CSAF 2.0 to CSAF 2.1 converter SHOULD removed the invalid value and output a
warning that an invalid CPE was detected and removed. Such a warning MUST include the invalid CPE.
* type `/$defs/full_product_name_t/product_identification_helper/cpe`: If a CPE is invalid, the CSAF 2.0 to CSAF 2.1 converter SHOULD removed the
invalid value and output a warning that an invalid CPE was detected and removed. Such a warning MUST include the invalid CPE.
* type `/$defs/full_product_name_t/product_identification_helper/purls`: If a `/$defs/full_product_name_t/product_identification_helper/purl` is given,
the CSAF 2.0 to CSAF 2.1 converter MUST convert it into the first item of the corresponding `purls` array.
* `/$schema`: The CSAF 2.0 to CSAF 2.1 converter MUST set property with the value prescribed by the schema.
* `/document/csaf_version`: The CSAF 2.0 to CSAF 2.1 converter MUST update the value to `2.1`.
* `/document/distribution/tlp/label`: If a TLP label is given, the CSAF 2.0 to CSAF 2.1 converter MUST convert it according to the table below:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Date and Time

This standard uses the `date-time` format as defined in JSON Schema Draft 2020-12 Section 7.3.1.
In accordance with [cite]{#RFC3339} and [cite]{#ISO8601}, the following rules apply:
In accordance with [cite](#RFC3339) and [cite](#ISO8601-1), the following rules apply:

* The letter `T` separating the date and time SHALL be upper case.
* The separator between date and time MUST be the letter `T`.
Expand Down
173 changes: 86 additions & 87 deletions csaf_2.1/prose/edit/src/guidance-on-size.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Normative References

ISO8601
: _Data elements and interchange formats — Information interchange — Representation of dates and times_, International Standard, ISO 8601:2004(E), December 1, 2004, https://www.iso.org/standard/40874.html.
ISO8601-1
: _Date and time — Representations for information interchangePart 1: Basic rules_, International Standard, ISO 8601-1:2019(E), February 25, 2019, https://www.iso.org/standard/70907.html.

JSON-Schema-Core
: _JSON Schema: A Media Type for Describing JSON Documents_, draft-bhutton-json-schema-00, December 2020, <https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ CSAF-v2.0
: _Common Security Advisory Framework Version 2.0_. Edited by Langley Rock, Stefan Hagen, and Thomas Schmidt. 18 November 2022. OASIS Standard. https://docs.oasis-open.org/csaf/csaf/v2.0/os/csaf-v2.0-os.html. Latest stage: https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html.

CVE
: _Common Vulnerability and Exposures (CVE) – The Standard for Information Security Vulnerability Names_, MITRE, 1999, https://cve.mitre.org/about/.
: _Common Vulnerability and Exposures (CVE) – The Standard for Information Security Vulnerability Names_, MITRE, 1999, https://www.cve.org/About/Overview.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sthagen The title changed - should we change that as well? Or use a different site?


CVE-NF
: _Common Vulnerability and Exposures (CVE) – The Standard for Information Security Vulnerability Names - CVE ID Syntax Change_, MITRE, January 01, 2014, https://cve.mitre.org/cve/identifiers/syntaxchange.html.
Expand All @@ -37,13 +37,13 @@ CVSS31
: _Common Vulnerability Scoring System v3.1: Specification Document_, FIRST.Org, Inc., June 2019, https://www.first.org/cvss/v3-1/cvss-v31-specification_r1.pdf.

CVSS40
: _Common Vulnerability Scoring System v4.0: Specification Document_, FIRST.Org, Inc., 09 November 2023, https://www.first.org/cvss/v4-0/cvss-v40-specification.pdf.
: _Common Vulnerability Scoring System v4.0: Specification Document_, FIRST.Org, Inc., November 9, 2023, https://www.first.org/cvss/v4-0/cvss-v40-specification.pdf.

CWE
: _Common Weakness Enumeration (CWE) – A Community-Developed List of Software Weakness Types_, MITRE, 2005, http://cwe.mitre.org/about/.
: _Common Weakness Enumeration (CWE) – A Community-Developed List of Software Weakness Types_, MITRE, 2006, http://cwe.mitre.org/about/.

CYCLONEDX13
: _CycloneDX Software Bill-of-Material Specification JSON schema version 1.3_, cyclonedx.org, May 2021, https://github.com/CycloneDX/specification/blob/1.3/schema/bom-1.3.schema.json.
CYCLONEDX161
: _CycloneDX Software Bill-of-Material Specification JSON schema version 1.6.1_, cyclonedx.org, November 7, 2024, https://github.com/CycloneDX/specification/blob/1.6.1/schema/bom-1.6.schema.json.

GFMCMARK
: _GitHub's fork of cmark, a CommonMark parsing and rendering library and program in C_, https://github.com/github/cmark.
Expand All @@ -55,7 +55,7 @@ ISO19770-2
: _Information technology — IT asset management — Part 2: Software identification tag_, International Standard, ISO 19770-2:2015, September 30, 2015, <https://www.iso.org/standard/65666.html>.

ISO29147
: _Information technology — Security techniques — Vulnerability disclosure_, International Standard, ISO/IEC 29147:2018, October, 2018, <https://www.iso.org/standard/72311.html>.
: _Information technology — Security techniques — Vulnerability disclosure_, International Standard, ISO/IEC 29147:2018, October 23, 2018, <https://www.iso.org/standard/72311.html>.

OPENSSL
: _GTLS/SSL and crypto library_, OpenSSL Software Foundation, https://www.openssl.org/.
Expand Down Expand Up @@ -99,11 +99,11 @@ SECURITY-TXT
SemVer
: _Semantic Versioning 2.0.0_, T. Preston-Werner, June 2013, <https://semver.org/>.

SPDX22
: _The Software Package Data Exchange (SPDX®) Specification Version 2.2_, Linux Foundation and its Contributors, 2020, <https://spdx.github.io/spdx-spec/>.
SPDX301
: _The System Package Data Exchange® (SPDX®) Specification Version 3.0.1_, Linux Foundation and its Contributors, 2024, <https://spdx.github.io/spdx-spec/>.

VERS
: _vers: a mostly universal version range specifier_, Part of the purl GitHub Project, <https://github.com/package-url/purl-spec/blob/version-range-spec/VERSION-RANGE-SPEC.rst>.
: _vers: a mostly universal version range specifier_, Part of the purl GitHub Project, <https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst>.

VEX
: _Vulnerability-Exploitability eXchange (VEX) - An Overview_, VEX sub-group of the Framing Working Group in the NTIA SBOM initiative, 27 September 2021, <https://ntia.gov/files/ntia/publications/vex_one-page_summary.pdf>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ The value of MUST obey to exactly one of the following options:
*Examples 1 (for `name` when using `product_version_range` with vers):*

```
vers:gem/>=2.2.0|!= 2.2.1|<2.3.0
vers:gem/>=2.2.0|!=2.2.1|<2.3.0
vers:npm/1.2.3|>=2.0.0|<5.0.0
vers:pypi/0.0.0|0.0.1|0.0.2|0.0.3|1.0|2.0pre1
vers:tomee/>=8.0.0-M1|<=8.0.1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,19 +164,19 @@ The default value for `algorithm` is `sha256`.

These values are derived from the currently supported digests OpenSSL [cite](#OPENSSL). Leading dashes were removed.

> The command `openssl dgst -list` (Version 1.1.1f from 2020-03-31) outputs the following:
> The command `openssl dgst -list` (Version 3.4.0 from 2024-10-22) outputs the following:
>
>```
> Supported digests:
> -blake2b512 -blake2s256 -md4
> -md5 -md5-sha1 -ripemd
> -ripemd160 -rmd160 -sha1
> -sha224 -sha256 -sha3-224
> -sha3-256 -sha3-384 -sha3-512
> -sha384 -sha512 -sha512-224
> -sha512-256 -shake128 -shake256
> -sm3 -ssl3-md5 -ssl3-sha1
> -whirlpool
> -md5 -md5-sha1 -mdc2
> -ripemd -ripemd160 -rmd160
> -sha1 -sha224 -sha256
> -sha3-224 -sha3-256 -sha3-384
> -sha3-512 -sha384 -sha512
> -sha512-224 -sha512-256 -shake128
> -shake256 -sm3 -ssl3-md5
> -ssl3-sha1 -whirlpool
>```

The Value of the cryptographic hash representation (`value`) of value type `string` of 32 or more characters with `pattern` (regular expression):
Expand Down
2 changes: 1 addition & 1 deletion csaf_2.1/prose/edit/src/tests-01-mndtr-11-cwe.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### CWE

It MUST be tested that given CWE exists and is valid in the version provided.
For each CWE it MUST be tested that the given CWE exists and is valid in the version provided.
Any `id` that refers to a CWE Category or View MUST fail the test.

The relevant path for this test is:
Expand Down
4 changes: 2 additions & 2 deletions csaf_2.1/prose/edit/src/tests-03-informative.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ If no CVE exists for that vulnerability, it is recommended to get one assigned.

### Missing CWE

It MUST be tested that the CWE is given.
It MUST be tested that at least one CWE is given.

The relevant path for this test is:

Expand All @@ -139,7 +139,7 @@ The relevant path for this test is:
]
```

> The CWE number is not given.
> No CWE number is given.

### Use of Short Hash

Expand Down