CycloneDX v1.6 JSON Reference

Type: object
No Additional Properties

Type: enum (of string)

Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention, nor does JSON schema support namespaces. This value must be "CycloneDX".

Must be one of:

  • "CycloneDX"

Type: string

The version of the CycloneDX specification the BOM conforms to.


Example:

"1.6.1"

Type: string

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. Use of serial numbers is recommended.

Must match regular expression: ^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"

Type: integer Default: 1

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

Value must be greater or equal to 1


Example:

1

Type: object

Provides additional information about a BOM.

No Additional Properties

Type: stringFormat: date-time

The date and time (timestamp) when the BOM was created.

Type: array of object

Lifecycles communicate the stage(s) in which data in the BOM was captured. Different types of data may be available at various phases of a lifecycle, such as the Software Development Lifecycle (SDLC), IT Asset Management (ITAM), and Software Asset Management (SAM). Thus, a BOM may include data specific to or only obtainable in a given lifecycle.

No Additional Items

Each item of this array must be:


The product lifecycle(s) that this BOM represents.

Type: object
No Additional Properties

Type: enum (of string)

A pre-defined phase in the product lifecycle.

Must be one of:

  • "design"
  • "pre-build"
  • "build"
  • "post-build"
  • "operations"
  • "discovery"
  • "decommission"
Type: object
No Additional Properties

Type: string

The name of the lifecycle phase

Type: string

The description of the lifecycle phase


The tool(s) used in the creation, enrichment, and validation of the BOM.

Type: object

The tool(s) used in the creation, enrichment, and validation of the BOM.

No Additional Properties

Type: array

A list of software and hardware components used as tools.

All items must be unique

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string)

Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.

Must be one of:

  • "application"
  • "framework"
  • "library"
  • "container"
  • "platform"
  • "operating-system"
  • "device"
  • "device-driver"
  • "firmware"
  • "file"
  • "machine-learning-model"
  • "data"
  • "cryptographic-asset"

Example:

"library"

Type: string

The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented, such as an image, font, or executable. Some library or framework components may also have an associated mime-type.

Must match regular expression: ^[-+a-z0-9.]+/[-+a-z0-9.]+$
Example:

"image/jpeg"

Type: string

An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: object

The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The organization that created the component.
Manufacturer is common in components created through automated processes. Components created through manual means may have @.authors instead.

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: array

The person(s) who created the component.
Authors are common in components created through manual processes. Components created through automated means may have @.manufacturer instead.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: string

[Deprecated] This will be removed in a future version. Use @.authors or @.manufacturer instead.
The person(s) or organization(s) that authored the component


Example:

"Acme Inc"

Type: string

The person(s) or organization(s) that published the component


Example:

"Acme Inc"

Type: string

The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.


Example:

"com.acme"

Type: string

The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery


Example:

"tomcat-catalina"

Type: string

The component version. The version should ideally comply with semantic versioning but is not enforced.

Must be at most 1024 characters long


Examples:

"9.0.14"
"v1.33.7"
"7.0.0-M1"
"2.0pre1"
"1.0.0-beta1"
"0.8.15"

Type: string

Specifies a description for the component

Type: enum (of string) Default: "required"

Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.

Must be one of:

  • "required"
  • "optional"
  • "excluded"

Type: array

The hashes of the component.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string)

The algorithm that generated the hash value.

Must be one of:

  • "MD5"
  • "SHA-1"
  • "SHA-256"
  • "SHA-384"
  • "SHA-512"
  • "SHA3-256"
  • "SHA3-384"
  • "SHA3-512"
  • "BLAKE2b-256"
  • "BLAKE2b-384"
  • "BLAKE2b-512"
  • "BLAKE3"

Type: string

The value of the hash.

Must match regular expression: ^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$
Example:

"3942447fac867ae5cdb3229b658f4d48"

Type: array

EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)

Type: array of object

A list of SPDX licenses and/or named licenses.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: object

Specifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.

No Additional Properties

Type: object

The following properties are required:

  • id
Type: object

The following properties are required:

  • name

Type: string

An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: enum (of string)

A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.

Must be one of:

  • "0BSD"
  • "3D-Slicer-1.0"
  • "AAL"
  • "Abstyles"
  • "AdaCore-doc"
  • "Adobe-2006"
  • "Adobe-Display-PostScript"
  • "Adobe-Glyph"
  • "Adobe-Utopia"
  • "ADSL"
  • "AFL-1.1"
  • "AFL-1.2"
  • "AFL-2.0"
  • "AFL-2.1"
  • "AFL-3.0"
  • "Afmparse"
  • "AGPL-1.0"
  • "AGPL-1.0-only"
  • "AGPL-1.0-or-later"
  • "AGPL-3.0"
  • "AGPL-3.0-only"
  • "AGPL-3.0-or-later"
  • "Aladdin"
  • "AMD-newlib"
  • "AMDPLPA"
  • "AML"
  • "AML-glslang"
  • "AMPAS"
  • "ANTLR-PD"
  • "ANTLR-PD-fallback"
  • "any-OSI"
  • "Apache-1.0"
  • "Apache-1.1"
  • "Apache-2.0"
  • "APAFML"
  • "APL-1.0"
  • "App-s2p"
  • "APSL-1.0"
  • "APSL-1.1"
  • "APSL-1.2"
  • "APSL-2.0"
  • "Arphic-1999"
  • "Artistic-1.0"
  • "Artistic-1.0-cl8"
  • "Artistic-1.0-Perl"
  • "Artistic-2.0"
  • "ASWF-Digital-Assets-1.0"
  • "ASWF-Digital-Assets-1.1"
  • "Baekmuk"
  • "Bahyph"
  • "Barr"
  • "bcrypt-Solar-Designer"
  • "Beerware"
  • "Bitstream-Charter"
  • "Bitstream-Vera"
  • "BitTorrent-1.0"
  • "BitTorrent-1.1"
  • "blessing"
  • "BlueOak-1.0.0"
  • "Boehm-GC"
  • "Borceux"
  • "Brian-Gladman-2-Clause"
  • "Brian-Gladman-3-Clause"
  • "BSD-1-Clause"
  • "BSD-2-Clause"
  • "BSD-2-Clause-Darwin"
  • "BSD-2-Clause-first-lines"
  • "BSD-2-Clause-FreeBSD"
  • "BSD-2-Clause-NetBSD"
  • "BSD-2-Clause-Patent"
  • "BSD-2-Clause-Views"
  • "BSD-3-Clause"
  • "BSD-3-Clause-acpica"
  • "BSD-3-Clause-Attribution"
  • "BSD-3-Clause-Clear"
  • "BSD-3-Clause-flex"
  • "BSD-3-Clause-HP"
  • "BSD-3-Clause-LBNL"
  • "BSD-3-Clause-Modification"
  • "BSD-3-Clause-No-Military-License"
  • "BSD-3-Clause-No-Nuclear-License"
  • "BSD-3-Clause-No-Nuclear-License-2014"
  • "BSD-3-Clause-No-Nuclear-Warranty"
  • "BSD-3-Clause-Open-MPI"
  • "BSD-3-Clause-Sun"
  • "BSD-4-Clause"
  • "BSD-4-Clause-Shortened"
  • "BSD-4-Clause-UC"
  • "BSD-4.3RENO"
  • "BSD-4.3TAHOE"
  • "BSD-Advertising-Acknowledgement"
  • "BSD-Attribution-HPND-disclaimer"
  • "BSD-Inferno-Nettverk"
  • "BSD-Protection"
  • "BSD-Source-beginning-file"
  • "BSD-Source-Code"
  • "BSD-Systemics"
  • "BSD-Systemics-W3Works"
  • "BSL-1.0"
  • "BUSL-1.1"
  • "bzip2-1.0.5"
  • "bzip2-1.0.6"
  • "C-UDA-1.0"
  • "CAL-1.0"
  • "CAL-1.0-Combined-Work-Exception"
  • "Caldera"
  • "Caldera-no-preamble"
  • "Catharon"
  • "CATOSL-1.1"
  • "CC-BY-1.0"
  • "CC-BY-2.0"
  • "CC-BY-2.5"
  • "CC-BY-2.5-AU"
  • "CC-BY-3.0"
  • "CC-BY-3.0-AT"
  • "CC-BY-3.0-AU"
  • "CC-BY-3.0-DE"
  • "CC-BY-3.0-IGO"
  • "CC-BY-3.0-NL"
  • "CC-BY-3.0-US"
  • "CC-BY-4.0"
  • "CC-BY-NC-1.0"
  • "CC-BY-NC-2.0"
  • "CC-BY-NC-2.5"
  • "CC-BY-NC-3.0"
  • "CC-BY-NC-3.0-DE"
  • "CC-BY-NC-4.0"
  • "CC-BY-NC-ND-1.0"
  • "CC-BY-NC-ND-2.0"
  • "CC-BY-NC-ND-2.5"
  • "CC-BY-NC-ND-3.0"
  • "CC-BY-NC-ND-3.0-DE"
  • "CC-BY-NC-ND-3.0-IGO"
  • "CC-BY-NC-ND-4.0"
  • "CC-BY-NC-SA-1.0"
  • "CC-BY-NC-SA-2.0"
  • "CC-BY-NC-SA-2.0-DE"
  • "CC-BY-NC-SA-2.0-FR"
  • "CC-BY-NC-SA-2.0-UK"
  • "CC-BY-NC-SA-2.5"
  • "CC-BY-NC-SA-3.0"
  • "CC-BY-NC-SA-3.0-DE"
  • "CC-BY-NC-SA-3.0-IGO"
  • "CC-BY-NC-SA-4.0"
  • "CC-BY-ND-1.0"
  • "CC-BY-ND-2.0"
  • "CC-BY-ND-2.5"
  • "CC-BY-ND-3.0"
  • "CC-BY-ND-3.0-DE"
  • "CC-BY-ND-4.0"
  • "CC-BY-SA-1.0"
  • "CC-BY-SA-2.0"
  • "CC-BY-SA-2.0-UK"
  • "CC-BY-SA-2.1-JP"
  • "CC-BY-SA-2.5"
  • "CC-BY-SA-3.0"
  • "CC-BY-SA-3.0-AT"
  • "CC-BY-SA-3.0-DE"
  • "CC-BY-SA-3.0-IGO"
  • "CC-BY-SA-4.0"
  • "CC-PDDC"
  • "CC0-1.0"
  • "CDDL-1.0"
  • "CDDL-1.1"
  • "CDL-1.0"
  • "CDLA-Permissive-1.0"
  • "CDLA-Permissive-2.0"
  • "CDLA-Sharing-1.0"
  • "CECILL-1.0"
  • "CECILL-1.1"
  • "CECILL-2.0"
  • "CECILL-2.1"
  • "CECILL-B"
  • "CECILL-C"
  • "CERN-OHL-1.1"
  • "CERN-OHL-1.2"
  • "CERN-OHL-P-2.0"
  • "CERN-OHL-S-2.0"
  • "CERN-OHL-W-2.0"
  • "CFITSIO"
  • "check-cvs"
  • "checkmk"
  • "ClArtistic"
  • "Clips"
  • "CMU-Mach"
  • "CMU-Mach-nodoc"
  • "CNRI-Jython"
  • "CNRI-Python"
  • "CNRI-Python-GPL-Compatible"
  • "COIL-1.0"
  • "Community-Spec-1.0"
  • "Condor-1.1"
  • "copyleft-next-0.3.0"
  • "copyleft-next-0.3.1"
  • "Cornell-Lossless-JPEG"
  • "CPAL-1.0"
  • "CPL-1.0"
  • "CPOL-1.02"
  • "Cronyx"
  • "Crossword"
  • "CrystalStacker"
  • "CUA-OPL-1.0"
  • "Cube"
  • "curl"
  • "cve-tou"
  • "D-FSL-1.0"
  • "DEC-3-Clause"
  • "diffmark"
  • "DL-DE-BY-2.0"
  • "DL-DE-ZERO-2.0"
  • "DOC"
  • "Dotseqn"
  • "DRL-1.0"
  • "DRL-1.1"
  • "DSDP"
  • "dtoa"
  • "dvipdfm"
  • "ECL-1.0"
  • "ECL-2.0"
  • "eCos-2.0"
  • "EFL-1.0"
  • "EFL-2.0"
  • "eGenix"
  • "Elastic-2.0"
  • "Entessa"
  • "EPICS"
  • "EPL-1.0"
  • "EPL-2.0"
  • "ErlPL-1.1"
  • "etalab-2.0"
  • "EUDatagrid"
  • "EUPL-1.0"
  • "EUPL-1.1"
  • "EUPL-1.2"
  • "Eurosym"
  • "Fair"
  • "FBM"
  • "FDK-AAC"
  • "Ferguson-Twofish"
  • "Frameworx-1.0"
  • "FreeBSD-DOC"
  • "FreeImage"
  • "FSFAP"
  • "FSFAP-no-warranty-disclaimer"
  • "FSFUL"
  • "FSFULLR"
  • "FSFULLRWD"
  • "FTL"
  • "Furuseth"
  • "fwlw"
  • "GCR-docs"
  • "GD"
  • "GFDL-1.1"
  • "GFDL-1.1-invariants-only"
  • "GFDL-1.1-invariants-or-later"
  • "GFDL-1.1-no-invariants-only"
  • "GFDL-1.1-no-invariants-or-later"
  • "GFDL-1.1-only"
  • "GFDL-1.1-or-later"
  • "GFDL-1.2"
  • "GFDL-1.2-invariants-only"
  • "GFDL-1.2-invariants-or-later"
  • "GFDL-1.2-no-invariants-only"
  • "GFDL-1.2-no-invariants-or-later"
  • "GFDL-1.2-only"
  • "GFDL-1.2-or-later"
  • "GFDL-1.3"
  • "GFDL-1.3-invariants-only"
  • "GFDL-1.3-invariants-or-later"
  • "GFDL-1.3-no-invariants-only"
  • "GFDL-1.3-no-invariants-or-later"
  • "GFDL-1.3-only"
  • "GFDL-1.3-or-later"
  • "Giftware"
  • "GL2PS"
  • "Glide"
  • "Glulxe"
  • "GLWTPL"
  • "gnuplot"
  • "GPL-1.0"
  • "GPL-1.0+"
  • "GPL-1.0-only"
  • "GPL-1.0-or-later"
  • "GPL-2.0"
  • "GPL-2.0+"
  • "GPL-2.0-only"
  • "GPL-2.0-or-later"
  • "GPL-2.0-with-autoconf-exception"
  • "GPL-2.0-with-bison-exception"
  • "GPL-2.0-with-classpath-exception"
  • "GPL-2.0-with-font-exception"
  • "GPL-2.0-with-GCC-exception"
  • "GPL-3.0"
  • "GPL-3.0+"
  • "GPL-3.0-only"
  • "GPL-3.0-or-later"
  • "GPL-3.0-with-autoconf-exception"
  • "GPL-3.0-with-GCC-exception"
  • "Graphics-Gems"
  • "gSOAP-1.3b"
  • "gtkbook"
  • "Gutmann"
  • "HaskellReport"
  • "hdparm"
  • "Hippocratic-2.1"
  • "HP-1986"
  • "HP-1989"
  • "HPND"
  • "HPND-DEC"
  • "HPND-doc"
  • "HPND-doc-sell"
  • "HPND-export-US"
  • "HPND-export-US-acknowledgement"
  • "HPND-export-US-modify"
  • "HPND-export2-US"
  • "HPND-Fenneberg-Livingston"
  • "HPND-INRIA-IMAG"
  • "HPND-Intel"
  • "HPND-Kevlin-Henney"
  • "HPND-Markus-Kuhn"
  • "HPND-merchantability-variant"
  • "HPND-MIT-disclaimer"
  • "HPND-Pbmplus"
  • "HPND-sell-MIT-disclaimer-xserver"
  • "HPND-sell-regexpr"
  • "HPND-sell-variant"
  • "HPND-sell-variant-MIT-disclaimer"
  • "HPND-sell-variant-MIT-disclaimer-rev"
  • "HPND-UC"
  • "HPND-UC-export-US"
  • "HTMLTIDY"
  • "IBM-pibs"
  • "ICU"
  • "IEC-Code-Components-EULA"
  • "IJG"
  • "IJG-short"
  • "ImageMagick"
  • "iMatix"
  • "Imlib2"
  • "Info-ZIP"
  • "Inner-Net-2.0"
  • "Intel"
  • "Intel-ACPI"
  • "Interbase-1.0"
  • "IPA"
  • "IPL-1.0"
  • "ISC"
  • "ISC-Veillard"
  • "Jam"
  • "JasPer-2.0"
  • "JPL-image"
  • "JPNIC"
  • "JSON"
  • "Kastrup"
  • "Kazlib"
  • "Knuth-CTAN"
  • "LAL-1.2"
  • "LAL-1.3"
  • "Latex2e"
  • "Latex2e-translated-notice"
  • "Leptonica"
  • "LGPL-2.0"
  • "LGPL-2.0+"
  • "LGPL-2.0-only"
  • "LGPL-2.0-or-later"
  • "LGPL-2.1"
  • "LGPL-2.1+"
  • "LGPL-2.1-only"
  • "LGPL-2.1-or-later"
  • "LGPL-3.0"
  • "LGPL-3.0+"
  • "LGPL-3.0-only"
  • "LGPL-3.0-or-later"
  • "LGPLLR"
  • "Libpng"
  • "libpng-2.0"
  • "libselinux-1.0"
  • "libtiff"
  • "libutil-David-Nugent"
  • "LiLiQ-P-1.1"
  • "LiLiQ-R-1.1"
  • "LiLiQ-Rplus-1.1"
  • "Linux-man-pages-1-para"
  • "Linux-man-pages-copyleft"
  • "Linux-man-pages-copyleft-2-para"
  • "Linux-man-pages-copyleft-var"
  • "Linux-OpenIB"
  • "LOOP"
  • "LPD-document"
  • "LPL-1.0"
  • "LPL-1.02"
  • "LPPL-1.0"
  • "LPPL-1.1"
  • "LPPL-1.2"
  • "LPPL-1.3a"
  • "LPPL-1.3c"
  • "lsof"
  • "Lucida-Bitmap-Fonts"
  • "LZMA-SDK-9.11-to-9.20"
  • "LZMA-SDK-9.22"
  • "Mackerras-3-Clause"
  • "Mackerras-3-Clause-acknowledgment"
  • "magaz"
  • "mailprio"
  • "MakeIndex"
  • "Martin-Birgmeier"
  • "McPhee-slideshow"
  • "metamail"
  • "Minpack"
  • "MirOS"
  • "MIT"
  • "MIT-0"
  • "MIT-advertising"
  • "MIT-CMU"
  • "MIT-enna"
  • "MIT-feh"
  • "MIT-Festival"
  • "MIT-Khronos-old"
  • "MIT-Modern-Variant"
  • "MIT-open-group"
  • "MIT-testregex"
  • "MIT-Wu"
  • "MITNFA"
  • "MMIXware"
  • "Motosoto"
  • "MPEG-SSG"
  • "mpi-permissive"
  • "mpich2"
  • "MPL-1.0"
  • "MPL-1.1"
  • "MPL-2.0"
  • "MPL-2.0-no-copyleft-exception"
  • "mplus"
  • "MS-LPL"
  • "MS-PL"
  • "MS-RL"
  • "MTLL"
  • "MulanPSL-1.0"
  • "MulanPSL-2.0"
  • "Multics"
  • "Mup"
  • "NAIST-2003"
  • "NASA-1.3"
  • "Naumen"
  • "NBPL-1.0"
  • "NCBI-PD"
  • "NCGL-UK-2.0"
  • "NCL"
  • "NCSA"
  • "Net-SNMP"
  • "NetCDF"
  • "Newsletr"
  • "NGPL"
  • "NICTA-1.0"
  • "NIST-PD"
  • "NIST-PD-fallback"
  • "NIST-Software"
  • "NLOD-1.0"
  • "NLOD-2.0"
  • "NLPL"
  • "Nokia"
  • "NOSL"
  • "Noweb"
  • "NPL-1.0"
  • "NPL-1.1"
  • "NPOSL-3.0"
  • "NRL"
  • "NTP"
  • "NTP-0"
  • "Nunit"
  • "O-UDA-1.0"
  • "OAR"
  • "OCCT-PL"
  • "OCLC-2.0"
  • "ODbL-1.0"
  • "ODC-By-1.0"
  • "OFFIS"
  • "OFL-1.0"
  • "OFL-1.0-no-RFN"
  • "OFL-1.0-RFN"
  • "OFL-1.1"
  • "OFL-1.1-no-RFN"
  • "OFL-1.1-RFN"
  • "OGC-1.0"
  • "OGDL-Taiwan-1.0"
  • "OGL-Canada-2.0"
  • "OGL-UK-1.0"
  • "OGL-UK-2.0"
  • "OGL-UK-3.0"
  • "OGTSL"
  • "OLDAP-1.1"
  • "OLDAP-1.2"
  • "OLDAP-1.3"
  • "OLDAP-1.4"
  • "OLDAP-2.0"
  • "OLDAP-2.0.1"
  • "OLDAP-2.1"
  • "OLDAP-2.2"
  • "OLDAP-2.2.1"
  • "OLDAP-2.2.2"
  • "OLDAP-2.3"
  • "OLDAP-2.4"
  • "OLDAP-2.5"
  • "OLDAP-2.6"
  • "OLDAP-2.7"
  • "OLDAP-2.8"
  • "OLFL-1.3"
  • "OML"
  • "OpenPBS-2.3"
  • "OpenSSL"
  • "OpenSSL-standalone"
  • "OpenVision"
  • "OPL-1.0"
  • "OPL-UK-3.0"
  • "OPUBL-1.0"
  • "OSET-PL-2.1"
  • "OSL-1.0"
  • "OSL-1.1"
  • "OSL-2.0"
  • "OSL-2.1"
  • "OSL-3.0"
  • "PADL"
  • "Parity-6.0.0"
  • "Parity-7.0.0"
  • "PDDL-1.0"
  • "PHP-3.0"
  • "PHP-3.01"
  • "Pixar"
  • "pkgconf"
  • "Plexus"
  • "pnmstitch"
  • "PolyForm-Noncommercial-1.0.0"
  • "PolyForm-Small-Business-1.0.0"
  • "PostgreSQL"
  • "PPL"
  • "PSF-2.0"
  • "psfrag"
  • "psutils"
  • "Python-2.0"
  • "Python-2.0.1"
  • "python-ldap"
  • "Qhull"
  • "QPL-1.0"
  • "QPL-1.0-INRIA-2004"
  • "radvd"
  • "Rdisc"
  • "RHeCos-1.1"
  • "RPL-1.1"
  • "RPL-1.5"
  • "RPSL-1.0"
  • "RSA-MD"
  • "RSCPL"
  • "Ruby"
  • "SAX-PD"
  • "SAX-PD-2.0"
  • "Saxpath"
  • "SCEA"
  • "SchemeReport"
  • "Sendmail"
  • "Sendmail-8.23"
  • "SGI-B-1.0"
  • "SGI-B-1.1"
  • "SGI-B-2.0"
  • "SGI-OpenGL"
  • "SGP4"
  • "SHL-0.5"
  • "SHL-0.51"
  • "SimPL-2.0"
  • "SISSL"
  • "SISSL-1.2"
  • "SL"
  • "Sleepycat"
  • "SMLNJ"
  • "SMPPL"
  • "SNIA"
  • "snprintf"
  • "softSurfer"
  • "Soundex"
  • "Spencer-86"
  • "Spencer-94"
  • "Spencer-99"
  • "SPL-1.0"
  • "ssh-keyscan"
  • "SSH-OpenSSH"
  • "SSH-short"
  • "SSLeay-standalone"
  • "SSPL-1.0"
  • "StandardML-NJ"
  • "SugarCRM-1.1.3"
  • "Sun-PPP"
  • "Sun-PPP-2000"
  • "SunPro"
  • "SWL"
  • "swrule"
  • "Symlinks"
  • "TAPR-OHL-1.0"
  • "TCL"
  • "TCP-wrappers"
  • "TermReadKey"
  • "TGPPL-1.0"
  • "threeparttable"
  • "TMate"
  • "TORQUE-1.1"
  • "TOSL"
  • "TPDL"
  • "TPL-1.0"
  • "TTWL"
  • "TTYP0"
  • "TU-Berlin-1.0"
  • "TU-Berlin-2.0"
  • "UCAR"
  • "UCL-1.0"
  • "ulem"
  • "UMich-Merit"
  • "Unicode-3.0"
  • "Unicode-DFS-2015"
  • "Unicode-DFS-2016"
  • "Unicode-TOU"
  • "UnixCrypt"
  • "Unlicense"
  • "UPL-1.0"
  • "URT-RLE"
  • "Vim"
  • "VOSTROM"
  • "VSL-1.0"
  • "W3C"
  • "W3C-19980720"
  • "W3C-20150513"
  • "w3m"
  • "Watcom-1.0"
  • "Widget-Workshop"
  • "Wsuipa"
  • "WTFPL"
  • "wxWindows"
  • "X11"
  • "X11-distribute-modifications-variant"
  • "Xdebug-1.03"
  • "Xerox"
  • "Xfig"
  • "XFree86-1.1"
  • "xinetd"
  • "xkeyboard-config-Zinoviev"
  • "xlock"
  • "Xnet"
  • "xpp"
  • "XSkat"
  • "xzoom"
  • "YPL-1.0"
  • "YPL-1.1"
  • "Zed"
  • "Zeeff"
  • "Zend-2.0"
  • "Zimbra-1.3"
  • "Zimbra-1.4"
  • "Zlib"
  • "zlib-acknowledgement"
  • "ZPL-1.1"
  • "ZPL-2.0"
  • "ZPL-2.1"
  • "389-exception"
  • "Asterisk-exception"
  • "Asterisk-linking-protocols-exception"
  • "Autoconf-exception-2.0"
  • "Autoconf-exception-3.0"
  • "Autoconf-exception-generic"
  • "Autoconf-exception-generic-3.0"
  • "Autoconf-exception-macro"
  • "Bison-exception-1.24"
  • "Bison-exception-2.2"
  • "Bootloader-exception"
  • "Classpath-exception-2.0"
  • "CLISP-exception-2.0"
  • "cryptsetup-OpenSSL-exception"
  • "DigiRule-FOSS-exception"
  • "eCos-exception-2.0"
  • "Fawkes-Runtime-exception"
  • "FLTK-exception"
  • "fmt-exception"
  • "Font-exception-2.0"
  • "freertos-exception-2.0"
  • "GCC-exception-2.0"
  • "GCC-exception-2.0-note"
  • "GCC-exception-3.1"
  • "Gmsh-exception"
  • "GNAT-exception"
  • "GNOME-examples-exception"
  • "GNU-compiler-exception"
  • "gnu-javamail-exception"
  • "GPL-3.0-interface-exception"
  • "GPL-3.0-linking-exception"
  • "GPL-3.0-linking-source-exception"
  • "GPL-CC-1.0"
  • "GStreamer-exception-2005"
  • "GStreamer-exception-2008"
  • "i2p-gpl-java-exception"
  • "KiCad-libraries-exception"
  • "LGPL-3.0-linking-exception"
  • "libpri-OpenH323-exception"
  • "Libtool-exception"
  • "Linux-syscall-note"
  • "LLGPL"
  • "LLVM-exception"
  • "LZMA-exception"
  • "mif-exception"
  • "Nokia-Qt-exception-1.1"
  • "OCaml-LGPL-linking-exception"
  • "OCCT-exception-1.0"
  • "OpenJDK-assembly-exception-1.0"
  • "openvpn-openssl-exception"
  • "PCRE2-exception"
  • "PS-or-PDF-font-exception-20170817"
  • "QPL-1.0-INRIA-2004-exception"
  • "Qt-GPL-exception-1.0"
  • "Qt-LGPL-exception-1.1"
  • "Qwt-exception-1.0"
  • "RRDtool-FLOSS-exception-2.0"
  • "SANE-exception"
  • "SHL-2.0"
  • "SHL-2.1"
  • "stunnel-exception"
  • "SWI-exception"
  • "Swift-exception"
  • "Texinfo-exception"
  • "u-boot-exception-2.0"
  • "UBDL-exception"
  • "Universal-FOSS-exception-1.0"
  • "vsftpd-openssl-exception"
  • "WxWindows-exception-3.1"
  • "x11vnc-openssl-exception"

Example:

"Apache-2.0"

Type: string

The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.


Example:

"Acme Software License"

Type: enum (of string)

Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.

Must be one of:

  • "declared"
  • "concluded"

Type: object

An optional way to include the textual content of a license.

No Additional Properties

Type: string Default: "text/plain"

Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.


Examples:

"text/plain"
"application/json"
"image/png"

Type: enum (of string)

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"

Type: string

The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

Type: stringFormat: iri-reference

The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness


Example:

"https://www.apache.org/licenses/LICENSE-2.0.txt"

Type: object

Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata

No Additional Properties

Type: array of string

License identifiers that may be used to manage licenses and their lifecycle

No Additional Items

Each item of this array must be:

Type: string


The individual or organization that grants a license to another individual or organization

No Additional Properties

Type: object

The following properties are required:

  • organization
Type: object

The following properties are required:

  • individual

Type: object

The organization that granted the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The individual, not associated with an organization, that granted the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"


The individual or organization for which a license was granted to

No Additional Properties

Type: object

The following properties are required:

  • organization
Type: object

The following properties are required:

  • individual

Type: object

The organization that was granted the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The individual, not associated with an organization, that was granted the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"


The individual or organization that purchased the license

No Additional Properties

Type: object

The following properties are required:

  • organization
Type: object

The following properties are required:

  • individual

Type: object

The organization that purchased the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The individual, not associated with an organization, that purchased the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: string

The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase

Type: array of enum (of string)

The type of license(s) that was granted to the licensee.

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "academic"
  • "appliance"
  • "client-access"
  • "concurrent-user"
  • "core-points"
  • "custom-metric"
  • "device"
  • "evaluation"
  • "named-user"
  • "node-locked"
  • "oem"
  • "perpetual"
  • "processor-points"
  • "subscription"
  • "user"
  • "other"

Type: stringFormat: date-time

The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.

Type: stringFormat: date-time

The timestamp indicating when the current license expires (if applicable).

Type: array

Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.

No Additional Items

Each item of this array must be:

Type: object

Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.

No Additional Properties

Type: string

The name of the property. Duplicate names are allowed, each potentially having a different value.

Type: string

The value of the property.

Type: array

A tuple of exactly one SPDX License Expression.

Must contain a minimum of 1 items

Must contain a maximum of 1 items

No Additional Items

Tuple Validation

Item at 1 must be:
Type: object
No Additional Properties

Type: string

A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements


Examples:

"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"

Type: enum (of string)

Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.

Must be one of:

  • "declared"
  • "concluded"

Type: string

An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

No Additional Items

Type: string

Asserts the identity of the component using CPE. The CPE must conform to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.


Example:

"cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"

Type: string

Asserts the identity of the component using package-url (purl). The purl, if specified, must be valid and conform to the specification defined at: https://github.com/package-url/purl-spec. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.


Example:

"pkg:maven/com.acme/[email protected]?packaging=jar"

Type: array of string

Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform to the specification defined at: https://www.iana.org/assignments/uri-schemes/prov/gitoid. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.

No Additional Items

Each item of this array must be:

Type: string

Examples:

"gitoid:blob:sha1:a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"
"gitoid:blob:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"

Type: array of string

Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must be valid and conform to the specification defined at: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.

No Additional Items

Each item of this array must be:

Type: string

Example:

"swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"

Type: object

Asserts the identity of the component using ISO-IEC 19770-2 Software Identification (SWID) Tags. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.

No Additional Properties

Type: string

Maps to the tagId of a SoftwareIdentity.

Type: string

Maps to the name of a SoftwareIdentity.

Type: string Default: "0.0"

Maps to the version of a SoftwareIdentity.

Type: integer Default: 0

Maps to the tagVersion of a SoftwareIdentity.

Type: boolean Default: false

Maps to the patch of a SoftwareIdentity.

Type: object

Specifies the metadata and content of the SWID tag.

No Additional Properties

Type: string Default: "text/plain"

Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.


Examples:

"text/plain"
"application/json"
"image/png"

Type: enum (of string)

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"

Type: string

The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

Type: stringFormat: iri-reference

The URL to the SWID file.

Type: boolean

[Deprecated] This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original.

Type: object

Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.

No Additional Properties

Type: array

Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.

No Additional Items

Each item of this array must be:

Type: array

Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.

No Additional Items

Each item of this array must be:

Type: array

Variants describe relations where the relationship between the components is not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.

No Additional Items

Each item of this array must be:

Type: array

A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.

No Additional Items

Each item of this array must be:

Type: object

Specifies an individual commit

No Additional Properties

Type: string

A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes.

Type: stringFormat: iri-reference

The URL to the commit. This URL will typically point to a commit in a version control system.

Type: object

The author who created the changes in the commit

No Additional Properties

Type: stringFormat: date-time

The timestamp in which the action occurred

Type: string

The name of the individual who performed the action

Type: stringFormat: idn-email

The email address of the individual who performed the action

Type: object

The person who committed or pushed the commit

No Additional Properties

Type: stringFormat: date-time

The timestamp in which the action occurred

Type: string

The name of the individual who performed the action

Type: stringFormat: idn-email

The email address of the individual who performed the action

Type: string

The text description of the contents of the commit

Type: array

A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complementary to commits or may be used in place of commits.

No Additional Items

Each item of this array must be:

Type: object

Specifies an individual patch

No Additional Properties

Type: enum (of string)

Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality.

Must be one of:

  • "unofficial"
  • "monkey"
  • "backport"
  • "cherry-pick"

Type: object

The patch file (or diff) that shows changes. Refer to https://en.wikipedia.org/wiki/Diff

No Additional Properties

Type: object

Specifies the optional text of the diff

No Additional Properties

Type: string Default: "text/plain"

Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.


Examples:

"text/plain"
"application/json"
"image/png"

Type: enum (of string)

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"

Type: string

The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

Type: stringFormat: iri-reference

Specifies the URL to the diff

Type: array

A collection of issues the patch resolves

No Additional Items

Each item of this array must be:

Type: object

An individual issue that has been resolved.

No Additional Properties

Type: enum (of string)

Specifies the type of issue

Must be one of:

  • "defect"
  • "enhancement"
  • "security"

Type: string

The identifier of the issue assigned by the source of the issue

Type: string

The name of the issue

Type: string

A description of the issue

Type: object

The source of the issue where it is documented

No Additional Properties

Type: string

The name of the source.


Examples:

"National Vulnerability Database"
"NVD"
"Apache"

Type: stringFormat: iri-reference

The url of the issue documentation as provided by the source

Type: array of string

A collection of URL's for reference. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: string

Notes, observations, and other non-structured commentary describing the components pedigree.

Type: array

External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.

No Additional Items

Each item of this array must be:

Type: object

External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.

No Additional Properties


The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.

Type: stringFormat: iri-reference
Type: object

Type: string

Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/

Must match regular expression: ^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$
Type: string

Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/

Must match regular expression: ^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$

Type: string

An optional comment describing the external reference

Type: enum (of string)

Specifies the type of external reference.

Must be one of:

  • "vcs"
  • "issue-tracker"
  • "website"
  • "advisories"
  • "bom"
  • "mailing-list"
  • "social"
  • "chat"
  • "documentation"
  • "support"
  • "source-distribution"
  • "distribution"
  • "distribution-intake"
  • "license"
  • "build-meta"
  • "build-system"
  • "release-notes"
  • "security-contact"
  • "model-card"
  • "log"
  • "configuration"
  • "evidence"
  • "formulation"
  • "attestation"
  • "threat-model"
  • "adversary-model"
  • "risk-assessment"
  • "vulnerability-assertion"
  • "exploitability-statement"
  • "pentest-report"
  • "static-analysis-report"
  • "dynamic-analysis-report"
  • "runtime-analysis-report"
  • "component-analysis-report"
  • "maturity-report"
  • "certification-report"
  • "codified-infrastructure"
  • "quality-metrics"
  • "poam"
  • "electronic-signature"
  • "digital-signature"
  • "rfc-9116"
  • "other"

Type: array

The hashes of the external reference (if applicable).

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string)

The algorithm that generated the hash value.

Must be one of:

  • "MD5"
  • "SHA-1"
  • "SHA-256"
  • "SHA-384"
  • "SHA-512"
  • "SHA3-256"
  • "SHA3-384"
  • "SHA3-512"
  • "BLAKE2b-256"
  • "BLAKE2b-384"
  • "BLAKE2b-512"
  • "BLAKE3"

Type: string

The value of the hash.

Must match regular expression: ^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$
Example:

"3942447fac867ae5cdb3229b658f4d48"

Type: array

A list of software and hardware components included in the parent component. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains.

All items must be unique

No Additional Items

Each item of this array must be:

Type: object

Provides the ability to document evidence collected through various forms of extraction or analysis.

No Additional Properties


Evidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified.

Type: array
No Additional Items

Each item of this array must be:

Type: object

Evidence that substantiates the identity of a component.

No Additional Properties

Type: enum (of string)

The identity field of the component which the evidence describes.

Must be one of:

  • "group"
  • "name"
  • "version"
  • "purl"
  • "cpe"
  • "omniborId"
  • "swhid"
  • "swid"
  • "hash"

Type: number

The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.

Value must be greater or equal to 0 and lesser or equal to 1

Type: string

The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).

Type: array of object

The methods used to extract and/or analyze the evidence.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string)

The technique used in this method of analysis.

Must be one of:

  • "source-code-analysis"
  • "binary-analysis"
  • "manifest-analysis"
  • "ast-fingerprint"
  • "hash-comparison"
  • "instrumentation"
  • "dynamic-analysis"
  • "filename"
  • "attestation"
  • "other"

Type: number

The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.

Value must be greater or equal to 0 and lesser or equal to 1

Type: string

The value or contents of the evidence.

Type: array

The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.

All items must be unique

No Additional Items

Each item of this array must be:


Type: string

Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.

Must be at least 1 characters long

Type: string

Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/

Must match regular expression: ^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$
Type: object

[Deprecated]

No Additional Properties

Type: enum (of string)

The identity field of the component which the evidence describes.

Must be one of:

  • "group"
  • "name"
  • "version"
  • "purl"
  • "cpe"
  • "omniborId"
  • "swhid"
  • "swid"
  • "hash"

Type: number

The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.

Value must be greater or equal to 0 and lesser or equal to 1

Type: string

The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).

Type: array of object

The methods used to extract and/or analyze the evidence.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string)

The technique used in this method of analysis.

Must be one of:

  • "source-code-analysis"
  • "binary-analysis"
  • "manifest-analysis"
  • "ast-fingerprint"
  • "hash-comparison"
  • "instrumentation"
  • "dynamic-analysis"
  • "filename"
  • "attestation"
  • "other"

Type: number

The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.

Value must be greater or equal to 0 and lesser or equal to 1

Type: string

The value or contents of the evidence.

Type: array

The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.

All items must be unique

No Additional Items

Each item of this array must be:


Type: string

Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.

Must be at least 1 characters long

Type: string

Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/

Must match regular expression: ^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$

Type: array of object

Evidence of individual instances of a component spread across multiple locations.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The location or path to where the component was found.

Type: integer

The line number where the component was found.

Value must be greater or equal to 0

Type: integer

The offset where the component was found.

Value must be greater or equal to 0

Type: string

The symbol name that was found associated with the component.

Type: string

Any additional context of the detected component (e.g. a code snippet).

Type: object

Evidence of the components use through the callstack.

No Additional Properties

Type: array of object

Within a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of program execution and manages the sequence of function invocations.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

A package organizes modules into namespaces, providing a unique namespace for each type it contains.

Type: string

A module or class that encloses functions/methods and other code.

Type: string

A block of code designed to perform a particular task.

Type: array of string

Optional arguments that are passed to the module or function.

No Additional Items

Each item of this array must be:

Type: string

Type: integer

The line number the code that is called resides on.

Type: integer

The column the code that is called resides.

Type: string

The full path and filename of the module.

Type: array

EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)

Type: array of object

A list of SPDX licenses and/or named licenses.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: object

Specifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.

No Additional Properties

Type: object

The following properties are required:

  • id
Type: object

The following properties are required:

  • name

Type: string

An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: enum (of string)

A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.

Must be one of:

  • "0BSD"
  • "3D-Slicer-1.0"
  • "AAL"
  • "Abstyles"
  • "AdaCore-doc"
  • "Adobe-2006"
  • "Adobe-Display-PostScript"
  • "Adobe-Glyph"
  • "Adobe-Utopia"
  • "ADSL"
  • "AFL-1.1"
  • "AFL-1.2"
  • "AFL-2.0"
  • "AFL-2.1"
  • "AFL-3.0"
  • "Afmparse"
  • "AGPL-1.0"
  • "AGPL-1.0-only"
  • "AGPL-1.0-or-later"
  • "AGPL-3.0"
  • "AGPL-3.0-only"
  • "AGPL-3.0-or-later"
  • "Aladdin"
  • "AMD-newlib"
  • "AMDPLPA"
  • "AML"
  • "AML-glslang"
  • "AMPAS"
  • "ANTLR-PD"
  • "ANTLR-PD-fallback"
  • "any-OSI"
  • "Apache-1.0"
  • "Apache-1.1"
  • "Apache-2.0"
  • "APAFML"
  • "APL-1.0"
  • "App-s2p"
  • "APSL-1.0"
  • "APSL-1.1"
  • "APSL-1.2"
  • "APSL-2.0"
  • "Arphic-1999"
  • "Artistic-1.0"
  • "Artistic-1.0-cl8"
  • "Artistic-1.0-Perl"
  • "Artistic-2.0"
  • "ASWF-Digital-Assets-1.0"
  • "ASWF-Digital-Assets-1.1"
  • "Baekmuk"
  • "Bahyph"
  • "Barr"
  • "bcrypt-Solar-Designer"
  • "Beerware"
  • "Bitstream-Charter"
  • "Bitstream-Vera"
  • "BitTorrent-1.0"
  • "BitTorrent-1.1"
  • "blessing"
  • "BlueOak-1.0.0"
  • "Boehm-GC"
  • "Borceux"
  • "Brian-Gladman-2-Clause"
  • "Brian-Gladman-3-Clause"
  • "BSD-1-Clause"
  • "BSD-2-Clause"
  • "BSD-2-Clause-Darwin"
  • "BSD-2-Clause-first-lines"
  • "BSD-2-Clause-FreeBSD"
  • "BSD-2-Clause-NetBSD"
  • "BSD-2-Clause-Patent"
  • "BSD-2-Clause-Views"
  • "BSD-3-Clause"
  • "BSD-3-Clause-acpica"
  • "BSD-3-Clause-Attribution"
  • "BSD-3-Clause-Clear"
  • "BSD-3-Clause-flex"
  • "BSD-3-Clause-HP"
  • "BSD-3-Clause-LBNL"
  • "BSD-3-Clause-Modification"
  • "BSD-3-Clause-No-Military-License"
  • "BSD-3-Clause-No-Nuclear-License"
  • "BSD-3-Clause-No-Nuclear-License-2014"
  • "BSD-3-Clause-No-Nuclear-Warranty"
  • "BSD-3-Clause-Open-MPI"
  • "BSD-3-Clause-Sun"
  • "BSD-4-Clause"
  • "BSD-4-Clause-Shortened"
  • "BSD-4-Clause-UC"
  • "BSD-4.3RENO"
  • "BSD-4.3TAHOE"
  • "BSD-Advertising-Acknowledgement"
  • "BSD-Attribution-HPND-disclaimer"
  • "BSD-Inferno-Nettverk"
  • "BSD-Protection"
  • "BSD-Source-beginning-file"
  • "BSD-Source-Code"
  • "BSD-Systemics"
  • "BSD-Systemics-W3Works"
  • "BSL-1.0"
  • "BUSL-1.1"
  • "bzip2-1.0.5"
  • "bzip2-1.0.6"
  • "C-UDA-1.0"
  • "CAL-1.0"
  • "CAL-1.0-Combined-Work-Exception"
  • "Caldera"
  • "Caldera-no-preamble"
  • "Catharon"
  • "CATOSL-1.1"
  • "CC-BY-1.0"
  • "CC-BY-2.0"
  • "CC-BY-2.5"
  • "CC-BY-2.5-AU"
  • "CC-BY-3.0"
  • "CC-BY-3.0-AT"
  • "CC-BY-3.0-AU"
  • "CC-BY-3.0-DE"
  • "CC-BY-3.0-IGO"
  • "CC-BY-3.0-NL"
  • "CC-BY-3.0-US"
  • "CC-BY-4.0"
  • "CC-BY-NC-1.0"
  • "CC-BY-NC-2.0"
  • "CC-BY-NC-2.5"
  • "CC-BY-NC-3.0"
  • "CC-BY-NC-3.0-DE"
  • "CC-BY-NC-4.0"
  • "CC-BY-NC-ND-1.0"
  • "CC-BY-NC-ND-2.0"
  • "CC-BY-NC-ND-2.5"
  • "CC-BY-NC-ND-3.0"
  • "CC-BY-NC-ND-3.0-DE"
  • "CC-BY-NC-ND-3.0-IGO"
  • "CC-BY-NC-ND-4.0"
  • "CC-BY-NC-SA-1.0"
  • "CC-BY-NC-SA-2.0"
  • "CC-BY-NC-SA-2.0-DE"
  • "CC-BY-NC-SA-2.0-FR"
  • "CC-BY-NC-SA-2.0-UK"
  • "CC-BY-NC-SA-2.5"
  • "CC-BY-NC-SA-3.0"
  • "CC-BY-NC-SA-3.0-DE"
  • "CC-BY-NC-SA-3.0-IGO"
  • "CC-BY-NC-SA-4.0"
  • "CC-BY-ND-1.0"
  • "CC-BY-ND-2.0"
  • "CC-BY-ND-2.5"
  • "CC-BY-ND-3.0"
  • "CC-BY-ND-3.0-DE"
  • "CC-BY-ND-4.0"
  • "CC-BY-SA-1.0"
  • "CC-BY-SA-2.0"
  • "CC-BY-SA-2.0-UK"
  • "CC-BY-SA-2.1-JP"
  • "CC-BY-SA-2.5"
  • "CC-BY-SA-3.0"
  • "CC-BY-SA-3.0-AT"
  • "CC-BY-SA-3.0-DE"
  • "CC-BY-SA-3.0-IGO"
  • "CC-BY-SA-4.0"
  • "CC-PDDC"
  • "CC0-1.0"
  • "CDDL-1.0"
  • "CDDL-1.1"
  • "CDL-1.0"
  • "CDLA-Permissive-1.0"
  • "CDLA-Permissive-2.0"
  • "CDLA-Sharing-1.0"
  • "CECILL-1.0"
  • "CECILL-1.1"
  • "CECILL-2.0"
  • "CECILL-2.1"
  • "CECILL-B"
  • "CECILL-C"
  • "CERN-OHL-1.1"
  • "CERN-OHL-1.2"
  • "CERN-OHL-P-2.0"
  • "CERN-OHL-S-2.0"
  • "CERN-OHL-W-2.0"
  • "CFITSIO"
  • "check-cvs"
  • "checkmk"
  • "ClArtistic"
  • "Clips"
  • "CMU-Mach"
  • "CMU-Mach-nodoc"
  • "CNRI-Jython"
  • "CNRI-Python"
  • "CNRI-Python-GPL-Compatible"
  • "COIL-1.0"
  • "Community-Spec-1.0"
  • "Condor-1.1"
  • "copyleft-next-0.3.0"
  • "copyleft-next-0.3.1"
  • "Cornell-Lossless-JPEG"
  • "CPAL-1.0"
  • "CPL-1.0"
  • "CPOL-1.02"
  • "Cronyx"
  • "Crossword"
  • "CrystalStacker"
  • "CUA-OPL-1.0"
  • "Cube"
  • "curl"
  • "cve-tou"
  • "D-FSL-1.0"
  • "DEC-3-Clause"
  • "diffmark"
  • "DL-DE-BY-2.0"
  • "DL-DE-ZERO-2.0"
  • "DOC"
  • "Dotseqn"
  • "DRL-1.0"
  • "DRL-1.1"
  • "DSDP"
  • "dtoa"
  • "dvipdfm"
  • "ECL-1.0"
  • "ECL-2.0"
  • "eCos-2.0"
  • "EFL-1.0"
  • "EFL-2.0"
  • "eGenix"
  • "Elastic-2.0"
  • "Entessa"
  • "EPICS"
  • "EPL-1.0"
  • "EPL-2.0"
  • "ErlPL-1.1"
  • "etalab-2.0"
  • "EUDatagrid"
  • "EUPL-1.0"
  • "EUPL-1.1"
  • "EUPL-1.2"
  • "Eurosym"
  • "Fair"
  • "FBM"
  • "FDK-AAC"
  • "Ferguson-Twofish"
  • "Frameworx-1.0"
  • "FreeBSD-DOC"
  • "FreeImage"
  • "FSFAP"
  • "FSFAP-no-warranty-disclaimer"
  • "FSFUL"
  • "FSFULLR"
  • "FSFULLRWD"
  • "FTL"
  • "Furuseth"
  • "fwlw"
  • "GCR-docs"
  • "GD"
  • "GFDL-1.1"
  • "GFDL-1.1-invariants-only"
  • "GFDL-1.1-invariants-or-later"
  • "GFDL-1.1-no-invariants-only"
  • "GFDL-1.1-no-invariants-or-later"
  • "GFDL-1.1-only"
  • "GFDL-1.1-or-later"
  • "GFDL-1.2"
  • "GFDL-1.2-invariants-only"
  • "GFDL-1.2-invariants-or-later"
  • "GFDL-1.2-no-invariants-only"
  • "GFDL-1.2-no-invariants-or-later"
  • "GFDL-1.2-only"
  • "GFDL-1.2-or-later"
  • "GFDL-1.3"
  • "GFDL-1.3-invariants-only"
  • "GFDL-1.3-invariants-or-later"
  • "GFDL-1.3-no-invariants-only"
  • "GFDL-1.3-no-invariants-or-later"
  • "GFDL-1.3-only"
  • "GFDL-1.3-or-later"
  • "Giftware"
  • "GL2PS"
  • "Glide"
  • "Glulxe"
  • "GLWTPL"
  • "gnuplot"
  • "GPL-1.0"
  • "GPL-1.0+"
  • "GPL-1.0-only"
  • "GPL-1.0-or-later"
  • "GPL-2.0"
  • "GPL-2.0+"
  • "GPL-2.0-only"
  • "GPL-2.0-or-later"
  • "GPL-2.0-with-autoconf-exception"
  • "GPL-2.0-with-bison-exception"
  • "GPL-2.0-with-classpath-exception"
  • "GPL-2.0-with-font-exception"
  • "GPL-2.0-with-GCC-exception"
  • "GPL-3.0"
  • "GPL-3.0+"
  • "GPL-3.0-only"
  • "GPL-3.0-or-later"
  • "GPL-3.0-with-autoconf-exception"
  • "GPL-3.0-with-GCC-exception"
  • "Graphics-Gems"
  • "gSOAP-1.3b"
  • "gtkbook"
  • "Gutmann"
  • "HaskellReport"
  • "hdparm"
  • "Hippocratic-2.1"
  • "HP-1986"
  • "HP-1989"
  • "HPND"
  • "HPND-DEC"
  • "HPND-doc"
  • "HPND-doc-sell"
  • "HPND-export-US"
  • "HPND-export-US-acknowledgement"
  • "HPND-export-US-modify"
  • "HPND-export2-US"
  • "HPND-Fenneberg-Livingston"
  • "HPND-INRIA-IMAG"
  • "HPND-Intel"
  • "HPND-Kevlin-Henney"
  • "HPND-Markus-Kuhn"
  • "HPND-merchantability-variant"
  • "HPND-MIT-disclaimer"
  • "HPND-Pbmplus"
  • "HPND-sell-MIT-disclaimer-xserver"
  • "HPND-sell-regexpr"
  • "HPND-sell-variant"
  • "HPND-sell-variant-MIT-disclaimer"
  • "HPND-sell-variant-MIT-disclaimer-rev"
  • "HPND-UC"
  • "HPND-UC-export-US"
  • "HTMLTIDY"
  • "IBM-pibs"
  • "ICU"
  • "IEC-Code-Components-EULA"
  • "IJG"
  • "IJG-short"
  • "ImageMagick"
  • "iMatix"
  • "Imlib2"
  • "Info-ZIP"
  • "Inner-Net-2.0"
  • "Intel"
  • "Intel-ACPI"
  • "Interbase-1.0"
  • "IPA"
  • "IPL-1.0"
  • "ISC"
  • "ISC-Veillard"
  • "Jam"
  • "JasPer-2.0"
  • "JPL-image"
  • "JPNIC"
  • "JSON"
  • "Kastrup"
  • "Kazlib"
  • "Knuth-CTAN"
  • "LAL-1.2"
  • "LAL-1.3"
  • "Latex2e"
  • "Latex2e-translated-notice"
  • "Leptonica"
  • "LGPL-2.0"
  • "LGPL-2.0+"
  • "LGPL-2.0-only"
  • "LGPL-2.0-or-later"
  • "LGPL-2.1"
  • "LGPL-2.1+"
  • "LGPL-2.1-only"
  • "LGPL-2.1-or-later"
  • "LGPL-3.0"
  • "LGPL-3.0+"
  • "LGPL-3.0-only"
  • "LGPL-3.0-or-later"
  • "LGPLLR"
  • "Libpng"
  • "libpng-2.0"
  • "libselinux-1.0"
  • "libtiff"
  • "libutil-David-Nugent"
  • "LiLiQ-P-1.1"
  • "LiLiQ-R-1.1"
  • "LiLiQ-Rplus-1.1"
  • "Linux-man-pages-1-para"
  • "Linux-man-pages-copyleft"
  • "Linux-man-pages-copyleft-2-para"
  • "Linux-man-pages-copyleft-var"
  • "Linux-OpenIB"
  • "LOOP"
  • "LPD-document"
  • "LPL-1.0"
  • "LPL-1.02"
  • "LPPL-1.0"
  • "LPPL-1.1"
  • "LPPL-1.2"
  • "LPPL-1.3a"
  • "LPPL-1.3c"
  • "lsof"
  • "Lucida-Bitmap-Fonts"
  • "LZMA-SDK-9.11-to-9.20"
  • "LZMA-SDK-9.22"
  • "Mackerras-3-Clause"
  • "Mackerras-3-Clause-acknowledgment"
  • "magaz"
  • "mailprio"
  • "MakeIndex"
  • "Martin-Birgmeier"
  • "McPhee-slideshow"
  • "metamail"
  • "Minpack"
  • "MirOS"
  • "MIT"
  • "MIT-0"
  • "MIT-advertising"
  • "MIT-CMU"
  • "MIT-enna"
  • "MIT-feh"
  • "MIT-Festival"
  • "MIT-Khronos-old"
  • "MIT-Modern-Variant"
  • "MIT-open-group"
  • "MIT-testregex"
  • "MIT-Wu"
  • "MITNFA"
  • "MMIXware"
  • "Motosoto"
  • "MPEG-SSG"
  • "mpi-permissive"
  • "mpich2"
  • "MPL-1.0"
  • "MPL-1.1"
  • "MPL-2.0"
  • "MPL-2.0-no-copyleft-exception"
  • "mplus"
  • "MS-LPL"
  • "MS-PL"
  • "MS-RL"
  • "MTLL"
  • "MulanPSL-1.0"
  • "MulanPSL-2.0"
  • "Multics"
  • "Mup"
  • "NAIST-2003"
  • "NASA-1.3"
  • "Naumen"
  • "NBPL-1.0"
  • "NCBI-PD"
  • "NCGL-UK-2.0"
  • "NCL"
  • "NCSA"
  • "Net-SNMP"
  • "NetCDF"
  • "Newsletr"
  • "NGPL"
  • "NICTA-1.0"
  • "NIST-PD"
  • "NIST-PD-fallback"
  • "NIST-Software"
  • "NLOD-1.0"
  • "NLOD-2.0"
  • "NLPL"
  • "Nokia"
  • "NOSL"
  • "Noweb"
  • "NPL-1.0"
  • "NPL-1.1"
  • "NPOSL-3.0"
  • "NRL"
  • "NTP"
  • "NTP-0"
  • "Nunit"
  • "O-UDA-1.0"
  • "OAR"
  • "OCCT-PL"
  • "OCLC-2.0"
  • "ODbL-1.0"
  • "ODC-By-1.0"
  • "OFFIS"
  • "OFL-1.0"
  • "OFL-1.0-no-RFN"
  • "OFL-1.0-RFN"
  • "OFL-1.1"
  • "OFL-1.1-no-RFN"
  • "OFL-1.1-RFN"
  • "OGC-1.0"
  • "OGDL-Taiwan-1.0"
  • "OGL-Canada-2.0"
  • "OGL-UK-1.0"
  • "OGL-UK-2.0"
  • "OGL-UK-3.0"
  • "OGTSL"
  • "OLDAP-1.1"
  • "OLDAP-1.2"
  • "OLDAP-1.3"
  • "OLDAP-1.4"
  • "OLDAP-2.0"
  • "OLDAP-2.0.1"
  • "OLDAP-2.1"
  • "OLDAP-2.2"
  • "OLDAP-2.2.1"
  • "OLDAP-2.2.2"
  • "OLDAP-2.3"
  • "OLDAP-2.4"
  • "OLDAP-2.5"
  • "OLDAP-2.6"
  • "OLDAP-2.7"
  • "OLDAP-2.8"
  • "OLFL-1.3"
  • "OML"
  • "OpenPBS-2.3"
  • "OpenSSL"
  • "OpenSSL-standalone"
  • "OpenVision"
  • "OPL-1.0"
  • "OPL-UK-3.0"
  • "OPUBL-1.0"
  • "OSET-PL-2.1"
  • "OSL-1.0"
  • "OSL-1.1"
  • "OSL-2.0"
  • "OSL-2.1"
  • "OSL-3.0"
  • "PADL"
  • "Parity-6.0.0"
  • "Parity-7.0.0"
  • "PDDL-1.0"
  • "PHP-3.0"
  • "PHP-3.01"
  • "Pixar"
  • "pkgconf"
  • "Plexus"
  • "pnmstitch"
  • "PolyForm-Noncommercial-1.0.0"
  • "PolyForm-Small-Business-1.0.0"
  • "PostgreSQL"
  • "PPL"
  • "PSF-2.0"
  • "psfrag"
  • "psutils"
  • "Python-2.0"
  • "Python-2.0.1"
  • "python-ldap"
  • "Qhull"
  • "QPL-1.0"
  • "QPL-1.0-INRIA-2004"
  • "radvd"
  • "Rdisc"
  • "RHeCos-1.1"
  • "RPL-1.1"
  • "RPL-1.5"
  • "RPSL-1.0"
  • "RSA-MD"
  • "RSCPL"
  • "Ruby"
  • "SAX-PD"
  • "SAX-PD-2.0"
  • "Saxpath"
  • "SCEA"
  • "SchemeReport"
  • "Sendmail"
  • "Sendmail-8.23"
  • "SGI-B-1.0"
  • "SGI-B-1.1"
  • "SGI-B-2.0"
  • "SGI-OpenGL"
  • "SGP4"
  • "SHL-0.5"
  • "SHL-0.51"
  • "SimPL-2.0"
  • "SISSL"
  • "SISSL-1.2"
  • "SL"
  • "Sleepycat"
  • "SMLNJ"
  • "SMPPL"
  • "SNIA"
  • "snprintf"
  • "softSurfer"
  • "Soundex"
  • "Spencer-86"
  • "Spencer-94"
  • "Spencer-99"
  • "SPL-1.0"
  • "ssh-keyscan"
  • "SSH-OpenSSH"
  • "SSH-short"
  • "SSLeay-standalone"
  • "SSPL-1.0"
  • "StandardML-NJ"
  • "SugarCRM-1.1.3"
  • "Sun-PPP"
  • "Sun-PPP-2000"
  • "SunPro"
  • "SWL"
  • "swrule"
  • "Symlinks"
  • "TAPR-OHL-1.0"
  • "TCL"
  • "TCP-wrappers"
  • "TermReadKey"
  • "TGPPL-1.0"
  • "threeparttable"
  • "TMate"
  • "TORQUE-1.1"
  • "TOSL"
  • "TPDL"
  • "TPL-1.0"
  • "TTWL"
  • "TTYP0"
  • "TU-Berlin-1.0"
  • "TU-Berlin-2.0"
  • "UCAR"
  • "UCL-1.0"
  • "ulem"
  • "UMich-Merit"
  • "Unicode-3.0"
  • "Unicode-DFS-2015"
  • "Unicode-DFS-2016"
  • "Unicode-TOU"
  • "UnixCrypt"
  • "Unlicense"
  • "UPL-1.0"
  • "URT-RLE"
  • "Vim"
  • "VOSTROM"
  • "VSL-1.0"
  • "W3C"
  • "W3C-19980720"
  • "W3C-20150513"
  • "w3m"
  • "Watcom-1.0"
  • "Widget-Workshop"
  • "Wsuipa"
  • "WTFPL"
  • "wxWindows"
  • "X11"
  • "X11-distribute-modifications-variant"
  • "Xdebug-1.03"
  • "Xerox"
  • "Xfig"
  • "XFree86-1.1"
  • "xinetd"
  • "xkeyboard-config-Zinoviev"
  • "xlock"
  • "Xnet"
  • "xpp"
  • "XSkat"
  • "xzoom"
  • "YPL-1.0"
  • "YPL-1.1"
  • "Zed"
  • "Zeeff"
  • "Zend-2.0"
  • "Zimbra-1.3"
  • "Zimbra-1.4"
  • "Zlib"
  • "zlib-acknowledgement"
  • "ZPL-1.1"
  • "ZPL-2.0"
  • "ZPL-2.1"
  • "389-exception"
  • "Asterisk-exception"
  • "Asterisk-linking-protocols-exception"
  • "Autoconf-exception-2.0"
  • "Autoconf-exception-3.0"
  • "Autoconf-exception-generic"
  • "Autoconf-exception-generic-3.0"
  • "Autoconf-exception-macro"
  • "Bison-exception-1.24"
  • "Bison-exception-2.2"
  • "Bootloader-exception"
  • "Classpath-exception-2.0"
  • "CLISP-exception-2.0"
  • "cryptsetup-OpenSSL-exception"
  • "DigiRule-FOSS-exception"
  • "eCos-exception-2.0"
  • "Fawkes-Runtime-exception"
  • "FLTK-exception"
  • "fmt-exception"
  • "Font-exception-2.0"
  • "freertos-exception-2.0"
  • "GCC-exception-2.0"
  • "GCC-exception-2.0-note"
  • "GCC-exception-3.1"
  • "Gmsh-exception"
  • "GNAT-exception"
  • "GNOME-examples-exception"
  • "GNU-compiler-exception"
  • "gnu-javamail-exception"
  • "GPL-3.0-interface-exception"
  • "GPL-3.0-linking-exception"
  • "GPL-3.0-linking-source-exception"
  • "GPL-CC-1.0"
  • "GStreamer-exception-2005"
  • "GStreamer-exception-2008"
  • "i2p-gpl-java-exception"
  • "KiCad-libraries-exception"
  • "LGPL-3.0-linking-exception"
  • "libpri-OpenH323-exception"
  • "Libtool-exception"
  • "Linux-syscall-note"
  • "LLGPL"
  • "LLVM-exception"
  • "LZMA-exception"
  • "mif-exception"
  • "Nokia-Qt-exception-1.1"
  • "OCaml-LGPL-linking-exception"
  • "OCCT-exception-1.0"
  • "OpenJDK-assembly-exception-1.0"
  • "openvpn-openssl-exception"
  • "PCRE2-exception"
  • "PS-or-PDF-font-exception-20170817"
  • "QPL-1.0-INRIA-2004-exception"
  • "Qt-GPL-exception-1.0"
  • "Qt-LGPL-exception-1.1"
  • "Qwt-exception-1.0"
  • "RRDtool-FLOSS-exception-2.0"
  • "SANE-exception"
  • "SHL-2.0"
  • "SHL-2.1"
  • "stunnel-exception"
  • "SWI-exception"
  • "Swift-exception"
  • "Texinfo-exception"
  • "u-boot-exception-2.0"
  • "UBDL-exception"
  • "Universal-FOSS-exception-1.0"
  • "vsftpd-openssl-exception"
  • "WxWindows-exception-3.1"
  • "x11vnc-openssl-exception"

Example:

"Apache-2.0"

Type: string

The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.


Example:

"Acme Software License"

Type: enum (of string)

Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.

Must be one of:

  • "declared"
  • "concluded"

Type: object

An optional way to include the textual content of a license.

No Additional Properties

Type: string Default: "text/plain"

Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.


Examples:

"text/plain"
"application/json"
"image/png"

Type: enum (of string)

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"

Type: string

The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

Type: stringFormat: iri-reference

The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness


Example:

"https://www.apache.org/licenses/LICENSE-2.0.txt"

Type: object

Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata

No Additional Properties

Type: array of string

License identifiers that may be used to manage licenses and their lifecycle

No Additional Items

Each item of this array must be:

Type: string


The individual or organization that grants a license to another individual or organization

No Additional Properties

Type: object

The following properties are required:

  • organization
Type: object

The following properties are required:

  • individual

Type: object

The organization that granted the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The individual, not associated with an organization, that granted the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"


The individual or organization for which a license was granted to

No Additional Properties

Type: object

The following properties are required:

  • organization
Type: object

The following properties are required:

  • individual

Type: object

The organization that was granted the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The individual, not associated with an organization, that was granted the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"


The individual or organization that purchased the license

No Additional Properties

Type: object

The following properties are required:

  • organization
Type: object

The following properties are required:

  • individual

Type: object

The organization that purchased the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The individual, not associated with an organization, that purchased the license

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: string

The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase

Type: array of enum (of string)

The type of license(s) that was granted to the licensee.

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "academic"
  • "appliance"
  • "client-access"
  • "concurrent-user"
  • "core-points"
  • "custom-metric"
  • "device"
  • "evaluation"
  • "named-user"
  • "node-locked"
  • "oem"
  • "perpetual"
  • "processor-points"
  • "subscription"
  • "user"
  • "other"

Type: stringFormat: date-time

The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.

Type: stringFormat: date-time

The timestamp indicating when the current license expires (if applicable).

Type: array

Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.

No Additional Items

Each item of this array must be:

Type: object

Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.

No Additional Properties

Type: string

The name of the property. Duplicate names are allowed, each potentially having a different value.

Type: string

The value of the property.

Type: array

A tuple of exactly one SPDX License Expression.

Must contain a minimum of 1 items

Must contain a maximum of 1 items

No Additional Items

Tuple Validation

Item at 1 must be:
Type: object
No Additional Properties

Type: string

A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements


Examples:

"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"

Type: enum (of string)

Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.

Must be one of:

  • "declared"
  • "concluded"

Type: string

An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

No Additional Items

Type: object

Specifies optional release notes.

No Additional Properties

Type: string

The software versioning type the release note describes.


Examples:

"major"
"minor"
"patch"
"pre-release"
"internal"

Type: string

The title of the release.

Type: stringFormat: iri-reference

The URL to an image that may be prominently displayed with the release note.

Type: stringFormat: iri-reference

The URL to an image that may be used in messaging on social media platforms.

Type: string

A short description of the release.

Type: stringFormat: date-time

The date and time (timestamp) when the release note was created.

Type: array of string

One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names).

No Additional Items

Each item of this array must be:

Type: string

Type: array of string

Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.

No Additional Items

Each item of this array must be:

Type: string

Examples:

"json-parser"
"object-persistence"
"text-to-image"
"translation"
"object-detection"

Type: array

A collection of issues that have been resolved.

No Additional Items

Each item of this array must be:

Type: object

An individual issue that has been resolved.

No Additional Properties

Type: enum (of string)

Specifies the type of issue

Must be one of:

  • "defect"
  • "enhancement"
  • "security"

Type: string

The identifier of the issue assigned by the source of the issue

Type: string

The name of the issue

Type: string

A description of the issue

Type: object

The source of the issue where it is documented

No Additional Properties

Type: string

The name of the source.


Examples:

"National Vulnerability Database"
"NVD"
"Apache"

Type: stringFormat: iri-reference

The url of the issue documentation as provided by the source

Type: array of string

A collection of URL's for reference. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages.

No Additional Items

Each item of this array must be:

Type: object

A note containing the locale and content.

No Additional Properties

Type: string

The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA"

Must match regular expression: ^([a-z]{2})(-[A-Z]{2})?$

Type: object

Specifies the full content of the release note.

No Additional Properties

Type: string Default: "text/plain"

Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.


Examples:

"text/plain"
"application/json"
"image/png"

Type: enum (of string)

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"

Type: string

The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

Type: array

Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.

No Additional Items

Each item of this array must be:

Type: object

Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.

No Additional Properties

Type: string

The name of the property. Duplicate names are allowed, each potentially having a different value.

Type: string

The value of the property.

Type: object

A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type machine-learning-model and must not be specified for other component types.

No Additional Properties

Type: string

An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: object

Hyper-parameters for construction of the model.

No Additional Properties

Type: object

The overall approach to learning used by the model for problem solving.

No Additional Properties

Type: enum (of string)

Learning types describing the learning problem or hybrid learning problem.

Must be one of:

  • "supervised"
  • "unsupervised"
  • "reinforcement-learning"
  • "semi-supervised"
  • "self-supervised"

Type: string

Directly influences the input and/or output. Examples include classification, regression, clustering, etc.

Type: string

The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc.

Type: string

The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc.

Type: array

The datasets used to train and evaluate the model.

No Additional Items

Each item of this array must be:


Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: enum (of string)

The general theme or subject matter of the data being specified.

Must be one of:

  • "source-code"
  • "configuration"
  • "dataset"
  • "definition"
  • "other"

Type: string

The name of the dataset.

Type: object

The contents or references to the contents of the data being described.

No Additional Properties

Type: object

An optional way to include textual or encoded data.

No Additional Properties

Type: string Default: "text/plain"

Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.


Examples:

"text/plain"
"application/json"
"image/png"

Type: enum (of string)

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"

Type: string

The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

Type: stringFormat: iri-reference

The URL to where the data can be retrieved.

Type: array

Provides the ability to document name-value parameters used for configuration.

No Additional Items

Each item of this array must be:

Type: object

Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.

No Additional Properties

Type: string

The name of the property. Duplicate names are allowed, each potentially having a different value.

Type: string

The value of the property.

Type: string

Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.

Type: array of string

A description of any sensitive data in a dataset.

No Additional Items

Each item of this array must be:

Type: string

Type: object

A collection of graphics that represent various measurements.

No Additional Properties

Type: string

A description of this collection of graphics.

Type: array

A collection of graphics.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

The name of the graphic.

Type: object

The graphic (vector or raster). Base64 encoding must be specified for binary images.

No Additional Properties

Type: string Default: "text/plain"

Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.


Examples:

"text/plain"
"application/json"
"image/png"

Type: enum (of string)

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"

Type: string

The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

Type: string

A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.

Type: object

Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.

No Additional Properties

Type: array

Data custodians are responsible for the safe custody, transport, and storage of data.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: object

The following properties are required:

  • organization
Type: object

The following properties are required:

  • contact

Type: object

The organization that is responsible for specific data governance role(s).

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The individual that is responsible for specific data governance role(s).

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: array

Data stewards are responsible for data content, context, and associated business rules.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: object

The following properties are required:

  • organization
Type: object

The following properties are required:

  • contact

Type: object

The organization that is responsible for specific data governance role(s).

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The individual that is responsible for specific data governance role(s).

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: array

Data owners are concerned with risk and appropriate access to data.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: object

The following properties are required:

  • organization
Type: object

The following properties are required:

  • contact

Type: object

The organization that is responsible for specific data governance role(s).

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of the organization


Example:

"Example Inc."

Type: object

The physical address (location) of the organization

No Additional Properties

Type: string

An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The country name or the two-letter ISO 3166-1 country code.

Type: string

The region or state in the country.


Example:

"Texas"

Type: string

The locality or city within the country.


Example:

"Austin"

Type: string

The post office box number.


Example:

"901"

Type: string

The postal code.


Example:

"78758"

Type: string

The street address.


Example:

"100 Main Street"

Type: array of string

The URL of the organization. Multiple URLs are allowed.

No Additional Items

Each item of this array must be:

Type: stringFormat: iri-reference

Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"

Type: object

The individual that is responsible for specific data governance role(s).

No Additional Properties

Type: string

An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.

Must be at least 1 characters long

Type: string

The name of a contact


Example:

"Contact name"

Type: stringFormat: idn-email

The email address of the contact.


Example:

Type: string

The phone number of the contact.


Example:

"800-555-1212"
Type: object
No Additional Properties


References a data component by the components bom-ref attribute

Type: string

Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.

Must be at least 1 characters long

Type: string

Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/

Must match regular expression: ^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$

Type: array

The input format(s) of the model

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

The data format for input/output to the model.


Examples:

"string"
"image"
"time-series"

Type: array

The output format(s) from the model

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

The data format for input/output to the model.


Examples:

"string"
"image"
"time-series"

Type: object

A quantitative analysis of the model

No Additional Properties

Type: array

The model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

The type of performance metric.

Type: string

The value of the performance metric.

Type: string

The name of the slice this metric was computed on. By default, assume this metric is not sliced.

Type: object

The confidence interval of the metric.

No Additional Properties

Type: string

The lower bound of the confidence interval.

Type: string

The upper bound of the confidence interval.

Type: object

A collection of graphics that represent various measurements.

No Additional Properties

Type: string

A description of this collection of graphics.

Type: array

A collection of graphics.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

The name of the graphic.

Type: object

The graphic (vector or raster). Base64 encoding must be specified for binary images.

No Additional Properties

Type: string Default: "text/plain"

Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.


Examples:

"text/plain"
"application/json"
"image/png"

Type: enum (of string)

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"

Type: string

The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

Type: object

What considerations should be taken into account regarding the model's construction, training, and application?

No Additional Properties

Type: array of string

Who are the intended users of the model?

No Additional Items

Each item of this array must be:

Type: string

Type: array of string

What are the intended use cases of the model?

No Additional Items

Each item of this array must be:

Type: string

Type: array of string

What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?

No Additional Items

Each item of this array must be:

Type: string

Type: array of string

What are the known tradeoffs in accuracy/performance of the model?

No Additional Items

Each item of this array must be:

Type: string

Type: array

What are the ethical risks involved in the application of this model?

No Additional Items

Each item of this array must be: