package mondoo.sbom.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Asset represents a digital or physical resource in an IT environment. It could be software, hardware, or any identifiable entity within the infrastructure.

Used in: Sbom

• string name = 3

  'name' is a human-readable identifier for the asset. This field should contain a descriptive name that easily identifies the asset within the system.

• repeated string platform_ids = 4

  'platform_ids' are unique identifiers that represent the asset within various platforms. These IDs follow the MRN format and can point to specific resources within a given platform. Example formats include identifiers for AWS accounts or EC2 instances. Sample platform ids are: - //platformid.api.mondoo.app/runtime/aws/accounts/111222333444 - //platformid.api.mondoo.app/runtime/aws/ec2/v1/accounts/111222333444

• repeated ExternalID external_ids = 5

  'external_ids' are a collection of identifiers that link the asset to external systems or resources. Each external ID is associated with a type that specifies the kind of identifier (e.g., AWS account number, ARN).

• optional Platform platform = 6

  'platform' provides detailed information about the platform of the asset, such as operating system, architecture, and version.

• map<string, string> labels = 18

  'labels' are key-value pairs used for categorizing or annotating the asset. These labels are sourced from the system that is the asset owner. For example, labels for EC2 instance are populated from the EC2 metadata tags.

• string trace_id = 19

  'trace_id' is used to link the asset to a specific identifier that is passed in by the user. if the user provides no value, this will be empty.

Used in: Package

• EvidenceType type = 1

  'type' indicates the type of evidence, such as a file path.

• string value = 2

  'value' is the actual evidence that supports the presence of the package in the asset. The format and interpretation of this value depend on the 'type'. For example, it could be a file path for file evidence.

Used in: Evidence

• EVIDENCE_TYPE_UNSPECIFIED = 0

• EVIDENCE_TYPE_FILE = 1

ExternalID encapsulates an external identifier and its type. This structure is useful for referencing resources or entities that are external to the system or application using this data model.

Used in: Asset

• ExternalIDType type = 1

  'type' specifies the kind of external identifier being used, such as an AWS account number or an ARN. The type provides context to the 'id' field, indicating how the ID should be interpreted and used.

• string id = 2

  'id' is the actual identifier of the external resource. The format and interpretation of this ID depend on the 'type'. For example, it could be a numeric string for AWS account numbers or a structured string for ARNs. This ID is used to uniquely identify or reference an external entity or resource.

ExternalIDType enumerates the different types of external identifiers that can be used to reference external resources or entities. Each type corresponds to a specific kind of identifier, such as an AWS account number or an Amazon Resource Name (ARN).

Used in: ExternalID

• EXTERNAL_ID_TYPE_UNSPECIFIED = 0

  EXTERNAL_ID_UNSPECIFIED indicates an undefined or unknown type of external ID. This default value is used when the external ID type has not been set or is not applicable.

• EXTERNAL_ID_TYPE_AWS_ACCOUNT = 1

  EXTERNAL_ID_AWS_ACCOUNT represents an AWS account identifier. This type is used when the external ID refers specifically to an AWS account number, which is a unique identifier for an AWS account.

• EXTERNAL_ID_TYPE_AWS_ARN = 2

  EXTERNAL_ID_AWS_ARN denotes an Amazon Resource Name (ARN), a standardized format used by AWS to uniquely identify resources within the AWS ecosystem. ARNs are used in various AWS services to refer to specific resources like IAM roles, S3 buckets, or EC2 instances.

• EXTERNAL_ID_TYPE_AWS_ORG = 3

  EXTERNAL_ID_TYPE_AWS_ORG denotes the organization to which the AWS Account and all subresources belong.

• EXTERNAL_ID_TYPE_AZURE_SUB = 4

  EXTERNAL_ID_TYPE_AZURE_SUB represents an Azure subscription identifier. This type is used when the external ID refers specifically to an Azure subscription number, which is a unique identifier for an Azure subscription.

• EXTERNAL_ID_TYPE_AZURE_ID = 5

  EXTERNAL_ID_TYPE_AZURE_ID represents a fully qualified Azure resource identifier, a standarized format used by Azure to uniquely identify resources within the Azure ecosystem.

Source describes the provider of the BOM data, which in this case is the always Mondoo.

Used in: Sbom

• string vendor = 1

  The vendor name or the organization that provided the BOM.

• string name = 2

  The name of the product or service this BOM pertains to.

• string version = 3

  The version of the product or service.

• string url = 4

  The URL of the product or service.

Package details an individual software package or library.

Used in: Sbom

• string name = 1

  The name of the package.

• string version = 2

  The version of the package.

• string architecture = 3

  The architecture of the package

• repeated string cpes = 4

  The Common Platform Enumeration (CPE) name

• string purl = 5

  The Package URL (pURL), a standardized format for defining and locating software package metadata.

• string location = 6

  location on disk Deprecated: use evidence instead

• string type = 7

  'type' indicates the type of package, such as a rpm, dpkg, or gem.

• string description = 20

  description of the package

• repeated Evidence evidence_list = 21

  'evidence_list' is a collection of evidence that supports the presence of the package in the asset. This evidence could include eg. file paths

• string origin = 22

  Package Origin (e.g. other package name, or source of the package)

• string vendor = 23

  Package Vendor/Publisher

Platform describes the technical platform or environment of an asset. This could be an operating system, a hardware architecture, a cloud resource or another defining characteristic of the asset's environment.

Used in: Asset

• string name = 1

  The technical name of the platform, e.g., "amazonlinux".

• string arch = 3

  The architecture type, e.g., "x86_64".

• string title = 4

  A human-readable title of the platform, e.g., "Amazon Linux 2".

• repeated string family = 5

  Categories or families the platform belongs to, e.g., "linux", "unix". protolint:disable REPEATED_FIELD_NAMES_PLURALIZED

• string build = 6

  An optional field indicating the build number of the platform.

• string version = 7

  The version of the platform, e.g., "2".

• map<string, string> labels = 22

  'labels' are additional key-value pairs that provide more context or metadata about the platform.

• repeated string cpes = 23

  The Common Platform Enumeration (CPE) for the platform.

Sbom (Software Bill of Materials) represents a comprehensive inventory of software packages. It is a structured list of all software components that are part of a given asset, such as a virtual machine or container. The Sbom is used to identify known vulnerabilities and other security issues within the scanned asset.

• optional Generator generator = 1

  Details the tool used to generate the BOM. This includes information about the software or service that created the BOM, such as its name, version, and other relevant metadata.

• string timestamp = 2

  Indicates when the BOM was generated or last updated. It is expected to follow the RFC 3339 format. This timestamp is essential for maintaining the relevance of the BOM, as software components can frequently change.

• Status status = 3

  'status' is an optional field that denotes the current state or processing status of the BOM. It can indicate whether the BOM generation was successful, partially successful, or failed. This status helps in determining the reliability and completeness of the BOM.

• optional Asset asset = 4

  Represents the primary asset for which the BOM is created. This could be a virtual machine, a container, an application, or any other logical unit in the IT environment. The asset details the context or scope for which the software components in the BOM are relevant.

• repeated Package packages = 5

  'packages' is a list of all software packages or components included in the BOM. Each package entry contains detailed information such as the package name, version, and other identifiers. This list forms the core of the BOM, providing a detailed account of the software composition of the asset.

• string error_message = 6

  'error_message' is and optional field that describes the error from a failed scan

Status represents the possible states of processing or generation for a Bill of Materials (BOM). Each status indicates a different stage or outcome in the lifecycle of a BOM.

Used in: Sbom

• STATUS_UNSPECIFIED = 0

  UNSPECIFIED indicates an undefined status. This value is used as a default when the status has not been set or is unknown. It suggests that the SBOM's processing state is currently not available or has not been initialized.

• STATUS_SUCCEEDED = 1

  SUCCEEDED indicates that the BOM was successfully processed or generated without any issues. This status means that all components, packages, and materials listed in the BOM have been accounted for and validated, and the BOM is complete and accurate.

• STATUS_PARTIALLY_SUCCEEDED = 2

  PARTIALLY_SUCCEEDED indicates that the BOM was processed or generated with some minor issues or omissions. While the majority of the SBOM is accurate, there might be a few components or details that could not be fully validated or included. This status is typically used when the BOM is usable but might require additional review or subsequent updates to ensure completeness.

• STATUS_FAILED = 3

  FAILED indicates that the process of generating or processing the SBOM encountered significant issues, resulting in an incomplete or inaccurate document. This status is used when critical components or information are missing, preventing the BOM from being usable or reliable. A failed status typically requires a thorough review and reprocessing of the BOM.

• STATUS_STARTED = 4

  STARTED indicates that the SBOM scan was initialized. It is used for tracking progress of a scan over time.