?um/p1-90`Location: /
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bomFormat | String | Required | 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 shall be "CycloneDX". |
| specVersion | String | Required | The version of the CycloneDX specification the BOM conforms to. |
| serialNumber | String | Optional | 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 shall conform to RFC 4122. Use of serial numbers is recommended. |
| version | Integer | Optional | 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'. |
| metadata | Object | Optional | Provides additional information about a BOM. |
| components | Array | Optional | A list of software and hardware components. |
| services | Array | Optional | A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services. |
| externalReferences | Array | Optional | 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. |
| dependencies | Array | Optional | Provides the ability to document dependency relationships including provided & implemented components. |
| compositions | Array | Optional | Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described. |
| vulnerabilities | Array | Optional | Vulnerabilities identified in components or services. |
| annotations | Array | Optional | Comments made by people, organizations, or tools about any object with a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike inventory information, annotations may contain opinions or commentary from various stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link and may optionally be signed. |
| formulation | Array | Optional | Describes the formulation of any referencable object within the BOM, including components, services, metadata, declarations, or the BOM itself. This may encompass how the object was created, assembled, deployed, tested, certified, or otherwise brought into its present form. Common examples include software build pipelines, deployment processes, AI/ML model training, cryptographic key generation or certification, and third-party audits. Processes are modelled using declared and observed formulas, composed of workflows, tasks, and individual steps. |
| declarations | Object | Optional | The list of declarations which describe the conformance to standards. Each declaration may include attestations, claims, and evidence. |
| definitions | Object | Optional | A collection of reusable objects that are defined and may be used elsewhere in the BOM. |
| citations | Array | Optional | A collection of attributions indicating which entity supplied information for specific fields within the BOM. |
| properties | Array | Optional | 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. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /bomFormat
Property: bomFormat (Required)
Type: String (enum)
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 shall be "CycloneDX".
Enumeration of possible values:Location: /specVersion
Property: specVersion (Required)
Type: String
The version of the CycloneDX specification the BOM conforms to.
1.7
Location: /serialNumber
Property: serialNumber (Optional)
Type: String
Pattern Constraint: ^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
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 shall conform to RFC 4122. Use of serial numbers is recommended.
urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79
Location: /version
Property: version (Optional)
Type: Integer
Minimum Value: 1
Default Value: 1
Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM should be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system should use the most recent version of the BOM. The default version is '1'.
1
Location: /metadata
Property: metadata (Optional)
Type: Object
Provides additional information about a BOM.
| Property | Type | Requirement | Description |
|---|---|---|---|
| timestamp | String | Optional | The date and time (timestamp) when the BOM was created. |
| lifecycles | Array | Optional | 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. |
| tools | Array | Optional | The tool(s) used in the creation, enrichment, and validation of the BOM. |
| manufacturer | Object | Optional | The organization that created the BOM. Manufacturer is common in BOMs created through automated processes. BOMs created through manual means may have @.authors instead. |
| authors | Array | Optional | 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. |
| component | Array | Optional | The component that the BOM describes. |
| manufacture | Object | Optional | [Deprecated] This will be removed in a future version. Use the @.component.manufacturer instead. The organization that manufactured the component that the BOM describes. |
| supplier | Object | Optional | 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. |
| licenses | Array | Optional | The licence information for the BOM document. This may be different from the licence(s) of the component(s) that the BOM describes. |
| properties | Array | Optional | 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. |
| distributionConstraints | Object | Optional | Conditions and constraints governing the sharing and distribution of the data or components described by this BOM. |
Location: /metadata/timestamp
Property: timestamp (Optional)
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the BOM was created.
Location: /metadata/lifecycles
Property: lifecycles (Optional)
Type: Array
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. Each item of this array shall be a Lifecycle object.
Location: /metadata/lifecycles/[]
Type: Object
The product lifecycle(s) that this BOM represents.
Shall be one of:
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| phase | String | Required | A pre-defined phase in the product lifecycle. |
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the lifecycle phase. |
| description | String | Optional | The description of the lifecycle phase. |
Location: /metadata/lifecycles/[]/phase
Property: phase (Required)
Type: String (enum)
A pre-defined phase in the product lifecycle.
| Value | 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. |
Location: /metadata/lifecycles/[]/name
Property: name (Required)
Type: String
The name of the lifecycle phase
Location: /metadata/lifecycles/[]/description
Property: description (Optional)
Type: String
The description of the lifecycle phase
Location: /metadata/tools
Property: tools (Optional)
The tool(s) used in the creation, enrichment, and validation of the BOM.
Shall be one of:
Type: Object
The tool(s) used in the creation, enrichment, and validation of the BOM.
| Property | Type | Requirement | Description |
|---|---|---|---|
| components | Array | Optional | A list of software and hardware components used as tools. Refer to the component definition at /components/[]. |
| services | Array | Optional | A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services. Refer to the service definition at /services/[]. |
Type: Array
[Deprecated] The tool(s) used in the creation, enrichment, and validation of the BOM.
Location: /metadata/tools/components
Property: components (Optional)
Type: Array
Uniqueness: All items shall be unique.
A list of software and hardware components used as tools. Each item of this array shall be a Component object.
Location: /metadata/tools/components/[]
Type: Object
Location: /metadata/tools/services
Property: services (Optional)
Type: Array
Uniqueness: All items shall be unique.
A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services. Each item of this array shall be a Service object.
Location: /metadata/tools/services/[]
Type: Object
Location: /metadata/tools
Property: tools
Type: Array
[Deprecated] The tool(s) used in the creation, enrichment, and validation of the BOM. Each item of this array shall be a Tool object.
Location: /metadata/tools/[]
Type: Object
[Deprecated] This will be removed in a future version. Use component or service instead. Information about the automated or manual tool used
| Property | Type | Requirement | Description |
|---|---|---|---|
| vendor | String | Optional | The name of the vendor who created the tool. |
| name | String | Optional | The name of the tool. |
| version | String | Optional | The version of the tool. |
| hashes | Array | Optional | The hashes of the tool (if applicable). |
| externalReferences | Array | Optional | 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. |
Location: /metadata/tools/[]/vendor
Type: String
The name of the vendor who created the tool
Location: /metadata/tools/[]/name
Type: String
The name of the tool
Location: /metadata/tools/[]/version
Type: String
The version of the tool
9.0.14
v1.33.7
7.0.0-M1
2.0pre1
1.0.0-beta1
0.8.15
Location: /metadata/tools/[]/hashes
Property: hashes (Optional)
Type: Array
The hashes of the tool (if applicable). Each item of this array shall be a Hash object.
Location: /metadata/tools/[]/hashes/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| alg | String | Required | The algorithm that generated the hash value. |
| content | String | Required | The value of the hash. |
Location: /metadata/tools/[]/hashes/[]/alg
Type: String (enum)
The algorithm that generated the hash value.
Enumeration of possible values:Location: /metadata/tools/[]/hashes/[]/content
Type: String
Pattern Constraint: ^([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})$
The value of the hash.
3942447fac867ae5cdb3229b658f4d48
Location: /metadata/tools/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /metadata/tools/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
Location: /metadata/manufacturer
Property: manufacturer (Optional)
Type: Object
The organization that created the BOM. Manufacturer is common in BOMs created through automated processes. BOMs created through manual means may have @.authors instead.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /metadata/manufacturer/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/manufacturer/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /metadata/manufacturer/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /metadata/manufacturer/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/manufacturer/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /metadata/manufacturer/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /metadata/manufacturer/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /metadata/manufacturer/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /metadata/manufacturer/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /metadata/manufacturer/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /metadata/manufacturer/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /metadata/manufacturer/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /metadata/manufacturer/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /metadata/manufacturer/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/manufacturer/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /metadata/manufacturer/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /metadata/manufacturer/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /metadata/authors
Property: authors (Optional)
Type: Array
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. Each item of this array shall be an Organizational Person object.
Location: /metadata/authors/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /metadata/authors/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/authors/[]/name
Type: String
The name of a contact
Contact name
Location: /metadata/authors/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /metadata/authors/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /metadata/component
Property: component (Optional)
Type: Object
The component that the BOM describes.
Location: /metadata/manufacture
Property: manufacture (Optional)
Type: Object
[Deprecated] This will be removed in a future version. Use the @.component.manufacturer instead. The organization that manufactured the component that the BOM describes.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /metadata/manufacture/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/manufacture/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /metadata/manufacture/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /metadata/manufacture/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/manufacture/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /metadata/manufacture/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /metadata/manufacture/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /metadata/manufacture/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /metadata/manufacture/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /metadata/manufacture/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /metadata/manufacture/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /metadata/manufacture/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /metadata/manufacture/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /metadata/manufacture/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/manufacture/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /metadata/manufacture/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /metadata/manufacture/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /metadata/supplier
Property: supplier (Optional)
Type: Object
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.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /metadata/supplier/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/supplier/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /metadata/supplier/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /metadata/supplier/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/supplier/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /metadata/supplier/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /metadata/supplier/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /metadata/supplier/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /metadata/supplier/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /metadata/supplier/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /metadata/supplier/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /metadata/supplier/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /metadata/supplier/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /metadata/supplier/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /metadata/supplier/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /metadata/supplier/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /metadata/supplier/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /metadata/licenses
Property: licenses (Optional)
Type: Array
The licence information for the BOM document. This may be different from the licence(s) of the component(s) that the BOM describes.
Location: /metadata/licenses/[]
Location: /metadata/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /metadata/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /metadata/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /metadata/properties/[]/value
Type: String
The value of the property.
Location: /metadata/distributionConstraints
Property: distributionConstraints (Optional)
Type: Object
Conditions and constraints governing the sharing and distribution of the data or components described by this BOM.
| Property | Type | Requirement | Description |
|---|---|---|---|
| tlp | String | Optional | The Traffic Light Protocol (TLP) classification that controls the sharing and distribution of the data that the BOM describes. |
Location: /metadata/distributionConstraints/tlp
Property: tlp (Optional)
Type: String (enum)
Default Value: CLEAR
The Traffic Light Protocol (TLP) classification that controls the sharing and distribution of the data that the BOM describes.
| Value | Description |
|---|---|
| CLEAR | The information is not subject to any restrictions as regards the sharing. |
| GREEN | The information is subject to limited disclosure, and recipients can share it within their community but not via publicly accessible channels. |
| AMBER | The information is subject to limited disclosure, and recipients can only share it on a need-to-know basis within their organization and with clients. |
| AMBER_AND_STRICT | The information is subject to limited disclosure, and recipients can only share it on a need-to-know basis within their organization. |
| RED | The information is subject to restricted distribution to individual recipients only and shall not be shared. |
Location: /components
Property: components (Optional)
Type: Array
Uniqueness: All items shall be unique.
A list of software and hardware components. Each item of this array shall be a Component object.
Location: /components/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Required | Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component. |
| mime-type | String | Optional | The 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. |
| bom-ref | String | Optional | An identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| supplier | Object | Optional | The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager. |
| manufacturer | Object | Optional | The organization that created the component. Manufacturer is common in components created through automated processes. Components created through manual means may have @.authors instead. |
| authors | Array | Optional | 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. |
| author | String | Optional | [Deprecated] This will be removed in a future version. Use @.authors or @.manufacturer instead. The person(s) or organization(s) that authored the component. |
| publisher | String | Optional | The person(s) or organization(s) that published the component. |
| group | String | Optional | 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. |
| name | String | Required | The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery. |
| version | String | Optional | The component version. The version should ideally comply with semantic versioning but is not enforced. Shall be used exclusively, either 'version' or 'versionRange', but not both. |
| versionRange | String | Optional | For an external component, this specifies the accepted version range. The value shall adhere to the Package URL Version Range syntax (vers), as defined at https://github.com/package-url/vers-spec May only be used if .isExternal is set to true. Shall be used exclusively, either 'version' or 'versionRange', but not both. |
| isExternal | Boolean | Optional | Determine whether this component is external. An external component is one that is not part of an assembly, but is expected to be provided by the environment, regardless of the component's .scope. This setting can be useful for distinguishing which components are bundled with the product and which can be relied upon to be present in the deployment environment. This may be set to true for runtime components only. For $.metadata.component, it shall be set to false. |
| description | String | Optional | Specifies a description for the component. |
| scope | String | Optional | Specifies the scope of the component. If scope is not specified, 'required' scope should be assumed by the consumer of the BOM. |
| hashes | Array | Optional | The hashes of the component. |
| licenses | Array | Optional | A list of SPDX licenses and/or named licenses and/or SPDX Licence Expression. |
| copyright | String | Optional | A copyright notice informing users of the underlying claims to copyright ownership in a published work. |
| patentAssertions | Array | Optional | A list of assertions made regarding patents associated with this component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents. |
| cpe | String | Optional | Asserts the identity of the component using CPE. The CPE shall 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. |
| purl | String | Optional | Asserts the identity of the component using package-url (purl). The purl, if specified, shall 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. |
| omniborId | Array | Optional | Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, shall 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. |
| swhid | Array | Optional | Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, shall 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. |
| swid | Object | Optional | 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. |
| modified | Boolean | Optional | [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. |
| pedigree | Object | Optional | 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. |
| externalReferences | Array | Optional | 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. |
| components | Array | Optional | 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. |
| evidence | Object | Optional | Provides the ability to document evidence collected through various forms of extraction or analysis. |
| releaseNotes | Object | Optional | Specifies release notes. |
| modelCard | Object | Optional | 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 shall not be specified for other component types. |
| data | Array | Optional | This object should be specified for any component of type data and shall not be specified for other component types. |
| cryptoProperties | Object | Optional | 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. |
| properties | Array | Optional | 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. |
| tags | Array | Optional | 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. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /components/[]/type
Type: String (enum)
Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.
library
| Value | 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 that interprets or executes software. This may include runtimes such as those that execute bytecode, just-in-time compilers, interpreters, 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. |
Location: /components/[]/mime-type
Type: String
Pattern Constraint: ^[-+a-z0-9.]+/[-+a-z0-9.]+$
The 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.
image/jpeg
Location: /components/[]/bom-ref
Type: String
An identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/supplier
Type: Object
The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/supplier/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/supplier/name
Type: String
The name of the organization
Example Inc.
Location: /components/[]/supplier/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/supplier/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/supplier/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/supplier/address/region
Type: String
The region or state in the country.
Texas
Location: /components/[]/supplier/address/locality
Type: String
The locality or city within the country.
Austin
Location: /components/[]/supplier/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /components/[]/supplier/address/postalCode
Type: String
The postal code.
78758
Location: /components/[]/supplier/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /components/[]/supplier/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/supplier/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/supplier/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/supplier/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/supplier/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/supplier/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/supplier/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/manufacturer
Type: Object
The organization that created the component. Manufacturer is common in components created through automated processes. Components created through manual means may have @.authors instead.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/manufacturer/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/manufacturer/name
Type: String
The name of the organization
Example Inc.
Location: /components/[]/manufacturer/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/manufacturer/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/manufacturer/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/manufacturer/address/region
Type: String
The region or state in the country.
Texas
Location: /components/[]/manufacturer/address/locality
Type: String
The locality or city within the country.
Austin
Location: /components/[]/manufacturer/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /components/[]/manufacturer/address/postalCode
Type: String
The postal code.
78758
Location: /components/[]/manufacturer/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /components/[]/manufacturer/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/manufacturer/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/manufacturer/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/manufacturer/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/manufacturer/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/manufacturer/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/manufacturer/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/authors
Property: authors (Optional)
Type: Array
The person(s) who created the component. Authors are common in components created through manual processes. Components created through automated means may have @.manufacturer instead. Each item of this array shall be an Organizational Person object.
Location: /components/[]/authors/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/authors/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/authors/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/authors/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/authors/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/author
Type: String
[Deprecated] This will be removed in a future version. Use @.authors or @.manufacturer instead. The person(s) or organization(s) that authored the component
Acme Inc
Location: /components/[]/publisher
Type: String
The person(s) or organization(s) that published the component
Acme Inc
Location: /components/[]/group
Type: String
The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.
com.acme
Location: /components/[]/name
Type: String
The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery
tomcat-catalina
Location: /components/[]/version
Type: String
The component version. The version should ideally comply with semantic versioning but is not enforced. Shall be used exclusively, either 'version' or 'versionRange', but not both.
9.0.14
v1.33.7
7.0.0-M1
2.0pre1
1.0.0-beta1
0.8.15
Location: /components/[]/versionRange
Type: String
For an external component, this specifies the accepted version range. The value shall adhere to the Package URL Version Range syntax (vers), as defined at https://github.com/package-url/vers-spec May only be used if .isExternal is set to true. Shall be used exclusively, either 'version' or 'versionRange', but not both.
vers:cargo/9.0.14
vers:npm/1.2.3|>=2.0.0|<5.0.0
vers:pypi/0.0.0|0.0.1|0.0.2|0.0.3|1.0|2.0pre1
vers:tomee/>=1.0.0-beta1|<=1.7.5|>=7.0.0-M1|<=7.0.7|>=7.1.0|<=7.1.2|>=8.0.0-M1|<=8.0.1
vers:gem/>=2.2.0|!= 2.2.1|<2.3.0
Location: /components/[]/isExternal
Type: Boolean
Determine whether this component is external. An external component is one that is not part of an assembly, but is expected to be provided by the environment, regardless of the component's .scope. This setting can be useful for distinguishing which components are bundled with the product and which can be relied upon to be present in the deployment environment. This may be set to true for runtime components only. For $.metadata.component, it shall be set to false.
Location: /components/[]/description
Type: String
Specifies a description for the component
Location: /components/[]/scope
Type: String (enum)
Default Value: required
Specifies the scope of the component. If scope is not specified, 'required' scope should be assumed by the consumer of the BOM.
| Value | 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 shall 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. |
Location: /components/[]/hashes
Property: hashes (Optional)
Type: Array
The hashes of the component. Each item of this array shall be a Hash object.
Location: /components/[]/hashes/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| alg | String | Required | The algorithm that generated the hash value. |
| content | String | Required | The value of the hash. |
Location: /components/[]/hashes/[]/alg
Type: String (enum)
The algorithm that generated the hash value.
Enumeration of possible values:Location: /components/[]/hashes/[]/content
Type: String
Pattern Constraint: ^([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})$
The value of the hash.
3942447fac867ae5cdb3229b658f4d48
Location: /components/[]/licenses
Property: licenses (Optional)
Type: Array
A list of SPDX licenses and/or named licenses and/or SPDX Licence Expression.
Location: /components/[]/licenses/[]
Shall be one of:
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| license | Object | Required | Specifies the details and attributes related to a software licence. It can either include a valid SPDX licence identifier or a named licence, along with additional properties such as licence acknowledgment, comprehensive commercial licensing information, and the full text of the licence. |
Type: Object
Specifies the details and attributes related to a software licence. It shall be a valid SPDX licence expression, along with additional properties such as licence acknowledgment.
| Property | Type | Requirement | Description |
|---|---|---|---|
| expression | String | Required | A valid SPDX licence expression. Refer to https://spdx.org/specifications for syntax requirements. |
| expressionDetails | Array | Optional | Details for parts of the expression. |
| acknowledgement | String | Optional | 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 licence. |
| bom-ref | String | Optional | An identifier which can be used to reference the licence elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| licensing | Object | Optional | Licensing details describing the licensor/licensee, licence type, renewal and expiration dates, and other important metadata. |
| properties | Array | Optional | 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. |
Location: /components/[]/licenses/[]/license
Property: license (Required)
Type: Object
Specifies the details and attributes related to a software licence. It can either include a valid SPDX licence identifier or a named licence, along with additional properties such as licence acknowledgment, comprehensive commercial licensing information, and the full text of the licence.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the licence elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| id | String | Optional | A valid SPDX licence identifier. If specified, this value shall be one of the enumeration of valid SPDX licence identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX licence list. |
| name | String | Optional | The name of the licence. This may include the name of a commercial or proprietary licence or an open source licence that may not be defined by SPDX. |
| acknowledgement | String | Optional | 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 licence. |
| text | Object | Optional | A way to include the textual content of a licence. |
| url | String | Optional | The URL to the licence file. If specified, a 'licence' externalReference should also be specified for completeness. |
| licensing | Object | Optional | Licensing details describing the licensor/licensee, licence type, renewal and expiration dates, and other important metadata. |
| properties | Array | Optional | 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. |
Location: /components/[]/licenses/[]/license/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the licence elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/id
Property: id (Optional)
Type: String
A valid SPDX licence identifier. If specified, this value shall be one of the enumeration of valid SPDX licence identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX licence list.
Apache-2.0
Location: /components/[]/licenses/[]/license/name
Property: name (Optional)
Type: String
The name of the licence. This may include the name of a commercial or proprietary licence or an open source licence that may not be defined by SPDX.
Acme Software License
Location: /components/[]/licenses/[]/license/acknowledgement
Property: acknowledgement (Optional)
Type: String (enum)
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 licence.
| Value | Description |
|---|---|
| declared | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| concluded | Concluded licenses are verified and confirmed. |
Location: /components/[]/licenses/[]/license/text
Property: text (Optional)
Type: Object
A way to include the textual content of a licence.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/licenses/[]/license/text/contentType
Property: contentType (Optional)
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/licenses/[]/license/text/encoding
Property: encoding (Optional)
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/licenses/[]/license/text/content
Property: content (Required)
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/licenses/[]/license/url
Property: url (Optional)
Type: String
Format: iri-reference as specified in RFC 3987
The URL to the licence file. If specified, a 'licence' externalReference should also be specified for completeness
https://www.apache.org/licenses/LICENSE-2.0.txt
Location: /components/[]/licenses/[]/license/licensing
Property: licensing (Optional)
Type: Object
Licensing details describing the licensor/licensee, licence type, renewal and expiration dates, and other important metadata
| Property | Type | Requirement | Description |
|---|---|---|---|
| altIds | Array | Optional | Licence identifiers that may be used to manage licenses and their lifecycle. |
| licensor | Array | Optional | The individual or organization that grants a licence to another individual or organization. |
| licensee | Array | Optional | The individual or organization for which a licence was granted to. |
| purchaser | Array | Optional | The individual or organization that purchased the licence. |
| purchaseOrder | String | Optional | The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase. |
| licenseTypes | Array | Optional | The type of licence(s) that was granted to the licensee. |
| lastRenewal | String | Optional | The timestamp indicating when the licence 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 licence was last renewed. |
| expiration | String | Optional | The timestamp indicating when the current licence expires (if applicable). |
Location: /components/[]/licenses/[]/license/licensing/altIds
Property: altIds (Optional)
Type: Array (of String)
Licence identifiers that may be used to manage licenses and their lifecycle Each item of this array shall be a string.
Location: /components/[]/licenses/[]/license/licensing/licensor
Property: licensor (Optional)
Type: Object
The individual or organization that grants a licence to another individual or organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that granted the licence. |
| individual | Object | Optional | The individual, not associated with an organization, that granted the licence. |
Location: /components/[]/licenses/[]/license/licensing/licensor/organization
Property: organization (Optional)
Type: Object
The organization that granted the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/license/licensing/licensor/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/license/licensing/licensor/individual
Property: individual (Optional)
Type: Object
The individual, not associated with an organization, that granted the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/license/licensing/licensor/individual/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/licensor/individual/name
Property: name (Optional)
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/license/licensing/licensor/individual/email
Property: email (Optional)
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/license/licensing/licensor/individual/phone
Property: phone (Optional)
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/license/licensing/licensee
Property: licensee (Optional)
Type: Object
The individual or organization for which a licence was granted to
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that was granted the licence. |
| individual | Object | Optional | The individual, not associated with an organization, that was granted the licence. |
Location: /components/[]/licenses/[]/license/licensing/licensee/organization
Property: organization (Optional)
Type: Object
The organization that was granted the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/license/licensing/licensee/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/license/licensing/licensee/individual
Property: individual (Optional)
Type: Object
The individual, not associated with an organization, that was granted the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/license/licensing/licensee/individual/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/licensee/individual/name
Property: name (Optional)
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/license/licensing/licensee/individual/email
Property: email (Optional)
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/license/licensing/licensee/individual/phone
Property: phone (Optional)
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/license/licensing/purchaser
Property: purchaser (Optional)
Type: Object
The individual or organization that purchased the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that purchased the licence. |
| individual | Object | Optional | The individual, not associated with an organization, that purchased the licence. |
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization
Property: organization (Optional)
Type: Object
The organization that purchased the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/license/licensing/purchaser/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/license/licensing/purchaser/individual
Property: individual (Optional)
Type: Object
The individual, not associated with an organization, that purchased the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/license/licensing/purchaser/individual/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/license/licensing/purchaser/individual/name
Property: name (Optional)
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/license/licensing/purchaser/individual/email
Property: email (Optional)
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/license/licensing/purchaser/individual/phone
Property: phone (Optional)
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/license/licensing/purchaseOrder
Property: purchaseOrder (Optional)
Type: String
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
Location: /components/[]/licenses/[]/license/licensing/licenseTypes
Property: licenseTypes (Optional)
Type: Array (of String) (enum)
The type of licence(s) that was granted to the licensee. Each item of this array shall be a string.
| Value | Description |
|---|---|
| academic | A licence that grants use of software solely for the purpose of education or research. |
| appliance | A licence covering use of software embedded in a specific piece of hardware. |
| client-access | A Client Access Licence (CAL) allows client computers to access services provided by server software. |
| concurrent-user | A Concurrent User licence (aka floating licence) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| core-points | A licence where the core of a computer's processor is assigned a specific number of points. |
| custom-metric | A licence for which consumption is measured by non-standard metrics. |
| device | A licence that covers a defined number of installations on computers and other types of devices. |
| evaluation | A licence that grants permission to install and use software for trial purposes. |
| named-user | A licence that grants access to the software to one or more pre-defined users. |
| node-locked | A licence that grants access to the software on one or more pre-defined computers or devices. |
| oem | An Original Equipment Manufacturer licence that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| perpetual | A licence where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| processor-points | A licence where each installation consumes points per processor. |
| subscription | A licence where the licensee pays a fee to use the software or service. |
| user | A licence that grants access to the software or service by a specified number of users. |
| other | Another licence type. |
Location: /components/[]/licenses/[]/license/licensing/lastRenewal
Property: lastRenewal (Optional)
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The timestamp indicating when the licence 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 licence was last renewed.
Location: /components/[]/licenses/[]/license/licensing/expiration
Property: expiration (Optional)
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The timestamp indicating when the current licence expires (if applicable).
Location: /components/[]/licenses/[]/license/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /components/[]/licenses/[]/license/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /components/[]/licenses/[]/license/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /components/[]/licenses/[]/license/properties/[]/value
Type: String
The value of the property.
Location: /components/[]/licenses/[]/expression
Property: expression (Required)
Type: String
A valid SPDX licence 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
Location: /components/[]/licenses/[]/expressionDetails
Property: expressionDetails (Optional)
Type: Array
Details for parts of the expression.
Location: /components/[]/licenses/[]/expressionDetails/[]
Type: Object
This document specifies the details and attributes related to a software licence identifier. An SPDX expression may be a compound of licence identifiers. The license_identifier property serves as the key that identifies each record. Note that this key is not required to be unique, as the same licence identifier could apply to multiple, different but similar licence details, texts, etc.
| Property | Type | Requirement | Description |
|---|---|---|---|
| licenseIdentifier | String | Required | The valid SPDX licence identifier. Refer to https://spdx.org/specifications for syntax requirements. This property serves as the primary key, which uniquely identifies each record. |
| bom-ref | String | Optional | An identifier which can be used to reference the licence elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| text | Object | Optional | A way to include the textual content of the licence. |
| url | String | Optional | The URL to the licence file. If specified, a 'licence' externalReference should also be specified for completeness. |
Location: /components/[]/licenses/[]/expressionDetails/[]/licenseIdentifier
Type: String
The valid SPDX licence identifier. Refer to https://spdx.org/specifications for syntax requirements. This property serves as the primary key, which uniquely identifies each record.
Apache-2.0
GPL-3.0-only WITH Classpath-exception-2.0
LicenseRef-my-custom-license
Location: /components/[]/licenses/[]/expressionDetails/[]/bom-ref
Type: String
An identifier which can be used to reference the licence elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/expressionDetails/[]/text
Type: Object
A way to include the textual content of the licence.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/licenses/[]/expressionDetails/[]/text/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/licenses/[]/expressionDetails/[]/text/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/licenses/[]/expressionDetails/[]/text/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/licenses/[]/expressionDetails/[]/url
Type: String
Format: iri-reference as specified in RFC 3987
The URL to the licence file. If specified, a 'licence' externalReference should also be specified for completeness
https://www.apache.org/licenses/LICENSE-2.0.txt
Location: /components/[]/licenses/[]/acknowledgement
Property: acknowledgement (Optional)
Type: String (enum)
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 licence.
| Value | Description |
|---|---|
| declared | Declared licenses represent the initial intentions of authors regarding the licensing terms of their code. |
| concluded | Concluded licenses are verified and confirmed. |
Location: /components/[]/licenses/[]/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the licence elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing
Property: licensing (Optional)
Type: Object
Licensing details describing the licensor/licensee, licence type, renewal and expiration dates, and other important metadata
| Property | Type | Requirement | Description |
|---|---|---|---|
| altIds | Array | Optional | Licence identifiers that may be used to manage licenses and their lifecycle. |
| licensor | Array | Optional | The individual or organization that grants a licence to another individual or organization. |
| licensee | Array | Optional | The individual or organization for which a licence was granted to. |
| purchaser | Array | Optional | The individual or organization that purchased the licence. |
| purchaseOrder | String | Optional | The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase. |
| licenseTypes | Array | Optional | The type of licence(s) that was granted to the licensee. |
| lastRenewal | String | Optional | The timestamp indicating when the licence 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 licence was last renewed. |
| expiration | String | Optional | The timestamp indicating when the current licence expires (if applicable). |
Location: /components/[]/licenses/[]/licensing/altIds
Property: altIds (Optional)
Type: Array (of String)
Licence identifiers that may be used to manage licenses and their lifecycle Each item of this array shall be a string.
Location: /components/[]/licenses/[]/licensing/licensor
Property: licensor (Optional)
Type: Object
The individual or organization that grants a licence to another individual or organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that granted the licence. |
| individual | Object | Optional | The individual, not associated with an organization, that granted the licence. |
Location: /components/[]/licenses/[]/licensing/licensor/organization
Property: organization (Optional)
Type: Object
The organization that granted the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/licenses/[]/licensing/licensor/organization/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/licensor/organization/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /components/[]/licenses/[]/licensing/licensor/organization/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/licenses/[]/licensing/licensor/organization/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/licensor/organization/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/licenses/[]/licensing/licensor/organization/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /components/[]/licenses/[]/licensing/licensor/organization/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /components/[]/licenses/[]/licensing/licensor/organization/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /components/[]/licenses/[]/licensing/licensor/organization/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /components/[]/licenses/[]/licensing/licensor/organization/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /components/[]/licenses/[]/licensing/licensor/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/licenses/[]/licensing/licensor/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/licenses/[]/licensing/licensor/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/licensing/licensor/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/licensor/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/licensing/licensor/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/licensing/licensor/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/licensing/licensor/individual
Property: individual (Optional)
Type: Object
The individual, not associated with an organization, that granted the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/licensing/licensor/individual/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/licensor/individual/name
Property: name (Optional)
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/licensing/licensor/individual/email
Property: email (Optional)
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/licensing/licensor/individual/phone
Property: phone (Optional)
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/licensing/licensee
Property: licensee (Optional)
Type: Object
The individual or organization for which a licence was granted to
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that was granted the licence. |
| individual | Object | Optional | The individual, not associated with an organization, that was granted the licence. |
Location: /components/[]/licenses/[]/licensing/licensee/organization
Property: organization (Optional)
Type: Object
The organization that was granted the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/licenses/[]/licensing/licensee/organization/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/licensee/organization/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /components/[]/licenses/[]/licensing/licensee/organization/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/licenses/[]/licensing/licensee/organization/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/licensee/organization/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/licenses/[]/licensing/licensee/organization/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /components/[]/licenses/[]/licensing/licensee/organization/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /components/[]/licenses/[]/licensing/licensee/organization/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /components/[]/licenses/[]/licensing/licensee/organization/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /components/[]/licenses/[]/licensing/licensee/organization/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /components/[]/licenses/[]/licensing/licensee/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/licenses/[]/licensing/licensee/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/licenses/[]/licensing/licensee/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/licensing/licensee/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/licensee/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/licensing/licensee/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/licensing/licensee/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/licensing/licensee/individual
Property: individual (Optional)
Type: Object
The individual, not associated with an organization, that was granted the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/licensing/licensee/individual/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/licensee/individual/name
Property: name (Optional)
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/licensing/licensee/individual/email
Property: email (Optional)
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/licensing/licensee/individual/phone
Property: phone (Optional)
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/licensing/purchaser
Property: purchaser (Optional)
Type: Object
The individual or organization that purchased the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that purchased the licence. |
| individual | Object | Optional | The individual, not associated with an organization, that purchased the licence. |
Location: /components/[]/licenses/[]/licensing/purchaser/organization
Property: organization (Optional)
Type: Object
The organization that purchased the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/licenses/[]/licensing/purchaser/organization/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/purchaser/organization/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /components/[]/licenses/[]/licensing/purchaser/organization/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/licenses/[]/licensing/purchaser/organization/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/purchaser/organization/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/licenses/[]/licensing/purchaser/organization/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /components/[]/licenses/[]/licensing/purchaser/organization/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /components/[]/licenses/[]/licensing/purchaser/organization/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /components/[]/licenses/[]/licensing/purchaser/organization/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /components/[]/licenses/[]/licensing/purchaser/organization/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /components/[]/licenses/[]/licensing/purchaser/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/licenses/[]/licensing/purchaser/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/licenses/[]/licensing/purchaser/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/licensing/purchaser/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/purchaser/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/licensing/purchaser/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/licensing/purchaser/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/licensing/purchaser/individual
Property: individual (Optional)
Type: Object
The individual, not associated with an organization, that purchased the licence
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/licenses/[]/licensing/purchaser/individual/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/licenses/[]/licensing/purchaser/individual/name
Property: name (Optional)
Type: String
The name of a contact
Contact name
Location: /components/[]/licenses/[]/licensing/purchaser/individual/email
Property: email (Optional)
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/licenses/[]/licensing/purchaser/individual/phone
Property: phone (Optional)
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/licenses/[]/licensing/purchaseOrder
Property: purchaseOrder (Optional)
Type: String
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
Location: /components/[]/licenses/[]/licensing/licenseTypes
Property: licenseTypes (Optional)
Type: Array (of String) (enum)
The type of licence(s) that was granted to the licensee. Each item of this array shall be a string.
| Value | Description |
|---|---|
| academic | A licence that grants use of software solely for the purpose of education or research. |
| appliance | A licence covering use of software embedded in a specific piece of hardware. |
| client-access | A Client Access Licence (CAL) allows client computers to access services provided by server software. |
| concurrent-user | A Concurrent User licence (aka floating licence) limits the number of licenses for a software application and licenses are shared among a larger number of users. |
| core-points | A licence where the core of a computer's processor is assigned a specific number of points. |
| custom-metric | A licence for which consumption is measured by non-standard metrics. |
| device | A licence that covers a defined number of installations on computers and other types of devices. |
| evaluation | A licence that grants permission to install and use software for trial purposes. |
| named-user | A licence that grants access to the software to one or more pre-defined users. |
| node-locked | A licence that grants access to the software on one or more pre-defined computers or devices. |
| oem | An Original Equipment Manufacturer licence that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware. |
| perpetual | A licence where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely. |
| processor-points | A licence where each installation consumes points per processor. |
| subscription | A licence where the licensee pays a fee to use the software or service. |
| user | A licence that grants access to the software or service by a specified number of users. |
| other | Another licence type. |
Location: /components/[]/licenses/[]/licensing/lastRenewal
Property: lastRenewal (Optional)
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The timestamp indicating when the licence 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 licence was last renewed.
Location: /components/[]/licenses/[]/licensing/expiration
Property: expiration (Optional)
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The timestamp indicating when the current licence expires (if applicable).
Location: /components/[]/licenses/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /components/[]/licenses/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /components/[]/licenses/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /components/[]/licenses/[]/properties/[]/value
Type: String
The value of the property.
Location: /components/[]/copyright
Type: String
A copyright notice informing users of the underlying claims to copyright ownership in a published work.
Acme Inc
Location: /components/[]/patentAssertions
Property: patentAssertions (Optional)
Type: Array
A list of assertions made regarding patents associated with this component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents. Each item of this array shall be a Patent Assertion object.
Location: /components/[]/patentAssertions/[]
Type: Object
An assertion linking a patent or patent family to this component or service.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | A reference to the patent or patent family object within the BOM. This shall match the bom-ref of a patent or patentFamily object. |
| assertionType | String | Required | The type of assertion being made about the patent or patent family. Examples include ownership, licensing, and standards inclusion. |
| patentRefs | Array | Optional | A list of BOM references (bom-ref) linking to patents or patent families associated with this assertion. |
| asserter | Array | Required | undefined. |
| notes | String | Optional | Additional notes or clarifications regarding the assertion, if necessary. For example, geographical restrictions, duration, or limitations of a licence. |
Location: /components/[]/patentAssertions/[]/bom-ref
Type: String
A reference to the patent or patent family object within the BOM. This shall match the bom-ref of a patent or patentFamily object.
Location: /components/[]/patentAssertions/[]/assertionType
Type: String (enum)
The type of assertion being made about the patent or patent family. Examples include ownership, licensing, and standards inclusion.
| Value | Description |
|---|---|
| ownership | The manufacturer asserts ownership of the patent or patent family. |
| license | The manufacturer asserts they have a licence to use the patent or patent family. |
| third-party-claim | A third party has asserted a claim or potential infringement against the manufacturer’s component or service. |
| standards-inclusion | The patent is part of a standard essential patent (SEP) portfolio relevant to the component or service. |
| prior-art | The manufacturer asserts the patent or patent family as prior art that invalidates another patent or claim. |
| exclusive-rights | The manufacturer asserts exclusive rights granted through a licensing agreement. |
| non-assertion | The manufacturer asserts they will not enforce the patent or patent family against certain uses or users. |
| research-or-evaluation | The patent or patent family is being used under a research or evaluation licence. |
Location: /components/[]/patentAssertions/[]/patentRefs
Property: patentRefs (Optional)
Type: Array (of String)
A list of BOM references (bom-ref) linking to patents or patent families associated with this assertion. Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. Each item of this array shall be a string.
Location: /components/[]/patentAssertions/[]/asserter
Shall be one of:
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Type: String
A reference to a previously defined organizationalContact or organizationalEntity object in the BOM. The value shall be a valid bom-ref pointing to one of these objects.
Location: /components/[]/patentAssertions/[]/asserter/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/patentAssertions/[]/asserter/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /components/[]/patentAssertions/[]/asserter/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/patentAssertions/[]/asserter/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/patentAssertions/[]/asserter/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/patentAssertions/[]/asserter/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /components/[]/patentAssertions/[]/asserter/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /components/[]/patentAssertions/[]/asserter/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /components/[]/patentAssertions/[]/asserter/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /components/[]/patentAssertions/[]/asserter/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /components/[]/patentAssertions/[]/asserter/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/patentAssertions/[]/asserter/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/patentAssertions/[]/asserter/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/patentAssertions/[]/asserter/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/patentAssertions/[]/asserter/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/patentAssertions/[]/asserter/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/patentAssertions/[]/asserter/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/patentAssertions/[]/asserter/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/patentAssertions/[]/asserter/name
Property: name (Optional)
Type: String
The name of a contact
Contact name
Location: /components/[]/patentAssertions/[]/asserter/email
Property: email (Optional)
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/patentAssertions/[]/asserter/phone
Property: phone (Optional)
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/patentAssertions/[]/notes
Type: String
Additional notes or clarifications regarding the assertion, if necessary. For example, geographical restrictions, duration, or limitations of a licence.
Location: /components/[]/cpe
Type: String
Asserts the identity of the component using CPE. The CPE shall 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:-:*:*:*:*:*:*:*
Location: /components/[]/purl
Type: String
Asserts the identity of the component using package-url (purl). The purl, if specified, shall 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/tomcat-catalina@9.0.14?packaging=jar
Location: /components/[]/omniborId
Property: omniborId (Optional)
Type: Array (of String)
Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, shall 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. Each item of this array shall be a string.
gitoid:blob:sha1:a94a8fe5ccb19ba61c4c0873d391e987982fbbd3
gitoid:blob:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
Location: /components/[]/swhid
Property: swhid (Optional)
Type: Array (of String)
Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, shall 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. Each item of this array shall be a string.
swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2
Location: /components/[]/swid
Type: Object
Asserts the identity of the component using ISO-IEC 19770-2 Software Identification (SWID) Tags. Refer to @.evidence.identity to optionally provide evidence that substantiates the assertion of the component's identity.
| Property | Type | Requirement | Description |
|---|---|---|---|
| tagId | String | Required | Maps to the tagId of a SoftwareIdentity. |
| name | String | Required | Maps to the name of a SoftwareIdentity. |
| version | String | Optional | Maps to the version of a SoftwareIdentity. |
| tagVersion | Integer | Optional | Maps to the tagVersion of a SoftwareIdentity. |
| patch | Boolean | Optional | Maps to the patch of a SoftwareIdentity. |
| text | Object | Optional | Specifies the metadata and content of the SWID tag. |
| url | String | Optional | The URL to the SWID file. |
Location: /components/[]/swid/tagId
Type: String
Maps to the tagId of a SoftwareIdentity.
Location: /components/[]/swid/name
Type: String
Maps to the name of a SoftwareIdentity.
Location: /components/[]/swid/version
Type: String
Default Value: 0.0
Maps to the version of a SoftwareIdentity.
Location: /components/[]/swid/tagVersion
Type: Integer
Maps to the tagVersion of a SoftwareIdentity.
Location: /components/[]/swid/patch
Type: Boolean
Maps to the patch of a SoftwareIdentity.
Location: /components/[]/swid/text
Type: Object
Specifies the metadata and content of the SWID tag.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/swid/text/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/swid/text/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/swid/text/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/swid/url
Type: String
Format: iri-reference as specified in RFC 3987
The URL to the SWID file.
Location: /components/[]/modified
Type: Boolean
[Deprecated] This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original.
Location: /components/[]/pedigree
Type: Object
Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ancestors | Array | Optional | Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains an 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. |
| descendants | Array | Optional | Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component. |
| variants | Array | Optional | Variants describe relations where the relationship between the components is not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor. |
| commits | Array | Optional | A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant. |
| patches | Array | Optional | >A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complementary to commits or may be used in place of commits. |
| notes | String | Optional | Notes, observations, and other non-structured commentary describing the components pedigree. |
Location: /components/[]/pedigree/ancestors
Property: ancestors (Optional)
Type: Array
Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains an ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from. Each item of this array shall be a Component object.
Location: /components/[]/pedigree/ancestors/[]
Type: Object
Location: /components/[]/pedigree/descendants
Property: descendants (Optional)
Type: Array
Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component. Each item of this array shall be a Component object.
Location: /components/[]/pedigree/descendants/[]
Type: Object
Location: /components/[]/pedigree/variants
Property: variants (Optional)
Type: Array
Variants describe relations where the relationship between the components is not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor. Each item of this array shall be a Component object.
Location: /components/[]/pedigree/variants/[]
Type: Object
Location: /components/[]/pedigree/commits
Property: commits (Optional)
Type: Array
A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant. Each item of this array shall be a Commit object.
Location: /components/[]/pedigree/commits/[]
Type: Object
Specifies an individual commit
| Property | Type | Requirement | Description |
|---|---|---|---|
| uid | String | Optional | A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes. |
| url | String | Optional | The URL to the commit. This URL will typically point to a commit in a version control system. |
| author | Object | Optional | The author who created the changes in the commit. |
| committer | Object | Optional | The person who committed or pushed the commit. |
| message | String | Optional | The text description of the contents of the commit. |
Location: /components/[]/pedigree/commits/[]/uid
Type: String
A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
Location: /components/[]/pedigree/commits/[]/url
Type: String
Format: iri-reference as specified in RFC 3987
The URL to the commit. This URL will typically point to a commit in a version control system.
Location: /components/[]/pedigree/commits/[]/author
Type: Object
The author who created the changes in the commit
| Property | Type | Requirement | Description |
|---|---|---|---|
| timestamp | String | Optional | The timestamp in which the action occurred. |
| name | String | Optional | The name of the individual who performed the action. |
| String | Optional | The email address of the individual who performed the action. |
Location: /components/[]/pedigree/commits/[]/author/timestamp
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The timestamp in which the action occurred
Location: /components/[]/pedigree/commits/[]/author/name
Type: String
The name of the individual who performed the action
Location: /components/[]/pedigree/commits/[]/author/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the individual who performed the action
Location: /components/[]/pedigree/commits/[]/committer
Type: Object
The person who committed or pushed the commit
| Property | Type | Requirement | Description |
|---|---|---|---|
| timestamp | String | Optional | The timestamp in which the action occurred. |
| name | String | Optional | The name of the individual who performed the action. |
| String | Optional | The email address of the individual who performed the action. |
Location: /components/[]/pedigree/commits/[]/committer/timestamp
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The timestamp in which the action occurred
Location: /components/[]/pedigree/commits/[]/committer/name
Type: String
The name of the individual who performed the action
Location: /components/[]/pedigree/commits/[]/committer/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the individual who performed the action
Location: /components/[]/pedigree/commits/[]/message
Type: String
The text description of the contents of the commit
Location: /components/[]/pedigree/patches
Property: patches (Optional)
Type: Array
>A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complementary to commits or may be used in place of commits. Each item of this array shall be a Patch object.
Location: /components/[]/pedigree/patches/[]
Type: Object
Specifies an individual patch
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Required | Specifies the purpose for the patch including the resolution of defects, security issues, or new behaviour or functionality. |
| diff | Object | Optional | The patch file (or diff) that shows changes. Refer to https://en.wikipedia.org/wiki/Diff. |
| resolves | Array | Optional | A collection of issues the patch resolves. |
Location: /components/[]/pedigree/patches/[]/type
Type: String (enum)
Specifies the purpose for the patch including the resolution of defects, security issues, or new behaviour or functionality.
| Value | 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 behaviour. 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. |
Location: /components/[]/pedigree/patches/[]/diff
Type: Object
The patch file (or diff) that shows changes. Refer to https://en.wikipedia.org/wiki/Diff
| Property | Type | Requirement | Description |
|---|---|---|---|
| text | Object | Optional | Specifies the text of the diff. |
| url | String | Optional | Specifies the URL to the diff. |
Location: /components/[]/pedigree/patches/[]/diff/text
Type: Object
Specifies the text of the diff
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/pedigree/patches/[]/diff/text/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/pedigree/patches/[]/diff/text/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/pedigree/patches/[]/diff/text/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/pedigree/patches/[]/diff/url
Type: String
Format: iri-reference as specified in RFC 3987
Specifies the URL to the diff
Location: /components/[]/pedigree/patches/[]/resolves
Property: resolves (Optional)
Type: Array
A collection of issues the patch resolves Each item of this array shall be an Issue object.
Location: /components/[]/pedigree/patches/[]/resolves/[]
Type: Object
An individual issue that has been resolved.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Required | Specifies the type of issue. |
| id | String | Optional | The identifier of the issue assigned by the source of the issue. |
| name | String | Optional | The name of the issue. |
| description | String | Optional | A description of the issue. |
| source | Object | Optional | The source of the issue where it is documented. |
| references | Array | Optional | A collection of URL's for reference. Multiple URLs are allowed. |
Location: /components/[]/pedigree/patches/[]/resolves/[]/type
Type: String (enum)
Specifies the type of issue
| Value | Description |
|---|---|
| defect | A fault, flaw, or bug in software. |
| enhancement | A new feature or behaviour in software. |
| security | A special type of defect which impacts security. |
Location: /components/[]/pedigree/patches/[]/resolves/[]/id
Type: String
The identifier of the issue assigned by the source of the issue
Location: /components/[]/pedigree/patches/[]/resolves/[]/name
Type: String
The name of the issue
Location: /components/[]/pedigree/patches/[]/resolves/[]/description
Type: String
A description of the issue
Location: /components/[]/pedigree/patches/[]/resolves/[]/source
Type: Object
The source of the issue where it is documented
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the source. |
| url | String | Optional | The url of the issue documentation as provided by the source. |
Location: /components/[]/pedigree/patches/[]/resolves/[]/source/name
Type: String
The name of the source.
National Vulnerability Database
NVD
Apache
Location: /components/[]/pedigree/patches/[]/resolves/[]/source/url
Type: String
Format: iri-reference as specified in RFC 3987
The url of the issue documentation as provided by the source
Location: /components/[]/pedigree/patches/[]/resolves/[]/references
Property: references (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
A collection of URL's for reference. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/pedigree/notes
Type: String
Notes, observations, and other non-structured commentary describing the components pedigree.
Location: /components/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /components/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
Location: /components/[]/components
Property: components (Optional)
Type: Array
Uniqueness: All items shall be unique.
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. Each item of this array shall be a Component object.
Location: /components/[]/components/[]
Type: Object
Location: /components/[]/evidence
Type: Object
Provides the ability to document evidence collected through various forms of extraction or analysis.
| Property | Type | Requirement | Description |
|---|---|---|---|
| identity | Array | Optional | Evidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified. |
| occurrences | Array | Optional | Evidence of individual instances of a component spread across multiple locations. |
| callstack | Object | Optional | Evidence of the components use through the callstack. |
| licenses | Array | Optional | A list of SPDX licenses and/or named licenses and/or SPDX Licence Expression. |
| copyright | Array | Optional | Copyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection. |
Location: /components/[]/evidence/identity
Evidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified.
Shall be one of:
Type: Array
Type: Object
[Deprecated]
| Property | Type | Requirement | Description |
|---|---|---|---|
| field | String | Required | The identity field of the component which the evidence describes. |
| confidence | Number | Optional | The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence. |
| concludedValue | String | Optional | The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available). |
| methods | Array | Optional | The methods used to extract and/or analyse the evidence. |
| tools | Array | Optional | 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. |
Location: /components/[]/evidence/identity
Property: identity
Type: Array
Location: /components/[]/evidence/identity/[]
Type: Object
Evidence that substantiates the identity of a component.
| Property | Type | Requirement | Description |
|---|---|---|---|
| field | String | Required | The identity field of the component which the evidence describes. |
| confidence | Number | Optional | The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence. |
| concludedValue | String | Optional | The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available). |
| methods | Array | Optional | The methods used to extract and/or analyse the evidence. |
| tools | Array | Optional | 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. |
Location: /components/[]/evidence/identity/[]/field
Type: String (enum)
The identity field of the component which the evidence describes.
Enumeration of possible values:Location: /components/[]/evidence/identity/[]/confidence
Type: Number
Maximum Value: 1
The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
Location: /components/[]/evidence/identity/[]/concludedValue
Type: String
The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).
Location: /components/[]/evidence/identity/[]/methods
Property: methods (Optional)
Type: Array
The methods used to extract and/or analyse the evidence.
Location: /components/[]/evidence/identity/[]/methods/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| technique | String | Required | The technique used in this method of analysis. |
| confidence | Number | Required | 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 | String | Optional | The value or contents of the evidence. |
Location: /components/[]/evidence/identity/[]/methods/[]/technique
Type: String (enum)
The technique used in this method of analysis.
Enumeration of possible values:Location: /components/[]/evidence/identity/[]/methods/[]/confidence
Type: Number
Maximum Value: 1
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.
Location: /components/[]/evidence/identity/[]/methods/[]/value
Type: String
The value or contents of the evidence.
Location: /components/[]/evidence/identity/[]/tools
Property: tools (Optional)
Type: Array
Uniqueness: All items shall be unique.
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.
Location: /components/[]/evidence/identity/[]/tools/[]
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /components/[]/evidence/identity/field
Property: field (Required)
Type: String (enum)
The identity field of the component which the evidence describes.
Enumeration of possible values:Location: /components/[]/evidence/identity/confidence
Property: confidence (Optional)
Type: Number
Maximum Value: 1
The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
Location: /components/[]/evidence/identity/concludedValue
Property: concludedValue (Optional)
Type: String
The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).
Location: /components/[]/evidence/identity/methods
Property: methods (Optional)
Type: Array
The methods used to extract and/or analyse the evidence.
Location: /components/[]/evidence/identity/methods/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| technique | String | Required | The technique used in this method of analysis. |
| confidence | Number | Required | 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 | String | Optional | The value or contents of the evidence. |
Location: /components/[]/evidence/identity/methods/[]/technique
Type: String (enum)
The technique used in this method of analysis.
Enumeration of possible values:Location: /components/[]/evidence/identity/methods/[]/confidence
Type: Number
Maximum Value: 1
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.
Location: /components/[]/evidence/identity/methods/[]/value
Type: String
The value or contents of the evidence.
Location: /components/[]/evidence/identity/tools
Property: tools (Optional)
Type: Array
Uniqueness: All items shall be unique.
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.
Location: /components/[]/evidence/identity/tools/[]
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /components/[]/evidence/occurrences
Property: occurrences (Optional)
Type: Array
Evidence of individual instances of a component spread across multiple locations.
Location: /components/[]/evidence/occurrences/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| location | String | Required | The location or path to where the component was found. |
| line | Integer | Optional | The line number where the component was found. |
| offset | Integer | Optional | The offset where the component was found. |
| symbol | String | Optional | The symbol name that was found associated with the component. |
| additionalContext | String | Optional | Any additional context of the detected component (e.g. a code snippet). |
Location: /components/[]/evidence/occurrences/[]/bom-ref
Type: String
An identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/evidence/occurrences/[]/location
Type: String
The location or path to where the component was found.
Location: /components/[]/evidence/occurrences/[]/line
Type: Integer
The line number where the component was found.
Location: /components/[]/evidence/occurrences/[]/offset
Type: Integer
The offset where the component was found.
Location: /components/[]/evidence/occurrences/[]/symbol
Type: String
The symbol name that was found associated with the component.
Location: /components/[]/evidence/occurrences/[]/additionalContext
Type: String
Any additional context of the detected component (e.g. a code snippet).
Location: /components/[]/evidence/callstack
Type: Object
Evidence of the components use through the callstack.
| Property | Type | Requirement | Description |
|---|---|---|---|
| frames | Array | Optional | Within a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of programme execution and manages the sequence of function invocations. |
Location: /components/[]/evidence/callstack/frames
Property: frames (Optional)
Type: Array
Within a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of programme execution and manages the sequence of function invocations.
Location: /components/[]/evidence/callstack/frames/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| package | String | Optional | A package organizes modules into namespaces, providing a unique namespace for each type it contains. |
| module | String | Required | A module or class that encloses functions/methods and other code. |
| function | String | Optional | A block of code designed to perform a particular task. |
| parameters | Array | Optional | Arguments that are passed to the module or function. |
| line | Integer | Optional | The line number the code that is called resides on. |
| column | Integer | Optional | The column the code that is called resides. |
| fullFilename | String | Optional | The full path and filename of the module. |
Location: /components/[]/evidence/callstack/frames/[]/package
Type: String
A package organizes modules into namespaces, providing a unique namespace for each type it contains.
Location: /components/[]/evidence/callstack/frames/[]/module
Type: String
A module or class that encloses functions/methods and other code.
Location: /components/[]/evidence/callstack/frames/[]/function
Type: String
A block of code designed to perform a particular task.
Location: /components/[]/evidence/callstack/frames/[]/parameters
Property: parameters (Optional)
Type: Array (of String)
Arguments that are passed to the module or function. Each item of this array shall be a string.
Location: /components/[]/evidence/callstack/frames/[]/line
Type: Integer
The line number the code that is called resides on.
Location: /components/[]/evidence/callstack/frames/[]/column
Type: Integer
The column the code that is called resides.
Location: /components/[]/evidence/callstack/frames/[]/fullFilename
Type: String
The full path and filename of the module.
Location: /components/[]/evidence/licenses
Property: licenses (Optional)
Type: Array
A list of SPDX licenses and/or named licenses and/or SPDX Licence Expression.
Location: /components/[]/evidence/licenses/[]
Location: /components/[]/evidence/copyright
Property: copyright (Optional)
Type: Array
Copyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection. Each item of this array shall be a Copyright object.
Location: /components/[]/evidence/copyright/[]
Type: Object
A copyright notice informing users of the underlying claims to copyright ownership in a published work.
| Property | Type | Requirement | Description |
|---|---|---|---|
| text | String | Required | The textual content of the copyright. |
Location: /components/[]/evidence/copyright/[]/text
Type: String
The textual content of the copyright.
Location: /components/[]/releaseNotes
Type: Object
Specifies release notes.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Required | The software versioning type the release note describes. |
| title | String | Optional | The title of the release. |
| featuredImage | String | Optional | The URL to an image that may be prominently displayed with the release note. |
| socialImage | String | Optional | The URL to an image that may be used in messaging on social media platforms. |
| description | String | Optional | A short description of the release. |
| timestamp | String | Optional | The date and time (timestamp) when the release note was created. |
| aliases | Array | Optional | 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). |
| tags | Array | Optional | 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. |
| resolves | Array | Optional | A collection of issues that have been resolved. |
| notes | Array | Optional | 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. |
| properties | Array | Optional | 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. |
Location: /components/[]/releaseNotes/type
Type: String
The software versioning type the release note describes.
major
minor
patch
pre-release
internal
Location: /components/[]/releaseNotes/title
Type: String
The title of the release.
Location: /components/[]/releaseNotes/featuredImage
Type: String
Format: iri-reference as specified in RFC 3987
The URL to an image that may be prominently displayed with the release note.
Location: /components/[]/releaseNotes/socialImage
Type: String
Format: iri-reference as specified in RFC 3987
The URL to an image that may be used in messaging on social media platforms.
Location: /components/[]/releaseNotes/description
Type: String
A short description of the release.
Location: /components/[]/releaseNotes/timestamp
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the release note was created.
Location: /components/[]/releaseNotes/aliases
Property: aliases (Optional)
Type: Array (of String)
One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names). Each item of this array shall be a string.
Location: /components/[]/releaseNotes/tags
Property: tags (Optional)
Type: Array (of String)
Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes. Each item of this array shall be a string.
json-parser
object-persistence
text-to-image
translation
object-detection
Location: /components/[]/releaseNotes/resolves
Property: resolves (Optional)
Type: Array
A collection of issues that have been resolved. Each item of this array shall be an Issue object.
Location: /components/[]/releaseNotes/resolves/[]
Type: Object
An individual issue that has been resolved.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Required | Specifies the type of issue. |
| id | String | Optional | The identifier of the issue assigned by the source of the issue. |
| name | String | Optional | The name of the issue. |
| description | String | Optional | A description of the issue. |
| source | Object | Optional | The source of the issue where it is documented. |
| references | Array | Optional | A collection of URL's for reference. Multiple URLs are allowed. |
Location: /components/[]/releaseNotes/resolves/[]/type
Type: String (enum)
Specifies the type of issue
| Value | Description |
|---|---|
| defect | A fault, flaw, or bug in software. |
| enhancement | A new feature or behaviour in software. |
| security | A special type of defect which impacts security. |
Location: /components/[]/releaseNotes/resolves/[]/id
Type: String
The identifier of the issue assigned by the source of the issue
Location: /components/[]/releaseNotes/resolves/[]/name
Type: String
The name of the issue
Location: /components/[]/releaseNotes/resolves/[]/description
Type: String
A description of the issue
Location: /components/[]/releaseNotes/resolves/[]/source
Type: Object
The source of the issue where it is documented
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the source. |
| url | String | Optional | The url of the issue documentation as provided by the source. |
Location: /components/[]/releaseNotes/resolves/[]/source/name
Type: String
The name of the source.
National Vulnerability Database
NVD
Apache
Location: /components/[]/releaseNotes/resolves/[]/source/url
Type: String
Format: iri-reference as specified in RFC 3987
The url of the issue documentation as provided by the source
Location: /components/[]/releaseNotes/resolves/[]/references
Property: references (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
A collection of URL's for reference. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/releaseNotes/notes
Property: notes (Optional)
Type: Array
Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages. Each item of this array shall be a Note object.
Location: /components/[]/releaseNotes/notes/[]
Type: Object
A note containing the locale and content.
| Property | Type | Requirement | Description |
|---|---|---|---|
| locale | String | Optional | The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA". |
| text | Object | Required | Specifies the full content of the release note. |
Location: /components/[]/releaseNotes/notes/[]/locale
Type: String
Pattern Constraint: ^([a-z]{2})(-[A-Z]{2})?$
The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA"
Location: /components/[]/releaseNotes/notes/[]/text
Type: Object
Specifies the full content of the release note.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/releaseNotes/notes/[]/text/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/releaseNotes/notes/[]/text/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/releaseNotes/notes/[]/text/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/releaseNotes/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /components/[]/releaseNotes/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /components/[]/releaseNotes/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /components/[]/releaseNotes/properties/[]/value
Type: String
The value of the property.
Location: /components/[]/modelCard
Type: Object
A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object should be specified for any component of type machine-learning-model and shall not be specified for other component types.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| modelParameters | Object | Optional | Hyper-parameters for construction of the model. |
| quantitativeAnalysis | Object | Optional | A quantitative analysis of the model. |
| considerations | Object | Optional | What considerations should be taken into account regarding the model's construction, training, and application?. |
| properties | Array | Optional | 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. |
Location: /components/[]/modelCard/bom-ref
Type: String
An identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters
Type: Object
Hyper-parameters for construction of the model.
| Property | Type | Requirement | Description |
|---|---|---|---|
| approach | Object | Optional | The overall approach to learning used by the model for problem solving. |
| task | String | Optional | Directly influences the input and/or output. Examples include classification, regression, clustering, etc. |
| architectureFamily | String | Optional | The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc. |
| modelArchitecture | String | Optional | The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc. |
| datasets | Array | Optional | The datasets used to train and evaluate the model. |
| inputs | Array | Optional | The input format(s) of the model. |
| outputs | Array | Optional | The output format(s) from the model. |
Location: /components/[]/modelCard/modelParameters/approach
Type: Object
The overall approach to learning used by the model for problem solving.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | Learning types describing the learning problem or hybrid learning problem. |
Location: /components/[]/modelCard/modelParameters/approach/type
Type: String (enum)
Learning types describing the learning problem or hybrid learning problem.
| Value | Description |
|---|---|
| supervised | Supervised machine learning involves training an algorithm on labelled data to predict or classify new data based on the patterns learned from the labelled 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 labelled 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. |
Location: /components/[]/modelCard/modelParameters/task
Type: String
Directly influences the input and/or output. Examples include classification, regression, clustering, etc.
Location: /components/[]/modelCard/modelParameters/architectureFamily
Type: String
The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc.
Location: /components/[]/modelCard/modelParameters/modelArchitecture
Type: String
The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc.
Location: /components/[]/modelCard/modelParameters/datasets
Property: datasets (Optional)
Type: Array
The datasets used to train and evaluate the model.
Location: /components/[]/modelCard/modelParameters/datasets/[]
Shall be one of:
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| type | String | Required | The general theme or subject matter of the data being specified. |
| name | String | Optional | The name of the dataset. |
| contents | Object | Optional | The contents or references to the contents of the data being described. |
| classification | String | Optional | Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed. |
| sensitiveData | Array | Optional | A description of any sensitive data in a dataset. |
| graphics | Object | Optional | A collection of graphics that represent various measurements. |
| description | String | Optional | A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc. |
| governance | Object | Optional | 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. |
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | String | Optional | References a data component by the components bom-ref attribute. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/type
Property: type (Required)
Type: String (enum)
The general theme or subject matter of the data being specified.
| Value | 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. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/name
Property: name (Optional)
Type: String
The name of the dataset.
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents
Property: contents (Optional)
Type: Object
The contents or references to the contents of the data being described.
| Property | Type | Requirement | Description |
|---|---|---|---|
| attachment | Object | Optional | A way to include textual or encoded data. |
| url | String | Optional | The URL to where the data can be retrieved. |
| properties | Array | Optional | Provides the ability to document name-value parameters used for configuration. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents/attachment
Property: attachment (Optional)
Type: Object
A way to include textual or encoded data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents/attachment/contentType
Property: contentType (Optional)
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents/attachment/encoding
Property: encoding (Optional)
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents/attachment/content
Property: content (Required)
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents/url
Property: url (Optional)
Type: String
Format: iri-reference as specified in RFC 3987
The URL to where the data can be retrieved.
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents/properties
Property: properties (Optional)
Type: Array
Provides the ability to document name-value parameters used for configuration. Each item of this array shall be a Lightweight name-value pair object.
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /components/[]/modelCard/modelParameters/datasets/[]/contents/properties/[]/value
Type: String
The value of the property.
Location: /components/[]/modelCard/modelParameters/datasets/[]/classification
Property: classification (Optional)
Type: String
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
Location: /components/[]/modelCard/modelParameters/datasets/[]/sensitiveData
Property: sensitiveData (Optional)
Type: Array (of String)
A description of any sensitive data in a dataset. Each item of this array shall be a string.
Location: /components/[]/modelCard/modelParameters/datasets/[]/graphics
Property: graphics (Optional)
Type: Object
A collection of graphics that represent various measurements.
| Property | Type | Requirement | Description |
|---|---|---|---|
| description | String | Optional | A description of this collection of graphics. |
| collection | Array | Optional | A collection of graphics. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/graphics/description
Property: description (Optional)
Type: String
A description of this collection of graphics.
Location: /components/[]/modelCard/modelParameters/datasets/[]/graphics/collection
Property: collection (Optional)
Type: Array
A collection of graphics. Each item of this array shall be a Graphic object.
Location: /components/[]/modelCard/modelParameters/datasets/[]/graphics/collection/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the graphic. |
| image | Object | Optional | The graphic (vector or raster). Base64 encoding shall be specified for binary images. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/graphics/collection/[]/name
Type: String
The name of the graphic.
Location: /components/[]/modelCard/modelParameters/datasets/[]/graphics/collection/[]/image
Type: Object
The graphic (vector or raster). Base64 encoding shall be specified for binary images.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/graphics/collection/[]/image/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/modelCard/modelParameters/datasets/[]/graphics/collection/[]/image/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/graphics/collection/[]/image/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/modelCard/modelParameters/datasets/[]/description
Property: description (Optional)
Type: String
A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance
Property: governance (Optional)
Type: Object
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
| Property | Type | Requirement | Description |
|---|---|---|---|
| custodians | Array | Optional | Data custodians are responsible for the safe custody, transport, and storage of data. |
| stewards | Array | Optional | Data stewards are responsible for data content, context, and associated business rules. |
| owners | Array | Optional | Data owners are concerned with risk and appropriate access to data. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians
Property: custodians (Optional)
Type: Array
Data custodians are responsible for the safe custody, transport, and storage of data.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/custodians/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards
Property: stewards (Optional)
Type: Array
Data stewards are responsible for data content, context, and associated business rules.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/stewards/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners
Property: owners (Optional)
Type: Array
Data owners are concerned with risk and appropriate access to data.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/modelCard/modelParameters/datasets/[]/governance/owners/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/modelCard/modelParameters/datasets/[]/ref
Property: ref (Optional)
Type: String
References a data component by the components bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /components/[]/modelCard/modelParameters/inputs
Property: inputs (Optional)
Type: Array
The input format(s) of the model Each item of this array shall be an Input and Output Parameters object.
Location: /components/[]/modelCard/modelParameters/inputs/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| format | String | Optional | The data format for input/output to the model. |
Location: /components/[]/modelCard/modelParameters/inputs/[]/format
Type: String
The data format for input/output to the model.
string
image
time-series
Location: /components/[]/modelCard/modelParameters/outputs
Property: outputs (Optional)
Type: Array
The output format(s) from the model Each item of this array shall be an Input and Output Parameters object.
Location: /components/[]/modelCard/modelParameters/outputs/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| format | String | Optional | The data format for input/output to the model. |
Location: /components/[]/modelCard/modelParameters/outputs/[]/format
Type: String
The data format for input/output to the model.
string
image
time-series
Location: /components/[]/modelCard/quantitativeAnalysis
Type: Object
A quantitative analysis of the model
| Property | Type | Requirement | Description |
|---|---|---|---|
| performanceMetrics | Array | Optional | The model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc. |
| graphics | Object | Optional | A collection of graphics that represent various measurements. |
Location: /components/[]/modelCard/quantitativeAnalysis/performanceMetrics
Property: performanceMetrics (Optional)
Type: Array
The model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc. Each item of this array shall be a Performance Metric object.
Location: /components/[]/modelCard/quantitativeAnalysis/performanceMetrics/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | The type of performance metric. |
| value | String | Optional | The value of the performance metric. |
| slice | String | Optional | The name of the slice this metric was computed on. By default, assume this metric is not sliced. |
| confidenceInterval | Object | Optional | The confidence interval of the metric. |
Location: /components/[]/modelCard/quantitativeAnalysis/performanceMetrics/[]/type
Type: String
The type of performance metric.
Location: /components/[]/modelCard/quantitativeAnalysis/performanceMetrics/[]/value
Type: String
The value of the performance metric.
Location: /components/[]/modelCard/quantitativeAnalysis/performanceMetrics/[]/slice
Type: String
The name of the slice this metric was computed on. By default, assume this metric is not sliced.
Location: /components/[]/modelCard/quantitativeAnalysis/performanceMetrics/[]/confidenceInterval
Type: Object
The confidence interval of the metric.
| Property | Type | Requirement | Description |
|---|---|---|---|
| lowerBound | String | Optional | The lower bound of the confidence interval. |
| upperBound | String | Optional | The upper bound of the confidence interval. |
Location: /components/[]/modelCard/quantitativeAnalysis/performanceMetrics/[]/confidenceInterval/lowerBound
Type: String
The lower bound of the confidence interval.
Location: /components/[]/modelCard/quantitativeAnalysis/performanceMetrics/[]/confidenceInterval/upperBound
Type: String
The upper bound of the confidence interval.
Location: /components/[]/modelCard/quantitativeAnalysis/graphics
Type: Object
A collection of graphics that represent various measurements.
| Property | Type | Requirement | Description |
|---|---|---|---|
| description | String | Optional | A description of this collection of graphics. |
| collection | Array | Optional | A collection of graphics. |
Location: /components/[]/modelCard/quantitativeAnalysis/graphics/description
Type: String
A description of this collection of graphics.
Location: /components/[]/modelCard/quantitativeAnalysis/graphics/collection
Property: collection (Optional)
Type: Array
A collection of graphics. Each item of this array shall be a Graphic object.
Location: /components/[]/modelCard/quantitativeAnalysis/graphics/collection/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the graphic. |
| image | Object | Optional | The graphic (vector or raster). Base64 encoding shall be specified for binary images. |
Location: /components/[]/modelCard/quantitativeAnalysis/graphics/collection/[]/name
Type: String
The name of the graphic.
Location: /components/[]/modelCard/quantitativeAnalysis/graphics/collection/[]/image
Type: Object
The graphic (vector or raster). Base64 encoding shall be specified for binary images.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/modelCard/quantitativeAnalysis/graphics/collection/[]/image/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/modelCard/quantitativeAnalysis/graphics/collection/[]/image/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/modelCard/quantitativeAnalysis/graphics/collection/[]/image/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/modelCard/considerations
Type: Object
What considerations should be taken into account regarding the model's construction, training, and application?
| Property | Type | Requirement | Description |
|---|---|---|---|
| users | Array | Optional | Who are the intended users of the model?. |
| useCases | Array | Optional | What are the intended use cases of the model?. |
| technicalLimitations | Array | Optional | What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?. |
| performanceTradeoffs | Array | Optional | What are the known tradeoffs in accuracy/performance of the model?. |
| ethicalConsiderations | Array | Optional | What are the ethical risks involved in the application of this model?. |
| environmentalConsiderations | Object | Optional | What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?. |
| fairnessAssessments | Array | Optional | How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?. |
Location: /components/[]/modelCard/considerations/users
Property: users (Optional)
Type: Array (of String)
Who are the intended users of the model? Each item of this array shall be a string.
Location: /components/[]/modelCard/considerations/useCases
Property: useCases (Optional)
Type: Array (of String)
What are the intended use cases of the model? Each item of this array shall be a string.
Location: /components/[]/modelCard/considerations/technicalLimitations
Property: technicalLimitations (Optional)
Type: Array (of String)
What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance? Each item of this array shall be a string.
Location: /components/[]/modelCard/considerations/performanceTradeoffs
Property: performanceTradeoffs (Optional)
Type: Array (of String)
What are the known tradeoffs in accuracy/performance of the model? Each item of this array shall be a string.
Location: /components/[]/modelCard/considerations/ethicalConsiderations
Property: ethicalConsiderations (Optional)
Type: Array
What are the ethical risks involved in the application of this model? Each item of this array shall be a Risk object.
Location: /components/[]/modelCard/considerations/ethicalConsiderations/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the risk. |
| mitigationStrategy | String | Optional | Strategy used to address this risk. |
Location: /components/[]/modelCard/considerations/ethicalConsiderations/[]/name
Type: String
The name of the risk.
Location: /components/[]/modelCard/considerations/ethicalConsiderations/[]/mitigationStrategy
Type: String
Strategy used to address this risk.
Location: /components/[]/modelCard/considerations/environmentalConsiderations
Type: Object
What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?
| Property | Type | Requirement | Description |
|---|---|---|---|
| energyConsumptions | Array | Optional | Describes energy consumption information incurred for one or more component lifecycle activities. |
| properties | Array | Optional | 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. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions
Property: energyConsumptions (Optional)
Type: Array
Describes energy consumption information incurred for one or more component lifecycle activities. Each item of this array shall be an Energy consumption object.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]
Type: Object
Describes energy consumption information incurred for the specified lifecycle activity.
| Property | Type | Requirement | Description |
|---|---|---|---|
| activity | String | Required | The type of activity that is part of a machine learning model development or operational lifecycle. |
| energyProviders | Array | Required | The provider(s) of the energy consumed by the associated model development lifecycle activity. |
| activityEnergyCost | Object | Required | The total energy cost associated with the model lifecycle activity. |
| co2CostEquivalent | Object | Optional | The CO2 cost (debit) equivalent to the total energy cost. |
| co2CostOffset | Object | Optional | The CO2 offset (credit) for the CO2 equivalent cost. |
| properties | Array | Optional | 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. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/activity
Type: String (enum)
The type of activity that is part of a machine learning model development or operational lifecycle.
| Value | 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, labelling 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. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders
Property: energyProviders (Required)
Type: Array
The provider(s) of the energy consumed by the associated model development lifecycle activity. Each item of this array shall be an Energy Provider object.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]
Type: Object
Describes the physical provider of energy used for model development or operations.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| description | String | Optional | A description of the energy provider. |
| organization | Object | Required | The organization that provides energy. |
| energySource | String | Required | The energy source for the energy provider. |
| energyProvided | Object | Required | The energy provided by the energy source for an associated activity. |
| externalReferences | Array | Optional | 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. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/bom-ref
Type: String
An identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/description
Type: String
A description of the energy provider.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization
Type: Object
The organization that provides energy.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/energySource
Type: String (enum)
The energy source for the energy provider.
| Value | 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. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/energyProvided
Type: Object
The energy provided by the energy source for an associated activity.
| Property | Type | Requirement | Description |
|---|---|---|---|
| value | Number | Required | Quantity of energy. |
| unit | String | Required | Unit of energy. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/energyProvided/value
Type: Number
Quantity of energy.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/energyProvided/unit
Type: String (enum)
Unit of energy.
| Value | Description |
|---|---|
| kWh | Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h). |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/energyProviders/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/activityEnergyCost
Type: Object
The total energy cost associated with the model lifecycle activity.
| Property | Type | Requirement | Description |
|---|---|---|---|
| value | Number | Required | Quantity of energy. |
| unit | String | Required | Unit of energy. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/activityEnergyCost/value
Type: Number
Quantity of energy.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/activityEnergyCost/unit
Type: String (enum)
Unit of energy.
| Value | Description |
|---|---|
| kWh | Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h). |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/co2CostEquivalent
Type: Object
The CO2 cost (debit) equivalent to the total energy cost.
| Property | Type | Requirement | Description |
|---|---|---|---|
| value | Number | Required | Quantity of carbon dioxide (CO2). |
| unit | String | Required | Unit of carbon dioxide (CO2). |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/co2CostEquivalent/value
Type: Number
Quantity of carbon dioxide (CO2).
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/co2CostEquivalent/unit
Type: String (enum)
Unit of carbon dioxide (CO2).
| Value | Description |
|---|---|
| tCO2eq | Tonnes (t) of carbon dioxide (CO2) equivalent (eq). |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/co2CostOffset
Type: Object
The CO2 offset (credit) for the CO2 equivalent cost.
| Property | Type | Requirement | Description |
|---|---|---|---|
| value | Number | Required | Quantity of carbon dioxide (CO2). |
| unit | String | Required | Unit of carbon dioxide (CO2). |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/co2CostOffset/value
Type: Number
Quantity of carbon dioxide (CO2).
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/co2CostOffset/unit
Type: String (enum)
Unit of carbon dioxide (CO2).
| Value | Description |
|---|---|
| tCO2eq | Tonnes (t) of carbon dioxide (CO2) equivalent (eq). |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/energyConsumptions/[]/properties/[]/value
Type: String
The value of the property.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /components/[]/modelCard/considerations/environmentalConsiderations/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /components/[]/modelCard/considerations/environmentalConsiderations/properties/[]/value
Type: String
The value of the property.
Location: /components/[]/modelCard/considerations/fairnessAssessments
Property: fairnessAssessments (Optional)
Type: Array
How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups? Each item of this array shall be a Fairness Assessment object.
Location: /components/[]/modelCard/considerations/fairnessAssessments/[]
Type: Object
Information about the benefits and harms of the model to an identified at risk group.
| Property | Type | Requirement | Description |
|---|---|---|---|
| groupAtRisk | String | Optional | The groups or individuals at risk of being systematically disadvantaged by the model. |
| benefits | String | Optional | Expected benefits to the identified groups. |
| harms | String | Optional | Expected harms to the identified groups. |
| mitigationStrategy | String | Optional | With respect to the benefits and harms outlined, please describe any mitigation strategy implemented. |
Location: /components/[]/modelCard/considerations/fairnessAssessments/[]/groupAtRisk
Type: String
The groups or individuals at risk of being systematically disadvantaged by the model.
Location: /components/[]/modelCard/considerations/fairnessAssessments/[]/benefits
Type: String
Expected benefits to the identified groups.
Location: /components/[]/modelCard/considerations/fairnessAssessments/[]/harms
Type: String
Expected harms to the identified groups.
Location: /components/[]/modelCard/considerations/fairnessAssessments/[]/mitigationStrategy
Type: String
With respect to the benefits and harms outlined, please describe any mitigation strategy implemented.
Location: /components/[]/modelCard/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /components/[]/modelCard/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /components/[]/modelCard/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /components/[]/modelCard/properties/[]/value
Type: String
The value of the property.
Location: /components/[]/data
Property: data (Optional)
Type: Array
This object should be specified for any component of type data and shall not be specified for other component types.
Location: /components/[]/data/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| type | String | Required | The general theme or subject matter of the data being specified. |
| name | String | Optional | The name of the dataset. |
| contents | Object | Optional | The contents or references to the contents of the data being described. |
| classification | String | Optional | Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed. |
| sensitiveData | Array | Optional | A description of any sensitive data in a dataset. |
| graphics | Object | Optional | A collection of graphics that represent various measurements. |
| description | String | Optional | A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc. |
| governance | Object | Optional | 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. |
Location: /components/[]/data/[]/bom-ref
Type: String
An identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/type
Type: String (enum)
The general theme or subject matter of the data being specified.
| Value | 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. |
Location: /components/[]/data/[]/name
Type: String
The name of the dataset.
Location: /components/[]/data/[]/contents
Type: Object
The contents or references to the contents of the data being described.
| Property | Type | Requirement | Description |
|---|---|---|---|
| attachment | Object | Optional | A way to include textual or encoded data. |
| url | String | Optional | The URL to where the data can be retrieved. |
| properties | Array | Optional | Provides the ability to document name-value parameters used for configuration. |
Location: /components/[]/data/[]/contents/attachment
Type: Object
A way to include textual or encoded data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/data/[]/contents/attachment/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/data/[]/contents/attachment/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/data/[]/contents/attachment/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/data/[]/contents/url
Type: String
Format: iri-reference as specified in RFC 3987
The URL to where the data can be retrieved.
Location: /components/[]/data/[]/contents/properties
Property: properties (Optional)
Type: Array
Provides the ability to document name-value parameters used for configuration. Each item of this array shall be a Lightweight name-value pair object.
Location: /components/[]/data/[]/contents/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /components/[]/data/[]/contents/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /components/[]/data/[]/contents/properties/[]/value
Type: String
The value of the property.
Location: /components/[]/data/[]/classification
Type: String
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
Location: /components/[]/data/[]/sensitiveData
Property: sensitiveData (Optional)
Type: Array (of String)
A description of any sensitive data in a dataset. Each item of this array shall be a string.
Location: /components/[]/data/[]/graphics
Type: Object
A collection of graphics that represent various measurements.
| Property | Type | Requirement | Description |
|---|---|---|---|
| description | String | Optional | A description of this collection of graphics. |
| collection | Array | Optional | A collection of graphics. |
Location: /components/[]/data/[]/graphics/description
Type: String
A description of this collection of graphics.
Location: /components/[]/data/[]/graphics/collection
Property: collection (Optional)
Type: Array
A collection of graphics. Each item of this array shall be a Graphic object.
Location: /components/[]/data/[]/graphics/collection/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the graphic. |
| image | Object | Optional | The graphic (vector or raster). Base64 encoding shall be specified for binary images. |
Location: /components/[]/data/[]/graphics/collection/[]/name
Type: String
The name of the graphic.
Location: /components/[]/data/[]/graphics/collection/[]/image
Type: Object
The graphic (vector or raster). Base64 encoding shall be specified for binary images.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /components/[]/data/[]/graphics/collection/[]/image/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /components/[]/data/[]/graphics/collection/[]/image/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /components/[]/data/[]/graphics/collection/[]/image/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /components/[]/data/[]/description
Type: String
A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.
Location: /components/[]/data/[]/governance
Type: Object
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
| Property | Type | Requirement | Description |
|---|---|---|---|
| custodians | Array | Optional | Data custodians are responsible for the safe custody, transport, and storage of data. |
| stewards | Array | Optional | Data stewards are responsible for data content, context, and associated business rules. |
| owners | Array | Optional | Data owners are concerned with risk and appropriate access to data. |
Location: /components/[]/data/[]/governance/custodians
Property: custodians (Optional)
Type: Array
Data custodians are responsible for the safe custody, transport, and storage of data.
Location: /components/[]/data/[]/governance/custodians/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /components/[]/data/[]/governance/custodians/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/data/[]/governance/custodians/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/custodians/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /components/[]/data/[]/governance/custodians/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/data/[]/governance/custodians/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/custodians/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/data/[]/governance/custodians/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /components/[]/data/[]/governance/custodians/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /components/[]/data/[]/governance/custodians/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /components/[]/data/[]/governance/custodians/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /components/[]/data/[]/governance/custodians/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /components/[]/data/[]/governance/custodians/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/data/[]/governance/custodians/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/data/[]/governance/custodians/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/data/[]/governance/custodians/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/custodians/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/data/[]/governance/custodians/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/data/[]/governance/custodians/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/data/[]/governance/custodians/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/data/[]/governance/custodians/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/custodians/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /components/[]/data/[]/governance/custodians/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/data/[]/governance/custodians/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/data/[]/governance/stewards
Property: stewards (Optional)
Type: Array
Data stewards are responsible for data content, context, and associated business rules.
Location: /components/[]/data/[]/governance/stewards/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /components/[]/data/[]/governance/stewards/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/data/[]/governance/stewards/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/stewards/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /components/[]/data/[]/governance/stewards/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/data/[]/governance/stewards/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/stewards/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/data/[]/governance/stewards/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /components/[]/data/[]/governance/stewards/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /components/[]/data/[]/governance/stewards/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /components/[]/data/[]/governance/stewards/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /components/[]/data/[]/governance/stewards/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /components/[]/data/[]/governance/stewards/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/data/[]/governance/stewards/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/data/[]/governance/stewards/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/data/[]/governance/stewards/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/stewards/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/data/[]/governance/stewards/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/data/[]/governance/stewards/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/data/[]/governance/stewards/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/data/[]/governance/stewards/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/stewards/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /components/[]/data/[]/governance/stewards/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/data/[]/governance/stewards/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/data/[]/governance/owners
Property: owners (Optional)
Type: Array
Data owners are concerned with risk and appropriate access to data.
Location: /components/[]/data/[]/governance/owners/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /components/[]/data/[]/governance/owners/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /components/[]/data/[]/governance/owners/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/owners/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /components/[]/data/[]/governance/owners/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /components/[]/data/[]/governance/owners/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/owners/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /components/[]/data/[]/governance/owners/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /components/[]/data/[]/governance/owners/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /components/[]/data/[]/governance/owners/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /components/[]/data/[]/governance/owners/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /components/[]/data/[]/governance/owners/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /components/[]/data/[]/governance/owners/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /components/[]/data/[]/governance/owners/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /components/[]/data/[]/governance/owners/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/data/[]/governance/owners/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/owners/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /components/[]/data/[]/governance/owners/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/data/[]/governance/owners/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/data/[]/governance/owners/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /components/[]/data/[]/governance/owners/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /components/[]/data/[]/governance/owners/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /components/[]/data/[]/governance/owners/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /components/[]/data/[]/governance/owners/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /components/[]/cryptoProperties
Type: Object
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.
| Property | Type | Requirement | Description |
|---|---|---|---|
| assetType | String | Required | Cryptographic 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. |
| algorithmProperties | Object | Optional | Additional properties specific to a cryptographic algorithm. |
| certificateProperties | Object | Optional | Properties for cryptographic assets of asset type 'certificate'. |
| relatedCryptoMaterialProperties | Object | Optional | Properties for cryptographic assets of asset type: related-crypto-material. |
| protocolProperties | Object | Optional | Properties specific to cryptographic assets of type: protocol. |
| oid | String | Optional | The object identifier (OID) of the cryptographic asset. |
Location: /components/[]/cryptoProperties/assetType
Type: String (enum)
Cryptographic 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.
| Value | 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 behaviour and communication with each other. |
| related-crypto-material | Other cryptographic assets related to algorithms, certificates, and protocols such as keys and tokens. |
Location: /components/[]/cryptoProperties/algorithmProperties
Type: Object
Additional properties specific to a cryptographic algorithm.
| Property | Type | Requirement | Description |
|---|---|---|---|
| primitive | String | Optional | Cryptographic 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). |
| algorithmFamily | String | Optional | A valid algorithm family identifier. If specified, this value shall be one of the enumeration of valid algorithm Family identifiers defined in the cryptography-defs.schema.json subschema. |
| parameterSetIdentifier | String | Optional | 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). |
| curve | String | Optional | [Deprecated] This will be removed in a future version. Use @.ellipticCurve instead. 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. |
| ellipticCurve | String | Optional | The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. If specified, this value shall be one of the enumeration of valid elliptic curves identifiers defined in the cryptography-defs.schema.json subschema. |
| executionEnvironment | String | Optional | The target and execution environment in which the algorithm is implemented in. |
| implementationPlatform | String | Optional | The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform. |
| certificationLevel | Array | Optional | 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). |
| mode | String | Optional | The mode of operation in which the cryptographic algorithm (block cipher) is used. |
| padding | String | Optional | The padding scheme that is used for the cryptographic algorithm. |
| cryptoFunctions | Array | Optional | The cryptographic functions implemented by the cryptographic algorithm. |
| classicalSecurityLevel | Integer | Optional | The classical security level that a cryptographic algorithm provides (in bits). |
| nistQuantumSecurityLevel | Integer | Optional | 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. |
Location: /components/[]/cryptoProperties/algorithmProperties/primitive
Type: String (enum)
Cryptographic 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).
| Value | 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. |
| key-wrap | Key-wrap is a cryptographic technique used to securely encrypt and protect cryptographic keys using algorithms like AES. |
| other | Another primitive type. |
| unknown | The primitive is not known. |
Location: /components/[]/cryptoProperties/algorithmProperties/algorithmFamily
Type: String (enum)
A valid algorithm family identifier. If specified, this value shall be one of the enumeration of valid algorithm Family identifiers defined in the cryptography-defs.schema.json subschema.
3DES
Blowfish
ECDH
Location: /components/[]/cryptoProperties/algorithmProperties/parameterSetIdentifier
Type: String
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).
Location: /components/[]/cryptoProperties/algorithmProperties/curve
Type: String
[Deprecated] This will be removed in a future version. Use @.ellipticCurve instead. 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.
Location: /components/[]/cryptoProperties/algorithmProperties/ellipticCurve
Type: String (enum)
The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. If specified, this value shall be one of the enumeration of valid elliptic curves identifiers defined in the cryptography-defs.schema.json subschema.
Location: /components/[]/cryptoProperties/algorithmProperties/executionEnvironment
Type: String (enum)
The target and execution environment in which the algorithm is implemented in.
| Value | 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. |
Location: /components/[]/cryptoProperties/algorithmProperties/implementationPlatform
Type: String (enum)
The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform.
Enumeration of possible values:Location: /components/[]/cryptoProperties/algorithmProperties/certificationLevel
Property: certificationLevel (Optional)
Type: Array (of String) (enum)
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). Each item of this array shall be a string.
| Value | 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 |
Location: /components/[]/cryptoProperties/algorithmProperties/mode
Type: String (enum)
The mode of operation in which the cryptographic algorithm (block cipher) is used.
| Value | 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 |
Location: /components/[]/cryptoProperties/algorithmProperties/padding
Type: String (enum)
The padding scheme that is used for the cryptographic algorithm.
| Value | 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 |
Location: /components/[]/cryptoProperties/algorithmProperties/cryptoFunctions
Property: cryptoFunctions (Optional)
Type: Array (of String) (enum)
The cryptographic functions implemented by the cryptographic algorithm. Each item of this array shall be a string.
Enumeration of possible values:Location: /components/[]/cryptoProperties/algorithmProperties/classicalSecurityLevel
Type: Integer
The classical security level that a cryptographic algorithm provides (in bits).
Location: /components/[]/cryptoProperties/algorithmProperties/nistQuantumSecurityLevel
Type: Integer
Maximum Value: 6
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.
Location: /components/[]/cryptoProperties/certificateProperties
Type: Object
Properties for cryptographic assets of asset type 'certificate'
| Property | Type | Requirement | Description |
|---|---|---|---|
| serialNumber | String | Optional | The serial number is a unique identifier for the certificate issued by a CA. |
| subjectName | String | Optional | The subject name for the certificate. |
| issuerName | String | Optional | The issuer name for the certificate. |
| notValidBefore | String | Optional | The date and time according to ISO-8601 standard from which the certificate is valid. |
| notValidAfter | String | Optional | The date and time according to ISO-8601 standard from which the certificate is not valid anymore. |
| signatureAlgorithmRef | String | Optional | [DEPRECATED] This will be removed in a future version. Use @.relatedCryptographicAssets instead. The bom-ref to signature algorithm used by the certificate. |
| subjectPublicKeyRef | String | Optional | [DEPRECATED] This will be removed in a future version. Use @.relatedCryptographicAssets instead. The bom-ref to the public key of the subject. |
| certificateFormat | String | Optional | The format of the certificate. |
| certificateExtension | String | Optional | [DEPRECATED] This will be removed in a future version. Use @.certificateFileExtension instead. The file extension of the certificate. |
| certificateFileExtension | String | Optional | The file extension of the certificate. |
| fingerprint | Object | Optional | The fingerprint is a cryptographic hash of the certificate excluding it's signature. |
| certificateState | Array | Optional | The certificate lifecycle is a comprehensive process that manages digital certificates from their initial creation to eventual expiration or revocation. It typically involves several stages. |
| creationDate | String | Optional | The date and time (timestamp) when the certificate was created or pre-activated. |
| activationDate | String | Optional | The date and time (timestamp) when the certificate was activated. |
| deactivationDate | String | Optional | The date and time (timestamp) when the related certificate was deactivated. |
| revocationDate | String | Optional | The date and time (timestamp) when the certificate was revoked. |
| destructionDate | String | Optional | The date and time (timestamp) when the certificate was destroyed. |
| certificateExtensions | Array | Optional | A certificate extension is a field that provides additional information about the certificate or its use. Extensions are used to convey additional information beyond the standard fields. |
| relatedCryptographicAssets | Array | Optional | A list of cryptographic assets related to this component. |
Location: /components/[]/cryptoProperties/certificateProperties/serialNumber
Type: String
The serial number is a unique identifier for the certificate issued by a CA.
Location: /components/[]/cryptoProperties/certificateProperties/subjectName
Type: String
The subject name for the certificate
Location: /components/[]/cryptoProperties/certificateProperties/issuerName
Type: String
The issuer name for the certificate
Location: /components/[]/cryptoProperties/certificateProperties/notValidBefore
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time according to ISO-8601 standard from which the certificate is valid
Location: /components/[]/cryptoProperties/certificateProperties/notValidAfter
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time according to ISO-8601 standard from which the certificate is not valid anymore
Location: /components/[]/cryptoProperties/certificateProperties/signatureAlgorithmRef
Type: String
[DEPRECATED] This will be removed in a future version. Use @.relatedCryptographicAssets instead. The bom-ref to signature algorithm used by the certificate
Location: /components/[]/cryptoProperties/certificateProperties/subjectPublicKeyRef
Type: String
[DEPRECATED] This will be removed in a future version. Use @.relatedCryptographicAssets instead. The bom-ref to the public key of the subject
Location: /components/[]/cryptoProperties/certificateProperties/certificateFormat
Type: String
The format of the certificate
X.509
PEM
DER
CVC
Location: /components/[]/cryptoProperties/certificateProperties/certificateExtension
Type: String
[DEPRECATED] This will be removed in a future version. Use @.certificateFileExtension instead. The file extension of the certificate
crt
pem
cer
der
p12
Location: /components/[]/cryptoProperties/certificateProperties/certificateFileExtension
Type: String
The file extension of the certificate.
crt
pem
cer
der
p12
Location: /components/[]/cryptoProperties/certificateProperties/fingerprint
Type: Object
The fingerprint is a cryptographic hash of the certificate excluding it's signature.
| Property | Type | Requirement | Description |
|---|---|---|---|
| alg | String | Required | The algorithm that generated the hash value. |
| content | String | Required | The value of the hash. |
Location: /components/[]/cryptoProperties/certificateProperties/fingerprint/alg
Type: String (enum)
The algorithm that generated the hash value.
Enumeration of possible values:Location: /components/[]/cryptoProperties/certificateProperties/fingerprint/content
Type: String
Pattern Constraint: ^([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})$
The value of the hash.
3942447fac867ae5cdb3229b658f4d48
Location: /components/[]/cryptoProperties/certificateProperties/certificateState
Property: certificateState (Optional)
Type: Array
The certificate lifecycle is a comprehensive process that manages digital certificates from their initial creation to eventual expiration or revocation. It typically involves several stages Each item of this array shall be a State object.
Location: /components/[]/cryptoProperties/certificateProperties/certificateState/[]
Type: Object
The state of the certificate.
Shall be one of:
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| state | String | Required | A pre-defined state in the certificate lifecycle. |
| reason | String | Optional | A reason for the certificate being in this state. |
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the certificate lifecycle state. |
| description | String | Optional | The description of the certificate lifecycle state. |
| reason | String | Optional | A reason for the certificate being in this state. |
Location: /components/[]/cryptoProperties/certificateProperties/certificateState/[]/state
Property: state (Required)
Type: String (enum)
A pre-defined state in the certificate lifecycle.
| Value | Description |
|---|---|
| pre-activation | The certificate has been issued by the issuing certificate authority (CA) but has not been authorized for use. |
| active | The certificate may be used to cryptographically protect information, cryptographically process previously protected information, or both. |
| deactivated | Certificates in the deactivated state shall not be used to apply cryptographic protection but, in some cases, may be used to process cryptographically protected information. |
| suspended | The use of a certificate may be suspended for several possible reasons. |
| revoked | A revoked certificate is a digital certificate that has been invalidated by the issuing certificate authority (CA) before its scheduled expiration date. |
| destroyed | The certificate has been destroyed. |
Location: /components/[]/cryptoProperties/certificateProperties/certificateState/[]/reason
Property: reason (Optional)
Type: String
A reason for the certificate being in this state.
Location: /components/[]/cryptoProperties/certificateProperties/certificateState/[]/name
Property: name (Required)
Type: String
The name of the certificate lifecycle state.
Location: /components/[]/cryptoProperties/certificateProperties/certificateState/[]/description
Property: description (Optional)
Type: String
The description of the certificate lifecycle state.
Location: /components/[]/cryptoProperties/certificateProperties/certificateState/[]/reason
Property: reason (Optional)
Type: String
A reason for the certificate being in this state.
Location: /components/[]/cryptoProperties/certificateProperties/creationDate
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the certificate was created or pre-activated.
Location: /components/[]/cryptoProperties/certificateProperties/activationDate
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the certificate was activated.
Location: /components/[]/cryptoProperties/certificateProperties/deactivationDate
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the related certificate was deactivated.
Location: /components/[]/cryptoProperties/certificateProperties/revocationDate
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the certificate was revoked.
Location: /components/[]/cryptoProperties/certificateProperties/destructionDate
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the certificate was destroyed.
Location: /components/[]/cryptoProperties/certificateProperties/certificateExtensions
Property: certificateExtensions (Optional)
Type: Array
A certificate extension is a field that provides additional information about the certificate or its use. Extensions are used to convey additional information beyond the standard fields. Each item of this array shall be an Extension object.
Location: /components/[]/cryptoProperties/certificateProperties/certificateExtensions/[]
Type: Object
Shall be one of:
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| commonExtensionName | String | Required | The name of the extension. |
| commonExtensionValue | String | Required | The value of the certificate extension. |
Type: Object
Custom extensions may convey application-specific or vendor-specific data not covered by standard extensions. The structure and semantics of custom extensions are typically defined outside of public standards. CycloneDX leverages properties to support this capability.
| Property | Type | Requirement | Description |
|---|---|---|---|
| customExtensionName | String | Required | The name for the custom certificate extension. |
| customExtensionValue | String | Optional | The description of the custom certificate extension. |
Location: /components/[]/cryptoProperties/certificateProperties/certificateExtensions/[]/commonExtensionName
Property: commonExtensionName (Required)
Type: String (enum)
The name of the extension.
| Value | Description |
|---|---|
| basicConstraints | Specifies whether a certificate can be used as a CA certificate or not. |
| keyUsage | Specifies the allowed uses of the public key in the certificate. |
| extendedKeyUsage | Specifies additional purposes for which the public key can be used. |
| subjectAlternativeName | Allows inclusion of additional names to identify the entity associated with the certificate. |
| authorityKeyIdentifier | Identifies the public key of the CA that issued the certificate. |
| subjectKeyIdentifier | Identifies the public key associated with the entity the certificate was issued to. |
| authorityInformationAccess | Contains CA issuers and OCSP information. |
| certificatePolicies | Defines the policies under which the certificate was issued and can be used. |
| crlDistributionPoints | Contains one or more URLs where a Certificate Revocation List (CRL) can be obtained. |
| signedCertificateTimestamp | Shows that the certificate has been publicly logged, which helps prevent the issuance of rogue certificates by a CA. Log ID, timestamp and signature as proof. |
Location: /components/[]/cryptoProperties/certificateProperties/certificateExtensions/[]/commonExtensionValue
Property: commonExtensionValue (Required)
Type: String
The value of the certificate extension.
Location: /components/[]/cryptoProperties/certificateProperties/certificateExtensions/[]/customExtensionName
Property: customExtensionName (Required)
Type: String
The name for the custom certificate extension.
Location: /components/[]/cryptoProperties/certificateProperties/certificateExtensions/[]/customExtensionValue
Property: customExtensionValue (Optional)
Type: String
The description of the custom certificate extension.
Location: /components/[]/cryptoProperties/certificateProperties/relatedCryptographicAssets
Property: relatedCryptographicAssets (Optional)
Type: Array
A list of cryptographic assets related to this component. Each item of this array shall be a Related Cryptographic Asset object.
Location: /components/[]/cryptoProperties/certificateProperties/relatedCryptographicAssets/[]
Type: Object
A cryptographic assets related to this component.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | Specifies the mechanism by which the cryptographic asset is secured by. |
| ref | String | Optional | The bom-ref to cryptographic asset. |
Location: /components/[]/cryptoProperties/certificateProperties/relatedCryptographicAssets/[]/type
Type: String
Specifies the mechanism by which the cryptographic asset is secured by.
publicKey
privateKey
algorithm
Location: /components/[]/cryptoProperties/certificateProperties/relatedCryptographicAssets/[]/ref
Type: String
The bom-ref to cryptographic asset.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties
Type: Object
Properties for cryptographic assets of asset type: related-crypto-material
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | The type for the related cryptographic material. |
| id | String | Optional | The unique identifier for the related cryptographic material. |
| state | String | Optional | The key state as defined by NIST SP 800-57. |
| algorithmRef | String | Optional | [DEPRECATED] Use @.relatedCryptographicAssets instead. The bom-ref to the algorithm used to generate the related cryptographic material. |
| creationDate | String | Optional | The date and time (timestamp) when the related cryptographic material was created. |
| activationDate | String | Optional | The date and time (timestamp) when the related cryptographic material was activated. |
| updateDate | String | Optional | The date and time (timestamp) when the related cryptographic material was updated. |
| expirationDate | String | Optional | The date and time (timestamp) when the related cryptographic material expires. |
| value | String | Optional | The associated value of the cryptographic material. |
| size | Integer | Optional | The size of the cryptographic asset (in bits). |
| format | String | Optional | The format of the related cryptographic material (e.g. P8, PEM, DER). |
| securedBy | Object | Optional | The mechanism by which the cryptographic asset is secured by. |
| fingerprint | Object | Optional | The fingerprint is a cryptographic hash of the asset. |
| relatedCryptographicAssets | Array | Optional | A list of cryptographic assets related to this component. |
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/type
Type: String (enum)
The type for the related cryptographic material
| Value | Description |
|---|---|
| private-key | The confidential key of a key pair used in asymmetric cryptography. |
| public-key | The non-confidential key of a key pair used in asymmetric cryptography. |
| secret-key | A key used to encrypt and decrypt messages in symmetric cryptography. |
| key | A piece of information, usually an octet string, which, when processed through a cryptographic algorithm, processes cryptographic data. |
| ciphertext | The result of encryption performed on plaintext using an algorithm (or cipher). |
| signature | A cryptographic value that is calculated from the data and a key known only by the signer. |
| digest | The output of the hash function. |
| initialization-vector | A fixed-size random or pseudo-random value used as an input parameter for cryptographic algorithms. |
| nonce | A random or pseudo-random number that can only be used once in a cryptographic communication. |
| seed | The input to a pseudo-random number generator. Different seeds generate different pseudo-random sequences. |
| salt | A value used in a cryptographic process, usually to ensure that the results of computations for one instance cannot be reused by an attacker. |
| shared-secret | A piece of data known only to the parties involved, in a secure communication. |
| tag | A message authentication code (MAC), sometimes known as an authentication tag, is a short piece of information used for authenticating and integrity-checking a message. |
| additional-data | An unspecified collection of data with relevance to cryptographic activity. |
| password | A secret word, phrase, or sequence of characters used during authentication or authorization. |
| credential | Establishes the identity of a party to communication, usually in the form of cryptographic keys or passwords. |
| token | An object encapsulating a security identity. |
| other | Another type of cryptographic asset. |
| unknown | The type of cryptographic asset is not known. |
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/id
Type: String
The unique identifier for the related cryptographic material.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/state
Type: String (enum)
The key state as defined by NIST SP 800-57.
Enumeration of possible values:Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/algorithmRef
Type: String
[DEPRECATED] Use @.relatedCryptographicAssets instead. The bom-ref to the algorithm used to generate the related cryptographic material.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/creationDate
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the related cryptographic material was created.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/activationDate
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the related cryptographic material was activated.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/updateDate
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the related cryptographic material was updated.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/expirationDate
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the related cryptographic material expires.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/value
Type: String
The associated value of the cryptographic material.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/size
Type: Integer
The size of the cryptographic asset (in bits).
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/format
Type: String
The format of the related cryptographic material (e.g. P8, PEM, DER).
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/securedBy
Type: Object
The mechanism by which the cryptographic asset is secured by.
| Property | Type | Requirement | Description |
|---|---|---|---|
| mechanism | String | Optional | Specifies the mechanism by which the cryptographic asset is secured by. |
| algorithmRef | String | Optional | The bom-ref to the algorithm. |
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/securedBy/mechanism
Type: String
Specifies the mechanism by which the cryptographic asset is secured by.
HSM
TPM
SGX
Software
None
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/securedBy/algorithmRef
Type: String
The bom-ref to the algorithm.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/fingerprint
Type: Object
The fingerprint is a cryptographic hash of the asset.
| Property | Type | Requirement | Description |
|---|---|---|---|
| alg | String | Required | The algorithm that generated the hash value. |
| content | String | Required | The value of the hash. |
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/fingerprint/alg
Type: String (enum)
The algorithm that generated the hash value.
Enumeration of possible values:Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/fingerprint/content
Type: String
Pattern Constraint: ^([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})$
The value of the hash.
3942447fac867ae5cdb3229b658f4d48
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/relatedCryptographicAssets
Property: relatedCryptographicAssets (Optional)
Type: Array
A list of cryptographic assets related to this component. Each item of this array shall be a Related Cryptographic Asset object.
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/relatedCryptographicAssets/[]
Type: Object
A cryptographic assets related to this component.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | Specifies the mechanism by which the cryptographic asset is secured by. |
| ref | String | Optional | The bom-ref to cryptographic asset. |
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/relatedCryptographicAssets/[]/type
Type: String
Specifies the mechanism by which the cryptographic asset is secured by.
publicKey
privateKey
algorithm
Location: /components/[]/cryptoProperties/relatedCryptoMaterialProperties/relatedCryptographicAssets/[]/ref
Type: String
The bom-ref to cryptographic asset.
Location: /components/[]/cryptoProperties/protocolProperties
Type: Object
Properties specific to cryptographic assets of type: protocol.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | The concrete protocol type. |
| version | String | Optional | The version of the protocol. |
| cipherSuites | Array | Optional | A list of cipher suites related to the protocol. |
| ikev2TransformTypes | Object | Optional | The IKEv2 transform types supported (types 1-4), defined in RFC 7296 section 3.3.2, and additional properties. |
| cryptoRefArray | Array | Optional | [DEPRECATED] Use @.relatedCryptographicAssets instead. A list of protocol-related cryptographic assets. |
| relatedCryptographicAssets | Array | Optional | A list of cryptographic assets related to this component. |
Location: /components/[]/cryptoProperties/protocolProperties/type
Type: String (enum)
The concrete protocol type.
| Value | 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 |
| dtls | Datagram Transport Layer Security |
| quic | Quick UDP Internet Connections |
| eap-aka | Extensible Authentication Protocol variant |
| eap-aka-prime | Enhanced version of EAP-AKA |
| prins | Protection of Inter-Network Signaling |
| 5g-aka | Authentication and Key Agreement for 5G |
| other | Another protocol type |
| unknown | The protocol type is not known |
Location: /components/[]/cryptoProperties/protocolProperties/version
Type: String
The version of the protocol.
1.0
1.2
1.99
Location: /components/[]/cryptoProperties/protocolProperties/cipherSuites
Property: cipherSuites (Optional)
Type: Array
A list of cipher suites related to the protocol. Each item of this array shall be a Cipher Suite object.
Location: /components/[]/cryptoProperties/protocolProperties/cipherSuites/[]
Type: Object
Object representing a cipher suite
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | A common name for the cipher suite. |
| algorithms | Array | Optional | A list of algorithms related to the cipher suite. |
| identifiers | Array | Optional | A list of common identifiers for the cipher suite. |
| tlsGroups | Array | Optional | A list of TLS named groups (formerly known as curves) for this cipher suite. These groups define the parameters for key exchange algorithms like ECDHE. |
| tlsSignatureSchemes | Array | Optional | A list of signature schemes supported for cipher suite. These schemes specify the algorithms used for digital signatures in TLS handshakes and certificate verification. |
Location: /components/[]/cryptoProperties/protocolProperties/cipherSuites/[]/name
Type: String
A common name for the cipher suite.
TLS_DHE_RSA_WITH_AES_128_CCM
Location: /components/[]/cryptoProperties/protocolProperties/cipherSuites/[]/algorithms
Property: algorithms (Optional)
Type: Array (of String)
A list of algorithms related to the cipher suite. The bom-ref to algorithm cryptographic asset. Each item of this array shall be a string.
Location: /components/[]/cryptoProperties/protocolProperties/cipherSuites/[]/identifiers
Property: identifiers (Optional)
Type: Array (of String)
A list of common identifiers for the cipher suite. Cipher suite identifier Each item of this array shall be a string.
0xC0
0x9E
Location: /components/[]/cryptoProperties/protocolProperties/cipherSuites/[]/tlsGroups
Property: tlsGroups (Optional)
Type: Array (of String)
A list of TLS named groups (formerly known as curves) for this cipher suite. These groups define the parameters for key exchange algorithms like ECDHE. The name of the TLS group Each item of this array shall be a string.
x25519
ffdhe2048
Location: /components/[]/cryptoProperties/protocolProperties/cipherSuites/[]/tlsSignatureSchemes
Property: tlsSignatureSchemes (Optional)
Type: Array (of String)
A list of signature schemes supported for cipher suite. These schemes specify the algorithms used for digital signatures in TLS handshakes and certificate verification. The name of the TLS signature scheme Each item of this array shall be a string.
ecdsa_secp256r1_sha256
rsa_pss_rsae_sha256
ed25519
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes
Type: Object
The IKEv2 transform types supported (types 1-4), defined in RFC 7296 section 3.3.2, and additional properties.
| Property | Type | Requirement | Description |
|---|---|---|---|
| encr | Array | Optional | Transform Type 1: encryption algorithms. |
| prf | Array | Optional | Transform Type 2: pseudorandom functions. |
| integ | Array | Optional | Transform Type 3: integrity algorithms. |
| ke | Array | Optional | Transform Type 4: Key Exchange Method (KE) per RFC 9370, formerly called Diffie-Hellman Group (D-H). |
| esn | Boolean | Optional | Specifies if an Extended Sequence Number (ESN) is used. |
| auth | Array | Optional | IKEv2 Authentication method per RFC9593. |
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/encr
Transform Type 1: encryption algorithms
Shall be any of:
Type: Array
Type: Array
[DEPRECATED] This will be removed in a future version. Transform Type 1: encryption algorithms
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/encr
Property: encr
Type: Array
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/encr/[]
Type: Object
Object representing an encryption algorithm (ENCR)
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | A name for the encryption method. |
| keyLength | Integer | Optional | The key length of the encryption algorithm. |
| algorithm | String | Optional | The bom-ref to algorithm cryptographic asset. |
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/encr/[]/name
Type: String
A name for the encryption method.
ENCR_AES_GCM_16
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/encr/[]/keyLength
Type: Integer
The key length of the encryption algorithm.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/encr/[]/algorithm
Type: String
The bom-ref to algorithm cryptographic asset.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/encr
Property: encr
Type: Array (of String)
[DEPRECATED] This will be removed in a future version. Transform Type 1: encryption algorithms Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. Each item of this array shall be a string.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/prf
Transform Type 2: pseudorandom functions
Shall be any of:
Type: Array
Type: Array
[DEPRECATED] This will be removed in a future version. Transform Type 2: pseudorandom functions
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/prf
Property: prf
Type: Array
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/prf/[]
Type: Object
Object representing a pseudorandom function (PRF)
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | A name for the pseudorandom function. |
| algorithm | String | Optional | The bom-ref to algorithm cryptographic asset. |
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/prf/[]/name
Type: String
A name for the pseudorandom function.
PRF_HMAC_SHA2_256
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/prf/[]/algorithm
Type: String
The bom-ref to algorithm cryptographic asset.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/prf
Property: prf
Type: Array (of String)
[DEPRECATED] This will be removed in a future version. Transform Type 2: pseudorandom functions Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. Each item of this array shall be a string.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/integ
Transform Type 3: integrity algorithms
Shall be any of:
Type: Array
Type: Array
[DEPRECATED] This will be removed in a future version. Transform Type 3: integrity algorithms
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/integ
Property: integ
Type: Array
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/integ/[]
Type: Object
Object representing an integrity algorithm (INTEG)
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | A name for the integrity algorithm. |
| algorithm | String | Optional | The bom-ref to algorithm cryptographic asset. |
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/integ/[]/name
Type: String
A name for the integrity algorithm.
AUTH_HMAC_SHA2_256_128
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/integ/[]/algorithm
Type: String
The bom-ref to algorithm cryptographic asset.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/integ
Property: integ
Type: Array (of String)
[DEPRECATED] This will be removed in a future version. Transform Type 3: integrity algorithms Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. Each item of this array shall be a string.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/ke
Transform Type 4: Key Exchange Method (KE) per RFC 9370, formerly called Diffie-Hellman Group (D-H).
Shall be any of:
Type: Array
Type: Array
[DEPRECATED] This will be removed in a future version. Transform Type 4: Key Exchange Method (KE) per RFC 9370, formerly called Diffie-Hellman Group (D-H).
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/ke
Property: ke
Type: Array
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/ke/[]
Type: Object
Object representing a key exchange method (KE)
| Property | Type | Requirement | Description |
|---|---|---|---|
| group | Integer | Optional | A group identifier for the key exchange algorithm. |
| algorithm | String | Optional | The bom-ref to algorithm cryptographic asset. |
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/ke/[]/group
Type: Integer
A group identifier for the key exchange algorithm.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/ke/[]/algorithm
Type: String
The bom-ref to algorithm cryptographic asset.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/ke
Property: ke
Type: Array (of String)
[DEPRECATED] This will be removed in a future version. Transform Type 4: Key Exchange Method (KE) per RFC 9370, formerly called Diffie-Hellman Group (D-H). Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. Each item of this array shall be a string.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/esn
Type: Boolean
Specifies if an Extended Sequence Number (ESN) is used.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/auth
IKEv2 Authentication method per RFC9593.
Shall be any of:
Type: Array
Type: Array
[DEPRECATED] This will be removed in a future version. IKEv2 Authentication method
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/auth
Property: auth
Type: Array
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/auth/[]
Type: Object
Object representing a IKEv2 Authentication method
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | A name for the authentication method. |
| algorithm | String | Optional | The bom-ref to algorithm cryptographic asset. |
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/auth/[]/name
Type: String
A name for the authentication method.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/auth/[]/algorithm
Type: String
The bom-ref to algorithm cryptographic asset.
Location: /components/[]/cryptoProperties/protocolProperties/ikev2TransformTypes/auth
Property: auth
Type: Array (of String)
[DEPRECATED] This will be removed in a future version. IKEv2 Authentication method Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. Each item of this array shall be a string.
Location: /components/[]/cryptoProperties/protocolProperties/cryptoRefArray
Property: cryptoRefArray (Optional)
Type: Array (of String)
[DEPRECATED] Use @.relatedCryptographicAssets instead. A list of protocol-related cryptographic assets Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. Each item of this array shall be a string.
Location: /components/[]/cryptoProperties/protocolProperties/relatedCryptographicAssets
Property: relatedCryptographicAssets (Optional)
Type: Array
A list of cryptographic assets related to this component. Each item of this array shall be a Related Cryptographic Asset object.
Location: /components/[]/cryptoProperties/protocolProperties/relatedCryptographicAssets/[]
Type: Object
A cryptographic assets related to this component.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | Specifies the mechanism by which the cryptographic asset is secured by. |
| ref | String | Optional | The bom-ref to cryptographic asset. |
Location: /components/[]/cryptoProperties/protocolProperties/relatedCryptographicAssets/[]/type
Type: String
Specifies the mechanism by which the cryptographic asset is secured by.
publicKey
privateKey
algorithm
Location: /components/[]/cryptoProperties/protocolProperties/relatedCryptographicAssets/[]/ref
Type: String
The bom-ref to cryptographic asset.
Location: /components/[]/cryptoProperties/oid
Type: String
The object identifier (OID) of the cryptographic asset.
Location: /components/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /components/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /components/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /components/[]/properties/[]/value
Type: String
The value of the property.
Location: /components/[]/tags
Property: tags (Optional)
Type: Array (of String)
Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes. Each item of this array shall be a string.
json-parser
object-persistence
text-to-image
translation
object-detection
Location: /components/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /services
Property: services (Optional)
Type: Array
Uniqueness: All items shall be unique.
A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services. Each item of this array shall be a Service object.
Location: /services/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| provider | Object | Optional | The organization that provides the service. |
| group | String | Optional | 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. |
| name | String | Required | The name of the service. This will often be a shortened, single name of the service. |
| version | String | Optional | The service version. |
| description | String | Optional | Specifies a description for the service. |
| endpoints | Array | Optional | The endpoint URIs of the service. Multiple endpoints are allowed. |
| authenticated | Boolean | Optional | 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. |
| x-trust-boundary | Boolean | Optional | 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. |
| trustZone | String | Optional | The name of the trust zone the service resides in. |
| data | Array | Optional | Specifies information about the data including the directional flow of data and the data classification. |
| licenses | Array | Optional | A list of SPDX licenses and/or named licenses and/or SPDX Licence Expression. |
| patentAssertions | Array | Optional | A list of assertions made regarding patents associated with this component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents. |
| externalReferences | Array | Optional | 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. |
| services | Array | Optional | 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. |
| releaseNotes | Object | Optional | Specifies release notes. |
| properties | Array | Optional | 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. |
| tags | Array | Optional | 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. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /services/[]/bom-ref
Type: String
An identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/provider
Type: Object
The organization that provides the service.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /services/[]/provider/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/provider/name
Type: String
The name of the organization
Example Inc.
Location: /services/[]/provider/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /services/[]/provider/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/provider/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /services/[]/provider/address/region
Type: String
The region or state in the country.
Texas
Location: /services/[]/provider/address/locality
Type: String
The locality or city within the country.
Austin
Location: /services/[]/provider/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /services/[]/provider/address/postalCode
Type: String
The postal code.
78758
Location: /services/[]/provider/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /services/[]/provider/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /services/[]/provider/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /services/[]/provider/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /services/[]/provider/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/provider/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /services/[]/provider/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /services/[]/provider/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /services/[]/group
Type: String
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
Location: /services/[]/name
Type: String
The name of the service. This will often be a shortened, single name of the service.
ticker-service
Location: /services/[]/version
Type: String
The service version.
9.0.14
v1.33.7
7.0.0-M1
2.0pre1
1.0.0-beta1
0.8.15
Location: /services/[]/description
Type: String
Specifies a description for the service
Location: /services/[]/endpoints
Property: endpoints (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The endpoint URIs of the service. Multiple endpoints are allowed. Each item of this array shall be a string.
https://example.com/api/v1/ticker
Location: /services/[]/authenticated
Type: Boolean
A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication.
Location: /services/[]/x-trust-boundary
Type: Boolean
A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed.
Location: /services/[]/trustZone
Type: String
The name of the trust zone the service resides in.
Location: /services/[]/data
Property: data (Optional)
Type: Array
Specifies information about the data including the directional flow of data and the data classification. Each item of this array shall be a Hash Objects object.
Location: /services/[]/data/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| flow | String | Required | Specifies 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. |
| classification | String | Required | Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed. |
| name | String | Optional | Name for the defined data. |
| description | String | Optional | Short description of the data content and usage. |
| governance | Object | Optional | 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. |
| source | Array | Optional | The URI, URL, or BOM-Link of the components or services the data came in from. |
| destination | Array | Optional | The URI, URL, or BOM-Link of the components or services the data is sent to. |
Location: /services/[]/data/[]/flow
Type: String (enum)
Specifies 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.
| Value | 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. |
Location: /services/[]/data/[]/classification
Type: String
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
Location: /services/[]/data/[]/name
Type: String
Name for the defined data
Credit card reporting
Location: /services/[]/data/[]/description
Type: String
Short description of the data content and usage
Credit card information being exchanged in between the web app and the database
Location: /services/[]/data/[]/governance
Type: Object
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
| Property | Type | Requirement | Description |
|---|---|---|---|
| custodians | Array | Optional | Data custodians are responsible for the safe custody, transport, and storage of data. |
| stewards | Array | Optional | Data stewards are responsible for data content, context, and associated business rules. |
| owners | Array | Optional | Data owners are concerned with risk and appropriate access to data. |
Location: /services/[]/data/[]/governance/custodians
Property: custodians (Optional)
Type: Array
Data custodians are responsible for the safe custody, transport, and storage of data.
Location: /services/[]/data/[]/governance/custodians/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /services/[]/data/[]/governance/custodians/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /services/[]/data/[]/governance/custodians/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/custodians/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /services/[]/data/[]/governance/custodians/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /services/[]/data/[]/governance/custodians/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/custodians/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /services/[]/data/[]/governance/custodians/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /services/[]/data/[]/governance/custodians/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /services/[]/data/[]/governance/custodians/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /services/[]/data/[]/governance/custodians/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /services/[]/data/[]/governance/custodians/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /services/[]/data/[]/governance/custodians/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /services/[]/data/[]/governance/custodians/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /services/[]/data/[]/governance/custodians/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /services/[]/data/[]/governance/custodians/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/custodians/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /services/[]/data/[]/governance/custodians/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /services/[]/data/[]/governance/custodians/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /services/[]/data/[]/governance/custodians/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /services/[]/data/[]/governance/custodians/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/custodians/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /services/[]/data/[]/governance/custodians/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /services/[]/data/[]/governance/custodians/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /services/[]/data/[]/governance/stewards
Property: stewards (Optional)
Type: Array
Data stewards are responsible for data content, context, and associated business rules.
Location: /services/[]/data/[]/governance/stewards/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /services/[]/data/[]/governance/stewards/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /services/[]/data/[]/governance/stewards/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/stewards/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /services/[]/data/[]/governance/stewards/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /services/[]/data/[]/governance/stewards/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/stewards/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /services/[]/data/[]/governance/stewards/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /services/[]/data/[]/governance/stewards/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /services/[]/data/[]/governance/stewards/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /services/[]/data/[]/governance/stewards/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /services/[]/data/[]/governance/stewards/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /services/[]/data/[]/governance/stewards/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /services/[]/data/[]/governance/stewards/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /services/[]/data/[]/governance/stewards/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /services/[]/data/[]/governance/stewards/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/stewards/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /services/[]/data/[]/governance/stewards/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /services/[]/data/[]/governance/stewards/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /services/[]/data/[]/governance/stewards/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /services/[]/data/[]/governance/stewards/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/stewards/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /services/[]/data/[]/governance/stewards/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /services/[]/data/[]/governance/stewards/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /services/[]/data/[]/governance/owners
Property: owners (Optional)
Type: Array
Data owners are concerned with risk and appropriate access to data.
Location: /services/[]/data/[]/governance/owners/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /services/[]/data/[]/governance/owners/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /services/[]/data/[]/governance/owners/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/owners/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /services/[]/data/[]/governance/owners/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /services/[]/data/[]/governance/owners/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/owners/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /services/[]/data/[]/governance/owners/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /services/[]/data/[]/governance/owners/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /services/[]/data/[]/governance/owners/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /services/[]/data/[]/governance/owners/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /services/[]/data/[]/governance/owners/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /services/[]/data/[]/governance/owners/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /services/[]/data/[]/governance/owners/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /services/[]/data/[]/governance/owners/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /services/[]/data/[]/governance/owners/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/owners/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /services/[]/data/[]/governance/owners/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /services/[]/data/[]/governance/owners/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /services/[]/data/[]/governance/owners/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /services/[]/data/[]/governance/owners/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/data/[]/governance/owners/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /services/[]/data/[]/governance/owners/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /services/[]/data/[]/governance/owners/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /services/[]/data/[]/source
Property: source (Optional)
Type: Array
The URI, URL, or BOM-Link of the components or services the data came in from
Location: /services/[]/data/[]/source/[]
Shall be any of:
Type: String
Format: iri-reference as specified in RFC 3987
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /services/[]/data/[]/destination
Property: destination (Optional)
Type: Array
The URI, URL, or BOM-Link of the components or services the data is sent to
Location: /services/[]/data/[]/destination/[]
Shall be any of:
Type: String
Format: iri-reference as specified in RFC 3987
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /services/[]/licenses
Property: licenses (Optional)
Type: Array
A list of SPDX licenses and/or named licenses and/or SPDX Licence Expression.
Location: /services/[]/licenses/[]
Location: /services/[]/patentAssertions
Property: patentAssertions (Optional)
Type: Array
A list of assertions made regarding patents associated with this component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents. Each item of this array shall be a Patent Assertion object.
Location: /services/[]/patentAssertions/[]
Type: Object
An assertion linking a patent or patent family to this component or service.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | A reference to the patent or patent family object within the BOM. This shall match the bom-ref of a patent or patentFamily object. |
| assertionType | String | Required | The type of assertion being made about the patent or patent family. Examples include ownership, licensing, and standards inclusion. |
| patentRefs | Array | Optional | A list of BOM references (bom-ref) linking to patents or patent families associated with this assertion. |
| asserter | Array | Required | undefined. |
| notes | String | Optional | Additional notes or clarifications regarding the assertion, if necessary. For example, geographical restrictions, duration, or limitations of a licence. |
Location: /services/[]/patentAssertions/[]/bom-ref
Type: String
A reference to the patent or patent family object within the BOM. This shall match the bom-ref of a patent or patentFamily object.
Location: /services/[]/patentAssertions/[]/assertionType
Type: String (enum)
The type of assertion being made about the patent or patent family. Examples include ownership, licensing, and standards inclusion.
| Value | Description |
|---|---|
| ownership | The manufacturer asserts ownership of the patent or patent family. |
| license | The manufacturer asserts they have a licence to use the patent or patent family. |
| third-party-claim | A third party has asserted a claim or potential infringement against the manufacturer’s component or service. |
| standards-inclusion | The patent is part of a standard essential patent (SEP) portfolio relevant to the component or service. |
| prior-art | The manufacturer asserts the patent or patent family as prior art that invalidates another patent or claim. |
| exclusive-rights | The manufacturer asserts exclusive rights granted through a licensing agreement. |
| non-assertion | The manufacturer asserts they will not enforce the patent or patent family against certain uses or users. |
| research-or-evaluation | The patent or patent family is being used under a research or evaluation licence. |
Location: /services/[]/patentAssertions/[]/patentRefs
Property: patentRefs (Optional)
Type: Array (of String)
A list of BOM references (bom-ref) linking to patents or patent families associated with this assertion. Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. Each item of this array shall be a string.
Location: /services/[]/patentAssertions/[]/asserter
Shall be one of:
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Type: String
A reference to a previously defined organizationalContact or organizationalEntity object in the BOM. The value shall be a valid bom-ref pointing to one of these objects.
Location: /services/[]/patentAssertions/[]/asserter/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/patentAssertions/[]/asserter/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /services/[]/patentAssertions/[]/asserter/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /services/[]/patentAssertions/[]/asserter/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/patentAssertions/[]/asserter/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /services/[]/patentAssertions/[]/asserter/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /services/[]/patentAssertions/[]/asserter/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /services/[]/patentAssertions/[]/asserter/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /services/[]/patentAssertions/[]/asserter/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /services/[]/patentAssertions/[]/asserter/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /services/[]/patentAssertions/[]/asserter/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /services/[]/patentAssertions/[]/asserter/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /services/[]/patentAssertions/[]/asserter/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /services/[]/patentAssertions/[]/asserter/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/patentAssertions/[]/asserter/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /services/[]/patentAssertions/[]/asserter/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /services/[]/patentAssertions/[]/asserter/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /services/[]/patentAssertions/[]/asserter/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /services/[]/patentAssertions/[]/asserter/name
Property: name (Optional)
Type: String
The name of a contact
Contact name
Location: /services/[]/patentAssertions/[]/asserter/email
Property: email (Optional)
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /services/[]/patentAssertions/[]/asserter/phone
Property: phone (Optional)
Type: String
The phone number of the contact.
800-555-1212
Location: /services/[]/patentAssertions/[]/notes
Type: String
Additional notes or clarifications regarding the assertion, if necessary. For example, geographical restrictions, duration, or limitations of a licence.
Location: /services/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /services/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
Location: /services/[]/services
Property: services (Optional)
Type: Array
Uniqueness: All items shall be unique.
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. Each item of this array shall be a Service object.
Location: /services/[]/services/[]
Type: Object
Location: /services/[]/releaseNotes
Type: Object
Specifies release notes.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Required | The software versioning type the release note describes. |
| title | String | Optional | The title of the release. |
| featuredImage | String | Optional | The URL to an image that may be prominently displayed with the release note. |
| socialImage | String | Optional | The URL to an image that may be used in messaging on social media platforms. |
| description | String | Optional | A short description of the release. |
| timestamp | String | Optional | The date and time (timestamp) when the release note was created. |
| aliases | Array | Optional | 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). |
| tags | Array | Optional | 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. |
| resolves | Array | Optional | A collection of issues that have been resolved. |
| notes | Array | Optional | 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. |
| properties | Array | Optional | 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. |
Location: /services/[]/releaseNotes/type
Type: String
The software versioning type the release note describes.
major
minor
patch
pre-release
internal
Location: /services/[]/releaseNotes/title
Type: String
The title of the release.
Location: /services/[]/releaseNotes/featuredImage
Type: String
Format: iri-reference as specified in RFC 3987
The URL to an image that may be prominently displayed with the release note.
Location: /services/[]/releaseNotes/socialImage
Type: String
Format: iri-reference as specified in RFC 3987
The URL to an image that may be used in messaging on social media platforms.
Location: /services/[]/releaseNotes/description
Type: String
A short description of the release.
Location: /services/[]/releaseNotes/timestamp
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the release note was created.
Location: /services/[]/releaseNotes/aliases
Property: aliases (Optional)
Type: Array (of String)
One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names). Each item of this array shall be a string.
Location: /services/[]/releaseNotes/tags
Property: tags (Optional)
Type: Array (of String)
Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes. Each item of this array shall be a string.
json-parser
object-persistence
text-to-image
translation
object-detection
Location: /services/[]/releaseNotes/resolves
Property: resolves (Optional)
Type: Array
A collection of issues that have been resolved. Each item of this array shall be an Issue object.
Location: /services/[]/releaseNotes/resolves/[]
Type: Object
An individual issue that has been resolved.
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Required | Specifies the type of issue. |
| id | String | Optional | The identifier of the issue assigned by the source of the issue. |
| name | String | Optional | The name of the issue. |
| description | String | Optional | A description of the issue. |
| source | Object | Optional | The source of the issue where it is documented. |
| references | Array | Optional | A collection of URL's for reference. Multiple URLs are allowed. |
Location: /services/[]/releaseNotes/resolves/[]/type
Type: String (enum)
Specifies the type of issue
| Value | Description |
|---|---|
| defect | A fault, flaw, or bug in software. |
| enhancement | A new feature or behaviour in software. |
| security | A special type of defect which impacts security. |
Location: /services/[]/releaseNotes/resolves/[]/id
Type: String
The identifier of the issue assigned by the source of the issue
Location: /services/[]/releaseNotes/resolves/[]/name
Type: String
The name of the issue
Location: /services/[]/releaseNotes/resolves/[]/description
Type: String
A description of the issue
Location: /services/[]/releaseNotes/resolves/[]/source
Type: Object
The source of the issue where it is documented
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the source. |
| url | String | Optional | The url of the issue documentation as provided by the source. |
Location: /services/[]/releaseNotes/resolves/[]/source/name
Type: String
The name of the source.
National Vulnerability Database
NVD
Apache
Location: /services/[]/releaseNotes/resolves/[]/source/url
Type: String
Format: iri-reference as specified in RFC 3987
The url of the issue documentation as provided by the source
Location: /services/[]/releaseNotes/resolves/[]/references
Property: references (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
A collection of URL's for reference. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /services/[]/releaseNotes/notes
Property: notes (Optional)
Type: Array
Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages. Each item of this array shall be a Note object.
Location: /services/[]/releaseNotes/notes/[]
Type: Object
A note containing the locale and content.
| Property | Type | Requirement | Description |
|---|---|---|---|
| locale | String | Optional | The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA". |
| text | Object | Required | Specifies the full content of the release note. |
Location: /services/[]/releaseNotes/notes/[]/locale
Type: String
Pattern Constraint: ^([a-z]{2})(-[A-Z]{2})?$
The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA"
Location: /services/[]/releaseNotes/notes/[]/text
Type: Object
Specifies the full content of the release note.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /services/[]/releaseNotes/notes/[]/text/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /services/[]/releaseNotes/notes/[]/text/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /services/[]/releaseNotes/notes/[]/text/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /services/[]/releaseNotes/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /services/[]/releaseNotes/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /services/[]/releaseNotes/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /services/[]/releaseNotes/properties/[]/value
Type: String
The value of the property.
Location: /services/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /services/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /services/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /services/[]/properties/[]/value
Type: String
The value of the property.
Location: /services/[]/tags
Property: tags (Optional)
Type: Array (of String)
Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes. Each item of this array shall be a string.
json-parser
object-persistence
text-to-image
translation
object-detection
Location: /services/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
| Property | Type | Requirement | Description |
|---|---|---|---|
| url | Array | Required | The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs. |
| comment | String | Optional | A comment describing the external reference. |
| type | String | Required | Specifies the type of external reference. |
| hashes | Array | Optional | The hashes of the external reference (if applicable). |
| properties | Array | Optional | 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. |
Location: /externalReferences/[]/url
The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Shall be any of:
Type: String
Format: iri-reference as specified in RFC 3987
Type: Object
Location: /externalReferences/[]/comment
Type: String
A comment describing the external reference
Location: /externalReferences/[]/type
Type: String (enum)
Specifies the type of external reference.
| Value | 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 licence file. If a licence URL has been defined in the licence 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 the formulation of any referencable object within the BOM, including components, services, metadata, declarations, or the BOM itself. |
| 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) |
| patent | References information about patents which may be defined in human-readable documents or in machine-readable formats such as CycloneDX or ST.96. For detailed patent information or to reference the information provided directly by patent offices, it is recommended to leverage standards from the World Intellectual Property Organization (WIPO) such as ST.96. |
| patent-family | References information about a patent family which may be defined in human-readable documents or in machine-readable formats such as CycloneDX or ST.96. A patent family is a group of related patent applications or granted patents that cover the same or similar invention. For detailed patent family information or to reference the information provided directly by patent offices, it is recommended to leverage standards from the World Intellectual Property Organization (WIPO) such as ST.96. |
| patent-assertion | References assertions made regarding patents associated with a component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents. |
| citation | A reference to external citations applicable to the object identified by this BOM entry or the BOM itself. When used with a BOM-Link, this allows offloading citations into a separate CycloneDX BOM. |
| other | Use this if no other types accurately describe the purpose of the external reference. |
Location: /externalReferences/[]/hashes
Property: hashes (Optional)
Type: Array
The hashes of the external reference (if applicable). Each item of this array shall be a Hash object.
Location: /externalReferences/[]/hashes/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| alg | String | Required | The algorithm that generated the hash value. |
| content | String | Required | The value of the hash. |
Location: /externalReferences/[]/hashes/[]/alg
Type: String (enum)
The algorithm that generated the hash value.
Enumeration of possible values:Location: /externalReferences/[]/hashes/[]/content
Type: String
Pattern Constraint: ^([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})$
The value of the hash.
3942447fac867ae5cdb3229b658f4d48
Location: /externalReferences/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /externalReferences/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /externalReferences/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /externalReferences/[]/properties/[]/value
Type: String
The value of the property.
Location: /dependencies
Property: dependencies (Optional)
Type: Array
Uniqueness: All items shall be unique.
Provides the ability to document dependency relationships including provided & implemented components. Each item of this array shall be a Dependency object.
Location: /dependencies/[]
Type: Object
Defines the direct dependencies of a component, service, or the components provided/implemented by a given component. Components or services that do not have their own dependencies shall be declared as empty elements within the graph. Components or services that are not represented in the dependency graph may have unknown dependencies. It is recommended that implementations assume this to be opaque and not an indicator of an object being dependency-free. It is recommended to leverage compositions to indicate unknown dependency graphs.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | String | Required | References a component or service by its bom-ref attribute. |
| dependsOn | Array | Optional | The bom-ref identifiers of the components or services that are dependencies of this dependency object. |
| provides | Array | Optional | The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object. For example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use. |
Location: /dependencies/[]/ref
Type: String
References a component or service by its bom-ref attribute
Location: /dependencies/[]/dependsOn
Property: dependsOn (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services that are dependencies of this dependency object. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /dependencies/[]/provides
Property: provides (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object. For example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /compositions
Property: compositions (Optional)
Type: Array
Uniqueness: All items shall be unique.
Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described. Each item of this array shall be a Compositions object.
Location: /compositions/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| aggregate | String | Required | Specifies an aggregate type that describes how complete a relationship is. |
| assemblies | Array | Optional | The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only. |
| dependencies | Array | Optional | The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only. |
| vulnerabilities | Array | Optional | The bom-ref identifiers of the vulnerabilities being described. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /compositions/[]/bom-ref
Type: String
An identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /compositions/[]/aggregate
Type: String (enum)
Default Value: not_specified
Specifies an aggregate type that describes how complete a relationship is.
| Value | Description |
|---|---|
| complete | The relationship is complete. No further relationships including constituent components, services, or dependencies are known to exist. |
| incomplete | The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies. |
| incomplete_first_party_only | The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented. |
| incomplete_first_party_proprietary_only | The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are proprietary. |
| incomplete_first_party_opensource_only | The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are opensource. |
| incomplete_third_party_only | The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented. |
| incomplete_third_party_proprietary_only | The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary. |
| incomplete_third_party_opensource_only | The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource. |
| unknown | The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive. |
| not_specified | The relationship completeness is not specified. |
Location: /compositions/[]/assemblies
Property: assemblies (Optional)
Type: Array
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only.
Location: /compositions/[]/assemblies/[]
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /compositions/[]/dependencies
Property: dependencies (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only. Each item of this array shall be a string.
Location: /compositions/[]/vulnerabilities
Property: vulnerabilities (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the vulnerabilities being described. Each item of this array shall be a string.
Location: /compositions/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /vulnerabilities
Property: vulnerabilities (Optional)
Type: Array
Uniqueness: All items shall be unique.
Vulnerabilities identified in components or services. Each item of this array shall be a Vulnerability object.
Location: /vulnerabilities/[]
Type: Object
Defines a weakness in a component or service that could be exploited or triggered by a threat source.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| id | String | Optional | The identifier that uniquely identifies the vulnerability. |
| source | Object | Optional | The source that published the vulnerability. |
| references | Array | Optional | Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence. |
| ratings | Array | Optional | List of vulnerability ratings. |
| cwes | Array | Optional | List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability. |
| description | String | Optional | A description of the vulnerability as provided by the source. |
| detail | String | Optional | If available, an in-depth description of the vulnerability as provided by the source organization. Details often include information useful in understanding root cause. |
| recommendation | String | Optional | Recommendations of how the vulnerability can be remediated or mitigated. |
| workaround | String | Optional | A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments. |
| proofOfConcept | Object | Optional | Evidence used to reproduce the vulnerability. |
| advisories | Array | Optional | Published advisories of the vulnerability if provided. |
| created | String | Optional | The date and time (timestamp) when the vulnerability record was created in the vulnerability database. |
| published | String | Optional | The date and time (timestamp) when the vulnerability record was first published. |
| updated | String | Optional | The date and time (timestamp) when the vulnerability record was last updated. |
| rejected | String | Optional | The date and time (timestamp) when the vulnerability record was rejected (if applicable). |
| credits | Object | Optional | Individuals or organizations credited with the discovery of the vulnerability. |
| tools | Array | Optional | The tool(s) used to identify, confirm, or score the vulnerability. |
| analysis | Object | Optional | An assessment of the impact and exploitability of the vulnerability. |
| affects | Array | Optional | The components or services that are affected by the vulnerability. |
| properties | Array | Optional | 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. |
Location: /vulnerabilities/[]/bom-ref
Type: String
An identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /vulnerabilities/[]/id
Type: String
The identifier that uniquely identifies the vulnerability.
CVE-2021-39182
GHSA-35m5-8cvj-8783
SNYK-PYTHON-ENROCRYPT-1912876
Location: /vulnerabilities/[]/source
Type: Object
The source that published the vulnerability.
| Property | Type | Requirement | Description |
|---|---|---|---|
| url | String | Optional | The url of the vulnerability documentation as provided by the source. |
| name | String | Optional | The name of the source. |
Location: /vulnerabilities/[]/source/url
Type: String
The url of the vulnerability documentation as provided by the source.
https://nvd.nist.gov/vuln/detail/CVE-2021-39182
Location: /vulnerabilities/[]/source/name
Type: String
The name of the source.
NVD
National Vulnerability Database
OSS Index
VulnDB
GitHub Advisories
Location: /vulnerabilities/[]/references
Property: references (Optional)
Type: Array
Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.
Location: /vulnerabilities/[]/references/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| id | String | Required | An identifier that uniquely identifies the vulnerability. |
| source | Object | Required | The source that published the vulnerability. |
Location: /vulnerabilities/[]/references/[]/id
Type: String
An identifier that uniquely identifies the vulnerability.
CVE-2021-39182
GHSA-35m5-8cvj-8783
SNYK-PYTHON-ENROCRYPT-1912876
Location: /vulnerabilities/[]/references/[]/source
Type: Object
The source that published the vulnerability.
| Property | Type | Requirement | Description |
|---|---|---|---|
| url | String | Optional | The url of the vulnerability documentation as provided by the source. |
| name | String | Optional | The name of the source. |
Location: /vulnerabilities/[]/references/[]/source/url
Type: String
The url of the vulnerability documentation as provided by the source.
https://nvd.nist.gov/vuln/detail/CVE-2021-39182
Location: /vulnerabilities/[]/references/[]/source/name
Type: String
The name of the source.
NVD
National Vulnerability Database
OSS Index
VulnDB
GitHub Advisories
Location: /vulnerabilities/[]/ratings
Property: ratings (Optional)
Type: Array
List of vulnerability ratings Each item of this array shall be a Rating object.
Location: /vulnerabilities/[]/ratings/[]
Type: Object
Defines the severity or risk ratings of a vulnerability.
| Property | Type | Requirement | Description |
|---|---|---|---|
| source | Object | Optional | The source that calculated the severity or risk rating of the vulnerability. |
| score | Number | Optional | The numerical score of the rating. |
| severity | String | Optional | Textual representation of the severity that corresponds to the numerical score of the rating. |
| method | String | Optional | Specifies the severity or risk scoring methodology or standard used. |
| vector | String | Optional | Textual representation of the metric values used to score the vulnerability. |
| justification | String | Optional | A reason for rating the vulnerability as it was. |
Location: /vulnerabilities/[]/ratings/[]/source
Type: Object
The source that calculated the severity or risk rating of the vulnerability.
| Property | Type | Requirement | Description |
|---|---|---|---|
| url | String | Optional | The url of the vulnerability documentation as provided by the source. |
| name | String | Optional | The name of the source. |
Location: /vulnerabilities/[]/ratings/[]/source/url
Type: String
The url of the vulnerability documentation as provided by the source.
https://nvd.nist.gov/vuln/detail/CVE-2021-39182
Location: /vulnerabilities/[]/ratings/[]/source/name
Type: String
The name of the source.
NVD
National Vulnerability Database
OSS Index
VulnDB
GitHub Advisories
Location: /vulnerabilities/[]/ratings/[]/score
Type: Number
The numerical score of the rating.
Location: /vulnerabilities/[]/ratings/[]/severity
Type: String (enum)
Textual representation of the severity that corresponds to the numerical score of the rating.
| Value | Description |
|---|---|
| critical | Critical severity |
| high | High severity |
| medium | Medium severity |
| low | Low severity |
| info | Informational warning. |
| none | None |
| unknown | The severity is not known |
Location: /vulnerabilities/[]/ratings/[]/method
Type: String (enum)
Specifies the severity or risk scoring methodology or standard used.
| Value | Description |
|---|---|
| CVSSv2 | Common Vulnerability Scoring System v2.0 |
| CVSSv3 | Common Vulnerability Scoring System v3.0 |
| CVSSv31 | Common Vulnerability Scoring System v3.1 |
| CVSSv4 | Common Vulnerability Scoring System v4.0 |
| OWASP | OWASP Risk Rating Methodology |
| SSVC | Stakeholder Specific Vulnerability Categorization |
| other | Another severity or risk scoring methodology |
Location: /vulnerabilities/[]/ratings/[]/vector
Type: String
Textual representation of the metric values used to score the vulnerability
Location: /vulnerabilities/[]/ratings/[]/justification
Type: String
A reason for rating the vulnerability as it was
Location: /vulnerabilities/[]/cwes
Property: cwes (Optional)
Type: Array (of Integer)
Minimum Value: 1
List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability. Integer representation of a Common Weaknesses Enumerations (CWE). For example 399 (of https://cwe.mitre.org/data/definitions/399.html) Each item of this array shall be an integer.
399
Location: /vulnerabilities/[]/description
Type: String
A description of the vulnerability as provided by the source.
Location: /vulnerabilities/[]/detail
Type: String
If available, an in-depth description of the vulnerability as provided by the source organization. Details often include information useful in understanding root cause.
Location: /vulnerabilities/[]/recommendation
Type: String
Recommendations of how the vulnerability can be remediated or mitigated.
Location: /vulnerabilities/[]/workaround
Type: String
A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments.
Location: /vulnerabilities/[]/proofOfConcept
Type: Object
Evidence used to reproduce the vulnerability.
| Property | Type | Requirement | Description |
|---|---|---|---|
| reproductionSteps | String | Optional | Precise steps to reproduce the vulnerability. |
| environment | String | Optional | A description of the environment in which reproduction was possible. |
| supportingMaterial | Array | Optional | Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code. |
Location: /vulnerabilities/[]/proofOfConcept/reproductionSteps
Type: String
Precise steps to reproduce the vulnerability.
Location: /vulnerabilities/[]/proofOfConcept/environment
Type: String
A description of the environment in which reproduction was possible.
Location: /vulnerabilities/[]/proofOfConcept/supportingMaterial
Property: supportingMaterial (Optional)
Type: Array
Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code. Each item of this array shall be an Attachment object.
Location: /vulnerabilities/[]/proofOfConcept/supportingMaterial/[]
Type: Object
Specifies the metadata and content for an attachment.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /vulnerabilities/[]/proofOfConcept/supportingMaterial/[]/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /vulnerabilities/[]/proofOfConcept/supportingMaterial/[]/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /vulnerabilities/[]/proofOfConcept/supportingMaterial/[]/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /vulnerabilities/[]/advisories
Property: advisories (Optional)
Type: Array
Published advisories of the vulnerability if provided. Each item of this array shall be an Advisory object.
Location: /vulnerabilities/[]/advisories/[]
Type: Object
Title and location where advisory information can be obtained. An advisory is a notification of a threat to a component, service, or system.
| Property | Type | Requirement | Description |
|---|---|---|---|
| title | String | Optional | A name of the advisory. |
| url | String | Required | Location where the advisory can be obtained. |
Location: /vulnerabilities/[]/advisories/[]/title
Type: String
A name of the advisory.
Location: /vulnerabilities/[]/advisories/[]/url
Type: String
Format: iri-reference as specified in RFC 3987
Location where the advisory can be obtained.
Location: /vulnerabilities/[]/created
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the vulnerability record was created in the vulnerability database.
Location: /vulnerabilities/[]/published
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the vulnerability record was first published.
Location: /vulnerabilities/[]/updated
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the vulnerability record was last updated.
Location: /vulnerabilities/[]/rejected
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the vulnerability record was rejected (if applicable).
Location: /vulnerabilities/[]/credits
Type: Object
Individuals or organizations credited with the discovery of the vulnerability.
| Property | Type | Requirement | Description |
|---|---|---|---|
| organizations | Array | Optional | The organizations credited with vulnerability discovery. |
| individuals | Array | Optional | The individuals, not associated with organizations, that are credited with vulnerability discovery. |
Location: /vulnerabilities/[]/credits/organizations
Property: organizations (Optional)
Type: Array
The organizations credited with vulnerability discovery.
Location: /vulnerabilities/[]/credits/organizations/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /vulnerabilities/[]/credits/organizations/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /vulnerabilities/[]/credits/organizations/[]/name
Type: String
The name of the organization
Example Inc.
Location: /vulnerabilities/[]/credits/organizations/[]/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /vulnerabilities/[]/credits/organizations/[]/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /vulnerabilities/[]/credits/organizations/[]/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /vulnerabilities/[]/credits/organizations/[]/address/region
Type: String
The region or state in the country.
Texas
Location: /vulnerabilities/[]/credits/organizations/[]/address/locality
Type: String
The locality or city within the country.
Austin
Location: /vulnerabilities/[]/credits/organizations/[]/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /vulnerabilities/[]/credits/organizations/[]/address/postalCode
Type: String
The postal code.
78758
Location: /vulnerabilities/[]/credits/organizations/[]/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /vulnerabilities/[]/credits/organizations/[]/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /vulnerabilities/[]/credits/organizations/[]/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /vulnerabilities/[]/credits/organizations/[]/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /vulnerabilities/[]/credits/organizations/[]/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /vulnerabilities/[]/credits/organizations/[]/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /vulnerabilities/[]/credits/organizations/[]/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /vulnerabilities/[]/credits/organizations/[]/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /vulnerabilities/[]/credits/individuals
Property: individuals (Optional)
Type: Array
The individuals, not associated with organizations, that are credited with vulnerability discovery. Each item of this array shall be an Organizational Person object.
Location: /vulnerabilities/[]/credits/individuals/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /vulnerabilities/[]/credits/individuals/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /vulnerabilities/[]/credits/individuals/[]/name
Type: String
The name of a contact
Contact name
Location: /vulnerabilities/[]/credits/individuals/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /vulnerabilities/[]/credits/individuals/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /vulnerabilities/[]/tools
The tool(s) used to identify, confirm, or score the vulnerability.
Shall be one of:
Type: Object
The tool(s) used to identify, confirm, or score the vulnerability.
| Property | Type | Requirement | Description |
|---|---|---|---|
| components | Array | Optional | A list of software and hardware components used as tools. Refer to the component definition at /components/[]. |
| services | Array | Optional | A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services. Refer to the service definition at /services/[]. |
Type: Array
[Deprecated] The tool(s) used to identify, confirm, or score the vulnerability.
Location: /vulnerabilities/[]/tools/components
Property: components (Optional)
Type: Array
Uniqueness: All items shall be unique.
A list of software and hardware components used as tools. Each item of this array shall be a Component object.
Location: /vulnerabilities/[]/tools/components/[]
Type: Object
Location: /vulnerabilities/[]/tools/services
Property: services (Optional)
Type: Array
Uniqueness: All items shall be unique.
A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services. Each item of this array shall be a Service object.
Location: /vulnerabilities/[]/tools/services/[]
Type: Object
Location: /vulnerabilities/[]/tools
Property: tools
Type: Array
[Deprecated] The tool(s) used to identify, confirm, or score the vulnerability. Each item of this array shall be a Tool object.
Location: /vulnerabilities/[]/tools/[]
Type: Object
[Deprecated] This will be removed in a future version. Use component or service instead. Information about the automated or manual tool used
| Property | Type | Requirement | Description |
|---|---|---|---|
| vendor | String | Optional | The name of the vendor who created the tool. |
| name | String | Optional | The name of the tool. |
| version | String | Optional | The version of the tool. |
| hashes | Array | Optional | The hashes of the tool (if applicable). |
| externalReferences | Array | Optional | 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. |
Location: /vulnerabilities/[]/tools/[]/vendor
Type: String
The name of the vendor who created the tool
Location: /vulnerabilities/[]/tools/[]/name
Type: String
The name of the tool
Location: /vulnerabilities/[]/tools/[]/version
Type: String
The version of the tool
9.0.14
v1.33.7
7.0.0-M1
2.0pre1
1.0.0-beta1
0.8.15
Location: /vulnerabilities/[]/tools/[]/hashes
Property: hashes (Optional)
Type: Array
The hashes of the tool (if applicable). Each item of this array shall be a Hash object.
Location: /vulnerabilities/[]/tools/[]/hashes/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| alg | String | Required | The algorithm that generated the hash value. |
| content | String | Required | The value of the hash. |
Location: /vulnerabilities/[]/tools/[]/hashes/[]/alg
Type: String (enum)
The algorithm that generated the hash value.
Enumeration of possible values:Location: /vulnerabilities/[]/tools/[]/hashes/[]/content
Type: String
Pattern Constraint: ^([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})$
The value of the hash.
3942447fac867ae5cdb3229b658f4d48
Location: /vulnerabilities/[]/tools/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /vulnerabilities/[]/tools/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
Location: /vulnerabilities/[]/analysis
Type: Object
An assessment of the impact and exploitability of the vulnerability.
| Property | Type | Requirement | Description |
|---|---|---|---|
| state | String | Optional | Declares the current state of an occurrence of a vulnerability, after automated or manual analysis. |
| justification | String | Optional | The rationale of why the impact analysis state was asserted. |
| response | Array | Optional | A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable. |
| detail | String | Optional | Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability. |
| firstIssued | String | Optional | The date and time (timestamp) when the analysis was first issued. |
| lastUpdated | String | Optional | The date and time (timestamp) when the analysis was last updated. |
Location: /vulnerabilities/[]/analysis/state
Type: String (enum)
Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.
| Value | Description |
|---|---|
| resolved | The vulnerability has been remediated. |
| resolved_with_pedigree | The vulnerability has been remediated and evidence of the changes are provided in the affected components pedigree containing verifiable commit history and/or diff(s). |
| exploitable | The vulnerability may be directly or indirectly exploitable. |
| in_triage | The vulnerability is being investigated. |
| false_positive | The vulnerability is not specific to the component or service and was falsely identified or associated. |
| not_affected | The component or service is not affected by the vulnerability. Justification should be specified for all not_affected cases. |
Location: /vulnerabilities/[]/analysis/justification
Type: String (enum)
The rationale of why the impact analysis state was asserted.
| Value | Description |
|---|---|
| code_not_present | The code has been removed or tree-shaked. |
| code_not_reachable | The vulnerable code is not invoked at runtime. |
| requires_configuration | Exploitability requires a configurable option to be set/unset. |
| requires_dependency | Exploitability requires a dependency that is not present. |
| requires_environment | Exploitability requires a certain environment which is not present. |
| protected_by_compiler | Exploitability requires a compiler flag to be set/unset. |
| protected_at_runtime | Exploits are prevented at runtime. |
| protected_at_perimeter | Attacks are blocked at physical, logical, or network perimeter. |
| protected_by_mitigating_control | Preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability. |
Location: /vulnerabilities/[]/analysis/response
Property: response (Optional)
Type: Array (of String) (enum)
A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable. Each item of this array shall be a string.
| Value | Description |
|---|---|
| can_not_fix | Can not fix |
| will_not_fix | Will not fix |
| update | Update to a different revision or release |
| rollback | Revert to a previous revision or release |
| workaround_available | There is a workaround available |
Location: /vulnerabilities/[]/analysis/detail
Type: String
Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability.
Location: /vulnerabilities/[]/analysis/firstIssued
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the analysis was first issued.
Location: /vulnerabilities/[]/analysis/lastUpdated
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the analysis was last updated.
Location: /vulnerabilities/[]/affects
Property: affects (Optional)
Type: Array
Uniqueness: All items shall be unique.
The components or services that are affected by the vulnerability.
Location: /vulnerabilities/[]/affects/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Required | References a component or service by the objects bom-ref. |
| versions | Array | Optional | Zero or more individual versions or range of versions. |
Location: /vulnerabilities/[]/affects/[]/ref
References a component or service by the objects bom-ref
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /vulnerabilities/[]/affects/[]/versions
Property: versions (Optional)
Type: Array
Zero or more individual versions or range of versions.
Location: /vulnerabilities/[]/affects/[]/versions/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| version | String | Optional | A single version of a component or service. |
| range | String | Optional | A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/vers-spec. |
| status | String | Optional | The vulnerability status for the version or range of versions. |
Location: /vulnerabilities/[]/affects/[]/versions/[]/version
Type: String
A single version of a component or service.
9.0.14
v1.33.7
7.0.0-M1
2.0pre1
1.0.0-beta1
0.8.15
Location: /vulnerabilities/[]/affects/[]/versions/[]/range
Type: String
A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/vers-spec
vers:cargo/9.0.14
vers:npm/1.2.3|>=2.0.0|<5.0.0
vers:pypi/0.0.0|0.0.1|0.0.2|0.0.3|1.0|2.0pre1
vers:tomee/>=1.0.0-beta1|<=1.7.5|>=7.0.0-M1|<=7.0.7|>=7.1.0|<=7.1.2|>=8.0.0-M1|<=8.0.1
vers:gem/>=2.2.0|!= 2.2.1|<2.3.0
Location: /vulnerabilities/[]/affects/[]/versions/[]/status
Type: String (enum)
Default Value: affected
The vulnerability status for the version or range of versions.
| Value | Description |
|---|---|
| affected | The version is affected by the vulnerability. |
| unaffected | The version is not affected by the vulnerability. |
| unknown | It is unknown (or unspecified) whether the given version is affected. |
Location: /vulnerabilities/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /vulnerabilities/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /vulnerabilities/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /vulnerabilities/[]/properties/[]/value
Type: String
The value of the property.
Location: /annotations
Property: annotations (Optional)
Type: Array
Uniqueness: All items shall be unique.
Comments made by people, organizations, or tools about any object with a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike inventory information, annotations may contain opinions or commentary from various stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link and may optionally be signed. Each item of this array shall be an Annotations object.
Location: /annotations/[]
Type: Object
A comment, note, explanation, or similar textual content which provides additional context to the object(s) being annotated.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| subjects | Array | Required | 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. |
| annotator | Array | Required | The organization, person, component, or service which created the textual content of the annotation. |
| timestamp | String | Required | The date and time (timestamp) when the annotation was created. |
| text | String | Required | The textual content of the annotation. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /annotations/[]/bom-ref
Type: String
An identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /annotations/[]/subjects
Property: subjects (Required)
Type: Array
Uniqueness: All items shall be unique.
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.
Location: /annotations/[]/subjects/[]
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /annotations/[]/annotator
Type: Object
The organization, person, component, or service which created the textual content of the annotation.
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that created the annotation. |
| individual | Object | Optional | The person that created the annotation. |
| component | Array | Optional | The tool or component that created the annotation. |
| service | Object | Optional | The service that created the annotation. |
Location: /annotations/[]/annotator/organization
Type: Object
The organization that created the annotation
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /annotations/[]/annotator/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /annotations/[]/annotator/organization/name
Type: String
The name of the organization
Example Inc.
Location: /annotations/[]/annotator/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /annotations/[]/annotator/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /annotations/[]/annotator/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /annotations/[]/annotator/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /annotations/[]/annotator/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /annotations/[]/annotator/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /annotations/[]/annotator/organization/address/postalCode
Type: String
The postal code.
78758
Location: /annotations/[]/annotator/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /annotations/[]/annotator/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /annotations/[]/annotator/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /annotations/[]/annotator/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /annotations/[]/annotator/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /annotations/[]/annotator/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /annotations/[]/annotator/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /annotations/[]/annotator/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /annotations/[]/annotator/individual
Type: Object
The person that created the annotation
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /annotations/[]/annotator/individual/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /annotations/[]/annotator/individual/name
Type: String
The name of a contact
Contact name
Location: /annotations/[]/annotator/individual/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /annotations/[]/annotator/individual/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /annotations/[]/annotator/component
Type: Object
The tool or component that created the annotation
Location: /annotations/[]/annotator/service
Type: Object
The service that created the annotation
Location: /annotations/[]/timestamp
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the annotation was created.
Location: /annotations/[]/text
Type: String
The textual content of the annotation.
Location: /annotations/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /formulation
Property: formulation (Optional)
Type: Array
Uniqueness: All items shall be unique.
Describes the formulation of any referencable object within the BOM, including components, services, metadata, declarations, or the BOM itself. This may encompass how the object was created, assembled, deployed, tested, certified, or otherwise brought into its present form. Common examples include software build pipelines, deployment processes, AI/ML model training, cryptographic key generation or certification, and third-party audits. Processes are modelled using declared and observed formulas, composed of workflows, tasks, and individual steps. Each item of this array shall be a Formula object.
Location: /formulation/[]
Type: Object
Describes workflows and resources that captures rules and other aspects of how the associated BOM component or service was formed.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the formula elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| components | Array | Optional | Transient components that are used in tasks that constitute one or more of this formula's workflows. |
| services | Array | Optional | Transient services that are used in tasks that constitute one or more of this formula's workflows. |
| workflows | Array | Optional | List of workflows that can be declared to accomplish specific orchestrated goals and independently triggered. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/bom-ref
Type: String
An identifier which can be used to reference the formula elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /formulation/[]/components
Property: components (Optional)
Type: Array
Uniqueness: All items shall be unique.
Transient components that are used in tasks that constitute one or more of this formula's workflows Each item of this array shall be a Component object.
Location: /formulation/[]/components/[]
Type: Object
Location: /formulation/[]/services
Property: services (Optional)
Type: Array
Uniqueness: All items shall be unique.
Transient services that are used in tasks that constitute one or more of this formula's workflows Each item of this array shall be a Service object.
Location: /formulation/[]/services/[]
Type: Object
Location: /formulation/[]/workflows
Property: workflows (Optional)
Type: Array
Uniqueness: All items shall be unique.
List of workflows that can be declared to accomplish specific orchestrated goals and independently triggered. Each item of this array shall be a Workflow object.
Location: /formulation/[]/workflows/[]
Type: Object
A specialized orchestration task.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Required | An identifier which can be used to reference the workflow elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| uid | String | Required | The unique identifier for the resource instance within its deployment context. |
| name | String | Optional | The name of the resource instance. |
| description | String | Optional | A description of the resource instance. |
| resourceReferences | Array | Optional | References to component or service resources that are used to realize the resource instance. |
| tasks | Array | Optional | The tasks that comprise the workflow. |
| taskDependencies | Array | Optional | The graph of dependencies between tasks within the workflow. |
| taskTypes | Array | Required | Indicates the types of activities performed by the set of workflow tasks. |
| trigger | Object | Optional | The trigger that initiated the task. |
| steps | Array | Optional | The sequence of steps for the task. |
| inputs | Array | Optional | Represents resources and data brought into a task at runtime by executor or task commands. |
| outputs | Array | Optional | Represents resources and data output from a task at runtime by executor or task commands. |
| timeStart | String | Optional | The date and time (timestamp) when the task started. |
| timeEnd | String | Optional | The date and time (timestamp) when the task ended. |
| workspaces | Array | Optional | A set of named filesystem or data resource shareable by workflow tasks. |
| runtimeTopology | Array | Optional | A graph of the component runtime topology for workflow's instance. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/bom-ref
Type: String
An identifier which can be used to reference the workflow elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /formulation/[]/workflows/[]/uid
Type: String
The unique identifier for the resource instance within its deployment context.
Location: /formulation/[]/workflows/[]/name
Type: String
The name of the resource instance.
Location: /formulation/[]/workflows/[]/description
Type: String
A description of the resource instance.
Location: /formulation/[]/workflows/[]/resourceReferences
Property: resourceReferences (Optional)
Type: Array
Uniqueness: All items shall be unique.
References to component or service resources that are used to realize the resource instance. Each item of this array shall be a Resource reference choice object.
Location: /formulation/[]/workflows/[]/resourceReferences/[]
Type: Object
A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/resourceReferences/[]/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/resourceReferences/[]/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks
Property: tasks (Optional)
Type: Array
Uniqueness: All items shall be unique.
The tasks that comprise the workflow. Each item of this array shall be a Task object.
Location: /formulation/[]/workflows/[]/tasks/[]
Type: Object
Describes the inputs, sequence of steps and resources used to accomplish a task and its output.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Required | An identifier which can be used to reference the task elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| uid | String | Required | The unique identifier for the resource instance within its deployment context. |
| name | String | Optional | The name of the resource instance. |
| description | String | Optional | A description of the resource instance. |
| resourceReferences | Array | Optional | References to component or service resources that are used to realize the resource instance. |
| taskTypes | Array | Required | Indicates the types of activities performed by the set of workflow tasks. |
| trigger | Object | Optional | The trigger that initiated the task. |
| steps | Array | Optional | The sequence of steps for the task. |
| inputs | Array | Optional | Represents resources and data brought into a task at runtime by executor or task commands. |
| outputs | Array | Optional | Represents resources and data output from a task at runtime by executor or task commands. |
| timeStart | String | Optional | The date and time (timestamp) when the task started. |
| timeEnd | String | Optional | The date and time (timestamp) when the task ended. |
| workspaces | Array | Optional | A set of named filesystem or data resource shareable by workflow tasks. |
| runtimeTopology | Array | Optional | A graph of the component runtime topology for task's instance. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/bom-ref
Type: String
An identifier which can be used to reference the task elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /formulation/[]/workflows/[]/tasks/[]/uid
Type: String
The unique identifier for the resource instance within its deployment context.
Location: /formulation/[]/workflows/[]/tasks/[]/name
Type: String
The name of the resource instance.
Location: /formulation/[]/workflows/[]/tasks/[]/description
Type: String
A description of the resource instance.
Location: /formulation/[]/workflows/[]/tasks/[]/resourceReferences
Property: resourceReferences (Optional)
Type: Array
Uniqueness: All items shall be unique.
References to component or service resources that are used to realize the resource instance. Each item of this array shall be a Resource reference choice object.
Location: /formulation/[]/workflows/[]/tasks/[]/resourceReferences/[]
Type: Object
A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/resourceReferences/[]/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/resourceReferences/[]/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/taskTypes
Property: taskTypes (Required)
Type: Array (of String) (enum)
Indicates the types of activities performed by the set of workflow tasks. Each item of this array shall be a string.
| Value | Description |
|---|---|
| copy | A task that copies software or data used to accomplish other tasks in the workflow. |
| clone | A task that clones a software repository into the workflow in order to retrieve its source code or data for use in a build step. |
| lint | A task that checks source code for programmatic and stylistic errors. |
| scan | A task that performs a scan against source code, or built or deployed components and services. Scans are typically run to gather or test for security vulnerabilities or policy compliance. |
| merge | A task that merges changes or fixes into source code prior to a build step in the workflow. |
| build | A task that builds the source code, dependencies and/or data into an artefact that can be deployed to and executed on target systems. |
| test | A task that verifies the functionality of a component or service. |
| deliver | A task that delivers a built artefact to one or more target repositories or storage systems. |
| deploy | A task that deploys a built artefact for execution on one or more target systems. |
| release | A task that releases a built, versioned artefact to a target repository or distribution system. |
| clean | A task that cleans unnecessary tools, build artifacts and/or data from workflow storage. |
| other | A workflow task that does not match current task type definitions. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger
Type: Object
The trigger that initiated the task.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Required | An identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| uid | String | Required | The unique identifier for the resource instance within its deployment context. |
| name | String | Optional | The name of the resource instance. |
| description | String | Optional | A description of the resource instance. |
| resourceReferences | Array | Optional | References to component or service resources that are used to realize the resource instance. |
| type | String | Required | The source type of event which caused the trigger to fire. |
| event | Object | Optional | The event data that caused the associated trigger to activate. |
| conditions | Array | Optional | A list of conditions used to determine if a trigger should be activated. |
| timeActivated | String | Optional | The date and time (timestamp) when the trigger was activated. |
| inputs | Array | Optional | Represents resources and data brought into a task at runtime by executor or task commands. |
| outputs | Array | Optional | Represents resources and data output from a task at runtime by executor or task commands. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/bom-ref
Type: String
An identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/uid
Type: String
The unique identifier for the resource instance within its deployment context.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/name
Type: String
The name of the resource instance.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/description
Type: String
A description of the resource instance.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/resourceReferences
Property: resourceReferences (Optional)
Type: Array
Uniqueness: All items shall be unique.
References to component or service resources that are used to realize the resource instance. Each item of this array shall be a Resource reference choice object.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/resourceReferences/[]
Type: Object
A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/resourceReferences/[]/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/resourceReferences/[]/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/type
Type: String (enum)
The source type of event which caused the trigger to fire.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event
Type: Object
The event data that caused the associated trigger to activate.
| Property | Type | Requirement | Description |
|---|---|---|---|
| uid | String | Optional | The unique identifier of the event. |
| description | String | Optional | A description of the event. |
| timeReceived | String | Optional | The date and time (timestamp) when the event was received. |
| data | Object | Optional | Encoding of the raw event data. |
| source | Array | Optional | References the component or service that was the source of the event. |
| target | Array | Optional | References the component or service that was the target of the event. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/uid
Type: String
The unique identifier of the event.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/description
Type: String
A description of the event.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/timeReceived
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the event was received.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/data
Type: Object
Encoding of the raw event data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/source
Type: Object
References the component or service that was the source of the event
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/target
Type: Object
References the component or service that was the target of the event
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/event/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/conditions
Property: conditions (Optional)
Type: Array
Uniqueness: All items shall be unique.
A list of conditions used to determine if a trigger should be activated. Each item of this array shall be a Condition object.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/conditions/[]
Type: Object
A condition that was used to determine a trigger should be activated.
| Property | Type | Requirement | Description |
|---|---|---|---|
| description | String | Optional | Describes the set of conditions which cause the trigger to activate. |
| expression | String | Optional | The logical expression that was evaluated that determined the trigger should be fired. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/conditions/[]/description
Type: String
Describes the set of conditions which cause the trigger to activate.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/conditions/[]/expression
Type: String
The logical expression that was evaluated that determined the trigger should be fired.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/conditions/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/conditions/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/conditions/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/conditions/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/timeActivated
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the trigger was activated.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs
Property: inputs (Optional)
Type: Array
Uniqueness: All items shall be unique.
Represents resources and data brought into a task at runtime by executor or task commands Each item of this array shall be an Input type object.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]
Type: Object
Type that represents various input data types and formats.
| Property | Type | Requirement | Description |
|---|---|---|---|
| source | Array | Optional | A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of inbound). |
| target | Array | Optional | A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace). |
| resource | Array | Optional | A reference to an independent resource provided as an input to a task by the workflow runtime. |
| parameters | Array | Optional | Inputs that have the form of parameters with names and values. |
| environmentVars | Array | Optional | Inputs that have the form of parameters with names and values. |
| data | Object | Optional | Inputs that have the form of data. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/source
Type: Object
A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of inbound)
source code repository
database
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/target
Type: Object
A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace)
workspace
directory
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/resource
Type: Object
A reference to an independent resource provided as an input to a task by the workflow runtime.
a reference to a configuration file in a repository (i.e., a bom-ref)
a reference to a scanning service used in a task (i.e., a bom-ref)
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/resource/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/resource/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/parameters
Property: parameters (Optional)
Type: Array
Uniqueness: All items shall be unique.
Inputs that have the form of parameters with names and values. Each item of this array shall be a Parameter object.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/parameters/[]
Type: Object
A representation of a functional parameter.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the parameter. |
| value | String | Optional | The value of the parameter. |
| dataType | String | Optional | The data type of the parameter. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/parameters/[]/name
Type: String
The name of the parameter.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/parameters/[]/value
Type: String
The value of the parameter.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/parameters/[]/dataType
Type: String
The data type of the parameter.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/environmentVars
Property: environmentVars (Optional)
Type: Array
Uniqueness: All items shall be unique.
Inputs that have the form of parameters with names and values.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/environmentVars/[]
Shall be one of:
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Type: String
In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/environmentVars/[]/name
Property: name (Required)
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/environmentVars/[]/value
Property: value (Optional)
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/data
Type: Object
Inputs that have the form of data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/inputs/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs
Property: outputs (Optional)
Type: Array
Uniqueness: All items shall be unique.
Represents resources and data output from a task at runtime by executor or task commands
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | Describes the type of data output. |
| source | Array | Optional | Component or service that generated or provided the output from the task (e.g., a build tool). |
| target | Array | Optional | Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of outbound). |
| resource | Array | Optional | A reference to an independent resource generated as output by the task. |
| data | Object | Optional | Outputs that have the form of data. |
| environmentVars | Array | Optional | Outputs that have the form of environment variables. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/type
Type: String (enum)
Describes the type of data output.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/source
Type: Object
Component or service that generated or provided the output from the task (e.g., a build tool)
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/target
Type: Object
Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of outbound)
a log file described as an `externalReference` within its target domain.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/resource
Type: Object
A reference to an independent resource generated as output by the task.
configuration file
source code
scanning service
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/resource/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/resource/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/data
Type: Object
Outputs that have the form of data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/environmentVars
Property: environmentVars (Optional)
Type: Array
Uniqueness: All items shall be unique.
Outputs that have the form of environment variables.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/environmentVars/[]
Shall be one of:
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Type: String
In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/environmentVars/[]/name
Property: name (Required)
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/environmentVars/[]/value
Property: value (Optional)
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/outputs/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/trigger/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/steps
Property: steps (Optional)
Type: Array
Uniqueness: All items shall be unique.
The sequence of steps for the task.
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]
Type: Object
Executes specific commands or tools in order to accomplish its owning task as part of a sequence.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | A name for the step. |
| description | String | Optional | A description of the step. |
| commands | Array | Optional | Ordered list of commands or directives for the step. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/name
Type: String
A name for the step.
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/description
Type: String
A description of the step.
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/commands
Property: commands (Optional)
Type: Array
Ordered list of commands or directives for the step
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/commands/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| executed | String | Optional | A text representation of the executed command. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/commands/[]/executed
Type: String
A text representation of the executed command.
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/commands/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/commands/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/commands/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/commands/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/steps/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs
Property: inputs (Optional)
Type: Array
Uniqueness: All items shall be unique.
Represents resources and data brought into a task at runtime by executor or task commands Each item of this array shall be an Input type object.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]
Type: Object
Type that represents various input data types and formats.
| Property | Type | Requirement | Description |
|---|---|---|---|
| source | Array | Optional | A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of inbound). |
| target | Array | Optional | A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace). |
| resource | Array | Optional | A reference to an independent resource provided as an input to a task by the workflow runtime. |
| parameters | Array | Optional | Inputs that have the form of parameters with names and values. |
| environmentVars | Array | Optional | Inputs that have the form of parameters with names and values. |
| data | Object | Optional | Inputs that have the form of data. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/source
Type: Object
A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of inbound)
source code repository
database
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/target
Type: Object
A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace)
workspace
directory
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/resource
Type: Object
A reference to an independent resource provided as an input to a task by the workflow runtime.
a reference to a configuration file in a repository (i.e., a bom-ref)
a reference to a scanning service used in a task (i.e., a bom-ref)
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/resource/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/resource/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/parameters
Property: parameters (Optional)
Type: Array
Uniqueness: All items shall be unique.
Inputs that have the form of parameters with names and values. Each item of this array shall be a Parameter object.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/parameters/[]
Type: Object
A representation of a functional parameter.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the parameter. |
| value | String | Optional | The value of the parameter. |
| dataType | String | Optional | The data type of the parameter. |
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/parameters/[]/name
Type: String
The name of the parameter.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/parameters/[]/value
Type: String
The value of the parameter.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/parameters/[]/dataType
Type: String
The data type of the parameter.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/environmentVars
Property: environmentVars (Optional)
Type: Array
Uniqueness: All items shall be unique.
Inputs that have the form of parameters with names and values.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/environmentVars/[]
Shall be one of:
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Type: String
In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/environmentVars/[]/name
Property: name (Required)
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/environmentVars/[]/value
Property: value (Optional)
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/data
Type: Object
Inputs that have the form of data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/inputs/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs
Property: outputs (Optional)
Type: Array
Uniqueness: All items shall be unique.
Represents resources and data output from a task at runtime by executor or task commands
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | Describes the type of data output. |
| source | Array | Optional | Component or service that generated or provided the output from the task (e.g., a build tool). |
| target | Array | Optional | Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of outbound). |
| resource | Array | Optional | A reference to an independent resource generated as output by the task. |
| data | Object | Optional | Outputs that have the form of data. |
| environmentVars | Array | Optional | Outputs that have the form of environment variables. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/type
Type: String (enum)
Describes the type of data output.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/source
Type: Object
Component or service that generated or provided the output from the task (e.g., a build tool)
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/target
Type: Object
Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of outbound)
a log file described as an `externalReference` within its target domain.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/resource
Type: Object
A reference to an independent resource generated as output by the task.
configuration file
source code
scanning service
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/resource/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/resource/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/data
Type: Object
Outputs that have the form of data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/environmentVars
Property: environmentVars (Optional)
Type: Array
Uniqueness: All items shall be unique.
Outputs that have the form of environment variables.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/environmentVars/[]
Shall be one of:
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Type: String
In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/environmentVars/[]/name
Property: name (Required)
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/environmentVars/[]/value
Property: value (Optional)
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/outputs/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/timeStart
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the task started.
Location: /formulation/[]/workflows/[]/tasks/[]/timeEnd
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the task ended.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces
Property: workspaces (Optional)
Type: Array
Uniqueness: All items shall be unique.
A set of named filesystem or data resource shareable by workflow tasks. Each item of this array shall be a Workspace object.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]
Type: Object
A named filesystem or data resource shareable by workflow tasks.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Required | An identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| uid | String | Required | The unique identifier for the resource instance within its deployment context. |
| name | String | Optional | The name of the resource instance. |
| aliases | Array | Optional | The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps. |
| description | String | Optional | A description of the resource instance. |
| resourceReferences | Array | Optional | References to component or service resources that are used to realize the resource instance. |
| accessMode | String | Optional | Describes the read-write access control for the workspace relative to the owning resource instance. |
| mountPath | String | Optional | A path to a location on disk where the workspace will be available to the associated task's steps. |
| managedDataType | String | Optional | The name of a domain-specific data type the workspace represents. |
| volumeRequest | String | Optional | Identifies the reference to the request for a specific volume type and parameters. |
| volume | Object | Optional | Information about the actual volume instance allocated to the workspace. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/bom-ref
Type: String
An identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/uid
Type: String
The unique identifier for the resource instance within its deployment context.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/name
Type: String
The name of the resource instance.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/aliases
Property: aliases (Optional)
Type: Array (of String)
The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps. Each item of this array shall be a string.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/description
Type: String
A description of the resource instance.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/resourceReferences
Property: resourceReferences (Optional)
Type: Array
Uniqueness: All items shall be unique.
References to component or service resources that are used to realize the resource instance. Each item of this array shall be a Resource reference choice object.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/resourceReferences/[]
Type: Object
A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/resourceReferences/[]/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/resourceReferences/[]/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/accessMode
Type: String (enum)
Describes the read-write access control for the workspace relative to the owning resource instance.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/mountPath
Type: String
A path to a location on disk where the workspace will be available to the associated task's steps.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/managedDataType
Type: String
The name of a domain-specific data type the workspace represents.
ConfigMap
Secret
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volumeRequest
Type: String
Identifies the reference to the request for a specific volume type and parameters.
a kubernetes Persistent Volume Claim (PVC) name
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume
Type: Object
Information about the actual volume instance allocated to the workspace.
see https://kubernetes.io/docs/concepts/storage/persistent-volumes/
| Property | Type | Requirement | Description |
|---|---|---|---|
| uid | String | Optional | The unique identifier for the volume instance within its deployment context. |
| name | String | Optional | The name of the volume instance. |
| mode | String | Optional | The mode for the volume instance. |
| path | String | Optional | The underlying path created from the actual volume. |
| sizeAllocated | String | Optional | The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as IEC standard unit in either decimal or binary form. |
| persistent | Boolean | Optional | Indicates if the volume persists beyond the life of the resource it is associated with. |
| remote | Boolean | Optional | Indicates if the volume is remotely (i.e., network) attached. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/uid
Type: String
The unique identifier for the volume instance within its deployment context.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/name
Type: String
The name of the volume instance
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/mode
Type: String (enum)
Default Value: filesystem
The mode for the volume instance.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/path
Type: String
The underlying path created from the actual volume.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/sizeAllocated
Type: String
The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as IEC standard unit in either decimal or binary form.
10GB
2Ti
1Pi
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/persistent
Type: Boolean
Indicates if the volume persists beyond the life of the resource it is associated with.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/remote
Type: Boolean
Indicates if the volume is remotely (i.e., network) attached.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/volume/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/workspaces/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/tasks/[]/runtimeTopology
Property: runtimeTopology (Optional)
Type: Array
Uniqueness: All items shall be unique.
A graph of the component runtime topology for task's instance. Each item of this array shall be a Dependency object.
Location: /formulation/[]/workflows/[]/tasks/[]/runtimeTopology/[]
Type: Object
Defines the direct dependencies of a component, service, or the components provided/implemented by a given component. Components or services that do not have their own dependencies shall be declared as empty elements within the graph. Components or services that are not represented in the dependency graph may have unknown dependencies. It is recommended that implementations assume this to be opaque and not an indicator of an object being dependency-free. It is recommended to leverage compositions to indicate unknown dependency graphs.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | String | Required | References a component or service by its bom-ref attribute. |
| dependsOn | Array | Optional | The bom-ref identifiers of the components or services that are dependencies of this dependency object. |
| provides | Array | Optional | The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object. For example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use. |
Location: /formulation/[]/workflows/[]/tasks/[]/runtimeTopology/[]/ref
Type: String
References a component or service by its bom-ref attribute
Location: /formulation/[]/workflows/[]/tasks/[]/runtimeTopology/[]/dependsOn
Property: dependsOn (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services that are dependencies of this dependency object. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /formulation/[]/workflows/[]/tasks/[]/runtimeTopology/[]/provides
Property: provides (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object. For example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /formulation/[]/workflows/[]/tasks/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/tasks/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/tasks/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/tasks/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/taskDependencies
Property: taskDependencies (Optional)
Type: Array
Uniqueness: All items shall be unique.
The graph of dependencies between tasks within the workflow. Each item of this array shall be a Dependency object.
Location: /formulation/[]/workflows/[]/taskDependencies/[]
Type: Object
Defines the direct dependencies of a component, service, or the components provided/implemented by a given component. Components or services that do not have their own dependencies shall be declared as empty elements within the graph. Components or services that are not represented in the dependency graph may have unknown dependencies. It is recommended that implementations assume this to be opaque and not an indicator of an object being dependency-free. It is recommended to leverage compositions to indicate unknown dependency graphs.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | String | Required | References a component or service by its bom-ref attribute. |
| dependsOn | Array | Optional | The bom-ref identifiers of the components or services that are dependencies of this dependency object. |
| provides | Array | Optional | The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object. For example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use. |
Location: /formulation/[]/workflows/[]/taskDependencies/[]/ref
Type: String
References a component or service by its bom-ref attribute
Location: /formulation/[]/workflows/[]/taskDependencies/[]/dependsOn
Property: dependsOn (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services that are dependencies of this dependency object. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /formulation/[]/workflows/[]/taskDependencies/[]/provides
Property: provides (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object. For example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /formulation/[]/workflows/[]/taskTypes
Property: taskTypes (Required)
Type: Array (of String) (enum)
Indicates the types of activities performed by the set of workflow tasks. Each item of this array shall be a string.
| Value | Description |
|---|---|
| copy | A task that copies software or data used to accomplish other tasks in the workflow. |
| clone | A task that clones a software repository into the workflow in order to retrieve its source code or data for use in a build step. |
| lint | A task that checks source code for programmatic and stylistic errors. |
| scan | A task that performs a scan against source code, or built or deployed components and services. Scans are typically run to gather or test for security vulnerabilities or policy compliance. |
| merge | A task that merges changes or fixes into source code prior to a build step in the workflow. |
| build | A task that builds the source code, dependencies and/or data into an artefact that can be deployed to and executed on target systems. |
| test | A task that verifies the functionality of a component or service. |
| deliver | A task that delivers a built artefact to one or more target repositories or storage systems. |
| deploy | A task that deploys a built artefact for execution on one or more target systems. |
| release | A task that releases a built, versioned artefact to a target repository or distribution system. |
| clean | A task that cleans unnecessary tools, build artifacts and/or data from workflow storage. |
| other | A workflow task that does not match current task type definitions. |
Location: /formulation/[]/workflows/[]/trigger
Type: Object
The trigger that initiated the task.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Required | An identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| uid | String | Required | The unique identifier for the resource instance within its deployment context. |
| name | String | Optional | The name of the resource instance. |
| description | String | Optional | A description of the resource instance. |
| resourceReferences | Array | Optional | References to component or service resources that are used to realize the resource instance. |
| type | String | Required | The source type of event which caused the trigger to fire. |
| event | Object | Optional | The event data that caused the associated trigger to activate. |
| conditions | Array | Optional | A list of conditions used to determine if a trigger should be activated. |
| timeActivated | String | Optional | The date and time (timestamp) when the trigger was activated. |
| inputs | Array | Optional | Represents resources and data brought into a task at runtime by executor or task commands. |
| outputs | Array | Optional | Represents resources and data output from a task at runtime by executor or task commands. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/trigger/bom-ref
Type: String
An identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /formulation/[]/workflows/[]/trigger/uid
Type: String
The unique identifier for the resource instance within its deployment context.
Location: /formulation/[]/workflows/[]/trigger/name
Type: String
The name of the resource instance.
Location: /formulation/[]/workflows/[]/trigger/description
Type: String
A description of the resource instance.
Location: /formulation/[]/workflows/[]/trigger/resourceReferences
Property: resourceReferences (Optional)
Type: Array
Uniqueness: All items shall be unique.
References to component or service resources that are used to realize the resource instance. Each item of this array shall be a Resource reference choice object.
Location: /formulation/[]/workflows/[]/trigger/resourceReferences/[]
Type: Object
A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/trigger/resourceReferences/[]/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/trigger/resourceReferences/[]/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/trigger/type
Type: String (enum)
The source type of event which caused the trigger to fire.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/trigger/event
Type: Object
The event data that caused the associated trigger to activate.
| Property | Type | Requirement | Description |
|---|---|---|---|
| uid | String | Optional | The unique identifier of the event. |
| description | String | Optional | A description of the event. |
| timeReceived | String | Optional | The date and time (timestamp) when the event was received. |
| data | Object | Optional | Encoding of the raw event data. |
| source | Array | Optional | References the component or service that was the source of the event. |
| target | Array | Optional | References the component or service that was the target of the event. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/trigger/event/uid
Type: String
The unique identifier of the event.
Location: /formulation/[]/workflows/[]/trigger/event/description
Type: String
A description of the event.
Location: /formulation/[]/workflows/[]/trigger/event/timeReceived
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the event was received.
Location: /formulation/[]/workflows/[]/trigger/event/data
Type: Object
Encoding of the raw event data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/trigger/event/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/trigger/event/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/trigger/event/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/trigger/event/source
Type: Object
References the component or service that was the source of the event
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/trigger/event/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/trigger/event/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/trigger/event/target
Type: Object
References the component or service that was the target of the event
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/trigger/event/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/trigger/event/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/trigger/event/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/trigger/event/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/trigger/event/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/trigger/event/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/trigger/conditions
Property: conditions (Optional)
Type: Array
Uniqueness: All items shall be unique.
A list of conditions used to determine if a trigger should be activated. Each item of this array shall be a Condition object.
Location: /formulation/[]/workflows/[]/trigger/conditions/[]
Type: Object
A condition that was used to determine a trigger should be activated.
| Property | Type | Requirement | Description |
|---|---|---|---|
| description | String | Optional | Describes the set of conditions which cause the trigger to activate. |
| expression | String | Optional | The logical expression that was evaluated that determined the trigger should be fired. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/trigger/conditions/[]/description
Type: String
Describes the set of conditions which cause the trigger to activate.
Location: /formulation/[]/workflows/[]/trigger/conditions/[]/expression
Type: String
The logical expression that was evaluated that determined the trigger should be fired.
Location: /formulation/[]/workflows/[]/trigger/conditions/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/trigger/conditions/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/trigger/conditions/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/trigger/conditions/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/trigger/timeActivated
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the trigger was activated.
Location: /formulation/[]/workflows/[]/trigger/inputs
Property: inputs (Optional)
Type: Array
Uniqueness: All items shall be unique.
Represents resources and data brought into a task at runtime by executor or task commands Each item of this array shall be an Input type object.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]
Type: Object
Type that represents various input data types and formats.
| Property | Type | Requirement | Description |
|---|---|---|---|
| source | Array | Optional | A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of inbound). |
| target | Array | Optional | A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace). |
| resource | Array | Optional | A reference to an independent resource provided as an input to a task by the workflow runtime. |
| parameters | Array | Optional | Inputs that have the form of parameters with names and values. |
| environmentVars | Array | Optional | Inputs that have the form of parameters with names and values. |
| data | Object | Optional | Inputs that have the form of data. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/source
Type: Object
A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of inbound)
source code repository
database
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/target
Type: Object
A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace)
workspace
directory
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/resource
Type: Object
A reference to an independent resource provided as an input to a task by the workflow runtime.
a reference to a configuration file in a repository (i.e., a bom-ref)
a reference to a scanning service used in a task (i.e., a bom-ref)
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/resource/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/resource/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/parameters
Property: parameters (Optional)
Type: Array
Uniqueness: All items shall be unique.
Inputs that have the form of parameters with names and values. Each item of this array shall be a Parameter object.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/parameters/[]
Type: Object
A representation of a functional parameter.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the parameter. |
| value | String | Optional | The value of the parameter. |
| dataType | String | Optional | The data type of the parameter. |
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/parameters/[]/name
Type: String
The name of the parameter.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/parameters/[]/value
Type: String
The value of the parameter.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/parameters/[]/dataType
Type: String
The data type of the parameter.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/environmentVars
Property: environmentVars (Optional)
Type: Array
Uniqueness: All items shall be unique.
Inputs that have the form of parameters with names and values.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/environmentVars/[]
Shall be one of:
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Type: String
In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/environmentVars/[]/name
Property: name (Required)
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/environmentVars/[]/value
Property: value (Optional)
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/data
Type: Object
Inputs that have the form of data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/trigger/inputs/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/trigger/outputs
Property: outputs (Optional)
Type: Array
Uniqueness: All items shall be unique.
Represents resources and data output from a task at runtime by executor or task commands
Location: /formulation/[]/workflows/[]/trigger/outputs/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | Describes the type of data output. |
| source | Array | Optional | Component or service that generated or provided the output from the task (e.g., a build tool). |
| target | Array | Optional | Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of outbound). |
| resource | Array | Optional | A reference to an independent resource generated as output by the task. |
| data | Object | Optional | Outputs that have the form of data. |
| environmentVars | Array | Optional | Outputs that have the form of environment variables. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/type
Type: String (enum)
Describes the type of data output.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/trigger/outputs/[]/source
Type: Object
Component or service that generated or provided the output from the task (e.g., a build tool)
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/target
Type: Object
Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of outbound)
a log file described as an `externalReference` within its target domain.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/resource
Type: Object
A reference to an independent resource generated as output by the task.
configuration file
source code
scanning service
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/resource/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/resource/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/data
Type: Object
Outputs that have the form of data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/environmentVars
Property: environmentVars (Optional)
Type: Array
Uniqueness: All items shall be unique.
Outputs that have the form of environment variables.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/environmentVars/[]
Shall be one of:
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Type: String
In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/environmentVars/[]/name
Property: name (Required)
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/environmentVars/[]/value
Property: value (Optional)
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/trigger/outputs/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/trigger/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/trigger/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/trigger/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/trigger/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/steps
Property: steps (Optional)
Type: Array
Uniqueness: All items shall be unique.
The sequence of steps for the task.
Location: /formulation/[]/workflows/[]/steps/[]
Type: Object
Executes specific commands or tools in order to accomplish its owning task as part of a sequence.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | A name for the step. |
| description | String | Optional | A description of the step. |
| commands | Array | Optional | Ordered list of commands or directives for the step. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/steps/[]/name
Type: String
A name for the step.
Location: /formulation/[]/workflows/[]/steps/[]/description
Type: String
A description of the step.
Location: /formulation/[]/workflows/[]/steps/[]/commands
Property: commands (Optional)
Type: Array
Ordered list of commands or directives for the step
Location: /formulation/[]/workflows/[]/steps/[]/commands/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| executed | String | Optional | A text representation of the executed command. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/steps/[]/commands/[]/executed
Type: String
A text representation of the executed command.
Location: /formulation/[]/workflows/[]/steps/[]/commands/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/steps/[]/commands/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/steps/[]/commands/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/steps/[]/commands/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/steps/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/steps/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/steps/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/steps/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/inputs
Property: inputs (Optional)
Type: Array
Uniqueness: All items shall be unique.
Represents resources and data brought into a task at runtime by executor or task commands Each item of this array shall be an Input type object.
Location: /formulation/[]/workflows/[]/inputs/[]
Type: Object
Type that represents various input data types and formats.
| Property | Type | Requirement | Description |
|---|---|---|---|
| source | Array | Optional | A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of inbound). |
| target | Array | Optional | A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace). |
| resource | Array | Optional | A reference to an independent resource provided as an input to a task by the workflow runtime. |
| parameters | Array | Optional | Inputs that have the form of parameters with names and values. |
| environmentVars | Array | Optional | Inputs that have the form of parameters with names and values. |
| data | Object | Optional | Inputs that have the form of data. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/inputs/[]/source
Type: Object
A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of inbound)
source code repository
database
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/inputs/[]/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/inputs/[]/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/inputs/[]/target
Type: Object
A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace)
workspace
directory
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/inputs/[]/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/inputs/[]/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/inputs/[]/resource
Type: Object
A reference to an independent resource provided as an input to a task by the workflow runtime.
a reference to a configuration file in a repository (i.e., a bom-ref)
a reference to a scanning service used in a task (i.e., a bom-ref)
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/inputs/[]/resource/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/inputs/[]/resource/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/inputs/[]/parameters
Property: parameters (Optional)
Type: Array
Uniqueness: All items shall be unique.
Inputs that have the form of parameters with names and values. Each item of this array shall be a Parameter object.
Location: /formulation/[]/workflows/[]/inputs/[]/parameters/[]
Type: Object
A representation of a functional parameter.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the parameter. |
| value | String | Optional | The value of the parameter. |
| dataType | String | Optional | The data type of the parameter. |
Location: /formulation/[]/workflows/[]/inputs/[]/parameters/[]/name
Type: String
The name of the parameter.
Location: /formulation/[]/workflows/[]/inputs/[]/parameters/[]/value
Type: String
The value of the parameter.
Location: /formulation/[]/workflows/[]/inputs/[]/parameters/[]/dataType
Type: String
The data type of the parameter.
Location: /formulation/[]/workflows/[]/inputs/[]/environmentVars
Property: environmentVars (Optional)
Type: Array
Uniqueness: All items shall be unique.
Inputs that have the form of parameters with names and values.
Location: /formulation/[]/workflows/[]/inputs/[]/environmentVars/[]
Shall be one of:
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Type: String
In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning.
Location: /formulation/[]/workflows/[]/inputs/[]/environmentVars/[]/name
Property: name (Required)
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/inputs/[]/environmentVars/[]/value
Property: value (Optional)
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/inputs/[]/data
Type: Object
Inputs that have the form of data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/inputs/[]/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/inputs/[]/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/inputs/[]/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/inputs/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/inputs/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/inputs/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/inputs/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/outputs
Property: outputs (Optional)
Type: Array
Uniqueness: All items shall be unique.
Represents resources and data output from a task at runtime by executor or task commands
Location: /formulation/[]/workflows/[]/outputs/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | String | Optional | Describes the type of data output. |
| source | Array | Optional | Component or service that generated or provided the output from the task (e.g., a build tool). |
| target | Array | Optional | Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of outbound). |
| resource | Array | Optional | A reference to an independent resource generated as output by the task. |
| data | Object | Optional | Outputs that have the form of data. |
| environmentVars | Array | Optional | Outputs that have the form of environment variables. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/outputs/[]/type
Type: String (enum)
Describes the type of data output.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/outputs/[]/source
Type: Object
Component or service that generated or provided the output from the task (e.g., a build tool)
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/outputs/[]/source/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/outputs/[]/source/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/outputs/[]/target
Type: Object
Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of outbound)
a log file described as an `externalReference` within its target domain.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/outputs/[]/target/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/outputs/[]/target/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/outputs/[]/resource
Type: Object
A reference to an independent resource generated as output by the task.
configuration file
source code
scanning service
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/outputs/[]/resource/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/outputs/[]/resource/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/outputs/[]/data
Type: Object
Outputs that have the form of data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /formulation/[]/workflows/[]/outputs/[]/data/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /formulation/[]/workflows/[]/outputs/[]/data/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /formulation/[]/workflows/[]/outputs/[]/data/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /formulation/[]/workflows/[]/outputs/[]/environmentVars
Property: environmentVars (Optional)
Type: Array
Uniqueness: All items shall be unique.
Outputs that have the form of environment variables.
Location: /formulation/[]/workflows/[]/outputs/[]/environmentVars/[]
Shall be one of:
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Type: String
In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning.
Location: /formulation/[]/workflows/[]/outputs/[]/environmentVars/[]/name
Property: name (Required)
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/outputs/[]/environmentVars/[]/value
Property: value (Optional)
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/outputs/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/outputs/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/outputs/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/outputs/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/timeStart
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the task started.
Location: /formulation/[]/workflows/[]/timeEnd
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the task ended.
Location: /formulation/[]/workflows/[]/workspaces
Property: workspaces (Optional)
Type: Array
Uniqueness: All items shall be unique.
A set of named filesystem or data resource shareable by workflow tasks. Each item of this array shall be a Workspace object.
Location: /formulation/[]/workflows/[]/workspaces/[]
Type: Object
A named filesystem or data resource shareable by workflow tasks.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Required | An identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| uid | String | Required | The unique identifier for the resource instance within its deployment context. |
| name | String | Optional | The name of the resource instance. |
| aliases | Array | Optional | The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps. |
| description | String | Optional | A description of the resource instance. |
| resourceReferences | Array | Optional | References to component or service resources that are used to realize the resource instance. |
| accessMode | String | Optional | Describes the read-write access control for the workspace relative to the owning resource instance. |
| mountPath | String | Optional | A path to a location on disk where the workspace will be available to the associated task's steps. |
| managedDataType | String | Optional | The name of a domain-specific data type the workspace represents. |
| volumeRequest | String | Optional | Identifies the reference to the request for a specific volume type and parameters. |
| volume | Object | Optional | Information about the actual volume instance allocated to the workspace. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/workspaces/[]/bom-ref
Type: String
An identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /formulation/[]/workflows/[]/workspaces/[]/uid
Type: String
The unique identifier for the resource instance within its deployment context.
Location: /formulation/[]/workflows/[]/workspaces/[]/name
Type: String
The name of the resource instance.
Location: /formulation/[]/workflows/[]/workspaces/[]/aliases
Property: aliases (Optional)
Type: Array (of String)
The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps. Each item of this array shall be a string.
Location: /formulation/[]/workflows/[]/workspaces/[]/description
Type: String
A description of the resource instance.
Location: /formulation/[]/workflows/[]/workspaces/[]/resourceReferences
Property: resourceReferences (Optional)
Type: Array
Uniqueness: All items shall be unique.
References to component or service resources that are used to realize the resource instance. Each item of this array shall be a Resource reference choice object.
Location: /formulation/[]/workflows/[]/workspaces/[]/resourceReferences/[]
Type: Object
A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | Array | Optional | References an object by its bom-ref attribute. |
| externalReference | Object | Optional | Reference to an externally accessible resource. |
Location: /formulation/[]/workflows/[]/workspaces/[]/resourceReferences/[]/ref
References an object by its bom-ref attribute
Shall be any of:
Type: String
Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType.
Type: String
Format: iri-reference as specified in RFC 3987
Pattern Constraint: ^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/
Location: /formulation/[]/workflows/[]/workspaces/[]/resourceReferences/[]/externalReference
Type: Object
Reference to an externally accessible resource.
Location: /formulation/[]/workflows/[]/workspaces/[]/accessMode
Type: String (enum)
Describes the read-write access control for the workspace relative to the owning resource instance.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/workspaces/[]/mountPath
Type: String
A path to a location on disk where the workspace will be available to the associated task's steps.
Location: /formulation/[]/workflows/[]/workspaces/[]/managedDataType
Type: String
The name of a domain-specific data type the workspace represents.
ConfigMap
Secret
Location: /formulation/[]/workflows/[]/workspaces/[]/volumeRequest
Type: String
Identifies the reference to the request for a specific volume type and parameters.
a kubernetes Persistent Volume Claim (PVC) name
Location: /formulation/[]/workflows/[]/workspaces/[]/volume
Type: Object
Information about the actual volume instance allocated to the workspace.
see https://kubernetes.io/docs/concepts/storage/persistent-volumes/
| Property | Type | Requirement | Description |
|---|---|---|---|
| uid | String | Optional | The unique identifier for the volume instance within its deployment context. |
| name | String | Optional | The name of the volume instance. |
| mode | String | Optional | The mode for the volume instance. |
| path | String | Optional | The underlying path created from the actual volume. |
| sizeAllocated | String | Optional | The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as IEC standard unit in either decimal or binary form. |
| persistent | Boolean | Optional | Indicates if the volume persists beyond the life of the resource it is associated with. |
| remote | Boolean | Optional | Indicates if the volume is remotely (i.e., network) attached. |
| properties | Array | Optional | 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. |
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/uid
Type: String
The unique identifier for the volume instance within its deployment context.
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/name
Type: String
The name of the volume instance
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/mode
Type: String (enum)
Default Value: filesystem
The mode for the volume instance.
Enumeration of possible values:Location: /formulation/[]/workflows/[]/workspaces/[]/volume/path
Type: String
The underlying path created from the actual volume.
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/sizeAllocated
Type: String
The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as IEC standard unit in either decimal or binary form.
10GB
2Ti
1Pi
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/persistent
Type: Boolean
Indicates if the volume persists beyond the life of the resource it is associated with.
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/remote
Type: Boolean
Indicates if the volume is remotely (i.e., network) attached.
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/workspaces/[]/volume/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/workspaces/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/workspaces/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/workspaces/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/workspaces/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/workflows/[]/runtimeTopology
Property: runtimeTopology (Optional)
Type: Array
Uniqueness: All items shall be unique.
A graph of the component runtime topology for workflow's instance. Each item of this array shall be a Dependency object.
Location: /formulation/[]/workflows/[]/runtimeTopology/[]
Type: Object
Defines the direct dependencies of a component, service, or the components provided/implemented by a given component. Components or services that do not have their own dependencies shall be declared as empty elements within the graph. Components or services that are not represented in the dependency graph may have unknown dependencies. It is recommended that implementations assume this to be opaque and not an indicator of an object being dependency-free. It is recommended to leverage compositions to indicate unknown dependency graphs.
| Property | Type | Requirement | Description |
|---|---|---|---|
| ref | String | Required | References a component or service by its bom-ref attribute. |
| dependsOn | Array | Optional | The bom-ref identifiers of the components or services that are dependencies of this dependency object. |
| provides | Array | Optional | The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object. For example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use. |
Location: /formulation/[]/workflows/[]/runtimeTopology/[]/ref
Type: String
References a component or service by its bom-ref attribute
Location: /formulation/[]/workflows/[]/runtimeTopology/[]/dependsOn
Property: dependsOn (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services that are dependencies of this dependency object. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /formulation/[]/workflows/[]/runtimeTopology/[]/provides
Property: provides (Optional)
Type: Array (of String)
Uniqueness: All items shall be unique.
The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object. For example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /formulation/[]/workflows/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/workflows/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/workflows/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/workflows/[]/properties/[]/value
Type: String
The value of the property.
Location: /formulation/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /formulation/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /formulation/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /formulation/[]/properties/[]/value
Type: String
The value of the property.
Location: /declarations
Property: declarations (Optional)
Type: Object
The list of declarations which describe the conformance to standards. Each declaration may include attestations, claims, and evidence.
| Property | Type | Requirement | Description |
|---|---|---|---|
| assessors | Array | Optional | The list of assessors evaluating claims and determining conformance to requirements and confidence in that assessment. |
| attestations | Array | Optional | The list of attestations asserted by an assessor that maps requirements to claims. |
| claims | Array | Optional | The list of claims. |
| evidence | Array | Optional | The list of evidence. |
| targets | Object | Optional | The list of targets which claims are made against. |
| affirmation | Object | Optional | A concise statement affirmed by an individual regarding all declarations, often used for third-party auditor acceptance or recipient acknowledgment. It includes a list of authorized signatories who assert the validity of the document on behalf of the organization. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /declarations/assessors
Property: assessors (Optional)
Type: Array
The list of assessors evaluating claims and determining conformance to requirements and confidence in that assessment. Each item of this array shall be an Assessor object.
Location: /declarations/assessors/[]
Type: Object
The assessor who evaluates claims and determines conformance to requirements and confidence in that assessment.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. |
| thirdParty | Boolean | Optional | The boolean indicating if the assessor is outside the organization generating claims. A value of false indicates a self assessor. |
| organization | Object | Optional | The entity issuing the assessment. |
Location: /declarations/assessors/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM.
Location: /declarations/assessors/[]/thirdParty
Type: Boolean
The boolean indicating if the assessor is outside the organization generating claims. A value of false indicates a self assessor.
Location: /declarations/assessors/[]/organization
Type: Object
The entity issuing the assessment.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /declarations/assessors/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/assessors/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /declarations/assessors/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /declarations/assessors/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/assessors/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /declarations/assessors/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /declarations/assessors/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /declarations/assessors/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /declarations/assessors/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /declarations/assessors/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /declarations/assessors/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /declarations/assessors/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /declarations/assessors/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/assessors/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/assessors/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /declarations/assessors/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/assessors/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/attestations
Property: attestations (Optional)
Type: Array
The list of attestations asserted by an assessor that maps requirements to claims. Each item of this array shall be an Attestation object.
Location: /declarations/attestations/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| summary | String | Optional | The short description explaining the main points of the attestation. |
| assessor | String | Optional | The bom-ref to the assessor asserting the attestation. |
| map | Array | Optional | The grouping of requirements to claims and the attestors declared conformance and confidence thereof. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /declarations/attestations/[]/summary
Type: String
The short description explaining the main points of the attestation.
Location: /declarations/attestations/[]/assessor
Type: String
The bom-ref to the assessor asserting the attestation.
Location: /declarations/attestations/[]/map
Property: map (Optional)
Type: Array
The grouping of requirements to claims and the attestors declared conformance and confidence thereof. Each item of this array shall be a Map object.
Location: /declarations/attestations/[]/map/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| requirement | String | Optional | The bom-ref to the requirement being attested to. |
| claims | Array | Optional | The list of bom-ref to the claims being attested to. |
| counterClaims | Array | Optional | The list of bom-ref to the counter claims being attested to. |
| conformance | Object | Optional | The conformance of the claim meeting a requirement. |
| confidence | Object | Optional | The confidence of the claim meeting the requirement. |
Location: /declarations/attestations/[]/map/[]/requirement
Type: String
The bom-ref to the requirement being attested to.
Location: /declarations/attestations/[]/map/[]/claims
Property: claims (Optional)
Type: Array (of String)
The list of bom-ref to the claims being attested to. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /declarations/attestations/[]/map/[]/counterClaims
Property: counterClaims (Optional)
Type: Array (of String)
The list of bom-ref to the counter claims being attested to. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /declarations/attestations/[]/map/[]/conformance
Type: Object
The conformance of the claim meeting a requirement.
| Property | Type | Requirement | Description |
|---|---|---|---|
| score | Number | Optional | The conformance of the claim between and inclusive of 0 and 1, where 1 is 100% conformance. |
| rationale | String | Optional | The rationale for the conformance score. |
| mitigationStrategies | Array | Optional | The list of bom-ref to the evidence provided describing the mitigation strategies. |
Location: /declarations/attestations/[]/map/[]/conformance/score
Type: Number
Maximum Value: 1
The conformance of the claim between and inclusive of 0 and 1, where 1 is 100% conformance.
Location: /declarations/attestations/[]/map/[]/conformance/rationale
Type: String
The rationale for the conformance score.
Location: /declarations/attestations/[]/map/[]/conformance/mitigationStrategies
Property: mitigationStrategies (Optional)
Type: Array (of String)
The list of bom-ref to the evidence provided describing the mitigation strategies. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /declarations/attestations/[]/map/[]/confidence
Type: Object
The confidence of the claim meeting the requirement.
| Property | Type | Requirement | Description |
|---|---|---|---|
| score | Number | Optional | The confidence of the claim between and inclusive of 0 and 1, where 1 is 100% confidence. |
| rationale | String | Optional | The rationale for the confidence score. |
Location: /declarations/attestations/[]/map/[]/confidence/score
Type: Number
Maximum Value: 1
The confidence of the claim between and inclusive of 0 and 1, where 1 is 100% confidence.
Location: /declarations/attestations/[]/map/[]/confidence/rationale
Type: String
The rationale for the confidence score.
Location: /declarations/attestations/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /declarations/claims
Property: claims (Optional)
Type: Array
The list of claims. Each item of this array shall be a Claim object.
Location: /declarations/claims/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. |
| target | String | Optional | The bom-ref to a target representing a specific system, application, API, module, team, person, process, business unit, company, etc... that this claim is being applied to. |
| predicate | String | Optional | The specific statement or assertion about the target. |
| mitigationStrategies | Array | Optional | The list of bom-ref to the evidence provided describing the mitigation strategies. Each mitigation strategy should include an explanation of how any weaknesses in the evidence will be mitigated. |
| reasoning | String | Optional | The written explanation of why the evidence provided substantiates the claim. |
| evidence | Array | Optional | The list of bom-ref to evidence that supports this claim. |
| counterEvidence | Array | Optional | The list of bom-ref to counterEvidence that supports this claim. |
| externalReferences | Array | Optional | 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. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /declarations/claims/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM.
Location: /declarations/claims/[]/target
Type: String
The bom-ref to a target representing a specific system, application, API, module, team, person, process, business unit, company, etc... that this claim is being applied to.
Location: /declarations/claims/[]/predicate
Type: String
The specific statement or assertion about the target.
Location: /declarations/claims/[]/mitigationStrategies
Property: mitigationStrategies (Optional)
Type: Array (of String)
The list of bom-ref to the evidence provided describing the mitigation strategies. Each mitigation strategy should include an explanation of how any weaknesses in the evidence will be mitigated. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /declarations/claims/[]/reasoning
Type: String
The written explanation of why the evidence provided substantiates the claim.
Location: /declarations/claims/[]/evidence
Property: evidence (Optional)
Type: Array (of String)
The list of bom-ref to evidence that supports this claim. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /declarations/claims/[]/counterEvidence
Property: counterEvidence (Optional)
Type: Array (of String)
The list of bom-ref to counterEvidence that supports this claim. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /declarations/claims/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /declarations/claims/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
Location: /declarations/claims/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /declarations/evidence
Property: evidence (Optional)
Type: Array
The list of evidence Each item of this array shall be an Evidence object.
Location: /declarations/evidence/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. |
| propertyName | String | Optional | The reference to the property name as defined in the CycloneDX Property Taxonomy. |
| description | String | Optional | The written description of what this evidence is and how it was created. |
| data | Array | Optional | The output or analysis that supports claims. |
| created | String | Optional | The date and time (timestamp) when the evidence was created. |
| expires | String | Optional | The date and time (timestamp) when the evidence is no longer valid. |
| author | Object | Optional | The author of the evidence. |
| reviewer | Object | Optional | The reviewer of the evidence. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /declarations/evidence/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM.
Location: /declarations/evidence/[]/propertyName
Type: String
The reference to the property name as defined in the CycloneDX Property Taxonomy.
Location: /declarations/evidence/[]/description
Type: String
The written description of what this evidence is and how it was created.
Location: /declarations/evidence/[]/data
Property: data (Optional)
Type: Array
The output or analysis that supports claims. Each item of this array shall be a Data object.
Location: /declarations/evidence/[]/data/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The name of the data. |
| contents | Object | Optional | The contents or references to the contents of the data being described. |
| classification | String | Optional | Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed. |
| sensitiveData | Array | Optional | A description of any sensitive data included. |
| governance | Object | Optional | 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. |
Location: /declarations/evidence/[]/data/[]/name
Type: String
The name of the data.
Location: /declarations/evidence/[]/data/[]/contents
Type: Object
The contents or references to the contents of the data being described.
| Property | Type | Requirement | Description |
|---|---|---|---|
| attachment | Object | Optional | A way to include textual or encoded data. |
| url | String | Optional | The URL to where the data can be retrieved. |
Location: /declarations/evidence/[]/data/[]/contents/attachment
Type: Object
A way to include textual or encoded data.
| Property | Type | Requirement | Description |
|---|---|---|---|
| contentType | String | Optional | Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry. |
| encoding | String | Optional | Specifies the encoding the text is represented in. |
| content | String | Required | The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Location: /declarations/evidence/[]/data/[]/contents/attachment/contentType
Type: String
Default Value: text/plain
Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include application/json for JSON data and text/plain for plan text documents. RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the IANA media types registry.
text/plain
application/json
image/png
Location: /declarations/evidence/[]/data/[]/contents/attachment/encoding
Type: String (enum)
Specifies the encoding the text is represented in.
| Value | Description |
|---|---|
| base64 | Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string. |
Location: /declarations/evidence/[]/data/[]/contents/attachment/content
Type: String
The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
Location: /declarations/evidence/[]/data/[]/contents/url
Type: String
Format: iri-reference as specified in RFC 3987
The URL to where the data can be retrieved.
Location: /declarations/evidence/[]/data/[]/classification
Type: String
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
Location: /declarations/evidence/[]/data/[]/sensitiveData
Property: sensitiveData (Optional)
Type: Array (of String)
A description of any sensitive data included. Each item of this array shall be a string.
Location: /declarations/evidence/[]/data/[]/governance
Type: Object
Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.
| Property | Type | Requirement | Description |
|---|---|---|---|
| custodians | Array | Optional | Data custodians are responsible for the safe custody, transport, and storage of data. |
| stewards | Array | Optional | Data stewards are responsible for data content, context, and associated business rules. |
| owners | Array | Optional | Data owners are concerned with risk and appropriate access to data. |
Location: /declarations/evidence/[]/data/[]/governance/custodians
Property: custodians (Optional)
Type: Array
Data custodians are responsible for the safe custody, transport, and storage of data.
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/evidence/[]/data/[]/governance/custodians/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/evidence/[]/data/[]/governance/stewards
Property: stewards (Optional)
Type: Array
Data stewards are responsible for data content, context, and associated business rules.
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/evidence/[]/data/[]/governance/stewards/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/evidence/[]/data/[]/governance/owners
Property: owners (Optional)
Type: Array
Data owners are concerned with risk and appropriate access to data.
Location: /declarations/evidence/[]/data/[]/governance/owners/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| organization | Object | Optional | The organization that is responsible for specific data governance role(s). |
| contact | Object | Optional | The individual that is responsible for specific data governance role(s). |
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization
Type: Object
The organization that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/contact
Type: Object
The individual that is responsible for specific data governance role(s).
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/contact/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/contact/name
Type: String
The name of a contact
Contact name
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/contact/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/evidence/[]/data/[]/governance/owners/[]/contact/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/evidence/[]/created
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the evidence was created.
Location: /declarations/evidence/[]/expires
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time (timestamp) when the evidence is no longer valid.
Location: /declarations/evidence/[]/author
Type: Object
The author of the evidence.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/evidence/[]/author/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/author/name
Type: String
The name of a contact
Contact name
Location: /declarations/evidence/[]/author/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/evidence/[]/author/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/evidence/[]/reviewer
Type: Object
The reviewer of the evidence.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/evidence/[]/reviewer/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/evidence/[]/reviewer/name
Type: String
The name of a contact
Contact name
Location: /declarations/evidence/[]/reviewer/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/evidence/[]/reviewer/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/evidence/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /declarations/targets
Property: targets (Optional)
Type: Object
The list of targets which claims are made against.
| Property | Type | Requirement | Description |
|---|---|---|---|
| organizations | Array | Optional | The list of organizations which claims are made against. |
| components | Array | Optional | The list of components which claims are made against. |
| services | Array | Optional | The list of services which claims are made against. |
Location: /declarations/targets/organizations
Property: organizations (Optional)
Type: Array
The list of organizations which claims are made against.
Location: /declarations/targets/organizations/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /declarations/targets/organizations/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/targets/organizations/[]/name
Type: String
The name of the organization
Example Inc.
Location: /declarations/targets/organizations/[]/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /declarations/targets/organizations/[]/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/targets/organizations/[]/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /declarations/targets/organizations/[]/address/region
Type: String
The region or state in the country.
Texas
Location: /declarations/targets/organizations/[]/address/locality
Type: String
The locality or city within the country.
Austin
Location: /declarations/targets/organizations/[]/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /declarations/targets/organizations/[]/address/postalCode
Type: String
The postal code.
78758
Location: /declarations/targets/organizations/[]/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /declarations/targets/organizations/[]/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /declarations/targets/organizations/[]/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /declarations/targets/organizations/[]/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/targets/organizations/[]/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/targets/organizations/[]/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /declarations/targets/organizations/[]/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/targets/organizations/[]/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/targets/components
Property: components (Optional)
Type: Array
The list of components which claims are made against. Each item of this array shall be a Component object.
Location: /declarations/targets/components/[]
Type: Object
Location: /declarations/targets/services
Property: services (Optional)
Type: Array
The list of services which claims are made against. Each item of this array shall be a Service object.
Location: /declarations/targets/services/[]
Type: Object
Location: /declarations/affirmation
Property: affirmation (Optional)
Type: Object
A concise statement affirmed by an individual regarding all declarations, often used for third-party auditor acceptance or recipient acknowledgment. It includes a list of authorized signatories who assert the validity of the document on behalf of the organization.
| Property | Type | Requirement | Description |
|---|---|---|---|
| statement | String | Optional | The brief statement affirmed by an individual regarding all declarations. *- Notes This could be an affirmation of acceptance by a third-party auditor or receiving individual of a file. |
| signatories | Array | Optional | The list of signatories authorized on behalf of an organization to assert validity of this document. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /declarations/affirmation/statement
Property: statement (Optional)
Type: String
The brief statement affirmed by an individual regarding all declarations. *- Notes This could be an affirmation of acceptance by a third-party auditor or receiving individual of a file.
I certify, to the best of my knowledge, that all information is correct.
Location: /declarations/affirmation/signatories
Property: signatories (Optional)
Type: Array
The list of signatories authorized on behalf of an organization to assert validity of this document. Each item of this array shall be a Signatory object.
Location: /declarations/affirmation/signatories/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Optional | The signatory's name. |
| role | String | Optional | The signatory's role within an organization. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
| organization | Object | Optional | The signatory's organization. |
| externalReference | Object | Optional | 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. |
Location: /declarations/affirmation/signatories/[]/name
Type: String
The signatory's name.
Location: /declarations/affirmation/signatories/[]/role
Type: String
The signatory's role within an organization.
Location: /declarations/affirmation/signatories/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /declarations/affirmation/signatories/[]/organization
Type: Object
The signatory's organization.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /declarations/affirmation/signatories/[]/organization/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/affirmation/signatories/[]/organization/name
Type: String
The name of the organization
Example Inc.
Location: /declarations/affirmation/signatories/[]/organization/address
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /declarations/affirmation/signatories/[]/organization/address/bom-ref
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/affirmation/signatories/[]/organization/address/country
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /declarations/affirmation/signatories/[]/organization/address/region
Type: String
The region or state in the country.
Texas
Location: /declarations/affirmation/signatories/[]/organization/address/locality
Type: String
The locality or city within the country.
Austin
Location: /declarations/affirmation/signatories/[]/organization/address/postOfficeBoxNumber
Type: String
The post office box number.
901
Location: /declarations/affirmation/signatories/[]/organization/address/postalCode
Type: String
The postal code.
78758
Location: /declarations/affirmation/signatories/[]/organization/address/streetAddress
Type: String
The street address.
100 Main Street
Location: /declarations/affirmation/signatories/[]/organization/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /declarations/affirmation/signatories/[]/organization/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /declarations/affirmation/signatories/[]/organization/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /declarations/affirmation/signatories/[]/organization/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /declarations/affirmation/signatories/[]/organization/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /declarations/affirmation/signatories/[]/organization/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /declarations/affirmation/signatories/[]/organization/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /declarations/affirmation/signatories/[]/externalReference
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
Location: /declarations/affirmation/signature
Property: signature (Optional)
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /declarations/signature
Property: signature (Optional)
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /definitions
Property: definitions (Optional)
Type: Object
A collection of reusable objects that are defined and may be used elsewhere in the BOM.
| Property | Type | Requirement | Description |
|---|---|---|---|
| standards | Array | Optional | The list of standards which may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to. |
| patents | Array | Optional | The list of either individual patents or patent families. |
Location: /definitions/standards
Property: standards (Optional)
Type: Array
The list of standards which may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to. Each item of this array shall be a Standard object.
Location: /definitions/standards/[]
Type: Object
A standard may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. |
| name | String | Optional | The name of the standard. This will often be a shortened, single name of the standard. |
| version | String | Optional | The version of the standard. |
| description | String | Optional | The description of the standard. |
| owner | String | Optional | The owner of the standard, often the entity responsible for its release. |
| requirements | Array | Optional | The list of requirements comprising the standard. |
| levels | Array | Optional | The list of levels associated with the standard. Some standards have different levels of compliance. |
| externalReferences | Array | Optional | 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. |
| signature | Array | Optional | Enveloped signature in JSON Signature Format (JSF). |
Location: /definitions/standards/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM.
Location: /definitions/standards/[]/name
Type: String
The name of the standard. This will often be a shortened, single name of the standard.
Location: /definitions/standards/[]/version
Type: String
The version of the standard.
Location: /definitions/standards/[]/description
Type: String
The description of the standard.
Location: /definitions/standards/[]/owner
Type: String
The owner of the standard, often the entity responsible for its release.
Location: /definitions/standards/[]/requirements
Property: requirements (Optional)
Type: Array
The list of requirements comprising the standard. Each item of this array shall be a Requirement object.
Location: /definitions/standards/[]/requirements/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. |
| identifier | String | Optional | The unique identifier used in the standard to identify a specific requirement. This should match what is in the standard and should not be the requirements bom-ref. |
| title | String | Optional | The title of the requirement. |
| text | String | Optional | The textual content of the requirement. |
| descriptions | Array | Optional | The supplemental text that provides additional guidance or context to the requirement, but is not directly part of the requirement. |
| openCre | Array | Optional | The Common Requirements Enumeration (CRE) identifier(s). CRE is a structured and standardized framework for uniting security standards and guidelines. CRE links each section of a resource to a shared topic identifier (a Common Requirement). Through this shared topic link, all resources map to each other. Use of CRE promotes clear and unambiguous communication among stakeholders. |
| parent | String | Optional | The bom-ref to a parent requirement. This establishes a hierarchy of requirements. Top-level requirements shall not define a parent. Only child requirements should define parents. |
| properties | Array | Optional | 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. |
| externalReferences | Array | Optional | 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. |
Location: /definitions/standards/[]/requirements/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM.
Location: /definitions/standards/[]/requirements/[]/identifier
Type: String
The unique identifier used in the standard to identify a specific requirement. This should match what is in the standard and should not be the requirements bom-ref.
Location: /definitions/standards/[]/requirements/[]/title
Type: String
The title of the requirement.
Location: /definitions/standards/[]/requirements/[]/text
Type: String
The textual content of the requirement.
Location: /definitions/standards/[]/requirements/[]/descriptions
Property: descriptions (Optional)
Type: Array (of String)
The supplemental text that provides additional guidance or context to the requirement, but is not directly part of the requirement. Each item of this array shall be a string.
Location: /definitions/standards/[]/requirements/[]/openCre
Property: openCre (Optional)
Type: Array (of String)
Pattern Constraint: ^CRE:[0-9]+-[0-9]+$
The Common Requirements Enumeration (CRE) identifier(s). CRE is a structured and standardized framework for uniting security standards and guidelines. CRE links each section of a resource to a shared topic identifier (a Common Requirement). Through this shared topic link, all resources map to each other. Use of CRE promotes clear and unambiguous communication among stakeholders. Each item of this array shall be a string.
CRE:764-507
Location: /definitions/standards/[]/requirements/[]/parent
Type: String
The bom-ref to a parent requirement. This establishes a hierarchy of requirements. Top-level requirements shall not define a parent. Only child requirements should define parents.
Location: /definitions/standards/[]/requirements/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /definitions/standards/[]/requirements/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /definitions/standards/[]/requirements/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /definitions/standards/[]/requirements/[]/properties/[]/value
Type: String
The value of the property.
Location: /definitions/standards/[]/requirements/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /definitions/standards/[]/requirements/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
Location: /definitions/standards/[]/levels
Property: levels (Optional)
Type: Array
The list of levels associated with the standard. Some standards have different levels of compliance. Each item of this array shall be a Level object.
Location: /definitions/standards/[]/levels/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. |
| identifier | String | Optional | The identifier used in the standard to identify a specific level. |
| title | String | Optional | The title of the level. |
| description | String | Optional | The description of the level. |
| requirements | Array | Optional | The list of requirement bom-refs that comprise the level. |
Location: /definitions/standards/[]/levels/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM.
Location: /definitions/standards/[]/levels/[]/identifier
Type: String
The identifier used in the standard to identify a specific level.
Location: /definitions/standards/[]/levels/[]/title
Type: String
The title of the level.
Location: /definitions/standards/[]/levels/[]/description
Type: String
The description of the level.
Location: /definitions/standards/[]/levels/[]/requirements
Property: requirements (Optional)
Type: Array (of String)
The list of requirement bom-refs that comprise the level. Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document. In contrast to bomLinkElementType. Each item of this array shall be a string.
Location: /definitions/standards/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /definitions/standards/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
Location: /definitions/standards/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /definitions/patents
Property: patents (Optional)
Type: Array
The list of either individual patents or patent families.
Location: /definitions/patents/[]
Shall be any of:
Type: Object
A patent is a legal instrument, granted by an authority, that confers certain rights over an invention for a specified period, contingent on public disclosure and adherence to relevant legal requirements. The summary information in this object is aligned with WIPO ST.96 principles where applicable.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. |
| patentNumber | String | Required | The unique number assigned to the granted patent by the issuing authority. Aligned with PatentNumber in WIPO ST.96. Refer to PatentNumber in ST.96. |
| applicationNumber | String | Optional | The unique number assigned to a patent application when it is filed with a patent office. It is used to identify the specific application and track its progress through the examination process. Aligned with ApplicationNumber in ST.96. Refer to ApplicationIdentificationType in ST.96. |
| jurisdiction | String | Required | The jurisdiction or patent office where the priority application was filed, specified using WIPO ST.3 codes. Aligned with IPOfficeCode in ST.96. Refer to IPOfficeCode in ST.96. |
| priorityApplication | Object | Optional | The priorityApplication contains the essential data necessary to identify and reference an earlier patent filing for priority rights. In line with WIPO ST.96 guidelines, it includes the jurisdiction (office code), application number, and filing date-the three key elements that uniquely specify the priority application in a global patent context. |
| publicationNumber | String | Optional | This is the number assigned to a patent application once it is published. Patent applications are generally published 18 months after filing (unless an applicant requests non-publication). This number is distinct from the application number. Purpose: Identifies the publicly available version of the application. Format: Varies by jurisdiction, often similar to application numbers but includes an additional suffix indicating publication. Example: - US: US20240000123A1 (indicates the first publication of application US20240000123) - Europe: EP23123456A1 (first publication of European application EP23123456). WIPO ST.96 v8.0: - Publication Number field: https://www.wipo.int/standards/XMLSchema/ST96/V8_0/Patent/PublicationNumber.xsd. |
| title | String | Optional | The title of the patent, summarising the invention it protects. Aligned with InventionTitle in WIPO ST.96. Refer to InventionTitle in ST.96. |
| abstract | String | Optional | A brief summary of the invention described in the patent. Aligned with Abstract and P in WIPO ST.96. Refer to Abstract in ST.96. |
| filingDate | String | Optional | The date the patent application was filed with the jurisdiction. Aligned with FilingDate in WIPO ST.96. Refer to FilingDate in ST.96. |
| grantDate | String | Optional | The date the patent was granted by the jurisdiction. Aligned with GrantDate in WIPO ST.96. Refer to GrantDate in ST.96. |
| patentExpirationDate | String | Optional | The date the patent expires. Derived from grant or filing date according to jurisdiction-specific rules. |
| patentLegalStatus | String | Required | Indicates the current legal status of the patent or patent application, based on the WIPO ST.27 standard. This status reflects administrative, procedural, or legal events. Values include both active and inactive states and are useful for determining enforceability, procedural history, and maintenance status. |
| patentAssignee | Array | Optional | A collection of organisations or individuals to whom the patent rights are assigned. This supports joint ownership and allows for flexible representation of both corporate entities and individual inventors. |
| externalReferences | Array | Optional | 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. |
Type: Object
A patent family is a group of related patent applications or granted patents that cover the same or similar invention. These patents are filed in multiple jurisdictions to protect the invention across different regions or countries. A patent family typically includes patents that share a common priority date, originating from the same initial application, and may vary slightly in scope or claims to comply with regional legal frameworks. Fields align with WIPO ST.96 standards where applicable.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. For a patent, it might be a good idea to use a patent number as the BOM reference ID. |
| familyId | String | Required | The unique identifier for the patent family, aligned with the id attribute in WIPO ST.96 v8.0's PatentFamilyType. Refer to PatentFamilyType in ST.96. |
| priorityApplication | Object | Optional | The priorityApplication contains the essential data necessary to identify and reference an earlier patent filing for priority rights. In line with WIPO ST.96 guidelines, it includes the jurisdiction (office code), application number, and filing date-the three key elements that uniquely specify the priority application in a global patent context. |
| members | Array | Optional | A collection of patents or applications that belong to this family, each identified by a bom-ref pointing to a patent object defined elsewhere in the BOM. |
| externalReferences | Array | Optional | 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. |
Location: /definitions/patents/[]/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM.
Location: /definitions/patents/[]/patentNumber
Property: patentNumber (Required)
Type: String
Pattern Constraint: ^[A-Za-z0-9][A-Za-z0-9\-/.()\s]{0,28}[A-Za-z0-9]$
The unique number assigned to the granted patent by the issuing authority. Aligned with PatentNumber in WIPO ST.96. Refer to PatentNumber in ST.96.
US987654321
EP1234567B1
Location: /definitions/patents/[]/applicationNumber
Property: applicationNumber (Optional)
Type: String
Pattern Constraint: ^[A-Za-z0-9][A-Za-z0-9\-/.()\s]{0,28}[A-Za-z0-9]$
The unique number assigned to a patent application when it is filed with a patent office. It is used to identify the specific application and track its progress through the examination process. Aligned with ApplicationNumber in ST.96. Refer to ApplicationIdentificationType in ST.96.
US20240000123
EP23123456
Location: /definitions/patents/[]/jurisdiction
Property: jurisdiction (Required)
Type: String
Pattern Constraint: ^[A-Z]{2}$
The jurisdiction or patent office where the priority application was filed, specified using WIPO ST.3 codes. Aligned with IPOfficeCode in ST.96. Refer to IPOfficeCode in ST.96.
US
EP
JP
Location: /definitions/patents/[]/priorityApplication
Property: priorityApplication (Optional)
Type: Object
The priorityApplication contains the essential data necessary to identify and reference an earlier patent filing for priority rights. In line with WIPO ST.96 guidelines, it includes the jurisdiction (office code), application number, and filing date-the three key elements that uniquely specify the priority application in a global patent context.
| Property | Type | Requirement | Description |
|---|---|---|---|
| applicationNumber | String | Required | The unique number assigned to a patent application when it is filed with a patent office. It is used to identify the specific application and track its progress through the examination process. Aligned with ApplicationNumber in ST.96. Refer to ApplicationIdentificationType in ST.96. |
| jurisdiction | String | Required | The jurisdiction or patent office where the priority application was filed, specified using WIPO ST.3 codes. Aligned with IPOfficeCode in ST.96. Refer to IPOfficeCode in ST.96. |
| filingDate | String | Required | The date the priority application was filed, aligned with FilingDate in ST.96. Refer to FilingDate in ST.96. |
Location: /definitions/patents/[]/priorityApplication/applicationNumber
Property: applicationNumber (Required)
Type: String
Pattern Constraint: ^[A-Za-z0-9][A-Za-z0-9\-/.()\s]{0,28}[A-Za-z0-9]$
The unique number assigned to a patent application when it is filed with a patent office. It is used to identify the specific application and track its progress through the examination process. Aligned with ApplicationNumber in ST.96. Refer to ApplicationIdentificationType in ST.96.
US20240000123
EP23123456
Location: /definitions/patents/[]/priorityApplication/jurisdiction
Property: jurisdiction (Required)
Type: String
Pattern Constraint: ^[A-Z]{2}$
The jurisdiction or patent office where the priority application was filed, specified using WIPO ST.3 codes. Aligned with IPOfficeCode in ST.96. Refer to IPOfficeCode in ST.96.
US
EP
JP
Location: /definitions/patents/[]/priorityApplication/filingDate
Property: filingDate (Required)
Type: String
Format: date as specified in RFC 3339 section 5.6
The date the priority application was filed, aligned with FilingDate in ST.96. Refer to FilingDate in ST.96.
Location: /definitions/patents/[]/publicationNumber
Property: publicationNumber (Optional)
Type: String
Pattern Constraint: ^[A-Za-z0-9][A-Za-z0-9\-/.()\s]{0,28}[A-Za-z0-9]$
This is the number assigned to a patent application once it is published. Patent applications are generally published 18 months after filing (unless an applicant requests non-publication). This number is distinct from the application number. Purpose: Identifies the publicly available version of the application. Format: Varies by jurisdiction, often similar to application numbers but includes an additional suffix indicating publication. Example: - US: US20240000123A1 (indicates the first publication of application US20240000123) - Europe: EP23123456A1 (first publication of European application EP23123456). WIPO ST.96 v8.0: - Publication Number field: https://www.wipo.int/standards/XMLSchema/ST96/V8_0/Patent/PublicationNumber.xsd
Location: /definitions/patents/[]/title
Property: title (Optional)
Type: String
The title of the patent, summarising the invention it protects. Aligned with InventionTitle in WIPO ST.96. Refer to InventionTitle in ST.96.
Location: /definitions/patents/[]/abstract
Property: abstract (Optional)
Type: String
A brief summary of the invention described in the patent. Aligned with Abstract and P in WIPO ST.96. Refer to Abstract in ST.96.
Location: /definitions/patents/[]/filingDate
Property: filingDate (Optional)
Type: String
Format: date as specified in RFC 3339 section 5.6
The date the patent application was filed with the jurisdiction. Aligned with FilingDate in WIPO ST.96. Refer to FilingDate in ST.96.
Location: /definitions/patents/[]/grantDate
Property: grantDate (Optional)
Type: String
Format: date as specified in RFC 3339 section 5.6
The date the patent was granted by the jurisdiction. Aligned with GrantDate in WIPO ST.96. Refer to GrantDate in ST.96.
Location: /definitions/patents/[]/patentExpirationDate
Property: patentExpirationDate (Optional)
Type: String
Format: date as specified in RFC 3339 section 5.6
The date the patent expires. Derived from grant or filing date according to jurisdiction-specific rules.
Location: /definitions/patents/[]/patentLegalStatus
Property: patentLegalStatus (Required)
Type: String (enum)
Indicates the current legal status of the patent or patent application, based on the WIPO ST.27 standard. This status reflects administrative, procedural, or legal events. Values include both active and inactive states and are useful for determining enforceability, procedural history, and maintenance status.
| Value | Description |
|---|---|
| pending | The patent application has been filed but not yet examined or granted. |
| granted | The patent application has been examined and a patent has been issued. |
| revoked | The patent has been declared invalid through a legal or administrative process. |
| expired | The patent has reached the end of its enforceable term. |
| lapsed | The patent is no longer in force due to non-payment of maintenance fees or other requirements. |
| withdrawn | The patent application was voluntarily withdrawn by the applicant. |
| abandoned | The patent application was abandoned, often due to lack of action or response. |
| suspended | Processing of the patent application has been temporarily halted. |
| reinstated | A previously abandoned or lapsed patent has been reinstated. |
| opposed | The patent application or granted patent is under formal opposition proceedings. |
| terminated | The patent or application has been officially terminated. |
| invalidated | The patent has been invalidated, either in part or in full. |
| in-force | The granted patent is active and enforceable. |
Location: /definitions/patents/[]/patentAssignee
Property: patentAssignee (Optional)
Type: Array
A collection of organisations or individuals to whom the patent rights are assigned. This supports joint ownership and allows for flexible representation of both corporate entities and individual inventors.
Location: /definitions/patents/[]/patentAssignee/[]
Shall be one of:
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of the organization. |
| address | Object | Optional | The physical address (location) of the organization. |
| url | Array | Optional | The URL of the organization. Multiple URLs are allowed. |
| contact | Array | Optional | A contact at the organization. Multiple contacts are allowed. |
Location: /definitions/patents/[]/patentAssignee/[]/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /definitions/patents/[]/patentAssignee/[]/name
Property: name (Optional)
Type: String
The name of a contact
Contact name
Location: /definitions/patents/[]/patentAssignee/[]/email
Property: email (Optional)
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /definitions/patents/[]/patentAssignee/[]/phone
Property: phone (Optional)
Type: String
The phone number of the contact.
800-555-1212
Location: /definitions/patents/[]/patentAssignee/[]/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /definitions/patents/[]/patentAssignee/[]/name
Property: name (Optional)
Type: String
The name of the organization
Example Inc.
Location: /definitions/patents/[]/patentAssignee/[]/address
Property: address (Optional)
Type: Object
The physical address (location) of the organization
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| country | String | Optional | The country name or the two-letter ISO 3166-1 country code. |
| region | String | Optional | The region or state in the country. |
| locality | String | Optional | The locality or city within the country. |
| postOfficeBoxNumber | String | Optional | The post office box number. |
| postalCode | String | Optional | The postal code. |
| streetAddress | String | Optional | The street address. |
Location: /definitions/patents/[]/patentAssignee/[]/address/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /definitions/patents/[]/patentAssignee/[]/address/country
Property: country (Optional)
Type: String
The country name or the two-letter ISO 3166-1 country code.
Location: /definitions/patents/[]/patentAssignee/[]/address/region
Property: region (Optional)
Type: String
The region or state in the country.
Texas
Location: /definitions/patents/[]/patentAssignee/[]/address/locality
Property: locality (Optional)
Type: String
The locality or city within the country.
Austin
Location: /definitions/patents/[]/patentAssignee/[]/address/postOfficeBoxNumber
Property: postOfficeBoxNumber (Optional)
Type: String
The post office box number.
901
Location: /definitions/patents/[]/patentAssignee/[]/address/postalCode
Property: postalCode (Optional)
Type: String
The postal code.
78758
Location: /definitions/patents/[]/patentAssignee/[]/address/streetAddress
Property: streetAddress (Optional)
Type: String
The street address.
100 Main Street
Location: /definitions/patents/[]/patentAssignee/[]/url
Property: url (Optional)
Type: Array (of String)
Format: iri-reference as specified in RFC 3987
The URL of the organization. Multiple URLs are allowed. Each item of this array shall be a string.
https://example.com
Location: /definitions/patents/[]/patentAssignee/[]/contact
Property: contact (Optional)
Type: Array
A contact at the organization. Multiple contacts are allowed. Each item of this array shall be an Organizational Person object.
Location: /definitions/patents/[]/patentAssignee/[]/contact/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| name | String | Optional | The name of a contact. |
| String | Optional | The email address of the contact. | |
| phone | String | Optional | The phone number of the contact. |
Location: /definitions/patents/[]/patentAssignee/[]/contact/[]/bom-ref
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /definitions/patents/[]/patentAssignee/[]/contact/[]/name
Type: String
The name of a contact
Contact name
Location: /definitions/patents/[]/patentAssignee/[]/contact/[]/email
Type: String
Format: idn-email address as specified in RFC 6531
The email address of the contact.
firstname.lastname@example.com
Location: /definitions/patents/[]/patentAssignee/[]/contact/[]/phone
Type: String
The phone number of the contact.
800-555-1212
Location: /definitions/patents/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /definitions/patents/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
| Property | Type | Requirement | Description |
|---|---|---|---|
| url | Array | Required | The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs. |
| comment | String | Optional | A comment describing the external reference. |
| type | String | Required | Specifies the type of external reference. |
| hashes | Array | Optional | The hashes of the external reference (if applicable). |
| properties | Array | Optional | 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. |
Location: /definitions/patents/[]/externalReferences/[]/url
The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Shall be any of:
Type: String
Format: iri-reference as specified in RFC 3987
Type: Object
Location: /definitions/patents/[]/externalReferences/[]/comment
Type: String
A comment describing the external reference
Location: /definitions/patents/[]/externalReferences/[]/type
Type: String (enum)
Specifies the type of external reference.
| Value | 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 licence file. If a licence URL has been defined in the licence 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 the formulation of any referencable object within the BOM, including components, services, metadata, declarations, or the BOM itself. |
| 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) |
| patent | References information about patents which may be defined in human-readable documents or in machine-readable formats such as CycloneDX or ST.96. For detailed patent information or to reference the information provided directly by patent offices, it is recommended to leverage standards from the World Intellectual Property Organization (WIPO) such as ST.96. |
| patent-family | References information about a patent family which may be defined in human-readable documents or in machine-readable formats such as CycloneDX or ST.96. A patent family is a group of related patent applications or granted patents that cover the same or similar invention. For detailed patent family information or to reference the information provided directly by patent offices, it is recommended to leverage standards from the World Intellectual Property Organization (WIPO) such as ST.96. |
| patent-assertion | References assertions made regarding patents associated with a component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents. |
| citation | A reference to external citations applicable to the object identified by this BOM entry or the BOM itself. When used with a BOM-Link, this allows offloading citations into a separate CycloneDX BOM. |
| other | Use this if no other types accurately describe the purpose of the external reference. |
Location: /definitions/patents/[]/externalReferences/[]/hashes
Property: hashes (Optional)
Type: Array
The hashes of the external reference (if applicable). Each item of this array shall be a Hash object.
Location: /definitions/patents/[]/externalReferences/[]/hashes/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| alg | String | Required | The algorithm that generated the hash value. |
| content | String | Required | The value of the hash. |
Location: /definitions/patents/[]/externalReferences/[]/hashes/[]/alg
Type: String (enum)
The algorithm that generated the hash value.
Enumeration of possible values:Location: /definitions/patents/[]/externalReferences/[]/hashes/[]/content
Type: String
Pattern Constraint: ^([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})$
The value of the hash.
3942447fac867ae5cdb3229b658f4d48
Location: /definitions/patents/[]/externalReferences/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /definitions/patents/[]/externalReferences/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /definitions/patents/[]/externalReferences/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /definitions/patents/[]/externalReferences/[]/properties/[]/value
Type: String
The value of the property.
Location: /definitions/patents/[]/bom-ref
Property: bom-ref (Optional)
Type: String
An identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref shall be unique within the BOM. For a patent, it might be a good idea to use a patent number as the BOM reference ID.
Location: /definitions/patents/[]/familyId
Property: familyId (Required)
Type: String
The unique identifier for the patent family, aligned with the id attribute in WIPO ST.96 v8.0's PatentFamilyType. Refer to PatentFamilyType in ST.96.
Location: /definitions/patents/[]/priorityApplication
Property: priorityApplication (Optional)
Type: Object
The priorityApplication contains the essential data necessary to identify and reference an earlier patent filing for priority rights. In line with WIPO ST.96 guidelines, it includes the jurisdiction (office code), application number, and filing date-the three key elements that uniquely specify the priority application in a global patent context.
| Property | Type | Requirement | Description |
|---|---|---|---|
| applicationNumber | String | Required | The unique number assigned to a patent application when it is filed with a patent office. It is used to identify the specific application and track its progress through the examination process. Aligned with ApplicationNumber in ST.96. Refer to ApplicationIdentificationType in ST.96. |
| jurisdiction | String | Required | The jurisdiction or patent office where the priority application was filed, specified using WIPO ST.3 codes. Aligned with IPOfficeCode in ST.96. Refer to IPOfficeCode in ST.96. |
| filingDate | String | Required | The date the priority application was filed, aligned with FilingDate in ST.96. Refer to FilingDate in ST.96. |
Location: /definitions/patents/[]/priorityApplication/applicationNumber
Property: applicationNumber (Required)
Type: String
Pattern Constraint: ^[A-Za-z0-9][A-Za-z0-9\-/.()\s]{0,28}[A-Za-z0-9]$
The unique number assigned to a patent application when it is filed with a patent office. It is used to identify the specific application and track its progress through the examination process. Aligned with ApplicationNumber in ST.96. Refer to ApplicationIdentificationType in ST.96.
US20240000123
EP23123456
Location: /definitions/patents/[]/priorityApplication/jurisdiction
Property: jurisdiction (Required)
Type: String
Pattern Constraint: ^[A-Z]{2}$
The jurisdiction or patent office where the priority application was filed, specified using WIPO ST.3 codes. Aligned with IPOfficeCode in ST.96. Refer to IPOfficeCode in ST.96.
US
EP
JP
Location: /definitions/patents/[]/priorityApplication/filingDate
Property: filingDate (Required)
Type: String
Format: date as specified in RFC 3339 section 5.6
The date the priority application was filed, aligned with FilingDate in ST.96. Refer to FilingDate in ST.96.
Location: /definitions/patents/[]/members
Property: members (Optional)
Type: Array (of String)
A collection of patents or applications that belong to this family, each identified by a bom-ref pointing to a patent object defined elsewhere in the BOM. A bom-ref linking to a patent or application object within the BOM. Each item of this array shall be a string.
Location: /definitions/patents/[]/externalReferences
Property: externalReferences (Optional)
Type: Array
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM. Each item of this array shall be an External Reference object.
Location: /definitions/patents/[]/externalReferences/[]
Type: Object
External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
| Property | Type | Requirement | Description |
|---|---|---|---|
| url | Array | Required | The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs. |
| comment | String | Optional | A comment describing the external reference. |
| type | String | Required | Specifies the type of external reference. |
| hashes | Array | Optional | The hashes of the external reference (if applicable). |
| properties | Array | Optional | 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. |
Location: /definitions/patents/[]/externalReferences/[]/url
The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https (RFC-7230), mailto (RFC-2368), tel (RFC-3966), and dns (RFC-4501). External references may also include formally registered URNs such as CycloneDX BOM-Link to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.
Shall be any of:
Type: String
Format: iri-reference as specified in RFC 3987
Type: Object
Location: /definitions/patents/[]/externalReferences/[]/comment
Type: String
A comment describing the external reference
Location: /definitions/patents/[]/externalReferences/[]/type
Type: String (enum)
Specifies the type of external reference.
| Value | 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 licence file. If a licence URL has been defined in the licence 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 the formulation of any referencable object within the BOM, including components, services, metadata, declarations, or the BOM itself. |
| 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) |
| patent | References information about patents which may be defined in human-readable documents or in machine-readable formats such as CycloneDX or ST.96. For detailed patent information or to reference the information provided directly by patent offices, it is recommended to leverage standards from the World Intellectual Property Organization (WIPO) such as ST.96. |
| patent-family | References information about a patent family which may be defined in human-readable documents or in machine-readable formats such as CycloneDX or ST.96. A patent family is a group of related patent applications or granted patents that cover the same or similar invention. For detailed patent family information or to reference the information provided directly by patent offices, it is recommended to leverage standards from the World Intellectual Property Organization (WIPO) such as ST.96. |
| patent-assertion | References assertions made regarding patents associated with a component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents. |
| citation | A reference to external citations applicable to the object identified by this BOM entry or the BOM itself. When used with a BOM-Link, this allows offloading citations into a separate CycloneDX BOM. |
| other | Use this if no other types accurately describe the purpose of the external reference. |
Location: /definitions/patents/[]/externalReferences/[]/hashes
Property: hashes (Optional)
Type: Array
The hashes of the external reference (if applicable). Each item of this array shall be a Hash object.
Location: /definitions/patents/[]/externalReferences/[]/hashes/[]
Type: Object
| Property | Type | Requirement | Description |
|---|---|---|---|
| alg | String | Required | The algorithm that generated the hash value. |
| content | String | Required | The value of the hash. |
Location: /definitions/patents/[]/externalReferences/[]/hashes/[]/alg
Type: String (enum)
The algorithm that generated the hash value.
Enumeration of possible values:Location: /definitions/patents/[]/externalReferences/[]/hashes/[]/content
Type: String
Pattern Constraint: ^([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})$
The value of the hash.
3942447fac867ae5cdb3229b658f4d48
Location: /definitions/patents/[]/externalReferences/[]/properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /definitions/patents/[]/externalReferences/[]/properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /definitions/patents/[]/externalReferences/[]/properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /definitions/patents/[]/externalReferences/[]/properties/[]/value
Type: String
The value of the property.
Location: /citations
Property: citations (Optional)
Type: Array
Uniqueness: All items shall be unique.
A collection of attributions indicating which entity supplied information for specific fields within the BOM. Each item of this array shall be a Citation object.
Location: /citations/[]
Type: Object
Details a specific attribution of data within the BOM to a contributing entity or process.
| Property | Type | Requirement | Description |
|---|---|---|---|
| bom-ref | String | Optional | Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links. |
| pointers | Array | Optional | One or more JSON Pointers identifying the BOM fields to which the attribution applies. Exactly one of the "pointers" or "expressions" elements shall be present. |
| expressions | Array | Optional | One or more path expressions used to locate values within a BOM. Exactly one of the "pointers" or "expressions" elements shall be present. |
| timestamp | String | Required | The date and time when the attribution was made or the information was supplied. |
| attributedTo | String | Optional | The bom-ref of an object, such as a component, service, tool, organisational entity, or person that supplied the cited information. At least one of the "attributedTo" or "process" elements shall be present. |
| process | String | Optional | The bom-ref to a process (such as a formula, workflow, task, or step) defined in the formulation section that executed or generated the attributed data. At least one of the "attributedTo" or "process" elements shall be present. |
| note | String | Optional | A description or comment about the context or quality of the data attribution. |
| signature | Array | Optional | A digital signature verifying the authenticity or integrity of the attribution. |
Location: /citations/[]/bom-ref
Type: String
Identifier for referable and therefore interlinkable elements. Value should not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.
Location: /citations/[]/pointers
Property: pointers (Optional)
Type: Array (of String)
One or more JSON Pointers identifying the BOM fields to which the attribution applies. Exactly one of the "pointers" or "expressions" elements shall be present. A JSON Pointer identifying the BOM field to which the attribution applies. Users of other serialization formats (e.g. XML) shall use the JSON Pointer format to ensure consistent field referencing across representations. Each item of this array shall be a string.
Location: /citations/[]/expressions
Property: expressions (Optional)
Type: Array (of String)
One or more path expressions used to locate values within a BOM. Exactly one of the "pointers" or "expressions" elements shall be present. Specifies a path expression used to locate a value within a BOM. The expression syntax shall conform to the format of the BOM's serialization. Use JSONPath for JSON, XPath for XML, and default to JSONPath for Protocol Buffers unless otherwise specified. Implementers shall ensure the expression is valid within the context of the applicable serialization format. Each item of this array shall be a string.
Location: /citations/[]/timestamp
Type: String
Format: data-time as specified in RFC 3339 section 5.6
The date and time when the attribution was made or the information was supplied.
Location: /citations/[]/attributedTo
Type: String
The bom-ref of an object, such as a component, service, tool, organisational entity, or person that supplied the cited information. At least one of the "attributedTo" or "process" elements shall be present.
Location: /citations/[]/process
Type: String
The bom-ref to a process (such as a formula, workflow, task, or step) defined in the formulation section that executed or generated the attributed data. At least one of the "attributedTo" or "process" elements shall be present.
Location: /citations/[]/note
Type: String
A description or comment about the context or quality of the data attribution.
Location: /citations/[]/signature
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.
Location: /properties
Property: properties (Optional)
Type: Array
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. Each item of this array shall be a Lightweight name-value pair object.
Location: /properties/[]
Type: Object
Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional.
| Property | Type | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of the property. Duplicate names are allowed, each potentially having a different value. |
| value | String | Optional | The value of the property. |
Location: /properties/[]/name
Type: String
The name of the property. Duplicate names are allowed, each potentially having a different value.
Location: /properties/[]/value
Type: String
The value of the property.
Location: /signature
Property: signature (Optional)
Type: Object
An enveloped digital signature embedded within and specific to this object within the BOM. CycloneDX signatures enable integrity and authenticity verification without separating the signature from the BOM. Enveloped signatures enable each party in the supply chain to take responsibility for and sign their specific data, ensuring its integrity and authenticity. By aggregating all signatures, stakeholders can independently verify discrete pieces of information from each provider, enhancing overall transparency and trust in the supply chain.