| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="containeranalysis_v1alpha1.html">Container Analysis API</a> . <a href="containeranalysis_v1alpha1.providers.html">providers</a> . <a href="containeranalysis_v1alpha1.providers.notes.html">notes</a> . <a href="containeranalysis_v1alpha1.providers.notes.occurrences.html">occurrences</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects. |
| |
| Args: |
| name: string, The name field will contain the note name for example: "provider/{provider_id}/notes/{note_id}" (required) |
| filter: string, The filter expression. |
| pageSize: integer, Number of notes to return in the list. |
| pageToken: string, Token to provide to skip to a particular spot in the list. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response including listed occurrences for a note. |
| "nextPageToken": "A String", # Token to receive the next page of notes. |
| "occurrences": [ # The occurrences attached to the specified note. |
| { # `Occurrence` includes information about analysis occurrences for an image. |
| "attestation": { # 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 AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact. |
| "pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. |
| "contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). |
| "pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. |
| "signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. |
| }, |
| }, |
| "buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build. |
| "intotoProvenance": { # In-toto Provenance representation as defined in spec. |
| "builderConfig": { # required |
| "id": "A String", |
| }, |
| "materials": [ # 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. |
| "A String", |
| ], |
| "metadata": { # Other properties of the build. |
| "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| "buildStartedOn": "A String", # The timestamp of when the build started. |
| "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| }, |
| "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| }, |
| "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # 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 |
| "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| }, |
| }, |
| "provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance |
| "buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. |
| "a_key": "A String", |
| }, |
| "builderVersion": "A String", # Version string of the builder at the time this build was executed. |
| "builtArtifacts": [ # Output of the build. |
| { # Artifact describes a build product. |
| "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. |
| "id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456 |
| "name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto. |
| "names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. |
| "A String", |
| ], |
| }, |
| ], |
| "commands": [ # Commands requested by the build. |
| { # Command describes a step performed as part of the build pipeline. |
| "args": [ # Command-line arguments used when executing this Command. |
| "A String", |
| ], |
| "dir": "A String", # Working directory (relative to project source root) used when running this Command. |
| "env": [ # Environment variables set before running this Command. |
| "A String", |
| ], |
| "id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency. |
| "name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. |
| "waitFor": [ # The ID(s) of the Command(s) that this Command depends on. |
| "A String", |
| ], |
| }, |
| ], |
| "createTime": "A String", # Time at which the build was created. |
| "creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. |
| "finishTime": "A String", # Time at which execution of the build was finished. |
| "id": "A String", # Unique identifier of the build. |
| "logsBucket": "A String", # Google Cloud Storage bucket where logs were written. |
| "projectId": "A String", # ID of the project. |
| "sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build. |
| "additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. |
| { # 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. |
| "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| "kind": "A String", # The alias kind. |
| "name": "A String", # The alias name. |
| }, |
| "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| "projectId": "A String", # The ID of the project. |
| "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| }, |
| "uid": "A String", # A server-assigned, globally unique identifier. |
| }, |
| "revisionId": "A String", # A revision ID. |
| }, |
| "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| "kind": "A String", # The alias kind. |
| "name": "A String", # The alias name. |
| }, |
| "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| "hostUri": "A String", # The URI of a running Gerrit instance. |
| "revisionId": "A String", # A revision (commit) ID. |
| }, |
| "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| "revisionId": "A String", # Required. Git commit hash. |
| "url": "A String", # Git repository URL. |
| }, |
| "labels": { # Labels with user defined metadata. |
| "a_key": "A String", |
| }, |
| }, |
| ], |
| "artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location. |
| "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| "generation": "A String", # Google Cloud Storage generation for the object. |
| "object": "A String", # Google Cloud Storage object containing source. |
| }, |
| "context": { # 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. # If provided, the source code used for the build came from this location. |
| "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| "kind": "A String", # The alias kind. |
| "name": "A String", # The alias name. |
| }, |
| "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| "projectId": "A String", # The ID of the project. |
| "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| }, |
| "uid": "A String", # A server-assigned, globally unique identifier. |
| }, |
| "revisionId": "A String", # A revision ID. |
| }, |
| "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| "kind": "A String", # The alias kind. |
| "name": "A String", # The alias name. |
| }, |
| "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| "hostUri": "A String", # The URI of a running Gerrit instance. |
| "revisionId": "A String", # A revision (commit) ID. |
| }, |
| "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| "revisionId": "A String", # Required. Git commit hash. |
| "url": "A String", # Git repository URL. |
| }, |
| "labels": { # Labels with user defined metadata. |
| "a_key": "A String", |
| }, |
| }, |
| "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. |
| "a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build. |
| "fileHash": [ # Collection of file hashes. |
| { # Container message for hash values. |
| "type": "A String", # The type of hash that was performed. |
| "value": "A String", # The hash value. |
| }, |
| ], |
| }, |
| }, |
| "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo. |
| "branchName": "A String", # Name of the branch to build. |
| "commitSha": "A String", # Explicit commit SHA to build. |
| "projectId": "A String", # ID of the project that owns the repo. |
| "repoName": "A String", # Name of the repo. |
| "tagName": "A String", # Name of the tag to build. |
| }, |
| "storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage. |
| "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| "generation": "A String", # Google Cloud Storage generation for the object. |
| "object": "A String", # Google Cloud Storage object containing source. |
| }, |
| }, |
| "startTime": "A String", # Time at which execution of the build was started. |
| "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not. |
| }, |
| "provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. |
| }, |
| "compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes whether or not a resource passes compliance checks. |
| "nonComplianceReason": "A String", # The reason for non compliance of these files. |
| "nonCompliantFiles": [ # A list of files which are violating compliance checks. |
| { # Details about files that caused a compliance check to fail. |
| "displayCommand": "A String", # Command to display the non-compliant files. |
| "path": "A String", # 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'. Empty if `display_command` is set. |
| "reason": "A String", # Explains why a file is non compliant for a CIS check. |
| }, |
| ], |
| }, |
| "createTime": "A String", # Output only. The time this `Occurrence` was created. |
| "deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime. |
| "address": "A String", # Address of the runtime element hosting this deployment. |
| "config": "A String", # Configuration used to create this deployment. |
| "deployTime": "A String", # Beginning of the lifetime of this deployment. |
| "platform": "A String", # Platform hosting this deployment. |
| "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. |
| "A String", |
| ], |
| "undeployTime": "A String", # End of the lifetime of this deployment. |
| "userEmail": "A String", # Identity of the user that triggered this deployment. |
| }, |
| "derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note. |
| "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence. |
| "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis. |
| "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image. |
| "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests. |
| "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| "A String", |
| ], |
| "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests. |
| }, |
| "layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. |
| { # Layer holds metadata specific to a layer of a Docker image. |
| "arguments": "A String", # The recovered arguments to the Dockerfile directive. |
| "directive": "A String", # The recovered Dockerfile directive used to construct this layer. |
| }, |
| ], |
| }, |
| "discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource. |
| "analysisStatus": "A String", # The status of discovery for the resource. |
| "analysisStatusError": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "continuousAnalysis": "A String", # Whether the resource is continuously analyzed. |
| "cpe": "A String", # The CPE of the resource being scanned. |
| "operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }, |
| }, |
| "dsseAttestation": { # An occurrence describing an attestation on a resource # This represents a DSSE attestation occurrence |
| "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. |
| "payload": "A String", # The bytes being signed |
| "payloadType": "A String", # The type of payload being signed |
| "signatures": [ # The signatures over the payload |
| { # A DSSE signature |
| "keyid": "A String", # A reference id to the key being used for signing |
| "sig": "A String", # The signature itself |
| }, |
| ], |
| }, |
| "statement": { # 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". |
| "predicateType": "A String", # "https://in-toto.io/Provenance/v0.1" for InTotoProvenance. |
| "provenance": { |
| "builderConfig": { # required |
| "id": "A String", |
| }, |
| "materials": [ # 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. |
| "A String", |
| ], |
| "metadata": { # Other properties of the build. |
| "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| "buildStartedOn": "A String", # The timestamp of when the build started. |
| "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| }, |
| "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| }, |
| "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # 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 |
| "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| }, |
| }, |
| "subject": [ |
| { |
| "digest": { # "": "" |
| "a_key": "A String", |
| }, |
| "name": "A String", |
| }, |
| ], |
| "type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| }, |
| }, |
| "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse |
| "payload": "A String", # The bytes being signed |
| "payloadType": "A String", # The type of payload being signed |
| "signatures": [ # The signatures over the payload |
| { # A DSSE signature |
| "keyid": "A String", # A reference id to the key being used for signing |
| "sig": "A String", # The signature itself |
| }, |
| ], |
| }, |
| "installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource. |
| "location": [ # All of the places within the filesystem versions of this package have been found. |
| { # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status |
| "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| "path": "A String", # The path from which we gathered that this package/version is installed. |
| "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version installed at this location. |
| "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not |
| "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| }, |
| }, |
| ], |
| "name": "A String", # Output only. The name of the installed package. |
| }, |
| "kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests. |
| "name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" |
| "noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests. |
| "remediation": "A String", # A description of actions that can be taken to remedy the `Note` |
| "resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies. |
| "contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest. |
| "type": "A String", # The type of hash that was performed. |
| "value": "A String", # The hash value. |
| }, |
| "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian". |
| "uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image. |
| }, |
| "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests. |
| "sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific software bill of materials document. |
| "createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard |
| "creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields |
| "creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name |
| "A String", |
| ], |
| "documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document |
| "externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document |
| "A String", |
| ], |
| "id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally |
| "licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created |
| "namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter |
| "title": "A String", # Identify name of this document as designated by creator |
| }, |
| "spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File. |
| "attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts |
| "A String", |
| ], |
| "comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file |
| "contributors": [ # This field provides a place for the SPDX file creator to record file contributors |
| "A String", |
| ], |
| "copyright": "A String", # Identify the copyright holder of the file, as well as any dates present |
| "filesLicenseInfo": [ # This field contains the license information actually found in the file, if any |
| "A String", |
| ], |
| "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined |
| "comments": "A String", # Comments |
| "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| }, |
| "notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file |
| }, |
| "spdxPackage": { # PackageInfoOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package. |
| "comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described |
| "filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package |
| "homePage": "A String", # Output only. Provide a place for the SPDX file creator to record a web site that serves as the package's home page |
| "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # package or alternative values, if the governing license cannot be determined |
| "comments": "A String", # Comments |
| "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| }, |
| "packageType": "A String", # Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc. |
| "sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package |
| "summaryDescription": "A String", # Output only. A short description of the package |
| "title": "A String", # Output only. Identify the full name of the package as given by the Package Originator |
| "version": "A String", # Output only. Identify the version of the package |
| }, |
| "spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific relationship between SPDX elements. |
| "comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship |
| "source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc) |
| "target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it |
| "type": "A String", # Output only. The type of relationship between the source and target SPDX elements |
| }, |
| "updateTime": "A String", # Output only. The time this `Occurrence` was last updated. |
| "upgrade": { # 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). # Describes an upgrade. |
| "distribution": { # 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. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence. |
| "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| "cve": [ # The cve that would be resolved by this upgrade. |
| "A String", |
| ], |
| "severity": "A String", # The severity as specified by the upstream operating system. |
| }, |
| "package": "A String", # Required - The package this Upgrade is for. |
| "parsedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in a machine + human readable form. |
| "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not |
| "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| }, |
| }, |
| "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note. |
| "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. |
| "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple package issues for this vulnerability, they can have different effective severities because some might come from the distro and some might come from installed language packs (e.g. Maven JARs or Go binaries). For this reason, it is advised to use the effective severity on the PackageIssue level, as this field may eventually be deprecated. In the case where multiple PackageIssues have different effective severities, the one set here will be the highest severity of any of the PackageIssues. |
| "packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource. |
| { # This message wraps a location affected by a vulnerability and its associated fix (if one is available). |
| "affectedLocation": { # The location of the vulnerability # The location of the vulnerability. |
| "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. |
| "package": "A String", # The package being described. |
| "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests. |
| "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not |
| "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| }, |
| }, |
| "effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when distro or language system has not yet assigned a severity for this vulnerability. |
| "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability. |
| "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. |
| "package": "A String", # The package being described. |
| "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests. |
| "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not |
| "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| }, |
| }, |
| "packageType": "A String", # The type of package (e.g. OS, MAVEN, GO). |
| "severityName": "A String", |
| }, |
| ], |
| "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability. |
| "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). This may be deprecated in the future because we can have multiple PackageIssues with different package types. |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
