OASIS Logo

Common Security Advisory Framework Version 2.1

 Committee Specification Draft 01

 28 May 2025

 

 This stage:

https://docs.oasis-open.org/csaf/csaf/v2.1/csd01/csaf-v2.1-csd01.md (Authoritative)
https://docs.oasis-open.org/csaf/csaf/v2.1/csd01/csaf-v2.1-csd01.html
https://docs.oasis-open.org/csaf/csaf/v2.1/csd01/csaf-v2.1-csd01.pdf

 Previous stage:

N/A

 Latest stage:

https://docs.oasis-open.org/csaf/csaf/v2.1/csaf-v2.1.md (Authoritative)
https://docs.oasis-open.org/csaf/csaf/v2.1/csaf-v2.1.html
https://docs.oasis-open.org/csaf/csaf/v2.1/csaf-v2.1.pdf

 Technical Committee:

OASIS Common Security Advisory Framework (CSAF) TC

 Chairs:

Justin Murphy (justin.murphy@mail.cisa.dhs.gov), DHS Cybersecurity and Infrastructure Security Agency (CISA)
Omar Santos (osantos@cisco.com), Cisco Systems
Stefan Hagen (stefan@hagen.link), Individual

 Editors:

Stefan Hagen (stefan@hagen.link), Individual
Thomas Schmidt (thomas.schmidt@bsi.bund.de), Federal Office for Information Security (BSI) Germany

 Additional artifacts:

This prose specification is one component of a Work Product that also includes:

This specification replaces or supersedes:

 Declared JSON namespaces:

 Abstract:

The Common Security Advisory Framework (CSAF) Version 2.1 is the definitive reference for the language which supports creation, update, and interoperable exchange of security advisories as structured information on products, vulnerabilities and the status of impact and remediation among interested parties.

 Status:

This document was last revised or approved by the membership of OASIS on the above date. The level of approval is also listed above. Check the “Latest stage” location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=csaf#technical.

TC members should send comments on this specification to the TC’s email list. Others should send comments to the TC’s public comment list, after subscribing to it by following the instructions at the “Send A Comment” button on the TC’s web page at https://www.oasis-open.org/committees/csaf/.

This specification is provided under the Non-Assertion Mode of the OASIS IPR Policy, the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s web page (https://www.oasis-open.org/committees/csaf/ipr.php).

Note that any machine-readable content (Computer Language Definitions) declared Normative for this Work Product is provided in separate plain text files. In the event of a discrepancy between any such plain text file and display content in the Work Product’s prose narrative document(s), the content in the separate plain text file prevails.

 Citation format:

When referencing this specification the following citation format should be used:

[csaf-v2.1]

Common Security Advisory Framework Version 2.1. Edited by Stefan Hagen, and Thomas Schmidt. 28 May 2025. OASIS Committee Specification Draft 01. https://docs.oasis-open.org/csaf/csaf/v2.1/csd01/csaf-v2.1-csd01.html. Latest stage: https://docs.oasis-open.org/csaf/csaf/v2.1/csaf-v2.1.html.

 Notices

Copyright © OASIS Open 2022. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the “OASIS IPR Policy”). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an “AS IS” basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

As stated in the OASIS IPR Policy, the following three paragraphs in brackets apply to OASIS Standards Final Deliverable documents (Committee Specification, Candidate OASIS Standard, OASIS Standard, or Approved Errata).

[OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this deliverable.]

[OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this OASIS Standards Final Deliverable. OASIS may include such claims on its website, but disclaims any obligation to do so.]

[OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this OASIS Standards Final Deliverable or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS’ procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Standards Final Deliverable, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.]

The name “OASIS” is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark/ for above guidance.

 Table of Contents

  1. Introduction
    1.1 IPR Policy
    1.2 Terminology
    1.3 Normative References
    1.4 Informative References
    1.5 Typographical Conventions
  2. Design Considerations
    2.1 Construction Principles
    2.2 Format Validation
    2.3 Date and Time
  3. Schema Elements
    3.1 Definitions
    3.1.1 Acknowledgments Type
    3.1.1.1 Acknowledgments Type - Names
    3.1.1.2 Acknowledgments Type - Organization
    3.1.1.3 Acknowledgments Type - Summary
    3.1.1.4 Acknowledgments Type - URLs
    3.1.1.5 Acknowledgments Type - Example
    3.1.2 Branches Type
    3.1.2.1 Branches Type - Branches
    3.1.2.2 Branches Type - Category
    3.1.2.3 Branches Type - Name
    3.1.2.3.1 Branches Type - Name under Product Version
    3.1.2.3.2 Branches Type - Name under Product Version Range
    3.1.2.4 Branches Type - Product
    3.1.3 Full Product Name Type
    3.1.3.1 Full Product Name Type - Name
    3.1.3.2 Full Product Name Type - Product ID
    3.1.3.3 Full Product Name Type - Product Identification Helper
    3.1.3.3.1 Full Product Name Type - Product Identification Helper - CPE
    3.1.3.3.2 Full Product Name Type - Product Identification Helper - Hashes
    3.1.3.3.3 Full Product Name Type - Product Identification Helper - Model Numbers
    3.1.3.3.4 Full Product Name Type - Product Identification Helper - purls
    3.1.3.3.5 Full Product Name Type - Product Identification Helper - SBOM URLs
    3.1.3.3.6 Full Product Name Type - Product Identification Helper - Serial Numbers
    3.1.3.3.7 Full Product Name Type - Product Identification Helper - SKUs
    3.1.3.3.8 Full Product Name Type - Product Identification Helper - Generic URIs
    3.1.4 Language Type
    3.1.5 Notes Type
    3.1.6 Product Group ID Type
    3.1.7 Product Groups Type
    3.1.8 Product ID Type
    3.1.9 Products Type
    3.1.10 References Type
    3.1.11 Version Type
    3.1.11.1 Version Type - Integer versioning
    3.1.11.2 Version Type - Semantic versioning
    3.2 Properties
    3.2.1 Schema Property
    3.2.2 Document Property
    3.2.2.1 Document Property - Acknowledgments
    3.2.2.2 Document Property - Aggregate Severity
    3.2.2.3 Document Property - Category
    3.2.2.4 Document Property - CSAF Version
    3.2.2.5 Document Property - Distribution
    3.2.2.5.1 Document Property - Distribution - Sharing Group
    3.2.2.5.2 Document Property - Distribution - Text
    3.2.2.5.3 Document Property - Distribution - TLP
    3.2.2.6 Document Property - Language
    3.2.2.7 Document Property - License Expression
    3.2.2.8 Document Property - Notes
    3.2.2.9 Document Property - Publisher
    3.2.2.9.1 Document Property - Publisher - Category
    3.2.2.9.2 Document Property - Publisher - Contact Details
    3.2.2.9.3 Document Property - Publisher - Issuing Authority
    3.2.2.9.4 Document Property - Publisher - Name
    3.2.2.9.5 Document Property - Publisher - Namespace
    3.2.2.10 Document Property - References
    3.2.2.11 Document Property - Source Language
    3.2.2.12 Document Property - Title
    3.2.2.13 Document Property - Tracking
    3.2.2.13.1 Document Property - Tracking - Aliases
    3.2.2.13.2 Document Property - Tracking - Current Release Date
    3.2.2.13.3 Document Property - Tracking - Generator
    3.2.2.13.4 Document Property - Tracking - ID
    3.2.2.13.5 Document Property - Tracking - Initial Release Date
    3.2.2.13.6 Document Property - Tracking - Revision History
    3.2.2.13.7 Document Property - Tracking - Status
    3.2.2.13.8 Document Property - Tracking - Version
    3.2.3 Product Tree Property
    3.2.3.1 Product Tree Property - Branches
    3.2.3.2 Product Tree Property - Full Product Names
    3.2.3.3 Product Tree Property - Product Groups
    3.2.3.4 Product Tree Property - Relationships
    3.2.4 Vulnerabilities Property
    3.2.4.1 Vulnerabilities Property - Acknowledgments
    3.2.4.2 Vulnerabilities Property - CVE
    3.2.4.3 Vulnerabilities Property - CWEs
    3.2.4.4 Vulnerabilities Property - Disclosure Date
    3.2.4.5 Vulnerabilities Property - Discovery Date
    3.2.4.6 Vulnerabilities Property - First Known Exploitation Dates
    3.2.4.7 Vulnerabilities Property - Flags
    3.2.4.8 Vulnerabilities Property - IDs
    3.2.4.9 Vulnerabilities Property - Involvements
    3.2.4.10 Vulnerabilities Property - Metrics
    3.2.4.10.1 Vulnerabilities Property - Metrics - Content
    3.2.4.10.2 Vulnerabilities Property - Metrics - Products
    3.2.4.10.3 Vulnerabilities Property - Metrics - Source
    3.2.4.11 Vulnerabilities Property - Notes
    3.2.4.12 Vulnerabilities Property - Product Status
    3.2.4.13 Vulnerabilities Property - References
    3.2.4.14 Vulnerabilities Property - Remediations
    3.2.4.14.1 Vulnerabilities Property - Remediations - Category
    3.2.4.14.2 Vulnerabilities Property - Remediations - Date
    3.2.4.14.3 Vulnerabilities Property - Remediations - Details
    3.2.4.14.4 Vulnerabilities Property - Remediations - Entitlements
    3.2.4.14.5 Vulnerabilities Property - Remediations - Group IDs
    3.2.4.14.6 Vulnerabilities Property - Remediations - Product IDs
    3.2.4.14.7 Vulnerabilities Property - Remediations - Restart Required
    3.2.4.14.8 Vulnerabilities Property - Remediations - URL
    3.2.4.15 Vulnerabilities Property - Threats
    3.2.4.16 Vulnerabilities Property - Title
  4. Profiles
    4.1 Profile 1: CSAF Base
    4.2 Profile 2: Security incident response
    4.3 Profile 3: Informational Advisory
    4.4 Profile 4: Security Advisory
    4.5 Profile 5: VEX
    4.6 Profile 6: Deprecated Security Advisory
    4.7 Profile 7: Withdrawn
    4.8 Profile 8: Superseded
  5. Additional Conventions
    5.1 Filename
    5.2 Separation in Data Stream
    5.3 Sorting
    5.4 Usage of Markdown
    5.5 Branch recursion
    5.6 Hardware and Software within the Product Tree
  6. Tests
    6.1 Mandatory Tests
    6.1.1 Missing Definition of Product ID
    6.1.2 Multiple Definition of Product ID
    6.1.3 Circular Definition of Product ID
    6.1.4 Missing Definition of Product Group ID
    6.1.5 Multiple Definition of Product Group ID
    6.1.6 Contradicting Product Status
    6.1.7 Multiple Scores with same Version per Product
    6.1.8 Invalid CVSS
    6.1.9 Invalid CVSS computation
    6.1.10 Inconsistent CVSS
    6.1.11 CWE
    6.1.12 Language
    6.1.13 PURL
    6.1.14 Sorted Revision History
    6.1.15 Translator
    6.1.16 Latest Document Version
    6.1.17 Document Status Draft
    6.1.18 Released Revision History
    6.1.19 Revision History Entries for Pre-release Versions
    6.1.20 Non-draft Document Version
    6.1.21 Missing Item in Revision History
    6.1.22 Multiple Definition in Revision History
    6.1.23 Multiple Use of Same CVE
    6.1.24 Multiple Definition in Involvements
    6.1.25 Multiple Use of Same Hash Algorithm
    6.1.26 Prohibited Document Category Name
    6.1.27 Profile Tests
    6.1.27.1 Document Notes
    6.1.27.2 Document References
    6.1.27.3 Vulnerabilities
    6.1.27.4 Product Tree
    6.1.27.5 Vulnerability Notes
    6.1.27.6 Product Status
    6.1.27.7 VEX Product Status
    6.1.27.8 Vulnerability ID
    6.1.27.9 Impact Statement
    6.1.27.10 Action Statement
    6.1.27.11 Vulnerabilities
    6.1.27.12 Affected Products
    6.1.27.13 Corresponding Affected Products
    6.1.27.14 Document Notes
    6.1.27.15 Product Tree
    6.1.27.16 Revision History
    6.1.27.17 Reasoning for Withdrawal
    6.1.27.18 Reasoning for Supersession
    6.1.27.19 Reference to Superseding Document
    6.1.28 Translation
    6.1.29 Remediation without Product Reference
    6.1.30 Mixed Integer and Semantic Versioning
    6.1.31 Version Range in Product Version
    6.1.32 Flag without Product Reference
    6.1.33 Multiple Flags with VEX Justification Codes per Product
    6.1.34 Branches Recursion Depth
    6.1.35 Contradicting Remediations
    6.1.36 Contradicting Product Status Remediation Combination
    6.1.37 Date and Time
    6.1.38 Non-Public Sharing Group with Max UUID
    6.1.39 Public Sharing Group with no Max UUID
    6.1.40 Invalid Sharing Group Name
    6.1.41 Missing Sharing Group Name
    6.1.42 PURL Qualifiers
    6.1.43 Use of Multiple Stars in Model Number
    6.1.44 Use of Multiple Stars in Serial Number
    6.1.45 Inconsistent Disclosure Date
    6.1.46 Invalid SSVC
    6.1.47 Inconsistent SSVC ID
    6.1.48 SSVC Decision Points
    6.1.49 Inconsistent SSVC Timestamp
    6.1.50 Product Version Range Rules
    6.1.51 Inconsistent EPSS Timestamp
    6.1.52 Inconsistent First Known Exploitation Dates
    6.1.53 Inconsistent Exploitation Date
    6.1.54 License Expression
    6.1.55 License Text
    6.2 Recommended Tests
    6.2.1 Unused Definition of Product ID
    6.2.2 Missing Remediation
    6.2.3 Missing Metric
    6.2.4 Build Metadata in Revision History
    6.2.5 Older Initial Release Date than Revision History
    6.2.6 Older Current Release Date than Revision History
    6.2.7 Missing Date in Involvements
    6.2.8 Use of MD5 as the only Hash Algorithm
    6.2.9 Use of SHA-1 as the only Hash Algorithm
    6.2.10 Missing TLP label (obsolete)
    6.2.11 Missing Canonical URL
    6.2.12 Missing Document Language
    6.2.13 Sorting
    6.2.14 Use of Private Language
    6.2.15 Use of Default Language
    6.2.16 Missing Product Identification Helper
    6.2.17 CVE in field IDs
    6.2.18 Product Version Range without vers
    6.2.19 CVSS for Fixed Products
    6.2.20 Additional Properties
    6.2.21 Same Timestamps in Revision History
    6.2.22 Document Tracking ID in Title
    6.2.23 Usage of Deprecated CWE
    6.2.24 Usage of Non-Latest CWE Version
    6.2.25 Usage of CWE Not Allowed for Vulnerability Mapping
    6.2.26 Usage of CWE Allowed with Review for Vulnerability Mapping
    6.2.27 Discouraged Product Status Remediation Combination
    6.2.28 Usage of Max UUID
    6.2.29 Usage of Nil UUID
    6.2.30 Usage of Sharing Group on TLP:CLEAR
    6.2.31 Hardware and Software
    6.2.32 Use of same Product Identification Helper for different Products
    6.2.33 Disclosure Date newer than Revision History
    6.2.34 Usage of Unregistered SSVC Decision Point Namespace
    6.2.35 Usage of Private SSVC Decision Point Namespace in TLP:CLEAR Document
    6.2.36 Usage of SSVC Decision Point Namespace with Extension in TLP:CLEAR Document
    6.2.37 Usage of Unknown SSVC Role
    6.2.38 Usage of Deprecated Profile
    6.2.39 Profile Tests
    6.2.39.1 Missing Fixed Product
    6.2.39.2 Language Specific Reasoning for Withdrawal
    6.2.39.3 Language Specific Reasoning for Supersession
    6.2.39.4 Language Specific Superseding Document
    6.2.40 Product Description without Product Reference
    6.2.41 Old EPSS Timestamp
    6.2.42 Inconsistent Product Identification Helper
    6.2.43 Missing License Expression
    6.2.44 Deprecated License Identifier
    6.2.45 Non-Existing License Identifier
    6.2.46 Language Specific License Text
    6.3 Informative Tests
    6.3.1 Use of CVSS v2 as the only Scoring System
    6.3.2 Use of CVSS v3.0
    6.3.3 Missing CVE
    6.3.4 Missing CWE
    6.3.5 Use of Short Hash
    6.3.6 Use of non-self referencing URLs Failing to Resolve
    6.3.7 Use of self referencing URLs Failing to Resolve
    6.3.8 Spell Check
    6.3.9 Branch Categories
    6.3.10 Usage of Product Version Range
    6.3.11 Usage of V as Version Indicator
    6.3.12 Missing CVSS v4.0
    6.3.13 Usage of Non-Latest SSVC Decision Point Version
    6.3.14 Usage of Private SSVC Decision Point Namespace in non TLP:CLEAR Document
    6.3.15 Usage of SSVC Decision Point Namespace with Extension in non TLP:CLEAR Document
    6.3.16 Grammar Check
    6.3.17 Use of Unregistered License
    6.4 Presets
    6.4.1 Presets defined through Test Subsections
    6.4.2 Presets defined through Conformance Targets
    6.4.3 Additional Presets
  7. Distributing CSAF documents
    7.1 Requirements
    7.1.1 Requirement 1: Valid CSAF document
    7.1.2 Requirement 2: Filename
    7.1.3 Requirement 3: TLS
    7.1.4 Requirement 4: TLP:CLEAR
    7.1.5 Requirement 5: TLP:AMBER, TLP:AMBER+STRICT and TLP:RED
    7.1.6 Requirement 6: No Redirects
    7.1.7 Requirement 7: provider-metadata.json
    7.1.8 Requirement 8: security.txt
    7.1.9 Requirement 9: Well-known URL for provider-metadata.json
    7.1.10 Requirement 10: DNS path
    7.1.11 Requirement 11: One folder per year
    7.1.12 Requirement 12: index.txt
    7.1.13 Requirement 13: changes.csv
    7.1.14 Requirement 14: Directory listings
    7.1.15 Requirement 15: ROLIE feed
    7.1.16 Requirement 16: ROLIE service document
    7.1.17 Requirement 17: ROLIE category document
    7.1.18 Requirement 18: Integrity
    7.1.19 Requirement 19: Signatures
    7.1.20 Requirement 20: Public OpenPGP Key
    7.1.21 Requirement 21: List of CSAF providers
    7.1.22 Requirement 22: Two disjoint issuing parties
    7.1.23 Requirement 23: Mirror
    7.1.24 Requirement 24: HTTP User-Agent
    7.1.25 Requirement 25: Access-Control-Allow-Origin
    7.2 Roles
    7.2.1 Role: CSAF publisher
    7.2.2 Role: CSAF provider
    7.2.3 Role: CSAF trusted provider
    7.2.4 Role: CSAF lister
    7.2.5 Role: CSAF aggregator
    7.3 Retrieving rules
    7.3.1 Finding provider-metadata.json
    7.3.2 Retrieving CSAF documents
    7.4 Transition between CSAF 2.0 and CSAF 2.1
    7.4.1 Announcing the Transition
    7.4.2 Transition Process for a CSAF Provider
    7.4.3 Archive of CSAF Document from Previous Version
    7.4.4 Transition Process for a CSAF Aggregator
  8. Safety, Security, and Data Protection Considerations
  9. Conformance
    9.1 Conformance Targets
    9.1.1 Conformance Clause 1: CSAF document
    9.1.2 Conformance Clause 2: CSAF producer
    9.1.3 Conformance Clause 3: CSAF direct producer
    9.1.4 Conformance Clause 4: CSAF converter
    9.1.5 Conformance Clause 5: CVRF CSAF converter
    9.1.6 Conformance Clause 6: CSAF content management system
    9.1.7 Conformance Clause 7: CSAF post-processor
    9.1.8 Conformance Clause 8: CSAF modifier
    9.1.9 Conformance Clause 9: CSAF translator
    9.1.10 Conformance Clause 10: CSAF consumer
    9.1.11 Conformance Clause 11: CSAF viewer
    9.1.12 Conformance Clause 12: CSAF management system
    9.1.13 Conformance Clause 13: CSAF asset matching system
    9.1.14 Conformance Clause 14: CSAF basic validator
    9.1.15 Conformance Clause 15: CSAF extended validator
    9.1.16 Conformance Clause 16: CSAF full validator
    9.1.17 Conformance Clause 17: CSAF SBOM matching system
    9.1.18 Conformance Clause 18: CSAF 2.0 to CSAF 2.1 converter
    9.1.19 Conformance Clause 19: CSAF library
    9.1.20 Conformance Clause 20: CSAF library with basic validation
    9.1.21 Conformance Clause 21: CSAF library with extended validation
    9.1.22 Conformance Clause 22: CSAF library with full validation
    9.1.23 Conformance Clause 23: CSAF downloader
    9.1.24 Conformance Clause 24: CSAF withdrawer
    9.1.25 Conformance Clause 25: CSAF superseder

Appendix A. Acknowledgments Appendix B. Revision History Appendix C. Guidance on the Size of CSAF Documents Appendix C. File Size Appendix C. Array Length Appendix C. String Length C.6 Date C.5 Enum C.5 URI Length C.5 UUID Length

 1. Introduction

 1.1 IPR Policy

This specification is provided under the Non-Assertion Mode of
the OASIS IPR Policy, the mode chosen when the Technical Committee was established.
For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s web page (https://www.oasis-open.org/committees/csaf/ipr.php).

 1.2 Terminology

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 [RFC2119] and [RFC8174] when, and only when, they appear in all capitals, as shown here.

For purposes of this document, the following terms and definitions apply:

advisory
reporting item that describes a condition present in an artifact and that requires action by the consumers
advisory document
artifact in which an analysis tool reports a result
advisory management system
software system that consumes the documents produced by analysis tools,
produces advisories that enable engineering and operating organizations to assess the quality of these
software artifacts at a point in time, and performs functions such as filing security advisories and
displaying information about individual advisories.
Note: An advisory management system can interact with a document viewer to display information about individual advisories.
advisory matching
process of determining whether two advisories are targeting the same products and conditions
artifact
sequence of bytes addressable via a URI.
Examples: A physical file in a file system such as a source file, an object file, a configuration file or a data file;
a specific version of a file in a version control system; a database table accessed via an HTTP request;
an arbitrary stream of bytes returned from an HTTP request, a product URL, a common product enumeration value.
CSAF 2.0 to CSAF 2.1 converter
A CSAF producer which takes a CSAF 2.0 document as input and converts it into a valid CSAF 2.1 document.
CSAF asset matching system
program that connects to or is an asset database and is able to manage CSAF documents as
required by CSAF management system
as well as matching them to assets of the asset database.
CSAF basic validator
A program that reads a document and checks it against the JSON schema and performs mandatory tests.
CSAF consumer
program that reads and interprets a CSAF document
CSAF content management system
program that is able to create, review and manage CSAF documents and is able to preview their details as
required by CSAF viewer.
CSAF converter
CSAF producer that transforms the output of an analysis tool from its native output format into the CSAF format
CSAF direct producer
analysis tool which acts as a CSAF producer
CSAF document
security advisory text document in the format defined by this document.
CSAF downloader
A program that retrieves CSAF documents in an automated fashion.
CSAF extended validator
A CSAF basic validator that additionally performs recommended tests.
CSAF full validator
A CSAF extended validator that additionally performs informative tests.
CSAF library
A library that implements CSAF data capabilities.
CSAF library with basic validation
A CSAF library that also satisfies the conformance target “CSAF basic validator”.
CSAF library with extended validation
A CSAF library that also satisfies the conformance target “CSAF extended validator”.
CSAF library with full validation
A CSAF library that also satisfies the conformance target “CSAF full validator”.
CSAF management system
program that is able to manage CSAF documents and is able to display their details as required by CSAF viewer.
CSAF modifier
CSAF post-processor which takes a CSAF document as input and modifies the structure or values of properties.
The output is a valid CSAF document.
CSAF post-processor
CSAF producer that transforms an existing CSAF document into a new CSAF document,
for example, by removing or redacting elements according to sharing policies.
CSAF SBOM matching system
A program that connects to or is an SBOM database and is able to manage CSAF documents as
required by CSAF management system as well as matching them to SBOM components of the SBOM database.
CSAF producer
program that emits output in the CSAF format
CSAF superseder
A CSAF post-processor that transforms a given CSAF into a superseded one.
CSAF translator
CSAF post-processor which takes a CSAF document as input and translates values of properties into another language.
The output is a valid CSAF document.
CSAF viewer
CSAF consumer that reads a CSAF document, displays a list of the results it contains,
and allows an end user to view each result in the context of the artifact in which it occurs.
CSAF withdrawer
A CSAF post-processor that transforms a given CSAF into a withdrawn one.
CVRF CSAF converter
CSAF producer which takes a CVRF document as input and converts it into a valid CSAF document.
document
output file produced by an analysis tool, which enumerates the results produced by the tool
driver
tool component containing an analysis tool’s or converter’s primary executable,
which controls the tool’s or converter’s execution,
and which in the case of an analysis tool typically defines a set of analysis rules
syntactic construct which enables a message string to refer to a location mentioned in the document
empty array
array that contains no elements, and so has a length of 0
empty object
object that contains no properties
empty string
string that contains no characters, and so has a length of 0
(end) user
person who uses the information in a document to investigate, triage, or resolve results
engineering system
software analysis environment within which analysis tools execute.
Note: An engineering system might include a build system, a source control system, a result management system,
a bug tracking system, a test execution system, and so on.
extension
tool component other than the driver (for example, a plugin, a configuration file, or a taxonomy)
external property file
file containing the values of one or more externalized properties
externalizable property
property that can be contained in an external property file
externalized property
property stored outside of the CSAF document to which it logically belongs
false positive
result which an end user decides does not actually represent a problem
filter
refine a list by selecting entries that match given criteria
fingerprint
stable value that can be used by a result management system to uniquely identify a result over time,
even if a relevant artifact is modified
formatted message
message string which contains formatting information such as Markdown formatting characters
fully qualified logical name
string that fully identifies the programmatic construct specified by a logical location,
typically by means of a hierarchical identifier.
hierarchical string
string in the format <component>{/<component>}*
line
contiguous sequence of characters, starting either at the beginning of an artifact or immediately after
a newline sequence, and ending at and including the nearest subsequent newline sequence, if one is present,
or else extending to the end of the artifact
line (number)
1-based index of a line within a file.
Note: Abbreviated to “line” when there is no danger of ambiguity with “line” in the sense of a sequence of characters.
localizable
subject to being translated from one natural language to another
message string
human-readable string that conveys information relevant to an element in a CSAF document
nested artifact
artifact that is contained within another artifact
newline sequence
sequence of one or more characters representing the end of a line of text.
Note: Some systems represent a newline sequence with a single newline character; others represent it as
a carriage return character followed by a newline character.
notification
reporting item that describes a condition encountered by a tool during its execution
opaque
neither human-readable nor machine-parsable into constituent parts
parent (artifact)
artifact which contains one or more nested artifacts
plain text message
message string which does not contain any formatting information
plugin
tool component that defines additional rules
policy
set of rule configurations that specify how results that
violate the rules defined by a particular tool component are to be treated
problem
result which indicates a condition that has the potential to detract from the quality of the program.
Examples: A security vulnerability, a deviation from contractual or legal requirements.
product
is any deliverable (e.g. software, hardware, specification, or service) which can be referred to with a name.
This applies regardless of the origin, the license model, or the mode of distribution of the deliverable.
property
attribute of an object consisting of a name and a value associated with the name
redactable property
property that potentially contains sensitive information that a CSAF direct producer or
a CSAF post-processor might wish to redact
reporting item
unit of output produced by a tool, either a result or a notification
reporting configuration
the subset of reporting metadata that a tool can configure at runtime, before performing its scan.
Examples: severity level, rank
repository
container for a related set of files in a version control system
search
compile a list of entries that match given criteria
taxonomy
classification of analysis results into a set of categories
tag
string that conveys additional information about the CSAF document element to which it applies
text artifact
artifact considered as a sequence of characters organized into lines and columns
text region
region representing a contiguous range of zero or more characters in a text artifact
tool component
component of an analysis tool or converter, either its driver or an extension, consisting of one or more files
top-level artifact
artifact which is not contained within any other artifact
translation
rendering of a tool component’s localizable strings into another language
triage
decide whether a result indicates a problem that needs to be corrected
user
see end user.
VCS
version control system
vendor
the community, individual, or organization that created or maintains a product
(including open source software and hardware providers)
VEX
Vulnerability Exploitability eXchange - enables a supplier or other party to assert whether or not
a particular product is affected by a specific vulnerability, especially helpful in efficiently consuming SBOM data.
viewer
see CSAF viewer.
vulnerability
functional behavior of a product or service that violates an implicit or explicit security policy
(conforming to ISO/IEC 29147 [ISO29147])
white space
code point used to improve text readability or token separation as defined in section 12.2 of cite
XML
eXtensible Markup Language - the format used by the predecessors of this standard, namely CVRF 1.1 and CVRF 1.2.

 1.3 Normative References

[ECMA-262] ECMAScript® 2024 Language Specification, ECMA-262, 15th edition, June 2024, https://262.ecma-international.org/15.0/

[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.

[JSON-Schema-Validation] JSON Schema Validation: A Vocabulary for Structural Validation of JSON, draft-bhutton-json-schema-validation-00, December 2020, https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00.

[JSON-Hyper-Schema] JSON Hyper-Schema: A Vocabulary for Hypermedia Annotation of JSON, draft-handrews-json-schema-hyperschema-02, September 2019, https://json-schema.org/draft/2019-09/json-schema-hypermedia.html.

[Relative-JSON-Pointers] Relative JSON Pointers, draft-bhutton-relative-json-pointer-00, December 2020, https://datatracker.ietf.org/doc/html/draft-bhutton-relative-json-pointer-00.

[RFC2119] Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels”, BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, https://www.rfc-editor.org/info/rfc2119.

[RFC3339] Klyne, G. and C. Newman, “Date and Time on the Internet: Timestamps”, RFC 3339, DOI 10.17487/RFC3339, July 2002, https://www.rfc-editor.org/info/rfc3339.

[RFC4180] Shafranovich, Y., “Common Format and MIME Type for Comma-Separated Values (CSV) Files”, RFC 4180, DOI 10.17487/RFC4180, October 2005, https://www.rfc-editor.org/info/rfc4180.

[RFC7230] Roy T. Fielding and Julian Reschke, “Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing”, RFC 7230, DOI 10.17487/RFC7230, June 2014, https://www.rfc-editor.org/info/rfc7230.

[RFC7464] Williams, N., “JavaScript Object Notation (JSON) Text Sequences”, RFC 7464, DOI 10.17487/RFC7464, February 2015, https://www.rfc-editor.org/info/rfc7464.

[RFC8174] Leiba, B., “Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words”, BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, https://www.rfc-editor.org/info/rfc8174.

[RFC8259] T. Bray, Ed., “The JavaScript Object Notation (JSON) Data Interchange Format”, RFC 8259, DOI 10.17487/RFC8259, December 2017, https://www.rfc-editor.org/info/rfc8259.

[RFC9562] Davis, K., Peabody, B., and P. Leach, “Universally Unique IDentifiers (UUIDs)”, RFC 9562, DOI 10.17487/RFC9562, May 2024, https://www.rfc-editor.org/info/rfc9562.

[SPDX301] The System Package Data Exchange® (SPDX®) Specification Version 3.0.1, Linux Foundation and its Contributors, 2024, https://spdx.github.io/spdx-spec/.

 1.4 Informative References

[CPE23-A] Common Platform Enumeration: Applicability Language Specification Version 2.3 (NISTIR 7698), D. Waltermire, P. Cichonski, K. Scarfone, Editors, NIST Interagency Report 7698, August 2011, https://dx.doi.org/10.6028/NIST.IR.7698.

[CPE23-D] Common Platform Enumeration: Dictionary Specification Version 2.3, P. Cichonski, D. Waltermire, K. Scarfone, Editors, NIST Interagency Report 7697, August 2011, https://dx.doi.org/10.6028/NIST.IR.7697.

[CPE23-M] Common Platform Enumeration: Naming Matching Specification Version 2.3, M. Parmelee, H. Booth, D. Waltermire, K. Scarfone, Editors, NIST Interagency Report 7696, August 2011, https://dx.doi.org/10.6028/NIST.IR.7696.

[CPE23-N] Common Platform Enumeration: Naming Specification Version 2.3, B. Cheikes, D. Waltermire, K. Scarfone, Editors, NIST Interagency Report 7695, August 2011, https://dx.doi.org/10.6028/NIST.IR.7695.

[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, Revised Feb. 2016, https://cve.mitre.org/docs/cve-intro-handout.pdf.

[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.

[CVRF-1-1] The Common Vulnerability Reporting Framework (CVRF) Version 1.1, M. Schiffman, Editor, May 2012, Internet Consortium for Advancement of Security on the Internet (ICASI), https://www.icasi.org/the-common-vulnerability-reporting-framework-cvrf-v1-1/.

[CVRF-v1.2] CSAF Common Vulnerability Reporting Framework (CVRF) Version 1.2. Edited by Stefan Hagen. 13 September 2017. OASIS Committee Specification 01. https://docs.oasis-open.org/csaf/csaf-cvrf/v1.2/cs01/csaf-cvrf-v1.2-cs01.html. Latest version: https://docs.oasis-open.org/csaf/csaf-cvrf/v1.2/csaf-cvrf-v1.2.html.

[CVSS2] A Complete Guide to the Common Vulnerability Scoring System Version 2.0, P. Mell, K. Scarfone, S. Romanosky, Editors, First.org, Inc., June 2007, https://www.first.org/cvss/v2/cvss-v2-guide.pdf.

[CVSS30] Common Vulnerability Scoring System v3.0: Specification Document, FIRST.Org, Inc., June 2019, https://www.first.org/cvss/v3.0/cvss-v30-specification_v1.9.pdf.

[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., 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, 2006, http://cwe.mitre.org/about/.

[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.

[EPSS] Exploit Prediction Scoring System (EPSS), FIRST.Org, Inc., https://www.first.org/epss/

[FETCH] Fetch: Living Standard, https://fetch.spec.whatwg.org.

[GFMCMARK] GitHub’s fork of cmark, a CommonMark parsing and rendering library and program in C, https://github.com/github/cmark.

[GFMENG] GitHub Engineering: A formal spec for GitHub Flavored Markdown, https://githubengineering.com/a-formal-spec-for-github-markdown/.

[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 23, 2018, https://www.iso.org/standard/72311.html.

[OPENSSL] GTLS/SSL and crypto library, OpenSSL Software Foundation, https://www.openssl.org/.

[PURL] Package URL (purl), GitHub Project, https://github.com/package-url/purl-spec.

[RFC3552] Rescorla, E. and B. Korver, “Guidelines for Writing RFC Text on Security Considerations”, BCP 72, RFC 3552, DOI 10.17487/RFC3552, July 2003, https://www.rfc-editor.org/info/rfc3552.

[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax”, STD 66, RFC 3986, DOI 10.17487/RFC3986, January 2005, https://www.rfc-editor.org/info/rfc3986.

[RFC4122] Leach, P., Mealling, M., and R. Salz, “A Universally Unique IDentifier (UUID) URN Namespace”, RFC 4122, DOI 10.17487/RFC4122, July 2005, https://www.rfc-editor.org/info/rfc4122.

[RFC4880] Callas, J., Donnerhacke, L., Finney, H., Shaw, D., and R. Thayer, “OpenPGP Message Format”, RFC 4880, DOI 10.17487/RFC4880, November 2007, https://www.rfc-editor.org/info/rfc4880.

[RFC7231] Fielding, R., Ed., and J. Reschke, Ed., “Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content”, RFC 7231, DOI 10.17487/RFC7231, June 2014, https://www.rfc-editor.org/info/rfc7231.

[RFC8322] Field, J., Banghart, S., and D. Waltermire, “Resource-Oriented Lightweight Information Exchange (ROLIE)”, RFC 8322, DOI 10.17487/RFC8322, February 2018, https://www.rfc-editor.org/info/rfc8322.

[RFC8615] Nottingham, M., “Well-Known Uniform Resource Identifiers (URIs)”, RFC 8615, DOI 10.17487/RFC8615, May 2019, https://www.rfc-editor.org/info/rfc8615.

[RFC9116] Foudil, E. and Y. Shafranovich, “A File Format to Aid in Security Vulnerability Disclosure”, RFC 9116, DOI 10.17487/RFC9116, April 2022, https://www.rfc-editor.org/info/rfc9116.

[SCAP12] The Technical Specification for the Security Content Automation Protocol (SCAP): SCAP Version 1.2, D. Waltermire, S. Quinn, K. Scarfone, A. Halbardier, Editors, NIST Spec. Publ. 800‑126 rev. 2, September 2011, https://dx.doi.org/10.6028/NIST.SP.800-126r2.

[SECURITY-TXT] Foudil, E. and Shafranovich, Y., Security.txt Project, https://securitytxt.org/.

[SemVer] Semantic Versioning 2.0.0, T. Preston-Werner, June 2013, https://semver.org/.

[SSVC] SSVC: Stakeholder-Specific Vulnerability Categorization, CERT/CC, https://certcc.github.io/SSVC/reference/

[VERS] 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.

[VEX-Justification] Vulnerability Exploitability eXchange (VEX) - Status Justifications, VEX sub-group of the Framing Working Group in the CISA SBOM initiative, June 2022, https://www.cisa.gov/sites/default/files/publications/VEX_Status_Justification_Jun22.pdf.

[XML] Extensible Markup Language (XML) 1.0 (Fifth Edition), T. Bray, J. Paoli, M. Sperberg-McQueen, E. Maler, F. Yergeau, Editors, W3C Recommendation, November 26, 2008, https://www.w3.org/TR/2008/REC-xml-20081126/. Latest version available at https://www.w3.org/TR/xml.

[XML-Schema-1] W3C XML Schema Definition Language (XSD) 1.1 Part 1: Structures, S. Gao, M. Sperberg-McQueen, H. Thompson, N. Mendelsohn, D. Beech, M. Maloney, Editors, W3C Recommendation, April 5, 2012, https://www.w3.org/TR/2012/REC-xmlschema11-1-20120405/. Latest version available at https://www.w3.org/TR/xmlschema11-1/.

[XML-Schema-2] W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes, D. Peterson, S. Gao, A. Malhotra, M. Sperberg-McQueen, H. Thompson, Paul V. Biron, Editors, W3C Recommendation, April 5, 2012, https://www.w3.org/TR/2012/REC-xmlschema11-2-20120405/. Latest version available at https://www.w3.org/TR/xmlschema11-2/.

 1.5 Typographical Conventions

Keywords defined by this specification use this monospaced font.

    Normative source code uses this paragraph style.

Some sections of this specification are illustrated with non-normative examples introduced with “Example” or “Examples” like so:

Example 1:

    Informative examples also use this paragraph style but preceded by the text "Example(s)".

All examples in this document are informative only.

All other text is normative unless otherwise labeled e.g. like the following informative comment:

This is a pure informative comment that may be present, because the information conveyed is deemed useful advice or common pitfalls learned from implementer or operator experience and often given including the rationale.

 2. Design Considerations

The Common Security Advisory Framework (CSAF) is a language to exchange Security Advisories formulated in JSON.

The term Security Advisory as used in this document describes any notification of security issues in products of and by providers. Anyone providing a product is considered in this document as a vendor, i.e. developers or maintainers of information system products or services. This includes all authoritative product vendors, Product Security Incident Response Teams (PSIRTs), and product resellers and distributors, including authoritative vendor partners. A security issue is not necessarily constrained to a problem statement, the focus of the term is on the security aspect impacting (or not impacting) specific product-platform-version combinations. Information on presence or absence of workarounds is also considered part of the security issue. This document is the definitive reference for the language elements of CSAF version 2.1. The encompassing JSON schema file noted in the Additional Artifacts section of the title page SHALL be taken as normative in the case a gap or an inconsistency in this explanatory document becomes evident. The following presentation in this section is grouped by topical area, and is not simply derivative documentation from the schema document itself. The information contained aims to be more descriptive and complete. Where applicable, common conventions are stated and known common issues in usage are pointed out informatively to support implementers of document producers and consumers alike.

This minimal required information set does not provide any useful information on products, vulnerabilities, or security advisories. Thus, any real-world Security Advisory will carry additional information as specified in section 3 Schema elements.

Care has been taken, to design the containers for product and vulnerability information to support fine-grained mapping of security advisories onto product and vulnerability and minimize data duplication through referencing. The display of the elements representing Product Tree and Vulnerability information has been placed in the sections named accordingly.

 2.1 Construction Principles

A Security Advisory defined as a CSAF document is the result of complex orchestration of many players and distinct and partially difficult to play schemas.

The format chosen is [JSONSchema] which allows validation and delegation to sub schema providers. The latter aligns well with separation of concerns and shares the format family of information interchange utilized by the providers of product and vulnerability information which migrated from XML to JSON since the creation of CSAF CVRF version 1.2, the pre-predecessor of this specification.

The acronym CSAF, “Common Security Advisory Framework”, stands for the target of concerted mitigation and remediation accomplishment.

Technically, the use of JSON schema allows validation and proof of model conformance (through established schema based validation) of the declared information inside CSAF documents.

The CSAF schema structures its derived documents into three main classes of the information conveyed:

  1. The frame, aggregation, and reference information of the document
  2. Product information considered relevant by the creator
  3. Vulnerability information and its relation to the products declared in 2.

Wherever possible repetition of data has been replaced by linkage through ID elements. Consistency on the content level thus is in the responsibility of the producer of such documents, to link e.g. vulnerability information to the matching product.

A dictionary like presentation of all defined schema elements is given in the section 3. Any expected relations to other elements (linkage) is described there. This linking relies on setting attribute values accordingly (mostly guided by industry best practice and conventions) and thus implies, that any deep validation on a semantic level (e.g. does the CWE match the described vulnerability) is to be ensured by the producer and consumer of CSAF documents. It is out of scope for this specification.

Proven and intended usage patterns from practice are given where possible.

Delegation to industry best practices technologies is used in referencing schemas for:

Even though not all - especially the referenced - JSON schemas prohibit specifically additional properties and custom keywords, it is strongly recommended not to use them. Suggestions for new fields SHOULD be made through issues in the TC’s GitHub. The JSON schemas defined in this standard do not allow the use of additional properties and custom keywords.

The standardized fields allow for scalability across different issuing parties and dramatically reduce the human effort and need for dedicated parsers as well as other tools on the side of the consuming parties.

Section 4 defined profiles that are used to ensure a common understanding of which fields are required in a given use case. Additional conventions are stated in section 5. The tests given in section 6 support CSAF producers and consumers to verify rules from the specification which can not be tested by the schema. Section 7 states how to distribute and where to find CSAF documents. Safety, Security and Data Protection are considered in section 8. Finally, a set of conformance targets describes tools in the ecosystem.

 2.2 Format Validation

The JSON schema 2020-12 dialect per default uses the format keyword just as annotation. To be able to ensure that the format constraints are validated as intended, the following metaschema is defined.

  {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://docs.oasis-open.org/csaf/csaf/v2.1/schema/meta.json",
    "$dynamicAnchor": "meta",
    "$vocabulary": {
      "https://json-schema.org/draft/2020-12/vocab/core": true,
      "https://json-schema.org/draft/2020-12/vocab/format-assertion": true
    },
    "allOf": [
      { "$ref": "https://json-schema.org/draft/2020-12/meta/core" },
      { "$ref": "https://json-schema.org/draft/2020-12/meta/format-assertion" }
    ]
  }

It is then consequently used in all JSON schemas defined in this standard and replaces the reference to the JSON schema 2020-12.

  {
    "$schema": "https://docs.oasis-open.org/csaf/csaf/v2.1/schema/meta.json",
    // ...
  }

The format validation is enforced by setting the corresponding vocabulary as required.

If a library used to parse, modify or create CSAF content is unable to deal with this meta schema, it could reach the objective by interpreting the schema as JSON schema 2020-12 dialect and enforcing the format validation via its implementation.

 2.3 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 [RFC3339] and [ISO8601-1], the following rules apply:

 3. Schema Elements

The CSAF schema describes how to represent security advisory information as a JSON document.

The CSAF schema Version 2.1 builds on the JSON Schema draft 2020-12 rules extended by the format validation enforcement (see 2.2).

    "$schema": "https://docs.oasis-open.org/csaf/csaf/v2.1/schema/meta.json"

The schema identifier is:

    "$id": "https://docs.oasis-open.org/csaf/csaf/v2.1/schema/csaf.json"

The further documentation of the schema is organized via Definitions and Properties.

Types and properties together provide the vocabulary for the domain specific language supporting security advisories.

The two mandatory properties are $schema and document. The optional two additional properties are product_tree and vulnerabilities.

 3.1 Definitions

The definitions ($defs) introduce the following domain specific types into the CSAF language: Acknowledgments (acknowledgments_t), Branches (branches_t), Full Product Name (full_product_name_t), Language (lang_t), Notes (notes_t), Product Group ID (product_group_id_t), Product Groups (product_groups_t), Product ID (product_id_t), Products (products_t), References (references_t), and Version (version_t).

    "$defs": {
        "acknowledgments_t": {
            // ...
        },
        "branches_t": {
            // ...
        },
        "full_product_name_t": {
            // ...
        },
        "lang_t": {
            // ...
        },
        "notes_t": {
            // ...
        },
        "product_group_id_t": {
            // ...
        },
        "product_groups_t": {
             // ...
        },
        "product_id_t": {
            // ...
        },
        "products_t": {
            // ...
        },
        "references_t": {
            // ...
        },
        "version_t": {
            // ...
        }
    },

 3.1.1 Acknowledgments Type

List of Acknowledgments (acknowledgments_t) type instances of value type array with 1 or more elements contain a list of Acknowledgment elements.

    "acknowledgments_t": {
      // ...
      "items": {
        // ...
      }
    },

The value type of Acknowledgment is object with at least 1 and at most 4 properties. Every such element acknowledges contributions by describing those that contributed. The properties are: names, organization, summary, and urls.

        "properties": {
          "names": {
            // ...
          },
          "organization": {
            // ...
          },
          "summary": {
            // ...
          },
          "urls": {
            // ...
          }
        }

 3.1.1.1 Acknowledgments Type - Names

List of acknowledged names (names) has value type array with 1 or more items holds the names of contributors being recognized. Every such item of value type string with 1 or more characters represents the name of the contributor and contains the name of a single contributor being recognized.

Examples 1:

    Albert Einstein
    Johann Sebastian Bach

 3.1.1.2 Acknowledgments Type - Organization

The contributing organization (organization) has value type string with 1 or more characters and holds the name of the contributing organization being recognized.

Examples 1:

    CISA
    Google Project Zero
    Talos

 3.1.1.3 Acknowledgments Type - Summary

Summary of the acknowledgment (summary) of value type string with 1 or more characters SHOULD represent any contextual details the document producers wish to make known about the acknowledgment or acknowledged parties.

Example 1:

    First analysis of Coordinated Multi-Stream Attack (CMSA)

 3.1.1.4 Acknowledgments Type - URLs

List of URLs (urls) of acknowledgment is a container (value type array) for 1 or more string of type URL that specifies a list of URLs or location of the reference to be acknowledged. Any URL of acknowledgment contains the URL or location of the reference to be acknowledged. Value type is string with format URI (uri).

 3.1.1.5 Acknowledgments Type - Example

Example 1:

  "acknowledgments": [
    {
      "names": [
        "Johann Sebastian Bach",
        "Georg Philipp Telemann",
        "Georg Friedrich Händel"
      ],
      "organization": "Baroque composers",
      "summary": "wonderful music"
    },
    {
      "organization": "CISA",
      "summary": "coordination efforts",
      "urls": [
        "https://cisa.gov"
      ]
    },
    {
      "organization": "BSI",
      "summary": "assistance in coordination"
    },
    {
      "names": [
        "Antonio Vivaldi"
      ],
      "summary": "influencing other composers"
    }
  ],

The example [1] above SHOULD lead to the following outcome in a human-readable advisory:

We thank the following parties for their efforts:

 3.1.2 Branches Type

List of branches (branches_t) with value type array contains 1 or more branch elements as children of the current element.

    "branches_t": {
      //...
      "items": {
        // ...
      }
    },

Every Branch holds exactly 3 properties and is a part of the hierarchical structure of the product tree. The properties name and category are mandatory. In addition, the object contains either a branches or a product property.

        "properties": {
          "branches": {
            // ...
          },
          "category": {
            // ...
          },
          "name": {
            // ...
          },
          "product": {
            // ...
          }
        }

branches_t supports building a hierarchical structure of products that allows to indicate the relationship of products to each other and enables grouping for simpler referencing. As an example, the structure MAY use the following levels: vendor -> product_family -> product_name -> product_version. It is recommended to use the hierarchical structure of vendor -> product_name -> product_version whenever possible to support the identification and matching of products on the consumer side.

 3.1.2.1 Branches Type - Branches

List of branches (branches) has the value type branches_t.

 3.1.2.2 Branches Type - Category

Category of the branch (category) of value type string and enum describes the characteristics of the labeled branch. Valid enum values are:

    architecture
    host_name
    language
    legacy
    patch_level
    platform
    product_family
    product_name
    product_version
    product_version_range
    service_pack
    specification
    vendor

The value architecture indicates the architecture for which the product is intended.

The value host_name indicates the host name of a system/service.

The value language indicates the language of the product.

The value legacy indicates an entry that has reached its end of life.

The value patch_level indicates the patch level of the product.

The value platform indicates the (CPU) platform for which the product is intended.

The value product_family indicates the product family that the product falls into.

The value product_name indicates the name of the product.

The value product_version indicates exactly a single version of the product. The value of the adjacent name property can be numeric or some other descriptor. However, it MUST NOT contain version ranges of any kind.

It is recommended to enumerate versions wherever possible. Nevertheless, the TC understands that this is sometimes impossible. To reflect that in the specification and aid in automatic processing of CSAF documents the value product_version_range was introduced. See next section for details.

The value product_version_range indicates a range of versions for the product. The value of the adjacent name property SHOULD NOT be used to convey a single version.

The value service_pack indicates the service pack of the product.

The value specification indicates the specification such as a standard, best common practice, etc.

The value vendor indicates the name of the vendor or manufacturer that makes the product.

 3.1.2.3 Branches Type - Name

Name of the branch (name) of value type string with 1 or more characters contains the canonical descriptor or ‘friendly name’ of the branch.

Examples 1:

    10
    365
    Microsoft
    Office
    PCS 7
    SIMATIC
    Siemens
    Windows

A leading v or V in the value of name SHOULD only exist for the categories product_version or product_version_range if it is part of the product version as given by the vendor.

 3.1.2.3.1 Branches Type - Name under Product Version

If adjacent property category has the value product_version, the value of name MUST NOT contain version ranges of any kind.

Examples 1 (for name when using product_version):

    10
    17.4
    v3

The product_version is the easiest way for users to determine whether their version is meant (provided that the given ancestors in the product tree matched): If both version strings are the same, it is a match - otherwise not. Therefore, it is always recommended to enumerate product versions instead of providing version ranges.

Examples 2 (for name when using product_version which are invalid):

    8.0.0 - 8.0.1
    8.1.5 and later
    <= 2
    prior to 4.2
    All versions < V3.0.29
    V3.0, V4.0, V4.1, V4.2

All the examples above contain some kind of a version range and are therefore invalid under the category product_version.

 3.1.2.3.2 Branches Type - Name under Product Version Range

If adjacent property category has the value product_version_range, the value of name MUST contain version ranges. The value of MUST obey to exactly one of the following options:

  1. Version Range Specifier (vers)

    vers is an ongoing community effort to address the problem of version ranges. Its draft specification is available at [VERS].

    vers MUST be used in its canonical form. To convey the term “all versions” the special string vers:all/* MUST be used.

    Examples 1 (for name when using product_version_range with vers):

        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

    Through the definitions of the vers specification a user can compute whether a given version is in a given range.

  2. Vers-like Specifier (vls)

    This option uses only the <version-constraint> part from the vers specification. It MUST NOT have an URI nor the <versioning-scheme> part. It is a fallback option and SHOULD NOT be used unless really necessary.

    The reason for that is, that it is nearly impossible for tools to reliable determine whether a given version is in the range or not.

    Tools MAY support this on best effort basis.

    Examples 2 (for name when using product_version_range with vls):

        <=2
    <4.2
    <V3.0.29
    >=8.1.5
    >10.9a|!=10.9c|!=10.9f|<=10.9k
    <2024-4-pabc0019|>2024-10-pefd0010|<2024-12-pjkl2010|>2024-12-pjkl5010|<=2025-1-pghi1001

 3.1.2.4 Branches Type - Product

Product (product) has the value type Full Product Name (full_product_name_t).

 3.1.3 Full Product Name Type

Full Product Name (full_product_name_t) with value type object specifies information about the product and assigns the product ID. The properties name and product_id are required. The property product_identification_helper is optional.

    "full_product_name_t": {
      // ...
      "properties": {
        "name": {
          // ...
        },
        "product_id": {
          // ...
        },
        "product_identification_helper": {
          // ...
        }
      }
    },

 3.1.3.1 Full Product Name Type - Name

Textual description of the product (name) has value type string with 1 or more characters. The value SHOULD be the product’s full canonical name, including version number and other attributes, as it would be used in a human-friendly document.

Examples 1:

    Cisco AnyConnect Secure Mobility Client 2.3.185
    Microsoft Host Integration Server 2006 Service Pack 1

 3.1.3.2 Full Product Name Type - Product ID

Product ID (product_id) holds a value of type Product ID (product_id_t).

 3.1.3.3 Full Product Name Type - Product Identification Helper

Helper to identify the product (product_identification_helper) of value type object provides in its properties at least one method which aids in identifying the product in an asset database. Of the given eight properties cpe, hashes, model_numbers, purls, sbom_urls, serial_numbers, skus, and x_generic_uris, one is mandatory.

    "product_identification_helper": {
      // ...
      "properties": {
        "cpe": {
          // ...
        },
        "hashes": {
          // ...
        },
        "model_numbers": {
          // ...
        },
        "purls": {
          // ...
        },
        "sbom_urls": {
          // ...
        },
        "serial_numbers": {
          // ...
        },
        "skus": {
          // ...
        },
        "x_generic_uris": {
          // ...
        }
      }
    }

A helper to identify the product SHALL identify the product described by the name in its entirety. A matching algorithm has to be able to rely on the product_identification_helper information during the matching without having to check e.g. the branches hierarchy leading to the product.

Therefore, it is, for example, prohibited to omit the version from the CPE if a product_version was given in branches hierarchy leading to the product.

 3.1.3.3.1 Full Product Name Type - Product Identification Helper - CPE

Common Platform Enumeration representation (cpe) of value type string of 5 or more characters with pattern (regular expression):

    ^((cpe:2\\.3:[aho\\*\\-](:(((\\?*|\\*?)([a-zA-Z0-9\\-\\._]|(\\\\[\\\\\\*\\?!\"#\\$%&'\\(\\)\\+,\\/:;<=>@\\[\\]\\^`\\{\\|\\}~]))+(\\?*|\\*?))|[\\*\\-])){5}(:(([a-zA-Z]{2,3}(-([a-zA-Z]{2}|[0-9]{3}))?)|[\\*\\-]))(:(((\\?*|\\*?)([a-zA-Z0-9\\-\\._]|(\\\\[\\\\\\*\\?!\"#\\$%&'\\(\\)\\+,\\/:;<=>@\\[\\]\\^`\\{\\|\\}~]))+(\\?*|\\*?))|[\\*\\-])){4})|([c][pP][eE]:\\/[AHOaho]?(:[A-Za-z0-9\\._\\-~%]*){0,6}))$

The Common Platform Enumeration (CPE) attribute refers to a method for naming platforms external to this specification. See [CPE23-N] for details.

Both, CPE 2.2 and CPE 2.3, are supported in CSAF.

 3.1.3.3.2 Full Product Name Type - Product Identification Helper - Hashes

List of hashes (hashes) of value type array holding at least one item contains a list of cryptographic hashes usable to identify files.

    "hashes": {
      // ...
      "items": {
        // ...
      }
    },

Cryptographic hashes of value type object contains all information to identify a file based on its cryptographic hash values. Any cryptographic hashes object has the 2 mandatory properties file_hashes and filename.

        "properties": {
          "file_hashes": {
            // ...
          },
          "filename": {
            // ...
          }
        }

List of file hashes (file_hashes) of value type array holding at least one item contains a list of cryptographic hashes for this file.

    "file_hashes": {
      // ...
      "items": {
        // ...
      }
    },

Each File hash of value type object contains one hash value and algorithm of the file to be identified. Any File hash object has the 2 mandatory properties algorithm and value.

        "properties": {
          "algorithm": {
            // ...
          },
          "value": {
            // ...
          }
        }

The algorithm of the cryptographic hash representation (algorithm) of value type string with one or more characters contains the name of the cryptographic hash algorithm used to calculate the value. The default value for algorithm is sha256.

Examples 1:

      blake2b512
      sha256
      sha3-512
      sha384
      sha512

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

The command openssl dgst -list (Version 3.4.0 from 2024-10-22) outputs the following:

 Supported digests:
 -blake2b512                -blake2s256                -md4
 -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):

    ^[0-9a-fA-F]{32,}$

The Value of the cryptographic hash attribute contains the cryptographic hash value in hexadecimal representation.

Examples 2:

    37df33cb7464da5c7f077f4d56a32bc84987ec1d85b234537c1c1a4d4fc8d09dc29e2e762cb5203677bf849a2855a0283710f1f5fe1d6ce8d5ac85c645d0fcb3
    4775203615d9534a8bfca96a93dc8b461a489f69124a130d786b42204f3341cc
    9ea4c8200113d49d26505da0e02e2f49055dc078d1ad7a419b32e291c7afebbb84badfbd46dec42883bea0b2a1fa697c

The filename representation (filename) of value type string with one or more characters contains the name of the file which is identified by the hash values.

Examples 3:

    WINWORD.EXE
    msotadddin.dll
    sudoers.so

If the value of the hash matches and the filename does not, a user SHOULD prefer the hash value. In such cases, the filename SHOULD be used as informational property.

 3.1.3.3.3 Full Product Name Type - Product Identification Helper - Model Numbers

The list of models (model_numbers) of value type array with 1 or more unique items contains a list of model numbers.

A list of models SHOULD only be used if a certain range of model numbers with its corresponding software version is affected, or the model numbers change during update.

This can also be used to identify hardware. If necessary, the software, or any other related part, SHALL be bind to that via a product relationship.

    "model_numbers": {
        //...
      "items": {
        //...
      }
    },

Any given model number of value type string with at least 1 character represents a model number of the component to identify - possibly with placeholders.

The terms “model”, “model number” and “model variant” are mostly used synonymously. Often it is abbreviated as “MN”, M/N” or “model no.”.

If a part of a model number of the component to identify is given, it MUST begin at the first and end at the last character position of the string representing the targeted component. The wildcard characters ? (for a single character) and * (for zero or more characters) signal exclusion of characters at these positions from matching. This applies also to the first character. An unescaped * MUST be the only * wildcard in the string. As part of the model number, the special characters ?, * and \ MUST be escaped with \.

Note: A backslash MUST be escaped itself in a JSON string.

Examples 1:

    *-G109A/EU?
    2024-*
    6RA8096-4MV62-0AA0
    6RA801?-??V62-0AA0
    IC25T060ATCS05-0
 3.1.3.3.4 Full Product Name Type - Product Identification Helper - purls

List of purls (purls) of value type array with 1 or more unique items contains a list of package URL (purl) identifiers.

    "purls": {
        //...
      "items": {
        //...
      }
    },

A package URL representation is a string of 7 or more characters with pattern (regular expression):

    ^pkg:[A-Za-z\\.\\-\\+][A-Za-z0-9\\.\\-\\+]*\\/.+

The given pattern does not completely evaluate whether a purl is valid according to the [PURL] specification. It provides a more generic approach and general guidance to enable forward compatibility. CSAF uses only the canonical form of purl to conform with section 3.3 of [RFC3986]. Therefore, URLs starting with pkg:// are considered invalid.

The package URL (purl) attribute refers to a method for reliably identifying and locating software packages external to this specification. See [PURL] for details. Multiple purls can be specified to allow for identifiers to locate identical components in different locations.

If multiple purls are specified, they SHALL only differ in their qualifiers. Otherwise, separate product branches SHOULD be used to differentiate between the components.

 3.1.3.3.5 Full Product Name Type - Product Identification Helper - SBOM URLs

The list of SBOM URLs (sbom_urls) of value type array with 1 or more items contains a list of URLs where SBOMs for this product can be retrieved.

The SBOMs might differ in format or depth of detail. Currently supported formats are SPDX, CycloneDX, and SWID.

    "sbom_urls": {
        //...
      "items": {
        //...
      }
    },

Any given SBOM URL of value type string with format uri contains a URL of one SBOM for this product.

Examples 1:

    https://raw.githubusercontent.com/CycloneDX/bom-examples/master/SBOM/keycloak-10.0.2/bom.json
    https://swinslow.net/spdx-examples/example4/main-bin-v2
 3.1.3.3.6 Full Product Name Type - Product Identification Helper - Serial Numbers

The list of serial numbers (serial_numbers) of value type array with 1 or more unique items contains a list of serial numbers.

A list of serial numbers SHOULD only be used if a certain range of serial numbers with its corresponding software version is affected, or the serial numbers change during update.

    "serial_numbers": {
        //...
      "items": {
        //...
      }
    },

Any given serial number of value type string with at least 1 character represents a serial number of the component to identify - possibly with placeholders.

If a part of a serial number of the component to identify is given, it MUST begin at the first and end at the last character position of the string representing the targeted component. The wildcard characters ? (for a single character) and * (for zero or more characters) signal exclusion of characters at these positions from matching. This applies also to the first character. An unescaped * MUST be the only * wildcard in the string. As part of the serial number, the special characters ?, * and \ MUST be escaped with \.

Note: A backslash MUST be escaped itself in a JSON string.

Examples 1:

    *RF8R71YR???
    11S45N0249Z1ZS9*
    DSEP147100
    L15-VM-???
    L234.696.30.044.712
 3.1.3.3.7 Full Product Name Type - Product Identification Helper - SKUs

The list of stock keeping units (skus) of value type array with 1 or more items contains a list of full or abbreviated (partial) stock keeping units.

A list of stock keeping units SHOULD only be used if the list of relationships is used to decouple e.g. hardware from the software, or the stock keeping units change during update. In the latter case the remediations SHALL include the new stock keeping units or a description how it can be obtained.

The use of the list of relationships in the first case is important. Otherwise, the end user is unable to identify which version (the affected or the not affected / fixed one) is used.

    "skus": {
        //...
      "items": {
        //...
      }
    },

Any given stock keeping unit of value type string with at least 1 character represents a full or abbreviated (partial) stock keeping unit (SKU) of the component to identify.

Sometimes this is also called “item number”, “article number” or “product number”.

If a part of a stock keeping unit of the component to identify is given, it SHOULD begin with the first character of the stock keeping unit and stop at any point. Characters which SHOULD NOT be matched MUST be replaced by either ? (for a single character) or * (for zero or more characters). Two * MUST NOT follow each other.

 3.1.3.3.8 Full Product Name Type - Product Identification Helper - Generic URIs

List of generic URIs (x_generic_uris) of value type array with at least 1 item contains a list of identifiers which are either vendor-specific or derived from a standard not yet supported.

    "x_generic_uris": {
      // ...
      "items": {
        // ...
      }
    }

Any such Generic URI item of value type object provides the two mandatory properties Namespace (namespace) and URI (uri).

        "properties": {
          "namespace": {
            // ...
          },
          "uri": {
            // ...
          }
        }

The namespace of the generic URI (namespace) of value type string with format uri refers to a URL which provides the name and knowledge about the specification used or is the namespace in which these values are valid.

The URI (uri) of value type string with format uri contains the identifier itself.

These elements can be used to reference a specific component from an SBOM:

Example 1 (linking a component from a CycloneDX SBOM using the bomlink mechanism):

          "x_generic_uris": [
            {
              "namespace": "https://cyclonedx.org/capabilities/bomlink/",
              "uri": "urn:cdx:411dafd2-c29f-491a-97d7-e97de5bc2289/1#pkg:maven/org.jboss.logging/jboss-logging@3.4.1.Final?type=jar"
            }
          ]

Example 2 (linking a component from an SPDX SBOM):

          "x_generic_uris": [
            {
              "namespace": "https://spdx.github.io/spdx-spec/latest/document-creation-information/#65-spdx-document-namespace-field",
              "uri": "https://swinslow.net/spdx-examples/example4/main-bin-v2#SPDXRef-libc"
            }
          ]

 3.1.4 Language Type

Language type (lang_t) has value type string with pattern (regular expression):

    ^(([A-Za-z]{2,3}(-[A-Za-z]{3}(-[A-Za-z]{3}){0,2})?|[A-Za-z]{4,8})(-[A-Za-z]{4})?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-[A-WY-Za-wy-z0-9](-[A-Za-z0-9]{2,8})+)*(-[Xx](-[A-Za-z0-9]{1,8})+)?|[Xx](-[A-Za-z0-9]{1,8})+|[Ii]-[Dd][Ee][Ff][Aa][Uu][Ll][Tt]|[Ii]-[Mm][Ii][Nn][Gg][Oo])$

The value identifies a language, corresponding to IETF BCP 47 / RFC 5646. See IETF language registry: https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry

CSAF skips those grandfathered language tags that are deprecated at the time of writing the specification. Even though the private use language tags are supported they should not be used to ensure readability across the ecosystem. It is recommended to follow the conventions for the capitalization of the subtags even though it is not mandatory as most users are used to that.

Examples 1:

    de
    en
    fr
    frc
    jp

 3.1.5 Notes Type

List of notes (notes_t) of value type array with 1 or more items of type Note contains notes which are specific to the current context.

    "notes_t": {
      // ...
      "items": {
        // ...
      }
    },

Value type of every such Note item is object with the mandatory properties category and text providing a place to put all manner of text blobs related to the current context. A Note object MAY provide the optional properties audience, group_ids, product_ids and title.

    "properties": {
      "audience": {
        // ...
      },
      "category": {
        // ...
      },
      "group_ids": {
        // ...
      },
      "product_ids": {
        // ...
      }
      "text": {
        // ...
      },
      "title": {
        // ...
      }
    }

Audience of note (audience) of value type string with 1 or more characters indicates who is intended to read it.

Examples 1:

    all
    executives
    operational management and system administrators
    safety engineers

Note category (category) of value type string and enum contains the information of what kind of note this is. Valid enum values are:

    description
    details
    faq
    general
    legal_disclaimer
    other
    summary

The value description indicates the note is a description of something. The optional sibling property title MAY have more information in this case.

The value details indicates the note is a low-level detailed discussion. The optional sibling property title MAY have more information in this case.

The value faq indicates the note is a list of frequently asked questions.

The value general indicates the note is a general, high-level note. The optional sibling property title MAY have more information in this case.

The value legal_disclaimer indicates the note represents any possible legal discussion, including constraints, surrounding the document.

The value other indicates the note is something that doesn’t fit the other categories. The optional sibling attribute title SHOULD have more information to indicate clearly what kind of note to expect in this case.

The value summary indicates the note is a summary of something. The optional sibling property title MAY have more information in this case.

Group IDs (group_ids) are of value type Product Groups (product_groups_t) and contain a list of Product Groups the current note item applies to.

Product IDs (product_ids) are of value type Products (products_t) and contain a list of Products the current note item applies to.

Note content (text) of value type string with 1 or more characters holds the content of the note. Content varies depending on type.

Title of note (title) of value type string with 1 or more characters provides a concise description of what is contained in the text of the note.

Examples 2:

    Details
    Executive summary
    Technical summary
    Impact on safety systems

 3.1.6 Product Group ID Type

The Product Group ID Type (product_group_id_t) of value type string with 1 or more characters is a reference token for product group instances. The value is a token required to identify a group of products so that it can be referred to from other parts in the document. There is no predefined or required format for the Product Group ID (product_group_id) as long as it uniquely identifies a product group in the context of the current document.

    "product_group_id_t": {
      // ...
    },

Examples 1:

    CSAFGID-0001
    CSAFGID-0002
    CSAFGID-0020

Even though the standard does not require a specific format it is recommended to use different prefixes for the Product ID and the Product Group ID to support reading and parsing the document.

 3.1.7 Product Groups Type

List of Product Group ID (product_groups_t) of value type array with 1 or more unique items (a set) of type Product Group ID (product_group_id_t) specifies a list of product_group_ids to give context to the parent item.

    "product_groups_t": {
      // ...
      "items": {
        // ...
      }
    },

 3.1.8 Product ID Type

The Product ID Type (product_id_t) of value type string with 1 or more characters is a reference token for product instances. The value is a token required to identify a full_product_name so that it can be referred to from other parts in the document. There is no predefined or required format for the Product ID (product_id) as long as it uniquely identifies a product in the context of the current document.

    "product_id_t": {
      // ...
    },

Examples 1:

    CSAFPID-0004
    CSAFPID-0008

Even though the standard does not require a specific format it is recommended to use different prefixes for the Product ID and the Product Group ID to support reading and parsing the document.

 3.1.9 Products Type

List of Product IDs (products_t) of value type array with 1 or more unique items (a set) of type Product ID (product_id_t) specifies a list of product_ids to give context to the parent item.

    "products_t": {
      // ...
      "items": {
        // ...
      }
    },

 3.1.10 References Type

List of references (references_t) of value type array with 1 or more items of type Reference holds a list of Reference objects.

    "references_t": {
      // ...
      "items": {
        // ...
      }
    },

Value type of every such Reference item is object with the mandatory properties url and summary holding any reference to conferences, papers, advisories, and other resources that are related and considered related to either a surrounding part of or the entire document and to be of value to the document consumer. A reference object MAY provide the optional property category.

    "properties": {
      "category": {
        // ...
      },
      "summary": {
        // ...
      },
      "url": {
        // ...
      }
    }

Category of reference (category) of value type string and enum indicates whether the reference points to the same document or vulnerability in focus (depending on scope) or to an external resource. Valid enum values are:

    external
    self

The default value for category is external.

The value external indicates, that this document is an external reference to a document or vulnerability in focus (depending on scope).

The value self indicates, that this document is a reference to this same document or vulnerability (also depending on scope).

This includes links to documents with the same content but different file format (e.g. advisories as PDF or HTML).

Summary of the reference (summary) of value type string with 1 or more characters indicates what this reference refers to.

URL of reference (url) of value type string with format uri provides the URL for the reference.

 3.1.11 Version Type

The Version (version_t) type has value type string with pattern (regular expression):

    ^(0|[1-9][0-9]*)$|^((0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)$

The version specifies a version string to denote clearly the evolution of the content of the document. There are two options how it can be used:

A CSAF document MUST use only one versioning system.

Examples 1:

    1
    4
    0.9.0
    1.4.3
    2.40.0+21AF26D3

 3.1.11.1 Version Type - Integer versioning

Integer versioning increments for each version where the /document/tracking/status is final the version number by one. The regular expression for this type is:

^(0|[1-9][0-9]*)$

The following rules apply:

  1. Once a versioned document has been released, the contents of that version MUST NOT be modified.
    Any modifications MUST be released as a new version.
  2. Version zero (0) is for initial development before the initial_release_date.
    The document status MUST be draft. Anything MAY change at any time. The document SHOULD NOT be considered stable.
  3. Version 1 defines the initial release to the specified target group.
    Each new version where /document/tracking/status is final has a version number incremented by one.
  4. Pre-release versions (document status draft) MUST carry the new version number.
    Sole exception is before the initial release (see rule 2).
    The combination of document status draft and version 1 MAY be used to indicate that the content is unlikely to change.
  5. Build metadata is never included in the version.
  6. Precedence MUST be determined by integer comparison.

 3.1.11.2 Version Type - Semantic versioning

Semantic versioning derived the rules from [SemVer]. The regular expression for this type is:

^((0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)$

The goal of this structure is to provide additional information to the end user whether a new comparison with the asset database is needed. The “public API” in regards to CSAF is the CSAF document with its structure and content. This results in the following rules:

  1. A normal version number MUST take the form X.Y.Z where X, Y, and Z are non-negative integers, and MUST NOT contain leading zeroes. X is the major version, Y is the minor version, and Z is the patch version. Each element MUST increase numerically. For instance: 1.9.0 -> 1.10.0 -> 1.11.0.

  2. Once a versioned document has been released, the contents of that version MUST NOT be modified. Any modifications MUST be released as a new version.

  3. Major version zero (0.y.z) is for initial development before the initial_release_date. The document status MUST be draft. Anything MAY change at any time. The document SHOULD NOT be considered stable. Changes which would increment the major version according to rule 7 are tracked in this stage with (0.y.z) by incrementing the minor version y instead. Changes that would increment the minor or patch version according to rule 6 or 5 are both tracked in this stage with (0.y.z) by incrementing the patch version z instead.

  4. Version 1.0.0 defines the initial release to the specified target group. The way in which the version number is incremented after this release is dependent on the content and structure of the document and how it changes.

  5. Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior.

    In the context of the document this is the case e.g. for spelling mistakes.

  6. Minor version Y (x.Y.z | x > 0) MUST be incremented if the content of an existing element changes except for those which are covert through rule 7. It MUST be incremented if substantial new information are introduced or new elements are provided. It MAY include patch level changes. Patch version MUST be reset to 0 when minor version is incremented.

  7. Major version X (X.y.z | X > 0) MUST be incremented if a new comparison with the end user’s asset database is required. This includes:

    It MAY also include minor and patch level changes. Patch and minor version MUST be reset to 0 when major version is incremented.

  8. A pre-release version (document status draft) MAY be denoted by appending a hyphen and a series of dot separated identifiers immediately following the patch version. Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-]. Identifiers MUST NOT be empty. Numeric identifiers MUST NOT include leading zeroes. Pre-release versions have a lower precedence than the associated normal version. A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version.

    Examples 1:

    1.0.0-0.3.7
1.0.0-alpha
1.0.0-alpha.1
1.0.0-x-y-z.--
1.0.0-x.7.z.92

  9. Pre-release MUST NOT be included if /document/tracking/status is final.

  10. Build metadata MAY be denoted by appending a plus sign and a series of dot separated identifiers immediately following the patch or pre-release version. Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-]. Identifiers MUST NOT be empty. Build metadata MUST be ignored when determining version precedence. Thus two versions that differ only in the build metadata, have the same precedence.

    Examples 2:

    1.0.0+20130313144700
1.0.0+21AF26D3----117B344092BD
1.0.0-alpha+001
1.0.0-beta+exp.sha.5114f85

  11. Precedence refers to how versions are compared to each other when ordered.

    1. Precedence MUST be calculated by separating the version into major, minor, patch and pre-release identifiers in that order (Build metadata does not figure into precedence).

    2. Precedence is determined by the first difference when comparing each of these identifiers from left to right as follows: Major, minor, and patch versions are always compared numerically.

      Example 3:

      1.0.0 < 2.0.0 < 2.1.0 < 2.1.1

    3. When major, minor, and patch are equal, a pre-release version has lower precedence than a normal version:

      Example 4:

      1.0.0-alpha < 1.0.0

    4. Precedence for two pre-release versions with the same major, minor, and patch version MUST be determined by comparing each dot separated identifier from left to right until a difference is found as follows:

      1. Identifiers consisting of only digits are compared numerically.
      2. Identifiers with letters or hyphens are compared lexically in ASCII sort order.
      3. Numeric identifiers always have lower precedence than non-numeric identifiers.
      4. A larger set of pre-release fields has a higher precedence than a smaller set, if all of the preceding identifiers are equal.

      Example 5:

      1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta < 1.0.0-beta < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0

Note, that the following values do no conform the semantic versioning described above.

Examples 6 (which are invalid):

  1.16.13.14-Cor
  1.0.0-x-y-z.–
  1.0.0+21AF26D3—-117B344092BD
  2.5.20+3f93da6b+7cc
  3.20.0-00

 3.2 Properties

These final four subsections document the four properties of a CSAF document. The two mandatory properties $schema and document, as well as the optional properties product_tree and vulnerabilities in that order.

 3.2.1 Schema Property

JSON schema ($schema) of value type string and enum with format uri contains the URL of the CSAF JSON schema which the document promises to be valid for. The single valid value for this enum is:

  https://docs.oasis-open.org/csaf/csaf/v2.1/schema/csaf.json

This value allows for tools to identify that a JSON document is meant to be valid against this schema. Tools can use that to support users by automatically checking whether the CSAF adheres to the JSON schema identified by this URL.

 3.2.2 Document Property

Document level meta-data (document) of value type object with the 6 mandatory properties Category (category), CSAF Version (csaf_version), Distribution (distribution), Publisher (publisher), Title (title), and Tracking (tracking) captures the meta-data about this document describing a particular set of security advisories. In addition, the document object MAY provide the 7 optional properties Acknowledgments (acknowledgments), Aggregate Severity (aggregate_severity), Language (lang), License expression (license_expression), Notes (notes), References (references), and Source Language (source_lang).

    "document": {
      // ...
      "properties": {
        "acknowledgments": {
          // ...
        },
        "aggregate_severity" : {
          // ...
        },
        "category": {
          // ...
        },
        "csaf_version": {
          // ...
        },
        "distribution": {
          // ...
        },
        "lang": {
          // ...
        },
        "license_expression": {
          // ...
        },
        "notes": {
          // ...
        },
        "publisher": {
          // ...
        },
        "references": {
          // ...
        },
        "source_lang": {
          // ...
        },
        "title": {
          // ...
        },
        "tracking": {
          // ...
        }
      }
    },

 3.2.2.1 Document Property - Acknowledgments

Document acknowledgments (acknowledgments) of value type Acknowledgments Type (acknowledgments_t) contains a list of acknowledgment elements associated with the whole document.

    "acknowledgments": {
      // ...
    },

 3.2.2.2 Document Property - Aggregate Severity

Aggregate severity (aggregate_severity) of value type object with the mandatory property text and the optional property namespace is a vehicle that is provided by the document producer to convey the urgency and criticality with which the one or more vulnerabilities reported should be addressed. It is a document-level metric and applied to the document as a whole — not any specific vulnerability. The range of values in this field is defined according to the document producer’s policies and procedures.

    "aggregate_severity": {
      // ...
      "properties": {
        "namespace": {
          // ...
        },
        "text": {
          // ...
        }
      }
    },

The Namespace of aggregate severity (namespace) of value type string with format uri points to the namespace so referenced.

The Text of aggregate severity (text) of value type string with 1 or more characters provides a severity which is independent of - and in addition to - any other standard metric for determining the impact or severity of a given vulnerability (such as CVSS).

Examples 1:

    Critical
    Important
    Moderate

 3.2.2.3 Document Property - Category

Document category (category) with value type string of 1 or more characters with pattern (regular expression):

    ^[^\\s\\-_\\.](.*[^\\s\\-_\\.])?$

Document category defines a short canonical name, chosen by the document producer, which will inform the end user as to the category of document.

It is directly related to the profiles defined in section 4.

    "category": {
      // ...
    }

Examples 1:

    csaf_base
    csaf_security_advisory
    csaf_vex
    Example Company Security Notice

 3.2.2.4 Document Property - CSAF Version

CSAF version (csaf_version) of value type string and enum gives the version of the CSAF specification which the document was generated for. The single valid value for this enum is:

    2.1

 3.2.2.5 Document Property - Distribution

Rules for sharing document (distribution) of value type object with the mandatory property Traffic Light Protocol (TLP) (tlp) and the optional properties Sharing Group (Sharing Group) and Text (text) describes any constraints on how this document might be shared.

    "distribution": {
      // ...
      "properties": {
        "sharing_group": {
          // ...
        },
        "text": {
          // ...
        },
        "tlp": {
          // ...
        }
      }
    },

If multiple values are present, the TLP information SHOULD be preferred as this aids in automation. The Sharing Group SHALL be interpreted as specification to the TLP information. Therefore, the Sharing Group MAY also be used to convey special TLP restrictions:

Examples 1:

    E-ISAC members-only
    Only releasable to European Energy sector
    Releasable to NATO countries

Note that for such restrictions the Sharing Group Name MUST exist and all participants MUST know the associated Sharing Group IDs to allow for automation.

 3.2.2.5.1 Document Property - Distribution - Sharing Group

Sharing Group (sharing_group) of value type object with the mandatory property Sharing Group ID (id) and the optional property Sharing Group Name (name) contains information about the group this document is intended to be shared with.

        "sharing_group": {
          // ...
          "properties": {
            "id": {
              // ...
            },
            "name": {
              // ...
            }
          }
        },

Sharing Group ID (id) of value type string with format uuid and pattern (regular expression):

    ^(([0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12})|([0]{8}-([0]{4}-){3}[0]{12})|([f]{8}-([f]{4}-){3}[f]{12}))$

Sharing Group ID provides the unique ID for the sharing group. This ID is intended to be globally unique and MAY also be used by different issuing parties to share CSAF data within a closed group, e.g. during a Multi-Party Coordinated Vulnerability Disclosure case.

Note, that participants in such cases usually differ. Therefore, it is advised to use one ID per case. Otherwise, the consequences of adding or removing parties from a case and the implications to other cases have to be considered.

The ID SHOULD NOT change throughout different CSAF documents, if the same sharing group is addressed. It MUST differ if a different sharing group is addressed.

It is assumed that the ID is globally unique, if constructed according to the specification for UUID Version 4.

The ID SHALL be valid according to [RFC9562] and recorded in the 8-4-4-4-12 notation in lower case. The ID SHALL be a UUID Version 4 for any closed sharing group, i.e. TLP:GREEN and above.

The following ID values SHOULD NOT be used unless there are technical reasons for them. Therefore, they are reserved for implementation-specific situations:

Note, that both values do not indicate a closed sharing group.

A CSAF document with TLP:CLEAR SHOULD NOT contain a sharing group value and SHALL NOT contain any other value for the Sharing Group ID than Max UUID (ffffffff-ffff-ffff-ffff-ffffffffffff).

If an issuing party distributes multiple versions of a single CSAF document to different sharing groups, the rules for CSAF modifier (cf. section sec) regarding the generation of the value of /document/tracking/id SHALL be applied. This implies that usually the sharing group ID is used as a prefix to the original /document/tracking/id.

Sharing Group Name (name) of value type string with one or more characters contains a human-readable name for the sharing group.

The Sharing Group Name is optional and can be chosen freely by the entity establishing the sharing group. However, the following values are reserved for the conditions below:

 3.2.2.5.2 Document Property - Distribution - Text

The Textual description (text) of value type string with 1 or more characters provides a textual description of additional constraints.

Examples 1:

    Copyright 2024, Example Company, All Rights Reserved.
    Distribute freely.
    Share only on a need-to-know-basis only.
 3.2.2.5.3 Document Property - Distribution - TLP

Traffic Light Protocol (TLP) (tlp) of value type object with the mandatory property Label (label) and the optional property URL (url) provides details about the TLP classification of the document.

    "tlp": {
      // ...
      "properties": {
        "label": {
          // ...
        },
        "url": {
          // ...
        }
      }
    }

The Label of TLP (label) with value type string and enum provides the TLP label of the document. Valid values of the enum are:

    AMBER
    AMBER+STRICT
    CLEAR
    GREEN
    RED

Note: In the TLP specification there are only 4 labels. The part +STRICT is an extension to TLP:AMBER. To simplify the JSON structure, avoid additional business level tests and aid in parsing, consumption and processing, it is provided as a label to be selected instead of having a separate field.

The default value for label is CLEAR.

Note: This provides the suggested default value for anyone writing CSAF documents as the majority of those are intended to be publicly available.

The URL of TLP version (url) with value type string with format uri provides a URL where to find the textual description of the TLP version which is used in this document. The default value is the URL to the definition by FIRST:

    https://www.first.org/tlp/

Examples 1:

    https://www.us-cert.gov/tlp
    https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/TLP/merkblatt-tlp.pdf

 3.2.2.6 Document Property - Language

Document language (lang) of value type Language Type (lang_t) identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.

 3.2.2.7 Document Property - License Expression

License expression (license_expression) of value type string with 1 or more characters contains the SPDX license expression for the CSAF document. It MUST NOT contain a license text. See annex B of [SPDX301] for details. The DocumentRef part given in that ABNF MUST NOT be used in CSAF. Any SPDX license identifier not from the official SPDX license identifier list MUST contain a prefix of the form LicenseRef-<license-inventoring-entity>- where <license-inventoring-entity> is replaced with a unique name for the entity that provided the database this license identifier was found in. The unique name MAY be a domain name. The same applies for AdditionRef- user defined identifiers.

In addition, the following rules apply:

Examples 1:

  CC-BY-4.0
  LicenseRef-www.example.org-Example-CSAF-License-3.0+
  LicenseRef-scancode-public-domain
  MIT OR any-OSI

 3.2.2.8 Document Property - Notes

Document notes (notes) of value type Notes Type (notes_t) holds notes associated with the whole document.

    "notes": {
      // ...
    },

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

category title content of text
description Product Description Contains a description of a product given in the product_tree in regards to field of application and core functionality. This SHOULD be bound to the corresponding product or product group.
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.
legal_disclaimer License Contains the only license text of the document license.
summary Summary Contains a short summary of the content of the advisory.

If a note is specific to a product or product group it MUST be bound via the group_ids respectively product_ids.

 3.2.2.9 Document Property - Publisher

Publisher (publisher) has value type object with the mandatory properties Category (category), Name (name) and Namespace (namespace) and provides information on the publishing entity. The 2 other optional properties are: contact_details and issuing_authority.

    "publisher": {
      // ...
      "properties": {
        "category": {
          // ...
        },
        "contact_details": {
          // ...
        },
        "issuing_authority": {
          // ...
        },
        "name": {
          // ...
        }
        "namespace": {
          // ...
        }
      }
    },
 3.2.2.9.1 Document Property - Publisher - Category

The Category of publisher (category) of value type string and enum provides information about the category of publisher releasing the document. The valid values are:

    coordinator
    discoverer
    multiplier
    other
    translator
    user
    vendor

The value coordinator indicates individuals or organizations that manage a single vendor’s response or multiple vendors’ responses to a vulnerability, a security flaw, or an incident. This includes all Computer Emergency/Incident Response Teams (CERTs/CIRTs) or agents acting on the behalf of a researcher.

The value discoverer indicates individuals or organizations that find vulnerabilities or security weaknesses. This includes all manner of researchers.

The value multiplier indicates individuals or organizations that use existing CSAF documents or information that could be represented in CSAF, and create their own CSAF documents for distribution to a specific target audience. A single multiplier might have target audiences.

For example, a National CSIRT might create different CSAF documents for the same vulnerability for critical infrastructure companies in different sectors, government agencies, non-critical industry, and the public based on information sharing agreements and threats to the target group.

The creation step can make use of a CSAF modifier that replaces metadata, e.g. the document publisher. Currently, this value includes multipliers, republishers, and forwarders.

The value translator indicates individuals or organizations that translate CSAF documents. This includes all manner of language translators, also those who work for the party issuing the original advisory.

The value other indicates a catchall for everyone else. Currently this includes editors, reviewers, and miscellaneous contributors.

The value user indicates anyone using a vendor’s product.

The value vendor indicates developers or maintainers of information system products or services. This includes all authoritative product vendors, product security incident response teams (PSIRTs), open source projects as well as product resellers and distributors, including authoritative vendor partners.

 3.2.2.9.2 Document Property - Publisher - Contact Details

Contact details (contact_details) of value type string with 1 or more characters provides information on how to contact the publisher, possibly including details such as web sites, email addresses, phone numbers, and postal mail addresses.

Example 1:

    Example Company can be reached at contact_us@example.com, or via our website at https://www.example.com/contact.
 3.2.2.9.3 Document Property - Publisher - Issuing Authority

Issuing authority (issuing_authority) of value type string with 1 or more characters Provides information about the authority of the issuing party to release the document, in particular, the party’s constituency and responsibilities or other obligations.

 3.2.2.9.4 Document Property - Publisher - Name

The Name of publisher (name) of value type string with 1 or more characters contains the name of the issuing party.

Example 1:

     BSI
     Cisco PSIRT
     Siemens ProductCERT
 3.2.2.9.5 Document Property - Publisher - Namespace

The Namespace of publisher (namespace) of value type string with format uri contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. The URL SHALL be normalized.

An issuing party can choose any URL which fulfills the requirements state above. The URL MAY be dereferenceable. If an issuing party has chosen a URL, it SHOULD NOT change. Tools can make use of the combination of /document/publisher/namespace and /document/tracking/id as it identifies a CSAF document globally unique.

If an issuing party decides to change its Namespace it SHOULD reissue all CSAF documents with an incremented (patch) version which has no other changes than:

Examples 1:

    https://csaf.io
    https://www.example.com

 3.2.2.10 Document Property - References

Document references (references) of value type References Type (references_t) holds a list of references associated with the whole document.

    "references": {
      // ...
    },

 3.2.2.11 Document Property - Source Language

Source language (source_lang) of value type Language Type (lang_t) identifies if this copy of the document is a translation then the value of this property describes from which language this document was translated.

The property MUST be present and set for any CSAF document with the value translator in /document/publisher/category. The property SHALL NOT be present if the document was not translated.

If an issuing party publishes a CSAF document with the same content in more than one language, one of these documents SHOULD be deemed the “original”, the other ones SHOULD be considered translations from the “original”. The issuing party can retain its original publisher information including the category. However, other rules defined in the conformance clause “CSAF translator” SHOULD be applied.

 3.2.2.12 Document Property - Title

Title of this document (title) of value type string with 1 or more characters SHOULD be a canonical name for the document, and sufficiently unique to distinguish it from similar documents.

Examples 1:

    Cisco IPv6 Crafted Packet Denial of Service Vulnerability
    Example Company Cross-Site-Scripting Vulnerability in Example Generator

 3.2.2.13 Document Property - Tracking

Tracking (tracking) of value type object with the six mandatory properties: Current Release Date (current_release_date), Identifier (id), Initial Release Date (initial_release_date), Revision History (revision_history), Status (status), and Version (version) is a container designated to hold all management attributes necessary to track a CSAF document as a whole. The two optional additional properties are Aliases (aliases) and Generator (generator).

    "tracking": {
      // ...
      "properties": {
        "aliases": {
          // ...
        },
        "current_release_date": {
          // ...
        },
        "generator": {
          // ...
        },
        "id": {
          // ...
        },
        "initial_release_date": {
          // ...
        },
        "revision_history": {
          // ...
        },
        "status": {
          // ...
        },
        "version": {
          // ...
        }
      }
    },
 3.2.2.13.1 Document Property - Tracking - Aliases

Aliases (aliases) of value type array with 1 or more unique items (a set) representing Alternate Names contains a list of alternate names for the same document.

    "aliases": {
      // ...
      "items": {
        // ...
      }
    },

Every such Alternate Name of value type string with 1 or more characters specifies a non-empty string that represents a distinct optional alternative ID used to refer to the document.

Example 1:

    CVE-2019-12345
 3.2.2.13.2 Document Property - Tracking - Current Release Date

Current release date (current_release_date) with value type string with format date-time holds the date when the current revision of this document was released.

 3.2.2.13.3 Document Property - Tracking - Generator

Document Generator (generator) of value type object with mandatory property Engine (engine) and optional property Date (date) is a container to hold all elements related to the generation of the document. These items will reference when the document was actually created, including the date it was generated and the entity that generated it.

        "generator": {
          // ...
          "properties": {
            "date": {
              // ...
            },
            "engine": {
              // ...
            }
          }
        },

Date of document generation (date) of value type string with format date-time SHOULD be the current date that the document was generated. Because documents are often generated internally by a document producer and exist for a nonzero amount of time before being released, this field MAY be different from the Initial Release Date and Current Release Date.

Engine of document generation (engine) of value type object with mandatory property Engine name (name) and optional property Engine version (version) contains information about the engine that generated the CSAF document.

        "engine": {
          // ...
          "properties": {
            "name": {
              // ...
            },
            "version": {
              // ...
            }
          }
        },

Engine name (name) of value type string with 1 or more characters represents the name of the engine that generated the CSAF document.

Examples 1:

    Red Hat rhsa-to-cvrf
    Secvisogram
    TVCE

Engine version (version) of value type string with 1 or more characters contains the version of the engine that generated the CSAF document.

Although it is not formally required, the TC suggests to use a versioning which is compatible with Semantic Versioning as described in the external specification [SemVer]. This could help the end user to identify when CSAF consumers have to be updated.

Examples 2:

    0.6.0
    1.0.0-beta+exp.sha.a1c44f85
    2
 3.2.2.13.4 Document Property - Tracking - ID

Unique identifier for the document (id) of value type string with 1 or more characters with pattern (regular expression):

    ^[\\S](.*[\\S])?$

Unique identifier for the document holds the Identifier. It SHALL NOT start or end with a white space and SHALL NOT contain a newline sequence.

The ID is a simple label that provides for a wide range of numbering values, types, and schemes. Its value SHOULD be assigned and maintained by the original document issuing authority. It MUST be unique for that organization.

Examples 1:

    Example Company - 2019-YH3234
    RHBA-2019:0024
    cisco-sa-20190513-secureboot

The combination of /document/publisher/namespace and /document/tracking/id identifies a CSAF document globally unique.

This value is also used to determine the filename for the CSAF document (cf. section 5.1).

 3.2.2.13.5 Document Property - Tracking - Initial Release Date

Initial release date (initial_release_date) with value type string with format date-time holds the date when this document was first released to the specified target group.

For TLP:CLEAR documents, this is usually the timestamp when the document was published. For TLP:GREEN and higher, this is the timestamp when it was first made available to the specific group. Note that the initial release date does not change after the initial release even if the document is later on released to a broader audience.

If the timestamp of the initial release date was set incorrectly, it MUST be corrected. This change MUST be tracked with a new entry in the revision history.

 3.2.2.13.6 Document Property - Tracking - Revision History

The Revision History (revision_history) with value type array of 1 or more Revision History Entries holds one revision item for each version of the CSAF document, including the initial one.

        "revision_history": {
          // ...
          "items": {
            // ...
          }
        },

Each Revision contains all the information elements required to track the evolution of a CSAF document. Revision History Entry items are of value type object with the three mandatory properties: Date (date), Number (number), and Summary (summary). In addition, a Revision MAY expose the optional property legacy_version.

        "properties": {
          "date": {
            // ...
          },
          "legacy_version": {
            // ...
          },
          "number": {
            // ...
          },
          "summary": {
            // ...
          }
        }

The Date of the revision (date) of value type string with format date-time states the date of the revision entry.

Legacy version of the revision (legacy_version) of value type string with 1 or more characters contains the version string used in an existing document with the same content.

This SHOULD be used to aid in the mapping between existing (human-readable) documents which might use a different version scheme and CSAF documents with the same content. It is recommended, to use the CSAF revision number to describe the revision history for any new human-readable equivalent.

The Number (number) has value type Version (version_t).

The Summary of the revision (summary) of value type string with 1 or more characters holds a single non-empty string representing a short description of the changes.

Each Revision item which has a number of 0 or 0.y.z MUST be removed from the document if the document status is final. Versions of the document which are pre-release SHALL NOT have its own revision item. All changes MUST be tracked in the item for the next release version. Build metadata SHOULD NOT be included in the number of any revision item.

 3.2.2.13.7 Document Property - Tracking - Status

Document status (status) of value type string and enum defines the draft status of the document. The value MUST be one of the following:

    draft
    final
    interim

The value draft indicates, that this is a pre-release, intended for issuing party’s internal use only, or possibly used externally when the party is seeking feedback or indicating its intentions regarding a specific issue.

The value final indicates, that the issuing party asserts the content is unlikely to change. “Final” status is an indication only, and does not preclude updates. This SHOULD be used if the issuing party expects no, slow or few changes.

The value interim indicates, that the issuing party expects rapid updates. This SHOULD be used if the expected rate of release for this document is significant higher than for other documents. Once the rate slows down it MUST be changed to final. This MAY be done in a patch version.

This is extremely useful for downstream vendors to constantly inform the end users about ongoing investigation. It can be used as an indication to pull the CSAF document more frequently.

 3.2.2.13.8 Document Property - Tracking - Version

Version has the value type Version (version_t).

 3.2.3 Product Tree Property

Product Tree (product_tree) has value type object with 1 or more properties is a container for all fully qualified product names that can be referenced elsewhere in the document. The properties are Branches (branches), Full Product Names (full_product_names), Product Groups (product_groups), and Relationships (relationships).

    "product_tree": {
      // ...
      "properties": {
        "branches": {
          // ...
        },
        "full_product_names": {
          // ...
        },
        "product_groups": {
          // ...
        },
        "relationships": {
          // ...
        }
      }
    },

 3.2.3.1 Product Tree Property - Branches

List of branches (branches) has the value type branches_t.

 3.2.3.2 Product Tree Property - Full Product Names

List of full product names (full_product_names) of value type array with 1 or more items of type full_product_name_t contains a list of full product names.

 3.2.3.3 Product Tree Property - Product Groups

List of product groups (product_groups) of value type array with 1 or more items of value type object contains a list of product groups.

    "product_groups": {
      // ...
      "items": {
        // ...
      }
    },

The product group items are of value type object with the 2 mandatory properties Group ID (group_id) and Product IDs (product_ids) and the optional Summary (summary) property.

    "properties": {
      "group_id": {
        // ...
      },
      "product_ids": {
        // ...
      },
      "summary": {
        // ...
      }
    }

The summary of the product group (summary) of value type string with 1 or more characters gives a short, optional description of the group.

Examples 1:

    Products supporting Modbus.
    The x64 versions of the operating system.

Group ID (group_id) has value type Product Group ID (product_group_id_t).

List of Product IDs (product_ids) of value type array with 2 or more unique items of value type Product ID (product_id_t) lists the product_ids of those products which known as one group in the document.

 3.2.3.4 Product Tree Property - Relationships

List of relationships (relationships) of value type array with 1 or more items contains a list of relationships.

    "relationships": {
      // ...
      "items": {
        // ...
      }
    }

The Relationship item is of value type object and has four mandatory properties: Relationship category (category), Full Product Name (full_product_name), Product Reference (product_reference), and Relates to Product Reference (relates_to_product_reference). The Relationship item establishes a link between two existing full_product_name_t elements, allowing the document producer to define a combination of two products that form a new full_product_name entry.

    "properties": {
      "category": {
        // ...
      },
      "full_product_name": {
        // ...
      },
      "product_reference": {
        // ...
      },
      "relates_to_product_reference": {
        // ...
      }
    }

The situation where a need for declaring a Relationship arises, is given when a product is e.g. vulnerable only when installed together with another, or to describe operating system components.

Relationship category (category) of value type string and enum defines the category of relationship for the referenced component. The valid values are:

    default_component_of
    external_component_of
    installed_on
    installed_with
    optional_component_of

The value default_component_of indicates that the entity labeled with one Product ID (e.g. CSAFPID-0001) is a default component of an entity with another Product ID (e.g. CSAFPID-0002). These Product IDs SHOULD NOT be identical to provide minimal redundancy.

The value external_component_of indicates that the entity labeled with one Product ID (e.g. CSAFPID-0001) is an external component of an entity with another Product ID (e.g. CSAFPID-0002). These Product IDs SHOULD NOT be identical to provide minimal redundancy.

The value installed_on indicates that the entity labeled with one Product ID (e.g. CSAFPID-0001) is installed on a platform entity with another Product ID (e.g. CSAFPID-0002). These Product IDs SHOULD NOT be identical to provide minimal redundancy.

The value installed_with indicates that the entity labeled with one Product ID (e.g. CSAFPID-0001) is installed alongside an entity with another Product ID (e.g. CSAFPID-0002). These Product IDs SHOULD NOT be identical to provide minimal redundancy.

The value optional_component_of indicates that the entity labeled with one Product ID (e.g. CSAFPID-0001) is an optional component of an entity with another Product ID (e.g. CSAFPID-0002). These Product IDs SHOULD NOT be identical to provide minimal redundancy.

Full Product Name (full_product_name) of value type Full Product Name Type (full_product_name_t).

Product Reference (product_reference) of value type Product ID (product_id_t) holds a Product ID that refers to the Full Product Name element, which is referenced as the first element of the relationship.

Relates to Product Reference (relates_to_product_reference) of value type Product ID (product_id_t) holds a Product ID that refers to the Full Product Name element, which is referenced as the second element of the relationship.

Examples 1:

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-908070601",
        "name": "Cisco AnyConnect Secure Mobility Client 4.9.04053"
      },
      {
        "product_id": "CSAFPID-908070602",
        "name": "Microsoft Windows"
      }
    ],
    "relationships": [
      {
        "product_reference": "CSAFPID-908070601",
        "category": "installed_on",
        "relates_to_product_reference": "CSAFPID-908070602",
        "full_product_name": {
          "product_id": "CSAFPID-908070603",
          "name": "Cisco AnyConnect Secure Mobility Client 4.9.04053 installed on Microsoft Windows"
        }
      }
    ]
  }

The product Cisco AnyConnect Secure Mobility Client 4.9.04053" (Product ID: CSAFPID-908070601) and the product Microsoft Windows (Product ID: CSAFPID-908070602) form together a new product with the separate Product ID CSAFPID-908070603. The latter one can be used to refer to that combination in other parts of the CSAF document. In the preceding example 1, it might be the case that Cisco AnyConnect Secure Mobility Client 4.9.04053" is only vulnerable when installed on Microsoft Windows.

 3.2.4 Vulnerabilities Property

Vulnerabilities (vulnerabilities) of value type array with 1 or more objects representing vulnerabilities and providing 1 or more properties represents a list of all relevant vulnerability information items.

    "vulnerabilities": {
      // ...
      "items": {
        // ...
      }
    }

The Vulnerability item of value type object with 1 or more properties is a container for the aggregation of all fields that are related to a single vulnerability in the document. Any vulnerability MAY provide the optional properties Acknowledgments (acknowledgments), Common Vulnerabilities and Exposures (CVE) (cve), Common Weakness Enumeration (CWE) (cwes), Disclosure Date (disclosure_date), Discovery Date (discovery_date), List of first known exploitation dates (first_known_exploitation_dates), Flags (flags), IDs (ids), Involvements (involvements), Metrics (metrics), Notes (notes), Product Status (product_status), References (references), Remediations (remediations), Threats (threats), and Title (title).

    "properties": {
      "acknowledgments": {
        // ...
      },
      "cve": {
        // ...
      },
      "cwes": {
        // ...
      },
      "disclosure_date": {
        // ...
      },
      "discovery_date": {
        // ...
      },
      "first_known_exploitation_dates": {
        // ...
      },
      "flags": {
        // ...
      },
      "ids": {
        // ...
      },
      "involvements": {
        // ...
      },
      "metrics": {
        // ...
      },
      "notes": {
        // ...
      },
      "product_status": {
        // ...
      },
      "references": {
        // ...
      },
      "remediations": {
        // ...
      },
      "threats": {
        // ...
      },
      "title": {
        // ...
      }
    }

 3.2.4.1 Vulnerabilities Property - Acknowledgments

Vulnerability acknowledgments (acknowledgments) of value type Acknowledgments Type (acknowledgments_t) contains a list of acknowledgment elements associated with this vulnerability item.

    "acknowledgments": {
      // ...
    },

 3.2.4.2 Vulnerabilities Property - CVE

CVE (cve) of value type string with pattern (regular expression):

    ^CVE-[0-9]{4}-[0-9]{4,}$

holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability.

 3.2.4.3 Vulnerabilities Property - CWEs

List of CWEs (cwes) of value type array with 1 or more unique items (a set) of value type object contains a list of CWEs.

    "cwes": {
      // ...
      "items": {
        // ...
      }
    },

It is expected that the list of CWEs is ordered from the most specific weakness ID to the least specific one.

Every CWE item of value type object with the 3 mandatory properties Weakness ID (id), Weakness Name (name), CWE version (version) holds the MITRE standard Common Weakness Enumeration (CWE) for the weakness associated. For more information cf. [CWE].

      "properties": {
        "id": {
          // ...
        },
        "name": {
          // ...
        },
        "version": {
          // ...
        }
      }

The Weakness ID (id) has value type string with pattern (regular expression):

    ^CWE-[1-9]\\d{0,5}$

It holds the ID for the weakness associated.

Examples 1:

    CWE-22
    CWE-352
    CWE-79

The Weakness name (name) has value type string of 1 or more characters with pattern (regular expression):

    ^[^\\s\\-_\\.](.*[^\\s\\-_\\.])?$

The Weakness name holds the full name of the weakness as given in the CWE specification.

Examples 2:

    Cross-Site Request Forgery (CSRF)
    Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal')
    Improper Neutralization of Input During Web Page Generation ('Cross-site Scripting')

The CWE version (version) has value type string with pattern (regular expression):

    ^[1-9]\\d*\\.([0-9]|([1-9]\\d+))(\\.\\d+)?$

It holds the version string of the CWE specification this weakness was extracted from. When creating or modifying a CSAF document, the latest published version of the CWE specification SHOULD be used.

Examples 3:

    "1.0",
    "3.4.1",
    "4.0",
    "4.11",
    "4.12"

 3.2.4.4 Vulnerabilities Property - Disclosure Date

Disclosure date (disclosure_date) of value type string with format date-time holds the date and time the vulnerability was originally disclosed to the public.

For vulnerabilities not yet disclosed to the public, a disclosure date in the future SHOULD indicate the intended date for disclosure of the vulnerability. This is also sometimes called embargo date. As disclosure dates may change during a vulnerability disclosure process, an issuing party SHOULD produce an updated CSAF document to confirm that the vulnerability was in fact disclosed to the public at that time or update the disclosure_date with the new intended date in the future.

 3.2.4.5 Vulnerabilities Property - Discovery Date

Discovery date (discovery_date) of value type string with format date-time holds the date and time the vulnerability was originally discovered.

 3.2.4.6 Vulnerabilities Property - First Known Exploitation Dates

List of first known exploitation dates (first_known_exploitation_dates) of value type array with 1 or more unique items (a set) of value type object contains a list of dates of first known exploitations.

    "first_known_exploitation_dates": {
      // ...
      "items": {
        // ...
      }
    },

Every First known exploitation date item of value type object with the 2 mandatory properties Date of the information (date) and Date of the exploitation (exploitation_date) holds at least 3 properties and contains information on when this vulnerability was first known to be exploited in the wild in the products specified. At least one of the optional elements Group IDs (group_ids) and Product IDs (product_ids) MUST be present to state for which products or product groups this date is applicable.

This information can be helpful to determine the risk of compromise. It can also be used to provide an indication for the time frame to be considered in a threat hunt for the exploitation this vulnerability.

    "properties": {
      "date": {
        // ...
      },
      "exploitation_date": {
        // ...
      },
      "group_ids": {
        // ...
      },
      "product_ids": {
        // ...
      }
    }

Date of the information (date) of value type string with format date-time contains the date when the information was last updated.

Date of the exploitation (exploitation_date) of value type string with format date-time contains the date when the exploitation happened.

Different document issuers might have different knowledge about exploitations in the wild that happened. Therefore, the exploitation_date can differ.

Group IDs (group_ids) are of value type Product Groups (product_groups_t) and contain a list of Product Groups the current first known exploitation date item applies to.

Product IDs (product_ids) are of value type Products (products_t) and contain a list of Products the current first known exploitation date item applies to.

 3.2.4.7 Vulnerabilities Property - Flags

List of flags (flags) of value type array with 1 or more unique items (a set) of value type object contains a list of machine readable flags.

    "flags": {
      // ...
      "items": {
        // ...
      }
    },

Every Flag item of value type object with the mandatory property Label (label) contains product specific information in regard to this vulnerability as a single machine readable flag. For example, this could be a machine readable justification code why a product is not affected. At least one of the optional elements Group IDs (group_ids) and Product IDs (product_ids) MUST be present to state for which products or product groups this flag is applicable.

These flags enable the receiving party to automate the selection of actions to take.

In addition, any Flag item MAY provide the three optional properties Date (date), Group IDs (group_ids) and Product IDs (product_ids).

    "properties": {
      "date": {
        // ...
      },
      "group_ids": {
        // ...
      },
      "label": {
        // ...
      },
      "product_ids": {
        // ...
      }
    }

Date of the flag (date) of value type string with format date-time contains the date when assessment was done or the flag was assigned.

Group IDs (group_ids) are of value type Product Groups (product_groups_t) and contain a list of Product Groups the current flag item applies to.

Label of the flag (label) of value type string and enum specifies the machine readable label. Valid enum values are:

    component_not_present
    inline_mitigations_already_exist
    vulnerable_code_cannot_be_controlled_by_adversary
    vulnerable_code_not_in_execute_path
    vulnerable_code_not_present

The given values reflect the VEX not affected justifications. See [VEX-Justification] for more details. The values MUST be used as follows:

Product IDs (product_ids) are of value type Products (products_t) and contain a list of Products the current flag item applies to.

 3.2.4.8 Vulnerabilities Property - IDs

List of IDs (ids) of value type array with one or more unique ID items of value type object represents a list of unique labels or tracking IDs for the vulnerability (if such information exists).

    "ids": {
      // ...
      "items": {
        // ...
      }
    },

Every ID item of value type object with the two mandatory properties System Name (system_name) and Text (text) contains a single unique label or tracking ID for the vulnerability.

      "properties": {
        "system_name": {
          // ...
        },
        "text": {
          // ...
        }
      }

System name (system_name) of value type string with 1 or more characters indicates the name of the vulnerability tracking or numbering system.

Examples 1:

    Cisco Bug ID
    GitHub Issue

Text (text) of value type string with 1 or more characters is unique label or tracking ID for the vulnerability (if such information exists).

Examples 2:

    CSCso66472
    oasis-tcs/csaf#210

General examples may include an identifier from a vulnerability tracking system that is available to customers, such as:

The ID MAY be a vendor-specific value but is not to be used to publish the CVE tracking numbers (MITRE standard Common Vulnerabilities and Exposures), as these are specified inside the dedicated CVE element.

 3.2.4.9 Vulnerabilities Property - Involvements

List of involvements (involvements) of value type array with 1 or more unique items (a set) of value type object contains a list of involvements.

    "involvements": {
      // ...
      "items": {
        // ...
      }
    },

Every Involvement item of value type object with the 2 mandatory properties Party (party), Status (status) and the 5 optional properties Party contact information (contact), Date of involvement (date), Group IDs (group_ids), Product IDs (product_ids), and Summary (summary) is a container that allows the document producers to comment on the level of involvement (or engagement) of themselves (or third parties) in the vulnerability identification, scoping, and remediation process. It can also be used to convey the disclosure timeline. The ordered tuple of the values of party and date (if present) SHALL be unique within involvements.

        "properties": {
          "contact": {
            // ...
          },
          "date": {
            // ...
          },
          "group_ids" {
            // ...
          },
          "party": {
            // ...
          },
          "product_ids": {
            // ...
          },
          "status": {
            // ...
          },
          "summary": {
            // ...
          }
        }

Party contact information (contact) contains the contact information of the party that was used in this state.

In many cases, that could be an email address.

Date of involvement (date) of value type string with format date-time holds the date and time of the involvement entry.

Group IDs (group_ids) are of value type Product Groups (product_groups_t) and contain a list of Product Groups the current involvement item applies to.

Party category (party) of value type string and enum defines the category of the involved party. Valid values are:

    coordinator
    discoverer
    other
    user
    vendor

These values follow the same definitions as given for the publisher category (cf. section 3.2.2.9.1).

Product IDs (product_ids) are of value type Products (products_t) and contain a list of Products the current involvement item applies to.

Party status (status) of value type string and enum defines contact status of the involved party. Valid values are:

    completed
    contact_attempted
    disputed
    in_progress
    not_contacted
    open

Each status is mutually exclusive - only one status is valid for a particular vulnerability at a particular time. As the vulnerability ages, a party’s involvement could move from state to state. However, in many cases, a document producer may choose not to issue CSAF documents at each state, or simply omit this element altogether. It is recommended, however, that vendors that issue CSAF documents indicating an open or in-progress involvement SHOULD eventually expect to issue a document containing one of the statuses disputed or completed as the latest one.

The two vulnerability involvement status states, contact_attempted and not_contacted are intended for use by document producers other than vendors (such as research or coordinating entities).

The value completed indicates that the party asserts that investigation of the vulnerability is complete. No additional information, fixes, or documentation from the party about the vulnerability should be expected to be released.

The value contact_attempted indicates that the document producer attempted to contact the party.

The value disputed indicates that the party disputes the vulnerability report in its entirety. This status SHOULD be used when the party believes that a vulnerability report regarding a product is completely inaccurate (that there is no real underlying security vulnerability) or that the technical issue being reported has no security implications.

The value in_progress indicates that some hotfixes, permanent fixes, mitigations, workarounds, or patches may have been made available by the party, but more information or fixes may be released in the future. The use of this status by a vendor indicates that future information from the vendor about the vulnerability is to be expected.

The value not_contacted indicates that the document producer has not attempted to make contact with the party.

The value open is the default status. It doesn’t indicate anything about the vulnerability remediation effort other than the fact that the party has acknowledged awareness of the vulnerability report. The use of this status by a vendor indicates that future updates from the vendor about the vulnerability are to be expected.

Summary of involvement (summary) of value type string with 1 or more characters contains additional context regarding what is going on.

 3.2.4.10 Vulnerabilities Property - Metrics

List of metrics (metrics) of value type array with 1 or more unique items (a set) of value type object Contains metric objects for the current vulnerability.

    "metrics": {
      // ...
      "items": {
        // ...
      }
    },

Every Metric item of value type object with the mandatory properties content and products and the optional property source contains all metadata about the metric including products it applies to and the source and the content itself.

        "properties": {
          "content": {
            // ...
          },
          "products": {
            // ...
          },
          "source": {
            // ...
          }
        }
 3.2.4.10.1 Vulnerabilities Property - Metrics - Content

Content (content) of value type object with the optional properties CVSS v2 (cvss_v2), CVSS v3 (cvss_v3), CVSS v4 (cvss_v4), EPSS (epss), and SSVC v1 (ssvc_v1) specifies information about (at least one) metric or score for the given products regarding the current vulnerability. A Content object has at least 1 property.

        "properties": {
          "cvss_v2": {
            // ...
          },
          "cvss_v3": {
            "oneOf": [
              // ...
            ]
          },
          "cvss_v4": {
            // ...
          },
          "epss": {
            // ...
          },
          "ssvc_v1": {
            // ....
          }
        }

The property CVSS v2 (cvss_v2) holding a CVSS v2.0 value abiding by the schema at https://www.first.org/cvss/cvss-v2.0.json.

The property CVSS v3 (cvss_v3) holding a CVSS v3.x value abiding by one of the schemas at https://www.first.org/cvss/cvss-v3.0.json or
https://www.first.org/cvss/cvss-v3.1.json.

The property CVSS v4 (cvss_v4) holding a CVSS v4.0 value abiding by the schema at https://www.first.org/cvss/cvss-v4.0.json.

The property SSVC v1 (ssvc_v1) holding an SSVC Decision Point Value Selection v1.0.1 value abiding by the schema at https://certcc.github.io/SSVC/data/schema/v1/Decision_Point_Value_Selection-1-0-1.schema.json.

The property EPSS (epss) of value type object with the 3 mandatory properties Percentile (percentile), Probability (probability) and EPSS timestamp (timestamp) contains the EPSS data.

            "properties": {
              "percentile": {
                // ...
              },
              "probability": {
                // ...
              },
              "timestamp": {
                // ...
              }
            }

Percentile (percentile) has value type string with pattern (regular expression):

    ^(([0]\\.([0-9])+)|([1]\\.[0]+))$

The value contains the rank ordering of probabilities from highest to lowest.

Probability (probability) with pattern (regular expression):

    ^(([0]\\.([0-9])+)|([1]\\.[0]+))$

The value contains the likelihood that any exploitation activity for this Vulnerability is being observed in the 30 days following the given timestamp.

EPSS timestamp (timestamp) of value type string with format date-time holds the date and time the EPSS value was recorded.

 3.2.4.10.2 Vulnerabilities Property - Metrics - Products

Product IDs (products) of value type products_t with 1 or more items indicates for which products the given content applies. A metric object SHOULD reflect the associated product’s status (for example, a fixed product no longer contains a vulnerability and should have a CVSS score of 0, or simply no score listed; the known affected versions of that product can list the vulnerability score as it applies to them).

 3.2.4.10.3 Vulnerabilities Property - Metrics - Source

Source (source) of value type string with format uri contains the URL of the source that originally determined the metric. If no source is given, then the metric was assigned by the document author.

For example, this could point to the vendor advisory, discoverer blog post, a multiplier’s assessment or other sources that provide metric information.

 3.2.4.11 Vulnerabilities Property - Notes

Vulnerability notes (notes) of value type Notes Type (notes_t) holds notes associated with this vulnerability item.

    "notes": {
      // ...
    },

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

category title content of text
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.

If a note is specific to a product or product group it MUST be bound via the group_ids respectively product_ids.

 3.2.4.12 Vulnerabilities Property - Product Status

Product status (product_status) of value type object with 1 or more properties contains different lists of product_ids which provide details on the status of the referenced product related to the current vulnerability. The nine defined properties are First affected (first_affected), First fixed (first_fixed), Fixed (fixed), Known affected (known_affected), Known not affected (known_not_affected), Last affected (last_affected), Recommended (recommended), Under investigation (under_investigation) and Unknown (unknown) are all of value type Products (products_t).

    "product_status": {
      // ...
      "properties": {
        "first_affected": {
          // ...
        },
        "first_fixed": {
          // ...
        },
        "fixed": {
          // ...
        },
        "known_affected": {
          // ...
        },
        "known_not_affected": {
          // ...
        },
        "last_affected": {
          // ...
        },
        "recommended": {
          // ...
        },
        "under_investigation": {
          // ...
        },
        "unknown": {
          // ...
        }
      }
    },

First affected (first_affected) of value type Products (products_t) represents that these are the first versions of the releases known to be affected by the vulnerability.

First fixed (first_fixed) of value type Products (products_t) represents that these versions contain the first fix for the vulnerability but may not be the recommended fixed versions.

Fixed (fixed) of value type Products (products_t) represents that these versions contain a fix for the vulnerability but may not be the recommended fixed versions.

Known affected (known_affected) of value type Products (products_t) represents that these versions are known to be affected by the vulnerability. Actions are recommended to remediate or address this vulnerability.

This could include for instance learning more about the vulnerability and context, and/or making a risk-based decision to patch or apply defense-in-depth measures. See /vulnerabilities[]/remediations, /vulnerabilities[]/notes and /vulnerabilities[]/threats for more details.

Known not affected (known_not_affected) of value type Products (products_t) represents that these versions are known not to be affected by the vulnerability. No remediation is required regarding this vulnerability.

This could for instance be because the code referenced in the vulnerability is not present, not exposed, compensating controls exist, or other factors. See /vulnerabilities[]/flags and /vulnerabilities[]/threats in category impact for more details.

Last affected (last_affected) of value type Products (products_t) represents that these are the last versions in a release train known to be affected by the vulnerability. Subsequently released versions would contain a fix for the vulnerability.

Recommended (recommended) of value type Products (products_t) represents that these versions have a fix for the vulnerability and are the vendor-recommended versions for fixing the vulnerability.

Under investigation (under_investigation) of value type Products (products_t) represents that it is not known yet whether these versions are or are not affected by the vulnerability. However, it is still under investigation - the result will be provided in a later release of the document.

Unknown (unknown) of value type Products (products_t) represents that it is not known whether these versions are or are not affected by the vulnerability. There is also no investigation and therefore the status might never be determined.

The individual properties form the following product status groups:

As the aforementioned product status groups contradict each other, the sets formed by the contradicting groups within one vulnerability item MUST be pairwise disjoint.

Note: An issuer might recommend (/vulnerabilities[]/product_status/recommended) a product version from any group - also from the affected group, i.e. if it was discovered that fixed versions introduce a more severe vulnerability.

 3.2.4.13 Vulnerabilities Property - References

Vulnerability references (references) of value type References Type (references_t) holds a list of references associated with this vulnerability item.

    "references": {
      // ...
    },

 3.2.4.14 Vulnerabilities Property - Remediations

List of remediations (remediations) of value type array with 1 or more Remediation items of value type object contains a list of remediations.

    "remediations": {
      // ...
      "items": {
        // ...
      }
    },

Every Remediation item of value type object with the 2 mandatory properties Category (category) and Details (details) specifies details on how to handle (and presumably, fix) a vulnerability. At least one of the optional elements Group IDs (group_ids) and Product IDs (product_ids) MUST be present to state for which products or product groups this remediation is applicable.

In addition, any Remediation MAY expose the six optional properties Date (date), Entitlements (entitlements), Group IDs (group_ids), Product IDs (product_ids), Restart required (restart_required), and URL (url).

      "properties": {
        "category": {
          // ...
        },
        "date": {
          // ...
        },
        "details": {
          // ...
        },
        "entitlements": {
          // ...
        },
        "group_ids": {
          // ...
        },
        "product_ids": {
          // ...
        },
        "restart_required": {
          // ...
        },
        "url": {
          // ...
        }
      }
 3.2.4.14.1 Vulnerabilities Property - Remediations - Category

Category of the remediation (category) of value type string and enum specifies the category which this remediation belongs to. Valid values are:

    fix_planned
    mitigation
    no_fix_planned
    none_available
    optional_patch
    vendor_fix
    workaround

The value workaround indicates that the remediation contains information about a configuration or specific deployment scenario that can be used to avoid exposure to the vulnerability. There MAY be none, one, or more workarounds available. This is typically the “first line of defense” against a new vulnerability before a mitigation or vendor fix has been issued or even discovered.

The value mitigation indicates that the remediation contains information about a configuration or deployment scenario that helps to reduce the risk of the vulnerability but that does not resolve the vulnerability on the affected product. Mitigations MAY include using devices or access controls external to the affected product. Mitigations MAY or MAY NOT be issued by the original author of the affected product, and they MAY or MAY NOT be officially sanctioned by the document producer.

The value vendor_fix indicates that the remediation contains information about an official fix that is issued by the original author of the affected product. Unless otherwise noted, it is assumed that this fix fully resolves the vulnerability.

The value optional_patch indicates that the remediation contains information about an patch that is issued by the original author of the affected product. Its application is not necessary, but might be desired by the user, e.g. to calm a security scanner by updating a dependency to a fixed version even though the dependency in the affected version was used in the product in a way that the product itself was not affected. Unless otherwise noted, it is assumed that this does not change the state regarding the vulnerability.

This is sometimes also referred to as a “regulatory compliance patch”.

The value none_available indicates that there is currently no fix or other remediation available. The text in field details SHOULD contain details about why there is no fix or other remediation.

The value fix_planned indicates that there is a fix for the vulnerability planned but not yet ready. An issuing party might choose to use this category to announce that a fix is currently developed. The text in field details SHOULD contain details including a date when a customer can expect the fix to be ready and distributed.

The value no_fix_planned indicates that there is no fix for the vulnerability and it is not planned to provide one at any time. This is often the case when a product has been orphaned, declared end-of-life, or otherwise deprecated. The text in field details SHOULD contain details about why there will be no fix issued.

Some category values contradict each other and thus are mutually exclusive per product. Therefore, such a combination MUST NOT be used in the list of remediations for the same product. This is independent from whether the product is referenced directly or indirectly through a product group. The following tables shows the allowed and prohibited combinations:

category value workaround mitigation vendor_fix optional_patch none_available fix_planned no_fix_planned
workaround allowed allowed allowed prohibited prohibited allowed allowed
mitigation allowed allowed allowed prohibited prohibited allowed allowed
vendor_fix allowed allowed allowed prohibited prohibited prohibited prohibited
optional_patch prohibited prohibited prohibited allowed prohibited prohibited prohibited
none_available prohibited prohibited prohibited prohibited allowed prohibited prohibited
fix_planned allowed allowed prohibited prohibited prohibited allowed prohibited
no_fix_planned allowed allowed prohibited prohibited prohibited prohibited allowed

Some category values contradict certain product status groups. Therefore, such a combination MUST NOT exist in a vulnerability item for the same product. This is independent from whether the product is referenced directly or indirectly through a product group. The following tables shows the allowed, discouraged and prohibited combinations:

category value Affected Not Affected Fixed Under Investigation Unknown Recommended
workaround allowed prohibited prohibited discouraged discouraged allowed
mitigation allowed prohibited prohibited discouraged discouraged allowed
vendor_fix allowed prohibited prohibited discouraged discouraged allowed
optional_patch prohibited allowed discouraged allowed allowed allowed
none_available allowed prohibited prohibited allowed allowed allowed
fix_planned allowed discouraged prohibited discouraged discouraged allowed
no_fix_planned allowed discouraged prohibited allowed allowed allowed
 3.2.4.14.2 Vulnerabilities Property - Remediations - Date

Date of the remediation (date) of value type string with format date-time contains the date from which the remediation is available.

 3.2.4.14.3 Vulnerabilities Property - Remediations - Details

Details of the remediation (details) of value type string with 1 or more characters contains a thorough human-readable discussion of the remediation.

 3.2.4.14.4 Vulnerabilities Property - Remediations - Entitlements

List of entitlements (entitlements) of value type array with 1 or more items of type Entitlement of the remediation as string with 1 or more characters contains a list of entitlements.

                "entitlements": {
                  // ....
                  "items": {
                    // ...
                  }
                },

Every Entitlement of the remediation contains any possible vendor-defined constraints for obtaining fixed software or hardware that fully resolves the vulnerability.

 3.2.4.14.5 Vulnerabilities Property - Remediations - Group IDs

Group IDs (group_ids) are of value type Product Groups (product_groups_t) and contain a list of Product Groups the current remediation item applies to.

 3.2.4.14.6 Vulnerabilities Property - Remediations - Product IDs

Product IDs (product_ids) are of value type Products (products_t) and contain a list of Products the current remediation item applies to.

 3.2.4.14.7 Vulnerabilities Property - Remediations - Restart Required

Restart required by remediation (restart_required) of value type object with the 1 mandatory property Category (category) and the optional property Details (details) provides information on category of restart is required by this remediation to become effective.

      "restart_required": {
        // ...
        "properties": {
          "category": {
            // ...
          }
          "details": {
            // ...
          }
        }
      },

Category of restart (category) of value type string and enum specifies what category of restart is required by this remediation to become effective. Valid values are:

    connected
    dependencies
    machine
    none
    parent
    service
    system
    vulnerable_component
    zone

The values MUST be used as follows:

Additional restart information (details) of value type string with 1 or more characters provides additional information for the restart. This can include details on procedures, scope or impact.

 3.2.4.14.8 Vulnerabilities Property - Remediations - URL

URL (url) of value type string with format uri contains the URL where to obtain the remediation.

 3.2.4.15 Vulnerabilities Property - Threats

List of threats (threats) of value type array with 1 or more items of value type object contains information about a vulnerability that can change with time.

    "threats": {
      // ...
      "items": {
        // ...
      }
    },

Every Threat item of value type object with the two mandatory properties Category (category) and Details (details) contains the vulnerability kinetic information. This information can change as the vulnerability ages and new information becomes available. In addition, any Threat item MAY expose the three optional properties Date (date), Group IDs (group_ids), and Product IDs (product_ids).

    "properties": {
      "category": {
        // ...
      }
      "date": {
        // ...
      },
      "details": {
        // ...
      },
      "group_ids": {
        // ...
      },
      "product_ids": {
        // ...
      }
    }

Category of the threat (category) of value type string and enum categorizes the threat according to the rules of the specification. Valid values are:

    exploit_status
    impact
    target_set

The value exploit_status indicates that the details field contains a description of the degree to which an exploit for the vulnerability is known. This knowledge can range from information privately held among a very small group to an issue that has been described to the public at a major conference or is being widely exploited globally. For consistency and simplicity, this section can be a mirror image of the CVSS exploitMaturity (v4.0), respectively exploitCodeMaturity (v3.1 and v3.0) or exploitability (v2.0) metric. However, it can also contain a more contextual status, such as “Weaponized” or “Functioning Code”.

The value impact indicates that the details field contains an assessment of the impact on the user or the target set if the vulnerability is successfully exploited or a description why it cannot be exploited. If applicable, for consistency and simplicity, this section can be a textual summary of the three CVSS impact metrics. These metrics measure how a vulnerability detracts from the three core security properties of an information system: Confidentiality, Integrity, and Availability.

The value target_set indicates that the details field contains a description of the currently known victim population in whatever terms are appropriate. Such terms MAY include: operating system platform, types of products, user segments, and geographic distribution.

Date of the threat (date) of value type string with format date-time contains the date when the assessment was done or the threat appeared.

Details of the threat (details) of value type string with 1 or more characters represents a thorough human-readable discussion of the threat.

Group IDs (group_ids) are of value type Product Groups (product_groups_t) and contain a list of Product Groups the current threat item applies to.

Product IDs (product_ids) are of value type Products (products_t) and contain a list of Products the current threat item applies to.

 3.2.4.16 Vulnerabilities Property - Title

Title (title) has value type string with 1 or more characters and gives the document producer the ability to apply a canonical name or title to the vulnerability.

 4. Profiles

CSAF documents do not have many required fields as they can be used for different purposes. To ensure a common understanding of which fields are required in a given use case the standard defines profiles. Each subsection describes such a profile by describing necessary content for that specific use case and providing insights into its purpose. The value of /document/category is used to identify a CSAF document’s profile. The following rules apply:

  1. Each CSAF document MUST conform the CSAF Base profile.
  2. Each profile extends the base profile “CSAF Base” - directly or indirect through another profile from the standard - by making additional
    fields from the standard mandatory.
    A profile can always add, but never subtract nor overwrite requirements defined in the profile it extends.
  3. Any optional field from the standard can also be added to a CSAF document which conforms with a profile without breaking conformance with
    the profile.
    One and only exempt is when the profile requires not to have a certain set of fields.
  4. Values of /document/category starting with csaf_ are reserved for existing, past, upcoming and future profiles defined in the CSAF standard.
  5. Values of /document/category starting with csaf_deprecated_ are used for official profiles that are marked deprecated.
    Those profiles are mostly there to allow backwards compatibility, e.g. with older CSAF versions.
    Therefore, they SHOULD NOT be used for newly created CSAF documents.
  6. Values of /document/category that do not match any of the values defined in section 4 of this standard SHALL be validated against
    the “CSAF Base” profile.
  7. Local or private profiles MAY exist and tools MAY choose to support them.
  8. If an official profile and a private profile exists, tools MUST validate against the official one from the standard.

 4.1 Profile 1: CSAF Base

This profile defines the default required fields for any CSAF document. Therefore, it is a “catch all” for CSAF documents that do not satisfy any other profile. Furthermore, it is the foundation all other profiles are build on.

A CSAF document SHALL fulfill the following requirements to satisfy the profile “CSAF Base”:

Neither CSAF Security Advisory nor csaf security advisory are valid values for /document/category.

An issuing party might choose to set /document/publisher/name in front of a value that is intended to only be used by another profile to state that the CSAF document does not use the profile associated with this value. In this case, the (case insensitive) string “CSAF” MUST be removed from the value. This SHOULD be done if the issuing party is unable or unwilling to use the value csaf_base, e.g. due to legal or cooperate identity reasons.

Both values Example Company Security Advisory and Example Company security_advisory in /document/category use the profile “CSAF Base”. This is important to prepare forward compatibility as later versions of CSAF might add new profiles. Therefore, the values which can be used for the profile “CSAF Base” might change.

 4.2 Profile 2: Security incident response

This profile SHOULD be used to provide a response to a security breach or incident. This MAY also be used to convey information about an incident that is unrelated to the issuing party’s own products or infrastructure.

Example Company might use a CSAF document satisfying this profile to respond to a security incident at ACME Inc. and the implications on its own products and infrastructure.

A CSAF document SHALL fulfill the following requirements to satisfy the profile “Security incident response”:

 4.3 Profile 3: Informational Advisory

This profile SHOULD be used to provide information which are not related to a vulnerability but e.g. a misconfiguration.

A CSAF document SHALL fulfill the following requirements to satisfy the profile “Informational Advisory”:

If the element /product_tree exists, a user MUST assume that all products mentioned are affected.

 4.4 Profile 4: Security Advisory

This profile SHOULD be used to provide information which is related to vulnerabilities and corresponding remediations.

A CSAF document SHALL fulfill the following requirements to satisfy the profile “Security Advisory”:

 4.5 Profile 5: VEX

This profile SHOULD be used to provide information of the “Vulnerability Exploitability eXchange”. The main purpose of the VEX format is to state that and why a certain product is, or is not, affected by a vulnerability. See [VEX] for details.

A CSAF document SHALL fulfill the following requirements to satisfy the profile “VEX”:

 4.6 Profile 6: Deprecated Security Advisory

This profile MAY be used to provide information which is related to vulnerabilities and corresponding remediations, e.g. when converting CSAF documents from older CSAF versions or a human-readable format. It SHOULD NOT be used for newly created documents. The profile “Security Advisory” from section [sec]{profiles-profile-4-security-advisory} SHOULD be used instead.

The definition of the profile “Deprecated Security Advisory” in CSAF 2.1 matches the definition of profile “Security Advisory” in CSAF 2.0.

A CSAF document SHALL fulfill the following requirements to satisfy the profile “Deprecated Security Advisory”:

 4.7 Profile 7: Withdrawn

This profile MUST be used for any CSAF document that is withdrawn. It MUST NOT be used for any superseded document.

A CSAF document SHALL fulfill the following requirements to satisfy the profile “Withdrawn”:

The CSAF document MAY link to additional information through /document/references.

 4.8 Profile 8: Superseded

This profile MUST be used for any CSAF document that is superseded. It MUST NOT be used for any withdrawn document.

A CSAF document SHALL fulfill the following requirements to satisfy the profile “Superseded”:

 5. Additional Conventions

This section provides additional rules for handling CSAF documents.

 5.1 Filename

The following rules MUST be applied to determine the filename for the CSAF document:

  1. The value /document/tracking/id is converted into lower case.
  2. Any character sequence which is not part of one of the following groups MUST be replaced by a single underscore (_):
  3. The file extension .json MUST be appended.

Examples 1:

  cisco-sa-20190513-secureboot.json
  example_company_-_2019-yh3234.json
  rhba-2019_0024.json

It is currently considered best practice to indicate that a CSAF document is invalid by inserting _invalid into the filename in front of the file extension.

Examples 2:

  cisco-sa-20190513-secureboot_invalid.json
  example_company_-_2019-yh3234_invalid.json
  rhba-2019_0024_invalid.json

 5.2 Separation in Data Stream

If multiple CSAF documents are transported via a data stream in a sequence without requests inbetween, they MUST be separated by the Record Separator in accordance with [RFC7464].

 5.3 Sorting

The keys within a CSAF document SHOULD be sorted alphabetically.

 5.4 Usage of Markdown

The use of GitHub-flavoured Markdown is permitted in the following fields:

  /document/acknowledgments[]/summary
  /document/distribution/text
  /document/notes[]/text
  /document/publisher/issuing_authority
  /document/references[]/summary
  /document/tracking/revision_history[]/summary
  /product_tree/product_groups[]/summary
  /vulnerabilities[]/acknowledgments[]/summary
  /vulnerabilities[]/involvements[]/summary
  /vulnerabilities[]/notes[]/text
  /vulnerabilities[]/references[]/summary
  /vulnerabilities[]/remediations[]/details
  /vulnerabilities[]/remediations[]/entitlements[]
  /vulnerabilities[]/remediations[]/restart_required/details
  /vulnerabilities[]/threats[]/details

Other fields MUST NOT contain Markdown.

 5.5 Branch recursion

The /product_tree uses a nested structure for branches. Along a single path to a leaf, the recursion of branches is limited to 30 repetitions. Therefore, the longest path to a leaf is:

/product_tree/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/product

 5.6 Hardware and Software within the Product Tree

If a product consists of hardware and software, the hardware part MUST be presented as one product in the product tree and the software part as another one. To form the overall product, both parts MUST be combined through a relationship.

Examples 1:

  "product_tree": {
    "branches": [
      {
        "branches": [
          {
            "branches": [
              {
                "category": "product_version",
                "name": "1.0",
                "product": {
                  "name": "Example Company Controller A 1.0",
                  "product_id": "CSAFPID-908070601",
                  "product_identification_helper": {
                    "serial_numbers": [
                      "143-D-354"
                    ]
                  }
                }
              }
            ],
            "category": "product_name",
            "name": "Controller A"
          },
          {
            "branches": [
              {
                "category": "product_version",
                "name": "4.1",
                "product": {
                  "name": "Example Company Controller A Firmware 4.1",
                  "product_id": "CSAFPID-908070602",
                  "product_identification_helper": {
                    "hashes": [
                      {
                        "file_hashes": [
                          {
                            "algorithm": "sha256",
                            "value": "3fb9d502d096b1dfbcdfe60eed80ddecd98c8771bf21a82bbe1752735c4dc9e2"
                          }
                        ],
                        "filename": "a_4-1.bin"
                      }
                    ]
                  }
                }
              },
              {
                "category": "product_version",
                "name": "4.2",
                "product": {
                  "name": "Example Company Controller A Firmware 4.2",
                  "product_id": "CSAFPID-908070603",
                  "product_identification_helper": {
                    "hashes": [
                      {
                        "file_hashes": [
                          {
                            "algorithm": "sha256",
                            "value": "0a853ce2337f0608489ac596a308dc5b7b19d35a52b10bf31261586ac368b175"
                          }
                        ],
                        "filename": "a_4-2.bin"
                      }
                    ]
                  }
                }
              }
            ],
            "category": "product_name",
            "name": "Controller A Firmware"
          }
        ],
        "category": "vendor",
        "name": "Example Company"
      }
    ],
    "relationships": [
      {
        "category": "installed_on",
        "full_product_name": {
          "name": "Example Company Controller A Firmware 4.1 installed on Example Company Controller A 1.0",
          "product_id": "CSAFPID-908070604"
        },
        "product_reference": "CSAFPID-908070602",
        "relates_to_product_reference": "CSAFPID-908070601"
      },
      {
        "category": "installed_on",
        "full_product_name": {
          "name": "Example Company Controller A Firmware 4.2 installed on Example Company Controller A 1.0",
          "product_id": "CSAFPID-908070605"
        },
        "product_reference": "CSAFPID-908070603",
        "relates_to_product_reference": "CSAFPID-908070601"
      }
    ]
  }

This requirement is important to allow for correct matching. The serial number 143-D-354 identifies the Example Company Controller A 1.0 which is in this example the hardware in its version 1.0. The hash 3fb9d502d096b1dfbcdfe60eed80ddecd98c8771bf21a82bbe1752735c4dc9e2 identifies the software in the version 4.1; the hash 0a853ce2337f0608489ac596a308dc5b7b19d35a52b10bf31261586ac368b175 identifies the software in the version 4.2. The relationships combine the software and hardware part and form new products. These are used e.g. to assign the product status in the vulnerability section.

A matching tool searches in a first step for the product identification helper, e.g the serial number in an asset database to identify the asset that has this specific hardware and matches the software separately in a second step.

Representing the software version as a child element under elements representing hardware unsettles the consumer whether the version applies to the software or hardware. Also, this would violate the rule regarding the full identification of a product by the product_identification_helper from section 3.1.3.3.

Based on the CVE statistics up to and including the year 2024, in the majority of cases the vulnerabilities reside in software or are remediated via software. Having multiple products with the same product_identification_helper in different product_status for the same vulnerability would make it undecidable for machines what the product_status actually is.

 6. Tests

The first three subsections list a number of tests which all will have a short description and an excerpt of an example which fails the test. The forth subsection groups tests into preset.

 6.1 Mandatory Tests

Mandatory tests MUST NOT fail at a valid CSAF document. A program MUST handle a test failure as an error.

 6.1.1 Missing Definition of Product ID

For each element of type /$defs/product_id_t which is not inside a Full Product Name (type: full_product_name_t) and therefore reference an element within the product_tree it MUST be tested that the Full Product Name element with the matching product_id exists. The same applies for all items of elements of type /$defs/products_t.

The relevant paths for this test are:

  /document/notes[]/product_ids[]
  /product_tree/product_groups[]/product_ids[]
  /product_tree/relationships[]/product_reference
  /product_tree/relationships[]/relates_to_product_reference
  /vulnerabilities[]/involvements[]/product_ids[]
  /vulnerabilities[]/flags[]/product_ids[]
  /vulnerabilities[]/metrics[]/products[]
  /vulnerabilities[]/notes[]/product_ids[]
  /vulnerabilities[]/product_status/first_affected[]
  /vulnerabilities[]/product_status/first_fixed[]
  /vulnerabilities[]/product_status/fixed[]
  /vulnerabilities[]/product_status/known_affected[]
  /vulnerabilities[]/product_status/known_not_affected[]
  /vulnerabilities[]/product_status/last_affected[]
  /vulnerabilities[]/product_status/recommended[]
  /vulnerabilities[]/product_status/under_investigation[]
  /vulnerabilities[]/remediations[]/product_ids[]
  /vulnerabilities[]/threats[]/product_ids[]

Example 1 (which fails the test):

  "product_tree": {
    "product_groups": [
      {
        "group_id": "CSAFGID-1020300",
        "product_ids": [
          "CSAFPID-9080700",
          "CSAFPID-9080701"
        ]
      }
    ]
  }

Neither CSAFPID-9080700 nor CSAFPID-9080701 were defined in the product_tree.

 6.1.2 Multiple Definition of Product ID

For each Product ID (type /$defs/product_id_t) in Full Product Name elements (type: /$defs/full_product_name_t) it MUST be tested that the product_id was not already defined within the same document.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_id
  /product_tree/full_product_names[]/product_id
  /product_tree/relationships[]/full_product_name/product_id

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      },
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product B"
      }
    ]
  }

CSAFPID-9080700 was defined twice.

 6.1.3 Circular Definition of Product ID

For each new defined Product ID (type /$defs/product_id_t) in items of relationships (/product_tree/relationships) it MUST be tested that the product_id does not end up in a circle.

The relevant path for this test is:

  /product_tree/relationships[]/full_product_name/product_id

As this can be quite complex a program for large CSAF documents, a program could check first whether a Product ID defined in a relationship item is used as product_reference or relates_to_product_reference. Only for those which fulfill this condition it is necessary to run the full check following the references.

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ],
    "relationships": [
      {
        "category": "installed_on",
        "full_product_name": {
          "name": "Product B",
          "product_id": "CSAFPID-9080701"
        },
        "product_reference": "CSAFPID-9080700",
        "relates_to_product_reference": "CSAFPID-9080701"
      }
    ]
  }

CSAFPID-9080701 refers to itself - this is a circular definition.

 6.1.4 Missing Definition of Product Group ID

For each element of type /$defs/product_group_id_t which is not inside a Product Group (/product_tree/product_groups[]) and therefore reference an element within the product_tree it MUST be tested that the Product Group element with the matching group_id exists. The same applies for all items of elements of type /$defs/product_groups_t.

The relevant paths for this test are:

  /document/notes[]/group_ids[]
  /vulnerabilities[]/flags[]/group_ids[]
  /vulnerabilities[]/involvements[]/group_ids[]
  /vulnerabilities[]/notes[]/group_ids[]
  /vulnerabilities[]/remediations[]/group_ids[]
  /vulnerabilities[]/threats[]/group_ids[]

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]
  },
  "vulnerabilities": [
    {
      "threats": [
        {
          "category": "exploit_status",
          "details": "Reliable exploits integrated in Metasploit.",
          "group_ids": [
            "CSAFGID-1020301"
          ]
        }
      ]
    }
  ]

CSAFGID-1020301 was not defined in the Product Tree.

 6.1.5 Multiple Definition of Product Group ID

For each Product Group ID (type /$defs/product_group_id_t) Product Group elements (/product_tree/product_groups[]) it MUST be tested that the group_id was not already defined within the same document.

The relevant path for this test is:

    /product_tree/product_groups[]/group_id

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      },
      {
        "product_id": "CSAFPID-9080701",
        "name": "Product B"
      },
      {
        "product_id": "CSAFPID-9080702",
        "name": "Product C"
      }
    ],
    "product_groups": [
      {
        "group_id": "CSAFGID-1020300",
        "product_ids": [
          "CSAFPID-9080700",
          "CSAFPID-9080701"
        ]
      },
      {
        "group_id": "CSAFGID-1020300",
        "product_ids": [
          "CSAFPID-9080700",
          "CSAFPID-9080702"
        ]
      }
    ]
  }

CSAFGID-1020300 was defined twice.

 6.1.6 Contradicting Product Status

For each item in /vulnerabilities it MUST be tested that the same Product ID is not member of contradicting product status groups. The sets formed by the contradicting groups within one vulnerability item MUST be pairwise disjoint.

The relevant path for this test is:

    /vulnerabilities[]/product_status

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]
  },
  "vulnerabilities": [
    {
      "product_status": {
        "known_affected": [
          "CSAFPID-9080700"
        ],
        "known_not_affected": [
          "CSAFPID-9080700"
        ]
      }
    }
  ]

CSAFPID-9080700 is a member of the two contradicting groups “Affected” and “Not affected”.

 6.1.7 Multiple Scores with same Version per Product

For each item in /vulnerabilities it MUST be tested that the same Product ID is not member of more than one CVSS-Vectors with the same version and same source.

Different source might assign different scores for the same product.

The relevant path for this test is:

    /vulnerabilities[]/metrics[]

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]
  },
  "vulnerabilities": [
    {
      "metrics": [
        {
          "content": {
            "cvss_v3": {
              "version": "3.1",
              "vectorString": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:H/A:H",
              "baseScore": 10,
              "baseSeverity": "CRITICAL"
           }
          }
          "products": [
            "CSAFPID-9080700"
          ]
        },
        {
          "content": {
            "cvss_v3": {
              "version": "3.1",
              "vectorString": "CVSS:3.1/AV:L/AC:L/PR:H/UI:R/S:U/C:H/I:H/A:H",
              "baseScore": 6.5,
              "baseSeverity": "MEDIUM"
            }
          }
          "products": [
            "CSAFPID-9080700"
          ]
        }
      ]
    }
  ]

Two CVSS v3.1 scores are given for CSAFPID-9080700 by the document author.

 6.1.8 Invalid CVSS

It MUST be tested that the given CVSS object is valid according to the referenced schema.

The relevant paths for this test are:

  /vulnerabilities[]/metrics[]/content/cvss_v2
  /vulnerabilities[]/metrics[]/content/cvss_v3
  /vulnerabilities[]/metrics[]/content/cvss_v4

Example 1 (which fails the test):

  "cvss_v3": {
    "version": "3.1",
    "vectorString": "CVSS:3.1/AV:L/AC:L/PR:H/UI:R/S:U/C:H/I:H/A:H",
    "baseScore": 6.5
  }

The required element baseSeverity is missing.

A tool MAY add one or more of the missing properties version, baseScore and baseSeverity based on the values given in vectorString as quick fix.

 6.1.9 Invalid CVSS computation

It MUST be tested that the given CVSS object has the values computed correctly according to the definition.

The vectorString SHOULD take precedence.

The relevant paths for this test are:

  /vulnerabilities[]/metrics[]/content/cvss_v2/baseScore
  /vulnerabilities[]/metrics[]/content/cvss_v2/temporalScore
  /vulnerabilities[]/metrics[]/content/cvss_v2/environmentalScore
  /vulnerabilities[]/metrics[]/content/cvss_v3/baseScore
  /vulnerabilities[]/metrics[]/content/cvss_v3/baseSeverity
  /vulnerabilities[]/metrics[]/content/cvss_v3/temporalScore
  /vulnerabilities[]/metrics[]/content/cvss_v3/temporalSeverity
  /vulnerabilities[]/metrics[]/content/cvss_v3/environmentalScore
  /vulnerabilities[]/metrics[]/content/cvss_v3/environmentalSeverity
  /vulnerabilities[]/metrics[]/content/cvss_v4/baseScore
  /vulnerabilities[]/metrics[]/content/cvss_v4/baseSeverity
  /vulnerabilities[]/metrics[]/content/cvss_v4/threatScore
  /vulnerabilities[]/metrics[]/content/cvss_v4/threatSeverity
  /vulnerabilities[]/metrics[]/content/cvss_v4/environmentalScore
  /vulnerabilities[]/metrics[]/content/cvss_v4/environmentalSeverity

Example 1 (which fails the test):

  "cvss_v3": {
    "version": "3.1",
    "vectorString": "CVSS:3.1/AV:L/AC:L/PR:H/UI:R/S:U/C:H/I:H/A:H",
    "baseScore": 10.0,
    "baseSeverity": "LOW"
  }

Neither baseScore nor baseSeverity has the correct value according to the specification.

A tool MAY set the correct values as computed according to the specification as quick fix.

 6.1.10 Inconsistent CVSS

It MUST be tested that the given CVSS properties do not contradict the CVSS vector.

The relevant paths for this test are:

  /vulnerabilities[]/metrics[]/content/cvss_v2
  /vulnerabilities[]/metrics[]/content/cvss_v3
  /vulnerabilities[]/metrics[]/content/cvss_v4

Example 1 (which fails the test):

  "cvss_v3": {
    "version": "3.1",
    "vectorString": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
    "baseScore": 9.8,
    "baseSeverity": "CRITICAL",
    "attackVector": "LOCAL",
    "attackComplexity": "LOW",
    "privilegesRequired": "NONE",
    "userInteraction": "NONE",
    "scope": "CHANGED",
    "confidentialityImpact": "HIGH",
    "integrityImpact": "HIGH",
    "availabilityImpact": "LOW"
  }

The values in CVSS vector differs from values of the properties attackVector, scope and availabilityImpact.

A tool MAY overwrite contradicting values according to the vectorString as quick fix.

 6.1.11 CWE

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:

    /vulnerabilities[]/cwes[]

Example 1 (which fails the test):

  "cwes": [
    {
      "id": "CWE-79",
      "name": "Improper Input Validation",
      "version": "4.13"
    }
  ]

The CWE-79 exists. However, its name in version 4.13 is Improper Neutralization of Input During Web Page Generation ('Cross-site Scripting').

 6.1.12 Language

For each element of type /$defs/lang_t it MUST be tested that the language code is valid and exists.

The relevant paths for this test are:

  /document/lang
  /document/source_lang

Example 1 (which fails the test):

  "lang": "EZ"

EZ is not a valid language. It is the subtag for the region “Eurozone”.

For any deprecated subtag, a tool MAY replace it with its preferred value as a quick fix.

 6.1.13 PURL

It MUST be tested that all given purls are valid.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_identification_helper/purls[]
  /product_tree/full_product_names[]/product_identification_helper/purls[]
  /product_tree/relationships[]/full_product_name/product_identification_helper/purls[]

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "name": "Product A",
        "product_id": "CSAFPID-9080700",
        "product_identification_helper": {
          "purls": [
            "pkg:maven/@1.3.4"
          ]
        }
      }
    ]
  }

Any valid purl has a name component.

 6.1.14 Sorted Revision History

It MUST be tested that the value of number of items of the revision history are sorted ascending when the items are sorted ascending by date and as a second level criteria number. As the timestamps might use different timezones, the sorting MUST take timezones into account.

The relevant path for this test is:

    /document/tracking/revision_history

Example 1 (which fails the test):

  "revision_history": [
    {
      "date": "2024-01-22T10:00:00.000Z",
      "number": "2",
      "summary": "Second version."
    },
    {
      "date": "2024-01-23T10:00:00.000Z",
      "number": "1",
      "summary": "Initial version."
    }
  ]

The first item has a higher version number than the second.

 6.1.15 Translator

It MUST be tested that /document/source_lang is present and set if the value translator is used for /document/publisher/category.

The relevant path for this test is:

    /document/source_lang

Example 1 (which fails the test):

  "document": {
    // ...
    "publisher": {
      "category": "translator",
      "name": "CSAF TC Translator",
      "namespace": "https://csaf.io/translator"
    },
    "title": "Mandatory test: Translator (failing example 1)",
    // ...
  }

The required element source_lang is missing.

 6.1.16 Latest Document Version

It MUST be tested that document version has the same value as the number in the last item of the revision history when it is sorted ascending by date and as a second level criteria number. As the timestamps might use different timezones, the sorting MUST take timezones into account. Build metadata is ignored in the comparison. Any pre-release part is also ignored if the document status is draft.

The relevant path for this test is:

    /document/tracking/version

Example 1 (which fails the test):

  "tracking": {
    // ...
    "revision_history": [
      {
        "date": "2024-01-21T09:00:00.000Z",
        "number": "1",
        "summary": "Initial version."
      },
      {
        "date": "2024-01-21T10:00:00.000Z",
        "number": "2",
        "summary": "Second version."
      }
    ],
    // ...
    "version": "1"
  }

The value of number of the last item after sorting is 2. However, the document version is 1.

 6.1.17 Document Status Draft

It MUST be tested that document status is draft if the document version is 0 or 0.y.z or contains the pre-release part.

The relevant path for this test is:

    /document/tracking/status

Example 1 (which fails the test):

    "tracking": {
      // ...
      "status": "final",
      "version": "0.9.5"
    }

The /document/tracking/version is 0.9.5 but the document status is final.

 6.1.18 Released Revision History

It MUST be tested that no item of the revision history has a number of 0 or 0.y.z when the document status is final or interim.

The relevant path for this test is:

    /document/tracking/revision_history[]/number

Example 1 (which fails the test):

    "tracking": {
      // ...
      "revision_history": [
        {
          "date": "2023-09-17T10:00:00.000Z",
          "number": "0",
          "summary": "First draft"
        },
        {
          "date": "2024-01-21T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        }
      ],
      "status": "final",
      "version": "1"
    }

The document status is final but the revision history includes an item which has 0 as value for number.

 6.1.19 Revision History Entries for Pre-release Versions

It MUST be tested that no item of the revision history has a number which includes pre-release information.

The relevant path for this test is:

    /document/tracking/revision_history[]/number

Example 1 (which fails the test):

    "revision_history": [
      {
        "date": "2023-08-22T10:00:00.000Z",
        "number": "1.0.0-rc",
        "summary": "Release Candidate for initial version."
      },
      {
        "date": "2023-08-23T10:00:00.000Z",
        "number": "1.0.0",
        "summary": "Initial version."
      }
    ]

The revision history contains an item which has a number that indicates that this is pre-release.

 6.1.20 Non-draft Document Version

It MUST be tested that document version does not contain a pre-release part if the document status is final or interim.

The relevant path for this test is:

    /document/tracking/version

Example 1 (which fails the test):

    "tracking": {
      // ...
      "status": "interim",
      "version": "1.0.0-alpha"
    }

The document status is interim but the document version contains the pre-release part -alpha.

 6.1.21 Missing Item in Revision History

It MUST be tested that items of the revision history do not omit a version number when the items are sorted ascending by date. As the timestamps might use different timezones, the sorting MUST take timezones into account. In the case of semantic versioning, this applies only to the Major version. It MUST also be tested that the first item in such a sorted list has either the version number 0 or 1 in the case of integer versioning or a Major version of 0 or 1 in the case of semantic versioning.

The relevant path for this test is:

    /document/tracking/revision_history

Example 1 (which fails the test):

    "revision_history": [
      {
        "date": "2023-08-22T10:00:00.000Z",
        "number": "1",
        "summary": "Initial version."
      },
      {
        "date": "2024-01-21T10:00:00.000Z",
        "number": "3",
        "summary": "Some other changes."
      }
    ]

The item for version 2 is missing.

 6.1.22 Multiple Definition in Revision History

It MUST be tested that items of the revision history do not contain the same version number.

The relevant path for this test is:

    /document/tracking/revision_history

Example 1 (which fails the test):

   "revision_history": [
      {
        "date": "2024-01-20T10:00:00.000Z",
        "number": "1",
        "summary": "Initial version."
      },
      {
        "date": "2024-01-21T10:00:00.000Z",
        "number": "1",
        "summary": "Some other changes."
      }
    ]

The revision history contains two items with the version number 1.

 6.1.23 Multiple Use of Same CVE

It MUST be tested that a CVE is not used in multiple vulnerability items.

The relevant path for this test is:

    /vulnerabilities[]/cve

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "cve": "CVE-2017-0145"
    },
    {
      "cve": "CVE-2017-0145"
    }
  ]

The vulnerabilities array contains two items with the same CVE identifier CVE-2017-0145.

 6.1.24 Multiple Definition in Involvements

It MUST be tested that items of the list of involvements do not contain the same party regardless of its status more than once at any date.

The relevant path for this test is:

    /vulnerabilities[]/involvements

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "involvements": [
        {
          "date": "2023-08-23T10:00:00.000Z",
          "party": "vendor",
          "status": "completed"
        },
        {
          "date": "2023-08-23T10:00:00.000Z",
          "party": "vendor",
          "status": "in_progress",
          "summary": "The vendor has released a mitigation and is working to fully resolve the issue."
        }
      ]
    }
  ]

The list of involvements contains two items with the same tuple party and date.

 6.1.25 Multiple Use of Same Hash Algorithm

It MUST be tested that the same hash algorithm is not used multiple times in one item of hashes.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_identification_helper/hashes[]/file_hashes
  /product_tree/full_product_names[]/product_identification_helper/hashes[]/file_hashes
  /product_tree/relationships[]/full_product_name/product_identification_helper/hashes[]/file_hashes

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "name": "Product A",
        "product_id": "CSAFPID-9080700",
        "product_identification_helper": {
          "hashes": [
            {
              "file_hashes": [
                {
                  "algorithm": "sha256",
                  "value": "026a37919b182ef7c63791e82c9645e2f897a3f0b73c7a6028c7febf62e93838"
                },
                {
                  "algorithm": "sha256",
                  "value": "0a853ce2337f0608489ac596a308dc5b7b19d35a52b10bf31261586ac368b175"
                }
              ],
              "filename": "product_a.so"
            }
          ]
         }
      }
    ]
  }

The hash algorithm sha256 is used two times in one item of hashes.

 6.1.26 Prohibited Document Category Name

It MUST be tested that the document category is not equal to the (case insensitive) name (without the prefix csaf_) or value of any other profile than “CSAF Base”. Any occurrences of dash, whitespace, and underscore characters are removed from the values on both sides before the match. Also the value MUST NOT start with the reserved prefix csaf_ except if the value is csaf_base.

This test does only apply for CSAF documents with the profile “CSAF Base”. Therefore, it MUST be skipped if the document category matches one of the values defined for the profile other than “CSAF Base”.

For CSAF 2.1, the test must be skipped for the following values in /document/category:

 csaf_base
 csaf_security_incident_response
 csaf_informational_advisory
 csaf_security_advisory
 csaf_vex
 csaf_deprecated_security_advisory
 csaf_withdrawn
 csaf_superseded

This is the only mandatory test related to the profile “CSAF Base” as the required fields SHALL be checked by validating the JSON schema.

The relevant path for this test is:

  /document/category

Examples 1 (for currently prohibited values):

  Csaf_a
  Informational Advisory
  security-incident-response
  Security      Advisory
  veX
  V_eX
  Deprecated Security Advisory
  withdrawn
  Superseded

Example 2 (which fails the test):

  "category": "Security_Incident_Response"

The value Security_Incident_Response is the name of a profile where the space was replaced with underscores.

 6.1.27 Profile Tests

This subsubsection structures the mandatory tests for the profiles. Not all tests apply for all profiles. Tests SHOULD be skipped if the document category does not match the one given in the test. Each of the following tests SHOULD be treated as they where listed similar to the other tests.

An application MAY group these tests by profiles when providing the additional function to only run one or more selected tests. This results in one virtual test per profile.

 6.1.27.1 Document Notes

It MUST be tested that at least one item in /document/notes exists which has a category of description, details, general or summary.

The relevant values for /document/category are:

  csaf_informational_advisory
  csaf_security_incident_response

The relevant path for this test is:

  /document/notes

Example 1 (which fails the test):

  "notes": [
    {
      "category": "legal_disclaimer",
      "text": "The CSAF document is provided to You \"AS IS\" and \"AS AVAILABLE\" and with all faults and defects without warranty of any kind.",
      "title": "Terms of Use"
    }
  ]

The document notes do not contain an item which has a category of description, details, general or summary.

 6.1.27.2 Document References

It MUST be tested that at least one item in /document/references exists that has links to an external source.

The relevant values for /document/category are:

  csaf_informational_advisory
  csaf_security_incident_response

The relevant path for this test is:

  /document/references

Example 1 (which fails the test):

  "references": [
    {
      "category": "self",
      "summary": "The canonical URL.",
      "url": "https://example.com/security/data/csaf/2024/oasis_csaf_tc-csaf_2_1-2024-6-1-27-02-01.json"
    }
  ]

The document references do not contain any item which has the category external.

 6.1.27.3 Vulnerabilities

It MUST be tested that the element /vulnerabilities does not exist.

The relevant values for /document/category are:

  csaf_informational_advisory
  csaf_withdrawn
  csaf_superseded

The relevant path for this test is:

  /vulnerabilities

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "title": "A vulnerability item that SHALL NOT exist"
    }
  ]

The element /vulnerabilities exists.

A tool MAY change the /document/category to csaf_base as a quick fix.

 6.1.27.4 Product Tree

It MUST be tested that the element /product_tree exists.

The relevant values for /document/category are:

  csaf_security_advisory
  csaf_vex
  csaf_deprecated_security_advisory

The relevant path for this test is:

  /product_tree

Example 1 (which fails the test):

  {
    "document": {
      // ...
    },
    "vulnerabilities": [
      // ...
    ]
  }

The element /product_tree does not exist.

 6.1.27.5 Vulnerability Notes

For each item in /vulnerabilities it MUST be tested that the element notes exists.

The relevant values for /document/category are:

  csaf_security_advisory
  csaf_vex
  csaf_deprecated_security_advisory

The relevant path for this test is:

  /vulnerabilities[]/notes

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "product_status": {
        "known_affected": [
          "CSAFPID-9080700"
        ]
      },
      "title": "A vulnerability item without a note"
    }
  ]

The vulnerability item has no notes element.

 6.1.27.6 Product Status

For each item in /vulnerabilities it MUST be tested that the element product_status exists.

The relevant values for /document/category are:

  csaf_security_advisory
  csaf_deprecated_security_advisory

The relevant path for this test is:

  /vulnerabilities[]/product_status

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "title": "A vulnerability item without a product status"
    }
  ]

The vulnerability item has no product_status element.

 6.1.27.7 VEX Product Status

For each item in /vulnerabilities it MUST be tested that at least one of the elements fixed, known_affected, known_not_affected, or under_investigation is present in product_status.

The relevant value for /document/category is:

  csaf_vex

The relevant paths for this test are:

  /vulnerabilities[]/product_status/fixed
  /vulnerabilities[]/product_status/known_affected
  /vulnerabilities[]/product_status/known_not_affected
  /vulnerabilities[]/product_status/under_investigation

Example 1 (which fails the test):

  "product_status": {
    "first_fixed": [
      // ...
    ],
    "recommended": [
      // ...
    ]
  }

None of the elements fixed, known_affected, known_not_affected, or under_investigation is present in product_status.

 6.1.27.8 Vulnerability ID

For each item in /vulnerabilities it MUST be tested that at least one of the elements cve or ids is present.

The relevant value for /document/category is:

  csaf_vex

The relevant paths for this test are:

  /vulnerabilities[]/cve
  /vulnerabilities[]/ids

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "title": "A vulnerability item without a CVE or ID"
    }
  ]

None of the elements cve or ids is present.

 6.1.27.9 Impact Statement

For each item in /vulnerabilities[]/product_status/known_not_affected it MUST be tested that a corresponding impact statement exist in /vulnerabilities[]/flags or /vulnerabilities[]/threats. For the latter one, the category value for such a statement MUST be impact.

The relevant value for /document/category is:

  csaf_vex

The relevant path for this test is:

  /vulnerabilities[]/flags
  /vulnerabilities[]/threats

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      },
      {
        "product_id": "CSAFPID-9080701",
        "name": "Product B"
      },
      {
        "product_id": "CSAFPID-9080702",
        "name": "Product C"
      }
    ],
    "product_groups": [
      {
        "group_id": "CSAFGID-0001",
        "product_ids": [
          "CSAFPID-9080700",
          "CSAFPID-9080701"
        ]
      }
    ]
  },
  "vulnerabilities": [
    {
      // ...
      "product_status": {
        "known_not_affected": [
          "CSAFPID-9080700",
          "CSAFPID-9080701",
          "CSAFPID-9080702"
        ]
      },
      "threats": [
        {
          "category": "impact",
          "details": "The vulnerable code is not present in these products.",
          "group_ids": [
            "CSAFGID-0001"
          ]
        }
      ]
    }
  ]

There is no impact statement for CSAFPID-9080702.

Note: The impact statement for CSAFPID-9080700 and CSAFPID-9080701 is given through CSAFGID-0001.

 6.1.27.10 Action Statement

For each item in /vulnerabilities[]/product_status/known_affected it MUST be tested that a corresponding action statement exist in /vulnerabilities[]/remediations.

The relevant value for /document/category is:

  csaf_vex

The relevant path for this test is:

  /vulnerabilities[]/remediations

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      },
      {
        "product_id": "CSAFPID-9080701",
        "name": "Product B"
      },
      {
        "product_id": "CSAFPID-9080702",
        "name": "Product C"
      }
    ],
    "product_groups": [
      {
        "group_id": "CSAFGID-0001",
        "product_ids": [
          "CSAFPID-9080700",
          "CSAFPID-9080701"
        ],
        "summary": "EOL products"
      }
    ]
  },
  "vulnerabilities": [
    {
      // ...
      "product_status": {
        "known_affected": [
          "CSAFPID-9080700",
          "CSAFPID-9080701",
          "CSAFPID-9080702"
        ]
      },
      "remediations": [
        {
          "category": "no_fix_planned",
          "details": "These products are end-of-life. Therefore, no fix will be provided.",
          "group_ids": [
            "CSAFGID-0001"
          ]
        }
      ]
    }
  ]

There is no action statement for CSAFPID-9080702.

Note: The action statement for CSAFPID-9080700 and CSAFPID-9080701 is given through CSAFGID-0001.

 6.1.27.11 Vulnerabilities

It MUST be tested that the element /vulnerabilities exists.

The relevant values for /document/category are:

  csaf_security_advisory
  csaf_vex
  csaf_deprecated_security_advisory

The relevant path for this test is:

  /vulnerabilities

Example 1 (which fails the test):

  {
    "document": {
      // ...
    },
    "product_tree": [
      // ...
    ]
  }

The element /vulnerabilities does not exist.

 6.1.27.12 Affected Products

For each item in /vulnerabilities it MUST be tested that the element product_status/known_affected exists.

The relevant value for /document/category is:

  csaf_security_advisory

The relevant path for this test is:

  /vulnerabilities[]/product_status/known_affected

Example 1 (which fails the test):

      "product_status": {
        "under_investigation": [
          "CSAFPID-9080700"
        ]
      }

The product status does not contain the known_affected element.

 6.1.27.13 Corresponding Affected Products

For each product listed in the product status group fixed in any vulnerability, it MUST be tested that a corresponding version of the product is listed as affected in the same vulnerability.

For a relationship installed_with the product without any relationship is a corresponding product.

The relevant value for /document/category is:

  csaf_security_advisory

The relevant path for this test is:

  /vulnerabilities[]/product_status/known_affected

Example 1 (which fails the test):

  {
    // ...
    "product_tree": {
      "branches": [
        {
          "branches": [
            {
              "branches": [
                {
                  "category": "product_version",
                  "name": "4.2",
                  "product": {
                    "name": "Example Company Product A 4.2",
                    "product_id": "CSAFPID-9080700"
                  }
                }
              ],
              "category": "product_name",
              "name": "Product A"
            }
          ],
          "category": "vendor",
          "name": "Example Company"
        }
      ]
    },
    "vulnerabilities": [
      {
        // ...
        "product_status": {
          "fixed": [
            "CSAFPID-9080700"
          ]
        }
      }
    ]
  }

The vulnerability just contains the fixed product but does not list corresponding affected products.

 6.1.27.14 Document Notes

It MUST be tested that at least one item in /document/notes exists which has a category of description.

The relevant values for /document/category are:

  csaf_withdrawn
  csaf_superseded

The relevant path for this test is:

  /document/notes

Example 1 (which fails the test):

  "notes": [
    {
      "category": "legal_disclaimer",
      "text": "The CSAF document is provided to You \"AS IS\" and \"AS AVAILABLE\" and with all faults and defects without warranty of any kind.",
      "title": "Terms of Use"
    }
  ]

The document notes do not contain an item which has a category of description.

 6.1.27.15 Product Tree

It MUST be tested that the element /product_tree does not exist.

The relevant values for /document/category are:

  csaf_withdrawn
  csaf_superseded

The relevant path for this test is:

  /product_tree

Example 1 (which fails the test):

    "product_tree": [
      // ...
    ]

The element /product_tree exists.

 6.1.27.16 Revision History

It MUST be tested that the revision history contains at least two entries.

The relevant values for /document/category are:

  csaf_withdrawn
  csaf_superseded

The relevant path for this test is:

  /document/tracking/revision_history

Example 1 (which fails the test):

  "revision_history": [
    {
      "date": "2024-01-24T10:00:00.000Z",
      "number": "1",
      "summary": "Initial version."
    }
  ],

The revision history contains only one entry.

 6.1.27.17 Reasoning for Withdrawal

If the document language is English or unspecified, it MUST be tested that exactly one item in document notes exists that has the title Reasoning for Withdrawal. The category of this item MUST be description.

The relevant value for /document/category is:

  csaf_withdrawn

The relevant path for this test is:

  /document/notes

Example 1 (which fails the test):

  "notes": [
    {
      "category": "summary",
      "text": "This CSAF document contained example data and was withdrawn to create test data.",
      "title": "Reasoning for Withdrawal"
    }
  ],

The note has the correct title. However, it uses the wrong category.

 6.1.27.18 Reasoning for Supersession

If the document language is English or unspecified, it MUST be tested that exactly one item in document notes exists that has the title Reasoning for Supersession. The category of this item MUST be description.

The relevant value for /document/category is:

  csaf_superseded

The relevant path for this test is:

  /document/notes

Example 1 (which fails the test):

  "notes": [
    {
      "category": "details",
      "text": "This CSAF document contained example data and was withdrawn to create test data.",
      "title": "Reasoning for Supersession"
    }
  ],

The note has the correct title. However, it uses the wrong category.

 6.1.27.19 Reference to Superseding Document

If the document language is English or unspecified, it MUST be tested that at least one item in document references exists that has a summary starting with Superseding Document. The category of this item MUST be external.

The relevant value for /document/category is:

  csaf_superseded

The relevant path for this test is:

  /document/references

Example 1 (which fails the test):

    "references": [
      {
        "category": "self",
        "summary": "Superseding Document",
        "url": "https://example.com/.well-known/csaf/clear/2024/esa-2024-1234.json"
      }
    ],

The reference summary starts correctly with the string “Superseding Document”. However, it uses the wrong category.

 6.1.28 Translation

It MUST be tested that the given source language and document language are not the same.

The relevant path for this test is:

  /document/lang
  /document/source_lang

Example 1 (which fails the test):

  "document": {
    // ...
    "lang": "en-US",
    // ...
    "source_lang": "en-US",
    // ...
  }

The document language and the source language have the same value en-US.

Note: A translation from en-US to en-GB would pass the test.

A tool MAY remove the source language as quick fix.

 6.1.29 Remediation without Product Reference

For each item in /vulnerabilities[]/remediations it MUST be tested that it includes at least one of the elements group_ids or product_ids.

The relevant path for this test is:

  /vulnerabilities[]/remediations[]

Example 1 (which fails the test):

      "remediations": [
        {
          "category": "no_fix_planned",
          "details": "These products are end-of-life. Therefore, no fix will be provided."
        }
      ]

The given remediation does not specify to which products it should be applied.

A tool MAY add all products of the affected group of this vulnerability to the remediation as quick fix.

 6.1.30 Mixed Integer and Semantic Versioning

It MUST be tested that all elements of type /$defs/version_t follow either integer versioning or semantic versioning homogeneously within the same document.

The relevant paths for this test are:

  /document/tracking/revision_history[]/number
  /document/tracking/version

Example 1 (which fails the test):

    "tracking": {
      // ...
      "revision_history": [
        {
          "date": "2024-01-21T09:00:00.000Z",
          "number": "1.0.0",
          "summary": "Initial version."
        },
        {
          "date": "2024-01-21T10:00:00.000Z",
          "number": "2",
          "summary": "Second version."
        }
      ],
      // ...
      "version": "2"
    }

The document started with semantic versioning (1.0.0) and switched to integer versioning (2).

A tool MAY assign all items their corresponding value according to integer versioning as a quick fix. In such case, the old number SHOULD be stored in legacy_version.

 6.1.31 Version Range in Product Version

For each element of type /$defs/branches_t with category of product_version it MUST be tested that the value of name does not contain a version range.

To implement this test it is deemed sufficient that, when converted to lower case, the value of name satisfies the two requirements below:

  1. It does not contain any of the following operators:

      <
  <=
  >
  >=

  2. If interpreted as a list of individual words separated by whitespace, the list does not contain any of the following keywords:

      after
  all
  before
  earlier
  later
  prior
  versions

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/name

Example 1 (which fails the test):

            "branches": [
              {
                "category": "product_version",
                "name": "prior to 4.2",
                // ...
              }
            ]

The version range prior to 4.2 is given for the branch category product_version.

 6.1.32 Flag without Product Reference

For each item in /vulnerabilities[]/flags it MUST be tested that it includes at least one of the elements group_ids or product_ids.

The relevant path for this test is:

  /vulnerabilities[]/flags[]

Example 1 (which fails the test):

      "flags": [
        {
          "label": "component_not_present"
        }
      ]

The given flag does not specify to which products it should be applied.

 6.1.33 Multiple Flags with VEX Justification Codes per Product

For each item in /vulnerabilities[] it MUST be tested that a Product is not member of more than one Flag item with a VEX justification code (see section 3.2.4.7). This takes indirect relations through Product Groups into account.

Additional flags with a different purpose might be provided in later versions of CSAF. Through the explicit reference of VEX justification codes the test is specified to be forward-compatible.

The relevant path for this test is:

  /vulnerabilities[]/flags

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      },
      {
        "product_id": "CSAFPID-9080701",
        "name": "Product B"
      }
    ],
    "product_groups": [
      {
        "group_id": "CSAFGID-0001",
        "product_ids": [
          "CSAFPID-9080700",
          "CSAFPID-9080701"
        ]
      }
    ]
  },
  "vulnerabilities": [
    {
      // ...
      "flags": [
        {
          "label": "component_not_present",
          "group_ids": [
            "CSAFGID-0001"
          ]
        },
        {
          "label": "vulnerable_code_cannot_be_controlled_by_adversary",
          "product_ids": [
            "CSAFPID-9080700"
          ]
        }
      ],
      // ...
      "product_status": {
        "known_not_affected": [
          "CSAFPID-9080700",
          "CSAFPID-9080701"
        ]
      }
    }
  ]

There are two flags given for CSAFPID-9080700 - one indirect through CSAFGID-0001 and one direct.

 6.1.34 Branches Recursion Depth

For each product defined under /product_tree/branches[] it MUST be tested that the complete JSON path does not contain more than 30 instances of branches.

The relevant path for this test is:

  /product_tree/branches[](/branches[])*/product

Example 1 (which fails the test):

  "product_tree": {
    "branches": [
      {
        "branches": [
          {
            "branches": [
              {
                "branches": [
                  {
                    "branches": [
                      {
                        "branches": [
                          {
                            "branches": [
                              {
                                "branches": [
                                  {
                                    "branches": [
                                      {
                                        "branches": [
                                          {
                                            "branches": [
                                              {
                                                "branches": [
                                                  {
                                                    "branches": [
                                                      {
                                                        "branches": [
                                                          {
                                                            "branches": [
                                                              {
                                                                "branches": [
                                                                  {
                                                                    "branches": [
                                                                      {
                                                                        "branches": [
                                                                          {
                                                                            "branches": [
                                                                              {
                                                                                "branches": [
                                                                                  {
                                                                                    "branches": [
                                                                                      {
                                                                                        "branches": [
                                                                                          {
                                                                                            "branches": [
                                                                                              {
                                                                                                "branches": [
                                                                                                  {
                                                                                                    "branches": [
                                                                                                      {
                                                                                                        "branches": [
                                                                                                          {
                                                                                                            "branches": [
                                                                                                              {
                                                                                                                "branches": [
                                                                                                                  {
                                                                                                                    "branches": [
                                                                                                                      {
                                                                                                                        "branches": [
                                                                                                                          {
                                                                                                                            "branches": [
                                                                                                                              {
                                                                                                                                "category": "product_name",
                                                                                                                                "name": "branches",
                                                                                                                                "product": {
                                                                                                                                  "name": "<<generate Product name>>",
                                                                                                                                  "product_id": "CSAFPID-9080700"
                                                                                                                                }
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "category": "product_family",
                                                                                                                            "name": "31"
                                                                                                                          }
                                                                                                                        ],
                                                                                                                        "category": "product_family",
                                                                                                                        "name": "with"
                                                                                                                      }
                                                                                                                    ],
                                                                                                                    "category": "product_family",
                                                                                                                    "name": "test"
                                                                                                                  }
                                                                                                                ],
                                                                                                                "category": "product_family",
                                                                                                                "name": "the"
                                                                                                              }
                                                                                                            ],
                                                                                                            "category": "product_family",
                                                                                                            "name": "fail"
                                                                                                          }
                                                                                                        ],
                                                                                                        "category": "product_family",
                                                                                                        "name": "and"
                                                                                                      }
                                                                                                    ],
                                                                                                    "category": "product_family",
                                                                                                    "name": "limits"
                                                                                                  }
                                                                                                ],
                                                                                                "category": "product_family",
                                                                                                "name": "the"
                                                                                              }
                                                                                            ],
                                                                                            "category": "product_family",
                                                                                            "name": "testing"
                                                                                          }
                                                                                        ],
                                                                                        "category": "product_family",
                                                                                        "name": "are"
                                                                                      }
                                                                                    ],
                                                                                    "category": "product_family",
                                                                                    "name": "they"
                                                                                  }
                                                                                ],
                                                                                "category": "product_family",
                                                                                "name": "but"
                                                                              }
                                                                            ],
                                                                            "category": "product_family",
                                                                            "name": "unrealistic"
                                                                          }
                                                                        ],
                                                                        "category": "product_family",
                                                                        "name": "less"
                                                                      }
                                                                    ],
                                                                    "category": "product_family",
                                                                    "name": "or"
                                                                  }
                                                                ],
                                                                "category": "product_family",
                                                                "name": "more"
                                                              }
                                                            ],
                                                            "category": "product_family",
                                                            "name": "and"
                                                          }
                                                        ],
                                                        "category": "product_family",
                                                        "name": "unnecessary"
                                                      }
                                                    ],
                                                    "category": "product_family",
                                                    "name": "seem"
                                                  }
                                                ],
                                                "category": "product_family",
                                                "name": "which"
                                              }
                                            ],
                                            "category": "product_family",
                                            "name": "product"
                                          }
                                        ],
                                        "category": "product_family",
                                        "name": "hypothetical"
                                      }
                                    ],
                                    "category": "product_family",
                                    "name": "this"
                                  }
                                ],
                                "category": "product_family",
                                "name": "for"
                              }
                            ],
                            "category": "product_family",
                            "name": "structure"
                          }
                        ],
                        "category": "product_family",
                        "name": "nested"
                      }
                    ],
                    "category": "product_family",
                    "name": "deeply"
                  }
                ],
                "category": "product_family",
                "name": "a"
              }
            ],
            "category": "product_family",
            "name": "uses"
          }
        ],
        "category": "vendor",
        "name": "Example Company"
      }
    ]
  }

The complete JSON path contains 31 times branches.

 6.1.35 Contradicting Remediations

For each item in /vulnerabilities[]/remediations it MUST be tested that a product is not member of contradicting remediation categories. This takes indirect relations through product groups into account.

The relevant path for this test is:

  /vulnerabilities[]/remediations[]

Example 1 (which fails the test):

      "remediations": [
        {
          "category": "no_fix_planned",
          "details": "The product is end-of-life. Therefore, no fix will be provided.",
          "product_ids": [
            "CSAFPID-9080700"
          ]
        },
        {
          "category": "vendor_fix",
          "details": "Update to version >=14.3 to fix the vulnerability.",
          "product_ids": [
            "CSAFPID-9080700"
          ]
        }
      ]

The two remediations given for the product with product ID CSAFPID-908070 contradict each other.

A tool MAY apply the conversion rules from the conformance target CSAF 2.0 to CSAF 2.1 converter if applicable or remove the product from the remediation with the lower priority. The priority MAY be defined as follows: vendor_fix > mitigation > workaround > fix_planned > no_fix_planned > optional_patch > none_available

 6.1.36 Contradicting Product Status Remediation Combination

For each item in /vulnerabilities[]/remediations it MUST be tested that a product is not member of a contradicting product status group. This takes indirect relations through product groups into account.

The relevant path for this test is:

  /vulnerabilities[]/remediations[]

Example 1 (which fails the test):

      "product_status": {
        "known_not_affected": [
          "CSAFPID-9080700"
        ]
      },
      "remediations": [
        {
          "category": "vendor_fix",
          "details": "Update to version >=14.3 to fix the vulnerability.",
          "product_ids": [
            "CSAFPID-9080700"
          ]
        }
      ]

For the product with product ID CSAFPID-908070 a vendor_fix is given but the product was not affected at all.

 6.1.37 Date and Time

For each item of type string and format date-time it MUST be tested that it conforms to the rules given in section sec.

The relevant path for this test is:

  /document/tracking/current_release_date
  /document/tracking/generator/date
  /document/tracking/initial_release_date
  /document/tracking/revision_history[]/date
  /vulnerabilities[]/disclosure_date
  /vulnerabilities[]/discovery_date
  /vulnerabilities[]/first_known_exploitation_dates[]/date
  /vulnerabilities[]/first_known_exploitation_dates[]/exploitation_date
  /vulnerabilities[]/flags[]/date
  /vulnerabilities[]/involvements[]/date
  /vulnerabilities[]/remediations[]/date
  /vulnerabilities[]/threats[]/date

Example 1 (which fails the test):

      "current_release_date": "2024-01-24 10:00:00.000Z",

The current_release_date uses a whitespace as separator instead the letter T.

 6.1.38 Non-Public Sharing Group with Max UUID

It MUST be tested that a CSAF document using Max UUID as sharing group ID has the TLP label CLEAR.

The relevant path for this test is:

  /document/distribution/tlp/label

Example 1 (which fails the test):

    "distribution": {
      "sharing_group": {
        "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
        "name": "Public"
      },
      "tlp": {
        "label": "RED"
      }
    },

The sharing group uses the Max UUID but the CSAF document is labeled as TLP:RED.

A tool MAY remove the property sharing_group as a quick fix.

 6.1.39 Public Sharing Group with no Max UUID

It MUST be tested that a CSAF document with the TLP label CLEAR use the Max UUID as sharing group ID if any. The test SHALL pass if no sharing group is present or the Nil UUID is used and the document status is draft.

The relevant path for this test is:

  /document/distribution/sharing_group/id

Example 1 (which fails the test):

    "distribution": {
      "sharing_group": {
        "id": "5868d6be-b28a-404e-a245-0b5093b31b8b"
      },
      "tlp": {
        "label": "CLEAR"
      }
    },

The sharing group is present for the TLP:CLEAR document but it differs from the Max UUID.

A tool MAY update the sharing group id as a quick fix.

 6.1.40 Invalid Sharing Group Name

It MUST be tested that the value of sharing group name does not equal the reserved values from section 3.2.2.5.1 if the precondition is not fulfilled.

The relevant path for this test is:

  /document/distribution/sharing_group/name

Example 1 (which fails the test):

    "distribution": {
      "sharing_group": {
        "id": "5868d6be-b28a-404e-a245-0b5093b31b8b",
        "name": "Public"
      },
      // ...
    },

The sharing group name is Public but it does not use the Max UUID.

A tool MAY update the sharing group name as a quick fix.

 6.1.41 Missing Sharing Group Name

It MUST be tested that the sharing group name exists and equals the predefined reserved value from section 3.2.2.5.1 if the precondition is fulfilled.

The relevant path for this test is:

  /document/distribution/sharing_group/name

Example 1 (which fails the test):

    "distribution": {
      "sharing_group": {
        "id": "ffffffff-ffff-ffff-ffff-ffffffffffff"
      },
      // ...
    },

The Max UUID is used but the sharing group name does not exist.

A tool MAY add the corresponding sharing group name as a quick fix.

 6.1.42 PURL Qualifiers

For each product_identification_helper object containing multiple purls it MUST be tested that the purls only differ in their qualifiers.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_identification_helper/purls[]
  /product_tree/full_product_names[]/product_identification_helper/purls[]
  /product_tree/relationships[]/full_product_name/product_identification_helper/purls[]

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "name": "Product A",
        "product_id": "CSAFPID-9080700",
        "product_identification_helper": {
          "purls": [
            "pkg:maven/com.example/logging@1.3.4",
            "pkg:maven/com.example/audit@1.3.4"
          ]
        }
      }
    ]
  }

The two purls differ in the name component.

 6.1.43 Use of Multiple Stars in Model Number

For each model number it MUST be tested that the it does not contain multiple unescaped stars.

Multiple * that match zero or multiple characters within a model number introduce ambiguity and are therefore prohibited.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_identification_helper/model_numbers[]
  /product_tree/full_product_names[]/product_id/product_identification_helper/model_numbers[]
  /product_tree/relationships[]/full_product_name/product_id/product_identification_helper/model_numbers[]

Example 1 (which fails the test):

          "model_numbers": [
            "P*A*"
          ]

The model number contains two unescaped stars.

 6.1.44 Use of Multiple Stars in Serial Number

For each serial number it MUST be tested that the it does not contain multiple unescaped stars.

Multiple * that match zero or multiple characters within a serial number introduce ambiguity and are therefore prohibited.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_identification_helper/serial_numbers[]
  /product_tree/full_product_names[]/product_id/product_identification_helper/serial_numbers[]
  /product_tree/relationships[]/full_product_name/product_id/product_identification_helper/serial_numbers[]

Example 1 (which fails the test):

          "serial_numbers": [
            "P*A*"
          ]

The serial number contains two unescaped stars.

 6.1.45 Inconsistent Disclosure Date

For each vulnerability, it MUST be tested that the disclosure_date is earlier than or equal to the date of the newest item of the revision_history if the document is labeled TLP:CLEAR and the document status is final or interim. As the timestamps might use different timezones, the sorting MUST take timezones into account.

The relevant path for this test is:

    /vulnerabilities[]/disclosure_date

Example 1 (which fails the test):

  "document": {
    // ...
    "distribution": {
      "tlp": {
        "label": "CLEAR"
      }
    },
    // ...
    "tracking": {
      // ...
      "revision_history": [
        {
          "date": "2024-01-24T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        }
      ],
      "status": "final",
      // ...
    }
  },
  "vulnerabilities": [
    {
      "disclosure_date": "2024-02-24T10:00:00.000Z"
    }
  ]

The document is labeled TLP:CLEAR and in status final but the disclosure_date is newer than the date of newest item in the revision_history.

 6.1.46 Invalid SSVC

It MUST be tested that the given SSVC object is valid according to the referenced schema.

The relevant path for this test is:

  /vulnerabilities[]/metrics[]/content/ssvc_v1

Example 1 (which fails the test):

  "ssvc_v1": {
    "id": "CVE-1900-0001",
    "schemaVersion": "1-0-1",
    "timestamp": "2024-01-24T10:00:00.000Z"
  }

The required element selections is missing.

A tool MAY add the missing property id based on the values given in cve respectively ids[]/text as quick fix.

 6.1.47 Inconsistent SSVC ID

For each ssvc_v1 object it MUST be tested that id is either the CVE of the vulnerability given in cve or the text of an item in the ids array. The test MUST fail, if the id equals the /document/tracking/id and the CSAF document contains more than one vulnerability.

The relevant path for this test is:

   /vulnerabilities[]/metrics[]/content/ssvc_v1/id

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "cve": "CVE-1900-0001",
      "metrics": [
        {
          "content": {
            "ssvc_v1": {
              "id": "CVE-1900-0002",
              "schemaVersion": "1-0-1",
              "selections": [
                {
                  "name": "Exploitation",
                  "namespace": "ssvc",
                  "values": [
                    "None"
                  ],
                  "version": "1.1.0"
                }
              ],
              "timestamp": "2024-01-24T10:00:00.000Z"
            }
          },
          // ...
        }
      ]
    }
  ]

The SSVC ID does not match the CVE ID.

 6.1.48 SSVC Decision Points

For each SSVC decision point given under selections with a registered namespace, it MUST be tested that given decision point exists, is valid and the items in values are ordered correctly. The test SHALL pass, if a non-registered namespace is used.

According to the SSVC project, the following values are currently registered:

  cvss
  nciss
  ssvc

A list of all valid decision points including their values is available at the SSVC repository.
The items in values need to have the same order as in their definition.

The relevant path for this test is:

   /vulnerabilities[]/metrics[]/content/ssvc_v1/selections[]

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "cve": "CVE-1900-0001",
      "metrics": [
        {
          "content": {
            "ssvc_v1": {
              "id": "CVE-1900-0001",
              "schemaVersion": "1-0-1",
              "selections": [
                {
                  "name": "Mission Impact",
                  "namespace": "ssvc",
                  "values": [
                    "None",
                    "Degraded"
                  ],
                  "version": "1.0.0"
                }
              ],
              "timestamp": "2024-01-24T10:00:00.000Z"
            }
          },
          // ...
        }
      ]
    }
  ]

The SSVC decision point Mission Impact doesn’t have the value Degraded in version 1.0.0.

If applicable, a tool MAY sort the items in values according to the order of their definition as a quick fix.

 6.1.49 Inconsistent SSVC Timestamp

For each vulnerability, it MUST be tested that the each SSVC timestamp is earlier than or equal to the date of the newest item of the revision_history if the document status is final or interim. As the timestamps might use different timezones, the sorting MUST take timezones into account.

The relevant path for this test is:

    /vulnerabilities[]/metrics[]/content/ssvc_v1/timestamp

Example 1 (which fails the test):

  "document": {
    // ...
    "tracking": {
      // ...
      "revision_history": [
        {
          "date": "2024-01-24T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        }
      ],
      "status": "final",
      // ...
    }
  },
  // ...
  "vulnerabilities": [
    {
      "cve": "CVE-1900-0001",
      "metrics": [
        {
          "content": {
            "ssvc_v1": {
              "id": "CVE-1900-0001",
              "schemaVersion": "1-0-1",
              "selections": [
                {
                  "name": "Exploitation",
                  "namespace": "ssvc",
                  "values": [
                    "Active"
                  ],
                  "version": "1.1.0"
                }
              ],
              "timestamp": "2024-07-13T10:00:00.000Z"
            }
          },
          // ...
        }
      ]
    }
  ]

The document is in status final but the SSVC timestamp is newer than the date of newest item in the revision_history.

 6.1.50 Product Version Range Rules

For each element of type /$defs/branches_t with category of product_version_range, it MUST be tested that the value of name complies with the rules given in section 3.1.2.3.2.

The relevant path for this test is:

    /product_tree/branches[](/branches[])*/name

Example 1 (which fails the test):

        {
          "category": "product_version_range",
          "name": "all versions < 4.2.0",
          // ...
        }

The version range given does not comply with the rules given in section 3.1.2.3.2.

 6.1.51 Inconsistent EPSS Timestamp

For each vulnerability, it MUST be tested that the each EPSS timestamp is earlier than or equal to the date of the newest item of the revision_history if the document status is final or interim. As the timestamps might use different timezones, the sorting MUST take timezones into account.

The relevant path for this test is:

    /vulnerabilities[]/metrics[]/content/epss/timestamp

Example 1 (which fails the test):

  "document": {
    // ...
    "distribution": {
      "tlp": {
        "label": "CLEAR"
      }
    },
    // ...
    "tracking": {
      // ...
      "revision_history": [
        {
          "date": "2024-01-24T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        }
      ],
      "status": "final",
      // ...
    }
  },
  "vulnerabilities": [
    {
      "cve": "CVE-1900-0001",
      "metrics": [
        {
          "content": {
            "epss": {
              "percentile": "0.999990000",
              "probability": "0.975570000",
              "timestamp": "2024-07-13T10:00:00.000Z"
            }
          },
          "products": [
            "CSAFPID-9080700"
          ]
        }
      ]
    }
  ]

The document is in status final but the EPSS timestamp is newer than the date of newest item in the revision_history.

 6.1.52 Inconsistent First Known Exploitation Dates

For each First Known Exploitation Dates item, it MUST be tested that the values of its date and exploitation_date properties are both earlier than or equal to the date of the newest item of the revision_history if the document status is final or interim. As the timestamps might use different timezones, the sorting MUST take timezones into account.

The relevant paths for this test are:

  /vulnerabilities[]/first_known_exploitation_dates[]/date
  /vulnerabilities[]/first_known_exploitation_dates[]/exploitation_date

Example 1 (which fails the test):

  "document": {
    // ...
    "tracking": {
      // ...
      "revision_history": [
        {
          "date": "2024-01-24T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        }
      ],
      "status": "final",
      // ...
    }
  },
  // ...
  "vulnerabilities": [
    {
      "first_known_exploitation_dates": [
        {
          "date": "2024-01-24T13:00:00.000Z",
          "exploitation_date": "2024-01-24T12:34:56.789Z",
          // ...
        }
      ]
    }
  ]

The document is in status final but the values of the properties date and exploitation_date of the First Known Exploitation Dates item are newer than the date of newest item in the revision_history.

 6.1.53 Inconsistent Exploitation Date

For each First Known Exploitation Dates item, it MUST be tested that the value of exploitation_date is earlier than or equal to value of the sibling element date. As the timestamps might use different timezones, the sorting MUST take timezones into account.

The relevant paths for this test are:

  /vulnerabilities[]/first_known_exploitation_dates[]/exploitation_date

Example 1 (which fails the test):

  "document": {
    // ...
    "tracking": {
      // ...
      "revision_history": [
        {
          "date": "2024-01-24T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        }
      ],
      "status": "final",
      // ...
    }
  },
  // ...
  "vulnerabilities": [
    {
      "first_known_exploitation_dates": [
        {
          "date": "2024-01-24T13:00:00.000Z",
          "exploitation_date": "2024-01-24T12:34:56.789Z",
          // ...
        }
      ]
    }
  ]

The document is in status final but the value of exploitation_date is newer than the value of date in the same item.

 6.1.54 License Expression

It MUST be tested that the license expression is valid.

To implement this test, it it deemed sufficient to check for the ABNF defined in annex B of [SPDX301] and the restriction on the DocumentRef part given in 3.2.2.7

The relevant path for this test is:

  /document/license_expression

Example 1 (which fails the test):

    "license_expression": "This is a license text that should not be here.",

The license expression contains a license text instead of a SPDX license expression.

 6.1.55 License Text

If the document language is English or unspecified, and the license_expression contains license identifiers or exceptions that are not listed in the SPDX license list or Aboutcode’s “ScanCode LicenseDB”, it MUST be tested that exactly one item in document notes exists that has the title License. The category of this item MUST be legal_disclaimer.

The relevant path for this test is:

  /document/notes

Example 1 (which fails the test):

  "document": {
    // ...
    "license_expression": "LicenseRef-www.example.com-no-work-pd",
    "notes": [
      {
        "category": "other",
        "text": "This is not a work and therefore it can't be licensed. Use it as public domain.",
        "title": "License"
      }
    ],
    // ...
  }

The note has the correct title. However, it uses the wrong category.

Recommended tests SHOULD NOT fail at a valid CSAF document without a good reason. Failing such a test does not make the CSAF document invalid. These tests may include information about features which are still supported but expected to be deprecated in a future version of CSAF. A program MUST handle a test failure as a warning.

 6.2.1 Unused Definition of Product ID

For each Product ID (type /$defs/product_id_t) in Full Product Name elements (type: /$defs/full_product_name_t) it MUST be tested that the product_id is referenced somewhere within the same document.

This test SHALL be skipped for CSAF documents conforming the profile “Informational Advisory”.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_id
  /product_tree/full_product_names[]/product_id
  /product_tree/relationships[]/full_product_name/product_id

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]
  }

CSAFPID-9080700 was defined but never used.

A tool MAY remove the unused definition as quick fix. However, such quick fix shall not be applied if the test was skipped.

 6.2.2 Missing Remediation

For each Product ID (type /$defs/product_id_t) in the Product Status groups Affected and Under investigation it MUST be tested that a remediation exists.

The remediation might be of the category none_available or no_fix_planned.

The relevant paths for this test are:

  /vulnerabilities[]/product_status/first_affected[]
  /vulnerabilities[]/product_status/known_affected[]
  /vulnerabilities[]/product_status/last_affected[]
  /vulnerabilities[]/product_status/under_investigation[]

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]
  },
  "vulnerabilities": [
    {
      "product_status": {
        "last_affected": [
          "CSAFPID-9080700"
        ]
      }
    }
  ]

CSAFPID-9080700 has in Product Status last_affected but there is no remediation object for this Product ID.

 6.2.3 Missing Metric

For each Product ID (type /$defs/product_id_t) in the Product Status groups Affected it MUST be tested that a metric object exists which covers this product.

The relevant paths for this test are:

  /vulnerabilities[]/product_status/first_affected[]
  /vulnerabilities[]/product_status/known_affected[]
  /vulnerabilities[]/product_status/last_affected[]

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]
  },
  "vulnerabilities": [
    {
      "product_status": {
        "first_affected": [
          "CSAFPID-9080700"
        ]
      }
    }
  ]

CSAFPID-9080700 has in Product Status first_affected but there is no metric object which covers this Product ID.

 6.2.4 Build Metadata in Revision History

For each item in revision history it MUST be tested that number does not include build metadata.

The relevant path for this test is:

    /document/tracking/revision_history[]/number

Example 1 (which fails the test):

    "revision_history": [
      {
        "date": "2023-08-23T10:00:00.000Z",
        "number": "1.0.0+exp.sha.ac00785",
        "summary": "Initial version."
      }
    ]

The revision history contains an item which has a number that includes the build metadata +exp.sha.ac00785.

 6.2.5 Older Initial Release Date than Revision History

It MUST be tested that the Initial Release Date is not older than the date of the oldest item in Revision History. As the timestamps might use different timezones, the sorting and comparison MUST take timezones into account.

The relevant path for this test is:

    /document/tracking/initial_release_date

Example 1 (which fails the test):

    "tracking": {
      // ...
      "initial_release_date": "2023-08-22T10:00:00.000Z",
      "revision_history": [
        {
          "date": "2023-09-06T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        },
        {
          "date": "2024-01-21T11:00:00.000Z",
          "number": "2",
          "summary": "Second version."
        }
      ],
      // ...
    }

The initial release date 2023-08-22T10:00:00.000Z is older than 2023-09-06T10:00:00.000Z which is the date of the oldest item in Revision History.

 6.2.6 Older Current Release Date than Revision History

It MUST be tested that the Current Release Date is not older than the date of the newest item in Revision History. As the timestamps might use different timezones, the sorting and comparison MUST take timezones into account.

The relevant path for this test is:

    /document/tracking/current_release_date

Example 1 (which fails the test):

    "tracking": {
      "current_release_date": "2023-09-06T10:00:00.000Z",
      // ...
      "revision_history": [
        {
          "date": "2023-09-06T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        },
        {
          "date": "2024-01-21T11:00:00.000Z",
          "number": "2",
          "summary": "Second version."
        }
      ],
      // ...
    }

The current release date 2023-09-06T10:00:00.000Z is older than 2023-09-23T1100:00.000Z which is the date of the newest item in Revision History.

 6.2.7 Missing Date in Involvements

For each item in the list of involvements it MUST be tested that it includes the property date.

The relevant path for this test is:

    /vulnerabilities[]/involvements

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "involvements": [
        {
          "party": "vendor",
          "status": "in_progress"
        }
      ]
    }
  ]

The list of involvements contains an item which does not contain the property date.

 6.2.8 Use of MD5 as the only Hash Algorithm

It MUST be tested that the hash algorithm md5 is not the only one present.

Since collision attacks exist for MD5 such value should be accompanied by a second cryptographically stronger hash. This will allow users to double check the results.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_identification_helper/hashes[]/file_hashes
  /product_tree/full_product_names[]/product_identification_helper/hashes[]/file_hashes
  /product_tree/relationships[]/full_product_name/product_identification_helper/hashes[]/file_hashes

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "name": "Product A",
        "product_id": "CSAFPID-9080700",
        "product_identification_helper": {
          "hashes": [
            {
              "file_hashes": [
                {
                  "algorithm": "md5",
                  "value": "6ae24620ea9656230f49234efd078935"
                }
              ],
              "filename": "product_a.so"
            }
          ]
        }
      }
    ]
  }

The hash algorithm md5 is used in one item of hashes without being accompanied by a second hash algorithm.

 6.2.9 Use of SHA-1 as the only Hash Algorithm

It MUST be tested that the hash algorithm sha1 is not the only one present.

Since collision attacks exist for SHA-1 such value should be accompanied by a second cryptographically stronger hash. This will allow users to double check the results.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_identification_helper/hashes[]/file_hashes
  /product_tree/full_product_names[]/product_identification_helper/hashes[]/file_hashes
  /product_tree/relationships[]/full_product_name/product_identification_helper/hashes[]/file_hashes

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "name": "Product A",
        "product_id": "CSAFPID-9080700",
        "product_identification_helper": {
          "hashes": [
            {
              "file_hashes": [
                {
                  "algorithm": "sha1",
                  "value": "e067035314dd8673fe1c9fc6b01414fe0950fdc4"
                }
              ],
              "filename": "product_a.so"
            }
          ]
        }
      }
    ]
  }

The hash algorithm sha1 is used in one item of hashes without being accompanied by a second hash algorithm.

 6.2.10 Missing TLP label (obsolete)

The TLP label is now required by the schema. Therefore, the recommended test is obsolete. This section is kept to document that change and keep the numbering of the remaining sections stable. The test is excluded from any preset and requirement to be executed.

 6.2.11 Missing Canonical URL

It MUST be tested that the CSAF document has a canonical URL.

To implement this test it is deemed sufficient that one item in /document/references fulfills all of the following:

The relevant path for this test is:

  /document/references

Example 1 (which fails the test):

  "document": {
    // ...
    "references": [
      {
        "category": "self",
        "summary": "A non-canonical URL.",
        "url": "https://example.com/security/data/csaf/2024/oasis_csaf_tc-csaf_2.1-2024-6-2-11-01_1.json"
      }
    ],
    // ...
    "tracking": {
      // ...
      "id": "OASIS_CSAF_TC-CSAF_2.1-2024-6-2-11-01",
      // ...
      "version": "1"
    },
    // ...
  }

The only element where the category is self has a URL that does not fulfill the requirement of a valid filename for a CSAF document.

 6.2.12 Missing Document Language

It MUST be tested that the document language is present and set.

The relevant path for this test is:

  /document/lang

Example 1 (which fails the test):

  "document": {
    "category": "csaf_base",
    "csaf_version": "2.1",
    "distribution": {
      "tlp": {
        "label": "CLEAR"
      }
    },
    "publisher": {
      // ...
    },
    // ...
  }

The document language is not defined.

 6.2.13 Sorting

It MUST be tested that all keys in a CSAF document are sorted alphabetically.

The relevant path for this test is:

  /

Example 1 (which fails the test):

  "document": {
    "csaf_version": "2.1",
    "category": "csaf_base",
    // ...
  }

The key csaf_version is not at the right place.

A tool MAY sort the keys as a quick fix.

 6.2.14 Use of Private Language

For each element of type /$defs/lang_t it MUST be tested that the language code does not contain subtags reserved for private use.

The relevant paths for this test are:

  /document/lang
  /document/source_lang

Example 1 (which fails the test):

  "lang": "qtx"

The language code qtx is reserved for private use.

A tool MAY remove such subtag as a quick fix.

 6.2.15 Use of Default Language

For each element of type /$defs/lang_t it MUST be tested that the language code is not i-default.

The relevant paths for this test are:

  /document/lang
  /document/source_lang

Example 1 (which fails the test):

  "lang": "i-default"

The language code i-default is used.

A tool MAY remove such element as a quick fix.

 6.2.16 Missing Product Identification Helper

For each element of type /$defs/full_product_name_t it MUST be tested that it includes the property product_identification_helper.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product
  /product_tree/full_product_names[]
  /product_tree/relationships[]/full_product_name

Example 1 (which fails the test):

    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]

The product CSAFPID-9080700 does not provide any Product Identification Helper at all.

 6.2.17 CVE in field IDs

For each item in /vulnerabilities[]/ids it MUST be tested that it is not a CVE ID.

It is sufficient to check, whether the property text matches the regex ^CVE-[0-9]{4}-[0-9]{4,}$.

The relevant paths for this test are:

  /vulnerabilities[]/ids[]

Example 1 (which fails the test):

      "ids": [
        {
          "system_name": "CVE Project",
          "text": "CVE-2021-44228"
        }
      ]

The CVE-2021-44228 is listed in an item of the ids array instead under cve.

A tool MAY set such element as value for the cve property as a quick fix, if that didn’t exist before. Alternatively, it MAY remove such element as a quick fix.

 6.2.18 Product Version Range without vers

For each element of type /$defs/branches_t with category of product_version_range it MUST be tested that the value of name conforms the vers specification.

To implement this test it is deemed sufficient that the value of name matches the following regex:

  ^vers:[a-z\\.\\-\\+][a-z0-9\\.\\-\\+]*/.+

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/name

Example 1 (which fails the test):

            "branches": [
              {
                "category": "product_version_range",
                "name": ">4.2",
                // ...
              }
            ]

The version range >4.2 is a valid vsl but not valid according to the vers specification.

 6.2.19 CVSS for Fixed Products

For each item the fixed products group (first_fixed and fixed) it MUST be tested that a CVSS applying to this product has an environmental score of 0. The test SHALL pass if none of the Product IDs listed within product status fixed or first_fixed is found in products of any item of the metrics element.

The relevant path for this test is:

  /vulnerabilities[]/product_status/first_fixed[]
  /vulnerabilities[]/product_status/fixed[]

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]
  },
  "vulnerabilities": [
    {
      "product_status": {
        "fixed": [
          "CSAFPID-9080700"
        ]
      },
      "metrics": [
        {
          "content": {
            "cvss_v3": {
              "baseScore": 6.5,
              "baseSeverity": "MEDIUM",
              "vectorString": "CVSS:3.1/AV:L/AC:L/PR:H/UI:R/S:U/C:H/I:H/A:H",
              "version": "3.1"
            }
          }          ,
          "products": [
            "CSAFPID-9080700"
          ]
        }
      ]
    }
  ]

Neither the environmentalScore nor the properties modifiedAvailabilityImpact, modifiedConfidentialityImpact, modifiedIntegrityImpact nor the corresponding attributes in the vectorString have been set.

A tool MAY remove any Product IDs listed within product status fixed or first_fixed from products of all items of the metrics element.

Alternatively, a tool MAY set those environmental properties according to the CVSS version used that reduce score to 0 and compute the environmentalScore as quick fix. The following environmental properties have been identified:

 6.2.20 Additional Properties

It MUST be tested that there is no additional property in the CSAF document that was not defined in the CSAF JSON schema. This also applies for referenced schemas.

The relevant path for this test is:

  /

To implement this test it is deemed sufficient to validate the CSAF document against a “strict” version schema that has all references integrated and sets additionalProperties respectively unevaluatedProperties to false at all appropriate places to detect additional properties.

Example 1 (which fails the test):

            "cvss_v3": {
              "baseScore": 6.4,
              "baseSeverity": "MEDIUM",
              "custom_property": "any",
              "vectorString": "CVSS:3.1/AV:L/AC:H/PR:L/UI:N/S:C/C:N/I:H/A:L",
              "version": "3.1"
            }

The key custom_property is not defined in the JSON schema.

A tool MAY remove such keys as a quick fix.

 6.2.21 Same Timestamps in Revision History

It MUST be tested that the timestamps of all items in the revision history are pairwise disjoint. As the timestamps might use different timezones, the comparison MUST take timezones into account.

The relevant path for this test is:

  /document/tracking/revision_history[]/date

Example 1 (which fails the test):

  "revision_history": [
    {
      "date": "2024-01-21T10:00:00.000Z",
      "number": "2.0.0",
      "summary": "Second version."
    },
    {
      "date": "2024-01-21T10:00:00.000Z",
      "number": "1.0.0",
      "summary": "Initial version."
    }
  ]

The first and second revision have the same timestamp.

 6.2.22 Document Tracking ID in Title

It MUST be tested that the /document/title does not contain the /document/tracking/id.

The relevant path for this test is:

  /document/title

Example 1 (which fails the test):

    "title": "OASIS_CSAF_TC-CSAF_2.1-2024-6-2-22-01: Recommended test: Document Tracking ID in Title (failing example 1)",
    "tracking": {
      // ...
      "id": "OASIS_CSAF_TC-CSAF_2.1-2024-6-2-22-01",
      // ...
    }

The document title contains the document tracking id.

A tool MAY remove the document tracking id from the document title. It SHOULD also remove any separating characters including whitespace, colon, dash and brackets.

 6.2.23 Usage of Deprecated CWE

For each item in the CWE array it MUST be tested that the CWE is not deprecated in the given version.

The relevant path for this test is:

  /vulnerabilities[]/cwes[]

Example 1 (which fails the test):

     "cwes": [
        {
          "id": "CWE-596",
          "name": "DEPRECATED: Incorrect Semantic Object Comparison",
          "version": "4.13"
        }
      ]

The CWE-596 is deprecated in version 4.13.

A tool MAY suggest to replace the deprecated CWE with its replacement or closest equivalent.

 6.2.24 Usage of Non-Latest CWE Version

For each item in the CWE array it MUST be tested that the latest CWE version available at the time of the last revision was used. The test SHALL fail if a later CWE version was used.

The relevant path for this test is:

  /vulnerabilities[]/cwes[]

Example 1 (which fails the test):

  "document": {
    // ...
    "tracking": {
      "current_release_date": "2024-01-21T10:00:00.000Z",
      // ...
    }
  },
  "vulnerabilities": [
    {
      "cwes": [
        {
          "id": "CWE-256",
          "name": "Plaintext Storage of a Password",
          "version": "4.12"
        }
      ]
    }
  ]

The CWE version listed is 4.12. However, version 4.13 was most recent version when the document was released on 2024-01-21T10:00:00.000Z.

A tool MAY suggest to use the latest version available at the time of the current_release_date. This is most likely also the overall latest CWE version as modifications to a CSAF document lead to a new current_release_date.

 6.2.25 Usage of CWE Not Allowed for Vulnerability Mapping

For each item in the CWE array it MUST be tested that the vulnerability mapping is allowed.

Currently, this includes the two usage state Allowed and Allowed-with-Review.

The relevant path for this test is:

  /vulnerabilities[]/cwes[]

Example 1 (which fails the test):

      "cwes": [
        {
          "id": "CWE-20",
          "name": "Improper Input Validation",
          "version": "4.13"
        }
      ]

The usage of CWE-20 is discouraged as “is commonly misused in low-information vulnerability reports when lower-level CWEs could be used instead, or when more details about the vulnerability are available”. cite

 6.2.26 Usage of CWE Allowed with Review for Vulnerability Mapping

For each item in the CWE array it MUST be tested that the vulnerability mapping is allowed without review.

Reasoning: CWEs marked with a vulnerability mapping state of Allowed-with-Review should only be used if a thorough review was done. This test helps to flag such mappings which can be used to trigger processes that ensure the extra review, e.g. by a senior analyst.

The relevant path for this test is:

  /vulnerabilities[]/cwes[]

Example 1 (which fails the test):

      "cwes": [
        {
          "id": "CWE-1023",
          "name": "Incomplete Comparison with Missing Factors",
          "version": "4.13"
        }
      ]

The usage of CWE-1023 is allowed with review as the “CWE entry is a Class and might have Base-level children that would be more appropriate”. cite

 6.2.27 Discouraged Product Status Remediation Combination

For each item in /vulnerabilities[]/remediations it MUST be tested that a Product is not member of a discouraged product status group remediation category combination. This takes indirect relations through Product Groups into account.

The relevant path for this test is:

  /vulnerabilities[]/remediations[]

Example 1 (which fails the test):

      "product_status": {
        "known_not_affected": [
          "CSAFPID-9080700"
        ]
      },
      "remediations": [
        {
          "category": "fix_planned",
          "details": "The fix should be available in Q4 2024.",
          "product_ids": [
            "CSAFPID-9080700"
          ]
        }
      ]

For the product with product ID CSAFPID-908070 a fix is planned but the product was not affected at all.

 6.2.28 Usage of Max UUID

It MUST be tested that the Max UUID is not used as sharing group id.

The relevant path for this test is:

  /document/distribution/sharing_group/id

Example 1 (which fails the test):

    "distribution": {
      "sharing_group": {
        "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
        "name": "Public"
      },
      // ...
    },

The sharing group id uses the Max UUID.

A tool MAY remove the property sharing_group as a quick fix.

 6.2.29 Usage of Nil UUID

It MUST be tested that the Nil UUID is not used as sharing group id.

The relevant path for this test is:

  /document/distribution/sharing_group/id

Example 1 (which fails the test):

    "distribution": {
      "sharing_group": {
        "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
        "name": "Public"
      },
      // ...
    },

The sharing group id uses the Nil UUID.

A tool MAY remove the property sharing_group as a quick fix.

 6.2.30 Usage of Sharing Group on TLP:CLEAR

It MUST be tested that no sharing group is used if the document is TLP:CLEAR.

The relevant path for this test is:

  /document/distribution/sharing_group

Example 1 (which fails the test):

    "distribution": {
      "sharing_group": {
        "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
        "name": "Public"
      },
      "tlp": {
        "label": "CLEAR"
      }
    },

The CSAF document is TLP:CLEAR but a sharing group is given.

A tool MAY remove the property sharing_group as a quick fix.

 6.2.31 Hardware and Software

For each product containing at least one of the Product Identification Helpers serial_numbers or model_numbers it MUST be tested that a relationship exists referencing this product.

This tests detects a potential situation where hardware and software have been mixed in the product_tree. Note: This test will fail if the CSAF document contains in its product_tree only hardware. However, this is expected and considered a good reason for the test to fail. This does not make the CSAF document invalid.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_id
  /product_tree/full_product_names[]/product_id
  /product_tree/relationships[]/full_product_name/product_id

Example 1 (which fails the test):

  "product_tree": {
    "branches": [
      {
        "branches": [
          {
            "branches": [
              {
                "category": "product_version",
                "name": "4.1",
                "product": {
                  "name": "Example Company Controller A Firmware 4.1",
                  "product_id": "CSAFPID-908070601",
                  "product_identification_helper": {
                    "serial_numbers": [
                      "143-D-354"
                    ]
                  }
                }
              }
            ],
            "category": "product_name",
            "name": "Controller A"
          }
        ],
        "category": "vendor",
        "name": "Example Company"
      }
    ]
  }

The product_tree mentions the hardware product Example Company Controller A and combines it with the Firmware version 4.1.

 6.2.32 Use of same Product Identification Helper for different Products

For each Product Identification Helper category it MUST be tested that the same value is not used for multiple products in this category.

This test detects a potentially incorrect constructed product tree. Note: This test will fail if the CSAF document contains in its product_tree the old and new name of a product that was renamed. However, this is expected and considered a good reason for the test to fail. This does not make the CSAF document invalid.

For the comparison, arrays need to be treated as unordered sets which need to be pairwise disjoint. When comparing two helper-objects’ array properties whose items are themselves JSON objects (e.g. hashes or file_hashes), the array needs to be treated as an unordered set, and each object is compared by deep-equality of its key/value pairs (ignoring key‐order).

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_identification_helper
  /product_tree/full_product_names[]/product_id/product_identification_helper
  /product_tree/relationships[]/full_product_name/product_id/product_identification_helper

Example 1 (which fails the test):

  "product_tree": {
    "branches": [
      {
        "branches": [
          {
            "branches": [
              {
                "category": "product_version",
                "name": "1.0",
                "product": {
                  "name": "Example Company Product A 1.0",
                  "product_id": "CSAFPID-908070601",
                  "product_identification_helper": {
                    "serial_numbers": [
                      "143-D-354"
                    ]
                  }
                }
              },
              {
                "category": "product_version",
                "name": "2.0",
                "product": {
                  "name": "Example Company Product A 2.0",
                  "product_id": "CSAFPID-908070602",
                  "product_identification_helper": {
                    "serial_numbers": [
                      "143-D-354"
                    ]
                  }
                }
              }
            ],
            "category": "product_name",
            "name": "Product A"
          }
        ],
        "category": "vendor",
        "name": "Example Company"
      }
    ]
  }

Both products are identified by the same serial number 143-D-354.

 6.2.33 Disclosure Date newer than Revision History

For each vulnerability, it MUST be tested that the disclosure_date is earlier or equal to the date of the newest item of the revision_history if the disclosure_date is in the past at the time of the test execution. As the timestamps might use different timezones, the sorting MUST take timezones into account.

The result of the test is dependent upon the time of the execution of the test - it might change for a given CSAF document over time. However, the latest version of a CSAF document should always pass the test.

The relevant path for this test is:

    /vulnerabilities[]/disclosure_date

Example 1 (which fails the test):

  "document": {
    // ...
    "distribution": {
      "tlp": {
        "label": "GREEN"
      }
    },
    // ...
    "tracking": {
      "current_release_date": "2024-01-24T10:00:00.000Z",
      // ...
      "initial_release_date": "2024-01-24T10:00:00.000Z",
      "revision_history": [
        {
          "date": "2024-01-24T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        }
      ],
      "status": "final",
      "version": "1"
    }
  },
  "vulnerabilities": [
    {
      "disclosure_date": "2024-02-24T10:00:00.000Z"
    }
  ]

The disclosure_date is in the past but newer than the date of newest item in the revision_history.

 6.2.34 Usage of Unregistered SSVC Decision Point Namespace

For each SSVC decision point given under selections, it MUST be tested the namespace is one of the case-sensitive registered namespaces.

The relevant path for this test is:

   /vulnerabilities[]/metrics[]/content/ssvc_v1/selections[]/namespace

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "cve": "CVE-1900-0001",
      "metrics": [
        {
          "content": {
            "ssvc_v1": {
              "id": "CVE-1900-0001",
              "schemaVersion": "1-0-1",
              "selections": [
                {
                  "name": "Technical Impact",
                  "namespace": "some-yet-unknown-or-maybe-private-namespace",
                  "values": [
                    "Total"
                  ],
                  "version": "1.0.0"
                }
              ],
              "timestamp": "2024-01-24T10:00:00.000Z"
            }
          },
          // ...
        }
      ]
    }
  ]

The namespace some-yet-unknown-or-maybe-private-namespace is not a registered namespace. Its decision point definitions might therefore not be known to the reader of the document.

 6.2.35 Usage of Private SSVC Decision Point Namespace in TLP:CLEAR Document

For each SSVC decision point given under selections, it MUST be tested the namespace is not a private one if the document is labeled TLP:CLEAR.

The relevant path for this test is:

   /vulnerabilities[]/metrics[]/content/ssvc_v1/selections[]/namespace

Example 1 (which fails the test):

  {
    "document": {
      // ...
      "distribution": {
        "tlp": {
          "label": "CLEAR"
        }
      },
      // ...
    }
    "vulnerabilities": [
      {
        "cve": "CVE-1900-0001",
        "metrics": [
          {
            "content": {
              "ssvc_v1": {
                "id": "CVE-1900-0001",
                "schemaVersion": "1-0-1",
                "selections": [
                  {
                    "name": "Technical Impact",
                    "namespace": "x_custom",
                    "values": [
                      "Total"
                    ],
                    "version": "1.0.0"
                  }
                ],
                "timestamp": "2024-01-24T10:00:00.000Z"
              }
            },
            // ...
          }
        ]
      }
    ]
  }

The namespace x_custom is a private namespace. Its decision point definitions might therefore not be known to the reader of the document.

 6.2.36 Usage of SSVC Decision Point Namespace with Extension in TLP:CLEAR Document

For each SSVC decision point given under selections, it MUST be tested the namespace does not use an extension if the document is labeled TLP:CLEAR.

The relevant path for this test is:

   /vulnerabilities[]/metrics[]/content/ssvc_v1/selections[]/namespace

Example 1 (which fails the test):

  {
    "document": {
      // ...
      "distribution": {
        "tlp": {
          "label": "CLEAR"
        }
      },
      // ...
    }
    "vulnerabilities": [
      {
        "cve": "CVE-1900-0001",
        "metrics": [
          {
            "content": {
              "ssvc_v1": {
                "id": "CVE-1900-0001",
                "schemaVersion": "1-0-1",
                "selections": [
                  {
                    "name": "Technical Impact",
                    "namespace": "ssvc/additional-technical-impacts",
                    "values": [
                      "Total"
                    ],
                    "version": "1.0.0"
                  }
                ],
                "timestamp": "2024-01-24T10:00:00.000Z"
              }
            },
            // ...
          }
        ]
      }
    ]
  }

The namespace contains the extension additional-technical-impacts. Its decision point definitions might therefore not be known to the reader of the document.

 6.2.37 Usage of Unknown SSVC Role

For each SSVC object, it MUST be tested the role is one of the case-sensitive registered roles.

The relevant path for this test is:

   /vulnerabilities[]/metrics[]/content/ssvc_v1/role

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "cve": "CVE-1900-0001",
      "metrics": [
        {
          "content": {
            "ssvc_v1": {
              "id": "CVE-1900-0001",
              "role": "An unregistered role",
              "schemaVersion": "1-0-1",
              "selections": [
                {
                  "name": "Technical Impact",
                  "namespace": "ssvc",
                  "values": [
                    "Total"
                  ],
                  "version": "1.0.0"
                }
              ],
              "timestamp": "2024-01-24T10:00:00.000Z"
            }
          },
          // ...
        }
      ]
    }
  ]

The role An unregistered role is not a registered role. Its structure might therefore not be known to the reader of the document.

 6.2.38 Usage of Deprecated Profile

It MUST be tested that the /document/category does not start with csaf_deprecated_.

The relevant path for this test is:

   /document/category

Example 1 (which fails the test):

    "category": "csaf_deprecated_security_advisory",

The document category starts with csaf_deprecated_.

 6.2.39 Profile Tests

This subsubsection structures the recommended tests for the profiles. Not all tests apply for all profiles. Tests SHOULD be skipped if the document category does not match the one given in the test. Each of the following tests SHOULD be treated as they where listed similar to the other tests.

 6.2.39.1 Missing Fixed Product

For each product listed in the product status group affected in any vulnerability, it MUST be tested that a corresponding version of the product is listed as fixed in the same vulnerability. The test MUST be skipped if there is a clear indication, that such a version of the product does not exist. Indicators include a remediation item with one of the categories fix_planned, no_fix_planned or none_available referring to the affected product. The test MUST NOT be skipped, if there is an indication, that such a version of the product might exist. Indicators include an affected product version range with the comparator < in the last version constraint and a remediation item with the categories vendor_fix referring to the affected product.

The relevant value for /document/category is:

  csaf_security_advisory

The relevant path for this test is:

  /vulnerabilities[]/product_status

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      // ...
      "product_status": {
        "known_affected": [
          "CSAFPID-9080700"
        ]
      },
      "remediations": [
        {
          "category": "vendor_fix",
          "details": "Update to the latest version, at least version 4.2.",
          "product_ids": [
            "CSAFPID-9080700"
          ]
        }
      ]
    }
  ]

The fixed product is not listed in the advisory but there is a clear indication that such product exists as there is a remediation with category vendor_fix.

A tool MAY create the missing fixed product based on the data available in the advisory as a quick fix.

 6.2.39.2 Language Specific Reasoning for Withdrawal

If the document language is specified but not English, it MUST be tested that exactly one item in document notes exists that has the language specific translation of the term Reasoning for Withdrawal as title. The category of this item MUST be description. If no language specific translation has been recorded, the test MUST be skipped and output an information to the user that no such translation is known.

A list of the language specific translations is kept at the OASIS CSAF TC.

The relevant value for /document/category is:

  csaf_withdrawn

The relevant path for this test is:

  /document/notes

Example 1 (which fails the test):

    "notes": [
      {
        "category": "summary",
        "text": "Das CSAF Document enthielt Beispieldaten und wurde zurückgezogen, um Testdaten zu erzeugen.",
        "title": "Begründung für die Zurückziehung"
      }
    ],

The note has the correct title. However, it uses the wrong category.

 6.2.39.3 Language Specific Reasoning for Supersession

If the document language is specified but not English, it MUST be tested that exactly one item in document notes exists that has the language specific translation of the term Reasoning for Supersession as title. The category of this item MUST be description. If no language specific translation has been recorded, the test MUST be skipped and output an information to the user that no such translation is known.

A list of the language specific translations is kept at the OASIS CSAF TC.

The relevant value for /document/category is:

  csaf_superseded

The relevant path for this test is:

  /document/notes

Example 1 (which fails the test):

    "notes": [
      {
        "category": "summary",
        "text": "Das CSAF Dokument enthielt Beispieldaten und wurde ersetzt, um Testdaten zu erzeugen.",
        "title": "Begründung für die Ersetzung"
      }
    ],

The note has the correct title. However, it uses the wrong category.

 6.2.39.4 Language Specific Superseding Document

If the document language is specified but not English, it MUST be tested that at least one item in document references exists that starts with the language specific translation of the term Superseding Document as summary. The category of this item MUST be external. If no language specific translation has been recorded, the test MUST be skipped and output an information to the user that no such translation is known.

A list of the language specific translations is kept at the OASIS CSAF TC.

The relevant value for /document/category is:

  csaf_superseded

The relevant path for this test is:

  /document/references

Example 1 (which fails the test):

    "references": [
      {
        "category": "self",
        "summary": "Ersetztes Dokument",
        "url": "https://example.com/.well-known/csaf/clear/2024/esa-2024-1234.json"
      }
    ],

The note has the correct title. However, it uses the wrong category.

 6.2.40 Product Description without Product Reference

For each product description it MUST be tested that it includes at least one of the elements group_ids or product_ids.

If the document language is English or unspecified, the product description can be identified by checking for a note containing the corresponding category and title combination from sec. For other languages, the language specific translation is used.

If no language specific translation has been recorded, the test MUST be skipped and output an information to the user that no translation for product description is known.

The relevant path for this test is:

  /document/notes[]

Example 1 (which fails the test):

    "notes": [
      {
        "category": "description",
        "text": "Product A is a local time tracking tool. It is mainly used by software developers and can be connected with most modern time-tracking systems.",
        "title": "Product Description"
      }
    ],

The given note item does not specify to which products it applies to.

 6.2.41 Old EPSS Timestamp

For each vulnerability, it MUST be tested that the youngest EPSS timestamp is not more than 15 days older than to the date of the newest item of the revision_history if the document status is final or interim. As the timestamps might use different timezones, the sorting MUST take timezones into account.

The relevant path for this test is:

    /vulnerabilities[]/metrics[]/content/epss/timestamp

Example 1 (which fails the test):

  "document": {
    // ...
    "distribution": {
      "tlp": {
        "label": "CLEAR"
      }
    },
    // ...
    "tracking": {
      // ...
      "revision_history": [
        {
          "date": "2024-01-24T10:00:00.000Z",
          "number": "1",
          "summary": "Initial version."
        }
      ],
      "status": "final",
      // ...
    }
  },
  "vulnerabilities": [
    {
      "cve": "CVE-1900-0001",
      "metrics": [
        {
          "content": {
            "epss": {
              "percentile": "0.999990000",
              "probability": "0.975570000",
              "timestamp": "2024-07-13T10:00:00.000Z"
            }
          },
          "products": [
            "CSAFPID-9080700"
          ]
        }
      ]
    }
  ]

The document is in status final but the EPSS timestamp is more than 15 days older than the date of newest item in the revision_history.

 6.2.42 Inconsistent Product Identification Helper

For each product identification helper which resides in branches, it MUST be tested that the product identification helper contain at least the same information as the categorized strings. Information that cannot be represented in the specific product identification helper MUST be omitted from the comparison.

To implement this test it is deemed sufficient to follow the process below. It is based on a static mapping of branch categories to the corresponding part of the product identification helpers. The latter one are referred to as counterparts.

  1. Determine counterpart in the specific product identification helper for all categories used along the path up to the product.
  2. Check whether the counterparts in the product identification helper are set.
  3. Check whether each set counterpart does not contain a wildcard unless the value of the categorized string would indicate that.
  4. Check whether the version part algins between the categorized strings and the product identification helper.
  5. For CPE only: Check whether extra information is included in the CPE that is not in the categorized string.
    This might be a counterpart that is set but the corresponding categorized string is missing along th path.

The relevant paths for this test are:

    /product_tree/branches[](/branches[])*/product/product_identification_helper/cpe
    /product_tree/branches[](/branches[])*/product/product_identification_helper/purl

Example 1 (which fails the test):

  "product_tree": {
    "branches": [
      {
        "category": "vendor",
        "name": "Example Company",
        "branches": [
          {
            "category": "product_name",
            "name": "Product A",
            "branches": [
              {
                "category": "product_version",
                "name": "2.2.0",
                "product": {
                  "product_id": "CSAFPID-9080700",
                  "name": "Example Company Product A 2.2.0",
                  "product_identification_helper": {
                    "cpe": "cpe:2.3:h:example:product_a:2.2.0:*:*:de:*:*:*:*"
                  }
                }
              },
              {
                "category": "product_version",
                "name": "2.3.0",
                "product": {
                  "product_id": "CSAFPID-9080701",
                  "name": "Example Company Product A 2.3.0",
                  "product_identification_helper": {
                    "cpe": "cpe:2.3:h:example:product_a:2.3.0:PL17:*:*:*:*:*:*"
                  }
                }
              }
            ]
          }
        ]
      }
    ]
  }

The CPE of the first product contains a language part that is not given through the categorized strings. The CPE of the second product contains an update part that is not given through the categorized strings.

 6.2.43 Missing License Expression

It MUST be tested that the license expression is present and set.

The relevant path for this test is:

  /document/license_expression

Example 1 (which fails the test):

  "document": {
    // ...
    "lang": "en-US",
    "publisher": {
      // ...
    },
    // ...
  }

The license expression is not defined.

 6.2.44 Deprecated License Identifier

It MUST be tested that all license identifier and exceptions used are not deprecated. This SHALL be tested for the SPDX license list and Aboutcode’s “ScanCode LicenseDB”. The test MAY be skipped for other license inventoring entities.

The relevant path for this test is:

  /document/license_expression

Example 1 (which fails the test):

  "license_expression": "GFDL-1.1",

The license identifier GFDL-1.1 was deprecated as of version 3.0.

 6.2.45 Non-Existing License Identifier

It MUST be tested that all license identifier and exceptions used exist. This SHALL be tested for the SPDX license list and Aboutcode’s “ScanCode LicenseDB”. The test MAY be skipped for other license inventoring entities.

The relevant path for this test is:

  /document/license_expression

Example 1 (which fails the test):

  "license_expression": "A-License-Identifier-That-Does-Not-Exist",

The license identifier does not exist in the SPDX license list.

 6.2.46 Language Specific License Text

If the document language is specified but not English, and the license_expression contains license identifiers or exceptions that are not listed in the SPDX license list or Aboutcode’s “ScanCode LicenseDB”, it MUST be tested that exactly one item in document notes exists that has the language specific translation of the term License as title. The category of this item MUST be legal_disclaimer. If no language specific translation has been recorded, the test MUST be skipped and output an information to the user that no such translation is known.

The relevant path for this test is:

  /document/notes

Example 1 (which fails the test):

  "document": {
    // ...
    "lang": "de-DE",
    "license_expression": "LicenseRef-www.example.com-no-work",
    "notes": [
      {
        "category": "summary",
        "text": "Es handelt sich nicht um ein urheberrechtliches Werk, da die Schöpfungshöhe nicht erreicht ist.",
        "title": "Lizenz"
      }
    ],
    // ...
  }

The note has the correct title. However, it uses the wrong category.

 6.3 Informative Tests

Informative tests provide insights in common mistakes and bad practices. They MAY fail at a valid CSAF document. It is up to the issuing party to decide whether this was an intended behavior and can be ignore or should be treated. These tests MAY include information about recommended usage. A program MUST handle a test failure as a information.

 6.3.1 Use of CVSS v2 as the only Scoring System

For each item in the list of metrics which contains the cvss_v2 object under content it MUST be tested that is not the only scoring item present. The test SHALL pass if a second scoring object is available regarding the specific product.

One source might just provide CVSS v2. As long as at least one different source provides a different scoring system for the same products, the test passes.

The relevant path for this test is:

    /vulnerabilities[]/metrics

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]
  },
  "vulnerabilities": [
    {
      "metrics": [
        {
          "content": {
            "cvss_v2": {
              "version": "2.0",
              "vectorString": "AV:N/AC:L/Au:N/C:C/I:C/A:C",
              "baseScore": 10
            }
          },
          "products": [
            "CSAFPID-9080700"
          ]
        }
      ]
    }
  ]

There is only a CVSS v2 score given for CSAFPID-9080700.

Recommendation:

It is recommended to (also) use the CVSS v4.0.

 6.3.2 Use of CVSS v3.0

For each item in the list of metrics which contains the cvss_v3 object under content it MUST be tested that CVSS v3.0 is not used.

The relevant paths for this test are:

  /vulnerabilities[]/metrics[]/content/cvss_v3/version
  /vulnerabilities[]/metrics[]/content/cvss_v3/vectorString

Example 1 (which fails the test):

  "cvss_v3": {
    "version": "3.0",
    "vectorString": "CVSS:3.0/AV:L/AC:L/PR:H/UI:R/S:U/C:H/I:H/A:H",
    "baseScore": 6.5,
    "baseSeverity": "MEDIUM"
  }

The CVSS v3.0 is used.

Recommendation:

It is recommended to upgrade to CVSS v3.1.

A tool MAY upgrade to CVSS v3.1 as quick fix. However, if such quick fix is supported the tool SHALL also recompute the baseScore and baseSeverity. The same applies for temporalScore and temporalSeverity respectively environmentalScore and environmentalSeverity if the necessary fields for computing their value are present and set.

 6.3.3 Missing CVE

It MUST be tested that the CVE number is given.

The relevant path for this test is:

  /vulnerabilities[]/cve

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "title": "BlueKeep"
    }
  ]

The CVE number is not given.

Recommendation:

It is recommended to provide a CVE number to support the users efforts to find more details about a vulnerability and potentially track it through multiple advisories. If no CVE exists for that vulnerability, it is recommended to get one assigned.

 6.3.4 Missing CWE

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

The relevant path for this test is:

  /vulnerabilities[]/cwes

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "cve": "CVE-2019-0708",
      "title": "BlueKeep"
    }
  ]

No CWE number is given.

 6.3.5 Use of Short Hash

It MUST be tested that the length of the hash value is not shorter than 64 characters.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/product/product_identification_helper/hashes[]/file_hashes[]/value
  /product_tree/full_product_names[]/product_identification_helper/hashes[]/file_hashes[]/value
  /product_tree/relationships[]/full_product_name/product_identification_helper/hashes[]/file_hashes[]/value

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "name": "Product A",
        "product_id": "CSAFPID-9080700",
        "product_identification_helper": {
          "hashes": [
            {
              "file_hashes": [
                {
                  "algorithm": "md4",
                  "value": "3202b50e2e5b2fcd75e284c3d9d5f8d6"
                }
              ],
              "filename": "product_a.so"
            }
          ]
        }
      }
    ]
  }

The length of the hash value is only 32 characters long.

 6.3.6 Use of non-self referencing URLs Failing to Resolve

For each URL which is not in the category self it MUST be tested that it resolves with a HTTP status code from the 2xx (Successful) or 3xx (Redirection) class.

This test does not apply for any item in an array of type references_t with the category self. For details about the HTTP status code classes see [RFC7231].

The relevant paths for this test are:

  /document/acknowledgments[]/urls[]
  /document/aggregate_severity/namespace
  /document/distribution/tlp/url
  /document/references[]/url
  /document/publisher/namespace
  /product_tree/branches[]/product/product_identification_helper/sbom_urls[]
  /product_tree/branches[]/product/product_identification_helper/x_generic_uris[]/namespace
  /product_tree/branches[]/product/product_identification_helper/x_generic_uris[]/uri
  /product_tree/branches[](/branches[])*/product/product_identification_helper/sbom_urls[]
  /product_tree/branches[](/branches[])*/product/product_identification_helper/x_generic_uris[]/namespace
  /product_tree/branches[](/branches[])*/product/product_identification_helper/x_generic_uris[]/uri
  /product_tree/full_product_names[]/product_identification_helper/sbom_urls[]
  /product_tree/full_product_names[]/product_identification_helper/x_generic_uris[]/namespace
  /product_tree/full_product_names[]/product_identification_helper/x_generic_uris[]/uri
  /product_tree/relationships[]/full_product_name/product_identification_helper/sbom_urls[]
  /product_tree/relationships[]/full_product_name/product_identification_helper/x_generic_uris[]/namespace
  /product_tree/relationships[]/full_product_name/product_identification_helper/x_generic_uris[]/uri
  /vulnerabilities[]/acknowledgments[]/urls[]
  /vulnerabilities[]/references[]/url
  /vulnerabilities[]/remediations[]/url

Example 1 (which fails the test):

    "references": [
      {
        "summary": "A URL that does not resolve with HTTP status code in the interval between (including) 200 and (excluding) 400.",
        "url": "https://example.invalid"
      }
    ]

The category is not set and therefore treated as its default value external. A request to that URL does not resolve with a status code from the 2xx (Successful) or 3xx (Redirection) class.

 6.3.7 Use of self referencing URLs Failing to Resolve

For each item in an array of type references_t with the category self it MUST be tested that the URL referenced resolves with a HTTP status code less than 400.

This test will most likely fail if the CSAF document is in a status before the initial release. For details about the HTTP status code classes see [RFC7231].

The relevant paths for this test are:

  /document/references[]/url
  /vulnerabilities[]/references[]/url

Example 1 (which fails the test):

    "references": [
      {
        "category": "self",
        "summary": "A URL that does not resolve with HTTP status code in the interval between (including) 200 and (excluding) 400.",
        "url": "https://example.invalid"
      }
    ]

The category is self and a request to that URL does not resolve with a status code from the 2xx (Successful) or 3xx (Redirection) class.

 6.3.8 Spell Check

If the document language is given it MUST be tested that a spell check for the given language does not find any mistakes. The test SHALL be skipped if the document language is not set. It SHALL fail if the given language is not supported. The value of /document/category SHOULD NOT be tested if the CSAF document does not use the profile “CSAF Base”.

The relevant paths for this test are:

  /document/acknowledgments[]/names[]
  /document/acknowledgments[]/organization
  /document/acknowledgments[]/summary
  /document/aggregate_severity/text
  /document/category
  /document/distribution/text
  /document/notes[]/audience
  /document/notes[]/text
  /document/notes[]/title
  /document/publisher/issuing_authority
  /document/publisher/name
  /document/references[]/summary
  /document/title
  /document/tracking/aliases[]
  /document/tracking/generator/engine/name
  /document/tracking/revision_history[]/summary
  /product_tree/branches[](/branches[])*/name
  /product_tree/branches[](/branches[])*/product/name
  /product_tree/branches[]/name
  /product_tree/branches[]/product/name
  /product_tree/full_product_names[]/name
  /product_tree/product_groups[]/summary
  /product_tree/relationships[]/full_product_name/name
  /vulnerabilities[]/acknowledgments[]/names[]
  /vulnerabilities[]/acknowledgments[]/organization
  /vulnerabilities[]/acknowledgments[]/summary
  /vulnerabilities[]/involvements[]/summary
  /vulnerabilities[]/notes[]/audience
  /vulnerabilities[]/notes[]/text
  /vulnerabilities[]/notes[]/title
  /vulnerabilities[]/references[]/summary
  /vulnerabilities[]/remediations[]/details
  /vulnerabilities[]/remediations[]/entitlements[]
  /vulnerabilities[]/remediations[]/restart_required/details
  /vulnerabilities[]/threats[]/details
  /vulnerabilities[]/title

Example 1 (which fails the test):

  "document": {
    // ...
    "lang": "en",
    "notes": [
      {
        "category": "summary",
        "text": "Secruity researchers found multiple vulnerabilities in XYZ."
      }
    ],
    // ...
  }

There is a spelling mistake in Secruity.

 6.3.9 Branch Categories

For each element of type /$defs/full_product_name_t in /product_tree/branches it MUST be tested that ancestor nodes along the path exist which use the following branch categories vendor -> product_name -> product_version in that order starting with the Product tree node.

Other branch categories can be used before, after or between the aforementioned branch categories without making the test invalid.

The relevant paths for this test are:

  /product_tree/branches

Example 1 (which fails the test):

    "branches": [
      {
        "category": "vendor",
        "name": "Example Company",
        "branches": [
          {
            "category": "product_name",
            "name": "Product A",
            "branches": [
              {
                "category": "patch_level",
                "name": "91",
                "product": {
                  "product_id": "CSAFPID-0002",
                  "name": "Example Company Product A Update 91"
                }
              }
            ]
          }
        ]
      }
    ]

The product CSAFPID-9080700 does not have any ancestor with the branch category product_version.

 6.3.10 Usage of Product Version Range

For each element of type /$defs/branches_t it MUST be tested that the category is not product_version_range.

It is usually hard decide for machines whether a product version matches a product version ranges. Therefore, it is recommended to avoid version ranges and enumerate versions wherever possible.

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/category

Example 1 (which fails the test):

                "category": "product_version_range",

The category product_version_range was used.

 6.3.11 Usage of V as Version Indicator

For each element of type /$defs/branches_t with category of product_version it MUST be tested that the value of name does not start with v or V before the version.

To implement this test it is deemed sufficient that the value of name does not match the following regex:

  ^[vV][0-9].*$

The relevant paths for this test are:

  /product_tree/branches[](/branches[])*/name

Example 1 (which fails the test):

            "branches": [
              {
                "category": "product_version",
                "name": "v4.2",
                // ...
              }
            ]

The product version starts with a v.

 6.3.12 Missing CVSS v4.0

For each item in the list of metrics it MUST be tested that a cvss_v4 object is present.

The relevant path for this test is:

    /vulnerabilities[]/metrics[]/content

Example 1 (which fails the test):

  "product_tree": {
    "full_product_names": [
      {
        "product_id": "CSAFPID-9080700",
        "name": "Product A"
      }
    ]
  },
  "vulnerabilities": [
    {
      "metrics": [
        {
          "content": {
            "cvss_v3": {
              "version": "3.1",
              "vectorString": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:H/A:H",
              "baseScore": 10,
              "baseSeverity": "CRITICAL"
            }
          },
          "products": [
            "CSAFPID-9080700"
          ]
        }
      ]
    }
  ]

There is no CVSS v4.0 score given for CSAFPID-9080700.

 6.3.13 Usage of Non-Latest SSVC Decision Point Version

For each SSVC decision point given under selections with the namespace of ssvc, it MUST be tested the latest decision point version available at the time of the timestamp was used. The test SHALL fail if a later version was used.

A list of all valid decision points including their values is available at the SSVC repository.

The relevant path for this test is:

   /vulnerabilities[]/metrics[]/content/ssvc_v1/selections[]

Example 1 (which fails the test):

  "vulnerabilities": [
    {
      "cve": "CVE-1900-0001",
      "metrics": [
        {
          "content": {
            "ssvc_v1": {
              "id": "CVE-1900-0001",
              "schemaVersion": "1-0-1",
              "selections": [
                {
                  "name": "Mission Impact",
                  "namespace": "ssvc",
                  "values": [
                    "Non-Essential Degraded"
                  ],
                  "version": "1.0.0"
                }
              ],
              "timestamp": "2024-01-24T10:00:00.000Z"
            }
          },
          // ...
        }
      ]
    }
  ]

At the timestamp 2024-01-24T10:00:00.000Z version 2.0.0 of the SSVC decision point Mission Impact was already available.

 6.3.14 Usage of Private SSVC Decision Point Namespace in non TLP:CLEAR Document

For each SSVC decision point given under selections, it MUST be tested the namespace is not a private one if the document is not labeled TLP:CLEAR.

The relevant path for this test is:

   /vulnerabilities[]/metrics[]/content/ssvc_v1/selections[]/namespace

Example 1 (which fails the test):

  {
    "document": {
      // ...
      "distribution": {
        "tlp": {
          "label": "GREEN"
        }
      },
      // ...
    }
    "vulnerabilities": [
      {
        "cve": "CVE-1900-0001",
        "metrics": [
          {
            "content": {
              "ssvc_v1": {
                "id": "CVE-1900-0001",
                "schemaVersion": "1-0-1",
                "selections": [
                  {
                    "name": "Technical Impact",
                    "namespace": "x_custom",
                    "values": [
                      "Total"
                    ],
                    "version": "1.0.0"
                  }
                ],
                "timestamp": "2024-01-24T10:00:00.000Z"
              }
            },
            // ...
          }
        ]
      }
    ]
  }

The namespace x_custom is a private namespace. Its decision point definitions might therefore not be known to the reader of the document.

 6.3.15 Usage of SSVC Decision Point Namespace with Extension in non TLP:CLEAR Document

For each SSVC decision point given under selections, it MUST be tested the namespace does not use an extension if the document is not labeled TLP:CLEAR.

The relevant path for this test is:

   /vulnerabilities[]/metrics[]/content/ssvc_v1/selections[]/namespace

Example 1 (which fails the test):

  {
    "document": {
      // ...
      "distribution": {
        "tlp": {
          "label": "GREEN"
        }
      },
      // ...
    }
    "vulnerabilities": [
      {
        "cve": "CVE-1900-0001",
        "metrics": [
          {
            "content": {
              "ssvc_v1": {
                "id": "CVE-1900-0001",
                "schemaVersion": "1-0-1",
                "selections": [
                  {
                    "name": "Technical Impact",
                    "namespace": "ssvc/additional-technical-impacts",
                    "values": [
                      "Total"
                    ],
                    "version": "1.0.0"
                  }
                ],
                "timestamp": "2024-01-24T10:00:00.000Z"
              }
            },
            // ...
          }
        ]
      }
    ]
  }

The namespace contains the extension additional-technical-impacts. Its decision point definitions might therefore not be known to the reader of the document.

 6.3.16 Grammar Check

If the document language is given it MUST be tested that a grammar check for the given language does not find any mistakes. The test SHALL be skipped if the document language is not set. It SHALL fail if the given language is not supported.

The relevant paths for this test are:

  /document/acknowledgments[]/summary
  /document/aggregate_severity/text
  /document/distribution/text
  /document/notes[]/audience
  /document/notes[]/text
  /document/notes[]/title
  /document/publisher/issuing_authority
  /document/references[]/summary
  /document/title
  /document/tracking/revision_history[]/summary
  /product_tree/product_groups[]/summary
  /vulnerabilities[]/acknowledgments[]/summary
  /vulnerabilities[]/involvements[]/summary
  /vulnerabilities[]/notes[]/audience
  /vulnerabilities[]/notes[]/text
  /vulnerabilities[]/notes[]/title
  /vulnerabilities[]/references[]/summary
  /vulnerabilities[]/remediations[]/details
  /vulnerabilities[]/remediations[]/entitlements[]
  /vulnerabilities[]/remediations[]/restart_required/details
  /vulnerabilities[]/threats[]/details
  /vulnerabilities[]/title

Example 1 (which fails the test):

  "document": {
    // ...
    "lang": "en",
    "notes": [
      {
        "category": "summary",
        "text": "The security hardening guide must followed for ensure secure operations of a products."
      }
    ],
    // ...
  }

Multiple grammar mistakes exist:

 6.3.17 Use of Unregistered License

It MUST be tested that the all license identifiers and exceptions are listed either in the official SPDX license identifier list or AboutCode’s “ScanCode LicenseDB”.

The relevant path for this test is:

  /document/license_expression

Example 1 (which fails the test):

    "license_expression": "LicenseRef-www.example.com-no-work-pd",

The license_expression contains a license identifier that is neither listed in the official SPDX license identifier list nor AboutCode’s “ScanCode LicenseDB”.

 6.4 Presets

A test preset is a predefined set of tests that was given a name. It MAY contain any number of tests. Two presets MAY overlap. The content of a preset MAY vary in different CSAF versions. A CSAF validator MUST support every official preset that solely include tests that are implemented by the CSAF validator. A CSAF validator MAY provide or support additional presets. A CSAF validator MUST implement all tests for any supported preset. Names of presets not defined in this CSAF standard SHALL have the following prefix before their name:

Official presets are defined in different parts of the standard.

 6.4.1 Presets defined through Test Subsections

The following presets are defined through subsections of the test section:

 6.4.2 Presets defined through Conformance Targets

The following presets are defined through conformance targets:

As presets are sets, the operator + MUST be interpreted as the union operation.

 6.4.3 Additional Presets

Additional presets are defined as follows:

 7. Distributing CSAF documents

This section lists requirements and roles defined for distributing CSAF documents. The first subsection provides all requirements - the second one the roles. It is mandatory to fulfill the basic role “CSAF publisher”. The last section provides specific rules for the process of retrieving CSAF documents.

 7.1 Requirements

The requirements in this subsection are consecutively numbered to be able to refer to them directly. The order does not give any hint about the importance. Not all requirements have to be fulfilled to conform to this specification - the sets of requirements per conformance clause are defined in section 7.2.

 7.1.1 Requirement 1: Valid CSAF document

The document is a valid CSAF document (cf. Conformance clause 1).

 7.1.2 Requirement 2: Filename

The CSAF document has a filename according to the rules in section 5.1.

 7.1.3 Requirement 3: TLS

The CSAF document is per default retrievable from a website which uses TLS for encryption and server authenticity. The CSAF document MUST NOT be downloadable from a location which does not encrypt the transport when crossing organizational boundaries to maintain the chain of custody.

 7.1.4 Requirement 4: TLP:CLEAR

If the CSAF document is labeled TLP:CLEAR, it MUST be freely accessible.

This does not exclude that such a document is also available in an access protected customer portal. However, there MUST be one copy of the document available for people without access to the portal.

Reasoning: If an advisory is already in the media, an end user should not be forced to collect the pieces of information from a press release but be able to retrieve the CSAF document.

 7.1.5 Requirement 5: TLP:AMBER, TLP:AMBER+STRICT and TLP:RED

CSAF documents labeled TLP:AMBER, TLP:AMBER+STRICT or TLP:RED MUST be access protected. If they are provided via a web server this SHALL be done under a different path than for TLP:CLEAR, TLP:GREEN and unlabeled CSAF documents. TLS client authentication, access tokens or any other automatable authentication method SHALL be used.

An issuing party MAY agree with the recipients to use any kind of secured drop at the recipients’ side to avoid putting them on their own website. However, it MUST be ensured that the documents are still access protected.

 7.1.6 Requirement 6: No Redirects

Redirects SHOULD NOT be used. If they are inevitable only HTTP Header redirects are allowed.

Reasoning: Clients should not parse the payload for navigation and some, as e.g. curl, do not follow any other kind of redirects.

If any redirects are used, there SHOULD not be more than 5 and MUST NOT be more than 10 consecutive redirects.

 7.1.7 Requirement 7: provider-metadata.json

The party MUST provide a valid provider-metadata.json according to the schema CSAF provider metadata for its own metadata.
The publisher object SHOULD match the one used in the CSAF documents of the issuing party but can be set to whatever value a CSAF aggregator SHOULD display over any individual publisher values in the CSAF documents themselves.

This information is used to collect the data for CSAF aggregators, listers and end users. The CSAF provider metadata schema ensures the consistency of the metadata for a CSAF provider across the ecosystem. Other approaches, like extracting the publisher object from CSAF documents, are likely to fail if the object differs between CSAF documents.

It is suggested to put the file provider-metadata.json adjacent to the ROLIE feed documents (requirement 15) or in the main directory adjacent to the year folders (requirement 14), changes.csv (requirement 13) and the index.txt (requirement 12). Suggested locations to store the provider-metadata.json are:

Example 1 (minimal with ROLIE document):

  {
    "$schema": "https://docs.oasis-open.org/csaf/csaf/v2.1/schema/provider.json",
    "canonical_url": "https://www.example.com/.well-known/csaf/provider-metadata.json",
    "distributions": [
      {
        "rolie": {
          "feeds": [
            {
              "last_updated": "2024-01-24T20:20:56.169Z",
              "summary": "All TLP:CLEAR advisories of Example Company.",
              "tlp_label": "CLEAR",
              "url": "https://www.example.com/.well-known/csaf/feed-tlp-clear.json"
            }
          ]
        }
      }
    ],
    "last_updated": "2024-01-24T20:20:56.169Z",
    "list_on_CSAF_aggregators": true,
    "metadata_version": "2.1",
    "mirror_on_CSAF_aggregators": true,
    "public_openpgp_keys": [
      {
        "fingerprint": "8F5F267907B2C4559DB360DB2294BA7D2B2298B1",
        "url": "https://keys.example.net/vks/v1/by-fingerprint/8F5F267907B2C4559DB360DB2294BA7D2B2298B1"
      }
    ],
    "publisher": {
      "category": "vendor",
      "name": "Example Company ProductCERT",
      "namespace": "https://psirt.example.com"
    },
    "role": "csaf_trusted_provider"
  }

The maintained_until and maintained_from properties can be used to indicate that the distributions contained in provider-metadata.json at the given canonical_url are only guaranteed to be maintained until or after the specified date and time. This SHOULD be used to support a transition period between CSAF 2.0 and CSAF 2.1 (cf. section sec). CSAF downloaders (cf. section sec) and programs retrieving or providing a provider-metadata.json SHOULD evaluate this property and emit a warning if the current date is less than 90 days away from maintained_until and an error if the current date exceeds maintained_until. The programs MAY provide a non-default option to use the provider-metadata.json anyway. Furthermore, such programs SHOULD evaluate the maintained_from property and output a warning if the current date is still before the maintained_from timestamp.

If a CSAF publisher (cf. section 7.2.1) does not provide the provider-metadata.json, an aggregator SHOULD contact the CSAF publisher in question to determine the values for list_on_CSAF_aggregators and mirror_on_CSAF_aggregators. If that is impossible or if the CSAF publisher is unresponsive the following values MUST be used:

    "list_on_CSAF_aggregators": true,
    "mirror_on_CSAF_aggregators": false

This prevents that CSAF documents of a CSAF publisher which have been collected by one CSAF aggregator A are mirrored again on a second CSAF aggregator B. Such cascades are prone to outdated information. If the first aggregator A collects the CSAF documents on best effort and B copies the files from A and announces that this is done weekly, one might assume that B’s CSAF documents are more recent. However, that is not the case as B’s information depends on A.

 7.1.8 Requirement 8: security.txt

In the security.txt there MUST be at least one field CSAF which points to the provider-metadata.json (requirement 7). If this field indicates a web URI, then it MUST begin with “https://” (as per section 2.7.2 of [RFC7230]).
See [SECURITY-TXT] for more details.

The security.txt was published as [RFC9116] in April 2022. The CSAF field was officially added through the IANA registry.

Examples 1:

CSAF: https://www.example.com/.well-known/csaf/provider-metadata.json
CSAF: https://domain.tld/security/data/csaf/provider-metadata.json
CSAF: https://psirt.domain.tld/advisories/csaf/provider-metadata.json
CSAF: https://domain.tld/security/csaf/provider-metadata.json

It is possible to advertise more than one provider-metadata.json by adding multiple CSAF fields, e.g. in case of changes to the organizational structure through mergers and acquisitions. However, this SHOULD NOT be done and removed as soon as possible. A valid use case for temporarily including multiple entries would be a transition phase between different CSAF versions, in which documents and provider metadata of both versions are served simultaneously (cf. section sec). If one of the URLs fulfills requirement 9, it MUST be set as the first CSAF entry in the security.txt.

 7.1.9 Requirement 9: Well-known URL for provider-metadata.json

The URL path /.well-known/csaf/provider-metadata.json under the main domain of the issuing authority serves directly the provider-metadata.json according to requirement 7. That implies that redirects SHALL NOT be used. The use of the scheme “HTTPS” is required. See [RFC8615] for more details.

Example 1:

  https://www.example.com/.well-known/csaf/provider-metadata.json

As specified in sec, the value of canonical_url MAY differ from the URL that was requested as a part of this requirement. Such state is intended and MUST NOT be reported as error.

 7.1.10 Requirement 10: DNS path

Assuming that the organization’s main domain is domain.tld, the DNS record csaf.data.security.domain.tld SHALL resolve to the IP address of a web server which serves directly the provider-metadata.json according to requirement 7.

The domain.tld is just a placeholder for the organization’s main domain. For the organization with the main domain being example.com, the necessary DNS record is csaf.data.security.example.com.

That implies that redirects SHALL NOT be used. The use of the scheme “HTTPS” is required.

 7.1.11 Requirement 11: One folder per year

The CSAF documents MUST be located within folders named <YYYY> where <YYYY> is the year given in the value of /document/tracking/initial_release_date.

Examples 1:

2024
2023

 7.1.12 Requirement 12: index.txt

The file index.txt MUST contain the list of all filenames of CSAF documents which are located in the sub-directories with their filenames. Each entry SHALL be terminated by a newline sequence. The last entry MAY skip the newline sequence.

If different TLP labels are used, multiple index.txt exist. However, they are located in the corresponding folders and contain only the filenames of files for that TLP label.

Example 1:

2023/esa-2023-09953.json
2022/esa-2022-02723.json
2021/esa-2021-31916.json
2021/esa-2021-03676.json

This can be used to download all CSAF documents.

 7.1.13 Requirement 13: changes.csv

The file changes.csv contains a list of CSAF documents in the current TLP level that were changed recently. Therefore, it MUST contain the filename as well as the value of /document/tracking/current_release_date for each CSAF document in the sub-directories without a heading; lines MUST be sorted by the current_release_date timestamp with the latest one first. The changes.csv SHALL be a valid comma separated values format as defined by [RFC4180] without double quotes.

Note: As a consequence of section sec Requirement 2 for filenames and section sec Requirement for directory names, there must not be any characters within the changes.csv that would require quoting.

Example 1:

2023/esa-2023-09953.json,2023-07-01T10:09:07Z
2021/esa-2021-03676.json,2023-07-01T10:09:01Z
2022/esa-2022-02723.json,2022-04-17T15:08:41Z
2021/esa-2021-31916.json,2022-03-01T06:01:00Z

Note: As CSAF 2.0 requires quotes, an [RFC4180] parser can read both format revisions.

 7.1.14 Requirement 14: Directory listings

Server-side generated directory listing SHALL be enabled to support manual navigation.

As the content of the directory listing is more or less static, there is little to no benefit in using of client-side scripts. Moreover, client-side scripts, like JavaScript, are usually not evaluated in text-based browsers and are also hard to check programmatically.

 7.1.15 Requirement 15: ROLIE feed

Resource-Oriented Lightweight Information Exchange (ROLIE) is a standard to ease discovery of security content. ROLIE is built on top of the Atom Publishing Format and Protocol, with specific requirements that support publishing security content. All CSAF documents with the same TLP level MUST be listed in a single ROLIE feed (summary feed). Additional ROLIE feeds might exist that contain only a subset of the CSAF documents. The selection criteria SHOULD be described through the summary. At least one of the feeds

MUST exist. Each ROLIE feed document MUST be a JSON file that conforms with [RFC8322].

The ROLIE feed document MUST contain a feed category with the registered ROLIE information type csaf. The scheme for this category MUST be urn:ietf:params:rolie:category:information-type.

Example 1:

  {
    "feed": {
      "id": "example-csaf-feed-tlp-clear",
      "title": "Example CSAF feed (TLP:CLEAR)",
      "link": [
        {
          "rel": "self",
          "href": "https://psirt.domain.tld/advisories/csaf/feed-tlp-clear.json"
        }
      ],
      "category": [
        {
          "scheme": "urn:ietf:params:rolie:category:information-type",
          "term": "csaf"
        }
      ],
      "updated": "2024-01-01T12:00:00.000Z",
      "entry": [
        {
          "id": "ESA-2024-001",
          "title": "Multiple vulnerabilities in ABC 0.0.2",
          "link": [
            {
              "rel": "self",
              "href": "https://psirt.domain.tld/advisories/csaf/2024/esa-2024-001.json"
            },
            {
              "rel": "hash",
              "href": "https://psirt.domain.tld/advisories/csaf/2024/esa-2024-001.json.sha512"
            },
            {
              "rel": "signature",
              "href": "https://psirt.domain.tld/advisories/csaf/2024/esa-2024-001.json.asc"
            }
          ],
          "published": "2024-01-01T11:00:00.000Z",
          "updated": "2024-01-01T12:00:00.000Z",
          "summary": {
            "content": "Multiple vulnerabilities were fixed in ABC 0.0.3"
          },
          "content": {
            "type": "application/json",
            "src": "https://psirt.domain.tld/advisories/csaf/2024/esa-2024-001.json"
          },
          "format": {
            "schema": "https://docs.oasis-open.org/csaf/csaf/v2.1/schema/csaf.json",
            "version": "2.1"
          }
        }
      ]
    }
  }

Any existing hash file (requirement 18) MUST be listed in the corresponding entry of the ROLIE feed as an item of the array link having the rel value of hash. Any existing signature file (requirement 19) MUST be listed in the corresponding entry of the ROLIE feed as an item of the array link having the rel value of signature.

 7.1.16 Requirement 16: ROLIE service document

The use and therefore the existence of ROLIE service document is optional. If it is used, each ROLIE service document MUST be a JSON file that conforms with [RFC8322] and lists the ROLIE feed documents. Additionally, it can also list the corresponding ROLIE category documents. The ROLIE service document SHOULD use the filename service.json and reside next to the provider-metadata.json.

Example 1:

  {
    "service": {
      "workspace": [
        {
          "title": "Public CSAF feed",
          "collection": [
            {
              "title": "Example CSAF feed (TLP:CLEAR)",
              "href": "https://psirt.domain.tld/advisories/csaf/feed-tlp-clear.json",
              "categories": {
                "category": [
                  {
                    "scheme": "urn:ietf:params:rolie:category:information-type",
                    "term": "csaf"
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  }

 7.1.17 Requirement 17: ROLIE category document

The use and therefore the existence of ROLIE category document is optional. If it is used, each ROLIE category document MUST be a JSON file that conforms with [RFC8322]. A ROLIE category document SHOULD reside next to the corresponding ROLIE feed. ROLIE categories SHOULD be used for to further dissect CSAF documents by one or more of the following criteria:

Example 3:

  {
    "categories": {
      "category": [
        {
            "term": "Example Company Product A"
        },
        {
            "term": "Example Company Product B"
        }
      ]
    }
  }

 7.1.18 Requirement 18: Integrity

All CSAF documents SHALL have at least one hash file computed with a secure cryptographic hash algorithm (e.g. SHA-512 or SHA-3) to ensure their integrity. The filename is constructed by appending the file extension which is given by the algorithm.

MD5 and SHA1 SHOULD NOT be used.

Example 1:

File name of CSAF document: esa-2022-02723.json
File name of SHA-256 hash file: esa-2022-02723.json.sha256
File name of SHA-512 hash file: esa-2022-02723.json.sha512

The file content SHALL start with the first byte of the hexadecimal hash value. Any subsequent data (like a filename) which is optional SHALL be separated by at least one space.

Example 2:

ea6a209dba30a958a78d82309d6cdcc6929fcb81673b3dc4d6b16fac18b6ff38  esa-2022-02723.json

If a ROLIE feed exists, each hash file MUST be listed in it as described in requirement 15.

 7.1.19 Requirement 19: Signatures

All CSAF documents SHALL have at least one OpenPGP signature file which is provided under the same filename which is extended by the appropriate extension. This signature SHALL be presented as an ASCII armored file. See [RFC4880] for more details.

Example 1:

File name of CSAF document: esa-2022-02723.json
File name of signature file: esa-2022-02723.json.asc

If a ROLIE feed exists, each signature file MUST be listed in it as described in requirement 15.

At all times, signatures MUST remain valid for a minimum of 30 days and ideally for at least 90 days. When executing CSAF document signatures, the signing party SHOULD adhere to or surpass the prevailing best practices and recommendations regarding key length. Tools SHOULD treat the violation of the rules given in the first sentence as:

 7.1.20 Requirement 20: Public OpenPGP Key

The public part of the OpenPGP key used to sign the CSAF documents MUST be available. This key file SHALL be presented as an ASCII armored file. It SHOULD also be available at a public key server.

For example, the public part of the OpenPGP key could be placed in a directory openpgp adjacent to the provider-metadata.json.

The OpenPGP key SHOULD have a strength that is considered secure.

Guidance on OpenPGP key strength can be retrieved from technical guidelines of competent authorities.

 7.1.21 Requirement 21: List of CSAF providers

The file aggregator.json MUST be present and valid according to the JSON schema CSAF aggregator.
It MUST NOT be stored adjacent to a provider-metadata.json.

Suggested locations to store the aggregator.json are:

The file aggregator.json SHOULD only list the latest version of the metadata of a CSAF provider.

Example 1:

  {
    "$schema": "https://docs.oasis-open.org/csaf/csaf/v2.1/schema/aggregator.json",
    "aggregator": {
      "category": "lister",
      "contact_details": "Example CSAF Lister can be reached at contact_us@lister.example, or via our website at https://lister.example/security/csaf/aggregator/contact.",
      "issuing_authority": "This service is provided as it is. It is free for everybody.",
      "name": "Example CSAF Lister",
      "namespace": "https://lister.example"
    },
    "aggregator_version": "2.1",
    "canonical_url": "https://aggregator.example/.well-known/csaf-aggregator/aggregator.json",
    "csaf_providers": [
      {
        "metadata": {
          "last_updated": "2024-01-12T20:20:56.169Z",
          "publisher": {
            "category": "vendor",
            "name": "Example Company ProductCERT",
            "namespace": "https://psirt.example.com"
          },
          "role": "csaf_provider",
          "url": "https://www.example.com/.well-known/csaf/provider-metadata.json"
        }
      },
      {
        "metadata": {
          "last_updated": "2024-01-12T21:35:38.000Z",
          "publisher": {
            "category": "coordinator",
            "name": "Example Coordinator CERT",
            "namespace": "https://cert.example"
          },
          "role": "csaf_trusted_provider",
          "url": "https://cert.example/advisories/csaf/provider-metadata.json"
        }
      }
    ],
    "last_updated": "2024-01-24T22:35:38.978Z"
  }

 7.1.22 Requirement 22: Two disjoint issuing parties

The file aggregator.json (requirement 21) lists at least two disjoint CSAF providers (including CSAF trusted providers) or one CSAF publisher and one CSAF provider (including CSAF trusted provider).

 7.1.23 Requirement 23: Mirror

The CSAF documents for each issuing party that is mirrored MUST be in a different folder. The folder name SHOULD be retrieved from the name of the issuing authority. This folders MUST be adjacent to the aggregator.json (requirement 21). Each such folder MUST at least:

Example 1:

  {
    "$schema": "https://docs.oasis-open.org/csaf/csaf/v2.1/schema/aggregator.json",
    "aggregator": {
      "category": "aggregator",
      "contact_details": "Example Aggregator can be reached at contact_us@aggregator.example, or via our website at https://aggregator.example/security/csaf/aggregator/contact.",
      "issuing_authority": "This service is provided as it is. It is free for everybody.",
      "name": "Example Aggregator",
      "namespace": "https://aggregator.example"
    },
    "aggregator_version": "2.1",
    "canonical_url": "https://aggregator.example/.well-known/csaf-aggregator/aggregator.json",
    "csaf_providers": [
      {
        "metadata": {
          "last_updated": "2024-01-12T20:20:56.169Z",
          "publisher": {
            "category": "vendor",
            "name": "Example Company ProductCERT",
            "namespace": "https://psirt.example.com"
          },
          "role": "csaf_provider",
          "url": "https://www.example.com/.well-known/csaf/provider-metadata.json"
        },
        "mirrors": [
          "https://aggregator.example/.well-known/csaf-aggregator/Example_Company_ProductCERT/provider-metadata.json"
        ]
      },
      {
        "metadata": {
          "last_updated": "2024-01-12T21:35:38.000Z",
          "publisher": {
            "category": "coordinator",
            "name": "Example Coordinator CERT",
            "namespace": "https://cert.example"
          },
          "role": "csaf_trusted_provider",
          "url": "https://cert.example/advisories/csaf/provider-metadata.json"
        },
        "mirrors": [
          "https://aggregator.example/.well-known/csaf-aggregator/Example_Coordinator_CERT/provider-metadata.json"
        ]
      }
    ],
    "last_updated": "2024-01-24T22:35:38.978Z"
  }

 7.1.24 Requirement 24: HTTP User-Agent

Access to the CSAF related files and directories provided, for both metadata and documents, MUST be allowed independent of the value of HTTP User-Agent.

Limit the value of HTTP User-Agents to a certain set would hinder adoption of tools retrieving the files.

The only exception is that the temporary blocking of certain HTTP User-Agents is allowed to mitigate an ongoing security incident (e.g. a DoS attack on the web server serving the CSAF files). However, a less severe measure with a similar effect SHOULD be used. CSAF related files and directories SHOULD be exempted from temporary blocking. The temporary blocking SHOULD be removed as soon as possible, at latest two weeks after the security incident process was completed.

Also confer to the TC’s guidance on content delivery networks and caching.

 7.1.25 Requirement 25: Access-Control-Allow-Origin

For any CSAF documents and related metadata, the web server SHOULD set the HTTP header Access-Control-Allow-Origin: *.

The HTTP header enables users to access the CSAF data with web browser based clients.

The value of the HTTP header MAY be altered to allow just specified domains. In such case, the response SHOULD follow the recommendations of [FETCH] including but not limited to those about the Vary header.

Such restriction may allow the allow-listed domains to send credentials.

 7.2 Roles

This subsection groups the requirements from the previous subsection into named sets which target the roles with the same name. This allows end users to request their suppliers to fulfill a certain set of requirements. A supplier can use roles for advertising and marketing.

The roles “CSAF publisher”, “CSAF provider”, and “CSAF trusted provider” are intended directly for issuing parties and form the first group. The second group consists of the roles “CSAF lister” and “CSAF aggregator”. They collect data from the aforementioned issuing parties of the first group and provide them in a single place to aid in automation. Parties of the second group can also issue their own advisories. However, they MUST follow the rules for the first group for that.

Both, a CSAF lister and a CSAF aggregator, decide based on their own rules which issuing parties to list respectively to mirror. However, an issuing party MAY apply to be listed or mirrored.

Issuing parties MUST indicate through the value false in list_on_CSAF_aggregators if they do not want to be listed. Issuing parties MUST indicate through the value false in mirror_on_CSAF_aggregators if they do not want to be mirrored.

The values are independent. The combination of the value false in list_on_CSAF_aggregators and true in mirror_on_CSAF_aggregators implies that the issuing party does not want to be listed without having the CSAF documents mirrored. Therefore, a CSAF aggregator can list that issuing party if it mirrors the files.

 7.2.1 Role: CSAF publisher

A distributing party satisfies the “CSAF publisher” role if the party:

 7.2.2 Role: CSAF provider

A CSAF publisher satisfies the “CSAF provider” role if the party fulfills the following three groups of requirements:

Firstly, the party:

Secondly, the party:

Thirdly, the party:

If the party uses the ROLIE-based distribution, it MUST also satisfy requirements 15 to 17. If it uses the directory-based distribution, it MUST also satisfy requirements 11 to 14.

 7.2.3 Role: CSAF trusted provider

A CSAF provider satisfies the “CSAF trusted provider” role if the party:

 7.2.4 Role: CSAF lister

A distributing party satisfies the “CSAF lister” role if the party:

The purpose of this role is to provide a list of URLs where to find CSAF documents. It is not assumed that the list will be complete.

 7.2.5 Role: CSAF aggregator

A distributing party satisfies the “CSAF aggregator” role if the party:

Additionally, a CSAF aggregator MAY list one or more issuing parties that it does not mirror.

The purpose of this role is to provide a single point where CSAF documents can be retrieved. Multiple CSAF aggregators are expected to exist around the world. None of them is required to mirror all CSAF documents of all issuing parties. CSAF aggregators can be provided for free or as a paid service.

To aid in automation, CSAF aggregators MAY mirror CSAF documents from CSAF publishers. Regarding the terms of use they SHOULD consult with the issuing party. The purpose of this option is that a consumer can retrieve CSAF documents from a CSAF publisher as if this issuing party would be a CSAF trusted provider. To reach that goal, a CSAF aggregator collects the CSAF documents from the CSAF publisher and mirrors it. The collection process MAY be automated or manual. CSAF aggregators announce the collection interval through the field update_interval in the corresponding item of the CSAF publishers list (csaf_publishers) in their aggregator.json. To minimize the implementation efforts and process overhead, a CSAF aggregator MAY upload the CSAF documents of a CSAF publisher into an internal instance of a CSAF provider software. Such construct is called “CSAF proxy provider” as it can be mirrored by the CSAF aggregator software. However, such a CSAF proxy provider MUST NOT be accessible from anyone else than the CSAF aggregator itself. Otherwise, that would violate the second rule of section 7.2.1. Therefore, it is recommended to expose the CSAF proxy provider only on localhost and allow the access only from the CSAF aggregator software.

 7.3 Retrieving rules

The retrieving process executes in two phases: Finding the provider-metadata.json (requirement 7 in section 7.1) and retrieving CSAF documents.

A retrieving party SHOULD do the first phase every time. Based on the setup and use case of the retrieving party it MAY choose to do it less often, e.g. only when adding new or updating distributing parties. In that case, it SHOULD to check regularly whether new information is available.

 7.3.1 Finding provider-metadata.json

Direct locating: The following process SHOULD be used to determine the location of a provider-metadata.json (requirement 7 in section 7.1) based on the main domain of the issuing party.

First, an ordered list of possible provider-metadata.json candidates SHOULD be generated in the following way:

  1. Checking the Well-known URL (requirement 9 in section 7.1)
  2. Checking the security.txt (requirement 8 in section 7.1)
  3. If the above steps fail to produce any candidates: Checking the DNS path (requirement 10 in section 7.1)

Second, select one or more provider-metadata.json to use from the list of valid candidates. If the retrieving party is only able to process one provider-metadata.json, the first one in the list SHOULD be chosen.

The term “checking” used in the listing above SHOULD be understood as follows: Try to access the resource and test whether the response provides an expected result as defined in the requirement in section 7.1. If that is the case, the response is added to the list of candidates - otherwise not. If the resource yields more than one response, the responses are added to the list in the order they are returned from the resource.

Indirect locating: A retrieving party MAY choose to determine the location of a provider-metadata.json by retrieving its location from an aggregator.json (requirement 21 in section 7.1) of a CSAF lister or CSAF aggregator.

 7.3.2 Retrieving CSAF documents

Given a provider-metadata.json, the following process SHOULD be used to retrieve CSAF documents:

  1. Parse the provider-metadata.json to determine whether the directory-based (requirements 11 to 14 in section 7.1)
    or ROLIE-based distribution (requirements 15 to 17 in section 7.1) is used.
    If both are present, the ROLIE information SHOULD be preferred.
  2. For any CSAF trusted provider, the hash and signature files (requirements 18 to 19 in section 7.1) SHOULD be retrieved together
    with the CSAF document.
    They MUST be checked before further processing the CSAF document.
  3. Test the CSAF document against the schema.
  4. Execute mandatory tests on the CSAF document.

 7.4 Transition between CSAF 2.0 and CSAF 2.1

This subsection details the process that SHOULD be followed when transitioning the distribution of documents from CSAF 2.0 to CSAF 2.1. Different scenarios can be encountered:

 7.4.1 Announcing the Transition

In the last scenario, a temporary parallel distribution of CSAF 2.0 and CSAF 2.1 documents and provider metadata is RECOMMENDED. The provider SHOULD announce a transition period containing three points in time:

The announcement MAY contain also the following information:

 7.4.2 Transition Process for a CSAF Provider

The following process SHOULD be followed:

If a DNS path (cf. section sec) is used instead of the well-known URL, the same process SHOULD be followed taking the rules below into account:

 7.4.3 Archive of CSAF Document from Previous Version

The following rules apply for the archival of CSAF document from a previous version:

 7.4.4 Transition Process for a CSAF Aggregator

Similarly, to the transition process for a CSAF provider, the same process SHOULD be used for a CSAF aggregator. It is RECOMMENDED to use the following URLs during the process:

A CSAF 2.1 aggregator MUST only sync and list CSAF 2.1 publishers and providers.

 8. Safety, Security, and Data Protection Considerations

CSAF documents are based on JSON, thus the security considerations of [RFC8259] apply and are repeated here as service for the reader:

Generally, there are security issues with scripting languages. JSON is a subset of JavaScript but excludes assignment and invocation.

Since JSON’s syntax is borrowed from JavaScript, it is possible to use that language’s eval() function to parse most JSON texts (but not all; certain characters such as U+2028 LINE SEPARATOR and U+2029 PARAGRAPH SEPARATOR are legal in JSON but not JavaScript). This generally constitutes an unacceptable security risk, since the text could contain executable code along with data declarations. The same consideration applies to the use of eval()-like functions in any other programming language in which JSON texts conform to that language’s syntax.

In addition, CSAF documents may be rendered by consumers in various human-readable formats like HTML or PDF. Thus, for security reasons, CSAF producers and consumers SHALL adhere to the following:

The distribution requirements of CSAF data allow to specify domains as the value of the HTTP header Access-Control-Allow-Origin. While a wildcard (*) as header value usually prevents implementing browsers from sending credentials during the CORS request, the restriction to specified domains often enables sending credentials. Allowing several specified domains results in using dynamics on the server, which can widen the attack surface by using more code and configuration. Furthermore, this might reveal information about internal structures, e.g. which domains are allowed to send credentials, or which tools are used. Given that credentials from a browser are a potent tool in the event of an attack, restricting the origins seems to imply a higher risk and therefore less secure than allowing all domains without credentials.

As setting the Access-Control-Allow-Origin header potentially allows for cross site request forgery, it SHOULD only be served on files and directories containing CSAF data. For any restricted feeds, standard authentication methods SHOULD be used that are not send by web browsers if the wildcard is used as header value.

 9. Conformance

In the only subsection of this section, the conformance targets and clauses are listed. The clauses, matching the targets one to one, are listed in separate sub-subsections of the targets listing subsection.

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 24 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 the security advisory sharing communities follow the chain link model. Instead, a single minimum capability level for every target is given to maintain important goals of providing a common framework for security advisories:

 9.1 Conformance Targets

This document defines requirements for the CSAF file format and for certain software components that interact with it. The entities (“conformance targets”) for which this document defines requirements are:

 9.1.1 Conformance Clause 1: CSAF document

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

 9.1.2 Conformance Clause 2: CSAF producer

A program satisfies the “CSAF producer” conformance profile if the program:

 9.1.3 Conformance Clause 3: CSAF direct producer

An analysis tool satisfies the “CSAF direct producer” conformance profile if the analysis tool:

 9.1.4 Conformance Clause 4: CSAF converter

A converter satisfies the “CSAF converter” conformance profile if the converter:

 9.1.5 Conformance Clause 5: CVRF CSAF converter

A program satisfies the “CVRF CSAF converter” conformance profile if the program fulfills the following two groups of requirements:

Firstly, the program:

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

 9.1.6 Conformance Clause 6: CSAF content management system

A CSAF content management system satisfies the “CSAF content management system” conformance profile if the content management system:

 9.1.7 Conformance Clause 7: CSAF post-processor

A CSAF post-processor satisfies the “CSAF post-processor” conformance profile if the post-processor:

 9.1.8 Conformance Clause 8: CSAF modifier

A program satisfies the “CSAF modifier” conformance profile if the program fulfills the two following groups of requirements:

The program:

The resulting modified document:

 9.1.9 Conformance Clause 9: CSAF translator

A program satisfies the “CSAF translator” conformance profile if the program fulfills the two following groups of requirements:

The program:

The resulting translated document:

 9.1.10 Conformance Clause 10: CSAF consumer

A processor satisfies the “CSAF consumer” conformance profile if the processor:

 9.1.11 Conformance Clause 11: CSAF viewer

A viewer satisfies the “CSAF viewer” conformance profile if the viewer fulfills the two following groups of requirements:

The viewer:

For each CVSS-Score in /vulnerabilities[]/metrics[] the viewer:

 9.1.12 Conformance Clause 12: CSAF management system

A CSAF management system satisfies the “CSAF management system” conformance profile if the management system:

 9.1.13 Conformance Clause 13: CSAF asset matching system

A CSAF asset matching system satisfies the “CSAF asset matching system” conformance profile if the asset matching system:

 9.1.14 Conformance Clause 14: CSAF basic validator

A program satisfies the “CSAF basic validator” conformance profile if the program:

A CSAF basic validator MAY provide one or more additional functions:

 9.1.15 Conformance Clause 15: CSAF extended validator

A CSAF basic validator satisfies the “CSAF extended validator” conformance profile if the CSAF basic validator:

A CSAF extended validator MAY provide an additional function to only run one or more selected recommended tests.

 9.1.16 Conformance Clause 16: CSAF full validator

A CSAF extended validator satisfies the “CSAF full validator” conformance profile if the CSAF extended validator:

A CSAF full validator MAY provide an additional function to only run one or more selected informative tests.

 9.1.17 Conformance Clause 17: CSAF SBOM matching system

A CSAF SBOM matching system satisfies the “CSAF SBOM matching system” conformance profile if the SBOM matching system:

 9.1.18 Conformance Clause 18: CSAF 2.0 to CSAF 2.1 converter

A program satisfies the “CSAF 2.0 to CSAF 2.1 converter” conformance profile if the program fulfills the following two groups of requirements:

Firstly, the program:

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

A tool MAY implement options to convert other Markdown formats to GitHub-flavored Markdown.

A tool MAY implement an additional, non-default option to output an invalid document that can be fixed afterwards. Solely in this case, any of the rules above MAY be ignored to avoid data loss.

 9.1.19 Conformance Clause 19: CSAF library

A library satisfies the “CSAF library” conformance profile if the library:

The library MAY implement an option to retrieve the keys unsorted.

 9.1.20 Conformance Clause 20: CSAF library with basic validation

A CSAF library satisfies the “CSAF library with basic validation” conformance profile if the CSAF library:

A CSAF library does not satisfies the “CSAF library with basic validation” conformance profile if the CSAF library uses an external library or program for the “CSAF basic validator” part and does not enforce its presence.

 9.1.21 Conformance Clause 21: CSAF library with extended validation

A CSAF library satisfies the “CSAF library with extended validation” conformance profile if the CSAF library:

A CSAF library does not satisfies the “CSAF library with extended validation” conformance profile if the CSAF library uses an external library or program for the “CSAF extended validator” part and does not enforce its presence.

 9.1.22 Conformance Clause 22: CSAF library with full validation

A CSAF library satisfies the “CSAF library with extended validation” conformance profile if the CSAF library:

A CSAF library does not satisfies the “CSAF library with full validation” conformance profile if the CSAF library uses an external library or program for the “CSAF full validator” part and does not enforce its presence.

 9.1.23 Conformance Clause 23: CSAF downloader

A program satisfies the “CSAF downloader” conformance profile if the program:

A tool MAY implement an option to store CSAF documents that fail any of the steps in section 7.3.2.

 9.1.24 Conformance Clause 24: CSAF withdrawer

A program satisfies the “CSAF withdrawer” conformance profile if the program:

A tool MAY implement an option to additionally remove any element that would hinder the production of a valid CSAF.

 9.1.25 Conformance Clause 25: CSAF superseder

A program satisfies the “CSAF superseder” conformance profile if the program:

A tool MAY implement an option to additionally remove any element that would hinder the production of a valid CSAF.

 Appendix A. Acknowledgments

The following individuals were members of the OASIS CSAF Technical Committee during the creation of this specification and their contributions are gratefully acknowledged:

CSAF TC Members:

First Name Last Name Company
Alexandre Dulaunoy CIRCL
Anthony Berglas Cryptsoft Pty Ltd.
Art Manion Carnegie Mellon University
Aukjan van Belkum EclecticIQ
Ben Sooter Electric Power Research Institute (EPRI)
Bernd Grobauer Siemens AG
Bruce Rich Cryptsoft Pty Ltd.
Chok Poh Oracle
Dan West Microsoft
David Waltermire NIST
Denny Page TIBCO Software Inc.
Duncan Sparrell sFractal Consulting LLC
Eric Johnson TIBCO Software Inc.
Ethan Rahn Arista Networks
Feng Cao Oracle
Greg Scott Cryptsoft Pty Ltd.
Harold Booth NIST
Jason Masters TELUS
Jennifer Victor Dell
Jessica Fitzgerald-McKay National Security Agency
Jonathan Bitle Kaiser Permanente
Justin Corlett Cryptsoft Pty Ltd.
Kazuo Noguchi Hitachi, Ltd.
Kent Landfield McAfee
Langley Rock Red Hat
Martin Prpic Red Hat
Masato Terada Hitachi, Ltd.
Mike Gorski Cisco Systems
Nicole Parrish Mitre Corporation
Omar Santos Cisco Systems
Patrick Maroney AT&T
Rhonda Levy Cisco Systems
Richard Struse Mitre Corporation
Ritwik Ghoshal Oracle
Robert Coderre Accenture
Robert Keith Accenture
Stefan Hagen Individual
Tania Ward Dell
Ted Bedwell Cisco Systems
Thomas Proell Siemens AG
Thomas Schmidt Federal Office for Information Security (BSI) Germany
Tim Hudson Cryptsoft Pty Ltd.
Tobias Limmer Siemens AG
Tony Cox Cryptsoft Pty Ltd.
Vincent Danen Red Hat
Will Rideout Arista Networks
Xiaoyu Ge Huawei Technologies Co., Ltd.

The following individuals were members of the OASIS CSAF Technical Committee during the creation of the previous version (CVRF v1.2) of this specification and their contributions are gratefully acknowledged:

CSAF TC Members:

First Name Last Name Company
Adam Montville CIS
Allan Thomson LookingGlass
Anthony Berglas Cryptsoft Pty Ltd.
Art Manion Carnegie Mellon University
Aukjan van Belkum EclecticIQ
Ben Sooter Electric Power Research Institute
Bernd Grobauer Siemens AG
Beth Pumo Kaiser Permanente
Bret Jordan Symantec Corp.
Bruce Rich Cryptsoft Pty Ltd.
Chet Ensign OASIS
Chok Poh Oracle
Chris Rouland Individual
David Waltermire NIST
Denny Page TIBCO Software Inc.
Doron Shiloach IBM
Duncan Sparrell sFractal Consulting LLC
Eric Johnson TIBCO Software Inc.
Feng Cao Oracle
Greg Reaume TELUS
Greg Scott Cryptsoft Pty Ltd.
Harold Booth NIST
Jamison Day LookingGlass
Jared Semrau “FireEye, Inc.”
Jason Masters TELUS
Jerome Athias Individual
Jessica Fitzgerald-McKay National Security Agency
Jonathan Bitle Kaiser Permanente
Justin Corlett Cryptsoft Pty Ltd.
Karen Scarfone Individual
Kazuo Noguchi “Hitachi, Ltd.”
Kent Landfield McAfee
Lothar Braun Siemens AG
Louis Ronnau Cisco Systems
Mark Davidson NC4
Mark-David McLaughlin Cisco Systems
Masato Terada “Hitachi, Ltd.”
Masood Nasir TELUS
Nicole Gong Mitre Corporation
Omar Santos Cisco Systems
Patrick Maroney Wapack Labs LLC
Paul Patrick “FireEye, Inc.”
Peter Allor IBM
Phillip Boles “FireEye, Inc.”
Ravi Balupari Netskope
Rich Reybok ServiceNow
Richard Struse DHS Office of Cybersecurity and Communications (CS&C)
Ritwik Ghoshal Oracle
Robert Coderre VeriSign
Robin Cover OASIS
Rupert Wimmer Siemens AG
Sanjiv Kalkar Individual
Sean Barnum Mitre Corporation
Stefan Hagen Individual
Ted Bedwell Cisco Systems
Thomas Schreck Siemens AG
Tim Hudson Cryptsoft Pty Ltd.
Tony Cox Cryptsoft Pty Ltd.
Trey Darley “Kingfisher Operations, sprl”
Vincent Danen Red Hat
Zach Turk Microsoft

 Appendix B. Revision History

Revision Date Editor Changes Made
csaf-v2.1-wd20240124-dev 2024-01-24 Stefan Hagen and Thomas Schmidt Preparing initial Editor Revision
csaf-v2.1-wd20240228-dev 2024-02-28 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20240327-dev 2024-03-27 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20240424-dev 2024-04-24 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20240529-dev 2024-05-29 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20240626-dev 2024-06-26 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20240731-dev 2024-07-31 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20240828-dev 2024-08-28 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20241030-dev 2024-10-30 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20241127-dev 2024-11-27 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20250129-dev 2025-01-29 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20250226-dev 2025-02-26 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20250326-dev 2025-03-26 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20250430-dev 2025-04-30 Stefan Hagen and Thomas Schmidt Next Editor Revision
csaf-v2.1-wd20250528-dev 2025-05-28 Stefan Hagen and Thomas Schmidt Next Editor Revision

 Appendix C. Guidance on the Size of CSAF Documents

This appendix provides informative guidance on the size of CSAF documents.

The TC carefully considered all known aspects to provide size limits for CSAF documents for this version of the specification with the result that hard limits SHOULD NOT be enforced. However, since there is the need for guidance to ensure interoperability in the ecosystem, the TC provides a set of soft limits. A CSAF document which exceeds those, can still be valid but it might not be processable for some parties.

All CSAF consumers SHOULD be able to process CSAF documents which comply with the limits below. All CSAF producers SHOULD NOT produce CSAF documents which exceed those limits.

If you come across a case where these limits are exceeded, please provide feedback to the TC.

 Appendix C. File Size

A CSAF document in the specified JSON format encoded in UTF-8 SHOULD conform to known size limits of current technologies parsing JSON content, e.g.: 50 MiB.

The CSAF documents observed in the wild expose strongly varying sizes as per the use cases they serve. At least one database technology in wide use for storing CSAF documents rejects insert attempts when the transformed BSON size exceeds 16 megabytes. The BSON format optimizes for accessibility and not size. So, small integers and small strings may incur more overhead in the BSON format than in JSON. In addition, the BSON format adds length information for the entries inside the document, which adds to the size when storing CSAF document content in a BSON format.

 Appendix C. Array Length

An array SHOULD NOT have more than:

 Appendix C. String Length

A string SHOULD NOT have a length greater than:

 C.6 Date

The maximum length of strings representing a temporal value is given by the format specifier. This applies to:

 C.5 Enum

A string which is an enum has a fixed maximum length given by its longest value.

Later versions of CSAF might add, modify or delete possible value which could change the longest value. Therefore, this sizes should not be implemented as fixed limits if forward compatibility is desired.

The value of /$schema is a fixed URL, currently pointing to the JSON schema location. It seems to be safe to assume that the length of this value is not greater than 150. This applies to:

For all other values, it seems to be safe to assume that the length of each value is not greater than 50. This applies to:

 C.5 URI Length

A string with format uri SHOULD NOT have a length greater than 20000. This applies to:

 C.5 UUID Length

A string with format uuid SHOULD NOT have a length greater than 50. This applies to: