CycloneDX v1.2 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.

Must be one of:

  • "CycloneDX"

Type: string

The version of the CycloneDX specification a BOM is written to (starting at version 1.2)


Example:

"1.2"

Type: string Default: ""

Every BOM generated should have a unique serial number, even if the contents of the BOM being generated have not changed over time. The process or tool responsible for creating the BOM should create random UUID's for every BOM generated.

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

The version allows component publishers/authors to make changes to existing BOMs to update various aspects of the document such as description or licenses. When a system is presented with multiple BOMs for the same component, the system should use the most recent version of the BOM. The default version is '1' and should be incremented for each version of the BOM that is published. Each version of a component should have a unique BOM and if no changes are made to the BOMs, then each BOM will have a version of '1'.


Example:

1

Type: object

Provides additional information about a BOM.

No Additional Properties

Type: string

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

Type: array

The tool(s) used in the creation of the BOM.

Each item of this array must be:

Type: object

The tool used to create the BOM.

No Additional Properties

Type: string

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

Type: string

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

Type: string

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

Type: array

The hashes of the tool (if applicable).

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string) Default: ""

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"
Must match regular expression: ^(.*)$

Type: string Default: ""
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

The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.

Each item of this array must be:

Type: object
No Additional Properties

Type: string Default: ""

The name of a contact

Must match regular expression: ^(.*)$
Example:

"Contact name"

Type: string Default: ""

The email address of the contact. Multiple email addresses are allowed.

Must match regular expression: ^(.*)$
Example:

Type: string Default: ""

The phone number of the contact. Multiple phone numbers are allowed.

Must match regular expression: ^(.*)$
Example:

"800-555-1212"

Type: object

The component that the BOM describes.

No Additional Properties

Type: enum (of string) Default: ""

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"
  • "operating-system"
  • "device"
  • "firmware"
  • "file"
Must match regular expression: ^(.*)$
Example:

"library"

Type: string Default: ""

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 Default: ""

An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref should be unique.

Must match regular expression: ^(.*)$

Type: object

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

No Additional Properties

Type: string Default: ""

The name of the organization

Must match regular expression: ^(.*)$
Example:

"Example Inc."

Type: array Default: ""

The URL of the organization. Multiple URLs are allowed.

Must match regular expression: ^(.*)$
Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

Each item of this array must be:

Type: object
No Additional Properties

Type: string Default: ""

The name of a contact

Must match regular expression: ^(.*)$
Example:

"Contact name"

Type: string Default: ""

The email address of the contact. Multiple email addresses are allowed.

Must match regular expression: ^(.*)$
Example:

Type: string Default: ""

The phone number of the contact. Multiple phone numbers are allowed.

Must match regular expression: ^(.*)$
Example:

"800-555-1212"

Type: string Default: ""

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

Must match regular expression: ^(.*)$
Example:

"Acme Inc"

Type: string Default: ""

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

Must match regular expression: ^(.*)$
Example:

"Acme Inc"

Type: string Default: ""

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.

Must match regular expression: ^(.*)$
Example:

"com.acme"

Type: string Default: ""

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

Must match regular expression: ^(.*)$
Example:

"tomcat-catalina"

Type: string Default: ""

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

Must match regular expression: ^(.*)$
Example:

"9.0.14"

Type: string Default: ""

Specifies a description for the component

Must match regular expression: ^(.*)$

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"
Must match regular expression: ^(.*)$

Type: array

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string) Default: ""

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"
Must match regular expression: ^(.*)$

Type: string Default: ""
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

Each item of this array must be:


No Additional Properties

Type: object

The following properties are required:

  • license
Type: object

The following properties are required:

  • expression

Type: object
No Additional Properties

Type: object

The following properties are required:

  • id
Type: object

The following properties are required:

  • name

Type: enum (of string)

A valid SPDX license ID

Must be one of:

  • "AFL-2.0"
  • "AAL"
  • "Adobe-2006"
  • "AFL-3.0"
  • "ADSL"
  • "0BSD"
  • "Afmparse"
  • "AFL-1.2"
  • "AGPL-1.0-or-later"
  • "AFL-2.1"
  • "AFL-1.1"
  • "AGPL-1.0"
  • "Adobe-Glyph"
  • "AMDPLPA"
  • "Aladdin"
  • "ANTLR-PD"
  • "AML"
  • "Apache-1.0"
  • "ANTLR-PD-fallback"
  • "Abstyles"
  • "AGPL-1.0-only"
  • "APAFML"
  • "APSL-1.0"
  • "APSL-1.1"
  • "APSL-2.0"
  • "AGPL-3.0-only"
  • "Apache-1.1"
  • "Apache-2.0"
  • "APL-1.0"
  • "Bahyph"
  • "Artistic-1.0"
  • "AMPAS"
  • "Barr"
  • "AGPL-3.0-or-later"
  • "BlueOak-1.0.0"
  • "Beerware"
  • "Artistic-1.0-cl8"
  • "blessing"
  • "Borceux"
  • "BSD-2-Clause-NetBSD"
  • "BSD-1-Clause"
  • "BSD-2-Clause-Patent"
  • "BitTorrent-1.0"
  • "BSD-2-Clause-FreeBSD"
  • "BSD-3-Clause-Attribution"
  • "BSD-2-Clause"
  • "APSL-1.2"
  • "BSD-3-Clause-LBNL"
  • "Artistic-2.0"
  • "BSD-3-Clause-No-Nuclear-License-2014"
  • "BSD-3-Clause-Modification"
  • "BSD-4-Clause-Shortened"
  • "BSD-3-Clause"
  • "BSD-3-Clause-Open-MPI"
  • "BitTorrent-1.1"
  • "BSD-3-Clause-No-Nuclear-Warranty"
  • "BSD-Source-Code"
  • "BSD-Protection"
  • "AGPL-3.0"
  • "BUSL-1.1"
  • "Artistic-1.0-Perl"
  • "BSL-1.0"
  • "BSD-2-Clause-Views"
  • "CAL-1.0-Combined-Work-Exception"
  • "CATOSL-1.1"
  • "bzip2-1.0.5"
  • "bzip2-1.0.6"
  • "CC-BY-2.5"
  • "CC-BY-3.0-AT"
  • "C-UDA-1.0"
  • "CC-BY-3.0-US"
  • "CC-BY-1.0"
  • "CC-BY-NC-1.0"
  • "CC-BY-NC-2.0"
  • "CC-BY-NC-2.5"
  • "CC-BY-2.0"
  • "CC-BY-NC-4.0"
  • "CC-BY-NC-ND-1.0"
  • "CC-BY-NC-ND-2.0"
  • "CC-BY-NC-3.0"
  • "CC-BY-NC-ND-3.0-IGO"
  • "CC-BY-NC-ND-3.0"
  • "BSD-3-Clause-No-Nuclear-License"
  • "CC-BY-NC-ND-4.0"
  • "CC-BY-NC-SA-2.0"
  • "CC-BY-NC-SA-2.5"
  • "CC-BY-NC-SA-3.0"
  • "CC-BY-NC-SA-4.0"
  • "CC-BY-ND-1.0"
  • "BSD-3-Clause-Clear"
  • "CC-BY-ND-2.5"
  • "CC-BY-ND-3.0"
  • "CC-BY-ND-4.0"
  • "CC-BY-SA-1.0"
  • "CC-BY-SA-2.0-UK"
  • "CC-BY-SA-2.0"
  • "CC-BY-SA-2.1-JP"
  • "CC-BY-ND-2.0"
  • "CC-BY-SA-3.0-AT"
  • "CC-BY-SA-3.0"
  • "CC-BY-SA-4.0"
  • "CC-BY-SA-2.5"
  • "CC-BY-3.0"
  • "CDDL-1.0"
  • "CC0-1.0"
  • "CC-BY-NC-ND-2.5"
  • "CC-BY-NC-SA-1.0"
  • "Caldera"
  • "CDLA-Permissive-1.0"
  • "CC-BY-4.0"
  • "CC-PDDC"
  • "BSD-4-Clause-UC"
  • "BSD-4-Clause"
  • "CAL-1.0"
  • "CDDL-1.1"
  • "CERN-OHL-1.2"
  • "CERN-OHL-1.1"
  • "CERN-OHL-P-2.0"
  • "CERN-OHL-S-2.0"
  • "CECILL-1.1"
  • "CECILL-2.0"
  • "CECILL-1.0"
  • "CNRI-Python"
  • "CNRI-Python-GPL-Compatible"
  • "copyleft-next-0.3.0"
  • "CPAL-1.0"
  • "copyleft-next-0.3.1"
  • "CPL-1.0"
  • "ClArtistic"
  • "CECILL-C"
  • "CNRI-Jython"
  • "Condor-1.1"
  • "CPOL-1.02"
  • "curl"
  • "diffmark"
  • "Crossword"
  • "Dotseqn"
  • "DOC"
  • "DSDP"
  • "DRL-1.0"
  • "ECL-1.0"
  • "ECL-2.0"
  • "eCos-2.0"
  • "CrystalStacker"
  • "CERN-OHL-W-2.0"
  • "D-FSL-1.0"
  • "eGenix"
  • "EPICS"
  • "Entessa"
  • "EPL-1.0"
  • "EFL-2.0"
  • "CUA-OPL-1.0"
  • "etalab-2.0"
  • "EUPL-1.0"
  • "ErlPL-1.1"
  • "EUDatagrid"
  • "EUPL-1.1"
  • "Cube"
  • "dvipdfm"
  • "FreeBSD-DOC"
  • "Eurosym"
  • "FSFAP"
  • "FreeImage"
  • "FSFULLR"
  • "FSFUL"
  • "GD"
  • "GFDL-1.1-invariants-only"
  • "EUPL-1.2"
  • "EPL-2.0"
  • "GFDL-1.1-no-invariants-or-later"
  • "GFDL-1.1-only"
  • "GFDL-1.1-or-later"
  • "GFDL-1.1"
  • "FTL"
  • "GFDL-1.2-invariants-or-later"
  • "GFDL-1.1-invariants-or-later"
  • "GFDL-1.2-invariants-only"
  • "GFDL-1.2-only"
  • "GFDL-1.2-or-later"
  • "GFDL-1.2"
  • "GFDL-1.2-no-invariants-only"
  • "GFDL-1.3-invariants-only"
  • "GFDL-1.3-no-invariants-only"
  • "GFDL-1.3-invariants-or-later"
  • "GFDL-1.2-no-invariants-or-later"
  • "Fair"
  • "Frameworx-1.0"
  • "Giftware"
  • "GFDL-1.1-no-invariants-only"
  • "GL2PS"
  • "Glulxe"
  • "Glide"
  • "gnuplot"
  • "GLWTPL"
  • "GPL-1.0-only"
  • "GPL-1.0-or-later"
  • "GPL-1.0"
  • "GFDL-1.3-only"
  • "GPL-2.0-only"
  • "GPL-2.0-or-later"
  • "GPL-2.0-with-autoconf-exception"
  • "GPL-2.0+"
  • "GFDL-1.3"
  • "GPL-1.0+"
  • "CDLA-Sharing-1.0"
  • "GPL-2.0-with-classpath-exception"
  • "GPL-2.0-with-GCC-exception"
  • "GPL-2.0-with-bison-exception"
  • "GPL-2.0-with-font-exception"
  • "GPL-2.0"
  • "CECILL-2.1"
  • "GPL-3.0"
  • "GPL-3.0+"
  • "GPL-3.0-with-autoconf-exception"
  • "GPL-3.0-only"
  • "Hippocratic-2.1"
  • "HPND"
  • "HTMLTIDY"
  • "GPL-3.0-with-GCC-exception"
  • "HaskellReport"
  • "GPL-3.0-or-later"
  • "ICU"
  • "ImageMagick"
  • "iMatix"
  • "IBM-pibs"
  • "Intel-ACPI"
  • "Intel"
  • "Info-ZIP"
  • "IPA"
  • "IJG"
  • "ISC"
  • "JasPer-2.0"
  • "JPNIC"
  • "JSON"
  • "LAL-1.2"
  • "LAL-1.3"
  • "Latex2e"
  • "Leptonica"
  • "HPND-sell-variant"
  • "LGPL-2.0-only"
  • "LGPL-2.0-or-later"
  • "Imlib2"
  • "IPL-1.0"
  • "LGPL-2.1-only"
  • "LGPL-2.1-or-later"
  • "LGPL-2.0+"
  • "LGPL-2.0"
  • "CECILL-B"
  • "LGPL-3.0-or-later"
  • "LGPL-3.0-only"
  • "LGPLLR"
  • "libpng-2.0"
  • "Libpng"
  • "libselinux-1.0"
  • "LGPL-3.0+"
  • "EFL-1.0"
  • "libtiff"
  • "GFDL-1.3-no-invariants-or-later"
  • "LiLiQ-Rplus-1.1"
  • "LiLiQ-R-1.1"
  • "LPL-1.0"
  • "LiLiQ-P-1.1"
  • "Linux-OpenIB"
  • "LPPL-1.0"
  • "LPPL-1.2"
  • "LPPL-1.3a"
  • "LPL-1.02"
  • "LPPL-1.3c"
  • "MakeIndex"
  • "LGPL-2.1+"
  • "LPPL-1.1"
  • "MIT-CMU"
  • "MirOS"
  • "MIT-advertising"
  • "MIT-Modern-Variant"
  • "MIT"
  • "MIT-enna"
  • "MIT-open-group"
  • "MIT-feh"
  • "MITNFA"
  • "MPL-1.0"
  • "mpich2"
  • "MPL-2.0"
  • "MPL-2.0-no-copyleft-exception"
  • "MS-RL"
  • "MTLL"
  • "MPL-1.1"
  • "MulanPSL-2.0"
  • "Motosoto"
  • "Mup"
  • "MulanPSL-1.0"
  • "NAIST-2003"
  • "Naumen"
  • "Multics"
  • "NBPL-1.0"
  • "NCSA"
  • "Net-SNMP"
  • "NetCDF"
  • "NASA-1.3"
  • "NGPL"
  • "NIST-PD-fallback"
  • "NIST-PD"
  • "Newsletr"
  • "NLPL"
  • "Nokia"
  • "NOSL"
  • "Noweb"
  • "NLOD-1.0"
  • "NPL-1.0"
  • "NCGL-UK-2.0"
  • "NRL"
  • "NTP-0"
  • "NTP"
  • "GFDL-1.3-or-later"
  • "Nunit"
  • "O-UDA-1.0"
  • "NPL-1.1"
  • "OCCT-PL"
  • "ODC-By-1.0"
  • "OFL-1.0-no-RFN"
  • "OCLC-2.0"
  • "OFL-1.0-RFN"
  • "OFL-1.0"
  • "OFL-1.1-no-RFN"
  • "OFL-1.1-RFN"
  • "OFL-1.1"
  • "OGDL-Taiwan-1.0"
  • "OGC-1.0"
  • "OGL-UK-1.0"
  • "OGL-UK-2.0"
  • "OGL-UK-3.0"
  • "OGTSL"
  • "OLDAP-1.1"
  • "OLDAP-1.2"
  • "OLDAP-1.3"
  • "OGL-Canada-2.0"
  • "OLDAP-2.0.1"
  • "OLDAP-2.0"
  • "OLDAP-2.1"
  • "OLDAP-2.2.1"
  • "OLDAP-2.2.2"
  • "OLDAP-2.2"
  • "ODbL-1.0"
  • "OLDAP-2.4"
  • "OLDAP-1.4"
  • "OLDAP-2.3"
  • "OLDAP-2.7"
  • "OLDAP-2.8"
  • "OML"
  • "OpenSSL"
  • "OLDAP-2.6"
  • "OPL-1.0"
  • "OSL-1.0"
  • "OSL-1.1"
  • "OSL-2.0"
  • "OSET-PL-2.1"
  • "OSL-2.1"
  • "Parity-6.0.0"
  • "Parity-7.0.0"
  • "PDDL-1.0"
  • "PHP-3.0"
  • "OSL-3.0"
  • "Plexus"
  • "MS-PL"
  • "PolyForm-Small-Business-1.0.0"
  • "PolyForm-Noncommercial-1.0.0"
  • "PSF-2.0"
  • "psfrag"
  • "PostgreSQL"
  • "psutils"
  • "Qhull"
  • "QPL-1.0"
  • "Rdisc"
  • "Python-2.0"
  • "RPL-1.1"
  • "RPL-1.5"
  • "RHeCos-1.1"
  • "RSA-MD"
  • "RSCPL"
  • "Ruby"
  • "SAX-PD"
  • "Saxpath"
  • "SCEA"
  • "Sendmail-8.23"
  • "Sendmail"
  • "SGI-B-1.0"
  • "SGI-B-1.1"
  • "SGI-B-2.0"
  • "SHL-0.5"
  • "SHL-0.51"
  • "SimPL-2.0"
  • "SISSL-1.2"
  • "SISSL"
  • "Sleepycat"
  • "SMLNJ"
  • "SMPPL"
  • "SNIA"
  • "Spencer-86"
  • "Spencer-94"
  • "Spencer-99"
  • "SPL-1.0"
  • "SSH-OpenSSH"
  • "PHP-3.01"
  • "SSH-short"
  • "MIT-0"
  • "RPSL-1.0"
  • "SWL"
  • "SugarCRM-1.1.3"
  • "TCL"
  • "TCP-wrappers"
  • "SSPL-1.0"
  • "TMate"
  • "TOSL"
  • "TORQUE-1.1"
  • "TAPR-OHL-1.0"
  • "UCL-1.0"
  • "Unicode-DFS-2015"
  • "Unicode-DFS-2016"
  • "Unicode-TOU"
  • "TU-Berlin-1.0"
  • "UPL-1.0"
  • "Unlicense"
  • "VOSTROM"
  • "Vim"
  • "VSL-1.0"
  • "W3C-20150513"
  • "W3C"
  • "W3C-19980720"
  • "Wsuipa"
  • "Watcom-1.0"
  • "WTFPL"
  • "X11"
  • "Xerox"
  • "XFree86-1.1"
  • "xinetd"
  • "Xnet"
  • "xpp"
  • "XSkat"
  • "YPL-1.0"
  • "YPL-1.1"
  • "Zed"
  • "Zend-2.0"
  • "TU-Berlin-2.0"
  • "Zimbra-1.4"
  • "zlib-acknowledgement"
  • "Zlib"
  • "ZPL-1.1"
  • "ZPL-2.0"
  • "ZPL-2.1"
  • "wxWindows"
  • "Zimbra-1.3"
  • "gSOAP-1.3b"
  • "Interbase-1.0"
  • "LGPL-2.1"
  • "LGPL-3.0"
  • "NPOSL-3.0"
  • "OLDAP-2.5"
  • "StandardML-NJ"
  • "389-exception"
  • "Autoconf-exception-2.0"
  • "Autoconf-exception-3.0"
  • "Bison-exception-2.2"
  • "Bootloader-exception"
  • "Classpath-exception-2.0"
  • "CLISP-exception-2.0"
  • "DigiRule-FOSS-exception"
  • "eCos-exception-2.0"
  • "Fawkes-Runtime-exception"
  • "FLTK-exception"
  • "Font-exception-2.0"
  • "freertos-exception-2.0"
  • "GCC-exception-2.0"
  • "GCC-exception-3.1"
  • "gnu-javamail-exception"
  • "GPL-3.0-linking-exception"
  • "GPL-3.0-linking-source-exception"
  • "GPL-CC-1.0"
  • "i2p-gpl-java-exception"
  • "LGPL-3.0-linking-exception"
  • "Libtool-exception"
  • "Linux-syscall-note"
  • "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"
  • "PS-or-PDF-font-exception-20170817"
  • "Qt-GPL-exception-1.0"
  • "Qt-LGPL-exception-1.1"
  • "Qwt-exception-1.0"
  • "SHL-2.0"
  • "SHL-2.1"
  • "Swift-exception"
  • "u-boot-exception-2.0"
  • "Universal-FOSS-exception-1.0"
  • "WxWindows-exception-3.1"

Example:

"Apache-2.0"

Type: string Default: ""

If SPDX does not define the license used, this field may be used to provide the license name

Must match regular expression: ^(.*)$
Example:

"Acme Software License"

Type: object

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

No Additional Properties

Type: string Default: "text/plain"

Specifies the content type of the text. Defaults to text/plain if not specified.

Type: enum (of string) Default: ""

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"
Must match regular expression: ^(.*)$

Type: string

The attachment data

Type: string

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

Must match regular expression: ^(.*)$
Example:

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

Type: string
Must match regular expression: ^(.*)$
Examples:

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

Type: string

DEPRECATED - DO NOT USE. This will be removed in a future version. Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe

Must match regular expression: ^(.*)$
Example:

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

Type: string Default: ""
Must match regular expression: ^(.*)$
Example:

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

Type: object

Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.

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 content type of the text. Defaults to text/plain if not specified.

Type: enum (of string) Default: ""

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"
Must match regular expression: ^(.*)$

Type: string

The attachment data

Type: string Default: "The URL to the SWID file."
Must match regular expression: ^(.*)$

Type: boolean

DEPRECATED - DO NOT USE. 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 is 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.

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.

Each item of this array must be:

Type: array

Variants describe relations where the relationship between the components are 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.

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.

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.

Must match regular expression: ^(.*)$

Type: string

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: string

The timestamp in which the action occurred

Type: string

The name of the individual who performed the action

Must match regular expression: ^(.*)$

Type: string

The email address of the individual who performed the action

Type: object

The person who committed or pushed the commit

No Additional Properties

Type: string

The timestamp in which the action occurred

Type: string

The name of the individual who performed the action

Must match regular expression: ^(.*)$

Type: string

The email address of the individual who performed the action

Type: string

The text description of the contents of the commit

Must match regular expression: ^(.*)$

Type: array

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

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 show 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 content type of the text. Defaults to text/plain if not specified.

Type: enum (of string) Default: ""

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"
Must match regular expression: ^(.*)$

Type: string

The attachment data

Type: string

Specifies the URL to the diff

Must match regular expression: ^(.*)$

Type: array

A collection of issues the patch resolves

Each item of this array must be:

Type: object

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

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

Must match regular expression: ^(.*)$

Type: string

The name of the issue

Must match regular expression: ^(.*)$

Type: string

A description of the issue

Must match regular expression: ^(.*)$

Type: object

The source of the issue where it is documented

No Additional Properties

Type: string

The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'

Must match regular expression: ^(.*)$

Type: string

The url of the issue documentation as provided by the source

Must match regular expression: ^(.*)$

Type: array Default: ""

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

Must match regular expression: ^(.*)$
Example:

"https://example.com"

Type: string

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

Must match regular expression: ^(.*)$

Type: array

Each item of this array must be:

Type: object

Specifies an individual external reference

No Additional Properties

Type: string

The URL to the external reference

Must match regular expression: ^(.*)$

Type: string

An optional comment describing the external reference

Must match regular expression: ^(.*)$

Type: enum (of string)

Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the "other" type.

Must be one of:

  • "vcs"
  • "issue-tracker"
  • "website"
  • "advisories"
  • "bom"
  • "mailing-list"
  • "social"
  • "chat"
  • "documentation"
  • "support"
  • "distribution"
  • "license"
  • "build-meta"
  • "build-system"
  • "other"

Type: array

All items must be unique

Each item of this array must be:

Type: object

The organization that manufactured the component that the BOM describes.

No Additional Properties

Type: string Default: ""

The name of the organization

Must match regular expression: ^(.*)$
Example:

"Example Inc."

Type: array Default: ""

The URL of the organization. Multiple URLs are allowed.

Must match regular expression: ^(.*)$
Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

Each item of this array must be:

Type: object
No Additional Properties

Type: string Default: ""

The name of a contact

Must match regular expression: ^(.*)$
Example:

"Contact name"

Type: string Default: ""

The email address of the contact. Multiple email addresses are allowed.

Must match regular expression: ^(.*)$
Example:

Type: string Default: ""

The phone number of the contact. Multiple phone numbers are allowed.

Must match regular expression: ^(.*)$
Example:

"800-555-1212"

Type: object

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

No Additional Properties

Type: string Default: ""

The name of the organization

Must match regular expression: ^(.*)$
Example:

"Example Inc."

Type: array Default: ""

The URL of the organization. Multiple URLs are allowed.

Must match regular expression: ^(.*)$
Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

Each item of this array must be:

Type: object
No Additional Properties

Type: string Default: ""

The name of a contact

Must match regular expression: ^(.*)$
Example:

"Contact name"

Type: string Default: ""

The email address of the contact. Multiple email addresses are allowed.

Must match regular expression: ^(.*)$
Example:

Type: string Default: ""

The phone number of the contact. Multiple phone numbers are allowed.

Must match regular expression: ^(.*)$
Example:

"800-555-1212"

Type: array

All items must be unique

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string) Default: ""

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"
  • "operating-system"
  • "device"
  • "firmware"
  • "file"
Must match regular expression: ^(.*)$
Example:

"library"

Type: string Default: ""

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 Default: ""

An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref should be unique.

Must match regular expression: ^(.*)$

Type: object

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

No Additional Properties

Type: string Default: ""

The name of the organization

Must match regular expression: ^(.*)$
Example:

"Example Inc."

Type: array Default: ""

The URL of the organization. Multiple URLs are allowed.

Must match regular expression: ^(.*)$
Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

Each item of this array must be:

Type: object
No Additional Properties

Type: string Default: ""

The name of a contact

Must match regular expression: ^(.*)$
Example:

"Contact name"

Type: string Default: ""

The email address of the contact. Multiple email addresses are allowed.

Must match regular expression: ^(.*)$
Example:

Type: string Default: ""

The phone number of the contact. Multiple phone numbers are allowed.

Must match regular expression: ^(.*)$
Example:

"800-555-1212"

Type: string Default: ""

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

Must match regular expression: ^(.*)$
Example:

"Acme Inc"

Type: string Default: ""

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

Must match regular expression: ^(.*)$
Example:

"Acme Inc"

Type: string Default: ""

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.

Must match regular expression: ^(.*)$
Example:

"com.acme"

Type: string Default: ""

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

Must match regular expression: ^(.*)$
Example:

"tomcat-catalina"

Type: string Default: ""

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

Must match regular expression: ^(.*)$
Example:

"9.0.14"

Type: string Default: ""

Specifies a description for the component

Must match regular expression: ^(.*)$

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"
Must match regular expression: ^(.*)$

Type: array

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string) Default: ""

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"
Must match regular expression: ^(.*)$

Type: string Default: ""
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

Each item of this array must be:


No Additional Properties

Type: object

The following properties are required:

  • license
Type: object

The following properties are required:

  • expression

Type: object
No Additional Properties

Type: object

The following properties are required:

  • id
Type: object

The following properties are required:

  • name

Type: enum (of string)

A valid SPDX license ID

Must be one of:

  • "AFL-2.0"
  • "AAL"
  • "Adobe-2006"
  • "AFL-3.0"
  • "ADSL"
  • "0BSD"
  • "Afmparse"
  • "AFL-1.2"
  • "AGPL-1.0-or-later"
  • "AFL-2.1"
  • "AFL-1.1"
  • "AGPL-1.0"
  • "Adobe-Glyph"
  • "AMDPLPA"
  • "Aladdin"
  • "ANTLR-PD"
  • "AML"
  • "Apache-1.0"
  • "ANTLR-PD-fallback"
  • "Abstyles"
  • "AGPL-1.0-only"
  • "APAFML"
  • "APSL-1.0"
  • "APSL-1.1"
  • "APSL-2.0"
  • "AGPL-3.0-only"
  • "Apache-1.1"
  • "Apache-2.0"
  • "APL-1.0"
  • "Bahyph"
  • "Artistic-1.0"
  • "AMPAS"
  • "Barr"
  • "AGPL-3.0-or-later"
  • "BlueOak-1.0.0"
  • "Beerware"
  • "Artistic-1.0-cl8"
  • "blessing"
  • "Borceux"
  • "BSD-2-Clause-NetBSD"
  • "BSD-1-Clause"
  • "BSD-2-Clause-Patent"
  • "BitTorrent-1.0"
  • "BSD-2-Clause-FreeBSD"
  • "BSD-3-Clause-Attribution"
  • "BSD-2-Clause"
  • "APSL-1.2"
  • "BSD-3-Clause-LBNL"
  • "Artistic-2.0"
  • "BSD-3-Clause-No-Nuclear-License-2014"
  • "BSD-3-Clause-Modification"
  • "BSD-4-Clause-Shortened"
  • "BSD-3-Clause"
  • "BSD-3-Clause-Open-MPI"
  • "BitTorrent-1.1"
  • "BSD-3-Clause-No-Nuclear-Warranty"
  • "BSD-Source-Code"
  • "BSD-Protection"
  • "AGPL-3.0"
  • "BUSL-1.1"
  • "Artistic-1.0-Perl"
  • "BSL-1.0"
  • "BSD-2-Clause-Views"
  • "CAL-1.0-Combined-Work-Exception"
  • "CATOSL-1.1"
  • "bzip2-1.0.5"
  • "bzip2-1.0.6"
  • "CC-BY-2.5"
  • "CC-BY-3.0-AT"
  • "C-UDA-1.0"
  • "CC-BY-3.0-US"
  • "CC-BY-1.0"
  • "CC-BY-NC-1.0"
  • "CC-BY-NC-2.0"
  • "CC-BY-NC-2.5"
  • "CC-BY-2.0"
  • "CC-BY-NC-4.0"
  • "CC-BY-NC-ND-1.0"
  • "CC-BY-NC-ND-2.0"
  • "CC-BY-NC-3.0"
  • "CC-BY-NC-ND-3.0-IGO"
  • "CC-BY-NC-ND-3.0"
  • "BSD-3-Clause-No-Nuclear-License"
  • "CC-BY-NC-ND-4.0"
  • "CC-BY-NC-SA-2.0"
  • "CC-BY-NC-SA-2.5"
  • "CC-BY-NC-SA-3.0"
  • "CC-BY-NC-SA-4.0"
  • "CC-BY-ND-1.0"
  • "BSD-3-Clause-Clear"
  • "CC-BY-ND-2.5"
  • "CC-BY-ND-3.0"
  • "CC-BY-ND-4.0"
  • "CC-BY-SA-1.0"
  • "CC-BY-SA-2.0-UK"
  • "CC-BY-SA-2.0"
  • "CC-BY-SA-2.1-JP"
  • "CC-BY-ND-2.0"
  • "CC-BY-SA-3.0-AT"
  • "CC-BY-SA-3.0"
  • "CC-BY-SA-4.0"
  • "CC-BY-SA-2.5"
  • "CC-BY-3.0"
  • "CDDL-1.0"
  • "CC0-1.0"
  • "CC-BY-NC-ND-2.5"
  • "CC-BY-NC-SA-1.0"
  • "Caldera"
  • "CDLA-Permissive-1.0"
  • "CC-BY-4.0"
  • "CC-PDDC"
  • "BSD-4-Clause-UC"
  • "BSD-4-Clause"
  • "CAL-1.0"
  • "CDDL-1.1"
  • "CERN-OHL-1.2"
  • "CERN-OHL-1.1"
  • "CERN-OHL-P-2.0"
  • "CERN-OHL-S-2.0"
  • "CECILL-1.1"
  • "CECILL-2.0"
  • "CECILL-1.0"
  • "CNRI-Python"
  • "CNRI-Python-GPL-Compatible"
  • "copyleft-next-0.3.0"
  • "CPAL-1.0"
  • "copyleft-next-0.3.1"
  • "CPL-1.0"
  • "ClArtistic"
  • "CECILL-C"
  • "CNRI-Jython"
  • "Condor-1.1"
  • "CPOL-1.02"
  • "curl"
  • "diffmark"
  • "Crossword"
  • "Dotseqn"
  • "DOC"
  • "DSDP"
  • "DRL-1.0"
  • "ECL-1.0"
  • "ECL-2.0"
  • "eCos-2.0"
  • "CrystalStacker"
  • "CERN-OHL-W-2.0"
  • "D-FSL-1.0"
  • "eGenix"
  • "EPICS"
  • "Entessa"
  • "EPL-1.0"
  • "EFL-2.0"
  • "CUA-OPL-1.0"
  • "etalab-2.0"
  • "EUPL-1.0"
  • "ErlPL-1.1"
  • "EUDatagrid"
  • "EUPL-1.1"
  • "Cube"
  • "dvipdfm"
  • "FreeBSD-DOC"
  • "Eurosym"
  • "FSFAP"
  • "FreeImage"
  • "FSFULLR"
  • "FSFUL"
  • "GD"
  • "GFDL-1.1-invariants-only"
  • "EUPL-1.2"
  • "EPL-2.0"
  • "GFDL-1.1-no-invariants-or-later"
  • "GFDL-1.1-only"
  • "GFDL-1.1-or-later"
  • "GFDL-1.1"
  • "FTL"
  • "GFDL-1.2-invariants-or-later"
  • "GFDL-1.1-invariants-or-later"
  • "GFDL-1.2-invariants-only"
  • "GFDL-1.2-only"
  • "GFDL-1.2-or-later"
  • "GFDL-1.2"
  • "GFDL-1.2-no-invariants-only"
  • "GFDL-1.3-invariants-only"
  • "GFDL-1.3-no-invariants-only"
  • "GFDL-1.3-invariants-or-later"
  • "GFDL-1.2-no-invariants-or-later"
  • "Fair"
  • "Frameworx-1.0"
  • "Giftware"
  • "GFDL-1.1-no-invariants-only"
  • "GL2PS"
  • "Glulxe"
  • "Glide"
  • "gnuplot"
  • "GLWTPL"
  • "GPL-1.0-only"
  • "GPL-1.0-or-later"
  • "GPL-1.0"
  • "GFDL-1.3-only"
  • "GPL-2.0-only"
  • "GPL-2.0-or-later"
  • "GPL-2.0-with-autoconf-exception"
  • "GPL-2.0+"
  • "GFDL-1.3"
  • "GPL-1.0+"
  • "CDLA-Sharing-1.0"
  • "GPL-2.0-with-classpath-exception"
  • "GPL-2.0-with-GCC-exception"
  • "GPL-2.0-with-bison-exception"
  • "GPL-2.0-with-font-exception"
  • "GPL-2.0"
  • "CECILL-2.1"
  • "GPL-3.0"
  • "GPL-3.0+"
  • "GPL-3.0-with-autoconf-exception"
  • "GPL-3.0-only"
  • "Hippocratic-2.1"
  • "HPND"
  • "HTMLTIDY"
  • "GPL-3.0-with-GCC-exception"
  • "HaskellReport"
  • "GPL-3.0-or-later"
  • "ICU"
  • "ImageMagick"
  • "iMatix"
  • "IBM-pibs"
  • "Intel-ACPI"
  • "Intel"
  • "Info-ZIP"
  • "IPA"
  • "IJG"
  • "ISC"
  • "JasPer-2.0"
  • "JPNIC"
  • "JSON"
  • "LAL-1.2"
  • "LAL-1.3"
  • "Latex2e"
  • "Leptonica"
  • "HPND-sell-variant"
  • "LGPL-2.0-only"
  • "LGPL-2.0-or-later"
  • "Imlib2"
  • "IPL-1.0"
  • "LGPL-2.1-only"
  • "LGPL-2.1-or-later"
  • "LGPL-2.0+"
  • "LGPL-2.0"
  • "CECILL-B"
  • "LGPL-3.0-or-later"
  • "LGPL-3.0-only"
  • "LGPLLR"
  • "libpng-2.0"
  • "Libpng"
  • "libselinux-1.0"
  • "LGPL-3.0+"
  • "EFL-1.0"
  • "libtiff"
  • "GFDL-1.3-no-invariants-or-later"
  • "LiLiQ-Rplus-1.1"
  • "LiLiQ-R-1.1"
  • "LPL-1.0"
  • "LiLiQ-P-1.1"
  • "Linux-OpenIB"
  • "LPPL-1.0"
  • "LPPL-1.2"
  • "LPPL-1.3a"
  • "LPL-1.02"
  • "LPPL-1.3c"
  • "MakeIndex"
  • "LGPL-2.1+"
  • "LPPL-1.1"
  • "MIT-CMU"
  • "MirOS"
  • "MIT-advertising"
  • "MIT-Modern-Variant"
  • "MIT"
  • "MIT-enna"
  • "MIT-open-group"
  • "MIT-feh"
  • "MITNFA"
  • "MPL-1.0"
  • "mpich2"
  • "MPL-2.0"
  • "MPL-2.0-no-copyleft-exception"
  • "MS-RL"
  • "MTLL"
  • "MPL-1.1"
  • "MulanPSL-2.0"
  • "Motosoto"
  • "Mup"
  • "MulanPSL-1.0"
  • "NAIST-2003"
  • "Naumen"
  • "Multics"
  • "NBPL-1.0"
  • "NCSA"
  • "Net-SNMP"
  • "NetCDF"
  • "NASA-1.3"
  • "NGPL"
  • "NIST-PD-fallback"
  • "NIST-PD"
  • "Newsletr"
  • "NLPL"
  • "Nokia"
  • "NOSL"
  • "Noweb"
  • "NLOD-1.0"
  • "NPL-1.0"
  • "NCGL-UK-2.0"
  • "NRL"
  • "NTP-0"
  • "NTP"
  • "GFDL-1.3-or-later"
  • "Nunit"
  • "O-UDA-1.0"
  • "NPL-1.1"
  • "OCCT-PL"
  • "ODC-By-1.0"
  • "OFL-1.0-no-RFN"
  • "OCLC-2.0"
  • "OFL-1.0-RFN"
  • "OFL-1.0"
  • "OFL-1.1-no-RFN"
  • "OFL-1.1-RFN"
  • "OFL-1.1"
  • "OGDL-Taiwan-1.0"
  • "OGC-1.0"
  • "OGL-UK-1.0"
  • "OGL-UK-2.0"
  • "OGL-UK-3.0"
  • "OGTSL"
  • "OLDAP-1.1"
  • "OLDAP-1.2"
  • "OLDAP-1.3"
  • "OGL-Canada-2.0"
  • "OLDAP-2.0.1"
  • "OLDAP-2.0"
  • "OLDAP-2.1"
  • "OLDAP-2.2.1"
  • "OLDAP-2.2.2"
  • "OLDAP-2.2"
  • "ODbL-1.0"
  • "OLDAP-2.4"
  • "OLDAP-1.4"
  • "OLDAP-2.3"
  • "OLDAP-2.7"
  • "OLDAP-2.8"
  • "OML"
  • "OpenSSL"
  • "OLDAP-2.6"
  • "OPL-1.0"
  • "OSL-1.0"
  • "OSL-1.1"
  • "OSL-2.0"
  • "OSET-PL-2.1"
  • "OSL-2.1"
  • "Parity-6.0.0"
  • "Parity-7.0.0"
  • "PDDL-1.0"
  • "PHP-3.0"
  • "OSL-3.0"
  • "Plexus"
  • "MS-PL"
  • "PolyForm-Small-Business-1.0.0"
  • "PolyForm-Noncommercial-1.0.0"
  • "PSF-2.0"
  • "psfrag"
  • "PostgreSQL"
  • "psutils"
  • "Qhull"
  • "QPL-1.0"
  • "Rdisc"
  • "Python-2.0"
  • "RPL-1.1"
  • "RPL-1.5"
  • "RHeCos-1.1"
  • "RSA-MD"
  • "RSCPL"
  • "Ruby"
  • "SAX-PD"
  • "Saxpath"
  • "SCEA"
  • "Sendmail-8.23"
  • "Sendmail"
  • "SGI-B-1.0"
  • "SGI-B-1.1"
  • "SGI-B-2.0"
  • "SHL-0.5"
  • "SHL-0.51"
  • "SimPL-2.0"
  • "SISSL-1.2"
  • "SISSL"
  • "Sleepycat"
  • "SMLNJ"
  • "SMPPL"
  • "SNIA"
  • "Spencer-86"
  • "Spencer-94"
  • "Spencer-99"
  • "SPL-1.0"
  • "SSH-OpenSSH"
  • "PHP-3.01"
  • "SSH-short"
  • "MIT-0"
  • "RPSL-1.0"
  • "SWL"
  • "SugarCRM-1.1.3"
  • "TCL"
  • "TCP-wrappers"
  • "SSPL-1.0"
  • "TMate"
  • "TOSL"
  • "TORQUE-1.1"
  • "TAPR-OHL-1.0"
  • "UCL-1.0"
  • "Unicode-DFS-2015"
  • "Unicode-DFS-2016"
  • "Unicode-TOU"
  • "TU-Berlin-1.0"
  • "UPL-1.0"
  • "Unlicense"
  • "VOSTROM"
  • "Vim"
  • "VSL-1.0"
  • "W3C-20150513"
  • "W3C"
  • "W3C-19980720"
  • "Wsuipa"
  • "Watcom-1.0"
  • "WTFPL"
  • "X11"
  • "Xerox"
  • "XFree86-1.1"
  • "xinetd"
  • "Xnet"
  • "xpp"
  • "XSkat"
  • "YPL-1.0"
  • "YPL-1.1"
  • "Zed"
  • "Zend-2.0"
  • "TU-Berlin-2.0"
  • "Zimbra-1.4"
  • "zlib-acknowledgement"
  • "Zlib"
  • "ZPL-1.1"
  • "ZPL-2.0"
  • "ZPL-2.1"
  • "wxWindows"
  • "Zimbra-1.3"
  • "gSOAP-1.3b"
  • "Interbase-1.0"
  • "LGPL-2.1"
  • "LGPL-3.0"
  • "NPOSL-3.0"
  • "OLDAP-2.5"
  • "StandardML-NJ"
  • "389-exception"
  • "Autoconf-exception-2.0"
  • "Autoconf-exception-3.0"
  • "Bison-exception-2.2"
  • "Bootloader-exception"
  • "Classpath-exception-2.0"
  • "CLISP-exception-2.0"
  • "DigiRule-FOSS-exception"
  • "eCos-exception-2.0"
  • "Fawkes-Runtime-exception"
  • "FLTK-exception"
  • "Font-exception-2.0"
  • "freertos-exception-2.0"
  • "GCC-exception-2.0"
  • "GCC-exception-3.1"
  • "gnu-javamail-exception"
  • "GPL-3.0-linking-exception"
  • "GPL-3.0-linking-source-exception"
  • "GPL-CC-1.0"
  • "i2p-gpl-java-exception"
  • "LGPL-3.0-linking-exception"
  • "Libtool-exception"
  • "Linux-syscall-note"
  • "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"
  • "PS-or-PDF-font-exception-20170817"
  • "Qt-GPL-exception-1.0"
  • "Qt-LGPL-exception-1.1"
  • "Qwt-exception-1.0"
  • "SHL-2.0"
  • "SHL-2.1"
  • "Swift-exception"
  • "u-boot-exception-2.0"
  • "Universal-FOSS-exception-1.0"
  • "WxWindows-exception-3.1"

Example:

"Apache-2.0"

Type: string Default: ""

If SPDX does not define the license used, this field may be used to provide the license name

Must match regular expression: ^(.*)$
Example:

"Acme Software License"

Type: object

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

No Additional Properties

Type: string Default: "text/plain"

Specifies the content type of the text. Defaults to text/plain if not specified.

Type: enum (of string) Default: ""

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"
Must match regular expression: ^(.*)$

Type: string

The attachment data

Type: string

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

Must match regular expression: ^(.*)$
Example:

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

Type: string
Must match regular expression: ^(.*)$
Examples:

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

Type: string

DEPRECATED - DO NOT USE. This will be removed in a future version. Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe

Must match regular expression: ^(.*)$
Example:

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

Type: string Default: ""
Must match regular expression: ^(.*)$
Example:

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

Type: object

Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.

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 content type of the text. Defaults to text/plain if not specified.

Type: enum (of string) Default: ""

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"
Must match regular expression: ^(.*)$

Type: string

The attachment data

Type: string Default: "The URL to the SWID file."
Must match regular expression: ^(.*)$

Type: boolean

DEPRECATED - DO NOT USE. 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 is 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.

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.

Each item of this array must be:

Type: array

Variants describe relations where the relationship between the components are 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.

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.

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.

Must match regular expression: ^(.*)$

Type: string

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: string

The timestamp in which the action occurred

Type: string

The name of the individual who performed the action

Must match regular expression: ^(.*)$

Type: string

The email address of the individual who performed the action

Type: object

The person who committed or pushed the commit

No Additional Properties

Type: string

The timestamp in which the action occurred

Type: string

The name of the individual who performed the action

Must match regular expression: ^(.*)$

Type: string

The email address of the individual who performed the action

Type: string

The text description of the contents of the commit

Must match regular expression: ^(.*)$

Type: array

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

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 show 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 content type of the text. Defaults to text/plain if not specified.

Type: enum (of string) Default: ""

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"
Must match regular expression: ^(.*)$

Type: string

The attachment data

Type: string

Specifies the URL to the diff

Must match regular expression: ^(.*)$

Type: array

A collection of issues the patch resolves

Each item of this array must be:

Type: object

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

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

Must match regular expression: ^(.*)$

Type: string

The name of the issue

Must match regular expression: ^(.*)$

Type: string

A description of the issue

Must match regular expression: ^(.*)$

Type: object

The source of the issue where it is documented

No Additional Properties

Type: string

The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'

Must match regular expression: ^(.*)$

Type: string

The url of the issue documentation as provided by the source

Must match regular expression: ^(.*)$

Type: array Default: ""

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

Must match regular expression: ^(.*)$
Example:

"https://example.com"

Type: string

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

Must match regular expression: ^(.*)$

Type: array

Each item of this array must be:

Type: object

Specifies an individual external reference

No Additional Properties

Type: string

The URL to the external reference

Must match regular expression: ^(.*)$

Type: string

An optional comment describing the external reference

Must match regular expression: ^(.*)$

Type: enum (of string)

Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the "other" type.

Must be one of:

  • "vcs"
  • "issue-tracker"
  • "website"
  • "advisories"
  • "bom"
  • "mailing-list"
  • "social"
  • "chat"
  • "documentation"
  • "support"
  • "distribution"
  • "license"
  • "build-meta"
  • "build-system"
  • "other"

Type: array

All items must be unique

Each item of this array must be:

Type: array

All items must be unique

Each item of this array must be:

Type: object
No Additional Properties

Type: string Default: ""

An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref should be unique.

Must match regular expression: ^(.*)$

Type: object

The organization that provides the service.

No Additional Properties

Type: string Default: ""

The name of the organization

Must match regular expression: ^(.*)$
Example:

"Example Inc."

Type: array Default: ""

The URL of the organization. Multiple URLs are allowed.

Must match regular expression: ^(.*)$
Example:

"https://example.com"

Type: array

A contact at the organization. Multiple contacts are allowed.

Each item of this array must be:

Type: object
No Additional Properties

Type: string Default: ""

The name of a contact

Must match regular expression: ^(.*)$
Example:

"Contact name"

Type: string Default: ""

The email address of the contact. Multiple email addresses are allowed.

Must match regular expression: ^(.*)$
Example:

Type: string Default: ""

The phone number of the contact. Multiple phone numbers are allowed.

Must match regular expression: ^(.*)$
Example:

"800-555-1212"

Type: string Default: ""

The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.

Must match regular expression: ^(.*)$
Example:

"com.acme"

Type: string Default: ""

The name of the service. This will often be a shortened, single name of the service.

Must match regular expression: ^(.*)$
Example:

"ticker-service"

Type: string Default: ""

The service version.

Must match regular expression: ^(.*)$
Example:

"1.0.0"

Type: string Default: ""

Specifies a description for the service

Must match regular expression: ^(.*)$

Type: array Default: ""

The endpoint URIs of the service. Multiple endpoints are allowed.

Must match regular expression: ^(.*)$
Example:

"https://example.com/api/v1/ticker"

Type: boolean

A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication.

Type: boolean

A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed.

Type: array

Specifies the data classification.

Each item of this array must be:

Type: object
No Additional Properties

Type: enum (of string) Default: ""

Must be one of:

  • "inbound"
  • "outbound"
  • "bi-directional"
  • "unknown"
Must match regular expression: ^(.*)$

Type: string

Type: array

Each item of this array must be:


No Additional Properties

Type: object

The following properties are required:

  • license
Type: object

The following properties are required:

  • expression

Type: object
No Additional Properties

Type: object

The following properties are required:

  • id
Type: object

The following properties are required:

  • name

Type: enum (of string)

A valid SPDX license ID

Must be one of:

  • "AFL-2.0"
  • "AAL"
  • "Adobe-2006"
  • "AFL-3.0"
  • "ADSL"
  • "0BSD"
  • "Afmparse"
  • "AFL-1.2"
  • "AGPL-1.0-or-later"
  • "AFL-2.1"
  • "AFL-1.1"
  • "AGPL-1.0"
  • "Adobe-Glyph"
  • "AMDPLPA"
  • "Aladdin"
  • "ANTLR-PD"
  • "AML"
  • "Apache-1.0"
  • "ANTLR-PD-fallback"
  • "Abstyles"
  • "AGPL-1.0-only"
  • "APAFML"
  • "APSL-1.0"
  • "APSL-1.1"
  • "APSL-2.0"
  • "AGPL-3.0-only"
  • "Apache-1.1"
  • "Apache-2.0"
  • "APL-1.0"
  • "Bahyph"
  • "Artistic-1.0"
  • "AMPAS"
  • "Barr"
  • "AGPL-3.0-or-later"
  • "BlueOak-1.0.0"
  • "Beerware"
  • "Artistic-1.0-cl8"
  • "blessing"
  • "Borceux"
  • "BSD-2-Clause-NetBSD"
  • "BSD-1-Clause"
  • "BSD-2-Clause-Patent"
  • "BitTorrent-1.0"
  • "BSD-2-Clause-FreeBSD"
  • "BSD-3-Clause-Attribution"
  • "BSD-2-Clause"
  • "APSL-1.2"
  • "BSD-3-Clause-LBNL"
  • "Artistic-2.0"
  • "BSD-3-Clause-No-Nuclear-License-2014"
  • "BSD-3-Clause-Modification"
  • "BSD-4-Clause-Shortened"
  • "BSD-3-Clause"
  • "BSD-3-Clause-Open-MPI"
  • "BitTorrent-1.1"
  • "BSD-3-Clause-No-Nuclear-Warranty"
  • "BSD-Source-Code"
  • "BSD-Protection"
  • "AGPL-3.0"
  • "BUSL-1.1"
  • "Artistic-1.0-Perl"
  • "BSL-1.0"
  • "BSD-2-Clause-Views"
  • "CAL-1.0-Combined-Work-Exception"
  • "CATOSL-1.1"
  • "bzip2-1.0.5"
  • "bzip2-1.0.6"
  • "CC-BY-2.5"
  • "CC-BY-3.0-AT"
  • "C-UDA-1.0"
  • "CC-BY-3.0-US"
  • "CC-BY-1.0"
  • "CC-BY-NC-1.0"
  • "CC-BY-NC-2.0"
  • "CC-BY-NC-2.5"
  • "CC-BY-2.0"
  • "CC-BY-NC-4.0"
  • "CC-BY-NC-ND-1.0"
  • "CC-BY-NC-ND-2.0"
  • "CC-BY-NC-3.0"
  • "CC-BY-NC-ND-3.0-IGO"
  • "CC-BY-NC-ND-3.0"
  • "BSD-3-Clause-No-Nuclear-License"
  • "CC-BY-NC-ND-4.0"
  • "CC-BY-NC-SA-2.0"
  • "CC-BY-NC-SA-2.5"
  • "CC-BY-NC-SA-3.0"
  • "CC-BY-NC-SA-4.0"
  • "CC-BY-ND-1.0"
  • "BSD-3-Clause-Clear"
  • "CC-BY-ND-2.5"
  • "CC-BY-ND-3.0"
  • "CC-BY-ND-4.0"
  • "CC-BY-SA-1.0"
  • "CC-BY-SA-2.0-UK"
  • "CC-BY-SA-2.0"
  • "CC-BY-SA-2.1-JP"
  • "CC-BY-ND-2.0"
  • "CC-BY-SA-3.0-AT"
  • "CC-BY-SA-3.0"
  • "CC-BY-SA-4.0"
  • "CC-BY-SA-2.5"
  • "CC-BY-3.0"
  • "CDDL-1.0"
  • "CC0-1.0"
  • "CC-BY-NC-ND-2.5"
  • "CC-BY-NC-SA-1.0"
  • "Caldera"
  • "CDLA-Permissive-1.0"
  • "CC-BY-4.0"
  • "CC-PDDC"
  • "BSD-4-Clause-UC"
  • "BSD-4-Clause"
  • "CAL-1.0"
  • "CDDL-1.1"
  • "CERN-OHL-1.2"
  • "CERN-OHL-1.1"
  • "CERN-OHL-P-2.0"
  • "CERN-OHL-S-2.0"
  • "CECILL-1.1"
  • "CECILL-2.0"
  • "CECILL-1.0"
  • "CNRI-Python"
  • "CNRI-Python-GPL-Compatible"
  • "copyleft-next-0.3.0"
  • "CPAL-1.0"
  • "copyleft-next-0.3.1"
  • "CPL-1.0"
  • "ClArtistic"
  • "CECILL-C"
  • "CNRI-Jython"
  • "Condor-1.1"
  • "CPOL-1.02"
  • "curl"
  • "diffmark"
  • "Crossword"
  • "Dotseqn"
  • "DOC"
  • "DSDP"
  • "DRL-1.0"
  • "ECL-1.0"
  • "ECL-2.0"
  • "eCos-2.0"
  • "CrystalStacker"
  • "CERN-OHL-W-2.0"
  • "D-FSL-1.0"
  • "eGenix"
  • "EPICS"
  • "Entessa"
  • "EPL-1.0"
  • "EFL-2.0"
  • "CUA-OPL-1.0"
  • "etalab-2.0"
  • "EUPL-1.0"
  • "ErlPL-1.1"
  • "EUDatagrid"
  • "EUPL-1.1"
  • "Cube"
  • "dvipdfm"
  • "FreeBSD-DOC"
  • "Eurosym"
  • "FSFAP"
  • "FreeImage"
  • "FSFULLR"
  • "FSFUL"
  • "GD"
  • "GFDL-1.1-invariants-only"
  • "EUPL-1.2"
  • "EPL-2.0"
  • "GFDL-1.1-no-invariants-or-later"
  • "GFDL-1.1-only"
  • "GFDL-1.1-or-later"
  • "GFDL-1.1"
  • "FTL"
  • "GFDL-1.2-invariants-or-later"
  • "GFDL-1.1-invariants-or-later"
  • "GFDL-1.2-invariants-only"
  • "GFDL-1.2-only"
  • "GFDL-1.2-or-later"
  • "GFDL-1.2"
  • "GFDL-1.2-no-invariants-only"
  • "GFDL-1.3-invariants-only"
  • "GFDL-1.3-no-invariants-only"
  • "GFDL-1.3-invariants-or-later"
  • "GFDL-1.2-no-invariants-or-later"
  • "Fair"
  • "Frameworx-1.0"
  • "Giftware"
  • "GFDL-1.1-no-invariants-only"
  • "GL2PS"
  • "Glulxe"
  • "Glide"
  • "gnuplot"
  • "GLWTPL"
  • "GPL-1.0-only"
  • "GPL-1.0-or-later"
  • "GPL-1.0"
  • "GFDL-1.3-only"
  • "GPL-2.0-only"
  • "GPL-2.0-or-later"
  • "GPL-2.0-with-autoconf-exception"
  • "GPL-2.0+"
  • "GFDL-1.3"
  • "GPL-1.0+"
  • "CDLA-Sharing-1.0"
  • "GPL-2.0-with-classpath-exception"
  • "GPL-2.0-with-GCC-exception"
  • "GPL-2.0-with-bison-exception"
  • "GPL-2.0-with-font-exception"
  • "GPL-2.0"
  • "CECILL-2.1"
  • "GPL-3.0"
  • "GPL-3.0+"
  • "GPL-3.0-with-autoconf-exception"
  • "GPL-3.0-only"
  • "Hippocratic-2.1"
  • "HPND"
  • "HTMLTIDY"
  • "GPL-3.0-with-GCC-exception"
  • "HaskellReport"
  • "GPL-3.0-or-later"
  • "ICU"
  • "ImageMagick"
  • "iMatix"
  • "IBM-pibs"
  • "Intel-ACPI"
  • "Intel"
  • "Info-ZIP"
  • "IPA"
  • "IJG"
  • "ISC"
  • "JasPer-2.0"
  • "JPNIC"
  • "JSON"
  • "LAL-1.2"
  • "LAL-1.3"
  • "Latex2e"
  • "Leptonica"
  • "HPND-sell-variant"
  • "LGPL-2.0-only"
  • "LGPL-2.0-or-later"
  • "Imlib2"
  • "IPL-1.0"
  • "LGPL-2.1-only"
  • "LGPL-2.1-or-later"
  • "LGPL-2.0+"
  • "LGPL-2.0"
  • "CECILL-B"
  • "LGPL-3.0-or-later"
  • "LGPL-3.0-only"
  • "LGPLLR"
  • "libpng-2.0"
  • "Libpng"
  • "libselinux-1.0"
  • "LGPL-3.0+"
  • "EFL-1.0"
  • "libtiff"
  • "GFDL-1.3-no-invariants-or-later"
  • "LiLiQ-Rplus-1.1"
  • "LiLiQ-R-1.1"
  • "LPL-1.0"
  • "LiLiQ-P-1.1"
  • "Linux-OpenIB"
  • "LPPL-1.0"
  • "LPPL-1.2"
  • "LPPL-1.3a"
  • "LPL-1.02"
  • "LPPL-1.3c"
  • "MakeIndex"
  • "LGPL-2.1+"
  • "LPPL-1.1"
  • "MIT-CMU"
  • "MirOS"
  • "MIT-advertising"
  • "MIT-Modern-Variant"
  • "MIT"
  • "MIT-enna"
  • "MIT-open-group"
  • "MIT-feh"
  • "MITNFA"
  • "MPL-1.0"
  • "mpich2"
  • "MPL-2.0"
  • "MPL-2.0-no-copyleft-exception"
  • "MS-RL"
  • "MTLL"
  • "MPL-1.1"
  • "MulanPSL-2.0"
  • "Motosoto"
  • "Mup"
  • "MulanPSL-1.0"
  • "NAIST-2003"
  • "Naumen"
  • "Multics"
  • "NBPL-1.0"
  • "NCSA"
  • "Net-SNMP"
  • "NetCDF"
  • "NASA-1.3"
  • "NGPL"
  • "NIST-PD-fallback"
  • "NIST-PD"
  • "Newsletr"
  • "NLPL"
  • "Nokia"
  • "NOSL"
  • "Noweb"
  • "NLOD-1.0"
  • "NPL-1.0"
  • "NCGL-UK-2.0"
  • "NRL"
  • "NTP-0"
  • "NTP"
  • "GFDL-1.3-or-later"
  • "Nunit"
  • "O-UDA-1.0"
  • "NPL-1.1"
  • "OCCT-PL"
  • "ODC-By-1.0"
  • "OFL-1.0-no-RFN"
  • "OCLC-2.0"
  • "OFL-1.0-RFN"
  • "OFL-1.0"
  • "OFL-1.1-no-RFN"
  • "OFL-1.1-RFN"
  • "OFL-1.1"
  • "OGDL-Taiwan-1.0"
  • "OGC-1.0"
  • "OGL-UK-1.0"
  • "OGL-UK-2.0"
  • "OGL-UK-3.0"
  • "OGTSL"
  • "OLDAP-1.1"
  • "OLDAP-1.2"
  • "OLDAP-1.3"
  • "OGL-Canada-2.0"
  • "OLDAP-2.0.1"
  • "OLDAP-2.0"
  • "OLDAP-2.1"
  • "OLDAP-2.2.1"
  • "OLDAP-2.2.2"
  • "OLDAP-2.2"
  • "ODbL-1.0"
  • "OLDAP-2.4"
  • "OLDAP-1.4"
  • "OLDAP-2.3"
  • "OLDAP-2.7"
  • "OLDAP-2.8"
  • "OML"
  • "OpenSSL"
  • "OLDAP-2.6"
  • "OPL-1.0"
  • "OSL-1.0"
  • "OSL-1.1"
  • "OSL-2.0"
  • "OSET-PL-2.1"
  • "OSL-2.1"
  • "Parity-6.0.0"
  • "Parity-7.0.0"
  • "PDDL-1.0"
  • "PHP-3.0"
  • "OSL-3.0"
  • "Plexus"
  • "MS-PL"
  • "PolyForm-Small-Business-1.0.0"
  • "PolyForm-Noncommercial-1.0.0"
  • "PSF-2.0"
  • "psfrag"
  • "PostgreSQL"
  • "psutils"
  • "Qhull"
  • "QPL-1.0"
  • "Rdisc"
  • "Python-2.0"
  • "RPL-1.1"
  • "RPL-1.5"
  • "RHeCos-1.1"
  • "RSA-MD"
  • "RSCPL"
  • "Ruby"
  • "SAX-PD"
  • "Saxpath"
  • "SCEA"
  • "Sendmail-8.23"
  • "Sendmail"
  • "SGI-B-1.0"
  • "SGI-B-1.1"
  • "SGI-B-2.0"
  • "SHL-0.5"
  • "SHL-0.51"
  • "SimPL-2.0"
  • "SISSL-1.2"
  • "SISSL"
  • "Sleepycat"
  • "SMLNJ"
  • "SMPPL"
  • "SNIA"
  • "Spencer-86"
  • "Spencer-94"
  • "Spencer-99"
  • "SPL-1.0"
  • "SSH-OpenSSH"
  • "PHP-3.01"
  • "SSH-short"
  • "MIT-0"
  • "RPSL-1.0"
  • "SWL"
  • "SugarCRM-1.1.3"
  • "TCL"
  • "TCP-wrappers"
  • "SSPL-1.0"
  • "TMate"
  • "TOSL"
  • "TORQUE-1.1"
  • "TAPR-OHL-1.0"
  • "UCL-1.0"
  • "Unicode-DFS-2015"
  • "Unicode-DFS-2016"
  • "Unicode-TOU"
  • "TU-Berlin-1.0"
  • "UPL-1.0"
  • "Unlicense"
  • "VOSTROM"
  • "Vim"
  • "VSL-1.0"
  • "W3C-20150513"
  • "W3C"
  • "W3C-19980720"
  • "Wsuipa"
  • "Watcom-1.0"
  • "WTFPL"
  • "X11"
  • "Xerox"
  • "XFree86-1.1"
  • "xinetd"
  • "Xnet"
  • "xpp"
  • "XSkat"
  • "YPL-1.0"
  • "YPL-1.1"
  • "Zed"
  • "Zend-2.0"
  • "TU-Berlin-2.0"
  • "Zimbra-1.4"
  • "zlib-acknowledgement"
  • "Zlib"
  • "ZPL-1.1"
  • "ZPL-2.0"
  • "ZPL-2.1"
  • "wxWindows"
  • "Zimbra-1.3"
  • "gSOAP-1.3b"
  • "Interbase-1.0"
  • "LGPL-2.1"
  • "LGPL-3.0"
  • "NPOSL-3.0"
  • "OLDAP-2.5"
  • "StandardML-NJ"
  • "389-exception"
  • "Autoconf-exception-2.0"
  • "Autoconf-exception-3.0"
  • "Bison-exception-2.2"
  • "Bootloader-exception"
  • "Classpath-exception-2.0"
  • "CLISP-exception-2.0"
  • "DigiRule-FOSS-exception"
  • "eCos-exception-2.0"
  • "Fawkes-Runtime-exception"
  • "FLTK-exception"
  • "Font-exception-2.0"
  • "freertos-exception-2.0"
  • "GCC-exception-2.0"
  • "GCC-exception-3.1"
  • "gnu-javamail-exception"
  • "GPL-3.0-linking-exception"
  • "GPL-3.0-linking-source-exception"
  • "GPL-CC-1.0"
  • "i2p-gpl-java-exception"
  • "LGPL-3.0-linking-exception"
  • "Libtool-exception"
  • "Linux-syscall-note"
  • "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"
  • "PS-or-PDF-font-exception-20170817"
  • "Qt-GPL-exception-1.0"
  • "Qt-LGPL-exception-1.1"
  • "Qwt-exception-1.0"
  • "SHL-2.0"
  • "SHL-2.1"
  • "Swift-exception"
  • "u-boot-exception-2.0"
  • "Universal-FOSS-exception-1.0"
  • "WxWindows-exception-3.1"

Example:

"Apache-2.0"

Type: string Default: ""

If SPDX does not define the license used, this field may be used to provide the license name

Must match regular expression: ^(.*)$
Example:

"Acme Software License"

Type: object

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

No Additional Properties

Type: string Default: "text/plain"

Specifies the content type of the text. Defaults to text/plain if not specified.

Type: enum (of string) Default: ""

Specifies the optional encoding the text is represented in.

Must be one of:

  • "base64"
Must match regular expression: ^(.*)$

Type: string

The attachment data

Type: string

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

Must match regular expression: ^(.*)$
Example:

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

Type: string
Must match regular expression: ^(.*)$
Examples:

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

Type: array

Each item of this array must be:

Type: object

Specifies an individual external reference

No Additional Properties

Type: string

The URL to the external reference

Must match regular expression: ^(.*)$

Type: string

An optional comment describing the external reference

Must match regular expression: ^(.*)$

Type: enum (of string)

Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the "other" type.

Must be one of:

  • "vcs"
  • "issue-tracker"
  • "website"
  • "advisories"
  • "bom"
  • "mailing-list"
  • "social"
  • "chat"
  • "documentation"
  • "support"
  • "distribution"
  • "license"
  • "build-meta"
  • "build-system"
  • "other"

Type: array

All items must be unique

Each item of this array must be:

Type: array

External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM.

Each item of this array must be:

Type: object

Specifies an individual external reference

No Additional Properties

Type: string

The URL to the external reference

Must match regular expression: ^(.*)$

Type: string

An optional comment describing the external reference

Must match regular expression: ^(.*)$

Type: enum (of string)

Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the "other" type.

Must be one of:

  • "vcs"
  • "issue-tracker"
  • "website"
  • "advisories"
  • "bom"
  • "mailing-list"
  • "social"
  • "chat"
  • "documentation"
  • "support"
  • "distribution"
  • "license"
  • "build-meta"
  • "build-system"
  • "other"

Type: array

Provides the ability to document dependency relationships.

All items must be unique

Each item of this array must be:

Type: object

Defines the direct dependencies of a component. Components that do not have their own dependencies MUST be declared as empty elements within the graph. Components that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a component being dependency-free.

No Additional Properties

Type: string

References a component by the components bom-ref attribute

Type: array of string

The bom-ref identifiers of the components that are dependencies of this dependency object.

All items must be unique

Each item of this array must be:

Type: string