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".
The version of the CycloneDX specification a BOM conforms to (starting at version 1.2).
"1.4"
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 are 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}$ "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"
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'.
1
Provides additional information about a BOM.
No Additional PropertiesThe date and time (timestamp) when the BOM was created.
The tool(s) used in the creation of the BOM.
No Additional ItemsInformation about the automated or manual tool used
No Additional PropertiesThe name of the vendor who created the tool
The name of the tool
The version of the tool
The hashes of the tool (if applicable).
No Additional Items^([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})$ "3942447fac867ae5cdb3229b658f4d48"
External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM.
No Additional ItemsSpecifies an individual external reference
No Additional PropertiesThe URL to the external reference
An optional comment describing the external reference
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.
The hashes of the external reference (if applicable).
No Additional Items^([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})$ "3942447fac867ae5cdb3229b658f4d48"
The component that the BOM describes.
No Additional PropertiesSpecifies 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. Types include:
"library"
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.]+$ "image/jpeg"
An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.
The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.
No Additional PropertiesThe name of the organization
"Example Inc."
The URL of the organization. Multiple URLs are allowed.
No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The person(s) or organization(s) that published the component
"Acme Inc"
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.
"com.acme"
The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery
"tomcat-catalina"
The component version. The version should ideally comply with semantic versioning but is not enforced.
"9.0.14"
Specifies a description for the component
Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.
^([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})$ "3942447fac867ae5cdb3229b658f4d48"
A valid SPDX license ID
"Apache-2.0"
If SPDX does not define the license used, this field may be used to provide the license name
"Acme Software License"
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
"https://www.apache.org/licenses/LICENSE-2.0.txt"
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
A copyright notice informing users of the underlying claims to copyright ownership in a published work.
"Acme Inc"
Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe
"cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"
Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the specification defined at: https://github.com/package-url/purl-spec
"pkg:maven/com.acme/[email protected]?packaging=jar"
Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.
No Additional PropertiesMaps to the tagId of a SoftwareIdentity.
Maps to the name of a SoftwareIdentity.
Maps to the version of a SoftwareIdentity.
Maps to the tagVersion of a SoftwareIdentity.
Maps to the patch of a SoftwareIdentity.
Specifies the metadata and content of the SWID tag.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to the SWID file.
[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 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.
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 PropertiesDescribes 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 ItemsDescendants 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 ItemsVariants 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.
No Additional ItemsA list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.
No Additional ItemsSpecifies an individual commit
No Additional PropertiesA unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
The URL to the commit. This URL will typically point to a commit in a version control system.
The person who committed or pushed the commit
No Additional PropertiesThe timestamp in which the action occurred
The name of the individual who performed the action
The email address of the individual who performed the action
The text description of the contents of the commit
No Additional ItemsA 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.
Specifies an individual patch
No Additional PropertiesSpecifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality.
The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff
No Additional PropertiesSpecifies the optional text of the diff
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Specifies the URL to the diff
A collection of issues the patch resolves
No Additional ItemsAn individual issue that has been resolved.
No Additional PropertiesSpecifies the type of issue
The identifier of the issue assigned by the source of the issue
The name of the issue
A description of the issue
The source of the issue where it is documented
No Additional PropertiesThe name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'
The url of the issue documentation as provided by the source
A collection of URL's for reference. Multiple URLs are allowed.
No Additional Items"https://example.com"
Notes, observations, and other non-structured commentary describing the components pedigree.
External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM.
No Additional ItemsSpecifies an individual external reference
No Additional PropertiesThe URL to the external reference
An optional comment describing the external reference
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.
The hashes of the external reference (if applicable).
No Additional Items^([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})$ "3942447fac867ae5cdb3229b658f4d48"
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 ItemsProvides the ability to document evidence collected through various forms of extraction or analysis.
No Additional PropertiesA valid SPDX license ID
"Apache-2.0"
If SPDX does not define the license used, this field may be used to provide the license name
"Acme Software License"
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
"https://www.apache.org/licenses/LICENSE-2.0.txt"
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Specifies optional release notes.
No Additional PropertiesThe software versioning type the release note describes.
"major"
"minor"
"patch"
"pre-release"
"internal"
The title of the release.
The URL to an image that may be prominently displayed with the release note.
A short description of the release.
The date and time (timestamp) when the release note was created.
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 ItemsA collection of issues that have been resolved.
No Additional ItemsAn individual issue that has been resolved.
No Additional PropertiesSpecifies the type of issue
The identifier of the issue assigned by the source of the issue
The name of the issue
A description of the issue
The source of the issue where it is documented
No Additional PropertiesThe name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'
The url of the issue documentation as provided by the source
A collection of URL's for reference. Multiple URLs are allowed.
No Additional Items"https://example.com"
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 ItemsA note containing the locale and content.
No Additional PropertiesThe 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})?$ Specifies the full content of the release note.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
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 ItemsThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
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 ItemsThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Enveloped signature in JSON Signature Format (JSF).
Unique top level property for Multiple Signatures. (multisignature)
No Additional ItemsSignature algorithm. The currently recognized JWA [RFC7518] and RFC8037 [RFC8037] asymmetric key algorithms. Note: Unlike RFC8037 [RFC8037] JSF requires explicit Ed* algorithm names instead of "EdDSA".
Signature algorithm. Note: If proprietary signature algorithms are added, they must be expressed as URIs.
Optional. Application specific string identifying the signature key.
Optional. Public key object.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EC" Key type indicator.
EC curve name.
EC curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-521", the decoded argument must be 66 bytes.
EC curve point Y. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-256", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"OKP" Key type indicator.
EdDSA curve name.
EdDSA curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "Ed25519", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"RSA" Key type indicator.
RSA modulus.
RSA exponent.
Key type indicator.
Additional Properties of any type are allowed.
Type: objectOptional. Sorted array of X.509 [RFC5280] certificates, where the first element must contain the signature certificate. The certificate path must be contiguous but is not required to be complete.
No Additional ItemsOptional. Array holding the names of one or more application level properties that must be excluded from the signature process. Note that the "excludes" property itself, must also be excluded from the signature process. Since both the "excludes" property and the associated data it points to are unsigned, a conforming JSF implementation must provide options for specifying which properties to accept.
No Additional ItemsThe signature data. Note that the binary representation must follow the JWA [RFC7518] specifications.
Unique top level property for Signature Chains. (signaturechain)
No Additional ItemsSignature algorithm. The currently recognized JWA [RFC7518] and RFC8037 [RFC8037] asymmetric key algorithms. Note: Unlike RFC8037 [RFC8037] JSF requires explicit Ed* algorithm names instead of "EdDSA".
Signature algorithm. Note: If proprietary signature algorithms are added, they must be expressed as URIs.
Optional. Application specific string identifying the signature key.
Optional. Public key object.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EC" Key type indicator.
EC curve name.
EC curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-521", the decoded argument must be 66 bytes.
EC curve point Y. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-256", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"OKP" Key type indicator.
EdDSA curve name.
EdDSA curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "Ed25519", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"RSA" Key type indicator.
RSA modulus.
RSA exponent.
Key type indicator.
Additional Properties of any type are allowed.
Type: objectOptional. Sorted array of X.509 [RFC5280] certificates, where the first element must contain the signature certificate. The certificate path must be contiguous but is not required to be complete.
No Additional ItemsOptional. Array holding the names of one or more application level properties that must be excluded from the signature process. Note that the "excludes" property itself, must also be excluded from the signature process. Since both the "excludes" property and the associated data it points to are unsigned, a conforming JSF implementation must provide options for specifying which properties to accept.
No Additional ItemsThe signature data. Note that the binary representation must follow the JWA [RFC7518] specifications.
Unique top level property for simple signatures. (signaturecore)
No Additional PropertiesSignature algorithm. The currently recognized JWA [RFC7518] and RFC8037 [RFC8037] asymmetric key algorithms. Note: Unlike RFC8037 [RFC8037] JSF requires explicit Ed* algorithm names instead of "EdDSA".
Signature algorithm. Note: If proprietary signature algorithms are added, they must be expressed as URIs.
Optional. Application specific string identifying the signature key.
Optional. Public key object.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EC" Key type indicator.
EC curve name.
EC curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-521", the decoded argument must be 66 bytes.
EC curve point Y. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-256", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"OKP" Key type indicator.
EdDSA curve name.
EdDSA curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "Ed25519", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"RSA" Key type indicator.
RSA modulus.
RSA exponent.
Key type indicator.
Additional Properties of any type are allowed.
Type: objectOptional. Sorted array of X.509 [RFC5280] certificates, where the first element must contain the signature certificate. The certificate path must be contiguous but is not required to be complete.
No Additional ItemsOptional. Array holding the names of one or more application level properties that must be excluded from the signature process. Note that the "excludes" property itself, must also be excluded from the signature process. Since both the "excludes" property and the associated data it points to are unsigned, a conforming JSF implementation must provide options for specifying which properties to accept.
No Additional ItemsThe signature data. Note that the binary representation must follow the JWA [RFC7518] specifications.
The organization that manufactured the component that the BOM describes.
No Additional PropertiesThe name of the organization
"Example Inc."
The URL of the organization. Multiple URLs are allowed.
No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.
No Additional PropertiesThe name of the organization
"Example Inc."
The URL of the organization. Multiple URLs are allowed.
No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
A valid SPDX license ID
"Apache-2.0"
If SPDX does not define the license used, this field may be used to provide the license name
"Acme Software License"
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
"https://www.apache.org/licenses/LICENSE-2.0.txt"
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
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 ItemsThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A list of software and hardware components.
All items must be unique
No Additional ItemsSpecifies 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. Types include:
"library"
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.]+$ "image/jpeg"
An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.
The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.
No Additional PropertiesThe name of the organization
"Example Inc."
The URL of the organization. Multiple URLs are allowed.
No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The person(s) or organization(s) that published the component
"Acme Inc"
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.
"com.acme"
The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery
"tomcat-catalina"
The component version. The version should ideally comply with semantic versioning but is not enforced.
"9.0.14"
Specifies a description for the component
Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.
^([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})$ "3942447fac867ae5cdb3229b658f4d48"
A valid SPDX license ID
"Apache-2.0"
If SPDX does not define the license used, this field may be used to provide the license name
"Acme Software License"
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
"https://www.apache.org/licenses/LICENSE-2.0.txt"
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
A copyright notice informing users of the underlying claims to copyright ownership in a published work.
"Acme Inc"
Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe
"cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"
Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the specification defined at: https://github.com/package-url/purl-spec
"pkg:maven/com.acme/[email protected]?packaging=jar"
Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.
No Additional PropertiesMaps to the tagId of a SoftwareIdentity.
Maps to the name of a SoftwareIdentity.
Maps to the version of a SoftwareIdentity.
Maps to the tagVersion of a SoftwareIdentity.
Maps to the patch of a SoftwareIdentity.
Specifies the metadata and content of the SWID tag.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to the SWID file.
[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 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.
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 PropertiesDescribes 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 ItemsDescendants 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 ItemsVariants 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.
No Additional ItemsA list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.
No Additional ItemsSpecifies an individual commit
No Additional PropertiesA unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
The URL to the commit. This URL will typically point to a commit in a version control system.
The person who committed or pushed the commit
No Additional PropertiesThe timestamp in which the action occurred
The name of the individual who performed the action
The email address of the individual who performed the action
The text description of the contents of the commit
No Additional ItemsA 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.
Specifies an individual patch
No Additional PropertiesSpecifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality.
The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff
No Additional PropertiesSpecifies the optional text of the diff
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Specifies the URL to the diff
A collection of issues the patch resolves
No Additional ItemsAn individual issue that has been resolved.
No Additional PropertiesSpecifies the type of issue
The identifier of the issue assigned by the source of the issue
The name of the issue
A description of the issue
The source of the issue where it is documented
No Additional PropertiesThe name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'
The url of the issue documentation as provided by the source
A collection of URL's for reference. Multiple URLs are allowed.
No Additional Items"https://example.com"
Notes, observations, and other non-structured commentary describing the components pedigree.
External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM.
No Additional ItemsSpecifies an individual external reference
No Additional PropertiesThe URL to the external reference
An optional comment describing the external reference
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.
The hashes of the external reference (if applicable).
No Additional Items^([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})$ "3942447fac867ae5cdb3229b658f4d48"
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 ItemsProvides the ability to document evidence collected through various forms of extraction or analysis.
No Additional PropertiesA valid SPDX license ID
"Apache-2.0"
If SPDX does not define the license used, this field may be used to provide the license name
"Acme Software License"
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
"https://www.apache.org/licenses/LICENSE-2.0.txt"
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Specifies optional release notes.
No Additional PropertiesThe software versioning type the release note describes.
"major"
"minor"
"patch"
"pre-release"
"internal"
The title of the release.
The URL to an image that may be prominently displayed with the release note.
A short description of the release.
The date and time (timestamp) when the release note was created.
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 ItemsA collection of issues that have been resolved.
No Additional ItemsAn individual issue that has been resolved.
No Additional PropertiesSpecifies the type of issue
The identifier of the issue assigned by the source of the issue
The name of the issue
A description of the issue
The source of the issue where it is documented
No Additional PropertiesThe name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'
The url of the issue documentation as provided by the source
A collection of URL's for reference. Multiple URLs are allowed.
No Additional Items"https://example.com"
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 ItemsA note containing the locale and content.
No Additional PropertiesThe 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})?$ Specifies the full content of the release note.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
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 ItemsThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
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 ItemsThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Enveloped signature in JSON Signature Format (JSF).
Unique top level property for Multiple Signatures. (multisignature)
No Additional ItemsSignature algorithm. The currently recognized JWA [RFC7518] and RFC8037 [RFC8037] asymmetric key algorithms. Note: Unlike RFC8037 [RFC8037] JSF requires explicit Ed* algorithm names instead of "EdDSA".
Signature algorithm. Note: If proprietary signature algorithms are added, they must be expressed as URIs.
Optional. Application specific string identifying the signature key.
Optional. Public key object.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EC" Key type indicator.
EC curve name.
EC curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-521", the decoded argument must be 66 bytes.
EC curve point Y. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-256", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"OKP" Key type indicator.
EdDSA curve name.
EdDSA curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "Ed25519", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"RSA" Key type indicator.
RSA modulus.
RSA exponent.
Key type indicator.
Additional Properties of any type are allowed.
Type: objectOptional. Sorted array of X.509 [RFC5280] certificates, where the first element must contain the signature certificate. The certificate path must be contiguous but is not required to be complete.
No Additional ItemsOptional. Array holding the names of one or more application level properties that must be excluded from the signature process. Note that the "excludes" property itself, must also be excluded from the signature process. Since both the "excludes" property and the associated data it points to are unsigned, a conforming JSF implementation must provide options for specifying which properties to accept.
No Additional ItemsThe signature data. Note that the binary representation must follow the JWA [RFC7518] specifications.
Unique top level property for Signature Chains. (signaturechain)
No Additional ItemsSignature algorithm. The currently recognized JWA [RFC7518] and RFC8037 [RFC8037] asymmetric key algorithms. Note: Unlike RFC8037 [RFC8037] JSF requires explicit Ed* algorithm names instead of "EdDSA".
Signature algorithm. Note: If proprietary signature algorithms are added, they must be expressed as URIs.
Optional. Application specific string identifying the signature key.
Optional. Public key object.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EC" Key type indicator.
EC curve name.
EC curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-521", the decoded argument must be 66 bytes.
EC curve point Y. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-256", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"OKP" Key type indicator.
EdDSA curve name.
EdDSA curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "Ed25519", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"RSA" Key type indicator.
RSA modulus.
RSA exponent.
Key type indicator.
Additional Properties of any type are allowed.
Type: objectOptional. Sorted array of X.509 [RFC5280] certificates, where the first element must contain the signature certificate. The certificate path must be contiguous but is not required to be complete.
No Additional ItemsOptional. Array holding the names of one or more application level properties that must be excluded from the signature process. Note that the "excludes" property itself, must also be excluded from the signature process. Since both the "excludes" property and the associated data it points to are unsigned, a conforming JSF implementation must provide options for specifying which properties to accept.
No Additional ItemsThe signature data. Note that the binary representation must follow the JWA [RFC7518] specifications.
Unique top level property for simple signatures. (signaturecore)
No Additional PropertiesSignature algorithm. The currently recognized JWA [RFC7518] and RFC8037 [RFC8037] asymmetric key algorithms. Note: Unlike RFC8037 [RFC8037] JSF requires explicit Ed* algorithm names instead of "EdDSA".
Signature algorithm. Note: If proprietary signature algorithms are added, they must be expressed as URIs.
Optional. Application specific string identifying the signature key.
Optional. Public key object.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EC" Key type indicator.
EC curve name.
EC curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-521", the decoded argument must be 66 bytes.
EC curve point Y. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-256", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"OKP" Key type indicator.
EdDSA curve name.
EdDSA curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "Ed25519", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"RSA" Key type indicator.
RSA modulus.
RSA exponent.
Key type indicator.
Additional Properties of any type are allowed.
Type: objectOptional. Sorted array of X.509 [RFC5280] certificates, where the first element must contain the signature certificate. The certificate path must be contiguous but is not required to be complete.
No Additional ItemsOptional. Array holding the names of one or more application level properties that must be excluded from the signature process. Note that the "excludes" property itself, must also be excluded from the signature process. Since both the "excludes" property and the associated data it points to are unsigned, a conforming JSF implementation must provide options for specifying which properties to accept.
No Additional ItemsThe signature data. Note that the binary representation must follow the JWA [RFC7518] specifications.
A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services.
All items must be unique
No Additional ItemsAn optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.
The organization that provides the service.
No Additional PropertiesThe name of the organization
"Example Inc."
The URL of the organization. Multiple URLs are allowed.
No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
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.
"com.acme"
The name of the service. This will often be a shortened, single name of the service.
"ticker-service"
The service version.
"1.0.0"
Specifies a description for the service
The endpoint URIs of the service. Multiple endpoints are allowed.
No Additional Items"https://example.com/api/v1/ticker"
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.
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.
Specifies the data classification.
No Additional ItemsSpecifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways, and unknown states that the direction is not known.
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
A valid SPDX license ID
"Apache-2.0"
If SPDX does not define the license used, this field may be used to provide the license name
"Acme Software License"
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
"https://www.apache.org/licenses/LICENSE-2.0.txt"
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM.
No Additional ItemsSpecifies an individual external reference
No Additional PropertiesThe URL to the external reference
An optional comment describing the external reference
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.
The hashes of the external reference (if applicable).
No Additional Items^([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})$ "3942447fac867ae5cdb3229b658f4d48"
A list of services included or deployed behind the parent service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies.
All items must be unique
No Additional ItemsSpecifies optional release notes.
No Additional PropertiesThe software versioning type the release note describes.
"major"
"minor"
"patch"
"pre-release"
"internal"
The title of the release.
The URL to an image that may be prominently displayed with the release note.
A short description of the release.
The date and time (timestamp) when the release note was created.
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 ItemsA collection of issues that have been resolved.
No Additional ItemsAn individual issue that has been resolved.
No Additional PropertiesSpecifies the type of issue
The identifier of the issue assigned by the source of the issue
The name of the issue
A description of the issue
The source of the issue where it is documented
No Additional PropertiesThe name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'
The url of the issue documentation as provided by the source
A collection of URL's for reference. Multiple URLs are allowed.
No Additional Items"https://example.com"
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 ItemsA note containing the locale and content.
No Additional PropertiesThe 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})?$ Specifies the full content of the release note.
No Additional PropertiesSpecifies the content type of the text. Defaults to text/plain if not specified.
Specifies the optional encoding the text is represented in.
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
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 ItemsThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
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 ItemsThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Enveloped signature in JSON Signature Format (JSF).
Unique top level property for Multiple Signatures. (multisignature)
No Additional ItemsSignature algorithm. The currently recognized JWA [RFC7518] and RFC8037 [RFC8037] asymmetric key algorithms. Note: Unlike RFC8037 [RFC8037] JSF requires explicit Ed* algorithm names instead of "EdDSA".
Signature algorithm. Note: If proprietary signature algorithms are added, they must be expressed as URIs.
Optional. Application specific string identifying the signature key.
Optional. Public key object.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EC" Key type indicator.
EC curve name.
EC curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-521", the decoded argument must be 66 bytes.
EC curve point Y. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "P-256", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"OKP" Key type indicator.
EdDSA curve name.
EdDSA curve point X. The length of this field must be the full size of a coordinate for the curve specified in the "crv" parameter. For example, if the value of "crv" is "Ed25519", the decoded argument must be 32 bytes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"RSA" Key type indicator.
RSA modulus.
RSA exponent.
Key type indicator.
Additional Properties of any type are allowed.
Type: objectOptional. Sorted array of X.509 [RFC5280] certificates, where the first element must contain the signature certificate. The certificate path must be contiguous but is not required to be complete.
No Additional ItemsOptional. Array holding the names of one or more application level properties that must be excluded from the signature process. Note that the "excludes" property itself, must also be excluded from the signature process. Since both the "excludes" property and the associated data it points to are unsigned, a conforming JSF implementation must provide options for specifying which properties to accept.
No Additional ItemsThe signature data. Note that the binary representation must follow the JWA [RFC7518] specifications.
Unique top level property for Signature Chains. (signaturechain)
No Additional ItemsSignature algorithm. The currently recognized JWA [RFC7518] and RFC8037 [RFC8037] asymmetric key algorithms. Note: Unlike RFC8037 [RFC8037] JSF requires explicit Ed* algorithm names instead of "EdDSA".