Skip to content

Commit 251b1cd

Browse files
Update ratings descriptions in schema files for clarity on VEX usage (#722)
<!-- Thank you for taking the time to develop and contribute a core enhancement or fix for a defect! We kindly request that you create pull requests only for things that have been discussed in a ticket first; exceptions may be made for spelling or grammar fixes. Read more about the process here: https://cyclonedx.org/participate/standardization-process/#working-model Please have the related ticket/issue ID ready. If there is none, feel free to create a new ticket: https://github.com/CycloneDX/specification/issues/new/choose --> <!-- Please provide a brief description of what this pull request intends to do and which ticket it fixes/closes. Example: > As discussed in ticket #485, this PR adds Streebog to the hash algorithm enum. > > fixes #485 In case this is for a spelling or grammar improvement, please provide a brief description. Example: > Fixe typo: color(AE) -> colour(BE) --> I am translating @stevespringett 's [feedback](#719 (comment)) on the CycloneDX VEX specification into the code. > Should ratings be normative inputs for prioritization in VEX consumers? _Yes, they should be. It is widely known that the NVD has historically overrated vulnerabilities (on purpose). So the ratings from the NVD and those from the manufactures are often different. CycloneDX can convey this information which can aid in prioritization._ fixes #719
2 parents 34e8064 + 80db025 commit 251b1cd

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

schema/bom-1.6.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -888,7 +888,7 @@ message Vulnerability {
888888
optional Source source = 3;
889889
// Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Oftentimes, the same vulnerability may exist in multiple sources of vulnerability intelligence but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.
890890
repeated VulnerabilityReference references = 4;
891-
// List of vulnerability ratings
891+
// List of vulnerability ratings. Consumers SHOULD consider ratings in prioritization decisions; source ratings may differ and aid prioritization.
892892
repeated VulnerabilityRating ratings = 5;
893893
// List of Common Weaknesses Enumerations (CWEs) codes that describe this vulnerability. For example, 399 (of https://cwe.mitre.org/data/definitions/399.html)
894894
repeated int32 cwes = 6;

schema/bom-1.6.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2681,7 +2681,7 @@
26812681
"ratings": {
26822682
"type": "array",
26832683
"title": "Ratings",
2684-
"description": "List of vulnerability ratings",
2684+
"description": "List of vulnerability ratings. Consumers SHOULD consider ratings in prioritization decisions; source ratings may differ and aid prioritization.",
26852685
"items": {
26862686
"$ref": "#/definitions/rating"
26872687
}

schema/bom-1.6.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4218,7 +4218,7 @@ limitations under the License.
42184218
</xs:element>
42194219
<xs:element name="ratings" minOccurs="0" maxOccurs="1">
42204220
<xs:annotation>
4221-
<xs:documentation xml:lang="en">List of vulnerability ratings.</xs:documentation>
4221+
<xs:documentation xml:lang="en">List of vulnerability ratings. Consumers SHOULD consider ratings in prioritization decisions; source ratings may differ and aid prioritization.</xs:documentation>
42224222
</xs:annotation>
42234223
<xs:complexType>
42244224
<xs:sequence>

schema/bom-1.7.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -990,7 +990,7 @@ message Vulnerability {
990990
optional Source source = 3;
991991
// Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Oftentimes, the same vulnerability may exist in multiple sources of vulnerability intelligence but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.
992992
repeated VulnerabilityReference references = 4;
993-
// List of vulnerability ratings
993+
// List of vulnerability ratings. Consumers SHOULD consider ratings in prioritization decisions; source ratings may differ and aid prioritization.
994994
repeated VulnerabilityRating ratings = 5;
995995
// List of Common Weaknesses Enumerations (CWEs) codes that describe this vulnerability. For example, 399 (of https://cwe.mitre.org/data/definitions/399.html)
996996
repeated int32 cwes = 6;

schema/bom-1.7.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2841,7 +2841,7 @@
28412841
"ratings": {
28422842
"type": "array",
28432843
"title": "Ratings",
2844-
"description": "List of vulnerability ratings",
2844+
"description": "List of vulnerability ratings. Consumers SHOULD consider ratings in prioritization decisions; source ratings may differ and aid prioritization.",
28452845
"items": {
28462846
"$ref": "#/definitions/rating"
28472847
}

schema/bom-1.7.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4461,7 +4461,7 @@ limitations under the License.
44614461
</xs:element>
44624462
<xs:element name="ratings" minOccurs="0" maxOccurs="1">
44634463
<xs:annotation>
4464-
<xs:documentation xml:lang="en">List of vulnerability ratings.</xs:documentation>
4464+
<xs:documentation xml:lang="en">List of vulnerability ratings. Consumers SHOULD consider ratings in prioritization decisions; source ratings may differ and aid prioritization.</xs:documentation>
44654465
</xs:annotation>
44664466
<xs:complexType>
44674467
<xs:sequence>

0 commit comments

Comments
 (0)