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.
The version of the CycloneDX specification a BOM is written to (starting at version 1.2)
"1.2"
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}$ "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"
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'.
1
Provides additional information about a BOM.
No Additional PropertiesThe date and time (timestamp) when the document was created.
The tool(s) used in the creation of the BOM.
No Additional ItemsThe tool used to create the BOM.
No Additional PropertiesThe date and time (timestamp) when the document was created.
The date and time (timestamp) when the document was created.
The date and time (timestamp) when the document was created.
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"
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.
^(.*)$ "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 should be unique.
Must match regular expression:^(.*)$ The organization that supplied the component. The supplier may often be the manufacture, but may also be a distributor or repackager.
No Additional PropertiesThe name of the organization
Must match regular expression:^(.*)$ "Example Inc."
The URL of the organization. Multiple URLs are allowed.
Must match regular expression:^(.*)$ No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
Must match regular expression:^(.*)$ "Contact name"
The email address of the contact. Multiple email addresses are allowed.
Must match regular expression:^(.*)$ The phone number of the contact. Multiple phone numbers are allowed.
Must match regular expression:^(.*)$ "800-555-1212"
The person(s) or organization(s) that published the component
Must match regular expression:^(.*)$ "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.
Must match regular expression:^(.*)$ "com.acme"
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:^(.*)$ "tomcat-catalina"
The component version. The version should ideally comply with semantic versioning but is not enforced.
Must match regular expression:^(.*)$ "9.0.14"
Specifies a description for the component
Must match regular expression:^(.*)$ 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
Must match regular expression:^(.*)$ "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
The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
Must match regular expression:^(.*)$ "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"
An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.
Must match regular expression:^(.*)$ "Acme Inc"
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:^(.*)$ "cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"
^(.*)$ "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
^(.*)$ 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.
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.
Must match regular expression:^(.*)$ 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
Must match regular expression:^(.*)$ The email address of the individual who performed the action
The text description of the contents of the commit
Must match regular expression:^(.*)$ 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
Specifies the URL to the diff
Must match regular expression:^(.*)$ A collection of issues the patch resolves
No Additional ItemsThe patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff
No Additional PropertiesSpecifies the type of issue
The identifier of the issue assigned by the source of the issue
Must match regular expression:^(.*)$ The name of the issue
Must match regular expression:^(.*)$ A description of the issue
Must match regular expression:^(.*)$ The source of the issue where it is documented
No Additional PropertiesThe name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'
Must match regular expression:^(.*)$ The url of the issue documentation as provided by the source
Must match regular expression:^(.*)$ A collection of URL's for reference. Multiple URLs are allowed.
Must match regular expression:^(.*)$ No Additional Items"https://example.com"
Notes, observations, and other non-structured commentary describing the components pedigree.
Must match regular expression:^(.*)$ Specifies an individual external reference
No Additional PropertiesThe URL to the external reference
Must match regular expression:^(.*)$ An optional comment describing the external reference
Must match regular expression:^(.*)$ 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.
All items must be unique
No Additional ItemsThe organization that manufactured the component that the BOM describes.
No Additional PropertiesThe name of the organization
Must match regular expression:^(.*)$ "Example Inc."
The URL of the organization. Multiple URLs are allowed.
Must match regular expression:^(.*)$ No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
Must match regular expression:^(.*)$ "Contact name"
The email address of the contact. Multiple email addresses are allowed.
Must match regular expression:^(.*)$ The phone number of the contact. Multiple phone numbers are allowed.
Must match regular expression:^(.*)$ "800-555-1212"
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 PropertiesThe name of the organization
Must match regular expression:^(.*)$ "Example Inc."
The URL of the organization. Multiple URLs are allowed.
Must match regular expression:^(.*)$ No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
Must match regular expression:^(.*)$ "Contact name"
The email address of the contact. Multiple email addresses are allowed.
Must match regular expression:^(.*)$ The phone number of the contact. Multiple phone numbers are allowed.
Must match regular expression:^(.*)$ "800-555-1212"
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.
^(.*)$ "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 should be unique.
Must match regular expression:^(.*)$ The organization that supplied the component. The supplier may often be the manufacture, but may also be a distributor or repackager.
No Additional PropertiesThe name of the organization
Must match regular expression:^(.*)$ "Example Inc."
The URL of the organization. Multiple URLs are allowed.
Must match regular expression:^(.*)$ No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
Must match regular expression:^(.*)$ "Contact name"
The email address of the contact. Multiple email addresses are allowed.
Must match regular expression:^(.*)$ The phone number of the contact. Multiple phone numbers are allowed.
Must match regular expression:^(.*)$ "800-555-1212"
The person(s) or organization(s) that published the component
Must match regular expression:^(.*)$ "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.
Must match regular expression:^(.*)$ "com.acme"
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:^(.*)$ "tomcat-catalina"
The component version. The version should ideally comply with semantic versioning but is not enforced.
Must match regular expression:^(.*)$ "9.0.14"
Specifies a description for the component
Must match regular expression:^(.*)$ 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
Must match regular expression:^(.*)$ "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
The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
Must match regular expression:^(.*)$ "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"
An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.
Must match regular expression:^(.*)$ "Acme Inc"
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:^(.*)$ "cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"
^(.*)$ "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
^(.*)$ 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.
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.
Must match regular expression:^(.*)$ 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
Must match regular expression:^(.*)$ The email address of the individual who performed the action
The text description of the contents of the commit
Must match regular expression:^(.*)$ 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
Specifies the URL to the diff
Must match regular expression:^(.*)$ A collection of issues the patch resolves
No Additional ItemsThe patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff
No Additional PropertiesSpecifies the type of issue
The identifier of the issue assigned by the source of the issue
Must match regular expression:^(.*)$ The name of the issue
Must match regular expression:^(.*)$ A description of the issue
Must match regular expression:^(.*)$ The source of the issue where it is documented
No Additional PropertiesThe name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'
Must match regular expression:^(.*)$ The url of the issue documentation as provided by the source
Must match regular expression:^(.*)$ A collection of URL's for reference. Multiple URLs are allowed.
Must match regular expression:^(.*)$ No Additional Items"https://example.com"
Notes, observations, and other non-structured commentary describing the components pedigree.
Must match regular expression:^(.*)$ Specifies an individual external reference
No Additional PropertiesThe URL to the external reference
Must match regular expression:^(.*)$ An optional comment describing the external reference
Must match regular expression:^(.*)$ 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.
All items must be unique
No Additional ItemsAll items must be unique
No Additional ItemsAn optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref should be unique.
Must match regular expression:^(.*)$ The organization that provides the service.
No Additional PropertiesThe name of the organization
Must match regular expression:^(.*)$ "Example Inc."
The URL of the organization. Multiple URLs are allowed.
Must match regular expression:^(.*)$ No Additional Items"https://example.com"
A contact at the organization. Multiple contacts are allowed.
No Additional ItemsThe name of a contact
Must match regular expression:^(.*)$ "Contact name"
The email address of the contact. Multiple email addresses are allowed.
Must match regular expression:^(.*)$ The phone number of the contact. Multiple phone numbers are allowed.
Must match regular expression:^(.*)$ "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.
Must match regular expression:^(.*)$ "com.acme"
The name of the service. This will often be a shortened, single name of the service.
Must match regular expression:^(.*)$ "ticker-service"
The service version.
Must match regular expression:^(.*)$ "1.0.0"
Specifies a description for the service
Must match regular expression:^(.*)$ The endpoint URIs of the service. Multiple endpoints are allowed.
Must match regular expression:^(.*)$ 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 Items^(.*)$ 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
Must match regular expression:^(.*)$ "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
The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
Must match regular expression:^(.*)$ "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 an individual external reference
No Additional PropertiesThe URL to the external reference
Must match regular expression:^(.*)$ An optional comment describing the external reference
Must match regular expression:^(.*)$ 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.
All items must be unique
No Additional ItemsExternal 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
Must match regular expression:^(.*)$ An optional comment describing the external reference
Must match regular expression:^(.*)$ 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.
Provides the ability to document dependency relationships.
All items must be unique
No Additional ItemsDefines 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 PropertiesReferences a component by the components bom-ref attribute
The bom-ref identifiers of the components that are dependencies of this dependency object.
All items must be unique
No Additional Items