This API is a prerequisite for leveraging Artifact Analysis scanning capabilities in both Artifact Registry and with Advanced Vulnerability Insights (runtime scanning) in GKE. In addition, the Container Analysis API is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts.

An alias to a repo revision.

Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.

Artifact describes a build product.

Assessment provides all information that is related to a single vulnerability for this product.

Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one Authority for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project.

Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign.

Request to create notes in batch.

Response for creating notes in batch.

Request to create occurrences in batch.

Response for creating occurrences in batch.

Associates members, or principals, with a role.

Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence.

Details of a build occurrence.

Provenance of a build. Contains all information needed to verify the full details about the build from source to completion.

A step in the build pipeline. Next ID: 21

The category to which the update belongs.

A compliance check that is a CIS benchmark.

A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo.

Empty placeholder to denote that this is a Google Cloud Storage export request.

Command describes a step performed as part of the build pipeline.

Indicates that the builder claims certain fields in this message to be complete.

An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason.

Describes the CIS benchmark version that is applicable to a given OS and os version.

ApprovalConfig describes configuration for manual approval of a build.

ApprovalResult describes the decision and associated metadata of a manual approval of a build.

Artifacts produced by a build that should be uploaded upon successful completion of all build steps.

Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.

A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.

Npm package to upload to Artifact Registry upon successful completion of all build steps.

Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.

A build resource in the Cloud Build API. At a high level, a Build describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build.

• $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

BuildApproval describes a build's approval configuration, state, and result.

A fatal problem encountered during the execution of the build.

Optional arguments to enable specific features of builds.

Details about how a build should be executed on a WorkerPool. See running builds in a private pool for more information.

A step in the build pipeline.

A non-fatal problem encountered during the execution of the build.

An image built by the pipeline.

Location of the source in a 2nd-gen Google Cloud Build repository resource.

Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.

Location of the source in any accessible Git repository.

Container message for hash values.

Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.

Location of the source in a Google Cloud Source Repository.

Artifacts created by the build pipeline.

Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use kmsKeyName with available_secrets instead of using kmsKeyName with secret. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.

Pairs a secret environment variable with a SecretVersion in Secret Manager.

Secrets and secret environment variables.

Location of the source in a supported storage service.

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.

Location of the source in an archive file in Cloud Storage.

Location of the source manifest in Cloud Storage. This feature is in Preview; see description here.

Start and end times for a build execution phase.

A Maven artifact uploaded using the MavenArtifact directive.

An npm package uploaded to Artifact Registry using the NpmPackage directive.

Artifact uploaded using the PythonPackage directive.

Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version.

Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document

An artifact that can be deployed in some runtime.

The period during which some deployable was active in a runtime.

A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).

Digest information.

A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A Discovery occurrence is created in a consumer's project at the start of analysis.

Provides information about the analysis status of a discovered resource.

This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.

Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence.

This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type.

The request to generate and export SBOM. Target must be specified for the request.

The response from a call to ExportSBOM.

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.

A set of properties that uniquely identify a given Docker image.

Per resource and severity counts of fixable and total vulnerabilities.

A SourceContext referring to a Gerrit project.

Request message for GetIamPolicy method.

Encapsulates settings provided to GetIamPolicy.

A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub).

Metadata for all operations used and required for all operations that created by Container Analysis Providers

Indicates the location at which a package was found.

Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.

Indicates that the builder claims certain fields in this message to be complete.

Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.

Identifies the event that kicked off the build.

The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.

Other properties of the build.

Container message for hash values.

This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify.

The unique identifier of the update.

Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url.

Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM .

Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json".

Justification provides the justification when the state of the assessment if NOT_AFFECTED.

Layer holds metadata specific to a layer of a Docker image.

License information.

Response for listing occurrences for a note.

Response for listing notes.

Response for listing occurrences.

An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in /var/lib/dpkg/status.

Other properties of the build.

Details about files that caused a compliance check to fail. display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'.

A type of analysis that can be done for a resource.

An instance of an analysis type that has been found on a resource.

A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).

PackageNote represents a particular package version.

Details on how a particular software package was installed on a system.

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: ``` bindings: - members:

• user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the IAM documentation.

Product contains information about a product and how to uniquely identify it.

Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project.

Additional options for ContainerAnalysis#projectsLocationsNotesList.

Additional options for ContainerAnalysis#projectsLocationsNotesOccurrencesList.

Additional options for ContainerAnalysis#projectsLocationsOccurrencesGetVulnerabilitySummary.

Additional options for ContainerAnalysis#projectsLocationsOccurrencesList.

Additional options for ContainerAnalysis#projectsNotesCreate.

Additional options for ContainerAnalysis#projectsNotesList.

Additional options for ContainerAnalysis#projectsNotesOccurrencesList.

Additional options for ContainerAnalysis#projectsNotesPatch.

Additional options for ContainerAnalysis#projectsOccurrencesGetVulnerabilitySummary.

Additional options for ContainerAnalysis#projectsOccurrencesList.

Additional options for ContainerAnalysis#projectsOccurrencesPatch.

Publisher contains information about the publisher of this Note.

Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe.

Metadata for any related URL information.

Specifies details on how to handle (and presumably, fix) a vulnerability.

A unique identifier for a Cloud Repo.

The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details.

A predicate which describes the SBOM being referenced.

The note representing an SBOM reference.

The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details.

The status of an SBOM generation.

Request message for SetIamPolicy method.

Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from public_key_id to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature public_key_id as anything more than a key lookup hint. The public_key_id DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The public_key_id is not recognized by the verifier. * The public key that public_key_id refers to does not verify the signature with respect to the payload. The signature contents SHOULD NOT be "attached" (where the payload is included with the serialized signature bytes). Verifiers MUST ignore any "attached" payload and only verify signatures with respect to explicitly provided payload (e.g. a payload field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature).

Indicates that the builder claims certain fields in this message to be complete.

Other properties of the build.

Keep in sync with schema at https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder renamed to ProvenanceBuilder because of Java conflicts.

See full explanation of fields at slsa.dev/provenance/v0.2.

Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe.

Source describes the location of the source used for the build.

A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

Start and end times for a build execution phase. Next ID: 3

The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.

An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update.

An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update.

Version contains structured information about the version of a package.

VexAssessment provides all publisher provided Vex information that is related to this vulnerability.

Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. Next ID: 3

A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE.

A security vulnerability that can be found in resources.

An occurrence of a severity vulnerability on a resource.

A summary of how many vulnerability occurrences there are per resource and severity type.

Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate.