API Reference google_api_on_demand_scanning v0.3.0

Modules

API client metadata for GoogleApi.OnDemandScanning.V1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.OnDemandScanning.V1.

AnalyzePackagesMetadata contains metadata for an active scan of a container image.

AnalyzePackagesMetadata contains metadata for an active scan of a container image.

AnalyzePackagesRequest is the request to analyze a list of packages and create Vulnerability Occurrences for it.

AnalyzePackagesResponse contains the information necessary to find results for the given scan.

AnalyzePackagesResponse contains the information necessary to find results for the given scan.

Artifact describes a build product.

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.

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

Attributes

  • id (type: String.t, default: nil) -

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 multiple versions of CVSS. The intention is that as new versions of CVSS scores get added, we will be able to modify this message rather than adding new protos for each new version of the score.

The category to which the update belongs.

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

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.

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

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

Provides information about the analysis status of a discovered resource.

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); } The JSON representation for Empty is empty JSON object {}.

Attributes

  • keyid (type: String.t, default: nil) -
  • sig (type: String.t, default: nil) -

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.

A SourceContext referring to a Gerrit project.

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

Container message for hash values.

The unique identifier of the update.

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

Attributes

  • builderConfig (type: GoogleApi.OnDemandScanning.V1.Model.BuilderConfig.t, default: nil) - required
  • materials (type: list(String.t), default: nil) - The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
  • metadata (type: GoogleApi.OnDemandScanning.V1.Model.Metadata.t, default: nil) -
  • recipe (type: GoogleApi.OnDemandScanning.V1.Model.Recipe.t, default: nil) - Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required

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

Attributes

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

The response message for Operations.ListOperations.

ListVulnerabilitiesResponse contains a single page of vulnerabilities resulting from a scan.

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

Attributes

  • digest (type: map(), default: nil) -
  • uri (type: String.t, default: nil) -

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

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

This resource represents a long-running operation that is the result of a network API call.

Attributes

  • cpeUri (type: String.t, default: nil) - The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability may manifest. Examples include distro or storage location for vulnerable jar.
  • os (type: String.t, default: nil) - The OS affected by a vulnerability This field is deprecated and the information is in cpe_uri
  • osVersion (type: String.t, default: nil) - The version of the OS This field is deprecated and the information is in cpe_uri
  • package (type: String.t, default: nil) - The package being analysed for vulnerabilities
  • packageType (type: String.t, default: nil) - The type of package: os, maven, go, etc.
  • unused (type: String.t, default: nil) -
  • version (type: String.t, default: nil) - The version of the package being analysed

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

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

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

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.

A unique identifier for a Cloud Repo.

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

Attributes

  • id (type: String.t, default: nil) -

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

Other properties of the build.

Attributes

  • builder (type: GoogleApi.OnDemandScanning.V1.Model.SlsaBuilder.t, default: nil) - required
  • materials (type: list(GoogleApi.OnDemandScanning.V1.Model.Material.t), default: nil) - The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
  • metadata (type: GoogleApi.OnDemandScanning.V1.Model.SlsaMetadata.t, default: nil) -
  • recipe (type: GoogleApi.OnDemandScanning.V1.Model.SlsaRecipe.t, default: nil) - Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required

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.

Attributes

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

An occurrence of a severity vulnerability on a resource.

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.