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 the BOM conforms to.
"1.6"
Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number must conform to RFC 4122. Use of serial numbers is recommended.
Must match regular expression:^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"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'.
Value must be greater or equal to 1
1
Provides additional information about a BOM.
No Additional PropertiesThe date and time (timestamp) when the BOM was created.
Lifecycles communicate the stage(s) in which data in the BOM was captured. Different types of data may be available at various phases of a lifecycle, such as the Software Development Lifecycle (SDLC), IT Asset Management (ITAM), and Software Asset Management (SAM). Thus, a BOM may include data specific to or only obtainable in a given lifecycle.
No Additional ItemsThe product lifecycle(s) that this BOM represents.
A pre-defined phase in the product lifecycle.
| Name | Description |
|---|---|
| "design" | BOM produced early in the development lifecycle containing an inventory of components and services that are proposed or planned to be used. The inventory may need to be procured, retrieved, or resourced prior to use. |
| "pre-build" | BOM consisting of information obtained prior to a build process and may contain source files and development artifacts and manifests. The inventory may need to be resolved and retrieved prior to use. |
| "build" | BOM consisting of information obtained during a build process where component inventory is available for use. The precise versions of resolved components are usually available at this time as well as the provenance of where the components were retrieved from. |
| "post-build" | BOM consisting of information obtained after a build process has completed and the resulting components(s) are available for further analysis. Built components may exist as the result of a CI/CD process, may have been installed or deployed to a system or device, and may need to be retrieved or extracted from the system or device. |
| "operations" | BOM produced that represents inventory that is running and operational. This may include staging or production environments and will generally encompass multiple SBOMs describing the applications and operating system, along with HBOMs describing the hardware that makes up the system. Operations Bill of Materials (OBOM) can provide full-stack inventory of runtime environments, configurations, and additional dependencies. |
| "discovery" | BOM consisting of information observed through network discovery providing point-in-time enumeration of embedded, on-premise, and cloud-native services such as server applications, connected devices, microservices, and serverless functions. |
| "decommission" | BOM containing inventory that will be, or has been retired from operations. |
The name of the lifecycle phase
The description of the lifecycle phase
The tool(s) used in the creation, enrichment, and validation of the BOM.
The tool(s) used in the creation, enrichment, and validation of the BOM.
No Additional PropertiesA list of software and hardware components used as tools.
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.
| Name | Description |
|---|---|
| "application" | A software application. Refer to https://en.wikipedia.org/wiki/Application_software for information about applications. |
| "framework" | A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework for information on how frameworks vary slightly from libraries. |
| "library" | A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing) for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is recommended. |
| "container" | A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to https://en.wikipedia.org/wiki/OS-level_virtualization. |
| "platform" | A runtime environment which interprets or executes software. This may include runtimes such as those that execute bytecode or low-code/no-code application platforms. |
| "operating-system" | A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to https://en.wikipedia.org/wiki/Operating_system. |
| "device" | A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device. See also the list of known device properties. |
| "device-driver" | A special type of software that operates or controls a particular type of device. Refer to https://en.wikipedia.org/wiki/Device_driver. |
| "firmware" | A special type of software that provides low-level control over a device's hardware. Refer to https://en.wikipedia.org/wiki/Firmware. |
| "file" | A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file for information about files. |
| "machine-learning-model" | A model based on training data that can make predictions or decisions without being explicitly programmed to do so. |
| "data" | A collection of discrete values that convey information. |
| "cryptographic-asset" | A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets. |
"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.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The organization that created the component.
Manufacturer is common in components created through automated processes. Components created through manual means may have @.authors instead.
An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The person(s) who created the component.
Authors are common in components created through manual processes. Components created through automated means may have @.manufacturer instead.
An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
[Deprecated] This will be removed in a future version. Use @.authors or @.manufacturer instead.
The person(s) or organization(s) that authored the component
"Acme Inc"
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.
Must be at most 1024 characters long
"9.0.14"
"v1.33.7"
"7.0.0-M1"
"2.0pre1"
"1.0.0-beta1"
"0.8.15"
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.
| Name | Description |
|---|---|
| "required" | The component is required for runtime |
| "optional" | The component is optional at runtime. Optional components are components that are not capable of being called due to them not being installed or otherwise accessible by any means. Components that are installed but due to configuration or other restrictions are prohibited from being called must be scoped as 'required'. |
| "excluded" | Components that are excluded provide the ability to document component usage for test and other non-runtime purposes. Excluded components are not reachable within a call graph at runtime. |
The hashes of the component.
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"3942447fac867ae5cdb3229b658f4d48"
EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
A list of SPDX licenses and/or named licenses.
No Additional ItemsSpecifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.
No Additional PropertiesAn optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
"Apache-2.0"
The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
"Acme Software License"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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"
Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata
No Additional PropertiesLicense identifiers that may be used to manage licenses and their lifecycle
No Additional ItemsThe individual or organization that grants a license to another individual or organization
No Additional PropertiesThe organization that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization for which a license was granted to
No Additional PropertiesThe organization that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization that purchased the license
No Additional PropertiesThe organization that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
The type of license(s) that was granted to the licensee.
No Additional Items| Name | Description |
|---|---|
| "academic" | A license that grants use of software solely for the purpose of education or research. |
| "appliance" | A license covering use of software embedded in a specific piece of hardware. |
| "client-access" | A Client Access License (CAL) allows client computers to access services provided by server software. |
| "concurrent-user" | A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| "core-points" | A license where the core of a computer's processor is assigned a specific number of points. |
| "custom-metric" | A license for which consumption is measured by non-standard metrics. |
| "device" | A license that covers a defined number of installations on computers and other types of devices. |
| "evaluation" | A license that grants permission to install and use software for trial purposes. |
| "named-user" | A license that grants access to the software to one or more pre-defined users. |
| "node-locked" | A license that grants access to the software on one or more pre-defined computers or devices. |
| "oem" | An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| "perpetual" | A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| "processor-points" | A license where each installation consumes points per processor. |
| "subscription" | A license where the licensee pays a fee to use the software or service. |
| "user" | A license that grants access to the software or service by a specified number of users. |
| "other" | Another license type. |
The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.
The timestamp indicating when the current license expires (if applicable).
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A tuple of exactly one SPDX License Expression.
Must contain a minimum of 1 items
Must contain a maximum of 1 items
A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A copyright notice informing users of the underlying claims to copyright ownership in a published work.
"Acme Inc"
Asserts the identity of the component using CPE. The CPE must conform to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"
Asserts the identity of the component using package-url (purl). The purl, if specified, must be valid and conform to the specification defined at: https://github.com/package-url/purl-spec. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"pkg:maven/com.acme/[email protected]?packaging=jar"
Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform to the specification defined at: https://www.iana.org/assignments/uri-schemes/prov/gitoid. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"gitoid:blob:sha1:a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"
"gitoid:blob:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must be valid and conform to the specification defined at: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"
Asserts the identity of the component using ISO-IEC 19770-2 Software Identification (SWID) Tags. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
Maps 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 format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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] 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 is not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.
No Additional 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 author who created the changes in 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 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 complementary 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.
| Name | Description |
|---|---|
| "unofficial" | A patch which is not developed by the creators or maintainers of the software being patched. Refer to https://en.wikipedia.org/wiki/Unofficial_patch. |
| "monkey" | A patch which dynamically modifies runtime behavior. Refer to https://en.wikipedia.org/wiki/Monkey_patch. |
| "backport" | A patch which takes code from a newer version of the software and applies it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting. |
| "cherry-pick" | A patch created by selectively applying commits from other versions or branches of the same software. |
The patch file (or diff) that shows changes. Refer to https://en.wikipedia.org/wiki/Diff
No Additional PropertiesSpecifies the optional text of the diff
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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
| Name | Description |
|---|---|
| "defect" | A fault, flaw, or bug in software. |
| "enhancement" | A new feature or behavior in software. |
| "security" | A special type of defect which impacts security. |
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.
"National Vulnerability Database"
"NVD"
"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 are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional ItemsExternal references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional PropertiesThe URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$An optional comment describing the external reference
Specifies the type of external reference.
| Name | Description |
|---|---|
| "vcs" | Version Control System |
| "issue-tracker" | Issue or defect tracking system, or an Application Lifecycle Management (ALM) system |
| "website" | Website |
| "advisories" | Security advisories |
| "bom" | Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc) |
| "mailing-list" | Mailing list or discussion group |
| "social" | Social media account |
| "chat" | Real-time chat platform |
| "documentation" | Documentation, guides, or how-to instructions |
| "support" | Community or commercial support |
| "source-distribution" | The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type. |
| "distribution" | Direct or repository download location |
| "distribution-intake" | The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary. |
| "license" | The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness. |
| "build-meta" | Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc) |
| "build-system" | Reference to an automated build system |
| "release-notes" | Reference to release notes |
| "security-contact" | Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT. |
| "model-card" | A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency. |
| "log" | A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations. |
| "configuration" | Parameters or settings that may be used by other components or services. |
| "evidence" | Information used to substantiate a claim. |
| "formulation" | Describes how a component or service was manufactured or deployed. |
| "attestation" | Human or machine-readable statements containing facts, evidence, or testimony. |
| "threat-model" | An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format. |
| "adversary-model" | The defined assumptions, goals, and capabilities of an adversary. |
| "risk-assessment" | Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk. |
| "vulnerability-assertion" | A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product. |
| "exploitability-statement" | A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization. |
| "pentest-report" | Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test. |
| "static-analysis-report" | SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code. |
| "dynamic-analysis-report" | Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations. |
| "runtime-analysis-report" | Report generated by analyzing the call stack of a running application. |
| "component-analysis-report" | Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis. |
| "maturity-report" | Report containing a formal assessment of an organization, business unit, or team against a maturity model. |
| "certification-report" | Industry, regulatory, or other certification from an accredited (if applicable) certification body. |
| "codified-infrastructure" | Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC). |
| "quality-metrics" | Report or system in which quality metrics can be obtained. |
| "poam" | Plans of Action and Milestones (POA&M) complement an "attestation" external reference. POA&M is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones". |
| "electronic-signature" | An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name. |
| "digital-signature" | A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification. |
| "rfc-9116" | Document that complies with RFC 9116 (A File Format to Aid in Security Vulnerability Disclosure) |
| "other" | Use this if no other types accurately describe the purpose of the external reference. |
The hashes of the external reference (if applicable).
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"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 PropertiesEvidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified.
Evidence that substantiates the identity of a component.
No Additional PropertiesThe identity field of the component which the evidence describes.
The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).
The methods used to extract and/or analyze the evidence.
No Additional ItemsThe technique used in this method of analysis.
The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value or contents of the evidence.
The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.
All items must be unique
No Additional ItemsDescriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.
Must be at least 1 characters long
Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$[Deprecated]
No Additional PropertiesThe identity field of the component which the evidence describes.
The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).
The methods used to extract and/or analyze the evidence.
No Additional ItemsThe technique used in this method of analysis.
The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value or contents of the evidence.
The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.
All items must be unique
No Additional ItemsDescriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.
Must be at least 1 characters long
Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$Evidence of individual instances of a component spread across multiple locations.
No Additional ItemsAn optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The location or path to where the component was found.
The line number where the component was found.
Value must be greater or equal to 0
The offset where the component was found.
Value must be greater or equal to 0
The symbol name that was found associated with the component.
Any additional context of the detected component (e.g. a code snippet).
Evidence of the components use through the callstack.
No Additional PropertiesWithin a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of program execution and manages the sequence of function invocations.
No Additional ItemsA package organizes modules into namespaces, providing a unique namespace for each type it contains.
A module or class that encloses functions/methods and other code.
A block of code designed to perform a particular task.
Optional arguments that are passed to the module or function.
No Additional ItemsThe line number the code that is called resides on.
The column the code that is called resides.
The full path and filename of the module.
EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
A list of SPDX licenses and/or named licenses.
No Additional ItemsSpecifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.
No Additional PropertiesAn optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
"Apache-2.0"
The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
"Acme Software License"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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"
Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata
No Additional PropertiesLicense identifiers that may be used to manage licenses and their lifecycle
No Additional ItemsThe individual or organization that grants a license to another individual or organization
No Additional PropertiesThe organization that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization for which a license was granted to
No Additional PropertiesThe organization that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization that purchased the license
No Additional PropertiesThe organization that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
The type of license(s) that was granted to the licensee.
No Additional Items| Name | Description |
|---|---|
| "academic" | A license that grants use of software solely for the purpose of education or research. |
| "appliance" | A license covering use of software embedded in a specific piece of hardware. |
| "client-access" | A Client Access License (CAL) allows client computers to access services provided by server software. |
| "concurrent-user" | A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| "core-points" | A license where the core of a computer's processor is assigned a specific number of points. |
| "custom-metric" | A license for which consumption is measured by non-standard metrics. |
| "device" | A license that covers a defined number of installations on computers and other types of devices. |
| "evaluation" | A license that grants permission to install and use software for trial purposes. |
| "named-user" | A license that grants access to the software to one or more pre-defined users. |
| "node-locked" | A license that grants access to the software on one or more pre-defined computers or devices. |
| "oem" | An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| "perpetual" | A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| "processor-points" | A license where each installation consumes points per processor. |
| "subscription" | A license where the licensee pays a fee to use the software or service. |
| "user" | A license that grants access to the software or service by a specified number of users. |
| "other" | Another license type. |
The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.
The timestamp indicating when the current license expires (if applicable).
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A tuple of exactly one SPDX License Expression.
Must contain a minimum of 1 items
Must contain a maximum of 1 items
A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Copyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection.
No Additional ItemsA copyright notice informing users of the underlying claims to copyright ownership in a published work.
No Additional PropertiesThe textual content of the copyright.
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.
The URL to an image that may be used in messaging on social media platforms.
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 ItemsTextual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.
No Additional Items"json-parser"
"object-persistence"
"text-to-image"
"translation"
"object-detection"
A collection of issues that have been resolved.
No Additional ItemsAn individual issue that has been resolved.
No Additional PropertiesSpecifies the type of issue
| Name | Description |
|---|---|
| "defect" | A fault, flaw, or bug in software. |
| "enhancement" | A new feature or behavior in software. |
| "security" | A special type of defect which impacts security. |
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.
"National Vulnerability Database"
"NVD"
"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 format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type machine-learning-model and must not be specified for other component types.
An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Hyper-parameters for construction of the model.
No Additional PropertiesThe overall approach to learning used by the model for problem solving.
No Additional PropertiesLearning types describing the learning problem or hybrid learning problem.
| Name | Description |
|---|---|
| "supervised" | Supervised machine learning involves training an algorithm on labeled data to predict or classify new data based on the patterns learned from the labeled examples. |
| "unsupervised" | Unsupervised machine learning involves training algorithms on unlabeled data to discover patterns, structures, or relationships without explicit guidance, allowing the model to identify inherent structures or clusters within the data. |
| "reinforcement-learning" | Reinforcement learning is a type of machine learning where an agent learns to make decisions by interacting with an environment to maximize cumulative rewards, through trial and error. |
| "semi-supervised" | Semi-supervised machine learning utilizes a combination of labeled and unlabeled data during training to improve model performance, leveraging the benefits of both supervised and unsupervised learning techniques. |
| "self-supervised" | Self-supervised machine learning involves training models to predict parts of the input data from other parts of the same data, without requiring external labels, enabling learning from large amounts of unlabeled data. |
Directly influences the input and/or output. Examples include classification, regression, clustering, etc.
The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc.
The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc.
The datasets used to train and evaluate the model.
No Additional ItemsAn optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The general theme or subject matter of the data being specified.
| Name | Description |
|---|---|
| "source-code" | Any type of code, code snippet, or data-as-code. |
| "configuration" | Parameters or settings that may be used by other components. |
| "dataset" | A collection of data. |
| "definition" | Data that can be used to create new instances of what the definition defines. |
| "other" | Any other type of data that does not fit into existing definitions. |
The name of the dataset.
The contents or references to the contents of the data being described.
No Additional PropertiesAn optional way to include textual or encoded data.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to where the data can be retrieved.
Provides the ability to document name-value parameters used for configuration.
No Additional ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
A description of any sensitive data in a dataset.
No Additional ItemsA collection of graphics that represent various measurements.
No Additional PropertiesA description of this collection of graphics.
A collection of graphics.
No Additional ItemsThe name of the graphic.
The graphic (vector or raster). Base64 encoding must be specified for binary images.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
No Additional PropertiesData custodians are responsible for the safe custody, transport, and storage of data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data stewards are responsible for data content, context, and associated business rules.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data owners are concerned with risk and appropriate access to data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
References a data component by the components bom-ref attribute
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.
Must be at least 1 characters long
Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$The input format(s) of the model
No Additional ItemsThe data format for input/output to the model.
"string"
"image"
"time-series"
The output format(s) from the model
No Additional ItemsThe data format for input/output to the model.
"string"
"image"
"time-series"
A quantitative analysis of the model
No Additional PropertiesThe model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc.
No Additional ItemsThe type of performance metric.
The value of the performance metric.
The name of the slice this metric was computed on. By default, assume this metric is not sliced.
The confidence interval of the metric.
No Additional PropertiesThe lower bound of the confidence interval.
The upper bound of the confidence interval.
A collection of graphics that represent various measurements.
No Additional PropertiesA description of this collection of graphics.
A collection of graphics.
No Additional ItemsThe name of the graphic.
The graphic (vector or raster). Base64 encoding must be specified for binary images.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
What considerations should be taken into account regarding the model's construction, training, and application?
No Additional PropertiesWho are the intended users of the model?
No Additional ItemsWhat are the intended use cases of the model?
No Additional ItemsWhat are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?
No Additional ItemsWhat are the known tradeoffs in accuracy/performance of the model?
No Additional ItemsWhat are the ethical risks involved in the application of this model?
No Additional ItemsThe name of the risk.
Strategy used to address this risk.
What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?
No Additional PropertiesDescribes energy consumption information incurred for one or more component lifecycle activities.
No Additional ItemsDescribes energy consumption information incurred for the specified lifecycle activity.
No Additional PropertiesThe type of activity that is part of a machine learning model development or operational lifecycle.
| Name | Description |
|---|---|
| "design" | A model design including problem framing, goal definition and algorithm selection. |
| "data-collection" | Model data acquisition including search, selection and transfer. |
| "data-preparation" | Model data preparation including data cleaning, labeling and conversion. |
| "training" | Model building, training and generalized tuning. |
| "fine-tuning" | Refining a trained model to produce desired outputs for a given problem space. |
| "validation" | Model validation including model output evaluation and testing. |
| "deployment" | Explicit model deployment to a target hosting infrastructure. |
| "inference" | Generating an output response from a hosted model from a set of inputs. |
| "other" | A lifecycle activity type whose description does not match currently defined values. |
The provider(s) of the energy consumed by the associated model development lifecycle activity.
No Additional ItemsDescribes the physical provider of energy used for model development or operations.
No Additional PropertiesAn optional identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A description of the energy provider.
The organization that provides energy.
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The energy source for the energy provider.
| Name | Description |
|---|---|
| "coal" | Energy produced by types of coal. |
| "oil" | Petroleum products (primarily crude oil and its derivative fuel oils). |
| "natural-gas" | Hydrocarbon gas liquids (HGL) that occur as gases at atmospheric pressure and as liquids under higher pressures including Natural gas (C5H12 and heavier), Ethane (C2H6), Propane (C3H8), etc. |
| "nuclear" | Energy produced from the cores of atoms (i.e., through nuclear fission or fusion). |
| "wind" | Energy produced from moving air. |
| "solar" | Energy produced from the sun (i.e., solar radiation). |
| "geothermal" | Energy produced from heat within the earth. |
| "hydropower" | Energy produced from flowing water. |
| "biofuel" | Liquid fuels produced from biomass feedstocks (i.e., organic materials such as plants or animals). |
| "unknown" | The energy source is unknown. |
| "other" | An energy source that is not listed. |
The energy provided by the energy source for an associated activity.
No Additional PropertiesQuantity of energy.
Unit of energy.
| Name | Description |
|---|---|
| "kWh" | Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h). |
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional ItemsExternal references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional PropertiesThe URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$An optional comment describing the external reference
Specifies the type of external reference.
| Name | Description |
|---|---|
| "vcs" | Version Control System |
| "issue-tracker" | Issue or defect tracking system, or an Application Lifecycle Management (ALM) system |
| "website" | Website |
| "advisories" | Security advisories |
| "bom" | Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc) |
| "mailing-list" | Mailing list or discussion group |
| "social" | Social media account |
| "chat" | Real-time chat platform |
| "documentation" | Documentation, guides, or how-to instructions |
| "support" | Community or commercial support |
| "source-distribution" | The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type. |
| "distribution" | Direct or repository download location |
| "distribution-intake" | The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary. |
| "license" | The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness. |
| "build-meta" | Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc) |
| "build-system" | Reference to an automated build system |
| "release-notes" | Reference to release notes |
| "security-contact" | Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT. |
| "model-card" | A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency. |
| "log" | A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations. |
| "configuration" | Parameters or settings that may be used by other components or services. |
| "evidence" | Information used to substantiate a claim. |
| "formulation" | Describes how a component or service was manufactured or deployed. |
| "attestation" | Human or machine-readable statements containing facts, evidence, or testimony. |
| "threat-model" | An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format. |
| "adversary-model" | The defined assumptions, goals, and capabilities of an adversary. |
| "risk-assessment" | Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk. |
| "vulnerability-assertion" | A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product. |
| "exploitability-statement" | A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization. |
| "pentest-report" | Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test. |
| "static-analysis-report" | SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code. |
| "dynamic-analysis-report" | Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations. |
| "runtime-analysis-report" | Report generated by analyzing the call stack of a running application. |
| "component-analysis-report" | Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis. |
| "maturity-report" | Report containing a formal assessment of an organization, business unit, or team against a maturity model. |
| "certification-report" | Industry, regulatory, or other certification from an accredited (if applicable) certification body. |
| "codified-infrastructure" | Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC). |
| "quality-metrics" | Report or system in which quality metrics can be obtained. |
| "poam" | Plans of Action and Milestones (POA&M) complement an "attestation" external reference. POA&M is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones". |
| "electronic-signature" | An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name. |
| "digital-signature" | A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification. |
| "rfc-9116" | Document that complies with RFC 9116 (A File Format to Aid in Security Vulnerability Disclosure) |
| "other" | Use this if no other types accurately describe the purpose of the external reference. |
The hashes of the external reference (if applicable).
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"3942447fac867ae5cdb3229b658f4d48"
The total energy cost associated with the model lifecycle activity.
No Additional PropertiesQuantity of energy.
Unit of energy.
| Name | Description |
|---|---|
| "kWh" | Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h). |
The CO2 cost (debit) equivalent to the total energy cost.
No Additional PropertiesQuantity of carbon dioxide (CO2).
Unit of carbon dioxide (CO2).
| Name | Description |
|---|---|
| "tCO2eq" | Tonnes (t) of carbon dioxide (CO2) equivalent (eq). |
The CO2 offset (credit) for the CO2 equivalent cost.
No Additional PropertiesQuantity of carbon dioxide (CO2).
Unit of carbon dioxide (CO2).
| Name | Description |
|---|---|
| "tCO2eq" | Tonnes (t) of carbon dioxide (CO2) equivalent (eq). |
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 ItemsProvides 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 PropertiesThe 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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?
No Additional ItemsInformation about the benefits and harms of the model to an identified at risk group.
No Additional PropertiesThe groups or individuals at risk of being systematically disadvantaged by the model.
Expected benefits to the identified groups.
Expected harms to the identified groups.
With respect to the benefits and harms outlined, please describe any mitigation strategy implemented.
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
This object SHOULD be specified for any component of type data and must not be specified for other component types.
An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The general theme or subject matter of the data being specified.
| Name | Description |
|---|---|
| "source-code" | Any type of code, code snippet, or data-as-code. |
| "configuration" | Parameters or settings that may be used by other components. |
| "dataset" | A collection of data. |
| "definition" | Data that can be used to create new instances of what the definition defines. |
| "other" | Any other type of data that does not fit into existing definitions. |
The name of the dataset.
The contents or references to the contents of the data being described.
No Additional PropertiesAn optional way to include textual or encoded data.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to where the data can be retrieved.
Provides the ability to document name-value parameters used for configuration.
No Additional ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
A description of any sensitive data in a dataset.
No Additional ItemsA collection of graphics that represent various measurements.
No Additional PropertiesA description of this collection of graphics.
A collection of graphics.
No Additional ItemsThe name of the graphic.
The graphic (vector or raster). Base64 encoding must be specified for binary images.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
No Additional PropertiesData custodians are responsible for the safe custody, transport, and storage of data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data stewards are responsible for data content, context, and associated business rules.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data owners are concerned with risk and appropriate access to data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Cryptographic assets have properties that uniquely define them and that make them actionable for further reasoning. As an example, it makes a difference if one knows the algorithm family (e.g. AES) or the specific variant or instantiation (e.g. AES-128-GCM). This is because the security level and the algorithm primitive (authenticated encryption) are only defined by the definition of the algorithm variant. The presence of a weak cryptographic algorithm like SHA1 vs. HMAC-SHA1 also makes a difference.
No Additional PropertiesCryptographic assets occur in several forms. Algorithms and protocols are most commonly implemented in specialized cryptographic libraries. They may, however, also be 'hardcoded' in software components. Certificates and related cryptographic material like keys, tokens, secrets or passwords are other cryptographic assets to be modelled.
| Name | Description |
|---|---|
| "algorithm" | Mathematical function commonly used for data encryption, authentication, and digital signatures. |
| "certificate" | An electronic document that is used to provide the identity or validate a public key. |
| "protocol" | A set of rules and guidelines that govern the behavior and communication with each other. |
| "related-crypto-material" | Other cryptographic assets related to algorithms, certificates, and protocols such as keys and tokens. |
Additional properties specific to a cryptographic algorithm.
No Additional PropertiesCryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (drbg, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (pke, e.g. RSA), extended output functions (xof, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (ae, e.g. AES-GCM) and the combination of multiple algorithms (combiner, e.g. SP800-56Cr2).
| Name | Description |
|---|---|
| "drbg" | Deterministic Random Bit Generator (DRBG) is a type of pseudorandom number generator designed to produce a sequence of bits from an initial seed value. DRBGs are commonly used in cryptographic applications where reproducibility of random values is important. |
| "mac" | In cryptography, a Message Authentication Code (MAC) is information used for authenticating and integrity-checking a message. |
| "block-cipher" | A block cipher is a symmetric key algorithm that operates on fixed-size blocks of data. It encrypts or decrypts the data in block units, providing confidentiality. Block ciphers are widely used in various cryptographic modes and protocols for secure data transmission. |
| "stream-cipher" | A stream cipher is a symmetric key cipher where plaintext digits are combined with a pseudorandom cipher digit stream (keystream). |
| "signature" | In cryptography, a signature is a digital representation of a message or data that proves its origin, identity, and integrity. Digital signatures are generated using cryptographic algorithms and are widely used for authentication and verification in secure communication. |
| "hash" | A hash function is a mathematical algorithm that takes an input (or 'message') and produces a fixed-size string of characters, which is typically a hash value. Hash functions are commonly used in various cryptographic applications, including data integrity verification and password hashing. |
| "pke" | Public Key Encryption (PKE) is a type of encryption that uses a pair of public and private keys for secure communication. The public key is used for encryption, while the private key is used for decryption. PKE is a fundamental component of public-key cryptography. |
| "xof" | An XOF is an extendable output function that can take arbitrary input and creates a stream of output, up to a limit determined by the size of the internal state of the hash function that underlies the XOF. |
| "kdf" | A Key Derivation Function (KDF) derives key material from another source of entropy while preserving the entropy of the input. |
| "key-agree" | In cryptography, a key-agreement is a protocol whereby two or more parties agree on a cryptographic key in such a way that both influence the outcome. |
| "kem" | A Key Encapsulation Mechanism (KEM) algorithm is a mechanism for transporting random keying material to a recipient using the recipient's public key. |
| "ae" | Authenticated Encryption (AE) is a cryptographic process that provides both confidentiality and data integrity. It ensures that the encrypted data has not been tampered with and comes from a legitimate source. AE is commonly used in secure communication protocols. |
| "combiner" | A combiner aggregates many candidates for a cryptographic primitive and generates a new candidate for the same primitive. |
| "other" | Another primitive type. |
| "unknown" | The primitive is not known. |
An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, '128' identifies the key length in bits, in SHA256, '256' identifies the digest length, '128' in SHAKE128 identifies its maximum security level in bits, and 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205).
The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. Absent an authoritative source of curve names, CycloneDX recommends using curve names as defined at https://neuromancer.sk/std/, the source of which can be found at https://github.com/J08nY/std-curves.
The target and execution environment in which the algorithm is implemented in.
| Name | Description |
|---|---|
| "software-plain-ram" | A software implementation running in plain unencrypted RAM. |
| "software-encrypted-ram" | A software implementation running in encrypted RAM. |
| "software-tee" | A software implementation running in a trusted execution environment. |
| "hardware" | A hardware implementation. |
| "other" | Another implementation environment. |
| "unknown" | The execution environment is not known. |
The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform.
The certification that the implementation of the cryptographic algorithm has received, if any. Certifications include revisions and levels of FIPS 140 or Common Criteria of different Extended Assurance Levels (CC-EAL).
No Additional Items| Name | Description |
|---|---|
| "none" | No certification obtained |
| "fips140-1-l1" | FIPS 140-1 Level 1 |
| "fips140-1-l2" | FIPS 140-1 Level 2 |
| "fips140-1-l3" | FIPS 140-1 Level 3 |
| "fips140-1-l4" | FIPS 140-1 Level 4 |
| "fips140-2-l1" | FIPS 140-2 Level 1 |
| "fips140-2-l2" | FIPS 140-2 Level 2 |
| "fips140-2-l3" | FIPS 140-2 Level 3 |
| "fips140-2-l4" | FIPS 140-2 Level 4 |
| "fips140-3-l1" | FIPS 140-3 Level 1 |
| "fips140-3-l2" | FIPS 140-3 Level 2 |
| "fips140-3-l3" | FIPS 140-3 Level 3 |
| "fips140-3-l4" | FIPS 140-3 Level 4 |
| "cc-eal1" | Common Criteria - Evaluation Assurance Level 1 |
| "cc-eal1+" | Common Criteria - Evaluation Assurance Level 1 (Augmented) |
| "cc-eal2" | Common Criteria - Evaluation Assurance Level 2 |
| "cc-eal2+" | Common Criteria - Evaluation Assurance Level 2 (Augmented) |
| "cc-eal3" | Common Criteria - Evaluation Assurance Level 3 |
| "cc-eal3+" | Common Criteria - Evaluation Assurance Level 3 (Augmented) |
| "cc-eal4" | Common Criteria - Evaluation Assurance Level 4 |
| "cc-eal4+" | Common Criteria - Evaluation Assurance Level 4 (Augmented) |
| "cc-eal5" | Common Criteria - Evaluation Assurance Level 5 |
| "cc-eal5+" | Common Criteria - Evaluation Assurance Level 5 (Augmented) |
| "cc-eal6" | Common Criteria - Evaluation Assurance Level 6 |
| "cc-eal6+" | Common Criteria - Evaluation Assurance Level 6 (Augmented) |
| "cc-eal7" | Common Criteria - Evaluation Assurance Level 7 |
| "cc-eal7+" | Common Criteria - Evaluation Assurance Level 7 (Augmented) |
| "other" | Another certification |
| "unknown" | The certification level is not known |
The mode of operation in which the cryptographic algorithm (block cipher) is used.
| Name | Description |
|---|---|
| "cbc" | Cipher block chaining |
| "ecb" | Electronic codebook |
| "ccm" | Counter with cipher block chaining message authentication code |
| "gcm" | Galois/counter |
| "cfb" | Cipher feedback |
| "ofb" | Output feedback |
| "ctr" | Counter |
| "other" | Another mode of operation |
| "unknown" | The mode of operation is not known |
The padding scheme that is used for the cryptographic algorithm.
| Name | Description |
|---|---|
| "pkcs5" | Public Key Cryptography Standard: Password-Based Cryptography |
| "pkcs7" | Public Key Cryptography Standard: Cryptographic Message Syntax |
| "pkcs1v15" | Public Key Cryptography Standard: RSA Cryptography v1.5 |
| "oaep" | Optimal asymmetric encryption padding |
| "raw" | Raw |
| "other" | Another padding scheme |
| "unknown" | The padding scheme is not known |
The cryptographic functions implemented by the cryptographic algorithm.
No Additional ItemsThe classical security level that a cryptographic algorithm provides (in bits).
Value must be greater or equal to 0
The NIST security strength category as defined in https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria). A value of 0 indicates that none of the categories are met.
Value must be greater or equal to 0 and lesser or equal to 6
Properties for cryptographic assets of asset type 'certificate'
No Additional PropertiesThe subject name for the certificate
The issuer name for the certificate
The date and time according to ISO-8601 standard from which the certificate is valid
The date and time according to ISO-8601 standard from which the certificate is not valid anymore
The bom-ref to signature algorithm used by the certificate
Must be at least 1 characters long
The bom-ref to the public key of the subject
Must be at least 1 characters long
The format of the certificate
"X.509"
"PEM"
"DER"
"CVC"
The file extension of the certificate
"crt"
"pem"
"cer"
"der"
"p12"
Properties specific to cryptographic assets of type: protocol.
The concrete protocol type.
| Name | Description |
|---|---|
| "tls" | Transport Layer Security |
| "ssh" | Secure Shell |
| "ipsec" | Internet Protocol Security |
| "ike" | Internet Key Exchange |
| "sstp" | Secure Socket Tunneling Protocol |
| "wpa" | Wi-Fi Protected Access |
| "other" | Another protocol type |
| "unknown" | The protocol type is not known |
The version of the protocol.
"1.0"
"1.2"
"1.99"
A list of cipher suites related to the protocol.
No Additional ItemsObject representing a cipher suite
No Additional PropertiesA common name for the cipher suite.
"TLS_DHE_RSA_WITH_AES_128_CCM"
A list of algorithms related to the cipher suite.
No Additional ItemsThe bom-ref to algorithm cryptographic asset.
Must be at least 1 characters long
A list of common identifiers for the cipher suite.
No Additional ItemsCipher suite identifier
"0xC0"
"0x9E"
The IKEv2 transform types supported (types 1-4), defined in RFC 7296 section 3.3.2, and additional properties.
No Additional PropertiesTransform Type 1: encryption algorithms
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Transform Type 2: pseudorandom functions
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Transform Type 3: integrity algorithms
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Transform Type 4: Key Exchange Method (KE) per RFC 9370, formerly called Diffie-Hellman Group (D-H).
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Specifies if an Extended Sequence Number (ESN) is used.
IKEv2 Authentication method
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A list of protocol-related cryptographic assets
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The object identifier (OID) of the cryptographic asset.
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.
No Additional Items"json-parser"
"object-persistence"
"text-to-image"
"translation"
"object-detection"
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 used as tools. 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.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The organization that provides the service.
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The 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.
Must be at most 1024 characters long
"9.0.14"
"v1.33.7"
"7.0.0-M1"
"2.0pre1"
"1.0.0-beta1"
"0.8.15"
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.
The name of the trust zone the service resides in.
Specifies information about the data including the directional flow of data and 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.
| Name | Description |
|---|---|
| "inbound" | Data that enters a service. |
| "outbound" | Data that exits a service. |
| "bi-directional" | Data flows in and out of the service. |
| "unknown" | The directional flow of data is not known. |
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
Name for the defined data
"Credit card reporting"
Short description of the data content and usage
"Credit card information being exchanged in between the web app and the database"
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
No Additional PropertiesData custodians are responsible for the safe custody, transport, and storage of data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data stewards are responsible for data content, context, and associated business rules.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data owners are concerned with risk and appropriate access to data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The URI, URL, or BOM-Link of the components or services the data came in from
No Additional ItemsDescriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$The URI, URL, or BOM-Link of the components or services the data is sent to
No Additional ItemsDescriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
A list of SPDX licenses and/or named licenses.
No Additional ItemsSpecifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.
No Additional PropertiesAn optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
"Apache-2.0"
The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
"Acme Software License"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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"
Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata
No Additional PropertiesLicense identifiers that may be used to manage licenses and their lifecycle
No Additional ItemsThe individual or organization that grants a license to another individual or organization
No Additional PropertiesThe organization that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization for which a license was granted to
No Additional PropertiesThe organization that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization that purchased the license
No Additional PropertiesThe organization that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
The type of license(s) that was granted to the licensee.
No Additional Items| Name | Description |
|---|---|
| "academic" | A license that grants use of software solely for the purpose of education or research. |
| "appliance" | A license covering use of software embedded in a specific piece of hardware. |
| "client-access" | A Client Access License (CAL) allows client computers to access services provided by server software. |
| "concurrent-user" | A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| "core-points" | A license where the core of a computer's processor is assigned a specific number of points. |
| "custom-metric" | A license for which consumption is measured by non-standard metrics. |
| "device" | A license that covers a defined number of installations on computers and other types of devices. |
| "evaluation" | A license that grants permission to install and use software for trial purposes. |
| "named-user" | A license that grants access to the software to one or more pre-defined users. |
| "node-locked" | A license that grants access to the software on one or more pre-defined computers or devices. |
| "oem" | An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| "perpetual" | A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| "processor-points" | A license where each installation consumes points per processor. |
| "subscription" | A license where the licensee pays a fee to use the software or service. |
| "user" | A license that grants access to the software or service by a specified number of users. |
| "other" | Another license type. |
The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.
The timestamp indicating when the current license expires (if applicable).
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A tuple of exactly one SPDX License Expression.
Must contain a minimum of 1 items
Must contain a maximum of 1 items
A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional ItemsExternal references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional PropertiesThe URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$An optional comment describing the external reference
Specifies the type of external reference.
| Name | Description |
|---|---|
| "vcs" | Version Control System |
| "issue-tracker" | Issue or defect tracking system, or an Application Lifecycle Management (ALM) system |
| "website" | Website |
| "advisories" | Security advisories |
| "bom" | Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc) |
| "mailing-list" | Mailing list or discussion group |
| "social" | Social media account |
| "chat" | Real-time chat platform |
| "documentation" | Documentation, guides, or how-to instructions |
| "support" | Community or commercial support |
| "source-distribution" | The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type. |
| "distribution" | Direct or repository download location |
| "distribution-intake" | The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary. |
| "license" | The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness. |
| "build-meta" | Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc) |
| "build-system" | Reference to an automated build system |
| "release-notes" | Reference to release notes |
| "security-contact" | Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT. |
| "model-card" | A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency. |
| "log" | A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations. |
| "configuration" | Parameters or settings that may be used by other components or services. |
| "evidence" | Information used to substantiate a claim. |
| "formulation" | Describes how a component or service was manufactured or deployed. |
| "attestation" | Human or machine-readable statements containing facts, evidence, or testimony. |
| "threat-model" | An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format. |
| "adversary-model" | The defined assumptions, goals, and capabilities of an adversary. |
| "risk-assessment" | Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk. |
| "vulnerability-assertion" | A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product. |
| "exploitability-statement" | A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization. |
| "pentest-report" | Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test. |
| "static-analysis-report" | SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code. |
| "dynamic-analysis-report" | Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations. |
| "runtime-analysis-report" | Report generated by analyzing the call stack of a running application. |
| "component-analysis-report" | Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis. |
| "maturity-report" | Report containing a formal assessment of an organization, business unit, or team against a maturity model. |
| "certification-report" | Industry, regulatory, or other certification from an accredited (if applicable) certification body. |
| "codified-infrastructure" | Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC). |
| "quality-metrics" | Report or system in which quality metrics can be obtained. |
| "poam" | Plans of Action and Milestones (POA&M) complement an "attestation" external reference. POA&M is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones". |
| "electronic-signature" | An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name. |
| "digital-signature" | A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification. |
| "rfc-9116" | Document that complies with RFC 9116 (A File Format to Aid in Security Vulnerability Disclosure) |
| "other" | Use this if no other types accurately describe the purpose of the external reference. |
The hashes of the external reference (if applicable).
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"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.
The URL to an image that may be used in messaging on social media platforms.
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 ItemsTextual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.
No Additional Items"json-parser"
"object-persistence"
"text-to-image"
"translation"
"object-detection"
A collection of issues that have been resolved.
No Additional ItemsAn individual issue that has been resolved.
No Additional PropertiesSpecifies the type of issue
| Name | Description |
|---|---|
| "defect" | A fault, flaw, or bug in software. |
| "enhancement" | A new feature or behavior in software. |
| "security" | A special type of defect which impacts security. |
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.
"National Vulnerability Database"
"NVD"
"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 format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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 ItemsProvides 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 PropertiesThe 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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.
No Additional Items"json-parser"
"object-persistence"
"text-to-image"
"translation"
"object-detection"
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
[Deprecated] The tool(s) used in the creation, enrichment, and validation of the BOM.
No Additional Items[Deprecated] This will be removed in a future version. Use component or service instead. Information 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
Must be at most 1024 characters long
"9.0.14"
"v1.33.7"
"7.0.0-M1"
"2.0pre1"
"1.0.0-beta1"
"0.8.15"
The hashes of the tool (if applicable).
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"3942447fac867ae5cdb3229b658f4d48"
External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional ItemsExternal references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional PropertiesThe URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$An optional comment describing the external reference
Specifies the type of external reference.
| Name | Description |
|---|---|
| "vcs" | Version Control System |
| "issue-tracker" | Issue or defect tracking system, or an Application Lifecycle Management (ALM) system |
| "website" | Website |
| "advisories" | Security advisories |
| "bom" | Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc) |
| "mailing-list" | Mailing list or discussion group |
| "social" | Social media account |
| "chat" | Real-time chat platform |
| "documentation" | Documentation, guides, or how-to instructions |
| "support" | Community or commercial support |
| "source-distribution" | The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type. |
| "distribution" | Direct or repository download location |
| "distribution-intake" | The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary. |
| "license" | The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness. |
| "build-meta" | Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc) |
| "build-system" | Reference to an automated build system |
| "release-notes" | Reference to release notes |
| "security-contact" | Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT. |
| "model-card" | A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency. |
| "log" | A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations. |
| "configuration" | Parameters or settings that may be used by other components or services. |
| "evidence" | Information used to substantiate a claim. |
| "formulation" | Describes how a component or service was manufactured or deployed. |
| "attestation" | Human or machine-readable statements containing facts, evidence, or testimony. |
| "threat-model" | An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format. |
| "adversary-model" | The defined assumptions, goals, and capabilities of an adversary. |
| "risk-assessment" | Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk. |
| "vulnerability-assertion" | A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product. |
| "exploitability-statement" | A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization. |
| "pentest-report" | Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test. |
| "static-analysis-report" | SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code. |
| "dynamic-analysis-report" | Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations. |
| "runtime-analysis-report" | Report generated by analyzing the call stack of a running application. |
| "component-analysis-report" | Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis. |
| "maturity-report" | Report containing a formal assessment of an organization, business unit, or team against a maturity model. |
| "certification-report" | Industry, regulatory, or other certification from an accredited (if applicable) certification body. |
| "codified-infrastructure" | Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC). |
| "quality-metrics" | Report or system in which quality metrics can be obtained. |
| "poam" | Plans of Action and Milestones (POA&M) complement an "attestation" external reference. POA&M is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones". |
| "electronic-signature" | An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name. |
| "digital-signature" | A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification. |
| "rfc-9116" | Document that complies with RFC 9116 (A File Format to Aid in Security Vulnerability Disclosure) |
| "other" | Use this if no other types accurately describe the purpose of the external reference. |
The hashes of the external reference (if applicable).
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"3942447fac867ae5cdb3229b658f4d48"
The organization that created the BOM.
Manufacturer is common in BOMs created through automated processes. BOMs created through manual means may have @.authors instead.
An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The person(s) who created the BOM.
Authors are common in BOMs created through manual processes. BOMs created through automated means may have @.manufacturer instead.
An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
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.
| Name | Description |
|---|---|
| "application" | A software application. Refer to https://en.wikipedia.org/wiki/Application_software for information about applications. |
| "framework" | A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework for information on how frameworks vary slightly from libraries. |
| "library" | A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing) for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is recommended. |
| "container" | A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to https://en.wikipedia.org/wiki/OS-level_virtualization. |
| "platform" | A runtime environment which interprets or executes software. This may include runtimes such as those that execute bytecode or low-code/no-code application platforms. |
| "operating-system" | A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to https://en.wikipedia.org/wiki/Operating_system. |
| "device" | A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device. See also the list of known device properties. |
| "device-driver" | A special type of software that operates or controls a particular type of device. Refer to https://en.wikipedia.org/wiki/Device_driver. |
| "firmware" | A special type of software that provides low-level control over a device's hardware. Refer to https://en.wikipedia.org/wiki/Firmware. |
| "file" | A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file for information about files. |
| "machine-learning-model" | A model based on training data that can make predictions or decisions without being explicitly programmed to do so. |
| "data" | A collection of discrete values that convey information. |
| "cryptographic-asset" | A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets. |
"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.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The organization that created the component.
Manufacturer is common in components created through automated processes. Components created through manual means may have @.authors instead.
An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The person(s) who created the component.
Authors are common in components created through manual processes. Components created through automated means may have @.manufacturer instead.
An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
[Deprecated] This will be removed in a future version. Use @.authors or @.manufacturer instead.
The person(s) or organization(s) that authored the component
"Acme Inc"
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.
Must be at most 1024 characters long
"9.0.14"
"v1.33.7"
"7.0.0-M1"
"2.0pre1"
"1.0.0-beta1"
"0.8.15"
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.
| Name | Description |
|---|---|
| "required" | The component is required for runtime |
| "optional" | The component is optional at runtime. Optional components are components that are not capable of being called due to them not being installed or otherwise accessible by any means. Components that are installed but due to configuration or other restrictions are prohibited from being called must be scoped as 'required'. |
| "excluded" | Components that are excluded provide the ability to document component usage for test and other non-runtime purposes. Excluded components are not reachable within a call graph at runtime. |
The hashes of the component.
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"3942447fac867ae5cdb3229b658f4d48"
EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
A list of SPDX licenses and/or named licenses.
No Additional ItemsSpecifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.
No Additional PropertiesAn optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
"Apache-2.0"
The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
"Acme Software License"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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"
Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata
No Additional PropertiesLicense identifiers that may be used to manage licenses and their lifecycle
No Additional ItemsThe individual or organization that grants a license to another individual or organization
No Additional PropertiesThe organization that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization for which a license was granted to
No Additional PropertiesThe organization that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization that purchased the license
No Additional PropertiesThe organization that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
The type of license(s) that was granted to the licensee.
No Additional Items| Name | Description |
|---|---|
| "academic" | A license that grants use of software solely for the purpose of education or research. |
| "appliance" | A license covering use of software embedded in a specific piece of hardware. |
| "client-access" | A Client Access License (CAL) allows client computers to access services provided by server software. |
| "concurrent-user" | A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| "core-points" | A license where the core of a computer's processor is assigned a specific number of points. |
| "custom-metric" | A license for which consumption is measured by non-standard metrics. |
| "device" | A license that covers a defined number of installations on computers and other types of devices. |
| "evaluation" | A license that grants permission to install and use software for trial purposes. |
| "named-user" | A license that grants access to the software to one or more pre-defined users. |
| "node-locked" | A license that grants access to the software on one or more pre-defined computers or devices. |
| "oem" | An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| "perpetual" | A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| "processor-points" | A license where each installation consumes points per processor. |
| "subscription" | A license where the licensee pays a fee to use the software or service. |
| "user" | A license that grants access to the software or service by a specified number of users. |
| "other" | Another license type. |
The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.
The timestamp indicating when the current license expires (if applicable).
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A tuple of exactly one SPDX License Expression.
Must contain a minimum of 1 items
Must contain a maximum of 1 items
A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A copyright notice informing users of the underlying claims to copyright ownership in a published work.
"Acme Inc"
Asserts the identity of the component using CPE. The CPE must conform to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"
Asserts the identity of the component using package-url (purl). The purl, if specified, must be valid and conform to the specification defined at: https://github.com/package-url/purl-spec. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"pkg:maven/com.acme/[email protected]?packaging=jar"
Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform to the specification defined at: https://www.iana.org/assignments/uri-schemes/prov/gitoid. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"gitoid:blob:sha1:a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"
"gitoid:blob:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must be valid and conform to the specification defined at: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"
Asserts the identity of the component using ISO-IEC 19770-2 Software Identification (SWID) Tags. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
Maps 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 format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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] 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 is not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.
No Additional 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 author who created the changes in 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 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 complementary 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.
| Name | Description |
|---|---|
| "unofficial" | A patch which is not developed by the creators or maintainers of the software being patched. Refer to https://en.wikipedia.org/wiki/Unofficial_patch. |
| "monkey" | A patch which dynamically modifies runtime behavior. Refer to https://en.wikipedia.org/wiki/Monkey_patch. |
| "backport" | A patch which takes code from a newer version of the software and applies it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting. |
| "cherry-pick" | A patch created by selectively applying commits from other versions or branches of the same software. |
The patch file (or diff) that shows changes. Refer to https://en.wikipedia.org/wiki/Diff
No Additional PropertiesSpecifies the optional text of the diff
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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
| Name | Description |
|---|---|
| "defect" | A fault, flaw, or bug in software. |
| "enhancement" | A new feature or behavior in software. |
| "security" | A special type of defect which impacts security. |
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.
"National Vulnerability Database"
"NVD"
"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 are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional ItemsExternal references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional PropertiesThe URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$An optional comment describing the external reference
Specifies the type of external reference.
| Name | Description |
|---|---|
| "vcs" | Version Control System |
| "issue-tracker" | Issue or defect tracking system, or an Application Lifecycle Management (ALM) system |
| "website" | Website |
| "advisories" | Security advisories |
| "bom" | Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc) |
| "mailing-list" | Mailing list or discussion group |
| "social" | Social media account |
| "chat" | Real-time chat platform |
| "documentation" | Documentation, guides, or how-to instructions |
| "support" | Community or commercial support |
| "source-distribution" | The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type. |
| "distribution" | Direct or repository download location |
| "distribution-intake" | The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary. |
| "license" | The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness. |
| "build-meta" | Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc) |
| "build-system" | Reference to an automated build system |
| "release-notes" | Reference to release notes |
| "security-contact" | Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT. |
| "model-card" | A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency. |
| "log" | A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations. |
| "configuration" | Parameters or settings that may be used by other components or services. |
| "evidence" | Information used to substantiate a claim. |
| "formulation" | Describes how a component or service was manufactured or deployed. |
| "attestation" | Human or machine-readable statements containing facts, evidence, or testimony. |
| "threat-model" | An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format. |
| "adversary-model" | The defined assumptions, goals, and capabilities of an adversary. |
| "risk-assessment" | Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk. |
| "vulnerability-assertion" | A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product. |
| "exploitability-statement" | A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization. |
| "pentest-report" | Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test. |
| "static-analysis-report" | SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code. |
| "dynamic-analysis-report" | Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations. |
| "runtime-analysis-report" | Report generated by analyzing the call stack of a running application. |
| "component-analysis-report" | Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis. |
| "maturity-report" | Report containing a formal assessment of an organization, business unit, or team against a maturity model. |
| "certification-report" | Industry, regulatory, or other certification from an accredited (if applicable) certification body. |
| "codified-infrastructure" | Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC). |
| "quality-metrics" | Report or system in which quality metrics can be obtained. |
| "poam" | Plans of Action and Milestones (POA&M) complement an "attestation" external reference. POA&M is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones". |
| "electronic-signature" | An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name. |
| "digital-signature" | A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification. |
| "rfc-9116" | Document that complies with RFC 9116 (A File Format to Aid in Security Vulnerability Disclosure) |
| "other" | Use this if no other types accurately describe the purpose of the external reference. |
The hashes of the external reference (if applicable).
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"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 PropertiesEvidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified.
Evidence that substantiates the identity of a component.
No Additional PropertiesThe identity field of the component which the evidence describes.
The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).
The methods used to extract and/or analyze the evidence.
No Additional ItemsThe technique used in this method of analysis.
The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value or contents of the evidence.
The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.
All items must be unique
No Additional ItemsDescriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.
Must be at least 1 characters long
Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$[Deprecated]
No Additional PropertiesThe identity field of the component which the evidence describes.
The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).
The methods used to extract and/or analyze the evidence.
No Additional ItemsThe technique used in this method of analysis.
The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value or contents of the evidence.
The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.
All items must be unique
No Additional ItemsDescriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.
Must be at least 1 characters long
Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$Evidence of individual instances of a component spread across multiple locations.
No Additional ItemsAn optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The location or path to where the component was found.
The line number where the component was found.
Value must be greater or equal to 0
The offset where the component was found.
Value must be greater or equal to 0
The symbol name that was found associated with the component.
Any additional context of the detected component (e.g. a code snippet).
Evidence of the components use through the callstack.
No Additional PropertiesWithin a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of program execution and manages the sequence of function invocations.
No Additional ItemsA package organizes modules into namespaces, providing a unique namespace for each type it contains.
A module or class that encloses functions/methods and other code.
A block of code designed to perform a particular task.
Optional arguments that are passed to the module or function.
No Additional ItemsThe line number the code that is called resides on.
The column the code that is called resides.
The full path and filename of the module.
EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
A list of SPDX licenses and/or named licenses.
No Additional ItemsSpecifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.
No Additional PropertiesAn optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
"Apache-2.0"
The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
"Acme Software License"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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"
Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata
No Additional PropertiesLicense identifiers that may be used to manage licenses and their lifecycle
No Additional ItemsThe individual or organization that grants a license to another individual or organization
No Additional PropertiesThe organization that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization for which a license was granted to
No Additional PropertiesThe organization that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization that purchased the license
No Additional PropertiesThe organization that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
The type of license(s) that was granted to the licensee.
No Additional Items| Name | Description |
|---|---|
| "academic" | A license that grants use of software solely for the purpose of education or research. |
| "appliance" | A license covering use of software embedded in a specific piece of hardware. |
| "client-access" | A Client Access License (CAL) allows client computers to access services provided by server software. |
| "concurrent-user" | A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| "core-points" | A license where the core of a computer's processor is assigned a specific number of points. |
| "custom-metric" | A license for which consumption is measured by non-standard metrics. |
| "device" | A license that covers a defined number of installations on computers and other types of devices. |
| "evaluation" | A license that grants permission to install and use software for trial purposes. |
| "named-user" | A license that grants access to the software to one or more pre-defined users. |
| "node-locked" | A license that grants access to the software on one or more pre-defined computers or devices. |
| "oem" | An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| "perpetual" | A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| "processor-points" | A license where each installation consumes points per processor. |
| "subscription" | A license where the licensee pays a fee to use the software or service. |
| "user" | A license that grants access to the software or service by a specified number of users. |
| "other" | Another license type. |
The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.
The timestamp indicating when the current license expires (if applicable).
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A tuple of exactly one SPDX License Expression.
Must contain a minimum of 1 items
Must contain a maximum of 1 items
A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Copyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection.
No Additional ItemsA copyright notice informing users of the underlying claims to copyright ownership in a published work.
No Additional PropertiesThe textual content of the copyright.
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.
The URL to an image that may be used in messaging on social media platforms.
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 ItemsTextual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.
No Additional Items"json-parser"
"object-persistence"
"text-to-image"
"translation"
"object-detection"
A collection of issues that have been resolved.
No Additional ItemsAn individual issue that has been resolved.
No Additional PropertiesSpecifies the type of issue
| Name | Description |
|---|---|
| "defect" | A fault, flaw, or bug in software. |
| "enhancement" | A new feature or behavior in software. |
| "security" | A special type of defect which impacts security. |
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.
"National Vulnerability Database"
"NVD"
"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 format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type machine-learning-model and must not be specified for other component types.
An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Hyper-parameters for construction of the model.
No Additional PropertiesThe overall approach to learning used by the model for problem solving.
No Additional PropertiesLearning types describing the learning problem or hybrid learning problem.
| Name | Description |
|---|---|
| "supervised" | Supervised machine learning involves training an algorithm on labeled data to predict or classify new data based on the patterns learned from the labeled examples. |
| "unsupervised" | Unsupervised machine learning involves training algorithms on unlabeled data to discover patterns, structures, or relationships without explicit guidance, allowing the model to identify inherent structures or clusters within the data. |
| "reinforcement-learning" | Reinforcement learning is a type of machine learning where an agent learns to make decisions by interacting with an environment to maximize cumulative rewards, through trial and error. |
| "semi-supervised" | Semi-supervised machine learning utilizes a combination of labeled and unlabeled data during training to improve model performance, leveraging the benefits of both supervised and unsupervised learning techniques. |
| "self-supervised" | Self-supervised machine learning involves training models to predict parts of the input data from other parts of the same data, without requiring external labels, enabling learning from large amounts of unlabeled data. |
Directly influences the input and/or output. Examples include classification, regression, clustering, etc.
The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc.
The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc.
The datasets used to train and evaluate the model.
No Additional ItemsAn optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The general theme or subject matter of the data being specified.
| Name | Description |
|---|---|
| "source-code" | Any type of code, code snippet, or data-as-code. |
| "configuration" | Parameters or settings that may be used by other components. |
| "dataset" | A collection of data. |
| "definition" | Data that can be used to create new instances of what the definition defines. |
| "other" | Any other type of data that does not fit into existing definitions. |
The name of the dataset.
The contents or references to the contents of the data being described.
No Additional PropertiesAn optional way to include textual or encoded data.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to where the data can be retrieved.
Provides the ability to document name-value parameters used for configuration.
No Additional ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
A description of any sensitive data in a dataset.
No Additional ItemsA collection of graphics that represent various measurements.
No Additional PropertiesA description of this collection of graphics.
A collection of graphics.
No Additional ItemsThe name of the graphic.
The graphic (vector or raster). Base64 encoding must be specified for binary images.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
No Additional PropertiesData custodians are responsible for the safe custody, transport, and storage of data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data stewards are responsible for data content, context, and associated business rules.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data owners are concerned with risk and appropriate access to data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
References a data component by the components bom-ref attribute
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.
Must be at least 1 characters long
Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$The input format(s) of the model
No Additional ItemsThe data format for input/output to the model.
"string"
"image"
"time-series"
The output format(s) from the model
No Additional ItemsThe data format for input/output to the model.
"string"
"image"
"time-series"
A quantitative analysis of the model
No Additional PropertiesThe model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc.
No Additional ItemsThe type of performance metric.
The value of the performance metric.
The name of the slice this metric was computed on. By default, assume this metric is not sliced.
The confidence interval of the metric.
No Additional PropertiesThe lower bound of the confidence interval.
The upper bound of the confidence interval.
A collection of graphics that represent various measurements.
No Additional PropertiesA description of this collection of graphics.
A collection of graphics.
No Additional ItemsThe name of the graphic.
The graphic (vector or raster). Base64 encoding must be specified for binary images.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
What considerations should be taken into account regarding the model's construction, training, and application?
No Additional PropertiesWho are the intended users of the model?
No Additional ItemsWhat are the intended use cases of the model?
No Additional ItemsWhat are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?
No Additional ItemsWhat are the known tradeoffs in accuracy/performance of the model?
No Additional ItemsWhat are the ethical risks involved in the application of this model?
No Additional ItemsThe name of the risk.
Strategy used to address this risk.
What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?
No Additional PropertiesDescribes energy consumption information incurred for one or more component lifecycle activities.
No Additional ItemsDescribes energy consumption information incurred for the specified lifecycle activity.
No Additional PropertiesThe type of activity that is part of a machine learning model development or operational lifecycle.
| Name | Description |
|---|---|
| "design" | A model design including problem framing, goal definition and algorithm selection. |
| "data-collection" | Model data acquisition including search, selection and transfer. |
| "data-preparation" | Model data preparation including data cleaning, labeling and conversion. |
| "training" | Model building, training and generalized tuning. |
| "fine-tuning" | Refining a trained model to produce desired outputs for a given problem space. |
| "validation" | Model validation including model output evaluation and testing. |
| "deployment" | Explicit model deployment to a target hosting infrastructure. |
| "inference" | Generating an output response from a hosted model from a set of inputs. |
| "other" | A lifecycle activity type whose description does not match currently defined values. |
The provider(s) of the energy consumed by the associated model development lifecycle activity.
No Additional ItemsDescribes the physical provider of energy used for model development or operations.
No Additional PropertiesAn optional identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A description of the energy provider.
The organization that provides energy.
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The energy source for the energy provider.
| Name | Description |
|---|---|
| "coal" | Energy produced by types of coal. |
| "oil" | Petroleum products (primarily crude oil and its derivative fuel oils). |
| "natural-gas" | Hydrocarbon gas liquids (HGL) that occur as gases at atmospheric pressure and as liquids under higher pressures including Natural gas (C5H12 and heavier), Ethane (C2H6), Propane (C3H8), etc. |
| "nuclear" | Energy produced from the cores of atoms (i.e., through nuclear fission or fusion). |
| "wind" | Energy produced from moving air. |
| "solar" | Energy produced from the sun (i.e., solar radiation). |
| "geothermal" | Energy produced from heat within the earth. |
| "hydropower" | Energy produced from flowing water. |
| "biofuel" | Liquid fuels produced from biomass feedstocks (i.e., organic materials such as plants or animals). |
| "unknown" | The energy source is unknown. |
| "other" | An energy source that is not listed. |
The energy provided by the energy source for an associated activity.
No Additional PropertiesQuantity of energy.
Unit of energy.
| Name | Description |
|---|---|
| "kWh" | Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h). |
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional ItemsExternal references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional PropertiesThe URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$An optional comment describing the external reference
Specifies the type of external reference.
| Name | Description |
|---|---|
| "vcs" | Version Control System |
| "issue-tracker" | Issue or defect tracking system, or an Application Lifecycle Management (ALM) system |
| "website" | Website |
| "advisories" | Security advisories |
| "bom" | Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc) |
| "mailing-list" | Mailing list or discussion group |
| "social" | Social media account |
| "chat" | Real-time chat platform |
| "documentation" | Documentation, guides, or how-to instructions |
| "support" | Community or commercial support |
| "source-distribution" | The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type. |
| "distribution" | Direct or repository download location |
| "distribution-intake" | The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary. |
| "license" | The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness. |
| "build-meta" | Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc) |
| "build-system" | Reference to an automated build system |
| "release-notes" | Reference to release notes |
| "security-contact" | Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT. |
| "model-card" | A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency. |
| "log" | A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations. |
| "configuration" | Parameters or settings that may be used by other components or services. |
| "evidence" | Information used to substantiate a claim. |
| "formulation" | Describes how a component or service was manufactured or deployed. |
| "attestation" | Human or machine-readable statements containing facts, evidence, or testimony. |
| "threat-model" | An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format. |
| "adversary-model" | The defined assumptions, goals, and capabilities of an adversary. |
| "risk-assessment" | Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk. |
| "vulnerability-assertion" | A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product. |
| "exploitability-statement" | A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization. |
| "pentest-report" | Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test. |
| "static-analysis-report" | SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code. |
| "dynamic-analysis-report" | Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations. |
| "runtime-analysis-report" | Report generated by analyzing the call stack of a running application. |
| "component-analysis-report" | Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis. |
| "maturity-report" | Report containing a formal assessment of an organization, business unit, or team against a maturity model. |
| "certification-report" | Industry, regulatory, or other certification from an accredited (if applicable) certification body. |
| "codified-infrastructure" | Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC). |
| "quality-metrics" | Report or system in which quality metrics can be obtained. |
| "poam" | Plans of Action and Milestones (POA&M) complement an "attestation" external reference. POA&M is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones". |
| "electronic-signature" | An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name. |
| "digital-signature" | A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification. |
| "rfc-9116" | Document that complies with RFC 9116 (A File Format to Aid in Security Vulnerability Disclosure) |
| "other" | Use this if no other types accurately describe the purpose of the external reference. |
The hashes of the external reference (if applicable).
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"3942447fac867ae5cdb3229b658f4d48"
The total energy cost associated with the model lifecycle activity.
No Additional PropertiesQuantity of energy.
Unit of energy.
| Name | Description |
|---|---|
| "kWh" | Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h). |
The CO2 cost (debit) equivalent to the total energy cost.
No Additional PropertiesQuantity of carbon dioxide (CO2).
Unit of carbon dioxide (CO2).
| Name | Description |
|---|---|
| "tCO2eq" | Tonnes (t) of carbon dioxide (CO2) equivalent (eq). |
The CO2 offset (credit) for the CO2 equivalent cost.
No Additional PropertiesQuantity of carbon dioxide (CO2).
Unit of carbon dioxide (CO2).
| Name | Description |
|---|---|
| "tCO2eq" | Tonnes (t) of carbon dioxide (CO2) equivalent (eq). |
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 ItemsProvides 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 PropertiesThe 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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?
No Additional ItemsInformation about the benefits and harms of the model to an identified at risk group.
No Additional PropertiesThe groups or individuals at risk of being systematically disadvantaged by the model.
Expected benefits to the identified groups.
Expected harms to the identified groups.
With respect to the benefits and harms outlined, please describe any mitigation strategy implemented.
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
This object SHOULD be specified for any component of type data and must not be specified for other component types.
An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The general theme or subject matter of the data being specified.
| Name | Description |
|---|---|
| "source-code" | Any type of code, code snippet, or data-as-code. |
| "configuration" | Parameters or settings that may be used by other components. |
| "dataset" | A collection of data. |
| "definition" | Data that can be used to create new instances of what the definition defines. |
| "other" | Any other type of data that does not fit into existing definitions. |
The name of the dataset.
The contents or references to the contents of the data being described.
No Additional PropertiesAn optional way to include textual or encoded data.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to where the data can be retrieved.
Provides the ability to document name-value parameters used for configuration.
No Additional ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
A description of any sensitive data in a dataset.
No Additional ItemsA collection of graphics that represent various measurements.
No Additional PropertiesA description of this collection of graphics.
A collection of graphics.
No Additional ItemsThe name of the graphic.
The graphic (vector or raster). Base64 encoding must be specified for binary images.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
No Additional PropertiesData custodians are responsible for the safe custody, transport, and storage of data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data stewards are responsible for data content, context, and associated business rules.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data owners are concerned with risk and appropriate access to data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Cryptographic assets have properties that uniquely define them and that make them actionable for further reasoning. As an example, it makes a difference if one knows the algorithm family (e.g. AES) or the specific variant or instantiation (e.g. AES-128-GCM). This is because the security level and the algorithm primitive (authenticated encryption) are only defined by the definition of the algorithm variant. The presence of a weak cryptographic algorithm like SHA1 vs. HMAC-SHA1 also makes a difference.
No Additional PropertiesCryptographic assets occur in several forms. Algorithms and protocols are most commonly implemented in specialized cryptographic libraries. They may, however, also be 'hardcoded' in software components. Certificates and related cryptographic material like keys, tokens, secrets or passwords are other cryptographic assets to be modelled.
| Name | Description |
|---|---|
| "algorithm" | Mathematical function commonly used for data encryption, authentication, and digital signatures. |
| "certificate" | An electronic document that is used to provide the identity or validate a public key. |
| "protocol" | A set of rules and guidelines that govern the behavior and communication with each other. |
| "related-crypto-material" | Other cryptographic assets related to algorithms, certificates, and protocols such as keys and tokens. |
Additional properties specific to a cryptographic algorithm.
No Additional PropertiesCryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (drbg, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (pke, e.g. RSA), extended output functions (xof, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (ae, e.g. AES-GCM) and the combination of multiple algorithms (combiner, e.g. SP800-56Cr2).
| Name | Description |
|---|---|
| "drbg" | Deterministic Random Bit Generator (DRBG) is a type of pseudorandom number generator designed to produce a sequence of bits from an initial seed value. DRBGs are commonly used in cryptographic applications where reproducibility of random values is important. |
| "mac" | In cryptography, a Message Authentication Code (MAC) is information used for authenticating and integrity-checking a message. |
| "block-cipher" | A block cipher is a symmetric key algorithm that operates on fixed-size blocks of data. It encrypts or decrypts the data in block units, providing confidentiality. Block ciphers are widely used in various cryptographic modes and protocols for secure data transmission. |
| "stream-cipher" | A stream cipher is a symmetric key cipher where plaintext digits are combined with a pseudorandom cipher digit stream (keystream). |
| "signature" | In cryptography, a signature is a digital representation of a message or data that proves its origin, identity, and integrity. Digital signatures are generated using cryptographic algorithms and are widely used for authentication and verification in secure communication. |
| "hash" | A hash function is a mathematical algorithm that takes an input (or 'message') and produces a fixed-size string of characters, which is typically a hash value. Hash functions are commonly used in various cryptographic applications, including data integrity verification and password hashing. |
| "pke" | Public Key Encryption (PKE) is a type of encryption that uses a pair of public and private keys for secure communication. The public key is used for encryption, while the private key is used for decryption. PKE is a fundamental component of public-key cryptography. |
| "xof" | An XOF is an extendable output function that can take arbitrary input and creates a stream of output, up to a limit determined by the size of the internal state of the hash function that underlies the XOF. |
| "kdf" | A Key Derivation Function (KDF) derives key material from another source of entropy while preserving the entropy of the input. |
| "key-agree" | In cryptography, a key-agreement is a protocol whereby two or more parties agree on a cryptographic key in such a way that both influence the outcome. |
| "kem" | A Key Encapsulation Mechanism (KEM) algorithm is a mechanism for transporting random keying material to a recipient using the recipient's public key. |
| "ae" | Authenticated Encryption (AE) is a cryptographic process that provides both confidentiality and data integrity. It ensures that the encrypted data has not been tampered with and comes from a legitimate source. AE is commonly used in secure communication protocols. |
| "combiner" | A combiner aggregates many candidates for a cryptographic primitive and generates a new candidate for the same primitive. |
| "other" | Another primitive type. |
| "unknown" | The primitive is not known. |
An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, '128' identifies the key length in bits, in SHA256, '256' identifies the digest length, '128' in SHAKE128 identifies its maximum security level in bits, and 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205).
The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. Absent an authoritative source of curve names, CycloneDX recommends using curve names as defined at https://neuromancer.sk/std/, the source of which can be found at https://github.com/J08nY/std-curves.
The target and execution environment in which the algorithm is implemented in.
| Name | Description |
|---|---|
| "software-plain-ram" | A software implementation running in plain unencrypted RAM. |
| "software-encrypted-ram" | A software implementation running in encrypted RAM. |
| "software-tee" | A software implementation running in a trusted execution environment. |
| "hardware" | A hardware implementation. |
| "other" | Another implementation environment. |
| "unknown" | The execution environment is not known. |
The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform.
The certification that the implementation of the cryptographic algorithm has received, if any. Certifications include revisions and levels of FIPS 140 or Common Criteria of different Extended Assurance Levels (CC-EAL).
No Additional Items| Name | Description |
|---|---|
| "none" | No certification obtained |
| "fips140-1-l1" | FIPS 140-1 Level 1 |
| "fips140-1-l2" | FIPS 140-1 Level 2 |
| "fips140-1-l3" | FIPS 140-1 Level 3 |
| "fips140-1-l4" | FIPS 140-1 Level 4 |
| "fips140-2-l1" | FIPS 140-2 Level 1 |
| "fips140-2-l2" | FIPS 140-2 Level 2 |
| "fips140-2-l3" | FIPS 140-2 Level 3 |
| "fips140-2-l4" | FIPS 140-2 Level 4 |
| "fips140-3-l1" | FIPS 140-3 Level 1 |
| "fips140-3-l2" | FIPS 140-3 Level 2 |
| "fips140-3-l3" | FIPS 140-3 Level 3 |
| "fips140-3-l4" | FIPS 140-3 Level 4 |
| "cc-eal1" | Common Criteria - Evaluation Assurance Level 1 |
| "cc-eal1+" | Common Criteria - Evaluation Assurance Level 1 (Augmented) |
| "cc-eal2" | Common Criteria - Evaluation Assurance Level 2 |
| "cc-eal2+" | Common Criteria - Evaluation Assurance Level 2 (Augmented) |
| "cc-eal3" | Common Criteria - Evaluation Assurance Level 3 |
| "cc-eal3+" | Common Criteria - Evaluation Assurance Level 3 (Augmented) |
| "cc-eal4" | Common Criteria - Evaluation Assurance Level 4 |
| "cc-eal4+" | Common Criteria - Evaluation Assurance Level 4 (Augmented) |
| "cc-eal5" | Common Criteria - Evaluation Assurance Level 5 |
| "cc-eal5+" | Common Criteria - Evaluation Assurance Level 5 (Augmented) |
| "cc-eal6" | Common Criteria - Evaluation Assurance Level 6 |
| "cc-eal6+" | Common Criteria - Evaluation Assurance Level 6 (Augmented) |
| "cc-eal7" | Common Criteria - Evaluation Assurance Level 7 |
| "cc-eal7+" | Common Criteria - Evaluation Assurance Level 7 (Augmented) |
| "other" | Another certification |
| "unknown" | The certification level is not known |
The mode of operation in which the cryptographic algorithm (block cipher) is used.
| Name | Description |
|---|---|
| "cbc" | Cipher block chaining |
| "ecb" | Electronic codebook |
| "ccm" | Counter with cipher block chaining message authentication code |
| "gcm" | Galois/counter |
| "cfb" | Cipher feedback |
| "ofb" | Output feedback |
| "ctr" | Counter |
| "other" | Another mode of operation |
| "unknown" | The mode of operation is not known |
The padding scheme that is used for the cryptographic algorithm.
| Name | Description |
|---|---|
| "pkcs5" | Public Key Cryptography Standard: Password-Based Cryptography |
| "pkcs7" | Public Key Cryptography Standard: Cryptographic Message Syntax |
| "pkcs1v15" | Public Key Cryptography Standard: RSA Cryptography v1.5 |
| "oaep" | Optimal asymmetric encryption padding |
| "raw" | Raw |
| "other" | Another padding scheme |
| "unknown" | The padding scheme is not known |
The cryptographic functions implemented by the cryptographic algorithm.
No Additional ItemsThe classical security level that a cryptographic algorithm provides (in bits).
Value must be greater or equal to 0
The NIST security strength category as defined in https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria). A value of 0 indicates that none of the categories are met.
Value must be greater or equal to 0 and lesser or equal to 6
Properties for cryptographic assets of asset type 'certificate'
No Additional PropertiesThe subject name for the certificate
The issuer name for the certificate
The date and time according to ISO-8601 standard from which the certificate is valid
The date and time according to ISO-8601 standard from which the certificate is not valid anymore
The bom-ref to signature algorithm used by the certificate
Must be at least 1 characters long
The bom-ref to the public key of the subject
Must be at least 1 characters long
The format of the certificate
"X.509"
"PEM"
"DER"
"CVC"
The file extension of the certificate
"crt"
"pem"
"cer"
"der"
"p12"
Properties specific to cryptographic assets of type: protocol.
The concrete protocol type.
| Name | Description |
|---|---|
| "tls" | Transport Layer Security |
| "ssh" | Secure Shell |
| "ipsec" | Internet Protocol Security |
| "ike" | Internet Key Exchange |
| "sstp" | Secure Socket Tunneling Protocol |
| "wpa" | Wi-Fi Protected Access |
| "other" | Another protocol type |
| "unknown" | The protocol type is not known |
The version of the protocol.
"1.0"
"1.2"
"1.99"
A list of cipher suites related to the protocol.
No Additional ItemsObject representing a cipher suite
No Additional PropertiesA common name for the cipher suite.
"TLS_DHE_RSA_WITH_AES_128_CCM"
A list of algorithms related to the cipher suite.
No Additional ItemsThe bom-ref to algorithm cryptographic asset.
Must be at least 1 characters long
A list of common identifiers for the cipher suite.
No Additional ItemsCipher suite identifier
"0xC0"
"0x9E"
The IKEv2 transform types supported (types 1-4), defined in RFC 7296 section 3.3.2, and additional properties.
No Additional PropertiesTransform Type 1: encryption algorithms
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Transform Type 2: pseudorandom functions
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Transform Type 3: integrity algorithms
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Transform Type 4: Key Exchange Method (KE) per RFC 9370, formerly called Diffie-Hellman Group (D-H).
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Specifies if an Extended Sequence Number (ESN) is used.
IKEv2 Authentication method
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A list of protocol-related cryptographic assets
No Additional ItemsIdentifier for referable and therefore interlinkable elements.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The object identifier (OID) of the cryptographic asset.
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.
No Additional Items"json-parser"
"object-persistence"
"text-to-image"
"translation"
"object-detection"
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
[Deprecated] This will be removed in a future version. Use the @.component.manufacturer instead.
The organization that manufactured the component that the BOM describes.
An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The 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 PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The license information for the BOM document.
This may be different from the license(s) of the component(s) that the BOM describes.
A list of SPDX licenses and/or named licenses.
No Additional ItemsSpecifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.
No Additional PropertiesAn optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
"Apache-2.0"
The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
"Acme Software License"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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"
Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata
No Additional PropertiesLicense identifiers that may be used to manage licenses and their lifecycle
No Additional ItemsThe individual or organization that grants a license to another individual or organization
No Additional PropertiesThe organization that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization for which a license was granted to
No Additional PropertiesThe organization that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization that purchased the license
No Additional PropertiesThe organization that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
The type of license(s) that was granted to the licensee.
No Additional Items| Name | Description |
|---|---|
| "academic" | A license that grants use of software solely for the purpose of education or research. |
| "appliance" | A license covering use of software embedded in a specific piece of hardware. |
| "client-access" | A Client Access License (CAL) allows client computers to access services provided by server software. |
| "concurrent-user" | A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| "core-points" | A license where the core of a computer's processor is assigned a specific number of points. |
| "custom-metric" | A license for which consumption is measured by non-standard metrics. |
| "device" | A license that covers a defined number of installations on computers and other types of devices. |
| "evaluation" | A license that grants permission to install and use software for trial purposes. |
| "named-user" | A license that grants access to the software to one or more pre-defined users. |
| "node-locked" | A license that grants access to the software on one or more pre-defined computers or devices. |
| "oem" | An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| "perpetual" | A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| "processor-points" | A license where each installation consumes points per processor. |
| "subscription" | A license where the licensee pays a fee to use the software or service. |
| "user" | A license that grants access to the software or service by a specified number of users. |
| "other" | Another license type. |
The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.
The timestamp indicating when the current license expires (if applicable).
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A tuple of exactly one SPDX License Expression.
Must contain a minimum of 1 items
Must contain a maximum of 1 items
A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
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 ItemsProvides 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 PropertiesThe 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.
| Name | Description |
|---|---|
| "application" | A software application. Refer to https://en.wikipedia.org/wiki/Application_software for information about applications. |
| "framework" | A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework for information on how frameworks vary slightly from libraries. |
| "library" | A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing) for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is recommended. |
| "container" | A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to https://en.wikipedia.org/wiki/OS-level_virtualization. |
| "platform" | A runtime environment which interprets or executes software. This may include runtimes such as those that execute bytecode or low-code/no-code application platforms. |
| "operating-system" | A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to https://en.wikipedia.org/wiki/Operating_system. |
| "device" | A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device. See also the list of known device properties. |
| "device-driver" | A special type of software that operates or controls a particular type of device. Refer to https://en.wikipedia.org/wiki/Device_driver. |
| "firmware" | A special type of software that provides low-level control over a device's hardware. Refer to https://en.wikipedia.org/wiki/Firmware. |
| "file" | A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file for information about files. |
| "machine-learning-model" | A model based on training data that can make predictions or decisions without being explicitly programmed to do so. |
| "data" | A collection of discrete values that convey information. |
| "cryptographic-asset" | A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets. |
"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.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The organization that created the component.
Manufacturer is common in components created through automated processes. Components created through manual means may have @.authors instead.
An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The person(s) who created the component.
Authors are common in components created through manual processes. Components created through automated means may have @.manufacturer instead.
An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
[Deprecated] This will be removed in a future version. Use @.authors or @.manufacturer instead.
The person(s) or organization(s) that authored the component
"Acme Inc"
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.
Must be at most 1024 characters long
"9.0.14"
"v1.33.7"
"7.0.0-M1"
"2.0pre1"
"1.0.0-beta1"
"0.8.15"
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.
| Name | Description |
|---|---|
| "required" | The component is required for runtime |
| "optional" | The component is optional at runtime. Optional components are components that are not capable of being called due to them not being installed or otherwise accessible by any means. Components that are installed but due to configuration or other restrictions are prohibited from being called must be scoped as 'required'. |
| "excluded" | Components that are excluded provide the ability to document component usage for test and other non-runtime purposes. Excluded components are not reachable within a call graph at runtime. |
The hashes of the component.
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"3942447fac867ae5cdb3229b658f4d48"
EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
A list of SPDX licenses and/or named licenses.
No Additional ItemsSpecifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.
No Additional PropertiesAn optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
"Apache-2.0"
The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
"Acme Software License"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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"
Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata
No Additional PropertiesLicense identifiers that may be used to manage licenses and their lifecycle
No Additional ItemsThe individual or organization that grants a license to another individual or organization
No Additional PropertiesThe organization that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization for which a license was granted to
No Additional PropertiesThe organization that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization that purchased the license
No Additional PropertiesThe organization that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
The type of license(s) that was granted to the licensee.
No Additional Items| Name | Description |
|---|---|
| "academic" | A license that grants use of software solely for the purpose of education or research. |
| "appliance" | A license covering use of software embedded in a specific piece of hardware. |
| "client-access" | A Client Access License (CAL) allows client computers to access services provided by server software. |
| "concurrent-user" | A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| "core-points" | A license where the core of a computer's processor is assigned a specific number of points. |
| "custom-metric" | A license for which consumption is measured by non-standard metrics. |
| "device" | A license that covers a defined number of installations on computers and other types of devices. |
| "evaluation" | A license that grants permission to install and use software for trial purposes. |
| "named-user" | A license that grants access to the software to one or more pre-defined users. |
| "node-locked" | A license that grants access to the software on one or more pre-defined computers or devices. |
| "oem" | An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| "perpetual" | A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| "processor-points" | A license where each installation consumes points per processor. |
| "subscription" | A license where the licensee pays a fee to use the software or service. |
| "user" | A license that grants access to the software or service by a specified number of users. |
| "other" | Another license type. |
The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.
The timestamp indicating when the current license expires (if applicable).
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A tuple of exactly one SPDX License Expression.
Must contain a minimum of 1 items
Must contain a maximum of 1 items
A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A copyright notice informing users of the underlying claims to copyright ownership in a published work.
"Acme Inc"
Asserts the identity of the component using CPE. The CPE must conform to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"
Asserts the identity of the component using package-url (purl). The purl, if specified, must be valid and conform to the specification defined at: https://github.com/package-url/purl-spec. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"pkg:maven/com.acme/[email protected]?packaging=jar"
Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform to the specification defined at: https://www.iana.org/assignments/uri-schemes/prov/gitoid. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"gitoid:blob:sha1:a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"
"gitoid:blob:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must be valid and conform to the specification defined at: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
"swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"
Asserts the identity of the component using ISO-IEC 19770-2 Software Identification (SWID) Tags. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
Maps 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 format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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] 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 is not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.
No Additional 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 author who created the changes in 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 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 complementary 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.
| Name | Description |
|---|---|
| "unofficial" | A patch which is not developed by the creators or maintainers of the software being patched. Refer to https://en.wikipedia.org/wiki/Unofficial_patch. |
| "monkey" | A patch which dynamically modifies runtime behavior. Refer to https://en.wikipedia.org/wiki/Monkey_patch. |
| "backport" | A patch which takes code from a newer version of the software and applies it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting. |
| "cherry-pick" | A patch created by selectively applying commits from other versions or branches of the same software. |
The patch file (or diff) that shows changes. Refer to https://en.wikipedia.org/wiki/Diff
No Additional PropertiesSpecifies the optional text of the diff
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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
| Name | Description |
|---|---|
| "defect" | A fault, flaw, or bug in software. |
| "enhancement" | A new feature or behavior in software. |
| "security" | A special type of defect which impacts security. |
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.
"National Vulnerability Database"
"NVD"
"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 are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional ItemsExternal references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional PropertiesThe URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$An optional comment describing the external reference
Specifies the type of external reference.
| Name | Description |
|---|---|
| "vcs" | Version Control System |
| "issue-tracker" | Issue or defect tracking system, or an Application Lifecycle Management (ALM) system |
| "website" | Website |
| "advisories" | Security advisories |
| "bom" | Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc) |
| "mailing-list" | Mailing list or discussion group |
| "social" | Social media account |
| "chat" | Real-time chat platform |
| "documentation" | Documentation, guides, or how-to instructions |
| "support" | Community or commercial support |
| "source-distribution" | The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type. |
| "distribution" | Direct or repository download location |
| "distribution-intake" | The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary. |
| "license" | The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness. |
| "build-meta" | Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc) |
| "build-system" | Reference to an automated build system |
| "release-notes" | Reference to release notes |
| "security-contact" | Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT. |
| "model-card" | A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency. |
| "log" | A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations. |
| "configuration" | Parameters or settings that may be used by other components or services. |
| "evidence" | Information used to substantiate a claim. |
| "formulation" | Describes how a component or service was manufactured or deployed. |
| "attestation" | Human or machine-readable statements containing facts, evidence, or testimony. |
| "threat-model" | An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format. |
| "adversary-model" | The defined assumptions, goals, and capabilities of an adversary. |
| "risk-assessment" | Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk. |
| "vulnerability-assertion" | A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product. |
| "exploitability-statement" | A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization. |
| "pentest-report" | Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test. |
| "static-analysis-report" | SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code. |
| "dynamic-analysis-report" | Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations. |
| "runtime-analysis-report" | Report generated by analyzing the call stack of a running application. |
| "component-analysis-report" | Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis. |
| "maturity-report" | Report containing a formal assessment of an organization, business unit, or team against a maturity model. |
| "certification-report" | Industry, regulatory, or other certification from an accredited (if applicable) certification body. |
| "codified-infrastructure" | Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC). |
| "quality-metrics" | Report or system in which quality metrics can be obtained. |
| "poam" | Plans of Action and Milestones (POA&M) complement an "attestation" external reference. POA&M is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones". |
| "electronic-signature" | An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name. |
| "digital-signature" | A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification. |
| "rfc-9116" | Document that complies with RFC 9116 (A File Format to Aid in Security Vulnerability Disclosure) |
| "other" | Use this if no other types accurately describe the purpose of the external reference. |
The hashes of the external reference (if applicable).
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"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 PropertiesEvidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified.
Evidence that substantiates the identity of a component.
No Additional PropertiesThe identity field of the component which the evidence describes.
The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).
The methods used to extract and/or analyze the evidence.
No Additional ItemsThe technique used in this method of analysis.
The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value or contents of the evidence.
The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.
All items must be unique
No Additional ItemsDescriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.
Must be at least 1 characters long
Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$[Deprecated]
No Additional PropertiesThe identity field of the component which the evidence describes.
The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).
The methods used to extract and/or analyze the evidence.
No Additional ItemsThe technique used in this method of analysis.
The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.
Value must be greater or equal to 0 and lesser or equal to 1
The value or contents of the evidence.
The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.
All items must be unique
No Additional ItemsDescriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.
Must be at least 1 characters long
Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$Evidence of individual instances of a component spread across multiple locations.
No Additional ItemsAn optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The location or path to where the component was found.
The line number where the component was found.
Value must be greater or equal to 0
The offset where the component was found.
Value must be greater or equal to 0
The symbol name that was found associated with the component.
Any additional context of the detected component (e.g. a code snippet).
Evidence of the components use through the callstack.
No Additional PropertiesWithin a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of program execution and manages the sequence of function invocations.
No Additional ItemsA package organizes modules into namespaces, providing a unique namespace for each type it contains.
A module or class that encloses functions/methods and other code.
A block of code designed to perform a particular task.
Optional arguments that are passed to the module or function.
No Additional ItemsThe line number the code that is called resides on.
The column the code that is called resides.
The full path and filename of the module.
EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
A list of SPDX licenses and/or named licenses.
No Additional ItemsSpecifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.
No Additional PropertiesAn optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
"Apache-2.0"
The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
"Acme Software License"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional way to include the textual content of a license.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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"
Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata
No Additional PropertiesLicense identifiers that may be used to manage licenses and their lifecycle
No Additional ItemsThe individual or organization that grants a license to another individual or organization
No Additional PropertiesThe organization that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization for which a license was granted to
No Additional PropertiesThe organization that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that was granted the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual or organization that purchased the license
No Additional PropertiesThe organization that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual, not associated with an organization, that purchased the license
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
The type of license(s) that was granted to the licensee.
No Additional Items| Name | Description |
|---|---|
| "academic" | A license that grants use of software solely for the purpose of education or research. |
| "appliance" | A license covering use of software embedded in a specific piece of hardware. |
| "client-access" | A Client Access License (CAL) allows client computers to access services provided by server software. |
| "concurrent-user" | A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| "core-points" | A license where the core of a computer's processor is assigned a specific number of points. |
| "custom-metric" | A license for which consumption is measured by non-standard metrics. |
| "device" | A license that covers a defined number of installations on computers and other types of devices. |
| "evaluation" | A license that grants permission to install and use software for trial purposes. |
| "named-user" | A license that grants access to the software to one or more pre-defined users. |
| "node-locked" | A license that grants access to the software on one or more pre-defined computers or devices. |
| "oem" | An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| "perpetual" | A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| "processor-points" | A license where each installation consumes points per processor. |
| "subscription" | A license where the licensee pays a fee to use the software or service. |
| "user" | A license that grants access to the software or service by a specified number of users. |
| "other" | Another license type. |
The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.
The timestamp indicating when the current license expires (if applicable).
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A tuple of exactly one SPDX License Expression.
Must contain a minimum of 1 items
Must contain a maximum of 1 items
A valid SPDX license expression.
Refer to https://spdx.org/specifications for syntax requirements
"Apache-2.0 AND (MIT OR GPL-2.0-only)"
"GPL-3.0-only WITH Classpath-exception-2.0"
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
| Name | Description |
|---|---|
| "declared" | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| "concluded" | Concluded licenses are verified and confirmed. |
An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Copyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection.
No Additional ItemsA copyright notice informing users of the underlying claims to copyright ownership in a published work.
No Additional PropertiesThe textual content of the copyright.
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.
The URL to an image that may be used in messaging on social media platforms.
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 ItemsTextual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.
No Additional Items"json-parser"
"object-persistence"
"text-to-image"
"translation"
"object-detection"
A collection of issues that have been resolved.
No Additional ItemsAn individual issue that has been resolved.
No Additional PropertiesSpecifies the type of issue
| Name | Description |
|---|---|
| "defect" | A fault, flaw, or bug in software. |
| "enhancement" | A new feature or behavior in software. |
| "security" | A special type of defect which impacts security. |
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.
"National Vulnerability Database"
"NVD"
"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 format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type machine-learning-model and must not be specified for other component types.
An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
Hyper-parameters for construction of the model.
No Additional PropertiesThe overall approach to learning used by the model for problem solving.
No Additional PropertiesLearning types describing the learning problem or hybrid learning problem.
| Name | Description |
|---|---|
| "supervised" | Supervised machine learning involves training an algorithm on labeled data to predict or classify new data based on the patterns learned from the labeled examples. |
| "unsupervised" | Unsupervised machine learning involves training algorithms on unlabeled data to discover patterns, structures, or relationships without explicit guidance, allowing the model to identify inherent structures or clusters within the data. |
| "reinforcement-learning" | Reinforcement learning is a type of machine learning where an agent learns to make decisions by interacting with an environment to maximize cumulative rewards, through trial and error. |
| "semi-supervised" | Semi-supervised machine learning utilizes a combination of labeled and unlabeled data during training to improve model performance, leveraging the benefits of both supervised and unsupervised learning techniques. |
| "self-supervised" | Self-supervised machine learning involves training models to predict parts of the input data from other parts of the same data, without requiring external labels, enabling learning from large amounts of unlabeled data. |
Directly influences the input and/or output. Examples include classification, regression, clustering, etc.
The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc.
The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc.
The datasets used to train and evaluate the model.
No Additional ItemsAn optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The general theme or subject matter of the data being specified.
| Name | Description |
|---|---|
| "source-code" | Any type of code, code snippet, or data-as-code. |
| "configuration" | Parameters or settings that may be used by other components. |
| "dataset" | A collection of data. |
| "definition" | Data that can be used to create new instances of what the definition defines. |
| "other" | Any other type of data that does not fit into existing definitions. |
The name of the dataset.
The contents or references to the contents of the data being described.
No Additional PropertiesAn optional way to include textual or encoded data.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
The URL to where the data can be retrieved.
Provides the ability to document name-value parameters used for configuration.
No Additional ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
A description of any sensitive data in a dataset.
No Additional ItemsA collection of graphics that represent various measurements.
No Additional PropertiesA description of this collection of graphics.
A collection of graphics.
No Additional ItemsThe name of the graphic.
The graphic (vector or raster). Base64 encoding must be specified for binary images.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
No Additional PropertiesData custodians are responsible for the safe custody, transport, and storage of data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data stewards are responsible for data content, context, and associated business rules.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
Data owners are concerned with risk and appropriate access to data.
No Additional ItemsThe organization that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The individual that is responsible for specific data governance role(s).
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
References a data component by the components bom-ref attribute
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.
In contrast to bomLinkElementType.
Must be at least 1 characters long
Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$The input format(s) of the model
No Additional ItemsThe data format for input/output to the model.
"string"
"image"
"time-series"
The output format(s) from the model
No Additional ItemsThe data format for input/output to the model.
"string"
"image"
"time-series"
A quantitative analysis of the model
No Additional PropertiesThe model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc.
No Additional ItemsThe type of performance metric.
The value of the performance metric.
The name of the slice this metric was computed on. By default, assume this metric is not sliced.
The confidence interval of the metric.
No Additional PropertiesThe lower bound of the confidence interval.
The upper bound of the confidence interval.
A collection of graphics that represent various measurements.
No Additional PropertiesA description of this collection of graphics.
A collection of graphics.
No Additional ItemsThe name of the graphic.
The graphic (vector or raster). Base64 encoding must be specified for binary images.
No Additional PropertiesSpecifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents.
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
"text/plain"
"application/json"
"image/png"
Specifies the optional encoding the text is represented in.
| Name | Description |
|---|---|
| "base64" | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
What considerations should be taken into account regarding the model's construction, training, and application?
No Additional PropertiesWho are the intended users of the model?
No Additional ItemsWhat are the intended use cases of the model?
No Additional ItemsWhat are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?
No Additional ItemsWhat are the known tradeoffs in accuracy/performance of the model?
No Additional ItemsWhat are the ethical risks involved in the application of this model?
No Additional ItemsThe name of the risk.
Strategy used to address this risk.
What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?
No Additional PropertiesDescribes energy consumption information incurred for one or more component lifecycle activities.
No Additional ItemsDescribes energy consumption information incurred for the specified lifecycle activity.
No Additional PropertiesThe type of activity that is part of a machine learning model development or operational lifecycle.
| Name | Description |
|---|---|
| "design" | A model design including problem framing, goal definition and algorithm selection. |
| "data-collection" | Model data acquisition including search, selection and transfer. |
| "data-preparation" | Model data preparation including data cleaning, labeling and conversion. |
| "training" | Model building, training and generalized tuning. |
| "fine-tuning" | Refining a trained model to produce desired outputs for a given problem space. |
| "validation" | Model validation including model output evaluation and testing. |
| "deployment" | Explicit model deployment to a target hosting infrastructure. |
| "inference" | Generating an output response from a hosted model from a set of inputs. |
| "other" | A lifecycle activity type whose description does not match currently defined values. |
The provider(s) of the energy consumed by the associated model development lifecycle activity.
No Additional ItemsDescribes the physical provider of energy used for model development or operations.
No Additional PropertiesAn optional identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
A description of the energy provider.
The organization that provides energy.
No Additional PropertiesAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of the organization
"Example Inc."
The physical address (location) of the organization
No Additional PropertiesAn optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The country name or the two-letter ISO 3166-1 country code.
The region or state in the country.
"Texas"
The locality or city within the country.
"Austin"
The post office box number.
"901"
The postal code.
"78758"
The street address.
"100 Main Street"
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 ItemsAn optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The name of a contact
"Contact name"
The phone number of the contact.
"800-555-1212"
The energy source for the energy provider.
| Name | Description |
|---|---|
| "coal" | Energy produced by types of coal. |
| "oil" | Petroleum products (primarily crude oil and its derivative fuel oils). |
| "natural-gas" | Hydrocarbon gas liquids (HGL) that occur as gases at atmospheric pressure and as liquids under higher pressures including Natural gas (C5H12 and heavier), Ethane (C2H6), Propane (C3H8), etc. |
| "nuclear" | Energy produced from the cores of atoms (i.e., through nuclear fission or fusion). |
| "wind" | Energy produced from moving air. |
| "solar" | Energy produced from the sun (i.e., solar radiation). |
| "geothermal" | Energy produced from heat within the earth. |
| "hydropower" | Energy produced from flowing water. |
| "biofuel" | Liquid fuels produced from biomass feedstocks (i.e., organic materials such as plants or animals). |
| "unknown" | The energy source is unknown. |
| "other" | An energy source that is not listed. |
The energy provided by the energy source for an associated activity.
No Additional PropertiesQuantity of energy.
Unit of energy.
| Name | Description |
|---|---|
| "kWh" | Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h). |
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional ItemsExternal references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
No Additional PropertiesThe URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/
Must match regular expression:^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$An optional comment describing the external reference
Specifies the type of external reference.
| Name | Description |
|---|---|
| "vcs" | Version Control System |
| "issue-tracker" | Issue or defect tracking system, or an Application Lifecycle Management (ALM) system |
| "website" | Website |
| "advisories" | Security advisories |
| "bom" | Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc) |
| "mailing-list" | Mailing list or discussion group |
| "social" | Social media account |
| "chat" | Real-time chat platform |
| "documentation" | Documentation, guides, or how-to instructions |
| "support" | Community or commercial support |
| "source-distribution" | The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type. |
| "distribution" | Direct or repository download location |
| "distribution-intake" | The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary. |
| "license" | The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness. |
| "build-meta" | Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc) |
| "build-system" | Reference to an automated build system |
| "release-notes" | Reference to release notes |
| "security-contact" | Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT. |
| "model-card" | A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency. |
| "log" | A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations. |
| "configuration" | Parameters or settings that may be used by other components or services. |
| "evidence" | Information used to substantiate a claim. |
| "formulation" | Describes how a component or service was manufactured or deployed. |
| "attestation" | Human or machine-readable statements containing facts, evidence, or testimony. |
| "threat-model" | An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format. |
| "adversary-model" | The defined assumptions, goals, and capabilities of an adversary. |
| "risk-assessment" | Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk. |
| "vulnerability-assertion" | A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product. |
| "exploitability-statement" | A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization. |
| "pentest-report" | Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test. |
| "static-analysis-report" | SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code. |
| "dynamic-analysis-report" | Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations. |
| "runtime-analysis-report" | Report generated by analyzing the call stack of a running application. |
| "component-analysis-report" | Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis. |
| "maturity-report" | Report containing a formal assessment of an organization, business unit, or team against a maturity model. |
| "certification-report" | Industry, regulatory, or other certification from an accredited (if applicable) certification body. |
| "codified-infrastructure" | Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC). |
| "quality-metrics" | Report or system in which quality metrics can be obtained. |
| "poam" | Plans of Action and Milestones (POA&M) complement an "attestation" external reference. POA&M is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones". |
| "electronic-signature" | An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name. |
| "digital-signature" | A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification. |
| "rfc-9116" | Document that complies with RFC 9116 (A File Format to Aid in Security Vulnerability Disclosure) |
| "other" | Use this if no other types accurately describe the purpose of the external reference. |
The hashes of the external reference (if applicable).
No Additional ItemsThe algorithm that generated the hash value.
The value of the hash.
Must match regular expression:^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"3942447fac867ae5cdb3229b658f4d48"
The total energy cost associated with the model lifecycle activity.
No Additional PropertiesQuantity of energy.
Unit of energy.
| Name | Description |
|---|---|
| "kWh" | Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h). |
The CO2 cost (debit) equivalent to the total energy cost.
No Additional PropertiesQuantity of carbon dioxide (CO2).
Unit of carbon dioxide (CO2).
| Name | Description |
|---|---|
| "tCO2eq" | Tonnes (t) of carbon dioxide (CO2) equivalent (eq). |
The CO2 offset (credit) for the CO2 equivalent cost.
No Additional PropertiesQuantity of carbon dioxide (CO2).
Unit of carbon dioxide (CO2).
| Name | Description |
|---|---|
| "tCO2eq" | Tonnes (t) of carbon dioxide (CO2) equivalent (eq). |
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 ItemsProvides 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 PropertiesThe 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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?
No Additional ItemsInformation about the benefits and harms of the model to an identified at risk group.
No Additional PropertiesThe groups or individuals at risk of being systematically disadvantaged by the model.
Expected benefits to the identified groups.
Expected harms to the identified groups.
With respect to the benefits and harms outlined, please describe any mitigation strategy implemented.
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 ItemsProvides 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 PropertiesThe name of the property. Duplicate names are allowed, each potentially having a different value.
The value of the property.
This object SHOULD be specified for any component of type data and must not be specified for other component types.
An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.
Value SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Must be at least 1 characters long
The general theme or subject matter of the data being specified.
| Name | Description |
|---|---|
| "source-code" | Any type of code, code snippet, or data-as-code. |
| "configuration" | Parameters or settings that may be used by other components. |
| "dataset" | A collection of data. |
| "definition" | Data that can be used to create new instances of what the definition defines. |
| "other" | Any other type of data that does not fit into existing definitions. |
The name of the dataset.
The contents or references to the contents of the data being described.
No Additional PropertiesAn optional way to include textual or encoded data.
No Additional Properties