CVE JSON 5.0 Schema - Json
CVE JSON 5.0 Schema - Json
CVE JSON 5.0 Schema - Json
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://cve.org/cve/record/v5_00/",
"type": "object",
"title": "CVE JSON record format",
"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/).",
"definitions": {
"uriType": {
"description": "A universal resource identifier (URI), according to
[RFC 3986](https://tools.ietf.org/html/rfc3986).",
"type": "string",
"format": "uri",
"minLength": 1,
"maxLength": 2048
},
"uuidType": {
"description": "A version 4 (random) universally unique identifier
(UUID) as defined by [RFC 4122](https://tools.ietf.org/html/rfc4122#section-
4.1.3).",
"type": "string",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-
9A-Fa-f]{3}-[0-9A-Fa-f]{12}$"
},
"reference": {
"type": "object",
"required": ["url"],
"properties": {
"url": {
"description": "The uniform resource locator (URL), according
to [RFC 3986](https://tools.ietf.org/html/rfc3986#section-1.1.3), that can be used
to retrieve the referenced resource.",
"$ref": "#/definitions/uriType"
},
"name": {
"description": "User created name for the reference, often the
title of the page.",
"type": "string",
"maxLength": 512,
"minLength": 1
},
"tags": {
"description": "An array of one or more tags that describe the
resource referenced by 'url'.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"oneOf": [
{
"$ref": "#/definitions/tagExtension"
},
{
"$ref": "file:tags/reference-tags.json"
}
]
}
}
}
},
"cveId": {
"type": "string",
"pattern": "^CVE-[0-9]{4}-[0-9]{4,19}$"
},
"orgId": {
"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.",
"$ref": "#/definitions/uuidType"
},
"userId": {
"description": "A UUID for a user participating in the CVE program.
This UUID can be used to lookup the user record in the user registry service.",
"$ref": "#/definitions/uuidType"
},
"shortName": {
"description": "A 2-32 character name that can be used to complement an
organization's UUID.",
"type": "string",
"minLength": 2,
"maxLength": 32
},
"datestamp": {
"description": "Date/time format based on RFC3339 and ISO ISO8601.",
"type": "string",
"format": "date",
"pattern": "^((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579]
[26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]
{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-
(0[1-9]|[12][0-9]|30))$"
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Date/time format based on RFC3339 and ISO ISO8601, with
an optional timezone in the format 'yyyy-MM-ddTHH:mm:ssZZZZ'. If timezone offset is
not given, GMT (0000) is assumed.",
"pattern": "^(((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579]
[26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]
{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-
(0[1-9]|[12][0-9]|30)))T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|
[+-][0-9]{2}:[0-9]{2})?$"
},
"version": {
"description": "A single version of a product, as expressed in its own
version numbering scheme.",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"status": {
"description": "The vulnerability status of a given version or range of
versions of a product. The statuses 'affected' and 'unaffected' indicate that the
version is affected or unaffected by the vulnerability. The status 'unknown'
indicates that it is unknown or unspecified whether the given version is affected.
There can be many reasons for an 'unknown' status, including that an investigation
has not been undertaken or that a vendor has not disclosed the status.",
"type": "string",
"enum": ["affected", "unaffected", "unknown"]
},
"product": {
"type": "object",
"description": "Provides information about the set of products and
services affected by this vulnerability.",
"allOf": [
{
"anyOf": [
{"required": ["vendor", "product"]},
{"required": ["collectionURL", "packageName"]}
]
},
{
"anyOf": [
{"required": ["versions"]},
{"required": ["defaultStatus"]}
]
}
],
"properties": {
"vendor": {
"type": "string",
"description": "Name of the organization, project, community,
individual, or user that created or maintains this product or hosted service. Can
be 'N/A' if none of those apply. When collectionURL and packageName are used, this
field may optionally represent the user or account within the package collection
associated with the package.",
"minLength": 1,
"maxLength": 512
},
"product": {
"type": "string",
"description": "Name of the affected product.",
"minLength": 1,
"maxLength": 2048
},
"collectionURL": {
"description": "URL identifying a package collection
(determines the meaning of packageName).",
"$ref": "#/definitions/uriType",
"examples": [
"https://access.redhat.com/downloads/content/package-
browser",
"https://addons.mozilla.org",
"https://addons.thunderbird.net",
"https://anaconda.org/anaconda/repo",
"https://app.vagrantup.com/boxes/search",
"https://apps.apple.com",
"https://archlinux.org/packages",
"https://atmospherejs.meteor.com",
"https://atom.io/packages",
"https://bitbucket.org",
"https://bower.io",
"https://brew.sh/",
"https://chocolatey.org/packages",
"https://chrome.google.com/webstore",
"https://clojars.org",
"https://cocoapods.org",
"https://code.dlang.org",
"https://conan.io/center",
"https://cpan.org/modules",
"https://cran.r-project.org",
"https://crates.io",
"https://ctan.org/pkg",
"https://drupal.org",
"https://exchange.adobe.com",
"https://forge.puppet.com/modules",
"https://github.com",
"https://gitlab.com/explore",
"https://golang.org/pkg",
"https://guix.gnu.org/packages",
"https://hackage.haskell.org",
"https://helm.sh",
"https://hub.docker.com",
"https://juliahub.com",
"https://lib.haxe.org",
"https://luarocks.org",
"https://marketplace.visualstudio.com",
"https://melpa.org",
"https://microsoft.com/en-us/store/apps",
"https://nimble.directory",
"https://nuget.org/packages",
"https://opam.ocaml.org/packages",
"https://openwrt.org/packages/index",
"https://package.elm-lang.org",
"https://packagecontrol.io",
"https://packages.debian.org",
"https://packages.gentoo.org",
"https://packagist.org",
"https://pear.php.net/packages.php",
"https://pecl.php.net",
"https://platformio.org/lib",
"https://play.google.com/store",
"https://plugins.gradle.org",
"https://projects.eclipse.org",
"https://pub.dev",
"https://pypi.python.org",
"https://registry.npmjs.org",
"https://registry.terraform.io",
"https://repo.hex.pm",
"https://repo.maven.apache.org/maven2",
"https://rubygems.org",
"https://search.nixos.org/packages",
"https://sourceforge.net",
"https://wordpress.org/plugins"
]
},
"packageName": {
"type": "string",
"description": "Name or identifier of the affected software
package as used in the package collection.",
"minLength": 1,
"maxLength": 2048
},
"cpes": {
"type": "array",
"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.",
"uniqueItems": true,
"items": {
"title": "CPE Name",
"type": "string",
"description":"Common Platform Enumeration (CPE) Name in
either 2.2 or 2.3 format",
"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})",
"minLength": 1,
"maxLength": 2048
}
},
"modules": {
"type": "array",
"description": "A list of the affected components, features,
modules, sub-components, sub-products, APIs, commands, utilities, programs, or
functionalities (optional).",
"uniqueItems": true,
"items": {
"type": "string",
"description": "Name of the affected component, feature,
module, sub-component, sub-product, API, command, utility, program, or
functionality (optional).",
"minLength": 1,
"maxLength": 4096
}
},
"programFiles": {
"type": "array",
"description": "A list of the affected source code files
(optional).",
"uniqueItems": true,
"items": {
"description": "Name or path or location of the affected
source code file.",
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"programRoutines": {
"type": "array",
"description": "A list of the affected source code functions,
methods, subroutines, or procedures (optional).",
"uniqueItems": true,
"items": {
"type": "object",
"description": "An object describing program routine.",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the affected source code
file, function, method, subroutine, or procedure.",
"minLength": 1,
"maxLength": 4096
}
}
}
},
"platforms": {
"title": "Platforms",
"description": "List of specific platforms if the vulnerability
is only relevant in the context of these platforms (optional). Platforms may
include execution environments, operating systems, virtualization technologies,
hardware models, or computing architectures. The lack of this field or an empty
array implies that the other fields are applicable to all relevant platforms.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"examples": ["iOS", "Android", "Windows", "macOS", "x86",
"ARM", "64 bit", "Big Endian", "iPad", "Chromebook", "Docker", "Model T"],
"maxLength": 1024
}
},
"repo": {
"description": "The URL of the source code repository, for
informational purposes and/or to resolve git hash version ranges.",
"$ref": "#/definitions/uriType"
},
"defaultStatus": {
"description": "The default status for versions that are not
otherwise listed in the versions list. If not specified, defaultStatus defaults to
'unknown'. Versions or defaultStatus may be omitted, but not both.",
"$ref": "#/definitions/status"
},
"versions": {
"type": "array",
"description": "Set of product versions or version ranges
related to the vulnerability. The versions satisfy the CNA Rules [8.1.2
requirement](https://cve.mitre.org/cve/cna/rules.html#section_8-
1_cve_entry_information_requirements). Versions or defaultStatus may be omitted,
but not both.",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"description": "A single version or a range of versions,
with vulnerability status.\n\nAn entry with only 'version' and 'status' indicates
the status of a single version.\n\nOtherwise, an entry describes a range; it must
include the 'versionType' property, to define the version numbering semantics in
use, and 'limit', to indicate the non-inclusive upper limit of the range. The
object describes the status for versions V such that 'version' <= V and V <
'limit', using the <= and < semantics defined for the specific kind of
'versionType'. Status changes within the range can be specified by an optional
'changes' list.\n\nThe algorithm to decide the status specified for a version V
is:\n\n\tfor entry in product.versions {\n\t\tif entry.lessThan is not present and
entry.lessThanOrEqual is not present and v == entry.version {\n\t\t\treturn
entry.status\n\t\t}\n\t\tif (entry.lessThan is present and entry.version <= v and v
< entry.lessThan) or\n\t\t (entry.lessThanOrEqual is present and entry.version <=
v and v <= entry.lessThanOrEqual) { // <= and < defined by entry.versionType\n\t\t\
tstatus = entry.status\n\t\t\tfor change in entry.changes {\n\t\t\t\tif change.at
<= v {\n\t\t\t\t\tstatus = change.status\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn status\
n\t\t}\n\t}\n\treturn product.defaultStatus\n\n.",
"oneOf": [
{
"required": ["version", "status"],
"maxProperties": 2
},
{
"required": ["version", "status", "versionType"],
"oneOf": [
{"required": ["lessThan"]},
{"required": ["lessThanOrEqual"]}
]
}
],
"properties": {
"version": {
"description": "The single version being described,
or the version at the start of the range. By convention, typically 0 denotes the
earliest possible version.",
"$ref": "#/definitions/version"
},
"status": {
"description": "The vulnerability status for the
version or range of versions. For a range, the status may be refined by the
'changes' list.",
"$ref": "#/definitions/status"
},
"versionType": {
"type": "string",
"description": "The version numbering system used
for specifying the range. This defines the exact semantics of the comparison (less-
than) operation on versions, which is required to understand the range itself.
'Custom' indicates that the version type is unspecified and should be avoided
whenever possible. It is included primarily for use in conversion of older data
files.",
"minLength": 1,
"maxLength": 128,
"examples": [
"custom",
"git",
"maven",
"python",
"rpm",
"semver"
]
},
"lessThan": {
"description": "The non-inclusive upper limit of
the range. This is the least version NOT in the range. The usual version syntax is
expanded to allow a pattern to end in an asterisk `(*)`, indicating an arbitrarily
large number in the version ordering. For example, `{version: 1.0 lessThan: 1.*}`
would describe the entire 1.X branch for most range kinds, and `{version: 2.0,
lessThan: *}` describes all versions starting at 2.0, including 3.0, 5.1, and so
on. Only one of lessThan and lessThanOrEqual should be specified.",
"$ref": "#/definitions/version"
},
"lessThanOrEqual": {
"description": "The inclusive upper limit of the
range. This is the greatest version contained in the range. Only one of lessThan
and lessThanOrEqual should be specified. For example, `{version: 1.0,
lessThanOrEqual: 1.3}` covers all versions from 1.0 up to and including 1.3.",
"$ref": "#/definitions/version"
},
"changes": {
"type": "array",
"description": "A list of status changes that take
place during the range. The array should be sorted in increasing order by the 'at'
field, according to the versionType, but clients must re-sort the list themselves
rather than assume it is sorted.",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"description": "The start of a single status
change during the range.",
"required": ["at", "status"],
"properties": {
"at": {
"description": "The version at which a
status change occurs.",
"$ref": "#/definitions/version"
},
"status": {
"description": "The new status in the
range starting at the given version.",
"$ref": "#/definitions/status"
}
}
}
}
}
}
}
}
},
"dataType": {
"description": "Indicates the type of information represented in the
JSON instance.",
"type": "string",
"enum": [
"CVE_RECORD"
]
},
"dataVersion": {
"description": "The version of the schema being used. Used to support
multiple versions of this format.",
"type": "string",
"enum": ["5.0"]
},
"cveMetadataPublished": {
"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.",
"type": "object",
"required": [
"cveId",
"assignerOrgId",
"state"
],
"properties": {
"cveId": {
"description": "The CVE identifier that this record pertains
to.",
"$ref": "#/definitions/cveId"
},
"assignerOrgId": {
"$ref": "#/definitions/orgId",
"description": "The UUID for the organization to which the CVE
ID was originally assigned. This UUID can be used to lookup the organization record
in the user registry service."
},
"assignerShortName": {
"$ref": "#/definitions/shortName",
"description": "The short name for the organization to which
the CVE ID was originally assigned."
},
"requesterUserId": {
"$ref": "#/definitions/userId",
"description": "The user that requested the CVE identifier."
},
"dateUpdated": {
"description": "The date/time the record was last updated.",
"$ref": "#/definitions/timestamp"
},
"serial": {
"type": "integer",
"minimum": 1,
"description": "The system of record causes this to start at 1,
and increment by 1 each time a submission from a data provider changes this CVE
Record. The incremented value moves to the Rejected schema upon a PUBLISHED-
>REJECTED transition, and moves to the Published schema upon a REJECTED->PUBLISHED
transition."
},
"dateReserved": {
"$ref": "#/definitions/timestamp",
"description": "The date/time this CVE ID was reserved in the
CVE automation workgroup services system. Disclaimer: This date reflects when the
CVE ID was reserved, and does not necessarily indicate when this vulnerability was
discovered, shared with the affected vendor, publicly disclosed, or updated in
CVE."
},
"datePublished": {
"$ref": "#/definitions/timestamp",
"description": "The date/time the CVE Record was first
published in the CVE List."
},
"state": {
"description": "State of CVE - PUBLISHED, REJECTED.",
"type": "string",
"enum": ["PUBLISHED"]
}
},
"additionalProperties": false
},
"cveMetadataRejected": {
"type": "object",
"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.",
"required": [
"cveId",
"assignerOrgId",
"state"
],
"properties": {
"cveId": {
"description": "The CVE identifier that this record pertains
to.",
"$ref": "#/definitions/cveId"
},
"assignerOrgId": {
"$ref": "#/definitions/orgId",
"description": "The UUID for the organization to which the CVE
ID was originally assigned."
},
"assignerShortName": {
"$ref": "#/definitions/shortName",
"description": "The short name for the organization to which
the CVE ID was originally assigned."
},
"serial": {
"type": "integer",
"minimum": 1,
"description": "The system of record causes this to start at 1,
and increment by 1 each time a submission from a data provider changes this CVE
Record. The incremented value moves to the Rejected schema upon a PUBLISHED-
>REJECTED transition, and moves to the Published schema upon a REJECTED->PUBLISHED
transition."
},
"dateUpdated": {
"description": "The date/time the record was last updated.",
"$ref": "#/definitions/timestamp"
},
"datePublished": {
"$ref": "#/definitions/timestamp",
"description": "The date/time the CVE Record was first
published in the CVE List."
},
"dateRejected": {
"$ref": "#/definitions/timestamp",
"description": "The date/time the CVE ID was rejected."
},
"state": {
"type": "string",