Skip to content

Commit 74551e8

Browse files
ccoffinccoffin
authored
New bundled CVE Record Format Files
1 parent f2a4044 commit 74551e8

4 files changed

+447
-31
lines changed

‎schema/docs/CVE_Record_Format_bundled.json

+111-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema#",
3-
"$id": "https://cveproject.github.io/cve-schema/schema/docs/CVE_Record_Format_bundled.json",
3+
"$id": "https://cveproject.github.io/cve-schema/schema/CVE_Record_Format.json",
44
"title": "CVE JSON record format",
55
"description": "cve-schema specifies the CVE JSON record format. This is the blueprint for a rich set of JSON data that can be submitted by CVE Numbering Authorities (CNAs) and Authorized Data Publishers (ADPs) to describe a CVE Record. Some examples of CVE Record data include CVE ID number, affected product(s), affected version(s), and public references. While those specific items are required when assigning a CVE, there are many other optional data in the schema that can be used to enrich CVE Records for community benefit. Learn more about the CVE program at [the official website](https://cve.mitre.org). This CVE JSON record format is defined using JSON Schema. Learn more about JSON Schema [here](https://json-schema.org/).",
66
"definitions": {
@@ -79,6 +79,20 @@
7979
"type": "string",
8080
"pattern": "^CVE-[0-9]{4}-[0-9]{4,19}$"
8181
},
82+
"cpe22and23": {
83+
"type": "string",
84+
"description": "Common Platform Enumeration (CPE) Name in either 2.2 or 2.3 format",
85+
"pattern": "([c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9._\\-~%]*){0,6})|(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})",
86+
"minLength": 1,
87+
"maxLength": 2048
88+
},
89+
"cpe23": {
90+
"type": "string",
91+
"description": "Common Platform Enumeration (CPE) Name in 2.3 format",
92+
"pattern": "(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})",
93+
"minLength": 1,
94+
"maxLength": 2048
95+
},
8296
"orgId": {
8397
"description": "A UUID for an organization participating in the CVE program. This UUID can be used to lookup the organization record in the user registry service.",
8498
"$ref": "#/definitions/uuidType"
@@ -244,15 +258,12 @@
244258
},
245259
"cpes": {
246260
"type": "array",
247-
"description": "Affected products defined by CPE. This is an array of CPE values (vulnerable and not), we use an array so that we can make multiple statements about the same version and they are separate (if we used a JSON object we'd essentially be keying on the CPE name and they would have to overlap). Also, this allows things like cveDataVersion or cveDescription to be applied directly to the product entry. This also allows more complex statements such as \"Product X between versions 10.2 and 10.8\" to be put in a machine-readable format. As well since multiple statements can be used multiple branches of the same product can be defined here.",
261+
"description": "Affected products defined by CPE. This is an array of CPE values (vulnerable and not), we use an array so that we can make multiple statements about the same version and they are separate (if we used a JSON object we'd essentially be keying on the CPE name and they would have to overlap). Also, this allows things like cveDataVersion or cveDescription to be applied directly to the product entry. This also allows more complex statements such as \"Product X between versions 10.2 and 10.8\" to be put in a machine-readable format. As well since multiple statements can be used multiple branches of the same product can be defined here. NOTE: Consider using the newer cpeApplicability block for defining CPE data using the CPE Applicability Language which includes more options for defining CPE Names.",
248262
"uniqueItems": true,
249263
"items": {
250264
"title": "CPE Name",
251-
"type": "string",
252265
"description": "Common Platform Enumeration (CPE) Name in either 2.2 or 2.3 format",
253-
"pattern": "([c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9._\\-~%]*){0,6})|(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})",
254-
"minLength": 1,
255-
"maxLength": 2048
266+
"$ref": "#/definitions/cpe22and23"
256267
}
257268
},
258269
"modules": {
@@ -445,7 +456,7 @@
445456
"description": "The version of the CVE schema used for validating this record. Used to support multiple versions of this format.",
446457
"type": "string",
447458
"pattern": "^5\\.(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))?$",
448-
"default": "5.1.0"
459+
"default": "5.1.1"
449460
},
450461
"cveMetadataPublished": {
451462
"description": "This is meta data about the CVE ID such as the CVE ID, who requested it, who assigned it, when it was requested, the current state (PUBLISHED, REJECTED, etc.) and so on. These fields are controlled by the CVE Services.",
@@ -573,6 +584,87 @@
573584
],
574585
"additionalProperties": false
575586
},
587+
"cpeApplicabilityElement": {
588+
"description": "Affected products defined using an implementation of the CPE Applicability Language, mostly copied/forked from the NIST NVD CVE API v2.0 schema (optional). An operator property allows AND or OR logic between CPEs or combinations of CPEs. The negate and vulnerable Boolean properties allow CPEs to be inverted and/or defined as vulnerable or not. Multiple version fields are provided for capturing ranges of products when defining a CPE Match String Range. NOTE: When defining a cpeApplicability block, it is recommended that it align with (as much as possible) the product data provided within the affected block.",
589+
"properties": {
590+
"operator": {
591+
"type": "string",
592+
"enum": [
593+
"AND",
594+
"OR"
595+
]
596+
},
597+
"negate": {
598+
"type": "boolean"
599+
},
600+
"nodes": {
601+
"type": "array",
602+
"items": {
603+
"$ref": "#/definitions/cpe_node"
604+
}
605+
}
606+
},
607+
"required": [
608+
"nodes"
609+
]
610+
},
611+
"cpe_node": {
612+
"description": "Defines a CPE configuration node in an applicability statement.",
613+
"properties": {
614+
"operator": {
615+
"type": "string",
616+
"enum": [
617+
"AND",
618+
"OR"
619+
]
620+
},
621+
"negate": {
622+
"type": "boolean"
623+
},
624+
"cpeMatch": {
625+
"type": "array",
626+
"items": {
627+
"$ref": "#/definitions/cpe_match"
628+
}
629+
}
630+
},
631+
"required": [
632+
"operator",
633+
"cpeMatch"
634+
]
635+
},
636+
"cpe_match": {
637+
"description": "CPE match string or range",
638+
"type": "object",
639+
"properties": {
640+
"vulnerable": {
641+
"type": "boolean"
642+
},
643+
"criteria": {
644+
"$ref": "#/definitions/cpe23"
645+
},
646+
"matchCriteriaId": {
647+
"$ref": "#/definitions/uuidType"
648+
},
649+
"versionStartExcluding": {
650+
"$ref": "#/definitions/version"
651+
},
652+
"versionStartIncluding": {
653+
"$ref": "#/definitions/version"
654+
},
655+
"versionEndExcluding": {
656+
"$ref": "#/definitions/version"
657+
},
658+
"versionEndIncluding": {
659+
"$ref": "#/definitions/version"
660+
}
661+
},
662+
"required": [
663+
"vulnerable",
664+
"criteria"
665+
],
666+
"additionalProperties": false
667+
},
576668
"cnaPublishedContainer": {
577669
"description": "An object containing the vulnerability information provided by a CVE Numbering Authority (CNA) for a published CVE ID. There can only be one CNA container per CVE record since there can only be one assigning CNA. The CNA container must include the required information defined in the CVE Rules, which includes a product, version, problem type, prose description, and a reference.",
578670
"type": "object",
@@ -600,6 +692,12 @@
600692
"affected": {
601693
"$ref": "#/definitions/affected"
602694
},
695+
"cpeApplicability": {
696+
"type": "array",
697+
"items": {
698+
"$ref": "#/definitions/cpeApplicabilityElement"
699+
}
700+
},
603701
"problemTypes": {
604702
"$ref": "#/definitions/problemTypes"
605703
},
@@ -706,6 +804,12 @@
706804
"affected": {
707805
"$ref": "#/definitions/affected"
708806
},
807+
"cpeApplicability": {
808+
"type": "array",
809+
"items": {
810+
"$ref": "#/definitions/cpeApplicabilityElement"
811+
}
812+
},
709813
"problemTypes": {
710814
"$ref": "#/definitions/problemTypes"
711815
},

‎schema/docs/CVE_Record_Format_bundled_adpContainer.json

+112-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema#",
33
"$id": "https://cveproject.github.io/cve-schema/schema/docs/CVE_Record_Format_bundled_adpContainer.json",
4-
"title": "CVE JSON adpContainer sub schema",
5-
"description": "CVE JSON adpContainer format",
4+
"title": "CVE Record Format adpContainer sub schema",
5+
"description": "CVE Record Format adpContainer format",
66
"definitions": {
77
"uriType": {
88
"description": "A universal resource identifier (URI), according to [RFC 3986](https://tools.ietf.org/html/rfc3986).",
@@ -79,6 +79,20 @@
7979
"type": "string",
8080
"pattern": "^CVE-[0-9]{4}-[0-9]{4,19}$"
8181
},
82+
"cpe22and23": {
83+
"type": "string",
84+
"description": "Common Platform Enumeration (CPE) Name in either 2.2 or 2.3 format",
85+
"pattern": "([c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9._\\-~%]*){0,6})|(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})",
86+
"minLength": 1,
87+
"maxLength": 2048
88+
},
89+
"cpe23": {
90+
"type": "string",
91+
"description": "Common Platform Enumeration (CPE) Name in 2.3 format",
92+
"pattern": "(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})",
93+
"minLength": 1,
94+
"maxLength": 2048
95+
},
8296
"orgId": {
8397
"description": "A UUID for an organization participating in the CVE program. This UUID can be used to lookup the organization record in the user registry service.",
8498
"$ref": "#/definitions/uuidType"
@@ -244,15 +258,12 @@
244258
},
245259
"cpes": {
246260
"type": "array",
247-
"description": "Affected products defined by CPE. This is an array of CPE values (vulnerable and not), we use an array so that we can make multiple statements about the same version and they are separate (if we used a JSON object we'd essentially be keying on the CPE name and they would have to overlap). Also, this allows things like cveDataVersion or cveDescription to be applied directly to the product entry. This also allows more complex statements such as \"Product X between versions 10.2 and 10.8\" to be put in a machine-readable format. As well since multiple statements can be used multiple branches of the same product can be defined here.",
261+
"description": "Affected products defined by CPE. This is an array of CPE values (vulnerable and not), we use an array so that we can make multiple statements about the same version and they are separate (if we used a JSON object we'd essentially be keying on the CPE name and they would have to overlap). Also, this allows things like cveDataVersion or cveDescription to be applied directly to the product entry. This also allows more complex statements such as \"Product X between versions 10.2 and 10.8\" to be put in a machine-readable format. As well since multiple statements can be used multiple branches of the same product can be defined here. NOTE: Consider using the newer cpeApplicability block for defining CPE data using the CPE Applicability Language which includes more options for defining CPE Names.",
248262
"uniqueItems": true,
249263
"items": {
250264
"title": "CPE Name",
251-
"type": "string",
252265
"description": "Common Platform Enumeration (CPE) Name in either 2.2 or 2.3 format",
253-
"pattern": "([c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9._\\-~%]*){0,6})|(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})",
254-
"minLength": 1,
255-
"maxLength": 2048
266+
"$ref": "#/definitions/cpe22and23"
256267
}
257268
},
258269
"modules": {
@@ -445,7 +456,7 @@
445456
"description": "The version of the CVE schema used for validating this record. Used to support multiple versions of this format.",
446457
"type": "string",
447458
"pattern": "^5\\.(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))?$",
448-
"default": "5.1.0"
459+
"default": "5.1.1"
449460
},
450461
"cveMetadataPublished": {
451462
"description": "This is meta data about the CVE ID such as the CVE ID, who requested it, who assigned it, when it was requested, the current state (PUBLISHED, REJECTED, etc.) and so on. These fields are controlled by the CVE Services.",
@@ -573,6 +584,87 @@
573584
],
574585
"additionalProperties": false
575586
},
587+
"cpeApplicabilityElement": {
588+
"description": "Affected products defined using an implementation of the CPE Applicability Language, mostly copied/forked from the NIST NVD CVE API v2.0 schema (optional). An operator property allows AND or OR logic between CPEs or combinations of CPEs. The negate and vulnerable Boolean properties allow CPEs to be inverted and/or defined as vulnerable or not. Multiple version fields are provided for capturing ranges of products when defining a CPE Match String Range. NOTE: When defining a cpeApplicability block, it is recommended that it align with (as much as possible) the product data provided within the affected block.",
589+
"properties": {
590+
"operator": {
591+
"type": "string",
592+
"enum": [
593+
"AND",
594+
"OR"
595+
]
596+
},
597+
"negate": {
598+
"type": "boolean"
599+
},
600+
"nodes": {
601+
"type": "array",
602+
"items": {
603+
"$ref": "#/definitions/cpe_node"
604+
}
605+
}
606+
},
607+
"required": [
608+
"nodes"
609+
]
610+
},
611+
"cpe_node": {
612+
"description": "Defines a CPE configuration node in an applicability statement.",
613+
"properties": {
614+
"operator": {
615+
"type": "string",
616+
"enum": [
617+
"AND",
618+
"OR"
619+
]
620+
},
621+
"negate": {
622+
"type": "boolean"
623+
},
624+
"cpeMatch": {
625+
"type": "array",
626+
"items": {
627+
"$ref": "#/definitions/cpe_match"
628+
}
629+
}
630+
},
631+
"required": [
632+
"operator",
633+
"cpeMatch"
634+
]
635+
},
636+
"cpe_match": {
637+
"description": "CPE match string or range",
638+
"type": "object",
639+
"properties": {
640+
"vulnerable": {
641+
"type": "boolean"
642+
},
643+
"criteria": {
644+
"$ref": "#/definitions/cpe23"
645+
},
646+
"matchCriteriaId": {
647+
"$ref": "#/definitions/uuidType"
648+
},
649+
"versionStartExcluding": {
650+
"$ref": "#/definitions/version"
651+
},
652+
"versionStartIncluding": {
653+
"$ref": "#/definitions/version"
654+
},
655+
"versionEndExcluding": {
656+
"$ref": "#/definitions/version"
657+
},
658+
"versionEndIncluding": {
659+
"$ref": "#/definitions/version"
660+
}
661+
},
662+
"required": [
663+
"vulnerable",
664+
"criteria"
665+
],
666+
"additionalProperties": false
667+
},
576668
"cnaPublishedContainer": {
577669
"description": "An object containing the vulnerability information provided by a CVE Numbering Authority (CNA) for a published CVE ID. There can only be one CNA container per CVE record since there can only be one assigning CNA. The CNA container must include the required information defined in the CVE Rules, which includes a product, version, problem type, prose description, and a reference.",
578670
"type": "object",
@@ -600,6 +692,12 @@
600692
"affected": {
601693
"$ref": "#/definitions/affected"
602694
},
695+
"cpeApplicability": {
696+
"type": "array",
697+
"items": {
698+
"$ref": "#/definitions/cpeApplicabilityElement"
699+
}
700+
},
603701
"problemTypes": {
604702
"$ref": "#/definitions/problemTypes"
605703
},
@@ -706,6 +804,12 @@
706804
"affected": {
707805
"$ref": "#/definitions/affected"
708806
},
807+
"cpeApplicability": {
808+
"type": "array",
809+
"items": {
810+
"$ref": "#/definitions/cpeApplicabilityElement"
811+
}
812+
},
709813
"problemTypes": {
710814
"$ref": "#/definitions/problemTypes"
711815
},

0 commit comments

Comments
 (0)