package cyclonedx.v1_6

Get desktop application:
View/edit binary Protocol Buffers messages

Title and location where advisory information can be obtained. An advisory is a notification of a threat to a component, service, or system.

Used in: Vulnerability

optional string title = 1
An optional name of the advisory.
string url = 2
Location where the advisory can be obtained.

Used in: Composition

AGGREGATE_NOT_SPECIFIED = 0
The relationship completeness is not specified. buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `not specified` is our fallback, doubling `unspecified`
AGGREGATE_COMPLETE = 1
The relationship is complete. No further relationships including constituent components, services, or dependencies are known to exist.
AGGREGATE_INCOMPLETE = 2
The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies.
AGGREGATE_INCOMPLETE_FIRST_PARTY_ONLY = 3
The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented.
AGGREGATE_INCOMPLETE_THIRD_PARTY_ONLY = 4
The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented.
AGGREGATE_UNKNOWN = 5
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.
AGGREGATE_INCOMPLETE_FIRST_PARTY_PROPRIETARY_ONLY = 6
The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.
AGGREGATE_INCOMPLETE_FIRST_PARTY_OPENSOURCE_ONLY = 7
The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are opensource.
AGGREGATE_INCOMPLETE_THIRD_PARTY_PROPRIETARY_ONLY = 8
The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.
AGGREGATE_INCOMPLETE_THIRD_PARTY_OPENSOURCE_ONLY = 9
The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource.

Used in: Bom

optional string bom_ref = 1
An optional identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref must be unique within the BOM.
repeated string subjects = 2
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.
optional AnnotatorChoice annotator = 3
The organization, person, component, or service which created the textual content of the annotation.
optional google.protobuf.Timestamp timestamp = 4
The date and time (timestamp) when the annotation was created.
string text = 5
The textual content of the annotation.

Used in: Annotation

oneof choice
- OrganizationalEntity organization = 1
  The organization that created the annotation
- OrganizationalContact individual = 2
  The person that created the annotation
- Component component = 3
  The tool or component that created the annotation
- Service service = 4
  The service that created the annotation

Specifies attributes of the text

Used in: ComponentData.ComponentDataContents, Declarations.Evidence.Data.Contents, Diff, Event, GraphicsCollection.Graphic, InputType, License, Note, OutputType, ProofOfConcept, Swid

optional string content_type = 1
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](https://www.ietf.org/rfc/rfc2045.html#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](https://www.iana.org/assignments/media-types/media-types.xhtml).
optional string encoding = 2
Specifies the optional encoding the text is represented in
string value = 3
SimpleContent value of element. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.

string spec_version = 1
The version of the CycloneDX specification a BOM is written to (starting at version 1.3)
optional int32 version = 2
The version allows component publishers/authors to make changes to existing BOMs to update various aspects of the document such as description or licenses. When a system is presented with multiple BOMs for the same component, the system should use the most recent version of the BOM. The default version is '1' and should be incremented for each version of the BOM that is published. Each version of a component should have a unique BOM and if no changes are made to the BOMs, then each BOM will have a version of '1'.
optional string serial_number = 3
Every BOM generated should have a unique serial number, even if the contents of the BOM being generated have not changed over time. The process or tool responsible for creating the BOM should create random UUID's for every BOM generated.
optional Metadata metadata = 4
Provides additional information about a BOM.
repeated Component components = 5
Provides the ability to document a list of components.
repeated Service services = 6
Provides the ability to document a list of external services.
repeated ExternalReference external_references = 7
Provides the ability to document external references related to the BOM or to the project the BOM describes.
repeated Dependency dependencies = 8
Provides the ability to document dependency relationships.
repeated Composition compositions = 9
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.
repeated Vulnerability vulnerabilities = 10
Vulnerabilities identified in components or services.
repeated Annotation annotations = 11
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 opinion or commentary from various stakeholders.
repeated Property properties = 12
Specifies optional, custom, properties
repeated Formula formulation = 13
Describes how a component or service was manufactured or deployed. This is achieved through the use of formulas, workflows, tasks, and steps, which declare the precise steps to reproduce along with the observed formulas describing the steps which transpired in the manufacturing process.
repeated Declarations declarations = 14
The list of declarations which describe the conformance to standards. Each declaration may include attestations, claims, and evidence.
repeated Definition definitions = 15
A collection of reusable objects that are defined and may be used elsewhere in the BOM.

A measure of carbon dioxide (CO2).

Used in: ModelCard.ModelCardConsiderations.EnergyConsumption

float value = 1
Quantity of carbon dioxide (CO2).
CO2MeasureType.CO2MeasureUnitType unit = 2
Unit of carbon dioxide (CO2).

Used in: CO2MeasureType

CO2_MEASURE_UNIT_TYPE_UNSPECIFIED = 0
Default
CO2_MEASURE_UNIT_TYPE_TONNES_CO2_EQUIVALENT = 1
Tonnes (t) of carbon dioxide (CO2) equivalent (eq) (the default unit).

Used in: Evidence

repeated Callstack.Frames frames = 1
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 program execution and manages the sequence of function invocations.

Used in: Callstack

optional string package = 1
A package organizes modules into namespaces, providing a unique namespace for each type it contains.
string module = 2
A module or class that encloses functions/methods and other code.
optional string function = 3
A block of code designed to perform a particular task.
repeated string parameters = 4
Optional arguments that are passed to the module or function.
optional int32 line = 5
The line number the code that is called resides on.
optional int32 column = 6
The column the code that is called resides.
optional string fullFilename = 7
The full path and filename of the module.

Used in: Component

CLASSIFICATION_NULL = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
CLASSIFICATION_APPLICATION = 1
A software application. Refer to https://en.wikipedia.org/wiki/Application_software for information about applications.
CLASSIFICATION_FRAMEWORK = 2
A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework for information on how frameworks vary slightly from libraries.
CLASSIFICATION_LIBRARY = 3
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.
CLASSIFICATION_OPERATING_SYSTEM = 4
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
CLASSIFICATION_DEVICE = 5
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: https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md
CLASSIFICATION_FILE = 6
A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file for information about files.
CLASSIFICATION_CONTAINER = 7
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
CLASSIFICATION_FIRMWARE = 8
A special type of software that provides low-level control over a devices hardware. Refer to https://en.wikipedia.org/wiki/Firmware
CLASSIFICATION_DEVICE_DRIVER = 9
A special type of software that operates or controls a particular type of device. Refer to https://en.wikipedia.org/wiki/Device_driver
CLASSIFICATION_PLATFORM = 10
A runtime environment which interprets or executes software. This may include runtimes such as those that execute bytecode or low-code/no-code application platforms.
CLASSIFICATION_MACHINE_LEARNING_MODEL = 11
A model based on training data that can make predictions or decisions without being explicitly programmed to do so.
CLASSIFICATION_DATA = 12
A collection of discrete values that convey information.
CLASSIFICATION_CRYPTOGRAPHIC_ASSET = 13
A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets.

Used in: Step

optional string executed = 1
A text representation of the executed command.
repeated Property properties = 2
Domain-specific command properties.

Used in: Pedigree

optional string uid = 1
A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
optional string url = 2
The URL to the commit. This URL will typically point to a commit in a version control system.
optional IdentifiableAction author = 3
The author who created the changes in the commit
optional IdentifiableAction committer = 4
The person who committed or pushed the commit
optional string message = 5
The text description of the contents of the commit

Used in: AnnotatorChoice, Bom, Declarations.Targets, Formula, Metadata, Pedigree, Tool

Classification type = 1
Specifies the type of component. For software components, classify as an application if no more specific appropriate classification is available or cannot be determined for the component.
optional string mime_type = 2
The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented, such as an image, font, or executable. Some library or framework components may also have an associated mime-type.
optional string bom_ref = 3
An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional OrganizationalEntity supplier = 4
The organization that supplied the component. The supplier may often be the manufacturer but may also be a distributor or repackager.
optional string author = 5
DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.authors` or `.manufacturer` instead. The person(s) or organization(s) that authored the component
optional string publisher = 6
The person(s) or organization(s) that published the component
optional string group = 7
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.
string name = 8
The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery
string version = 9
The component version. The version should ideally comply with semantic versioning but is not enforced. Version was made optional in v1.4 of the spec. For backward compatibility, it is recommended to use an empty string to represent components without version information.
optional string description = 10
Specifies a description for the component
optional Scope scope = 11
Specifies the scope of the component. If a scope is not specified, SCOPE_REQUIRED scope should be assumed by the consumer of the BOM
repeated Hash hashes = 12
The hashes of the component.
repeated LicenseChoice licenses = 13
EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
optional string copyright = 14
An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.
optional string cpe = 15
DEPRECATED - DO NOT USE. This will be removed in a future version. Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe
optional string purl = 16
Specifies the package-url (PURL). The purl, if specified, must be valid and conform to the specification defined at: https://github.com/package-url/purl-spec
optional Swid swid = 17
Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.
optional bool modified = 18
DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating is the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original.
optional Pedigree pedigree = 19
Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc.
repeated ExternalReference external_references = 20
Provides the ability to document external references related to the component or to the project the component describes.
repeated Component components = 21
Specifies optional sub-components. 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.
repeated Property properties = 22
Specifies optional, custom, properties
optional Evidence evidence = 23
Specifies optional license and copyright evidence.
optional ReleaseNotes releaseNotes = 24
Specifies optional release notes.
optional ModelCard modelCard = 25
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.
repeated ComponentData data = 26
This object SHOULD be specified for any component of type `data` and must not be specified for other component types.
optional CryptoProperties cryptoProperties = 27
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) is 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.
optional OrganizationalEntity manufacturer = 28
The organization that created the component. Manufacturer is common in components created through automated processes. Components created through manual means may have `.authors` instead.
repeated OrganizationalContact authors = 29
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.
repeated string tags = 30
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. Examples include "json-parser", "object-persistence", "text-to-image", "translation", and "object-detection".
repeated string omniborId = 31
Specifies the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform to the specification defined at: https://www.iana.org/assignments/uri-schemes/prov/gitoid
repeated string swhid = 32
Specifies the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must be valid and conform to the specification defined at: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html

Used in: Component, ModelCard.ModelParameters.Datasets

optional string bom_ref = 1
An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.
ComponentDataType type = 2
The general theme or subject matter of the data being specified.
optional string name = 3
The name of the dataset.
optional ComponentData.ComponentDataContents contents = 4
The contents or references to the contents of the data being described.
optional string classification = 5
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
repeated string sensitiveData = 6
A description of any sensitive data in a dataset.
optional GraphicsCollection graphics = 7
A collection of graphics that represent various measurements.
optional string description = 8
A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.
optional DataGovernance governance = 9
Data Governance

Used in: ComponentData

optional AttachedText attachment = 1
An optional way to include textual or encoded data.
optional string url = 2
The URL to where the data can be retrieved.
repeated Property properties = 3
Provides the ability to document name-value parameters used for configuration.

Used in: ComponentData

COMPONENT_DATA_TYPE_SOURCE_CODE = 0
Any type of code, code snippet, or data-as-code buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error, it shall be fixed with v2.0 of this very schema
COMPONENT_DATA_TYPE_CONFIGURATION = 1
Parameters or settings that may be used by other components.
COMPONENT_DATA_TYPE_DATASET = 2
A collection of data.
COMPONENT_DATA_TYPE_DEFINITION = 3
Data that can be used to create new instances of what the definition defines.
COMPONENT_DATA_TYPE_OTHER = 4
Any other type of data that does not fit into existing definitions.

Used in: Bom

Aggregate aggregate = 1
Indicates the aggregate completeness
repeated string assemblies = 2
The assemblies the aggregate completeness applies to
repeated string dependencies = 3
The dependencies the aggregate completeness applies to
repeated string vulnerabilities = 4
The bom-ref identifiers of the vulnerabilities being described.
optional string bom_ref = 5
An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref must be unique within the BOM.

A condition that was used to determine a trigger should be activated.

Used in: Trigger

optional string description = 1
Describes the set of conditions which cause the trigger to activate.
optional string expression = 2
The logical expression that was evaluated that determined the trigger should be fired.
repeated Property properties = 3
Domain-specific condition instance properties.

"Cryptographic Properties

Used in: Component

CryptoProperties.CryptoAssetType assetType = 1
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.
optional CryptoProperties.AlgorithmProperties algorithmProperties = 2
Additional properties specific to a cryptographic algorithm.
optional CryptoProperties.CertificateProperties certificateProperties = 3
Properties for cryptographic assets of asset type 'certificate'
optional CryptoProperties.RelatedCryptoMaterialProperties relatedCryptoMaterialProperties = 4
Properties for cryptographic assets of asset type: `related-crypto-material`
optional CryptoProperties.ProtocolProperties protocolProperties = 5
Properties specific to cryptographic assets of type: `protocol`.
optional string oid = 6
The object identifier (OID) of the cryptographic asset.

Algorithm Propertie

Used in: CryptoProperties

optional AlgorithmProperties.CryptoPrimitive primitive = 1
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).
optional string parameterSetIdentifier = 2
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).
optional string curve = 3
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 use of curve names as defined at [https://neuromancer.sk/std/](https://neuromancer.sk/std/), the source from which can be found at [https://github.com/J08nY/std-curves](https://github.com/J08nY/std-curves).
optional AlgorithmProperties.CryptoExecutionEnvironment executionEnvironment = 4
The target and execution environment in which the algorithm is implemented in.
optional AlgorithmProperties.CryptoImplementationPlatform implementationPlatform = 5
The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform.
repeated string certificationLevel = 6
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).
optional AlgorithmProperties.CryptoAlgorithmMode mode = 7
The mode of operation in which the cryptographic algorithm (block cipher) is used.
optional AlgorithmProperties.CryptoAlgorithmPadding padding = 8
The padding scheme that is used for the cryptographic algorithm.
repeated AlgorithmProperties.CryptoAlgorithmFunction cryptoFunctions = 9
The cryptographic functions implemented by the cryptographic algorithm.
optional int32 classicalSecurityLevel = 10
The classical security level that a cryptographic algorithm provides (in bits).
optional int32 nistQuantumSecurityLevel = 11
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.

Cryptographic functions

Used in: AlgorithmProperties

CRYPTO_ALGORITHM_FUNCTION_UNSPECIFIED = 0
ProtoBuff's default value -- it differs from "unknown"
CRYPTO_ALGORITHM_FUNCTION_UNKNOWN = 1
meaning "there is some, but it is unclear which one"
CRYPTO_ALGORITHM_FUNCTION_OTHER = 2
none of the following
CRYPTO_ALGORITHM_FUNCTION_GENERATE = 3
CRYPTO_ALGORITHM_FUNCTION_KEYGEN = 4
CRYPTO_ALGORITHM_FUNCTION_ENCRYPT = 5
CRYPTO_ALGORITHM_FUNCTION_DECRYPT = 6
CRYPTO_ALGORITHM_FUNCTION_DIGEST = 7
CRYPTO_ALGORITHM_FUNCTION_TAG = 8
CRYPTO_ALGORITHM_FUNCTION_KEYDERIVE = 9
CRYPTO_ALGORITHM_FUNCTION_SIGN = 10
CRYPTO_ALGORITHM_FUNCTION_VERIFY = 11
CRYPTO_ALGORITHM_FUNCTION_ENCAPSULATE = 12
CRYPTO_ALGORITHM_FUNCTION_DECAPSULATE = 13

Mode

Used in: AlgorithmProperties

CRYPTO_ALGORITHM_MODE_UNSPECIFIED = 0
ProtoBuff's default value -- it differs from "unknown"
CRYPTO_ALGORITHM_MODE_UNKNOWN = 1
The mode of operation is not known
CRYPTO_ALGORITHM_MODE_OTHER = 2
Another mode of operation - none of the following
CRYPTO_ALGORITHM_MODE_CBC = 3
Cipher block chaining
CRYPTO_ALGORITHM_MODE_ECB = 4
Electronic codebook
CRYPTO_ALGORITHM_MODE_CCM = 5
Counter with cipher block chaining message authentication code
CRYPTO_ALGORITHM_MODE_GCM = 6
Galois/counter
CRYPTO_ALGORITHM_MODE_CFB = 7
Cipher feedback
CRYPTO_ALGORITHM_MODE_OFB = 8
Output feedback
CRYPTO_ALGORITHM_MODE_CTR = 9
Counter

Padding

Used in: AlgorithmProperties

CRYPTO_ALGORITHM_PADDING_UNSPECIFIED = 0
ProtoBuff's default value -- it differs from "unknown"
CRYPTO_ALGORITHM_PADDING_UNKNOWN = 1
The padding scheme is not known
CRYPTO_ALGORITHM_PADDING_OTHER = 2
Another padding scheme - none of the following
CRYPTO_ALGORITHM_PADDING_PKCS5 = 3
Public Key Cryptography Standard: Password-Based Cryptography
CRYPTO_ALGORITHM_PADDING_PKCS7 = 4
Public Key Cryptography Standard: Cryptographic Message Syntax
CRYPTO_ALGORITHM_PADDING_PKCS1V15 = 5
Public Key Cryptography Standard: RSA Cryptography v1.5
CRYPTO_ALGORITHM_PADDING_OAEP = 6
Optimal asymmetric encryption padding
CRYPTO_ALGORITHM_PADDING_RAW = 7
Raw

Execution Environment

Used in: AlgorithmProperties

CRYPTO_EXECUTION_ENVIRONMENT_UNSPECIFIED = 0
ProtoBuff's default value -- it differs from "unknown"
CRYPTO_EXECUTION_ENVIRONMENT_UNKNOWN = 1
The execution environment is not known
CRYPTO_EXECUTION_ENVIRONMENT_OTHER = 2
Another implementation environment - none of the following
CRYPTO_EXECUTION_ENVIRONMENT_SOFTWARE_PLAIN_RAM = 3
A software implementation running in plain unencrypted RAM.
CRYPTO_EXECUTION_ENVIRONMENT_SOFTWARE_ENCRYPTED_RAM = 4
A software implementation running in encrypted RAM.
CRYPTO_EXECUTION_ENVIRONMENT_SOFTWARE_TEE = 5
A software implementation running in a trusted execution environment.
CRYPTO_EXECUTION_ENVIRONMENT_HARDWARE = 6
A hardware implementation.

Implementation platform

Used in: AlgorithmProperties

CRYPTO_IMPLEMENTATION_PLATFORM_UNSPECIFIED = 0
ProtoBuff's default value -- it differs from "unknown"
CRYPTO_IMPLEMENTATION_PLATFORM_UNKNOWN = 1
the platform is not known
CRYPTO_IMPLEMENTATION_PLATFORM_OTHER = 2
none of the following
CRYPTO_IMPLEMENTATION_PLATFORM_GENERIC = 3
CRYPTO_IMPLEMENTATION_PLATFORM_X86_32 = 4
CRYPTO_IMPLEMENTATION_PLATFORM_X86_64 = 5
CRYPTO_IMPLEMENTATION_PLATFORM_ARMV7A = 6
CRYPTO_IMPLEMENTATION_PLATFORM_ARMV7M = 7
CRYPTO_IMPLEMENTATION_PLATFORM_ARMV8A = 8
CRYPTO_IMPLEMENTATION_PLATFORM_ARMV8M = 9
CRYPTO_IMPLEMENTATION_PLATFORM_ARMV9A = 10
CRYPTO_IMPLEMENTATION_PLATFORM_ARMV9M = 11
CRYPTO_IMPLEMENTATION_PLATFORM_X390X = 12
CRYPTO_IMPLEMENTATION_PLATFORM_PPC64 = 13
CRYPTO_IMPLEMENTATION_PLATFORM_PPC64LE = 14

Primitive

Used in: AlgorithmProperties

CRYPTO_PRIMITIVE_UNSPECIFIED = 0
ProtoBuff's default value -- it differs from "unknown"
CRYPTO_PRIMITIVE_UNKNOWN = 1
The primitive is not known
CRYPTO_PRIMITIVE_OTHER = 2
Another primitive type - none of the following
CRYPTO_PRIMITIVE_DRBG = 3
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.
CRYPTO_PRIMITIVE_MAC = 4
In cryptography, a Message Authentication Code (MAC) is information used for authenticating and integrity-checking a message.
CRYPTO_PRIMITIVE_BLOCK_CIPHER = 5
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.
CRYPTO_PRIMITIVE_STREAM_CIPHER = 6
A stream cipher is a symmetric key cipher where plaintext digits are combined with a pseudorandom cipher digit stream (keystream).
CRYPTO_PRIMITIVE_SIGNATURE = 7
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.
CRYPTO_PRIMITIVE_HASH = 8
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.
CRYPTO_PRIMITIVE_PKE = 9
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.
CRYPTO_PRIMITIVE_XOF = 10
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.
CRYPTO_PRIMITIVE_KDF = 11
A Key Derivation Function (KDF) derives key material from another source of entropy while preserving the entropy of the input.
CRYPTO_PRIMITIVE_KEY_AGREE = 12
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.
CRYPTO_PRIMITIVE_KEM = 13
A Key Encapsulation Mechanism (KEM) algorithm is a mechanism for transporting random keying material to a recipient using the recipient's public key.
CRYPTO_PRIMITIVE_AE = 14
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.
CRYPTO_PRIMITIVE_COMBINER = 15
A combiner aggregates many candidates for a cryptographic primitive and generates a new candidate for the same primitive.

Certificate Properties

Used in: CryptoProperties

optional string subjectName = 1
The subject name for the certificate
optional string issuerName = 2
The issuer name for the certificate
optional google.protobuf.Timestamp notValidBefore = 3
The date and time according to ISO-8601 standard from which the certificate is valid
optional google.protobuf.Timestamp notValidAfter = 4
The date and time according to ISO-8601 standard from which the certificate is not valid anymore
optional string signatureAlgorithmRef = 5
The bom-ref to signature algorithm used by the certificate
optional string subjectPublicKeyRef = 6
The bom-ref to the public key of the subject
optional string certificateFormat = 7
The format of the certificate. Examples include X.509, PEM, DER, and CVC.
optional string certificateExtension = 8
The file extension of the certificate. Examples include crt, pem, cer, der, and p12.

Asset Type

Used in: CryptoProperties

CRYPTO_ASSET_TYPE_UNSPECIFIED = 0
ProtoBuff's default value
CRYPTO_ASSET_TYPE_ALGORITHM = 1
Mathematical function commonly used for data encryption, authentication, and digital signatures.
CRYPTO_ASSET_TYPE_CERTIFICATE = 2
An electronic document that is used to provide the identity or validate a public key.
CRYPTO_ASSET_TYPE_PROTOCOL = 3
A set of rules and guidelines that govern the behavior and communication with each other.
CRYPTO_ASSET_TYPE_RELATED_CRYPTO_MATERIAL = 4
Other cryptographic assets related to algorithms, certificates, and protocols such as keys and tokens.

Protocol Properties

Used in: CryptoProperties

optional ProtocolProperties.CryptoProtocolType type = 1
The concrete protocol type.
optional string version = 2
The version of the protocol. Examples include 1.0, 1.2, and 1.99.
repeated ProtocolProperties.CryptoProtocolCipherSuite cipherSuites = 3
A list of cipher suites related to the protocol.
optional ProtocolProperties.Ikev2TransformTypes ikev2TransformTypes = 4
The IKEv2 transform types supported (types 1-4), defined in RFC7296 section 3.3.2, and additional properties.
repeated string cryptoRef = 5
The bom-ref(s) to protocol-related cryptographic assets

Object representing a cipher suite

Used in: ProtocolProperties

optional string name = 1
A common name for the cipher suite. For example: TLS_DHE_RSA_WITH_AES_128_CCM
repeated string algorithms = 2
A list of algorithms related to the cipher suite. Use the bom-ref to the algorithm cryptographic asset.
repeated string identifiers = 3
A list of common identifiers for the cipher suite. For example: 0xC0 and 0x9E

Used in: ProtocolProperties

CRYPTO_PROTOCOL_TYPE_UNSPECIFIED = 0
ProtoBuff's default value -- it differs from "unknown"
CRYPTO_PROTOCOL_TYPE_UNKNOWN = 1
The protocol type is not known
CRYPTO_PROTOCOL_TYPE_OTHER = 2
Another protocol type - none of the following
CRYPTO_PROTOCOL_TYPE_TLS = 3
Transport Layer Security
CRYPTO_PROTOCOL_TYPE_SSH = 4
Secure Shell
CRYPTO_PROTOCOL_TYPE_IPSEC = 5
Internet Protocol Security
CRYPTO_PROTOCOL_TYPE_IKE = 6
Internet Key Exchange
CRYPTO_PROTOCOL_TYPE_SSTP = 7
Secure Socket Tunneling Protocol
CRYPTO_PROTOCOL_TYPE_WPA = 8
Wi-Fi Protected Access

IKEv2 Transform Types

Used in: ProtocolProperties

repeated string encr = 1
Transform Type 1: encryption algorithms
repeated string prf = 2
Transform Type 2: pseudorandom functions
repeated string integ = 3
Transform Type 3: integrity algorithms
repeated string ke = 4
Transform Type 4: Key Exchange Method (KE) per RFC9370, formerly called Diffie-Hellman Group (D-H)
optional bool esn = 5
Specifies if an Extended Sequence Number (ESN) is used.
repeated string auth = 6
IKEv2 Authentication method

Related Cryptographic Material Properties

Used in: CryptoProperties

optional RelatedCryptoMaterialProperties.CryptoRelatedType type = 1
The type for the related cryptographic material
optional string id = 2
The optional unique identifier for the related cryptographic material.
optional RelatedCryptoMaterialProperties.CryptoRelatedState state = 3
The key state as defined by NIST SP 800-57.
optional string algorithmRef = 4
The bom-ref to the algorithm used to generate the related cryptographic material.
optional google.protobuf.Timestamp creationDate = 5
The date and time (timestamp) when the related cryptographic material was created.
optional google.protobuf.Timestamp activationDate = 6
The date and time (timestamp) when the related cryptographic material was activated.
optional google.protobuf.Timestamp updateDate = 7
The date and time (timestamp) when the related cryptographic material was updated.
optional google.protobuf.Timestamp expirationDate = 8
The date and time (timestamp) when the related cryptographic material expires.
optional string value = 9
The associated value of the cryptographic material.
optional int64 size = 10
The size of the cryptographic asset (in bits).
optional string format = 11
The format of the related cryptographic material (e.g. P8, PEM, DER).
optional RelatedCryptoMaterialProperties.CryptoRelatedSecuredBy securedBy = 12
The mechanism by which the cryptographic asset is secured.

Secured By

optional string mechanism = 1
Specifies the mechanism by which the cryptographic asset is secured. Examples include HSM, TPM, SGX, Software, and None
optional string algorithmRef = 2
The bom-ref to the algorithm.

State

CRYPTO_RELATED_STATE_UNSPECIFIED = 0
Default
CRYPTO_RELATED_STATE_PRE_ACTIVATION = 1
CRYPTO_RELATED_STATE_ACTIVE = 2
CRYPTO_RELATED_STATE_SUSPENDED = 3
CRYPTO_RELATED_STATE_DEACTIVATED = 4
CRYPTO_RELATED_STATE_COMPROMISED = 5
CRYPTO_RELATED_STATE_DESTROYED = 6

relatedCryptoMaterialType

CRYPTO_RELATED_TYPE_UNSPECIFIED = 0
ProtoBuff's default value -- it differs from "unknown"
CRYPTO_RELATED_TYPE_UNKNOWN = 1
The type of cryptographic asset is not known.
CRYPTO_RELATED_TYPE_OTHER = 2
Another type of cryptographic asset - none of the following
CRYPTO_RELATED_TYPE_PRIVATE_KEY = 3
CRYPTO_RELATED_TYPE_PUBLIC_KEY = 4
CRYPTO_RELATED_TYPE_SECRET_KEY = 5
CRYPTO_RELATED_TYPE_KEY = 6
CRYPTO_RELATED_TYPE_CIPHERTEXT = 7
CRYPTO_RELATED_TYPE_SIGNATURE = 8
CRYPTO_RELATED_TYPE_DIGEST = 9
CRYPTO_RELATED_TYPE_INITIALIZATION_VECTOR = 10
CRYPTO_RELATED_TYPE_NONCE = 11
CRYPTO_RELATED_TYPE_SEED = 12
CRYPTO_RELATED_TYPE_SALT = 13
CRYPTO_RELATED_TYPE_SHARED_SECRET = 14
CRYPTO_RELATED_TYPE_TAG = 15
CRYPTO_RELATED_TYPE_ADDITIONAL_DATA = 16
CRYPTO_RELATED_TYPE_PASSWORD = 17
CRYPTO_RELATED_TYPE_CREDENTIAL = 18
CRYPTO_RELATED_TYPE_TOKEN = 19

Specifies the data flow.

Used in: Service

DataFlowDirection flow = 1
Specifies the flow direction of the data.
string value = 2
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
optional string name = 3
Name for the defined data
optional string description = 4
Short description of the data content and usage
repeated string source = 5
The URI, URL, or BOM-Link of the components or services the data came in from
repeated string destination = 6
The URI, URL, or BOM-Link of the components or services the data is sent to
optional DataGovernance governance = 7
Data Governance

Specifies the flow direction of the data. Valid values are: inbound, outbound, bi-directional, and unknown. 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. buf:lint:ignore ENUM_VALUE_PREFIX -- Enum value names should be prefixed with "DATA_FLOW_DIRECTION_"

Used in: DataFlow

DATA_FLOW_NULL = 0
Default buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
DATA_FLOW_INBOUND = 1
Data that enters a service.
DATA_FLOW_OUTBOUND = 2
Data that exits a service.
DATA_FLOW_BI_DIRECTIONAL = 3
Data flows in and out of the service.
DATA_FLOW_UNKNOWN = 4
The directional flow of data is not known.

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.

Used in: ComponentData, DataFlow, Declarations.Evidence.Data

repeated DataGovernance.DataGovernanceResponsibleParty custodians = 1
Data custodians are responsible for the safe custody, transport, and storage of data.
repeated DataGovernance.DataGovernanceResponsibleParty stewards = 2
Data stewards are responsible for data content, context, and associated business rules.
repeated DataGovernance.DataGovernanceResponsibleParty owners = 3
Data owners are concerned with risk and appropriate access to data.

Used in: DataGovernance

oneof choice
- OrganizationalEntity organization = 1
  The organization that is responsible for specific data governance role(s).
- OrganizationalContact contact = 2
  The individual that is responsible for specific data governance role(s).

The list of declarations which describe the conformance to standards. Each declaration may include attestations, claims, and evidence.

Used in: Bom

repeated Declarations.Assessor assessors = 1
The list of assessors evaluating claims and determining conformance to requirements and confidence in that assessment.
repeated Declarations.Attestation attestations = 2
The list of attestations asserted by an assessor that maps requirements to claims.
repeated Declarations.Claim claims = 3
The list of claims.
repeated Declarations.Evidence evidence = 4
The list of evidence
optional Declarations.Targets targets = 5
The list of targets which claims are made against.
optional Declarations.Affirmation affirmation = 6
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.

Used in: Declarations

optional string statement = 1
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. Example: "I certify, to the best of my knowledge, that all information is correct."
repeated Affirmation.Signatory signatories = 2
The list of signatories authorized on behalf of an organization to assert validity of this document.

Used in: Affirmation

optional string name = 1
The signatory's name.
optional string role = 2
The signatory's role within an organization.
optional OrganizationalEntity organization = 3
The signatory's organization.
optional ExternalReference externalReference = 4
An External reference provides 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.

Used in: Declarations

optional string bom_ref = 1
An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional bool thirdParty = 2
The boolean indicating if the assessor is outside the organization generating claims. A value of false indicates a self assessor.
optional OrganizationalEntity organization = 3
The entity issuing the assessment.

Attestation

Used in: Declarations

optional string summary = 1
The short description explaining the main points of the attestation.
optional string assessor = 2
The `bom-ref` to the assessor asserting the attestation.
repeated Attestation.AttestationMap map = 3
The grouping of requirements to claims and the attestors' declared conformance and confidence thereof.

Map

Used in: Attestation

optional string requirement = 1
The `bom-ref` to the requirement being attested to.
repeated string claims = 2
The list of `bom-ref` to the claims being attested to.
repeated string counterClaims = 3
The list of `bom-ref` to the counter claims being attested to.
optional AttestationMap.AttestationConformance conformance = 4
The conformance of the claim meeting a requirement.
optional AttestationMap.AttestationConfidence confidence = 5
The confidence of the claim meeting the requirement.

Confidence

Used in: AttestationMap

optional double score = 1
The confidence of the claim between and inclusive of 0 and 1, where 1 is 100% confidence.
optional string rationale = 2
The rationale for the confidence score.

Conformance

Used in: AttestationMap

optional double score = 1
The conformance of the claim between and inclusive of 0 and 1, where 1 is 100% conformance.
optional string rationale = 2
The rationale for the conformance score.
repeated string mitigationStrategies = 3
The list of `bom-ref` to the evidence provided describing the mitigation strategies.

Used in: Declarations

optional string bom_ref = 1
An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional string target = 2
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.
optional string predicate = 3
The specific statement or assertion about the target.
repeated string mitigationStrategies = 4
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.
optional string reasoning = 5
The written explanation of why the evidence provided substantiates the claim.
repeated string evidence = 6
The list of `bom-ref` to evidence that supports this claim.
repeated string counterEvidence = 7
The list of `bom-ref` to counterEvidence that supports this claim.
repeated ExternalReference externalReferences = 8
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.

Used in: Declarations

optional string bom_ref = 1
An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional string propertyName = 2
The reference to the property name as defined in the CycloneDX Property Taxonomy: https://github.com/CycloneDX/cyclonedx-property-taxonomy/.
optional string description = 3
The written description of what this evidence is and how it was created.
repeated Evidence.Data data = 4
The output or analysis that supports claims.
optional google.protobuf.Timestamp created = 5
The date and time (timestamp) when the evidence was created.
optional google.protobuf.Timestamp expires = 6
The optional date and time (timestamp) when the evidence is no longer valid.
optional OrganizationalContact author = 7
The author of the evidence.
optional OrganizationalContact reviewer = 8
The reviewer of the evidence.

Used in: Evidence

optional string name = 1
The name of the data.
optional Data.Contents contents = 2
The contents or references to the contents of the data being described.
optional string classification = 3
Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
repeated string sensitiveData = 4
A description of any sensitive data included.
optional DataGovernance governance = 5
Data Governance

Used in: Data

optional AttachedText attachment = 1
An optional way to include textual or encoded data.
optional string url = 2
The URL to where the data can be retrieved.

Used in: Declarations

repeated OrganizationalEntity organizations = 1
The list of organizations which claims are made against.
repeated Component components = 2
The list of components which claims are made against.
repeated Service services = 3
The list of services which claims are made against.

Used in: Bom

repeated Definition.Standard standards = 1
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.

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.

Used in: Definition

optional string bom_ref = 1
An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional string name = 2
The name of the standard. This will often be a shortened, single name of the standard.
optional string version = 3
The version of the standard.
optional string description = 4
The description of the standard.
optional string owner = 5
The owner of the standard, often the entity responsible for its release.
repeated Standard.Requirement requirements = 6
The list of requirements comprising the standard.
repeated Standard.Level levels = 7
The list of levels associated with the standard. Some standards have different levels of compliance.
repeated ExternalReference externalReferences = 8
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.

Used in: Standard

optional string bom_ref = 1
An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional string identifier = 2
The identifier used in the standard to identify a specific level.
optional string title = 3
The title of the level.
optional string description = 4
The description of the level.
repeated string requirements = 5
The list of requirement `bom-ref`s that comprise the level.

Used in: Standard

optional string bom_ref = 1
An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional string identifier = 2
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.
optional string title = 3
The title of the requirement.
optional string text = 4
The textual content of the requirement.
repeated string descriptions = 5
The supplemental text that provides additional guidance or context to the requirement but is not directly part of the requirement.
repeated string openCre = 6
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. The use of CRE promotes clear and unambiguous communication among stakeholders.
optional string parent = 7
The optional `bom-ref` to a parent requirement. This establishes a hierarchy of requirements. Top-level requirements must not define a parent. Only child requirements should define parents.
repeated Property properties = 8
Specifies optional, custom, properties
repeated ExternalReference externalReferences = 9
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.

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 must 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.

Used in: Bom, Task, Workflow

string ref = 1
References a component or service by its bom-ref attribute
repeated Dependency dependencies = 2
The bom-ref identifiers of the components or services that are dependencies of this dependency object.
repeated string provides = 3
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.

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

Used in: Patch

optional AttachedText text = 1
Specifies the optional text of the diff
optional string url = 2
Specifies the URL to the diff

A measure of energy.

Used in: EnergyProviderType, ModelCard.ModelCardConsiderations.EnergyConsumption

float value = 1
Quantity of energy.
EnergyMeasureType.EnergyMeasureUnitType unit = 2
Unit of energy.

Used in: EnergyMeasureType

ENERGY_MEASURE_UNIT_TYPE_UNSPECIFIED = 0
Default
ENERGY_MEASURE_UNIT_TYPE_KILOWATT_HOURS = 1
kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h) (the default unit).

Describes the physical provider of energy used for model development or operations.

Used in: ModelCard.ModelCardConsiderations.EnergyConsumption

optional string bom_ref = 1
BOM unique reference to the energy provider.
string description = 2
A description of the energy provider.
optional OrganizationalEntity organization = 3
The organization of the energy provider.
EnergyProviderType.EnergySourceType energySource = 4
The energy source for the energy provider.
optional EnergyMeasureType energyProvided = 5
The energy provided by the energy source for an associated activity.
repeated ExternalReference external_references = 6
Provides the ability to document external references related to the BOM or to the project the BOM describes.

Used in: EnergyProviderType

ENERGY_SOURCE_TYPE_UNSPECIFIED = 0
Default
ENERGY_SOURCE_TYPE_UNKNOWN = 1
energy source: unknown. The energy source is unknown.
ENERGY_SOURCE_TYPE_OTHER = 2
energy source: other. An energy source that is not listed.
ENERGY_SOURCE_TYPE_COAL = 3
energy source: coal. Energy produced by types of coal.
ENERGY_SOURCE_TYPE_OIL = 4
energy source: oil. Petroleum products (primarily crude oil and its derivative fuel oils).
ENERGY_SOURCE_TYPE_NATURAL_GAS = 5
energy source: 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.
ENERGY_SOURCE_TYPE_NUCLEAR = 6
energy source: nuclear. Energy produced from the cores of atoms (i.e., through nuclear fission or fusion).
ENERGY_SOURCE_TYPE_WIND = 7
energy source: wind. Energy produced from moving air.
ENERGY_SOURCE_TYPE_SOLAR = 8
energy source: solar. Energy produced from the sun (i.e., solar radiation).
ENERGY_SOURCE_TYPE_GEOTHERMAL = 9
energy source: geothermal. Energy produced from heat within the earth.
ENERGY_SOURCE_TYPE_HYDROPOWER = 10
energy source: hydropower. Energy produced from flowing water.
ENERGY_SOURCE_TYPE_BIOFUEL = 11
energy source: biofuel. Liquid fuels produced from biomass feedstocks (i.e., organic materials such as plants or animals).

Used in: InputType, OutputType

oneof choice
- Property property = 1
  Name-value pair
- string value = 2
  Value

Represents something that happened that may trigger a response.

Used in: Trigger

optional string uid = 1
The unique identifier of the event.
optional string description = 2
A description of the event.
optional google.protobuf.Timestamp timeReceived = 3
The date and time (timestamp) when the event was received.
optional AttachedText data = 4
Encoding of the raw event data.
optional ResourceReferenceChoice source = 5
References the component or service that was the source of the event
optional ResourceReferenceChoice target = 6
References the component or service that was the target of the event
repeated Property properties = 7
Additional properties of the event.

Provides the ability to document evidence collected through various forms of extraction or analysis.

Used in: Component

repeated LicenseChoice licenses = 1
EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
repeated EvidenceCopyright copyright = 2
Copyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection.
repeated EvidenceIdentity identity = 3
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.
repeated EvidenceOccurrences occurrences = 4
Evidence of individual instances of a component spread across multiple locations.
optional Callstack callstack = 5
Evidence of the components use through the callstack.

Used in: Evidence

string text = 1
Copyright text

buf:lint:ignore ENUM_VALUE_PREFIX -- Enum value names should be prefixed with "EVIDENCE_FIELD_TYPE_"

Used in: EvidenceIdentity

EVIDENCE_FIELD_NULL = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
EVIDENCE_FIELD_GROUP = 1
EVIDENCE_FIELD_NAME = 2
EVIDENCE_FIELD_VERSION = 3
EVIDENCE_FIELD_PURL = 4
EVIDENCE_FIELD_CPE = 5
EVIDENCE_FIELD_SWID = 6
EVIDENCE_FIELD_HASH = 7
EVIDENCE_FIELD_OMNIBOR_ID = 8
EVIDENCE_FIELD_SWHID = 9

Used in: Evidence

EvidenceFieldType field = 1
The identity field of the component which the evidence describes.
optional float confidence = 2
The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
repeated EvidenceMethods methods = 3
The methods used to extract and/or analyze the evidence.
repeated string tools = 4
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.
optional string concludedValue = 5
The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).

Used in: EvidenceIdentity

EvidenceTechnique technique = 1
The technique used in this method of analysis.
float confidence = 2
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.
optional string value = 3
The value or contents of the evidence.

Used in: Evidence

optional string bom_ref = 1
An optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref must be unique within the BOM.
string location = 2
The location or path to where the component was found.
optional int32 line = 3
The line number where the component was found.
optional int32 offset = 4
The offset where the component was found.
optional string symbol = 5
The symbol name that was found associated with the component.
optional string additionalContext = 6
Any additional context of the detected component (e.g. a code snippet).

Used in: EvidenceMethods

EVIDENCE_TECHNIQUE_SOURCE_CODE_ANALYSIS = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error, it shall be fixed with v2.0 of this very schema
EVIDENCE_TECHNIQUE_BINARY_ANALYSIS = 1
EVIDENCE_TECHNIQUE_MANIFEST_ANALYSIS = 2
EVIDENCE_TECHNIQUE_AST_FINGERPRINT = 3
EVIDENCE_TECHNIQUE_HASH_COMPARISON = 4
EVIDENCE_TECHNIQUE_INSTRUMENTATION = 5
EVIDENCE_TECHNIQUE_DYNAMIC_ANALYSIS = 6
EVIDENCE_TECHNIQUE_FILENAME = 7
EVIDENCE_TECHNIQUE_ATTESTATION = 8
EVIDENCE_TECHNIQUE_OTHER = 9

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.

Used in: Bom, Component, Declarations.Affirmation.Signatory, Declarations.Claim, Definition.Standard, Definition.Standard.Requirement, EnergyProviderType, ResourceReferenceChoice, Service, Tool

ExternalReferenceType type = 1
Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the "other" type.
string url = 2
The URL to the external reference
optional string comment = 3
An optional comment describing the external reference
repeated Hash hashes = 4
Optional integrity hashes for the external resource content

Used in: ExternalReference

EXTERNAL_REFERENCE_TYPE_OTHER = 0
Use this if no other types accurately describe the purpose of the external reference buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `other` is our fallback, doubling `unspecified`
EXTERNAL_REFERENCE_TYPE_VCS = 1
Version Control System
EXTERNAL_REFERENCE_TYPE_ISSUE_TRACKER = 2
Issue, defect tracking system, or an Application Lifecycle Management (ALM) system
EXTERNAL_REFERENCE_TYPE_WEBSITE = 3
Website
EXTERNAL_REFERENCE_TYPE_ADVISORIES = 4
Security advisories
EXTERNAL_REFERENCE_TYPE_BOM = 5
Bill-of-material document (CycloneDX, SPDX, SWID, etc)
EXTERNAL_REFERENCE_TYPE_MAILING_LIST = 6
Mailing list or discussion group
EXTERNAL_REFERENCE_TYPE_SOCIAL = 7
Social media account
EXTERNAL_REFERENCE_TYPE_CHAT = 8
Real-time chat platform
EXTERNAL_REFERENCE_TYPE_DOCUMENTATION = 9
Documentation, guides, or how-to instructions
EXTERNAL_REFERENCE_TYPE_SUPPORT = 10
Community or commercial support
EXTERNAL_REFERENCE_TYPE_DISTRIBUTION = 11
Direct or repository download location
EXTERNAL_REFERENCE_TYPE_LICENSE = 12
The URL to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness
EXTERNAL_REFERENCE_TYPE_BUILD_META = 13
Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)
EXTERNAL_REFERENCE_TYPE_BUILD_SYSTEM = 14
URL to an automated build system
EXTERNAL_REFERENCE_TYPE_SECURITY_CONTACT = 15
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.
EXTERNAL_REFERENCE_TYPE_ATTESTATION = 16
Human or machine-readable statements containing facts, evidence, or testimony
EXTERNAL_REFERENCE_TYPE_THREAT_MODEL = 17
An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format
EXTERNAL_REFERENCE_TYPE_ADVERSARY_MODEL = 18
The defined assumptions, goals, and capabilities of an adversary.
EXTERNAL_REFERENCE_TYPE_RISK_ASSESSMENT = 19
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.
EXTERNAL_REFERENCE_TYPE_DISTRIBUTION_INTAKE = 20
The location where a component was published. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary
EXTERNAL_REFERENCE_TYPE_VULNERABILITY_ASSERTION = 21
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
EXTERNAL_REFERENCE_TYPE_EXPLOITABILITY_STATEMENT = 22
A Vulnerability Exploitability eXchange (VEX) 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
EXTERNAL_REFERENCE_TYPE_PENTEST_REPORT = 23
Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test
EXTERNAL_REFERENCE_TYPE_STATIC_ANALYSIS_REPORT = 24
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
EXTERNAL_REFERENCE_TYPE_DYNAMIC_ANALYSIS_REPORT = 25
Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations
EXTERNAL_REFERENCE_TYPE_RUNTIME_ANALYSIS_REPORT = 26
Report generated by analyzing the call stack of a running application
EXTERNAL_REFERENCE_TYPE_COMPONENT_ANALYSIS_REPORT = 27
Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis
EXTERNAL_REFERENCE_TYPE_MATURITY_REPORT = 28
Report containing a formal assessment of an organization, business unit, or team against a maturity model
EXTERNAL_REFERENCE_TYPE_CERTIFICATION_REPORT = 29
Industry, regulatory, or other certification from an accredited (if applicable) certification body
EXTERNAL_REFERENCE_TYPE_QUALITY_METRICS = 30
Report or system in which quality metrics can be obtained
EXTERNAL_REFERENCE_TYPE_CODIFIED_INFRASTRUCTURE = 31
Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC)
EXTERNAL_REFERENCE_TYPE_MODEL_CARD = 32
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.
EXTERNAL_REFERENCE_TYPE_POAM = 33
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".
EXTERNAL_REFERENCE_TYPE_LOG = 34
A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations.
EXTERNAL_REFERENCE_TYPE_CONFIGURATION = 35
Parameters or settings that may be used by other components or services.
EXTERNAL_REFERENCE_TYPE_EVIDENCE = 36
Information used to substantiate a claim.
EXTERNAL_REFERENCE_TYPE_FORMULATION = 37
Describes how a component or service was manufactured or deployed.
EXTERNAL_REFERENCE_TYPE_SOURCE_DISTRIBUTION = 38
The location where the source code distributable can be obtained. This is often an archive format such as zip or tar.gz. The source-distribution type complements the use of the version control (vcs) type.
EXTERNAL_REFERENCE_TYPE_ELECTRONIC_SIGNATURE = 39
An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name.
EXTERNAL_REFERENCE_TYPE_DIGITAL_SIGNATURE = 40
A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification.
EXTERNAL_REFERENCE_TYPE_RFC_9116 = 41
Document that complies with RFC-9116 (A File Format to Aid in Security Vulnerability Disclosure)
EXTERNAL_REFERENCE_TYPE_RELEASE_NOTES = 42
Reference to release notes

Describes workflows and resources that captures rules and other aspects of how the associated BOM component or service was formed.

Used in: Bom

optional string bom_ref = 1
BOM unique reference to the resource.
repeated Component components = 2
Transient components that are used in tasks that constitute one or more of this formula's workflows
repeated Service services = 3
Transient services that are used in tasks that constitute one or more of this formula's workflows
repeated Workflow workflows = 4
List of workflows that can be declared to accomplish specific orchestrated goals and independently triggered.
repeated Property properties = 5
Domain-specific formula properties.

A collection of graphics that represent various measurements.

Used in: ComponentData, ModelCard.QuantitativeAnalysis

optional string description = 1
A description of this collection of graphics.
repeated GraphicsCollection.Graphic graphic = 2
A collection of graphics.

Used in: GraphicsCollection

optional string name = 1
The name of the graphic.
optional AttachedText image = 2
The graphic (vector or raster). Base64 encoding must be specified for binary images.

Specifies the file hash of the component

Used in: Component, ExternalReference, Tool

HashAlg alg = 1
Specifies the algorithm used to create the hash
string value = 2
SimpleContent value of element

Used in: Hash

HASH_ALG_NULL = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
HASH_ALG_MD_5 = 1
HASH_ALG_SHA_1 = 2
HASH_ALG_SHA_256 = 3
HASH_ALG_SHA_384 = 4
HASH_ALG_SHA_512 = 5
HASH_ALG_SHA_3_256 = 6
HASH_ALG_SHA_3_384 = 7
HASH_ALG_SHA_3_512 = 8
HASH_ALG_BLAKE_2_B_256 = 9
HASH_ALG_BLAKE_2_B_384 = 10
HASH_ALG_BLAKE_2_B_512 = 11
HASH_ALG_BLAKE_3 = 12

Used in: Commit

optional google.protobuf.Timestamp timestamp = 1
The timestamp in which the action occurred
optional string name = 2
The name of the individual who performed the action
optional string email = 3
The email address of the individual who performed the action

Used in: VulnerabilityAnalysis

IMPACT_ANALYSIS_JUSTIFICATION_NULL = 0
An undefined impact analysis justification buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
IMPACT_ANALYSIS_JUSTIFICATION_CODE_NOT_PRESENT = 1
The code has been removed or tree-shaked.
IMPACT_ANALYSIS_JUSTIFICATION_CODE_NOT_REACHABLE = 2
The vulnerable code is not invoked at runtime.
IMPACT_ANALYSIS_JUSTIFICATION_REQUIRES_CONFIGURATION = 3
Exploitability requires a configurable option to be set/unset.
IMPACT_ANALYSIS_JUSTIFICATION_REQUIRES_DEPENDENCY = 4
Exploitability requires a dependency that is not present.
IMPACT_ANALYSIS_JUSTIFICATION_REQUIRES_ENVIRONMENT = 5
Exploitability requires a certain environment which is not present.
IMPACT_ANALYSIS_JUSTIFICATION_PROTECTED_BY_COMPILER = 6
Exploitability requires a compiler flag to be set/unset.
IMPACT_ANALYSIS_JUSTIFICATION_PROTECTED_AT_RUNTIME = 7
Exploits are prevented at runtime.
IMPACT_ANALYSIS_JUSTIFICATION_PROTECTED_AT_PERIMETER = 8
Attacks are blocked at physical, logical, or network perimeter.
IMPACT_ANALYSIS_JUSTIFICATION_PROTECTED_BY_MITIGATING_CONTROL = 9
Preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability.

Used in: VulnerabilityAnalysis

IMPACT_ANALYSIS_STATE_NULL = 0
An undefined impact analysis state buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
IMPACT_ANALYSIS_STATE_RESOLVED = 1
The vulnerability has been remediated.
IMPACT_ANALYSIS_STATE_RESOLVED_WITH_PEDIGREE = 2
The vulnerability has been remediated, and evidence of the changes is provided in the affected components pedigree containing verifiable commit history and/or diff(s).
IMPACT_ANALYSIS_STATE_EXPLOITABLE = 3
The vulnerability may be directly or indirectly exploitable.
IMPACT_ANALYSIS_STATE_IN_TRIAGE = 4
The vulnerability is being investigated.
IMPACT_ANALYSIS_STATE_FALSE_POSITIVE = 5
The vulnerability is not specific to the component or service and was falsely identified or associated.
IMPACT_ANALYSIS_STATE_NOT_AFFECTED = 6
The component or service is not affected by the vulnerability. Justification should be specified for all not_affected cases.

Type that represents various input data types and formats.

Used in: Task, Trigger, Workflow

optional ResourceReferenceChoice source = 1
A references to the component or service that provided the input to the task (e.g., reference to a service with a data flow value of `inbound`)
optional ResourceReferenceChoice target = 2
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)
optional ResourceReferenceChoice resource = 3
A reference to an independent resource provided as an input to a task by the workflow runtime.
repeated Parameter parameters = 4
Inputs that have the form of parameters with names and values.
repeated EnvironmentVars environmentVars = 5
Inputs that have the form of parameters with names and values.
optional AttachedText data = 6
Inputs that have the form of data.
repeated Property properties = 7
Additional properties of the input data.

An individual issue that has been resolved.

Used in: Patch, ReleaseNotes

IssueClassification type = 1
Specifies the type of issue
optional string id = 2
The identifier of the issue assigned by the source of the issue
optional string name = 3
The name of the issue
optional string description = 4
A description of the issue
optional Source source = 5
The source of the issue where it is documented
repeated string references = 6
A collection of URL's for reference. Multiple URLs are allowed. Example: "https://example.com"

Used in: Issue

ISSUE_CLASSIFICATION_NULL = 0
Default buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
ISSUE_CLASSIFICATION_DEFECT = 1
A fault, flaw, or bug in software
ISSUE_CLASSIFICATION_ENHANCEMENT = 2
A new feature or behavior in software
ISSUE_CLASSIFICATION_SECURITY = 3
A special type of defect which impacts security

Specifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.

Used in: LicenseChoice

oneof license
- string id = 1
  A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
- string name = 2
  The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
optional AttachedText text = 3
Specifies the optional full text of the attachment
optional string url = 4
The URL to the attachment file. If the attachment is a license or BOM, an externalReference should also be specified for completeness.
optional string bom_ref = 5
An optional identifier which can be used to reference the license elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional Licensing licensing = 6
Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata
repeated Property properties = 7
Specifies optional, custom, properties
optional LicenseAcknowledgementEnumeration acknowledgement = 8
Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in `@.evidence.licenses`. Observed licenses form the evidence necessary to substantiate a concluded license.

Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in `@.evidence.licenses`. Observed licenses form the evidence necessary to substantiate a concluded license.

Used in: License, LicenseChoice

LICENSE_ACKNOWLEDGEMENT_ENUMERATION_UNSPECIFIED = 0
The license acknowledgement is not specified.
LICENSE_ACKNOWLEDGEMENT_ENUMERATION_DECLARED = 1
Declared licenses represent the initial intentions of authors regarding the licensing terms of their code.
LICENSE_ACKNOWLEDGEMENT_ENUMERATION_CONCLUDED = 2
Concluded licenses are verified and confirmed.

Used in: Component, Evidence, Metadata, Service

oneof choice
- License license = 1
  A license
- string expression = 2
  A valid SPDX license expression. Refer to https://spdx.org/specifications for syntax requirements
optional LicenseAcknowledgementEnumeration acknowledgement = 3
This field must only be used when "expression" is chosen as the License object has its own acknowledgement.
optional string bom_ref = 4
This field must only be used when "expression" is chosen as the License object has its own bom_ref.

Used in: License

repeated string altIds = 1
License identifiers that may be used to manage licenses and their lifecycle
optional OrganizationalEntityOrContact licensor = 2
The individual or organization that grants a license to another individual or organization
optional OrganizationalEntityOrContact licensee = 3
The individual or organization for which a license was granted to
optional OrganizationalEntityOrContact purchaser = 4
The individual or organization that purchased the license
optional string purchaseOrder = 5
The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase
repeated LicensingTypeEnum licenseTypes = 6
The type of license(s) that was granted to the licensee
optional google.protobuf.Timestamp lastRenewal = 7
The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.
optional google.protobuf.Timestamp expiration = 8
The timestamp indicating when the current license expires (if applicable).

buf:lint:ignore ENUM_VALUE_PREFIX -- Enum value names should be prefixed with "LICENSING_TYPE_ENUM_"

Used in: Licensing

LICENSING_TYPE_NULL = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
LICENSING_TYPE_ACADEMIC = 1
A license that grants use of software solely for the purpose of education or research.
LICENSING_TYPE_APPLIANCE = 2
A license covering use of software embedded in a specific piece of hardware.
LICENSING_TYPE_CLIENT_ACCESS = 3
A Client Access License (CAL) allows client computers to access services provided by server software.
LICENSING_TYPE_CONCURRENT_USER = 4
A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users.
LICENSING_TYPE_CORE_POINTS = 5
A license where the core of a computer's processor is assigned a specific number of points.
LICENSING_TYPE_CUSTOM_METRIC = 6
A license for which consumption is measured by non-standard metrics.
LICENSING_TYPE_DEVICE = 7
A license that covers a defined number of installations on computers and other types of devices.
LICENSING_TYPE_EVALUATION = 8
A license that grants permission to install and use software for trial purposes.
LICENSING_TYPE_NAMED_USER = 9
A license that grants access to the software to one or more pre-defined users.
LICENSING_TYPE_NODE_LOCKED = 10
A license that grants access to the software on one or more pre-defined computers or devices.
LICENSING_TYPE_OEM = 11
An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware.
LICENSING_TYPE_PERPETUAL = 12
A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely.
LICENSING_TYPE_PROCESSOR_POINTS = 13
A license where each installation consumes points per processor.
LICENSING_TYPE_SUBSCRIPTION = 14
A license where the licensee pays a fee to use the software or service.
LICENSING_TYPE_USER = 15
A license that grants access to the software or service by a specified number of users.
LICENSING_TYPE_OTHER = 16
Another license type.

Used in: Lifecycles

LIFECYCLE_PHASE_DESIGN = 0
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. buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error; it shall be fixed with v2.0 of this very schema
LIFECYCLE_PHASE_PRE_BUILD = 1
BOM consists of information obtained prior to a build process and may contain source files, development artifacts, and manifests. The inventory may need to be resolved and retrieved prior to use.
LIFECYCLE_PHASE_BUILD = 2
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.
LIFECYCLE_PHASE_POST_BUILD = 3
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.
LIFECYCLE_PHASE_OPERATIONS = 4
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.
LIFECYCLE_PHASE_DISCOVERY = 5
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.
LIFECYCLE_PHASE_DECOMMISSION = 6
BOM containing inventory that will be, or has been retired from operations.

Used in: Metadata

oneof choice
- LifecyclePhase phase = 1
  A pre-defined phase in the product lifecycle.
- string name = 2
  The name of the lifecycle phase
optional string description = 3
The description of the lifecycle phase

Used in: Bom

optional google.protobuf.Timestamp timestamp = 1
The date and time (timestamp) when the document was created.
optional Tool tools = 2
The tool(s) used in the creation of the BOM.
repeated OrganizationalContact authors = 3
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.
optional Component component = 4
The component that the BOM describes.
optional OrganizationalEntity manufacture = 5
DEPRECATED - DO NOT USE - This will be removed in a future version - Use the `.component.manufacturer` instead. The organization that manufactured the component that the BOM describes.
optional OrganizationalEntity supplier = 6
The organization that supplied the component that the BOM describes. The supplier may often be the manufacture, but may also be a distributor or repackager.
repeated LicenseChoice licenses = 7
The license information for the BOM document. This may be different from the license(s) of the component(s) that the BOM describes. EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
repeated Property properties = 8
Specifies optional, custom, properties
repeated Lifecycles lifecycles = 9
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.
optional OrganizationalEntity manufacturer = 10
The organization that created the BOM. Manufacturer is common in BOMs created through automated processes. BOMs created through manual means may have '.authors' instead.

* A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified for other component types. Comment: Model card support in CycloneDX is derived from TensorFlow Model Card Toolkit released under the Apache 2.0 license and available from https://github.com/tensorflow/model-card-toolkit/blob/main/model_card_toolkit/schema/v0.0.2/model_card.schema.json. In addition, CycloneDX model card support includes portions of VerifyML, also released under the Apache 2.0 license and available from https://github.com/cylynx/verifyml/blob/main/verifyml/model_card_toolkit/schema/v0.0.4/model_card.schema.json.

Used in: Component

optional string bom_ref = 1
An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref must be unique within the BOM.
optional ModelCard.ModelParameters modelParameters = 2
Hyper-parameters for construction of the model.
optional ModelCard.QuantitativeAnalysis quantitativeAnalysis = 3
A quantitative analysis of the model
optional ModelCard.ModelCardConsiderations considerations = 4
What considerations should be taken into account regarding the model's construction, training, and application?

Used in: ModelCard

repeated string users = 1
Who are the intended users of the model?
repeated string useCases = 2
What are the intended use cases of the model?
repeated string technicalLimitations = 3
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?
repeated string performanceTradeoffs = 4
What are the known tradeoffs in accuracy/performance of the model?
repeated ModelCardConsiderations.EthicalConsiderations ethicalConsiderations = 5
What are the ethical risks involved in the application of this model?
repeated ModelCardConsiderations.FairnessAssessments fairnessAssessments = 6
How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?
optional ModelCardConsiderations.EnvironmentalConsiderations environmentalConsiderations = 7
What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?

Describes energy consumption information incurred for the specified lifecycle activity.

Used in: EnvironmentalConsiderations

EnergyConsumption.ActivityType activity = 1
The type of activity that is part of a machine learning model development or operational lifecycle.
repeated EnergyProviderType energyProviders = 2
The providers of the energy consumed by the associated model development lifecycle activity.
optional EnergyMeasureType activityEnergyCost = 3
The total energy cost associated with the model lifecycle activity.
optional CO2MeasureType co2CostEquivalent = 4
The CO2 cost or debit equivalent to the total energy cost.
optional CO2MeasureType co2CostOffset = 5
The CO2 offset or credit for the CO2 equivalent cost.
repeated Property properties = 6
Specifies optional, custom properties for environment considerations

An activity that is part of a machine learning model development or operational lifecycle.

Used in: EnergyConsumption

ACTIVITY_TYPE_UNSPECIFIED = 0
Default
ACTIVITY_TYPE_OTHER = 1
a lifecycle activity type whose description does not match currently defined values (the default type).
ACTIVITY_TYPE_DESIGN = 2
model design including problem framing, goal definition and algorithm selection.
ACTIVITY_TYPE_DATA_COLLECTION = 3
model data acquisition including search, selection and transfer.
ACTIVITY_TYPE_DATA_PREPARATION = 4
model data preparation including data cleaning, labeling and conversion.
ACTIVITY_TYPE_TRAINING = 5
model building, training and generalized tuning.
ACTIVITY_TYPE_FINE_TUNING = 6
refining a trained model to produce desired outputs for a given problem space.
ACTIVITY_TYPE_VALIDATION = 7
model validation including model output evaluation and testing.
ACTIVITY_TYPE_DEPLOYMENT = 8
explicit model deployment to a target hosting infrastructure.
ACTIVITY_TYPE_INFERENCE = 9
generating an output response from a hosted model from a set of inputs.

Used in: ModelCardConsiderations

repeated EnergyConsumption energyConsumptions = 1
Describes energy consumption information incurred for one or more component lifecycle activities.
repeated Property properties = 2
Specifies optional, custom properties for environment considerations

Used in: ModelCardConsiderations

optional string name = 1
The name of the risk.
optional string mitigationStrategy = 2
Strategy used to address this risk.

Used in: ModelCardConsiderations

optional string groupAtRisk = 1
The groups or individuals at risk of being systematically disadvantaged by the model.
optional string benefits = 2
Expected benefits to the identified groups.
optional string harms = 3
Expected harms to the identified groups.
optional string mitigationStrategy = 4
With respect to the benefits and harms outlined, please describe any mitigation strategy implemented.

Used in: ModelCard

optional ModelParameters.Approach approach = 1
The overall approach to learning used by the model for problem-solving.
optional string task = 2
Directly influences the input and/or output. Examples include classification, regression, clustering, etc.
optional string architectureFamily = 3
The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc.
optional string modelArchitecture = 4
The specific architecture of the model, such as GPT-1, ResNet-50, YOLOv3, etc.
repeated ModelParameters.Datasets datasets = 5
The datasets used to train and evaluate the model.
repeated ModelParameters.MachineLearningInputOutputParameters inputs = 6
The input format(s) of the model
repeated ModelParameters.MachineLearningInputOutputParameters outputs = 7
The output format(s) from the model

Used in: ModelParameters

optional ModelParameterApproachType type = 1
Learning types describing the learning problem or hybrid learning problem.

Used in: ModelParameters

oneof choice
- ComponentData dataset = 1
  Inline Data Information
- string ref = 2
  References a data component by the components bom-ref attribute

Used in: ModelParameters

optional string format = 1
The data format for input/output to the model. Example formats include string, image, time-series

Used in: ModelCard

repeated QuantitativeAnalysis.PerformanceMetrics performanceMetrics = 1
The model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc.
optional GraphicsCollection graphics = 2
A collection of graphics that represent various measurements.

Used in: QuantitativeAnalysis

optional string type = 1
The type of performance metric.
optional string value = 2
The value of the performance metric.
optional string slice = 3
The name of the slice this metric was computed on. By default, assume this metric is not sliced.
optional PerformanceMetrics.ConfidenceInterval confidenceInterval = 4
The confidence interval of the metric.

Used in: PerformanceMetrics

optional string lowerBound = 1
The lower bound of the confidence interval.
optional string upperBound = 2
The upper bound of the confidence interval.

Used in: ModelCard.ModelParameters.Approach

MODEL_PARAMETER_APPROACH_TYPE_SUPERVISED = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error, it shall be fixed with v2.0 of this very schema Supervised machine learning involves training an algorithm on labeled data to predict or classify new data based on the patterns learned from the labeled examples.
MODEL_PARAMETER_APPROACH_TYPE_UNSUPERVISED = 1
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.
MODEL_PARAMETER_APPROACH_TYPE_REINFORCED_LEARNING = 2
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.
MODEL_PARAMETER_APPROACH_TYPE_SEMI_SUPERVISED = 3
Semi-supervised machine learning utilizes a combination of labeled and unlabeled data during training to improve model performance, leveraging the benefits of both supervised and unsupervised learning techniques.
MODEL_PARAMETER_APPROACH_TYPE_SELF_SUPERVISED = 4
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.

A note containing the locale and content.

Used in: ReleaseNotes

optional string locale = 1
The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA".
optional AttachedText text = 2
Specifies the full content of the release note.

Used in: AnnotatorChoice, Component, DataGovernance.DataGovernanceResponsibleParty, Declarations.Evidence, Metadata, OrganizationalEntity, OrganizationalEntityOrContact, VulnerabilityCredits

optional string name = 1
The name of the contact
optional string email = 2
The email address of the contact.
optional string phone = 3
The phone number of the contact.
optional string bom_ref = 4
An optional identifier which can be used to reference the object elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.

Used in: AnnotatorChoice, Component, DataGovernance.DataGovernanceResponsibleParty, Declarations.Affirmation.Signatory, Declarations.Assessor, Declarations.Targets, EnergyProviderType, Metadata, OrganizationalEntityOrContact, Service, VulnerabilityCredits

optional string name = 1
The name of the organization
repeated string url = 2
The URL of the organization. Multiple URLs are allowed.
repeated OrganizationalContact contact = 3
A contact person at the organization. Multiple contacts are allowed.
optional string bom_ref = 4
An optional identifier which can be used to reference the object elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional PostalAddressType address = 5
The physical address (location) of the organization

EITHER an organization OR an individual

Used in: Licensing

oneof choice
- OrganizationalEntity organization = 1
  Organization
- OrganizationalContact individual = 2
  Individual

Type that represents various output data types and formats.

Used in: Task, Trigger, Workflow

optional OutputType.OutputTypeType type = 1
Describes the type of data output.
optional ResourceReferenceChoice source = 2
Component or service that generated or provided the output from the task (e.g., a build tool)
optional ResourceReferenceChoice target = 3
Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of `outbound`)
optional ResourceReferenceChoice resource = 4
A reference to an independent resource generated as output by the task.
optional AttachedText data = 5
Outputs that have the form of data.
repeated EnvironmentVars environmentVars = 6
Outputs that have the form of environment variables.
repeated Property properties = 7
Additional properties of the output data.

buf:lint:ignore ENUM_VALUE_PREFIX -- Enum value names should be prefixed with "OUTPUT_TYPE_TYPE_"

Used in: OutputType

OUTPUT_TYPE_ARTIFACT = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error; it shall be fixed with v2.0 of this very schema
OUTPUT_TYPE_ATTESTATION = 1
OUTPUT_TYPE_LOG = 2
OUTPUT_TYPE_EVIDENCE = 3
OUTPUT_TYPE_METRICS = 4
OUTPUT_TYPE_OTHER = 5

A representation of a functional parameter.

Used in: InputType

optional string name = 1
The name of the parameter.
optional string value = 2
The value of the parameter.
optional string dataType = 3
The data type of the parameter.

Specifies an individual patch

Used in: Pedigree

PatchClassification type = 1
Specifies the purpose for the patch, including the resolution of defects, security issues, or new behavior or functionality
optional Diff diff = 2
The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff
repeated Issue resolves = 3
A collection of issues the patch resolves

Used in: Patch

PATCH_CLASSIFICATION_NULL = 0
Default buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
PATCH_CLASSIFICATION_UNOFFICIAL = 1
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
PATCH_CLASSIFICATION_MONKEY = 2
A patch which dynamically modifies runtime behavior. Refer to https://en.wikipedia.org/wiki/Monkey_patch
PATCH_CLASSIFICATION_BACKPORT = 3
A patch which takes code from a newer version of software and applies it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting
PATCH_CLASSIFICATION_CHERRY_PICK = 4
A patch created by selectively applying commits from other versions or branches of the same software.

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.

Used in: Component

repeated Component ancestors = 1
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.
repeated Component descendants = 2
Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.
repeated Component variants = 3
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.
repeated Commit commits = 4
A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.
repeated Patch patches = 5
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.
optional string notes = 6
Notes, observations, and other non-structured commentary describing the component's pedigree.

An address used to identify a contactable location.

Used in: OrganizationalEntity

optional string bom_ref = 1
An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.
optional string country = 2
The country name or the two-letter ISO 3166-1 country code.
optional string region = 3
The region or state in the country. For example, Texas.
optional string locality = 4
The locality or city within the country. For example, Austin.
optional string postOfficeBoxNumber = 5
The post office box number. For example, 901.
optional string postalCodeue = 6
The postal code. For example, 78758.
optional string streetAddress = 7
The street address. For example, 100 Main Street.

Used in: Vulnerability

optional string reproductionSteps = 1
Precise steps to reproduce the vulnerability.
optional string environment = 2
A description of the environment in which reproduction was possible.
repeated AttachedText supportingMaterial = 3
Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code.

Specifies a property

Used in: Bom, Command, Component, ComponentData.ComponentDataContents, Condition, Definition.Standard.Requirement, EnvironmentVars, Event, Formula, InputType, License, Metadata, ModelCard.ModelCardConsiderations.EnergyConsumption, ModelCard.ModelCardConsiderations.EnvironmentalConsiderations, OutputType, ReleaseNotes, Service, Step, Task, Trigger, Volume, Vulnerability, Workflow, Workspace

string name = 1
Name (or key)
optional string value = 2
Value

Used in: Component, Service

string type = 1
The software versioning type. It is recommended that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.
optional string title = 2
The title of the release.
optional string featuredImage = 3
The URL to an image that may be prominently displayed with the release note.
optional string socialImage = 4
The URL to an image that may be used in messaging on social media platforms.
optional string description = 5
A short description of the release.
optional google.protobuf.Timestamp timestamp = 6
The date and time (timestamp) when the release note was created.
repeated string aliases = 7
Optional alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names).
repeated string tags = 8
Textual strings that aid in the 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. Examples include "json-parser", "object-persistence", "text-to-image", "translation", and "object-detection".
repeated Issue resolves = 9
A collection of issues that have been resolved.
repeated Note notes = 10
Zero or more release notes containing the locale and content. Multiple note messages may be specified to support release notes in a wide variety of languages.
repeated Property properties = 11
Specifies optional, custom, properties

Type that permits a choice to reference a resource using an iternal bom-ref identifier or an external reference.

Used in: Event, InputType, OutputType, Task, Trigger, Workflow, Workspace

oneof choice
- string ref = 1
  References an object by its bom-ref attribute
- ExternalReference externalReference = 2
  Reference to an externally accessible resource

Used in: Component

SCOPE_UNSPECIFIED = 0
Default
SCOPE_REQUIRED = 1
The component is required for runtime
SCOPE_OPTIONAL = 2
The component is optional at runtime. Optional components are components that are not capable of being called due to them not being installed or otherwise accessible by any means. Components that are installed but, due to configuration or other restrictions, are prohibited from being called must be scoped as 'required'.
SCOPE_EXCLUDED = 3
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.

Used in: VulnerabilityRating

SCORE_METHOD_NULL = 0
An undefined score method buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
SCORE_METHOD_CVSSV2 = 1
Common Vulnerability Scoring System v2 - https://www.first.org/cvss/v2/
SCORE_METHOD_CVSSV3 = 2
Common Vulnerability Scoring System v3 - https://www.first.org/cvss/v3-0/
SCORE_METHOD_CVSSV31 = 3
Common Vulnerability Scoring System v3.1 - https://www.first.org/cvss/v3-1/
SCORE_METHOD_OWASP = 4
OWASP Risk Rating Methodology - https://owasp.org/www-community/OWASP_Risk_Rating_Methodology
SCORE_METHOD_OTHER = 5
Other scoring method
SCORE_METHOD_CVSSV4 = 6
Common Vulnerability Scoring System v4.0 - https://www.first.org/cvss/v4-0/
SCORE_METHOD_SSVC = 7
Stakeholder Specific Vulnerability Categorization (all versions) - https://github.com/CERTCC/SSVC

Used in: AnnotatorChoice, Bom, Declarations.Targets, Formula, Tool

optional string bom_ref = 1
An optional identifier which can be used to reference the service elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional OrganizationalEntity provider = 2
The organization that provides the service.
optional string group = 3
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.
string name = 4
The name of the service. This will often be a shortened, single name of the service.
optional string version = 5
The service version.
optional string description = 6
Specifies a description for the service.
repeated string endpoints = 7
The endpoint URIs of the service. Multiple endpoints are allowed. Example: "https://example.com/api/v1/ticker"
optional bool authenticated = 8
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.
optional bool x_trust_boundary = 9
A boolean value indicating if the 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.
repeated DataFlow data = 10
Specifies information about the data including the directional flow of data and the data classification.
repeated LicenseChoice licenses = 11
EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)
repeated ExternalReference external_references = 12
Provides the ability to document external references related to the service.
repeated Service services = 13
Specifies optional sub-service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies, similar to system -> subsystem -> parts assembly in physical supply chains.
repeated Property properties = 14
Specifies optional, custom, properties
optional ReleaseNotes releaseNotes = 15
Specifies optional release notes.
optional string trustZone = 16
The name of the trust zone the service resides in.
repeated string tags = 17
Textual strings that aid in the 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. Examples include "json-parser", "object-persistence", "text-to-image", "translation", and "object-detection".

Textual representation of the severity of the vulnerability adopted by the analysis method. If the analysis method uses values other than what is provided, the user is expected to translate appropriately.

Used in: VulnerabilityRating

SEVERITY_UNKNOWN = 0
The severity is not known buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `unknown` is our fallback, doubling `unspecified`
SEVERITY_CRITICAL = 1
Critical severity
SEVERITY_HIGH = 2
High severity
SEVERITY_MEDIUM = 3
Medium severity
SEVERITY_LOW = 4
Low severity
SEVERITY_INFO = 5
Informational warning.
SEVERITY_NONE = 6
None

The source of the issue where it is documented.

Used in: Issue, Vulnerability, VulnerabilityRating, VulnerabilityReference

optional string name = 1
The name of the source. For example, "National Vulnerability Database", "NVD", and "Apache"
optional string url = 2
The url of the issue documentation as provided by the source

Executes specific commands or tools in order to accomplish its owning task as part of a sequence.

Used in: Task, Workflow

optional string name = 1
A name for the step.
optional string description = 2
A description of the step.
repeated Command commands = 3
Ordered list of commands or directives for the step
repeated Property properties = 4
Domain-specific step properties.

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

Used in: Component

string tag_id = 1
Maps to the tagId of a SoftwareIdentity.
string name = 2
Maps to the name of a SoftwareIdentity.
optional string version = 3
Maps to the version of a SoftwareIdentity. Defaults to '0.0' if not specified.
optional int32 tag_version = 4
Maps to the tagVersion of a SoftwareIdentity. Defaults to '0' if not specified.
optional bool patch = 5
Maps to the patch of a SoftwareIdentity. Defaults to 'false' if not specified.
optional AttachedText text = 6
Specifies the full content of the SWID tag.
optional string url = 7
The URL to the SWID file.

Describes the inputs, sequence of steps and resources used to accomplish a task and its output.

Used in: Workflow

string bom_ref = 1
BOM unique reference to the resource.
string uid = 2
The unique identifier for the resource instance within its deployment context.
optional string name = 3
The name of the resource instance.
optional string description = 4
A description of the resource instance.
repeated Property properties = 5
Domain-specific task instance properties.
repeated ResourceReferenceChoice resourceReferences = 6
References to component or service resources that are used to realize the resource instance.
repeated TaskType taskTypes = 7
Indicates the types of activities performed by the set of workflow tasks.
optional Trigger trigger = 8
The trigger that initiated the task.
repeated Step steps = 9
"The sequence of steps for the task.
repeated InputType inputs = 10
Represents resources and data brought into a task at runtime by an executor or task commands
repeated OutputType outputs = 11
Represents resources and data output from a task at runtime by an executor or task commands
optional google.protobuf.Timestamp timeStart = 14
The date and time (timestamp) when the task started.
optional google.protobuf.Timestamp timeEnd = 15
The date and time (timestamp) when the task ended.
repeated Workspace workspaces = 16
A set of named filesystem or data resource shareable by workflow tasks.
repeated Dependency runtimeTopology = 17
A graph of the component runtime topology for task's instance.

Used in: Task, Workflow

TASK_TYPE_COPY = 0
A task that copies software or data used to accomplish other tasks in the workflow. buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error; it shall be fixed with v2.0 of this very schema
TASK_TYPE_CLONE = 1
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.
TASK_TYPE_LINT = 2
A task that checks source code for programmatic and stylistic errors.
TASK_TYPE_SCAN = 3
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.
TASK_TYPE_MERGE = 4
A task that merges changes or fixes into source code prior to a build step in the workflow.
TASK_TYPE_BUILD = 5
A task that builds the source code, dependencies and/or data into an artifact that can be deployed to and executed on target systems.
TASK_TYPE_TEST = 6
A task that verifies the functionality of a component or service.
TASK_TYPE_DELIVER = 7
A task that delivers a built artifact to one or more target repositories or storage systems.
TASK_TYPE_DEPLOY = 8
A task that deploys a built artifact for execution on one or more target systems.
TASK_TYPE_RELEASE = 9
A task that releases a built, versioned artifact to a target repository or distribution system.
TASK_TYPE_CLEAN = 10
A task that cleans unnecessary tools, build artifacts and/or data from workflow storage.
TASK_TYPE_OTHER = 11
A workflow task that does not match current task type definitions.

Specifies a tool (manual or automated).

Used in: Metadata, Vulnerability

optional string vendor = 1
DEPRECATED - DO NOT USE - The vendor of the tool used to create the BOM.
optional string name = 2
DEPRECATED - DO NOT USE - The name of the tool used to create the BOM.
optional string version = 3
DEPRECATED - DO NOT USE - The version of the tool used to create the BOM.
repeated Hash hashes = 4
DEPRECATED - DO NOT USE
repeated ExternalReference external_references = 5
DEPRECATED - DO NOT USE - Provides the ability to document external references related to the tool.
repeated Component components = 6
A list of software and hardware components used as tools
repeated Service services = 7
A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services.

Represents a resource that can conditionally activate (or fire) tasks based upon associated events and their data.

Used in: Task, Workflow

string bom_ref = 1
BOM unique reference to the resource.
string uid = 2
The unique identifier for the resource instance within its deployment context.
optional string name = 3
The name of the resource instance.
optional string description = 4
A description of the resource instance.
repeated Property properties = 5
Additional properties of the trigger.
repeated ResourceReferenceChoice resourceReferences = 6
References to component or service resources that are used to realize the resource instance.
Trigger.TriggerType type = 7
The source type of event which caused the trigger to fire.
optional Event event = 8
The event data that caused the associated trigger to activate.
repeated Condition conditions = 9
A list of conditions used to determine if a trigger should be activated.
optional google.protobuf.Timestamp timeActivated = 10
The date and time (timestamp) when the trigger was activated.
repeated InputType inputs = 11
Represents resources and data brought into a task at runtime by an executor or task commands
repeated OutputType outputs = 12
Represents resources and data output from a task at runtime by an executor or task commands

Used in: Trigger

TRIGGER_TYPE_MANUAL = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error; it shall be fixed with v2.0 of this very schema
TRIGGER_TYPE_API = 1
TRIGGER_TYPE_WEBHOOK = 2
TRIGGER_TYPE_SCHEDULED = 3

An identifiable, logical unit of data storage tied to a physical device.

Used in: Workspace

optional string uid = 1
The unique identifier for the volume instance within its deployment context.
optional string name = 2
The name of the volume instance
optional Volume.VolumeMode mode = 3
The volume mode for the volume instance.
optional string path = 4
The underlying path created from the actual volume.
optional string sizeAllocated = 5
The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as the IEC standard unit in either decimal or binary form.
optional bool persistent = 6
Indicates if the volume persists beyond the life of the resource it is associated with.
optional bool remote = 7
Indicates if the volume is remotely (i.e., network) attached.
repeated Property properties = 8
Domain-specific volume instance properties.

Used in: Volume

VOLUME_MODE_FILESYSTEM = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error; it shall be fixed with v2.0 of this very schema
VOLUME_MODE_BLOCK = 1

Defines a weakness in a component or service that could be exploited or triggered by a threat source.

Used in: Bom

optional string bom_ref = 1
An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.
optional string id = 2
The identifier that uniquely identifies the vulnerability.
optional Source source = 3
The source that published the vulnerability.
repeated VulnerabilityReference references = 4
Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Oftentimes, 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.
repeated VulnerabilityRating ratings = 5
List of vulnerability ratings
repeated int32 cwes = 6
List of Common Weaknesses Enumerations (CWEs) codes that describe this vulnerability. For example, 399 (of https://cwe.mitre.org/data/definitions/399.html)
optional string description = 7
A description of the vulnerability as provided by the source.
optional string detail = 8
If available, an in-depth description of the vulnerability as provided by the source organization. Details often include information useful in understanding the root cause.
optional string recommendation = 9
Recommendations of how the vulnerability can be remediated or mitigated.
repeated Advisory advisories = 10
Published advisories of the vulnerability if provided.
optional google.protobuf.Timestamp created = 11
The date and time (timestamp) when the vulnerability record was created in the vulnerability database.
optional google.protobuf.Timestamp published = 12
The date and time (timestamp) when the vulnerability record was first published.
optional google.protobuf.Timestamp updated = 13
The date and time (timestamp) when the vulnerability record was last updated.
optional VulnerabilityCredits credits = 14
Individuals or organizations credited with the discovery of the vulnerability.
optional Tool tools = 15
The tool(s) used to identify, confirm, or score the vulnerability.
optional VulnerabilityAnalysis analysis = 16
An assessment of the impact and exploitability of the vulnerability.
repeated VulnerabilityAffects affects = 17
affects
repeated Property properties = 18
Specifies optional, custom, properties
optional google.protobuf.Timestamp rejected = 19
The date and time (timestamp) when the vulnerability record was rejected (if applicable).
optional ProofOfConcept proofOfConcept = 20
Evidence used to reproduce the vulnerability.
optional string workaround = 21
A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments.

The vulnerability status of a given version or range of versions of a product. The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor has not disclosed the status.

Used in: VulnerabilityAffectedVersions

VULNERABILITY_AFFECTED_STATUS_UNKNOWN = 0
It is unknown (or unspecified) whether the given version is affected. buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `unknown` is our fallback, doubling `unspecified`
VULNERABILITY_AFFECTED_STATUS_AFFECTED = 1
The version is affected by the vulnerability.
VULNERABILITY_AFFECTED_STATUS_NOT_AFFECTED = 2
The version is not affected by the vulnerability.

Used in: VulnerabilityAffects

oneof choice
- string version = 1
  A single version of a component or service.
- string range = 2
  A version range specified in Package URL Version Range syntax (vers), which is defined at https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst
optional VulnerabilityAffectedStatus status = 3
The vulnerability status for the version or range of versions. Defaults to VULNERABILITY_AFFECTED_STATUS_AFFECTED if not specified.

Used in: Vulnerability

string ref = 1
References a component or service by the objects bom-ref
repeated VulnerabilityAffectedVersions versions = 2
Zero or more individual versions or range of versions.

Used in: Vulnerability

optional ImpactAnalysisState state = 1
Declares the current state of an occurrence of a vulnerability after automated or manual analysis.
optional ImpactAnalysisJustification justification = 2
The rationale of why the impact analysis state was asserted.
repeated VulnerabilityResponse response = 3
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.
optional string detail = 4
Detailed description of the impact, including methods used during the 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.
optional google.protobuf.Timestamp firstIssued = 5
The date and time (timestamp) when the analysis was first issued.
optional google.protobuf.Timestamp lastUpdated = 6
The date and time (timestamp) when the analysis was last updated.

Used in: Vulnerability

repeated OrganizationalEntity organizations = 1
The organizations credited with vulnerability discovery.
repeated OrganizationalContact individuals = 2
The individuals not associated with organizations that are credited with vulnerability discovery.

Used in: Vulnerability

optional Source source = 1
The source that calculated the severity or risk rating of the vulnerability.
optional double score = 2
The numerical score of the rating.
optional Severity severity = 3
Textual representation of the severity that corresponds to the numerical score of the rating.
optional ScoreMethod method = 4
Specifies the severity or risk scoring methodology or standard used.
optional string vector = 5
Textual representation of the metric values used to score the vulnerability.
optional string justification = 6
An optional reason for rating the vulnerability as it was.

Used in: Vulnerability

string id = 1
An identifier that uniquely identifies the vulnerability.
optional Source source = 2
The source that published the vulnerability.

Used in: VulnerabilityAnalysis

VULNERABILITY_RESPONSE_NULL = 0
unspecified value buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- `null` is our fallback, doubling `unspecified`
VULNERABILITY_RESPONSE_CAN_NOT_FIX = 1
Can not fix
VULNERABILITY_RESPONSE_WILL_NOT_FIX = 2
Will not fix
VULNERABILITY_RESPONSE_UPDATE = 3
Update to a different revision or release
VULNERABILITY_RESPONSE_ROLLBACK = 4
Revert to a previous revision or release
VULNERABILITY_RESPONSE_WORKAROUND_AVAILABLE = 5
There is a workaround available

A specialized orchestration task.

Used in: Formula

string bom_ref = 1
BOM unique reference to the resource.
string uid = 2
The unique identifier for the resource instance within its deployment context.
optional string name = 3
The name of the resource instance.
optional string description = 4
A description of the resource instance.
repeated Property properties = 5
Domain-specific resource instance properties.
repeated ResourceReferenceChoice resourceReferences = 6
References to component or service resources that are used to realize the resource instance.
repeated Task tasks = 7
The tasks that comprise the workflow.
repeated Dependency taskDependencies = 8
The graph of dependencies between tasks within the workflow.
repeated TaskType taskTypes = 9
Indicates the types of activities performed by the set of workflow tasks.
optional Trigger trigger = 10
The trigger that initiated the task.
repeated Step steps = 11
The sequence of steps for the task.
repeated InputType inputs = 12
Represents resources and data brought into a task at runtime by executor or task commands
repeated OutputType outputs = 13
Represents resources and data output from a task at runtime by executor or task commands
optional google.protobuf.Timestamp timeStart = 14
The date and time (timestamp) when the task started.
optional google.protobuf.Timestamp timeEnd = 15
The date and time (timestamp) when the task ended.
repeated Workspace workspaces = 16
A set of named filesystem or data resource shareable by workflow tasks.
repeated Dependency runtimeTopology = 17
A graph of the component runtime topology for workflow's instance.

A named filesystem or data resource shareable by workflow tasks.

Used in: Task, Workflow

string bom_ref = 1
BOM unique reference to the resource.
string uid = 2
The unique identifier for the resource instance within its deployment context.
optional string name = 3
The name of the resource instance.
repeated string aliases = 4
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.
optional string description = 5
A description of the resource instance.
repeated Property properties = 6
Domain-specific workspace instance properties.
repeated ResourceReferenceChoice resourceReferences = 7
References to component or service resources that are used to realize the resource instance.
optional Workspace.AccessMode accessMode = 8
Describes the read-write access control for the workspace relative to the owning resource instance.
optional string mountPath = 9
A path to a location on disk where the workspace will be available for the associated task's steps.
optional string managedDataType = 10
The name of a domain-specific data type the workspace represents.
optional string volumeRequest = 11
Identifies the reference to the request for a specific volume type and parameters.
optional Volume volume = 12
Information about the actual volume instance allocated to the workspace.

Used in: Workspace

ACCESS_MODE_READ_ONLY = 0
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error; it shall be fixed with v2.0 of this very schema
ACCESS_MODE_READ_WRITE = 1
ACCESS_MODE_READ_WRITE_ONCE = 2
ACCESS_MODE_WRITE_ONCE = 3
ACCESS_MODE_WRITE_ONLY = 4

package cyclonedx.v1_6

message Advisory

optional string title = 1

string url = 2

enum Aggregate

AGGREGATE_NOT_SPECIFIED = 0

AGGREGATE_COMPLETE = 1

AGGREGATE_INCOMPLETE = 2

AGGREGATE_INCOMPLETE_FIRST_PARTY_ONLY = 3

AGGREGATE_INCOMPLETE_THIRD_PARTY_ONLY = 4

AGGREGATE_UNKNOWN = 5

AGGREGATE_INCOMPLETE_FIRST_PARTY_PROPRIETARY_ONLY = 6

AGGREGATE_INCOMPLETE_FIRST_PARTY_OPENSOURCE_ONLY = 7

AGGREGATE_INCOMPLETE_THIRD_PARTY_PROPRIETARY_ONLY = 8

AGGREGATE_INCOMPLETE_THIRD_PARTY_OPENSOURCE_ONLY = 9

message Annotation

optional string bom_ref = 1

repeated string subjects = 2

optional AnnotatorChoice annotator = 3

optional google.protobuf.Timestamp timestamp = 4

string text = 5

message AnnotatorChoice

oneof choice

OrganizationalEntity organization = 1

OrganizationalContact individual = 2

Component component = 3

Service service = 4

message AttachedText

optional string content_type = 1

optional string encoding = 2

string value = 3

message Bom

string spec_version = 1

optional int32 version = 2

optional string serial_number = 3

optional Metadata metadata = 4

repeated Component components = 5

repeated Service services = 6

repeated ExternalReference external_references = 7

repeated Dependency dependencies = 8

repeated Composition compositions = 9

repeated Vulnerability vulnerabilities = 10

repeated Annotation annotations = 11

repeated Property properties = 12

repeated Formula formulation = 13

repeated Declarations declarations = 14

repeated Definition definitions = 15

message CO2MeasureType

float value = 1

CO2MeasureType.CO2MeasureUnitType unit = 2

enum CO2MeasureType.CO2MeasureUnitType

CO2_MEASURE_UNIT_TYPE_UNSPECIFIED = 0

CO2_MEASURE_UNIT_TYPE_TONNES_CO2_EQUIVALENT = 1

message Callstack

repeated Callstack.Frames frames = 1

message Callstack.Frames

optional string package = 1

string module = 2

optional string function = 3

repeated string parameters = 4

optional int32 line = 5

optional int32 column = 6

optional string fullFilename = 7

enum Classification

CLASSIFICATION_NULL = 0

CLASSIFICATION_APPLICATION = 1

CLASSIFICATION_FRAMEWORK = 2

CLASSIFICATION_LIBRARY = 3

CLASSIFICATION_OPERATING_SYSTEM = 4

CLASSIFICATION_DEVICE = 5

CLASSIFICATION_FILE = 6

CLASSIFICATION_CONTAINER = 7

CLASSIFICATION_FIRMWARE = 8

CLASSIFICATION_DEVICE_DRIVER = 9

CLASSIFICATION_PLATFORM = 10

CLASSIFICATION_MACHINE_LEARNING_MODEL = 11

CLASSIFICATION_DATA = 12

CLASSIFICATION_CRYPTOGRAPHIC_ASSET = 13

message Command

optional string executed = 1