Skip to content

Proto schema

Messages

Component

Field Type Description
uuid string UUID of the component.
group string Group / namespace of the component.
name string Name of the component.
version string Version of the component.
classifier string Classifier / type of the component. May be any of: - APPLICATION - CONTAINER - DEVICE - FILE - FIRMWARE - FRAMEWORK - LIBRARY - OPERATING_SYSTEM
cpe string CPE of the component. https://csrc.nist.gov/projects/security-content-automation-protocol/specifications/cpe
purl string Package URL of the component. https://github.com/package-url/purl-spec
swid_tag_id string SWID tag ID of the component. https://csrc.nist.gov/projects/Software-Identification-SWID
is_internal bool Whether the component is internal to the organization.
properties Component.Property[] Properties of the component.
md5 string
sha1 string
sha256 string
sha384 string
sha512 string
sha3_256 string
sha3_384 string
sha3_512 string
blake2b_256 string
blake2b_384 string
blake2b_512 string
blake3 string
license_name string
license_expression string
resolved_license License
published_at google.protobuf.Timestamp When the current version was published. NOTE: The platform resolves this information asynchronously, so it is not guaranteed to be available immediately. Policies should explicitly check presence using the has() macro.
latest_version string Latest available version. NOTE: The platform resolves this information asynchronously, so it is not guaranteed to be available immediately. Policies should explicitly check presence using the has() macro.
package_artifact_md5 string MD5 hash of the corresponding package artifact as reported by its upstream repository. NOTE: The platform resolves this information asynchronously, so it is not guaranteed to be available immediately. Policies should explicitly check presence using the has() macro.
package_artifact_sha1 string SHA-1 hash of the corresponding package artifact as reported by its upstream repository. NOTE: The platform resolves this information asynchronously, so it is not guaranteed to be available immediately. Policies should explicitly check presence using the has() macro.
package_artifact_sha256 string SHA-256 hash of the corresponding package artifact as reported by its upstream repository. NOTE: The platform resolves this information asynchronously, so it is not guaranteed to be available immediately. Policies should explicitly check presence using the has() macro.
package_artifact_sha512 string SHA-512 hash of the corresponding package artifact as reported by its upstream repository. NOTE: The platform resolves this information asynchronously, so it is not guaranteed to be available immediately. Policies should explicitly check presence using the has() macro.
latest_version_published_at google.protobuf.Timestamp When the latest version was published. NOTE: The platform resolves this information asynchronously, so it is not guaranteed to be available immediately. Policies should explicitly check presence using the has() macro.

Component.Property

Field Type Description
group string
name string
value string
type string

License

Field Type Description
uuid string
id string
name string
groups License.Group[]
is_osi_approved bool
is_fsf_libre bool
is_deprecated_id bool
is_custom bool

License.Group

Field Type Description
uuid string
name string

Project

Field Type Description
uuid string
group string
name string
version string
classifier string
is_active bool
tags string[]
properties Project.Property[]
cpe string
purl string
swid_tag_id string
last_bom_import google.protobuf.Timestamp
metadata Project.Metadata

Project.Metadata

Field Type Description
tools Tools
bom_generated google.protobuf.Timestamp

Project.Property

Field Type Description
group string
name string
value string
type string

Tools

Field Type Description
components Component[] Components used as tools.

VersionDistance

Field Type Description
epoch string
major string
minor string
patch string

Vulnerability

Field Type Description
uuid string
id string
source string
aliases Vulnerability.Alias[]
cwes int32[]
created google.protobuf.Timestamp
published google.protobuf.Timestamp
updated google.protobuf.Timestamp
severity string
cvssv2_base_score double
cvssv2_impact_subscore double
cvssv2_exploitability_subscore double
cvssv2_vector string
cvssv3_base_score double
cvssv3_impact_subscore double
cvssv3_exploitability_subscore double
cvssv3_vector string
owasp_rr_likelihood_score double
owasp_rr_technical_impact_score double
owasp_rr_business_impact_score double
owasp_rr_vector string
epss_score double
epss_percentile double
cvssv4_vector string
cvssv4_score double

Vulnerability.Alias

Field Type Description
id string
source string