specification/schema/2.0/cyclonedx-2.0.schema.json at 7d3546b3a0e8c562ae07170d9391ae514505a0e1 · CycloneDX/specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://cyclonedx.org/schema/2.0/cyclonedx-2.0.schema.json",
  "type": "object",
  "title": "CycloneDX Transparency Expression Language",
  "$comment" : "OWASP CycloneDX is an Ecma International standard (ECMA-424) developed in collaboration between the OWASP Foundation and Ecma Technical Committee 54 (TC54). The standard is published under a royalty-free patent policy. This JSON schema is the reference implementation and is licensed under the Apache License 2.0.",
  "required": [
    "specFormat",
    "specVersion"
  ],
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "type": "string"
    },
    "specFormat": {
      "type": "string",
      "title": "Specification Format",
      "description": "Specifies the format. This value shall be \"CycloneDX\".",
      "enum": [
        "CycloneDX"
      ]
    },
    "specVersion": {
      "type": "string",
      "title": "Specification Version",
      "description": "The version of the CycloneDX specification the BOM conforms to.",
      "examples": [
        "2.0"
      ]
    },
    "serialNumber": {
      "type": "string",
      "title": "BOM Serial Number",
      "description": "Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number must conform to [RFC 4122](https://www.ietf.org/rfc/rfc4122.html). Use of serial numbers is recommended.",
      "examples": [
        "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"
      ],
      "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
    },
    "version": {
      "type": "integer",
      "title": "BOM Version",
      "description": "Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is '1'.",
      "minimum": 1,
      "default": 1
    },
    "metadata": {
      "$ref": "model/cyclonedx-metadata-2.0.schema.json#/$defs/metadata"
    },
    "components": {
      "$ref": "model/cyclonedx-component-2.0.schema.json#/$defs/components",
      "description": "A collection of components. When a metadata component is present, this array represents the inventory of components associated with that subject, forming a bill of materials. When the metadata component is omitted, the array provides component data for interchange purposes without establishing a compositional relationship."
    },
    "services": {
      "$ref": "model/cyclonedx-service-2.0.schema.json#/$defs/services"
    },
    "dependencies": {
      "$ref": "model/cyclonedx-dependency-2.0.schema.json#/$defs/dependencies"
    },
    "compositions": {
      "$ref": "model/cyclonedx-composition-2.0.schema.json#/$defs/compositions"
    },
    "vulnerabilities": {
      "$ref": "model/cyclonedx-vulnerability-2.0.schema.json#/$defs/vulnerabilities"
    },
    "annotations": {
      "$ref": "model/cyclonedx-annotation-2.0.schema.json#/$defs/annotations"
    },
    "formulation": {
      "$ref": "model/cyclonedx-formulation-2.0.schema.json#/$defs/formulation"
    },
    "declarations": {
      "$ref": "model/cyclonedx-declaration-2.0.schema.json#/$defs/declarations"
    },
    "definitions": {
      "$ref": "model/cyclonedx-definition-2.0.schema.json#/$defs/definitions"
    },
    "citations": {
      "$ref": "model/cyclonedx-citation-2.0.schema.json#/$defs/citations"
    },
    "properties": {
      "$ref": "model/cyclonedx-common-2.0.schema.json#/$defs/properties"
    },
    "externalReferences": {
      "$ref": "model/cyclonedx-common-2.0.schema.json#/$defs/externalReferences"
    },
    "signatures": {
      "$ref": "model/cyclonedx-common-2.0.schema.json#/$defs/signatures"
    }
  },
  "allOf": [
    { "$ref": "model/cyclonedx-common-2.0.schema.json#/$defs/extensibleProperties" }
  ]
}