Field | Type | Label | Description |
title | string | optional | An optional name of the advisory. |
url | string | Location where the advisory can be obtained. |
Field | Type | Label | Description |
bom_ref | string | optional | An optional identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref MUST be unique within the BOM. |
subjects | string | repeated | The object in the BOM identified by its bom-ref. This is often a component or service, but may be any object type supporting bom-refs. |
annotator | AnnotatorChoice | The organization, person, component, or service which created the textual content of the annotation. | |
timestamp | google.protobuf.Timestamp | The date and time (timestamp) when the annotation was created. | |
text | string | The textual content of the annotation. |
Field | Type | Label | Description |
organization | OrganizationalEntity | The organization that created the annotation | |
individual | OrganizationalContact | The person that created the annotation | |
component | Component | The tool or component that created the annotation | |
service | Service | The service that created the annotation |
Specifies attributes of the text
Field | Type | Label | Description |
content_type | string | optional | Specifies the content type of the text. Defaults to 'text/plain' if not specified. |
encoding | string | optional | Specifies the optional encoding the text is represented in |
value | string | SimpleContent value of element. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text. |
Field | Type | Label | Description |
spec_version | string | The version of the CycloneDX specification a BOM is written to (starting at version 1.3) | |
version | int32 | optional | 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'. |
serial_number | string | optional | 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. |
metadata | Metadata | optional | Provides additional information about a BOM. |
components | Component | repeated | Provides the ability to document a list of components. |
services | Service | repeated | Provides the ability to document a list of external services. |
external_references | ExternalReference | repeated | Provides the ability to document external references related to the BOM or to the project the BOM describes. |
dependencies | Dependency | repeated | Provides the ability to document dependency relationships. |
compositions | Composition | repeated | Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described. |
vulnerabilities | Vulnerability | repeated | Vulnerabilities identified in components or services. |
annotations | Annotation | repeated | 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. |
properties | Property | repeated | Specifies optional, custom, properties |
formulation | Formula | repeated | 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. |
Evidence of the components use through the callstack.
Field | Type | Label | Description |
frames | Callstack.Frames | repeated |
Field | Type | Label | Description |
package | string | optional | A package organizes modules into namespaces, providing a unique namespace for each type it contains. |
module | string | A module or class that encloses functions/methods and other code. | |
function | string | optional | A block of code designed to perform a particular task. |
parameters | string | repeated | Optional arguments that are passed to the module or function. |
line | int32 | optional | The line number the code that is called resides on. |
column | int32 | optional | The column the code that is called resides. |
fullFilename | string | optional | The full path and filename of the module. |
Field | Type | Label | Description |
executed | string | optional | A text representation of the executed command. |
properties | Property | repeated | Domain-specific command properties. |
Field | Type | Label | Description |
uid | string | optional | A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes. |
url | string | optional | The URL to the commit. This URL will typically point to a commit in a version control system. |
author | IdentifiableAction | optional | The author who created the changes in the commit |
committer | IdentifiableAction | optional | The person who committed or pushed the commit |
message | string | optional | The text description of the contents of the commit |
Field | Type | Label | Description |
type | Classification | Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component. | |
mime_type | string | optional | The 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. |
bom_ref | string | optional | 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. |
supplier | OrganizationalEntity | optional | The organization that supplied the component. The supplier may often be the manufacture, but may also be a distributor or repackager. |
author | string | optional | The person(s) or organization(s) that authored the component |
publisher | string | optional | The person(s) or organization(s) that published the component |
group | string | optional | The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org. |
name | string | The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery | |
version | string | 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. | |
description | string | optional | Specifies a description for the component |
scope | Scope | optional | Specifies the scope of the component. If scope is not specified, SCOPE_REQUIRED scope should be assumed by the consumer of the BOM |
hashes | Hash | repeated | |
licenses | LicenseChoice | repeated | EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression) |
copyright | string | optional | An optional copyright notice informing users of the underlying claims to copyright ownership in a published work. |
cpe | string | optional | 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 |
purl | string | optional | 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 |
swid | Swid | optional | Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags. |
modified | bool | optional | 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. |
pedigree | Pedigree | optional | Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. |
external_references | ExternalReference | repeated | Provides the ability to document external references related to the component or to the project the component describes. |
components | Component | repeated | 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. |
properties | Property | repeated | Specifies optional, custom, properties |
evidence | Evidence | repeated | Specifies optional license and copyright evidence |
releaseNotes | ReleaseNotes | optional | Specifies optional release notes. |
modelCard | ModelCard | optional | 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. |
data | ComponentData | optional | This object SHOULD be specified for any component of type `data` and MUST NOT be specified for other component types. |
Field | Type | Label | Description |
bom_ref | string | optional | An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref MUST be unique within the BOM. |
type | ComponentDataType | The general theme or subject matter of the data being specified. | |
name | string | optional | The name of the dataset. |
contents | ComponentData.ComponentDataContents | optional | The contents or references to the contents of the data being described. |
classification | string | optional | Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed. |
sensitiveData | string | repeated | A description of any sensitive data in a dataset. |
graphics | GraphicsCollection | optional | A collection of graphics that represent various measurements. |
description | string | optional | A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc. |
governance | DataGovernance | optional | Data Governance |
Field | Type | Label | Description |
attachment | AttachedText | optional | An optional way to include textual or encoded data. |
url | string | optional | The URL to where the data can be retrieved. |
properties | Property | repeated | Provides the ability to document name-value parameters used for configuration. |
Field | Type | Label | Description |
aggregate | Aggregate | Indicates the aggregate completeness | |
assemblies | string | repeated | The assemblies the aggregate completeness applies to |
dependencies | string | repeated | The dependencies the aggregate completeness applies to |
vulnerabilities | string | repeated | The bom-ref identifiers of the vulnerabilities being described. |
bom_ref | string | optional | 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.
Field | Type | Label | Description |
description | string | optional | Describes the set of conditions which cause the trigger to activate. |
expression | string | optional | The logical expression that was evaluated that determined the trigger should be fired. |
properties | Property | repeated | Domain-specific condition instance properties. |
Specifies the data flow.
Field | Type | Label | Description |
flow | DataFlowDirection | Specifies the flow direction of the data. | |
value | string | Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed. | |
name | string | optional | Name for the defined data |
description | string | optional | Short description of the data content and usage |
source | string | repeated | The URI, URL, or BOM-Link of the components or services the data came in from |
destination | string | repeated | The URI, URL, or BOM-Link of the components or services the data is sent to |
governance | DataGovernance | optional | Data Governance |
Field | Type | Label | Description |
custodians | DataGovernance.DataGovernanceResponsibleParty | repeated | Data custodians are responsible for the safe custody, transport, and storage of data. |
stewards | DataGovernance.DataGovernanceResponsibleParty | repeated | Data stewards are responsible for data content, context, and associated business rules. |
owners | DataGovernance.DataGovernanceResponsibleParty | repeated | Data owners are concerned with risk and appropriate access to data. |
Field | Type | Label | Description |
organization | OrganizationalEntity | ||
contact | OrganizationalContact |
Field | Type | Label | Description |
ref | string | References a component or service by the its bom-ref attribute | |
dependencies | Dependency | repeated |
Field | Type | Label | Description |
text | AttachedText | optional | Specifies the optional text of the diff |
url | string | optional | Specifies the URL to the diff |
Field | Type | Label | Description |
property | Property | ||
value | string |
Represents something that happened that may trigger a response.
Field | Type | Label | Description |
uid | string | optional | The unique identifier of the event. |
description | string | optional | A description of the event. |
timeReceived | google.protobuf.Timestamp | optional | The date and time (timestamp) when the event was received. |
data | AttachedText | optional | Encoding of the raw event data. |
source | ResourceReferenceChoice | optional | References the component or service that was the source of the event |
target | ResourceReferenceChoice | optional | References the component or service that was the target of the event |
properties | Property | repeated | Additional properties of the event. |
Field | Type | Label | Description |
licenses | LicenseChoice | repeated | EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression) |
copyright | EvidenceCopyright | repeated | |
identity | EvidenceIdentity | repeated | |
occurrences | EvidenceOccurrences | repeated | |
callstack | Callstack | optional |
Field | Type | Label | Description |
text | string | Copyright text |
Field | Type | Label | Description |
field | EvidenceFieldType | The identity field of the component which the evidence describes. | |
confidence | float | optional | The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence. |
methods | EvidenceMethods | repeated | The methods used to extract and/or analyze the evidence. |
tools | string | repeated | 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. |
Field | Type | Label | Description |
technique | EvidenceTechnique | The technique used in this method of analysis. | |
confidence | float | The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence. | |
value | string | optional | The value or contents of the evidence. |
Field | Type | Label | Description |
bom_ref | string | optional | An optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref MUST be unique within the BOM. |
location | string | The location or path to where the component was found. |
Field | Type | Label | Description |
type | ExternalReferenceType | 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. | |
url | string | The URL to the external reference | |
comment | string | optional | An optional comment describing the external reference |
hashes | Hash | repeated | Optional integrity hashes for the external resource content |
Describes workflows and resources that captures rules and other aspects of how the associated BOM component or service was formed.
Field | Type | Label | Description |
bom_ref | string | optional | BOM unique reference to the resource. |
components | Component | repeated | Transient components that are used in tasks that constitute one or more of this formula's workflows |
services | Service | repeated | Transient services that are used in tasks that constitute one or more of this formula's workflows |
workflows | Workflow | repeated | List of workflows that can be declared to accomplish specific orchestrated goals and independently triggered. |
properties | Property | repeated | Domain-specific formula properties. |
Field | Type | Label | Description |
description | string | optional | A description of this collection of graphics. |
graphic | GraphicsCollection.Graphic | repeated | A collection of graphics. |
Field | Type | Label | Description |
name | string | optional | The name of the graphic. |
image | AttachedText | optional | The graphic (vector or raster). Base64 encoding MUST be specified for binary images. |
Specifies the file hash of the component
Field | Type | Label | Description |
alg | HashAlg | Specifies the algorithm used to create the hash | |
value | string | SimpleContent value of element |
Field | Type | Label | Description |
timestamp | google.protobuf.Timestamp | optional | The timestamp in which the action occurred |
name | string | optional | The name of the individual who performed the action |
string | optional | The email address of the individual who performed the action |
Type that represents various input data types and formats.
Field | Type | Label | Description |
source | ResourceReferenceChoice | optional | A references to the component or service that provided the input to the task (e.g., reference to a service with data flow value of `inbound`) |
target | ResourceReferenceChoice | optional | A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace) |
resource | ResourceReferenceChoice | optional | A reference to an independent resource provided as an input to a task by the workflow runtime. |
parameters | Parameter | repeated | Inputs that have the form of parameters with names and values. |
environmentVars | EnvironmentVars | repeated | Inputs that have the form of parameters with names and values. |
data | AttachedText | optional | Inputs that have the form of data. |
properties | Property | repeated | Additional properties of the input data. |
Field | Type | Label | Description |
type | IssueClassification | Specifies the type of issue | |
id | string | optional | The identifier of the issue assigned by the source of the issue |
name | string | optional | The name of the issue |
description | string | optional | A description of the issue |
source | Source | optional | |
references | string | repeated |
Field | Type | Label | Description |
id | string | A valid SPDX license ID | |
name | string | If SPDX does not define the license used, this field may be used to provide the license name | |
text | AttachedText | optional | Specifies the optional full text of the attachment |
url | string | optional | The URL to the attachment file. If the attachment is a license or BOM, an externalReference should also be specified for completeness. |
bom_ref | string | optional | 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. |
licensing | Licensing | optional | Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata |
properties | Property | repeated | Specifies optional, custom, properties |
Field | Type | Label | Description |
license | License | ||
expression | string |
Field | Type | Label | Description |
altIds | string | repeated | License identifiers that may be used to manage licenses and their lifecycle |
licensor | OrganizationalEntityOrContact | optional | The individual or organization that grants a license to another individual or organization |
licensee | OrganizationalEntityOrContact | optional | The individual or organization for which a license was granted to |
purchaser | OrganizationalEntityOrContact | optional | The individual or organization that purchased the license |
purchaseOrder | string | optional | The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase |
licenseTypes | LicensingTypeEnum | repeated | The type of license(s) that was granted to the licensee |
lastRenewal | google.protobuf.Timestamp | optional | 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. |
expiration | google.protobuf.Timestamp | optional | The timestamp indicating when the current license expires (if applicable). |
Field | Type | Label | Description |
phase | LifecyclePhase | A pre-defined phase in the product lifecycle. | |
name | string | The name of the lifecycle phase | |
description | string | optional | The description of the lifecycle phase |
Field | Type | Label | Description |
timestamp | google.protobuf.Timestamp | optional | The date and time (timestamp) when the document was created. |
tools | Tool | optional | The tool(s) used in the creation of the BOM. |
authors | OrganizationalContact | repeated | The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors. |
component | Component | optional | The component that the BOM describes. |
manufacture | OrganizationalEntity | optional | The organization that manufactured the component that the BOM describes. |
supplier | OrganizationalEntity | optional | 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. |
licenses | LicenseChoice | optional | The license information for the BOM document EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression) |
properties | Property | repeated | Specifies optional, custom, properties |
lifecycles | Lifecycles | repeated | The product lifecycle(s) that this BOM represents. |
Field | Type | Label | Description |
bom_ref | string | optional | 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. |
modelParameters | ModelCard.ModelParameters | optional | Hyper-parameters for construction of the model. |
quantitativeAnalysis | ModelCard.QuantitativeAnalysis | optional | A quantitative analysis of the model |
considerations | ModelCard.ModelCardConsiderations | optional | What considerations should be taken into account regarding the model's construction, training, and application? |
Field | Type | Label | Description |
users | string | repeated | Who are the intended users of the model? |
useCases | string | repeated | What are the intended use cases of the model? |
technicalLimitations | string | repeated | What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance? |
performanceTradeoffs | string | repeated | What are the known tradeoffs in accuracy/performance of the model? |
ethicalConsiderations | ModelCard.ModelCardConsiderations.EthicalConsiderations | repeated | What are the ethical (or environmental) risks involved in the application of this model? |
fairnessAssessments | ModelCard.ModelCardConsiderations.FairnessAssessments | repeated | How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups? |
Field | Type | Label | Description |
name | string | optional | The name of the risk. |
mitigationStrategy | string | optional | Strategy used to address this risk. |
Field | Type | Label | Description |
groupAtRisk | string | optional | The groups or individuals at risk of being systematically disadvantaged by the model. |
benefits | string | optional | Expected benefits to the identified groups. |
harms | string | optional | Expected harms to the identified groups. |
mitigationStrategy | string | optional | With respect to the benefits and harms outlined, please describe any mitigation strategy implemented. |
Field | Type | Label | Description |
approach | ModelCard.ModelParameters.Approach | optional | The overall approach to learning used by the model for problem solving. |
task | string | optional | Directly influences the input and/or output. Examples include classification, regression, clustering, etc. |
architectureFamily | string | optional | The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc. |
modelArchitecture | string | optional | The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc. |
datasets | ModelCard.ModelParameters.Datasets | repeated | The datasets used to train and evaluate the model. |
inputs | ModelCard.ModelParameters.MachineLearningInputOutputParameters | repeated | The input format(s) of the model |
outputs | ModelCard.ModelParameters.MachineLearningInputOutputParameters | repeated | The output format(s) from the model |
Field | Type | Label | Description |
type | ModelParameterApproachType | optional |
Field | Type | Label | Description |
dataset | ComponentData | ||
ref | string | References a data component by the components bom-ref attribute |
Field | Type | Label | Description |
format | string | optional | The data format for input/output to the model. Example formats include string, image, time-series |
Field | Type | Label | Description |
performanceMetrics | ModelCard.QuantitativeAnalysis.PerformanceMetrics | repeated | The model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc. |
graphics | GraphicsCollection | optional |
Field | Type | Label | Description |
type | string | optional | The type of performance metric. |
value | string | optional | The value of the performance metric. |
slice | string | optional | The name of the slice this metric was computed on. By default, assume this metric is not sliced. |
confidenceInterval | ModelCard.QuantitativeAnalysis.PerformanceMetrics.ConfidenceInterval | optional | The confidence interval of the metric. |
Field | Type | Label | Description |
lowerBound | string | optional | The lower bound of the confidence interval. |
upperBound | string | optional | The upper bound of the confidence interval. |
Field | Type | Label | Description |
locale | string | optional | The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA". |
text | AttachedText | optional | Specifies the full content of the release note. |
Field | Type | Label | Description |
name | string | optional | The name of the contact |
string | optional | The email address of the contact. | |
phone | string | optional | The phone number of the contact. |
bom_ref | string | optional | 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. |
Field | Type | Label | Description |
name | string | optional | The name of the organization |
url | string | repeated | The URL of the organization. Multiple URLs are allowed. |
contact | OrganizationalContact | repeated | A contact person at the organization. Multiple contacts are allowed. |
bom_ref | string | optional | 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. |
Field | Type | Label | Description |
organization | OrganizationalEntity | ||
individual | OrganizationalContact |
Field | Type | Label | Description |
type | OutputType.OutputTypeType | optional | Describes the type of data output. |
source | ResourceReferenceChoice | optional | Component or service that generated or provided the output from the task (e.g., a build tool) |
target | ResourceReferenceChoice | optional | Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of `outbound`) |
resource | ResourceReferenceChoice | optional | A reference to an independent resource generated as output by the task. |
data | AttachedText | optional | Outputs that have the form of data. |
environmentVars | EnvironmentVars | repeated | Outputs that have the form of environment variables. |
properties | Property | repeated | Additional properties of the output data. |
A representation of a functional parameter.
Field | Type | Label | Description |
name | string | optional | The name of the parameter. |
value | string | optional | The value of the parameter. |
dataType | string | optional | The data type of the parameter. |
Field | Type | Label | Description |
type | PatchClassification | Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality | |
diff | Diff | optional | The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff |
resolves | Issue | repeated |
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.
Field | Type | Label | Description |
ancestors | Component | repeated | 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 a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from. |
descendants | Component | repeated | Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component. |
variants | Component | repeated | Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor. |
commits | Commit | repeated | A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant. |
patches | Patch | repeated | A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits. |
notes | string | optional | Notes, observations, and other non-structured commentary describing the components pedigree. |
Field | Type | Label | Description |
reproductionSteps | string | optional | Precise steps to reproduce the vulnerability. |
environment | string | optional | A description of the environment in which reproduction was possible. |
supportingMaterial | AttachedText | repeated | Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code. |
Specifies a property
Field | Type | Label | Description |
name | string | ||
value | string | optional |
Field | Type | Label | Description |
type | string | 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. | |
title | string | optional | The title of the release. |
featuredImage | string | optional | The URL to an image that may be prominently displayed with the release note. |
socialImage | string | optional | The URL to an image that may be used in messaging on social media platforms. |
description | string | optional | A short description of the release. |
timestamp | google.protobuf.Timestamp | optional | The date and time (timestamp) when the release note was created. |
aliases | string | repeated | Optional alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names). |
tags | string | repeated | Optional tags that may aid in search or retrieval of the release note. |
resolves | Issue | repeated | A collection of issues that have been resolved. |
notes | Note | repeated | 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. |
properties | Property | repeated | Specifies optional, custom, properties |
Field | Type | Label | Description |
ref | string | ||
externalReference | ExternalReference |
Field | Type | Label | Description |
bom_ref | string | optional | 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. |
provider | OrganizationalEntity | optional | The organization that provides the service. |
group | string | optional | The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided. |
name | string | The name of the service. This will often be a shortened, single name of the service. | |
version | string | optional | The service version. |
description | string | optional | Specifies a description for the service. |
endpoints | string | repeated | |
authenticated | bool | optional | A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication. |
x_trust_boundary | bool | optional | A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed. |
data | DataFlow | repeated | |
licenses | LicenseChoice | repeated | EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression) |
external_references | ExternalReference | repeated | Provides the ability to document external references related to the service. |
services | Service | repeated | 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. |
properties | Property | repeated | Specifies optional, custom, properties |
releaseNotes | ReleaseNotes | optional | Specifies optional release notes. |
trustZone | string | optional | The name of the trust zone the service resides in. |
The source of the issue where it is documented.
Field | Type | Label | Description |
name | string | optional | The name of the source. For example "National Vulnerability Database", "NVD", and "Apache" |
url | string | optional | 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.
Field | Type | Label | Description |
name | string | optional | A name for the step. |
description | string | optional | A description of the step. |
commands | Command | repeated | Ordered list of commands or directives for the step |
properties | Property | repeated | Domain-specific step properties. |
Field | Type | Label | Description |
tag_id | string | Maps to the tagId of a SoftwareIdentity. | |
name | string | Maps to the name of a SoftwareIdentity. | |
version | string | optional | Maps to the version of a SoftwareIdentity. Defaults to '0.0' if not specified. |
tag_version | int32 | optional | Maps to the tagVersion of a SoftwareIdentity. Defaults to '0' if not specified. |
patch | bool | optional | Maps to the patch of a SoftwareIdentity. Defaults to 'false' if not specified. |
text | AttachedText | optional | Specifies the full content of the SWID tag. |
url | string | optional | The URL to the SWID file. |
Describes the inputs, sequence of steps and resources used to accomplish a task and its output.
Field | Type | Label | Description |
bom_ref | string | BOM unique reference to the resource. | |
uid | string | The unique identifier for the resource instance within its deployment context. | |
name | string | optional | The name of the resource instance. |
description | string | optional | A description of the resource instance. |
properties | Property | repeated | Domain-specific task instance properties. |
resourceReferences | ResourceReferenceChoice | repeated | References to component or service resources that are used to realize the resource instance. |
taskTypes | TaskType | repeated | Indicates the types of activities performed by the set of workflow tasks. |
trigger | Trigger | optional | The trigger that initiated the task. |
steps | Step | repeated | "The sequence of steps for the task. |
inputs | InputType | repeated | Represents resources and data brought into a task at runtime by executor or task commands |
outputs | OutputType | repeated | Represents resources and data output from a task at runtime by executor or task commands |
timeStart | google.protobuf.Timestamp | optional | The date and time (timestamp) when the task started. |
timeEnd | google.protobuf.Timestamp | optional | The date and time (timestamp) when the task ended. |
workspaces | Workspace | repeated | A set of named filesystem or data resource shareable by workflow tasks. |
runtimeTopology | Dependency | repeated | A graph of the component runtime topology for task's instance. |
Specifies a tool (manual or automated).
Field | Type | Label | Description |
vendor | string | optional | Deprecated. DEPRECATED - DO NOT USE - The vendor of the tool used to create the BOM. |
name | string | optional | Deprecated. DEPRECATED - DO NOT USE - The name of the tool used to create the BOM. |
version | string | optional | Deprecated. DEPRECATED - DO NOT USE - The version of the tool used to create the BOM. |
hashes | Hash | repeated | Deprecated. DEPRECATED - DO NOT USE |
external_references | ExternalReference | repeated | Deprecated. DEPRECATED - DO NOT USE - Provides the ability to document external references related to the tool. |
components | Component | repeated | A list of software and hardware components used as tools |
services | Service | repeated | A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services. |
Name | Option |
vendor | true |
name | true |
version | true |
hashes | true |
external_references | true |
Represents a resource that can conditionally activate (or fire) tasks based upon associated events and their data.
Field | Type | Label | Description |
bom_ref | string | BOM unique reference to the resource. | |
uid | string | The unique identifier for the resource instance within its deployment context. | |
name | string | optional | The name of the resource instance. |
description | string | optional | A description of the resource instance. |
properties | Property | repeated | Additional properties of the trigger. |
resourceReferences | ResourceReferenceChoice | repeated | References to component or service resources that are used to realize the resource instance. |
type | Trigger.TriggerType | The source type of event which caused the trigger to fire. | |
event | Event | optional | The event data that caused the associated trigger to activate. |
conditions | Condition | repeated | Conditions |
timeActivated | google.protobuf.Timestamp | optional | The date and time (timestamp) when the trigger was activated. |
inputs | InputType | repeated | Represents resources and data brought into a task at runtime by executor or task commands |
outputs | OutputType | repeated | Represents resources and data output from a task at runtime by executor or task commands |
An identifiable, logical unit of data storage tied to a physical device.
Field | Type | Label | Description |
uid | string | optional | The unique identifier for the volume instance within its deployment context. |
name | string | optional | The name of the volume instance |
mode | Volume.VolumeMode | optional | The volume mode for the volume instance. |
path | string | optional | The underlying path created from the actual volume. |
sizeAllocated | string | optional | The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as IEC standard unit in either decimal or binary form. |
persistent | bool | optional | Indicates if the volume persists beyond the life of the resource it is associated with. |
remote | bool | optional | Indicates if the volume is remotely (i.e., network) attached. |
properties | Property | repeated | Domain-specific volume instance properties. |
Field | Type | Label | Description |
bom_ref | string | optional | 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. |
id | string | optional | The identifier that uniquely identifies the vulnerability. |
source | Source | optional | The source that published the vulnerability. |
references | VulnerabilityReference | repeated | Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence. |
ratings | VulnerabilityRating | repeated | List of vulnerability ratings |
cwes | int32 | repeated | List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability. For example 399 (of https://cwe.mitre.org/data/definitions/399.html) |
description | string | optional | A description of the vulnerability as provided by the source. |
detail | string | optional | If available, an in-depth description of the vulnerability as provided by the source organization. Details often include information useful in understanding root cause. |
recommendation | string | optional | Recommendations of how the vulnerability can be remediated or mitigated. |
advisories | Advisory | repeated | Published advisories of the vulnerability if provided. |
created | google.protobuf.Timestamp | optional | The date and time (timestamp) when the vulnerability record was created in the vulnerability database. |
published | google.protobuf.Timestamp | optional | The date and time (timestamp) when the vulnerability record was first published. |
updated | google.protobuf.Timestamp | optional | The date and time (timestamp) when the vulnerability record was last updated. |
credits | VulnerabilityCredits | optional | Individuals or organizations credited with the discovery of the vulnerability. |
tools | Tool | optional | The tool(s) used to identify, confirm, or score the vulnerability. |
analysis | VulnerabilityAnalysis | optional | An assessment of the impact and exploitability of the vulnerability. |
affects | VulnerabilityAffects | repeated | affects |
properties | Property | repeated | Specifies optional, custom, properties |
rejected | google.protobuf.Timestamp | optional | The date and time (timestamp) when the vulnerability record was rejected (if applicable). |
proofOfConcept | ProofOfConcept | optional | Evidence used to reproduce the vulnerability. |
workaround | string | optional | A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments. |
Field | Type | Label | Description |
version | string | A single version of a component or service. | |
range | string | 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 | |
status | VulnerabilityAffectedStatus | optional | The vulnerability status for the version or range of versions. Defaults to VULNERABILITY_AFFECTED_STATUS_AFFECTED if not specified. |
Field | Type | Label | Description |
ref | string | References a component or service by the objects bom-ref | |
versions | VulnerabilityAffectedVersions | repeated | Zero or more individual versions or range of versions. |
Field | Type | Label | Description |
state | ImpactAnalysisState | optional | Declares the current state of an occurrence of a vulnerability, after automated or manual analysis. |
justification | ImpactAnalysisJustification | optional | The rationale of why the impact analysis state was asserted. |
response | VulnerabilityResponse | repeated | A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable. |
detail | string | optional | Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability. |
firstIssued | google.protobuf.Timestamp | optional | The date and time (timestamp) when the analysis was first issued. |
lastUpdated | google.protobuf.Timestamp | optional | The date and time (timestamp) when the analysis was last updated. |
Field | Type | Label | Description |
organizations | OrganizationalEntity | repeated | The organizations credited with vulnerability discovery. |
individuals | OrganizationalContact | repeated | The individuals, not associated with organizations, that are credited with vulnerability discovery. |
Field | Type | Label | Description |
source | Source | optional | The source that calculated the severity or risk rating of the vulnerability. |
score | double | optional | The numerical score of the rating. |
severity | Severity | optional | Textual representation of the severity that corresponds to the numerical score of the rating. |
method | ScoreMethod | optional | Specifies the severity or risk scoring methodology or standard used. |
vector | string | optional | Textual representation of the metric values used to score the vulnerability. |
justification | string | optional | An optional reason for rating the vulnerability as it was. |
Field | Type | Label | Description |
id | string | An identifier that uniquely identifies the vulnerability. | |
source | Source | The source that published the vulnerability. |
A specialized orchestration task.
Field | Type | Label | Description |
bom_ref | string | BOM unique reference to the resource. | |
uid | string | The unique identifier for the resource instance within its deployment context. | |
name | string | optional | The name of the resource instance. |
description | string | optional | A description of the resource instance. |
properties | Property | repeated | Domain-specific resource instance properties. |
resourceReferences | ResourceReferenceChoice | repeated | References to component or service resources that are used to realize the resource instance. |
tasks | Task | repeated | The tasks that comprise the workflow. |
taskDependencies | Dependency | repeated | The graph of dependencies between tasks within the workflow. |
taskTypes | TaskType | repeated | Indicates the types of activities performed by the set of workflow tasks. |
trigger | Trigger | optional | The trigger that initiated the task. |
steps | Step | repeated | The sequence of steps for the task. |
inputs | InputType | repeated | Represents resources and data brought into a task at runtime by executor or task commands |
outputs | OutputType | repeated | Represents resources and data output from a task at runtime by executor or task commands |
timeStart | google.protobuf.Timestamp | optional | The date and time (timestamp) when the task started. |
timeEnd | google.protobuf.Timestamp | optional | The date and time (timestamp) when the task ended. |
workspaces | Workspace | repeated | A set of named filesystem or data resource shareable by workflow tasks. |
runtimeTopology | Dependency | repeated | A graph of the component runtime topology for workflow's instance. |
A named filesystem or data resource shareable by workflow tasks.
Field | Type | Label | Description |
bom_ref | string | BOM unique reference to the resource. | |
uid | string | The unique identifier for the resource instance within its deployment context. | |
name | string | optional | The name of the resource instance. |
aliases | string | repeated | The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps. |
description | string | optional | A description of the resource instance. |
properties | Property | repeated | Domain-specific workspace instance properties. |
resourceReferences | ResourceReferenceChoice | repeated | References to component or service resources that are used to realize the resource instance. |
accessMode | Workspace.AccessMode | optional | Describes the read-write access control for the workspace relative to the owning resource instance. |
mountPath | string | optional | A path to a location on disk where the workspace will be available to the associated task's steps. |
managedDataType | string | optional | The name of a domain-specific data type the workspace represents. |
volumeRequest | string | optional | Identifies the reference to the request for a specific volume type and parameters. |
volume | Volume | optional | Information about the actual volume instance allocated to the workspace. |
Name | Number | Description |
AGGREGATE_NOT_SPECIFIED | 0 | The relationship completeness is not specified. |
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. |
Name | Number | Description |
CLASSIFICATION_NULL | 0 | |
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. |
Name | Number | Description |
COMPONENT_DATA_TYPE_SOURCE_CODE | 0 | Any type of code, code snippet, or data-as-code |
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. |
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.
Name | Number | Description |
DATA_FLOW_NULL | 0 | |
DATA_FLOW_INBOUND | 1 | |
DATA_FLOW_OUTBOUND | 2 | |
DATA_FLOW_BI_DIRECTIONAL | 3 | |
DATA_FLOW_UNKNOWN | 4 |
Name | Number | Description |
EVIDENCE_FIELD_NULL | 0 | |
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 |
Name | Number | Description |
EVIDENCE_TECHNIQUE_SOURCE_CODE_ANALYSIS | 0 | |
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 |
Name | Number | Description |
EXTERNAL_REFERENCE_TYPE_OTHER | 0 | Use this if no other types accurately describe the purpose of the external reference |
EXTERNAL_REFERENCE_TYPE_VCS | 1 | Version Control System |
EXTERNAL_REFERENCE_TYPE_ISSUE_TRACKER | 2 | Issue or 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 to. 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) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization |
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 (POAM) compliment an "attestation" external reference. POAM 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. |
Name | Number | Description |
HASH_ALG_NULL | 0 | |
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 |
Name | Number | Description |
IMPACT_ANALYSIS_JUSTIFICATION_NULL | 0 | An undefined impact analysis justification |
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. |
Name | Number | Description |
IMPACT_ANALYSIS_STATE_NULL | 0 | An undefined impact analysis state |
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 are 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. |
Name | Number | Description |
ISSUE_CLASSIFICATION_NULL | 0 | |
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 |
Name | Number | Description |
LICENSING_TYPE_NULL | 0 | |
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. |
Name | Number | Description |
LIFECYCLE_PHASE_DESIGN | 0 | BOM produced early in the development lifecycle containing 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. |
LIFECYCLE_PHASE_PRE_BUILD | 1 | BOM consisting of information obtained prior to a build process and may contain source files and development artifacts and manifests. The inventory may need to be resolved and retrieved prior to use. |
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. |
Name | Number | Description |
MODEL_PARAMETER_APPROACH_TYPE_SUPERVISED | 0 | |
MODEL_PARAMETER_APPROACH_TYPE_UNSUPERVISED | 1 | |
MODEL_PARAMETER_APPROACH_TYPE_REINFORCED_LEARNING | 2 | |
MODEL_PARAMETER_APPROACH_TYPE_SEMI_SUPERVISED | 3 | |
MODEL_PARAMETER_APPROACH_TYPE_SELF_SUPERVISED | 4 |
Name | Number | Description |
OUTPUT_TYPE_ARTIFACT | 0 | |
OUTPUT_TYPE_ATTESTATION | 1 | |
OUTPUT_TYPE_LOG | 2 | |
OUTPUT_TYPE_EVIDENCE | 3 | |
OUTPUT_TYPE_METRICS | 4 | |
OUTPUT_TYPE_OTHER | 5 |
Name | Number | Description |
PATCH_CLASSIFICATION_NULL | 0 | |
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. |
Name | Number | Description |
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 be 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. |
Name | Number | Description |
SCORE_METHOD_NULL | 0 | An undefined score method |
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 v3.1 - https://www.first.org/cvss/v4-0/ |
SCORE_METHOD_SSVC | 7 | Stakeholder Specific Vulnerability Categorization (all versions) - https://github.com/CERTCC/SSVC |
Name | Number | Description |
SEVERITY_UNKNOWN | 0 | |
SEVERITY_CRITICAL | 1 | |
SEVERITY_HIGH | 2 | |
SEVERITY_MEDIUM | 3 | |
SEVERITY_LOW | 4 | |
SEVERITY_INFO | 5 | |
SEVERITY_NONE | 6 |
Name | Number | Description |
TASK_TYPE_COPY | 0 | |
TASK_TYPE_CLONE | 1 | |
TASK_TYPE_LINT | 2 | |
TASK_TYPE_SCAN | 3 | |
TASK_TYPE_MERGE | 4 | |
TASK_TYPE_BUILD | 5 | |
TASK_TYPE_TEST | 6 | |
TASK_TYPE_DELIVER | 7 | |
TASK_TYPE_DEPLOY | 8 | |
TASK_TYPE_RELEASE | 9 | |
TASK_TYPE_CLEAN | 10 | |
TASK_TYPE_OTHER | 11 |
Name | Number | Description |
TRIGGER_TYPE_MANUAL | 0 | |
TRIGGER_TYPE_API | 1 | |
TRIGGER_TYPE_WEBHOOK | 2 | |
TRIGGER_TYPE_SCHEDULED | 3 |
Name | Number | Description |
VOLUME_MODE_FILESYSTEM | 0 | |
VOLUME_MODE_BLOCK | 1 |
Name | Number | Description |
VULNERABILITY_AFFECTED_STATUS_UNKNOWN | 0 | 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. |
VULNERABILITY_AFFECTED_STATUS_AFFECTED | 1 | |
VULNERABILITY_AFFECTED_STATUS_NOT_AFFECTED | 2 |
Name | Number | Description |
VULNERABILITY_RESPONSE_NULL | 0 | |
VULNERABILITY_RESPONSE_CAN_NOT_FIX | 1 | |
VULNERABILITY_RESPONSE_WILL_NOT_FIX | 2 | |
VULNERABILITY_RESPONSE_UPDATE | 3 | |
VULNERABILITY_RESPONSE_ROLLBACK | 4 | |
VULNERABILITY_RESPONSE_WORKAROUND_AVAILABLE | 5 |
Name | Number | Description |
ACCESS_MODE_READ_ONLY | 0 | |
ACCESS_MODE_READ_WRITE | 1 | |
ACCESS_MODE_READ_WRITE_ONCE | 2 | |
ACCESS_MODE_WRITE_ONCE | 3 | |
ACCESS_MODE_WRITE_ONLY | 4 |
.proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
double | double | double | float | float64 | double | float | Float | |
float | float | float | float | float32 | float | float | Float | |
int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |